diff --git a/README.md b/README.md index a94ae57..38871eb 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# ESP32 ESP-IDF and ESP8266 RTOS SDK component for AHT20/AHT21 humidity & temperature sensor +# ESP32 ESP-IDF and ESP8266 RTOS SDK component for AHT10/AHT15/AHT20/AHT21/AHT25/AHT30 humidity & temperature sensor ## Tested on diff --git a/ds/AHT10.pdf b/ds/AHT10.pdf new file mode 100644 index 0000000..016062c Binary files /dev/null and b/ds/AHT10.pdf differ diff --git a/ds/AHT15.pdf b/ds/AHT15.pdf new file mode 100644 index 0000000..73f711c Binary files /dev/null and b/ds/AHT15.pdf differ diff --git a/ds/AHT20.pdf b/ds/AHT20.pdf new file mode 100644 index 0000000..166796f Binary files /dev/null and b/ds/AHT20.pdf differ diff --git a/ds/AHT21.pdf b/ds/AHT21.pdf new file mode 100644 index 0000000..f991659 Binary files /dev/null and b/ds/AHT21.pdf differ diff --git a/ds/AHT25.pdf b/ds/AHT25.pdf new file mode 100644 index 0000000..c870131 Binary files /dev/null and b/ds/AHT25.pdf differ diff --git a/ds/AHT30.pdf b/ds/AHT30.pdf new file mode 100644 index 0000000..22eea6b Binary files /dev/null and b/ds/AHT30.pdf differ diff --git a/include/zh_aht.h b/include/zh_aht.h index 9fd6196..cb809b2 100644 --- a/include/zh_aht.h +++ b/include/zh_aht.h @@ -10,9 +10,11 @@ #include "freertos/FreeRTOS.h" #include "freertos/task.h" -#define ZH_AHT_INIT_CONFIG_DEFAULT() \ - { \ - .i2c_port = 0 \ +#define ZH_AHT_INIT_CONFIG_DEFAULT() \ + { \ + .sensor_type = ZH_AHT2X, \ + .i2c_address = ZH_I2C_ADDRESS_LOW, \ + .i2c_port = 0 \ } #ifdef __cplusplus @@ -22,11 +24,20 @@ extern "C" typedef struct // Structure for initial initialization of AHT sensor. { + enum // Sensor type. + { + ZH_AHT1X, // AHT10/AHT15. + ZH_AHT2X // AHT20/AHT21/AHT25/AHT30. + } sensor_type; + enum // Sensor I2C address. + { + ZH_I2C_ADDRESS_HIGH = 0x39, // Address pin connected to VCC. AHT10 only. + ZH_I2C_ADDRESS_LOW = 0x38 // AHT15/AHT20/AHT21/AHT25/AHT30. AHT10 address pin connected to GND. + } i2c_address; 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; /** diff --git a/version.txt b/version.txt index 7f20734..1cc5f65 100644 --- a/version.txt +++ b/version.txt @@ -1 +1 @@ -1.0.1 \ No newline at end of file +1.1.0 \ No newline at end of file diff --git a/zh_aht.c b/zh_aht.c index a258d71..70cfb1a 100644 --- a/zh_aht.c +++ b/zh_aht.c @@ -1,12 +1,13 @@ #include "zh_aht.h" -#define I2C_DATA_SIZE 7 // Sensor data size. -#define MEASUREMENT_TIME 80 // Sensor measurement time. -#define RESET_TIME 20 // Sensor reset time. -#define I2C_ADDRESS 0x38 // Sensor I2C address. +#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_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 0xBE, 0x08, 0x00 // Command for initialize 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}; @@ -31,11 +32,11 @@ esp_err_t zh_aht_init(const zh_aht_init_config_t *config) #ifndef CONFIG_IDF_TARGET_ESP8266 i2c_device_config_t aht_config = { .dev_addr_length = I2C_ADDR_BIT_LEN_7, - .device_address = I2C_ADDRESS, + .device_address = _init_config.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) + if (i2c_master_probe(_init_config.i2c_handle, _init_config.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; @@ -47,7 +48,7 @@ esp_err_t zh_aht_init(const zh_aht_init_config_t *config) #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, _init_config.i2c_address << 1 | I2C_MASTER_WRITE, true); i2c_master_write_byte(i2c_cmd_handle, command, true); i2c_master_stop(i2c_cmd_handle); esp_err = i2c_master_cmd_begin(_init_config.i2c_port, i2c_cmd_handle, 1000 / portTICK_PERIOD_MS); @@ -63,7 +64,7 @@ esp_err_t zh_aht_init(const zh_aht_init_config_t *config) #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_write_byte(i2c_cmd_handle, _init_config.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); esp_err = i2c_master_cmd_begin(_init_config.i2c_port, i2c_cmd_handle, 1000 / portTICK_PERIOD_MS); @@ -76,13 +77,21 @@ esp_err_t zh_aht_init(const zh_aht_init_config_t *config) ESP_LOGE(TAG, "AHT initialization fail. I2C driver error at line %d.", __LINE__); return ESP_ERR_INVALID_RESPONSE; } - if ((sensor_data & 0b00001000) == 0) + if ((sensor_data & 0x08) == 0) // If sensor is not calibrated. { uint8_t command[] = {I2C_INIT_COMMAND}; + if (_init_config.sensor_type == ZH_AHT1X) + { + command[0] = I2C_INIT_AHT1X_FIRST_BYTE; + } + else + { + command[0] = I2C_INIT_AHT2X_FIRST_BYTE; + } #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, _init_config.i2c_address << 1 | I2C_MASTER_WRITE, true); i2c_master_write_byte(i2c_cmd_handle, command[0], true); i2c_master_write_byte(i2c_cmd_handle, command[1], true); i2c_master_write_byte(i2c_cmd_handle, command[2], true); @@ -117,12 +126,12 @@ esp_err_t zh_aht_read(float *humidity, float *temperature) return ESP_ERR_NOT_FOUND; } esp_err_t esp_err = ESP_OK; - uint8_t sensor_data[I2C_DATA_SIZE] = {0}; + uint8_t sensor_data[I2C_MAX_DATA_SIZE] = {0}; uint8_t 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, _init_config.i2c_address << 1 | I2C_MASTER_WRITE, true); i2c_master_write_byte(i2c_cmd_handle, command[0], true); i2c_master_write_byte(i2c_cmd_handle, command[1], true); i2c_master_write_byte(i2c_cmd_handle, command[2], true); @@ -141,7 +150,7 @@ esp_err_t zh_aht_read(float *humidity, float *temperature) #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_write_byte(i2c_cmd_handle, _init_config.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); @@ -157,15 +166,18 @@ esp_err_t zh_aht_read(float *humidity, float *temperature) ESP_LOGE(TAG, "AHT read fail. I2C driver error at line %d.", __LINE__); return ESP_ERR_INVALID_RESPONSE; } - if ((sensor_data[0] & 0b01000000) != 0) + 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 (_calc_crc(sensor_data, I2C_DATA_SIZE - 1) != sensor_data[6]) + if (_init_config.sensor_type != ZH_AHT1X) { - ESP_LOGE(TAG, "AHT read fail. Invalid CRC."); - return ESP_ERR_INVALID_CRC; + 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; @@ -186,7 +198,7 @@ esp_err_t zh_aht_reset(void) #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, _init_config.i2c_address << 1 | I2C_MASTER_WRITE, true); i2c_master_write_byte(i2c_cmd_handle, command, true); i2c_master_stop(i2c_cmd_handle); esp_err = i2c_master_cmd_begin(_init_config.i2c_port, i2c_cmd_handle, 1000 / portTICK_PERIOD_MS);