Typo Corrections

FAQ.md

@@ -106,7 +106,7 @@ ESP_ERROR_CHECK(ads111x_init_desc(&dev, addr, I2C_PORT, SDA_GPIO, SCL_GPIO));
     dev.cfg.master.clk_speed = 100000; // Hz
 #endif
 
-ESP_ERROR_CHECK(ads111x_set_mode(&dev, ADS111X_MODE_CONTINUOS));    // Continuous conversion mode
+ESP_ERROR_CHECK(ads111x_set_mode(&dev, ADS111X_MODE_CONTINUOUS));    // Continuous conversion mode
 ESP_ERROR_CHECK(ads111x_set_data_rate(&dev, ADS111X_DATA_RATE_32)); // 32 samples per second
 ...
 ```

components/ads111x/ads111x.h

@@ -95,7 +95,7 @@ typedef enum
  */
 typedef enum
 {
-    ADS111X_MODE_CONTINUOS = 0, //!< Continuous conversion mode
+    ADS111X_MODE_CONTINUOUS = 0, //!< Continuous conversion mode
     ADS111X_MODE_SINGLE_SHOT    //!< Power-down single-shot mode (default)
 } ads111x_mode_t;
 
@@ -138,7 +138,7 @@ typedef enum
 } ads111x_comp_queue_t;
 
 /**
- * Initialize device descriptior
+ * Initialize device descriptor
  * @param dev Device descriptor
  * @param addr Device address
  * @param port I2C port number

components/bh1750/bh1750.c

@@ -100,7 +100,7 @@ esp_err_t bh1750_setup(i2c_dev_t *dev, bh1750_mode_t mode, bh1750_resolution_t r
 {
     CHECK_ARG(dev);
 
-    uint8_t opcode = mode == BH1750_MODE_CONTINIOUS ? OPCODE_CONT : OPCODE_OT;
+    uint8_t opcode = mode == BH1750_MODE_CONTINUOUS ? OPCODE_CONT : OPCODE_OT;
     switch (resolution)
     {
         case BH1750_RES_LOW:  opcode |= OPCODE_LOW;   break;

components/bh1750/bh1750.h

@@ -35,7 +35,7 @@ extern "C" {
 typedef enum
 {
     BH1750_MODE_ONE_TIME = 0, //!< One time measurement
-    BH1750_MODE_CONTINIOUS    //!< Continious measurement
+    BH1750_MODE_CONTINUOUS    //!< Continuous measurement
 } bh1750_mode_t;
 
 /**
@@ -49,7 +49,7 @@ typedef enum
 } bh1750_resolution_t;
 
 /**
- * @brief Initialize device descriptior
+ * @brief Initialize device descriptor
  * @param[out] dev Pointer to device descriptor
  * @param[in] addr I2C address, BH1750_ADDR_LO or BH1750_ADDR_HI
  * @param[in] port I2C port number

components/bmp180/bmp180.c

@@ -55,15 +55,15 @@ static esp_err_t bmp180_read_reg_16(i2c_dev_t *dev, uint8_t reg, int16_t *r)
     return ESP_OK;
 }
 
-static inline esp_err_t bmp180_start_messurement(i2c_dev_t *dev, uint8_t cmd)
+static inline esp_err_t bmp180_start_measurement(i2c_dev_t *dev, uint8_t cmd)
 {
     return i2c_dev_write_reg(dev, BMP180_CONTROL_REG, &cmd, 1);
 }
 
 static esp_err_t bmp180_get_uncompensated_temperature(i2c_dev_t *dev, int32_t *ut)
 {
     // Write Start Code into reg 0xF4.
-    CHECK(bmp180_start_messurement(dev, BMP180_MEASURE_TEMP));
+    CHECK(bmp180_start_measurement(dev, BMP180_MEASURE_TEMP));
 
     // Wait 5ms, datasheet states 4.5ms
     ets_delay_us(5000);
@@ -89,7 +89,7 @@ static esp_err_t bmp180_get_uncompensated_pressure(i2c_dev_t *dev, bmp180_mode_t
     }
 
     // Write Start Code into reg 0xF4
-    CHECK(bmp180_start_messurement(dev, BMP180_MEASURE_PRESS | (oss << 6)));
+    CHECK(bmp180_start_measurement(dev, BMP180_MEASURE_PRESS | (oss << 6)));
 
     ets_delay_us(us);
 

components/bmp180/bmp180.h

@@ -61,7 +61,7 @@ typedef enum
 
 
 /**
- * @brief Initialize device descriptior
+ * @brief Initialize device descriptor
  *
  * @param[out] dev Pointer to device descriptor
  * @param port I2C port number

components/bmp280/bmp280.h

@@ -116,7 +116,7 @@ typedef struct {
 } bmp280_t;
 
 /**
- * @brief Initialize device descriptior
+ * @brief Initialize device descriptor
  * @param[out] dev Pointer to device descriptor
  * @param[in] addr BMP280 address
  * @param[in] port I2C port number
@@ -136,7 +136,7 @@ esp_err_t bmp280_free_desc(bmp280_t *dev);
 /**
  * Initialize default parameters.
  * Default configuration:
- *      mode: NORAML
+ *      mode: NORMAL
  *      filter: OFF
  *      oversampling: x4
  *      standby time: 250ms
@@ -173,7 +173,7 @@ esp_err_t bmp280_is_measuring(bmp280_t *dev, bool *busy);
  *  Pressure in Pascals in fixed point 24 bit integer 8 bit fraction format.
  *
  *  Humidity is optional and only read for the BME280, in percent relative
- *  humidity as a fixed point 22 bit interger and 10 bit fraction format.
+ *  humidity as a fixed point 22 bit integer and 10 bit fraction format.
  */
 esp_err_t bmp280_read_fixed(bmp280_t *dev, int32_t *temperature,
                             uint32_t *pressure, uint32_t *humidity);

components/dht/dht.c

@@ -46,7 +46,7 @@
  *  of length 5.  The first and third bytes are humidity (%) and temperature (C), respectively.  Bytes 2 and 4
  *  are zero-filled and the fifth is a checksum such that:
  *
- *  byte_5 == (byte_1 + byte_2 + byte_3 + btye_4) & 0xFF
+ *  byte_5 == (byte_1 + byte_2 + byte_3 + byte_4) & 0xFF
  *
  */
 

components/ds3231/ds3231.h

@@ -116,7 +116,7 @@ esp_err_t ds3231_get_time(i2c_dev_t *dev, struct tm *time);
  * and you can set both alarms at the same time (pass `DS3231_ALARM_1`/`DS3231_ALARM_2`/`DS3231_ALARM_BOTH`).
  *
  * If only setting one alarm just pass 0 for `tm` struct and `option` field for the other alarm.
- * If using `DS3231_ALARM1_EVERY_SECOND`/`DS3231_ALARM2_EVERY_MIN` you can pass 0 for `tm` stuct.
+ * If using `DS3231_ALARM1_EVERY_SECOND`/`DS3231_ALARM2_EVERY_MIN` you can pass 0 for `tm` struct.
  *
  * If you want to enable interrupts for the alarms you need to do that separately.
  *

components/hd44780/hd44780.c

@@ -1,7 +1,7 @@
 /**
  * @file hd44780.c
  *
- * ESP-IDF driver for HD44780 compartible LCD text displays
+ * ESP-IDF driver for HD44780 compatible LCD text displays
  *
  * Ported from esp-open-rtos
  *

components/hd44780/hd44780.h

@@ -3,7 +3,7 @@
  * @defgroup hd44780 hd44780
  * @{
  *
- * ESP-IDF driver for HD44780 compartible LCD text displays
+ * ESP-IDF driver for HD44780 compatible LCD text displays
  *
  * Ported from esp-open-rtos
  *

components/hmc5883l/hmc5883l.h

@@ -117,7 +117,7 @@ typedef struct
 } hmc5883l_data_t;
 
 /**
- * @brief Initialize device descriptior
+ * @brief Initialize device descriptor
  * @param dev Pointer to device descriptor
  * @param port I2C port number
  * @param sda_gpio GPIO pin number for SDA

components/hx711/hx711.h

@@ -88,7 +88,7 @@ esp_err_t hx711_wait(hx711_t *dev, size_t timeout_ms);
  * @brief Read raw data from device.
  *
  * Please call this function only when device is ready,
- * otherwise communictaion errors may occur
+ * otherwise communication errors may occur
  *
  * @param dev Device descriptor
  * @param data Raw ADC data

components/i2cdev/i2cdev.h

@@ -95,7 +95,7 @@ esp_err_t i2c_dev_give_mutex(i2c_dev_t *dev);
 /**
  * @brief Read from slave device
  *
- * Issue a send operation of \p out_data register adress, followed by reading \p in_size bytes
+ * Issue a send operation of \p out_data register address, followed by reading \p in_size bytes
  * from slave into \p in_data .
  * Function is thread-safe.
  * @param[in] dev Device descriptor

components/ina260/ina260.h

@@ -149,7 +149,7 @@ esp_err_t ina260_reset(ina260_t *dev);
  *
  * @param dev Device descriptor
  * @param mode Operating mode
- * @param avg_mode Averaging mide
+ * @param avg_mode Averaging mode
  * @param vbus_ct Bus voltage conversion time
  * @param ish_ct Shunt current conversion time
  * @return `ESP_OK` on success
@@ -162,7 +162,7 @@ esp_err_t ina260_set_config(ina260_t *dev, ina260_mode_t mode, ina260_averaging_
  *
  * @param dev Device descriptor
  * @param[out] mode Operating mode
- * @param[out] avg_mode Averaging mide
+ * @param[out] avg_mode Averaging mode
  * @param[out] vbus_ct Bus voltage conversion time
  * @param[out] ish_ct Shunt current conversion time
  * @return `ESP_OK` on success

components/ina3221/ina3221.h

@@ -89,7 +89,7 @@ typedef union
     {
         uint16_t esht :1; ///< Enable/Disable shunt measure    // LSB
         uint16_t ebus :1; ///< Enable/Disable bus measure
-        uint16_t mode :1; ///< Single shot measure or continious mode
+        uint16_t mode :1; ///< Single shot measure or continuous mode
         uint16_t vsht :3; ///< Shunt voltage conversion time
         uint16_t vbus :3; ///< Bus voltage conversion time
         uint16_t avg  :3; ///< number of sample collected and averaged together

components/lm75/lm75.c

@@ -82,7 +82,7 @@ esp_err_t lm75_read_temperature(i2c_dev_t *dev, float *value)
 
     I2C_DEV_TAKE_MUTEX(dev);
     CHECK_LOGE(dev, read_register16(dev, LM75_REG_TEMP, &raw_data),
-            "lm75_read_temperature(): read_register16() failed: regsiter: 0x%x", LM75_REG_TEMP);
+            "lm75_read_temperature(): read_register16() failed: register: 0x%x", LM75_REG_TEMP);
     I2C_DEV_GIVE_MUTEX(dev);
 
     *value = (raw_data >> 5) * 0.125;
@@ -144,7 +144,7 @@ esp_err_t lm75_get_os_threshold(i2c_dev_t *dev, float *value)
 
     I2C_DEV_TAKE_MUTEX(dev);
     CHECK_LOGE(dev, read_register16(dev, LM75_REG_TOS, &reg_value),
-            "lm75_get_os_threshold(): read_register16() failed: regsiter: 0x%x", LM75_REG_TOS);
+            "lm75_get_os_threshold(): read_register16() failed: register: 0x%x", LM75_REG_TOS);
     I2C_DEV_GIVE_MUTEX(dev);
 
     ESP_LOGV(TAG, "lm75_get_os_threshold(): reg_value: 0x%x 9 bit reg_value: 0x%x", reg_value, reg_value >> 7);
@@ -205,7 +205,7 @@ esp_err_t lm75_clear_bits_register8(i2c_dev_t *dev, uint8_t reg, uint8_t mask)
         value ^= mask;
         ESP_LOGV(TAG, "lm75_clear_bits_register8(): updating register with value: 0x%x", value);
         CHECK_LOGE(dev, write_register8(dev, reg, value),
-                "write_register8() failed: regsiter 0x%x", reg);
+                "write_register8() failed: register 0x%x", reg);
     } else {
         ESP_LOGV(TAG, "lm75_clear_bits_register8(): register unchanged");
     }

components/lm75/lm75.h

@@ -28,8 +28,8 @@
  * Short usage instruction:
  *
  * 1. Include lm75.h
- * 2. Initialize I2C descriptior by i2cdev_init()
- * 3. Initialize LM75 descriptior by lm75_init_desc()
+ * 2. Initialize I2C descriptor by i2cdev_init()
+ * 3. Initialize LM75 descriptor by lm75_init_desc()
  * 4. Initialize LM75 by lm75_init()
  * 5. Read temperature by lm75_read_temperature()
  *
@@ -95,11 +95,11 @@ typedef struct {
 } lm75_config_t;
 
 /**
- * @brief Initialize LM75 device descriptior
+ * @brief Initialize LM75 device descriptor
  *
  * i2cdev_init() must be called before this function.
  *
- * @param[out] dev pointer to LM75 device descriptior
+ * @param[out] dev pointer to LM75 device descriptor
  * @param[in] addr I2C address of LM75
  * @param[in] port I2C port
  * @param[in] sda_gpio GPIO number of SDA
@@ -113,44 +113,44 @@ esp_err_t lm75_init_desc(i2c_dev_t *dev, uint8_t addr, i2c_port_t port, gpio_num
  *
  * lm75_init_desc() must be called before this function.
  *
- * @param[in] dev pointer to LM75 device descriptior
+ * @param[in] dev pointer to LM75 device descriptor
  * @param[in] config configuration
  */
 esp_err_t lm75_init(i2c_dev_t *dev, const lm75_config_t config);
 
 /**
- * @brief free LM75 device descriptior
+ * @brief free LM75 device descriptor
  * @param dev Pointer to device descriptor
  */
 esp_err_t lm75_free_desc(i2c_dev_t *dev);
 
 /**
  * @brief Get the value of OS Polarity in the configuration register
- * @param[in] dev pointer to LM75 device descriptior
+ * @param[in] dev pointer to LM75 device descriptor
  * @param[out] v value of OS Polarity
  * @return `ESP_OK` on success
  */
 esp_err_t lm75_get_os_polarity(i2c_dev_t *dev, uint8_t *v);
 
 /**
  * @brief Get the value of OS threshold in the configuration register
- * @param[in] dev pointer to LM75 device descriptior
+ * @param[in] dev pointer to LM75 device descriptor
  * @param[out] value value of OS threshold
  * @return `ESP_OK` on success
  */
 esp_err_t lm75_get_os_threshold(i2c_dev_t *dev, float *value);
 
 /**
  * @brief Read the temperature
- * @param[in] dev pointer to LM75 device descriptior
+ * @param[in] dev pointer to LM75 device descriptor
  * @param[out] value temperature
  * @return `ESP_OK` on success
  */
 esp_err_t lm75_read_temperature(i2c_dev_t *dev, float *value);
 
 /**
  * @brief Set OS mode
- * @param[in] dev pointer to LM75 device descriptior
+ * @param[in] dev pointer to LM75 device descriptor
  * @param[in] v OS mode
  * @return `ESP_OK` on success
  */
@@ -159,30 +159,30 @@ esp_err_t lm75_set_os_mode(i2c_dev_t *dev, const lm75_os_mode_t v);
 /**
  * @brief Set the value of OS Polarity in the configuration register
  *
- * @param[in] dev pointer to LM75 device descriptior
+ * @param[in] dev pointer to LM75 device descriptor
  * @param[in] v value of OS Polarity
  * @return `ESP_OK` on success
  */
 esp_err_t lm75_set_os_polarity(i2c_dev_t *dev, const lm75_os_polarity_t v);
 
 /**
  * @brief Set the value of OS threshold in the configuration register
- * @param[in] dev pointer to LM75 device descriptior
+ * @param[in] dev pointer to LM75 device descriptor
  * @param[in] value value of OS threshold
  * @return `ESP_OK` on success
  */
 esp_err_t lm75_set_os_threshold(i2c_dev_t *dev, const float value);
 
 /**
  * @brief Shutdown LM75
- * @param[in] dev pointer to LM75 device descriptior
+ * @param[in] dev pointer to LM75 device descriptor
  * @return `ESP_OK` on success
  */
 esp_err_t lm75_shutdown(i2c_dev_t *dev);
 
 /**
  * @brief Wake LM75 up
- * @param[in] dev pointer to LM75 device descriptior
+ * @param[in] dev pointer to LM75 device descriptor
  * @return `ESP_OK` on success
  */
 esp_err_t lm75_wakeup(i2c_dev_t *dev);

components/max31725/max31725.h

@@ -65,7 +65,7 @@ typedef enum {
 } max31725_mode_t;
 
 /**
- * @brief Initialize device descriptior
+ * @brief Initialize device descriptor
  * @param dev Device descriptor
  * @param port I2C port number
  * @param addr I2C address

components/mcp23008/mcp23008.h

@@ -53,7 +53,7 @@ typedef enum
 } mcp23008_gpio_intr_t;
 
 /**
- * @brief Initialize device descriptior
+ * @brief Initialize device descriptor
  * SCL frequency is 1MHz
  * @param dev Pointer to I2C device descriptor
  * @param port I2C port number

components/mcp23x17/mcp23x17.h

@@ -75,7 +75,7 @@ typedef enum
 #ifdef CONFIG_MCP23X17_IFACE_I2C
 
 /**
- * @brief Initialize device descriptior
+ * @brief Initialize device descriptor
  * SCL frequency is 1MHz
  * @param dev Pointer to device descriptor
  * @param port I2C port number

components/mcp342x/mcp342x.h

@@ -74,7 +74,7 @@ typedef struct {
 } mcp342x_t;
 
 /**
- * @brief Initialize device descriptior
+ * @brief Initialize device descriptor
  * @param dev Device descriptor
  * @param port I2C port
  * @param addr Device address
@@ -139,9 +139,9 @@ esp_err_t mcp342x_get_data(mcp342x_t *dev, int32_t *data, bool *ready);
 esp_err_t mcp342x_get_voltage(mcp342x_t *dev, float *volts, bool *ready);
 
 /**
- * @brief Do a single converiton
+ * @brief Do a single conversion
  * - start conversion
- * - wait convertion time
+ * - wait conversion time
  * - read conversion result
  *
  * @param dev Device descriptor