Skip to content

Commit 6570ee3

Browse files
authored
Make Spell-check workflow happy 😊 (#121)
* docs: spelling fixes * docs: `Commander.py` spelling fixes * ci: update ignored word list * docs: Add pres to ignored word list * ci: change words to lower case * ci: add `ser` to ignored word list * fix: add missing `.` to `.codespellrc` * docs: fix more spelling * docs: replace `colour` with US spelling `color`
1 parent b7e49e6 commit 6570ee3

File tree

4 files changed

+9
-9
lines changed

4 files changed

+9
-9
lines changed

src/Arduino_BHY2Host.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ class Arduino_BHY2Host {
9595
void configureSensor(SensorConfigurationPacket& config);
9696
void configureSensor(uint8_t sensorId, float sampleRate, uint32_t latency);
9797
/**
98-
* @brief Recieve acknowledgement from Nicla board over ESLOV
98+
* @brief Receive Acknowledgment from Nicla board over ESLOV
9999
*
100100
* @return uint8_t One byte of data read from the I2C bus.
101101
*/

src/BLEHandler.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ class BLEHandler {
1111
BLEHandler();
1212
virtual ~BLEHandler();
1313
/**
14-
* @brief Initialise BLE for DFU and sensor data transfer and connect to Nicla device
14+
* @brief initialize BLE for DFU and sensor data transfer and connect to Nicla device
1515
*
1616
* @return true successful connection to Nicla over BLE
1717
*

src/EslovHandler.h

+6-6
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ class EslovHandler {
6161
/**
6262
* @brief Start I2C communication over ESLOV between host board and Nicla
6363
*
64-
* @return true I2C communication initialised successfully.
64+
* @return true I2C communication initialized successfully.
6565
*/
6666
bool begin(bool passthrough);
6767
/**
@@ -91,30 +91,30 @@ class EslovHandler {
9191
/**
9292
* @brief Requests an acknowledgment packet from the Nicla over ESLOV.
9393
*
94-
* @return uint8_t acknowledge packet recieved from the Nicla over ESLOV
94+
* @return uint8_t acknowledge packet Received from the Nicla over ESLOV
9595
*/
9696
uint8_t requestPacketAck();
9797
/**
98-
* @brief Change `EslovState` of Nicla to `ESLOV_AVAILABLE_SENSOR_STATE` and wait for the interrupt pin to go high. Then read the avaliable sensor data over I2C.
98+
* @brief Change `EslovState` of Nicla to `ESLOV_AVAILABLE_SENSOR_STATE` and wait for the interrupt pin to go high. Then read the available sensor data over I2C.
9999
*
100100
* @return uint8_t Number of available sensor data packets.
101101
*/
102102
uint8_t requestAvailableData();
103103
/**
104-
* @brief Change `EslovState` of Nicla to `ESLOV_AVAILABLE_SENSOR_STATE` and wait for the interrupt pin to go high. Then read the avaliable long sensor data over I2C.
104+
* @brief Change `EslovState` of Nicla to `ESLOV_AVAILABLE_SENSOR_STATE` and wait for the interrupt pin to go high. Then read the available long sensor data over I2C.
105105
*
106106
* @return uint8_t Number of available long sensor data packets.
107107
*/
108108
uint8_t requestAvailableLongData();
109109
/**
110-
* @brief Change `EslovState` of Nicla to `ESLOV_READ_SENSOR_STATE` and wait for the interrupt pin to go high. Then read the avaliable sensor data over I2C.
110+
* @brief Change `EslovState` of Nicla to `ESLOV_READ_SENSOR_STATE` and wait for the interrupt pin to go high. Then read the available sensor data over I2C.
111111
*
112112
* @param sData data packet containing sensorID, payload size and data payload
113113
* @return true Successful request of sensor data
114114
*/
115115
bool requestSensorData(SensorDataPacket &sData);
116116
/**
117-
* @brief Change `EslovState` of Nicla to `ESLOV_READ_SENSOR_STATE` and wait for the interrupt pin to go high. Then read the avaliable long sensor data over I2C.
117+
* @brief Change `EslovState` of Nicla to `ESLOV_READ_SENSOR_STATE` and wait for the interrupt pin to go high. Then read the available long sensor data over I2C.
118118
*
119119
* @param sData data packet containing sensorID, payload size and data payload
120120
* @return true Successful request of sensor data

src/sensors/DataParser.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ struct DataBSEC {
5151
uint16_t iaq_s; //iaq value for stationary use cases
5252
float b_voc_eq; //breath VOC equivalent (ppm)
5353
uint32_t co2_eq; //CO2 equivalent (ppm) [400,]
54-
float comp_t; //compensated temperature (celcius)
54+
float comp_t; //compensated temperature (celsius)
5555
float comp_h; //compensated humidity
5656
uint32_t comp_g; //compensated gas resistance (Ohms)
5757
uint8_t accuracy; //accuracy level: [0-3]

0 commit comments

Comments
 (0)