feat: initial

CMakeLists.txt

@@ -1 +1 @@
-idf_component_register(SRCS "main.c" INCLUDE_DIRS "include")
+idf_component_register(SRCS "zh_aht.c" INCLUDE_DIRS "include" REQUIRES driver)

README.md

@@ -1,3 +1,80 @@
-# esp_component_template
+# ESP32 ESP-IDF and ESP8266 RTOS SDK component for AHT10/AHT15/AHT20/AHT21/AHT25/AHT30 humidity & temperature sensor
 
-esp_component_template
+## Tested on
+
+1. ESP8266 RTOS_SDK v3.4
+2. ESP32 ESP-IDF v5.2
+
+## Features
+
+1. Autodetect sensor type.
+
+## Using
+
+In an existing project, run the following command to install the component:
+
+```text
+cd ../your_project/components
+git clone https://github.com/aZholtikov/zh_aht.git
+```
+
+In the application, add the component:
+
+```c
+#include "zh_aht.h"
+```
+
+## Example
+
+Reading the sensor:
+
+```c
+#include "zh_aht.h"
+
+#define I2C_PORT (I2C_NUM_MAX - 1)
+
+void app_main(void)
+{
+    esp_log_level_set("zh_aht", ESP_LOG_NONE);
+#ifdef CONFIG_IDF_TARGET_ESP8266
+    i2c_config_t i2c_config = {
+        .mode = I2C_MODE_MASTER,
+        .sda_io_num = GPIO_NUM_4, // In accordance with used chip.
+        .sda_pullup_en = GPIO_PULLUP_ENABLE,
+        .scl_io_num = GPIO_NUM_5, // In accordance with used chip.
+        .scl_pullup_en = GPIO_PULLUP_ENABLE,
+    };
+    i2c_driver_install(I2C_PORT, i2c_config.mode);
+    i2c_param_config(I2C_PORT, &i2c_config);
+#else
+    i2c_master_bus_config_t i2c_bus_config = {
+        .clk_source = I2C_CLK_SRC_DEFAULT,
+        .i2c_port = I2C_PORT,
+        .scl_io_num = GPIO_NUM_22, // In accordance with used chip.
+        .sda_io_num = GPIO_NUM_21, // In accordance with used chip.
+        .glitch_ignore_cnt = 7,
+        .flags.enable_internal_pullup = true,
+    };
+    i2c_master_bus_handle_t i2c_bus_handle;
+    i2c_new_master_bus(&i2c_bus_config, &i2c_bus_handle);
+#endif
+    zh_aht_init_config_t aht_init_config = ZH_AHT_INIT_CONFIG_DEFAULT();
+#ifdef CONFIG_IDF_TARGET_ESP8266
+    aht_init_config.i2c_port = I2C_PORT;
+#else
+    aht_init_config.i2c_handle = i2c_bus_handle;
+#endif
+    zh_aht_init(&aht_init_config);
+    float humidity = 0.0;
+    float temperature = 0.0;
+    for (;;)
+    {
+        zh_aht_read(&humidity, &temperature);
+        printf("Humidity %0.2f\n", humidity);
+        printf("Temperature %0.2f\n", temperature);
+        vTaskDelay(5000 / portTICK_PERIOD_MS);
+    }
+}
+```
+
+Any [feedback](mailto:github@azholtikov.ru) will be gladly accepted.

include/zh_aht.h

@@ -0,0 +1,78 @@
+#pragma once
+
+#include "esp_err.h"
+#include "esp_log.h"
+#ifdef CONFIG_IDF_TARGET_ESP8266
+#include "driver/i2c.h"
+#else
+#include "driver/i2c_master.h"
+#endif
+#include "freertos/FreeRTOS.h"
+#include "freertos/task.h"
+
+#define ZH_AHT_INIT_CONFIG_DEFAULT() \
+    {                                \
+        .i2c_port = 0                \
+    }
+
+#ifdef __cplusplus
+extern "C"
+{
+#endif
+
+    typedef struct // Structure for initial initialization of AHT sensor.
+    {
+        bool i2c_port; // I2C port.
+#ifndef CONFIG_IDF_TARGET_ESP8266
+        i2c_master_bus_handle_t i2c_handle; // Unique I2C bus handle.
+#endif
+    } zh_aht_init_config_t;
+
+    /**
+     * @brief Initialize AHT sensor.
+     *
+     * @param[in] config Pointer to AHT initialized configuration structure. Can point to a temporary variable.
+     *
+     * @attention I2C driver must be initialized first.
+     *
+     * @note Before initialize the sensor recommend initialize zh_aht_init_config_t structure with default values.
+     *
+     * @code zh_aht_init_config_t config = ZH_AHT_INIT_CONFIG_DEFAULT() @endcode
+     *
+     * @return
+     *              - ESP_OK if initialization was success
+     *              - ESP_ERR_INVALID_ARG if parameter error
+     *              - ESP_ERR_NOT_FOUND if sensor not connected or not responded
+     *              - ESP_ERR_INVALID_RESPONSE if I2C driver error
+     */
+    esp_err_t zh_aht_init(const zh_aht_init_config_t *config);
+
+    /**
+     * @brief Read AHT sensor.
+     *
+     * @param[out] humidity Pointer for AHT sensor reading data of humidity.
+     * @param[out] temperature Pointer for AHT sensor reading data of temperature.
+     *
+     * @return
+     *              - ESP_OK if read was success
+     *              - ESP_ERR_INVALID_ARG if parameter error
+     *              - ESP_ERR_NOT_FOUND if sensor is not initialized
+     *              - ESP_ERR_INVALID_CRC if check CRC is fail
+     *              - ESP_ERR_INVALID_RESPONSE if I2C driver error
+     *              - ESP_ERR_TIMEOUT if sensor has not responded
+     */
+    esp_err_t zh_aht_read(float *humidity, float *temperature);
+
+    /**
+     * @brief Reset AHT sensor.
+     *
+     * @return
+     *              - ESP_OK if reset was success
+     *              - ESP_ERR_NOT_FOUND if sensor is not initialized
+     *              - ESP_ERR_INVALID_RESPONSE if I2C driver error
+     */
+    esp_err_t zh_aht_reset(void);
+
+#ifdef __cplusplus
+}
+#endif

version.txt

@@ -0,0 +1 @@
+1.0.0

zh_aht.c

@@ -0,0 +1,260 @@
+#include "zh_aht.h"
+
+#define I2C_MAX_DATA_SIZE 7                    // Sensor maximum data size (in bytes).
+#define MEASUREMENT_TIME 80                    // Sensor measurement time (in milliseconds).
+#define RESET_TIME 20                          // Sensor reset time (in milliseconds).
+#define I2C_ADDRESS 0x38                       // Sensor I2C address.
+#define I2C_DATA_READ_COMMAND 0xAC, 0x33, 0x00 // Command for read sensor data (temperature and humidity).
+#define I2C_RESET_COMMAND 0xBA                 // Command for reset sensor.
+#define I2C_INIT_COMMAND 0x00, 0x08, 0x00      // Command for initialize sensor. First byte is depend of sensor type.
+#define I2C_INIT_AHT1X_FIRST_BYTE 0xE1         // First byte for command for initialize sensor. For AHT1X series.
+#define I2C_INIT_AHT2X_FIRST_BYTE 0xBE         // First byte for command for initialize sensor. For AHT2X/3X series.
+#define I2C_STATUS_READ_COMMAND 0x71           // Command for read sensor status.
+
+static zh_aht_init_config_t _init_config = {0};
+static bool _is_initialized = false;
+#ifndef CONFIG_IDF_TARGET_ESP8266
+static i2c_master_dev_handle_t _aht_handle = {0};
+#endif
+
+static const char *TAG = "zh_aht";
+
+static uint8_t _calc_crc(const uint8_t *buf, size_t len);
+
+esp_err_t zh_aht_init(const zh_aht_init_config_t *config)
+{
+    ESP_LOGI(TAG, "AHT initialization begin.");
+    if (config == NULL)
+    {
+        ESP_LOGE(TAG, "AHT initialization fail. Invalid argument.");
+        return ESP_ERR_INVALID_ARG;
+    }
+    _init_config = *config;
+#ifndef CONFIG_IDF_TARGET_ESP8266
+    i2c_device_config_t aht_config = {
+        .dev_addr_length = I2C_ADDR_BIT_LEN_7,
+        .device_address = I2C_ADDRESS,
+        .scl_speed_hz = 100000,
+    };
+    i2c_master_bus_add_device(_init_config.i2c_handle, &aht_config, &_aht_handle);
+    if (i2c_master_probe(_init_config.i2c_handle, I2C_ADDRESS, 1000 / portTICK_PERIOD_MS) != ESP_OK)
+    {
+        ESP_LOGE(TAG, "AHT initialization fail. Sensor not connected or not responded.");
+        return ESP_ERR_NOT_FOUND;
+    }
+#endif
+    esp_err_t err = ESP_OK;
+    uint8_t status_read_command = I2C_STATUS_READ_COMMAND;
+    uint8_t sensor_data = 0;
+#ifdef CONFIG_IDF_TARGET_ESP8266
+    i2c_cmd_handle_t i2c_cmd_handle = i2c_cmd_link_create();
+    i2c_master_start(i2c_cmd_handle);
+    i2c_master_write_byte(i2c_cmd_handle, I2C_ADDRESS << 1 | I2C_MASTER_WRITE, true);
+    i2c_master_write_byte(i2c_cmd_handle, status_read_command, true);
+    i2c_master_stop(i2c_cmd_handle);
+    err = i2c_master_cmd_begin(_init_config.i2c_port, i2c_cmd_handle, 1000 / portTICK_PERIOD_MS);
+    i2c_cmd_link_delete(i2c_cmd_handle);
+#else
+    err = i2c_master_transmit(_aht_handle, &status_read_command, sizeof(status_read_command), 1000 / portTICK_PERIOD_MS);
+#endif
+    if (err != ESP_OK)
+    {
+        ESP_LOGE(TAG, "AHT initialization fail. I2C driver error at line %d.", __LINE__);
+        return ESP_ERR_INVALID_RESPONSE;
+    }
+#ifdef CONFIG_IDF_TARGET_ESP8266
+    i2c_cmd_handle = i2c_cmd_link_create();
+    i2c_master_start(i2c_cmd_handle);
+    i2c_master_write_byte(i2c_cmd_handle, I2C_ADDRESS << 1 | I2C_MASTER_READ, true);
+    i2c_master_read_byte(i2c_cmd_handle, &sensor_data, I2C_MASTER_NACK);
+    i2c_master_stop(i2c_cmd_handle);
+    err = i2c_master_cmd_begin(_init_config.i2c_port, i2c_cmd_handle, 1000 / portTICK_PERIOD_MS);
+    i2c_cmd_link_delete(i2c_cmd_handle);
+#else
+    err = i2c_master_receive(_aht_handle, &sensor_data, sizeof(sensor_data), 1000 / portTICK_PERIOD_MS);
+#endif
+    if (err != ESP_OK)
+    {
+        ESP_LOGE(TAG, "AHT initialization fail. I2C driver error at line %d.", __LINE__);
+        return ESP_ERR_INVALID_RESPONSE;
+    }
+    if ((sensor_data & 0x08) == 0) // If sensor is not calibrated.
+    {
+        uint8_t init_command[] = {I2C_INIT_COMMAND};
+        uint8_t check_command = I2C_INIT_AHT2X_FIRST_BYTE;
+        bool is_first_check = false;
+    INIT_SENSOR:;
+#ifdef CONFIG_IDF_TARGET_ESP8266
+        i2c_cmd_handle = i2c_cmd_link_create();
+        i2c_master_start(i2c_cmd_handle);
+        i2c_master_write_byte(i2c_cmd_handle, I2C_ADDRESS << 1 | I2C_MASTER_WRITE, true);
+        i2c_master_write_byte(i2c_cmd_handle, check_command, true);
+        i2c_master_stop(i2c_cmd_handle);
+        err = i2c_master_cmd_begin(_init_config.i2c_port, i2c_cmd_handle, 1000 / portTICK_PERIOD_MS);
+        i2c_cmd_link_delete(i2c_cmd_handle);
+#else
+        err = i2c_master_transmit(_aht_handle, &check_command, sizeof(check_command), 1000 / portTICK_PERIOD_MS);
+#endif
+        if (err != ESP_OK)
+        {
+            if (err == ESP_ERR_INVALID_STATE && is_first_check == false)
+            {
+                check_command = I2C_INIT_AHT1X_FIRST_BYTE;
+                is_first_check = true;
+                goto INIT_SENSOR;
+            }
+            else
+            {
+                ESP_LOGE(TAG, "AHT initialization fail. I2C driver error at line %d.", __LINE__);
+                return ESP_ERR_INVALID_RESPONSE;
+            }
+        }
+        init_command[0] = check_command;
+#ifdef CONFIG_IDF_TARGET_ESP8266
+        i2c_cmd_handle = i2c_cmd_link_create();
+        i2c_master_start(i2c_cmd_handle);
+        i2c_master_write_byte(i2c_cmd_handle, I2C_ADDRESS << 1 | I2C_MASTER_WRITE, true);
+        i2c_master_write_byte(i2c_cmd_handle, init_command[0], true);
+        i2c_master_write_byte(i2c_cmd_handle, init_command[1], true);
+        i2c_master_write_byte(i2c_cmd_handle, init_command[2], true);
+        i2c_master_stop(i2c_cmd_handle);
+        err = i2c_master_cmd_begin(_init_config.i2c_port, i2c_cmd_handle, 1000 / portTICK_PERIOD_MS);
+        i2c_cmd_link_delete(i2c_cmd_handle);
+#else
+        err = i2c_master_transmit(_aht_handle, init_command, sizeof(init_command), 1000 / portTICK_PERIOD_MS);
+#endif
+        if (err != ESP_OK)
+        {
+            ESP_LOGE(TAG, "AHT initialization fail. I2C driver error at line %d.", __LINE__);
+            return ESP_ERR_INVALID_RESPONSE;
+        }
+    }
+    ESP_LOGI(TAG, "AHT initialization success.");
+    _is_initialized = true;
+    return ESP_OK;
+}
+
+esp_err_t zh_aht_read(float *humidity, float *temperature)
+{
+    ESP_LOGI(TAG, "AHT read begin.");
+    if (humidity == NULL || temperature == NULL)
+    {
+        ESP_LOGE(TAG, "AHT read fail. Invalid argument.");
+        return ESP_ERR_INVALID_ARG;
+    }
+    if (_is_initialized == false)
+    {
+        ESP_LOGE(TAG, "AHT read fail. AHT not initialized.");
+        return ESP_ERR_NOT_FOUND;
+    }
+    esp_err_t err = ESP_OK;
+    uint8_t sensor_data[I2C_MAX_DATA_SIZE] = {0};
+    uint8_t data_read_command[] = {I2C_DATA_READ_COMMAND};
+#ifdef CONFIG_IDF_TARGET_ESP8266
+    i2c_cmd_handle_t i2c_cmd_handle = i2c_cmd_link_create();
+    i2c_master_start(i2c_cmd_handle);
+    i2c_master_write_byte(i2c_cmd_handle, I2C_ADDRESS << 1 | I2C_MASTER_WRITE, true);
+    i2c_master_write_byte(i2c_cmd_handle, data_read_command[0], true);
+    i2c_master_write_byte(i2c_cmd_handle, data_read_command[1], true);
+    i2c_master_write_byte(i2c_cmd_handle, data_read_command[2], true);
+    i2c_master_stop(i2c_cmd_handle);
+    err = i2c_master_cmd_begin(_init_config.i2c_port, i2c_cmd_handle, 1000 / portTICK_PERIOD_MS);
+    i2c_cmd_link_delete(i2c_cmd_handle);
+#else
+    err = i2c_master_transmit(_aht_handle, data_read_command, sizeof(data_read_command), 1000 / portTICK_PERIOD_MS);
+#endif
+    if (err != ESP_OK)
+    {
+        ESP_LOGE(TAG, "AHT read fail. I2C driver error at line %d.", __LINE__);
+        return ESP_ERR_INVALID_RESPONSE;
+    }
+    vTaskDelay(MEASUREMENT_TIME / portTICK_PERIOD_MS);
+#ifdef CONFIG_IDF_TARGET_ESP8266
+    i2c_cmd_handle = i2c_cmd_link_create();
+    i2c_master_start(i2c_cmd_handle);
+    i2c_master_write_byte(i2c_cmd_handle, I2C_ADDRESS << 1 | I2C_MASTER_READ, true);
+    for (uint8_t i = 0; i < sizeof(sensor_data); ++i)
+    {
+        i2c_master_read_byte(i2c_cmd_handle, &sensor_data[i], i == (sizeof(sensor_data) - 1) ? I2C_MASTER_NACK : I2C_MASTER_ACK);
+    }
+    i2c_master_stop(i2c_cmd_handle);
+    err = i2c_master_cmd_begin(_init_config.i2c_port, i2c_cmd_handle, 1000 / portTICK_PERIOD_MS);
+    i2c_cmd_link_delete(i2c_cmd_handle);
+#else
+    err = i2c_master_receive(_aht_handle, sensor_data, sizeof(sensor_data), 1000 / portTICK_PERIOD_MS);
+#endif
+    if (err != ESP_OK)
+    {
+        ESP_LOGE(TAG, "AHT read fail. I2C driver error at line %d.", __LINE__);
+        return ESP_ERR_INVALID_RESPONSE;
+    }
+    if ((sensor_data[0] & 0x40) != 0) // If sensor is busy in measurement.
+    {
+        ESP_LOGE(TAG, "AHT read fail. Timeout exceeded.");
+        return ESP_ERR_TIMEOUT;
+    }
+    if (sensor_data[6] != 0x00 || sensor_data[6] != 0xFF)
+    {
+        if (_calc_crc(sensor_data, I2C_MAX_DATA_SIZE - 1) != sensor_data[6])
+        {
+            ESP_LOGE(TAG, "AHT read fail. Invalid CRC.");
+            return ESP_ERR_INVALID_CRC;
+        }
+    }
+    *humidity = (((((uint32_t)sensor_data[1]) << 16) | (((uint32_t)sensor_data[2]) << 8) | (((uint32_t)sensor_data[3]) << 0)) >> 4) / 1048576.0 * 100.0;
+    *temperature = (((((uint32_t)sensor_data[3]) << 16) | (((uint32_t)sensor_data[4]) << 8) | (((uint32_t)sensor_data[5]) << 0)) & 0xFFFFF) / 1048576.0 * 200.0 - 50.0;
+    ESP_LOGI(TAG, "AHT read success.");
+    return ESP_OK;
+}
+
+esp_err_t zh_aht_reset(void)
+{
+    ESP_LOGI(TAG, "AHT reset begin.");
+    if (_is_initialized == false)
+    {
+        ESP_LOGE(TAG, "AHT reset fail. AHT not initialized.");
+        return ESP_ERR_NOT_FOUND;
+    }
+    esp_err_t err = ESP_OK;
+    uint8_t reset_command = I2C_RESET_COMMAND;
+#ifdef CONFIG_IDF_TARGET_ESP8266
+    i2c_cmd_handle_t i2c_cmd_handle = i2c_cmd_link_create();
+    i2c_master_start(i2c_cmd_handle);
+    i2c_master_write_byte(i2c_cmd_handle, I2C_ADDRESS << 1 | I2C_MASTER_WRITE, true);
+    i2c_master_write_byte(i2c_cmd_handle, reset_command, true);
+    i2c_master_stop(i2c_cmd_handle);
+    err = i2c_master_cmd_begin(_init_config.i2c_port, i2c_cmd_handle, 1000 / portTICK_PERIOD_MS);
+    i2c_cmd_link_delete(i2c_cmd_handle);
+#else
+    err = i2c_master_transmit(_aht_handle, &reset_command, sizeof(reset_command), 1000 / portTICK_PERIOD_MS);
+#endif
+    if (err != ESP_OK)
+    {
+        ESP_LOGE(TAG, "AHT reset fail. I2C driver error at line %d.", __LINE__);
+        return ESP_ERR_INVALID_RESPONSE;
+    }
+    vTaskDelay(RESET_TIME / portTICK_PERIOD_MS);
+    ESP_LOGI(TAG, "AHT reset success.");
+    return ESP_OK;
+}
+
+static uint8_t _calc_crc(const uint8_t *buf, size_t len)
+{
+    uint8_t crc = 0xFF;
+    for (uint8_t byte = 0; byte < len; byte++)
+    {
+        crc ^= buf[byte];
+        for (uint8_t i = 8; i > 0; --i)
+        {
+            if ((crc & 0x80) != 0)
+            {
+                crc = (crc << 1) ^ 0x31;
+            }
+            else
+            {
+                crc = crc << 1;
+            }
+        }
+    }
+    return crc;
+}