Compare commits

...

1 Commits
v1.1.0 ... main

Author SHA1 Message Date
eb84f82b89 Version 1.1.1
Added autodetect sensor type.
2024-07-21 09:16:10 +03:00
4 changed files with 81 additions and 67 deletions

View File

@ -5,6 +5,10 @@
1. ESP8266 RTOS_SDK v3.4 1. ESP8266 RTOS_SDK v3.4
2. ESP32 ESP-IDF v5.2 2. ESP32 ESP-IDF v5.2
## Features
1. Autodetect sensor type.
## Using ## Using
In an existing project, run the following command to install the component: In an existing project, run the following command to install the component:

View File

@ -10,11 +10,9 @@
#include "freertos/FreeRTOS.h" #include "freertos/FreeRTOS.h"
#include "freertos/task.h" #include "freertos/task.h"
#define ZH_AHT_INIT_CONFIG_DEFAULT() \ #define ZH_AHT_INIT_CONFIG_DEFAULT() \
{ \ { \
.sensor_type = ZH_AHT2X, \ .i2c_port = 0 \
.i2c_address = ZH_I2C_ADDRESS_LOW, \
.i2c_port = 0 \
} }
#ifdef __cplusplus #ifdef __cplusplus
@ -24,16 +22,6 @@ extern "C"
typedef struct // Structure for initial initialization of AHT sensor. 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. bool i2c_port; // I2C port.
#ifndef CONFIG_IDF_TARGET_ESP8266 #ifndef CONFIG_IDF_TARGET_ESP8266
i2c_master_bus_handle_t i2c_handle; // Unique I2C bus handle. i2c_master_bus_handle_t i2c_handle; // Unique I2C bus handle.

View File

@ -1 +1 @@
1.1.0 1.1.1

124
zh_aht.c
View File

@ -3,6 +3,7 @@
#define I2C_MAX_DATA_SIZE 7 // Sensor maximum data size (in bytes). #define I2C_MAX_DATA_SIZE 7 // Sensor maximum data size (in bytes).
#define MEASUREMENT_TIME 80 // Sensor measurement time (in milliseconds). #define MEASUREMENT_TIME 80 // Sensor measurement time (in milliseconds).
#define RESET_TIME 20 // Sensor reset 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_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_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_COMMAND 0x00, 0x08, 0x00 // Command for initialize sensor. First byte is depend of sensor type.
@ -32,31 +33,31 @@ esp_err_t zh_aht_init(const zh_aht_init_config_t *config)
#ifndef CONFIG_IDF_TARGET_ESP8266 #ifndef CONFIG_IDF_TARGET_ESP8266
i2c_device_config_t aht_config = { i2c_device_config_t aht_config = {
.dev_addr_length = I2C_ADDR_BIT_LEN_7, .dev_addr_length = I2C_ADDR_BIT_LEN_7,
.device_address = _init_config.i2c_address, .device_address = I2C_ADDRESS,
.scl_speed_hz = 100000, .scl_speed_hz = 100000,
}; };
i2c_master_bus_add_device(_init_config.i2c_handle, &aht_config, &_aht_handle); i2c_master_bus_add_device(_init_config.i2c_handle, &aht_config, &_aht_handle);
if (i2c_master_probe(_init_config.i2c_handle, _init_config.i2c_address, 1000 / portTICK_PERIOD_MS) != ESP_OK) 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."); ESP_LOGE(TAG, "AHT initialization fail. Sensor not connected or not responded.");
return ESP_ERR_NOT_FOUND; return ESP_ERR_NOT_FOUND;
} }
#endif #endif
esp_err_t esp_err = ESP_OK; esp_err_t err = ESP_OK;
uint8_t command = I2C_STATUS_READ_COMMAND; uint8_t status_read_command = I2C_STATUS_READ_COMMAND;
uint8_t sensor_data = 0; uint8_t sensor_data = 0;
#ifdef CONFIG_IDF_TARGET_ESP8266 #ifdef CONFIG_IDF_TARGET_ESP8266
i2c_cmd_handle_t i2c_cmd_handle = i2c_cmd_link_create(); i2c_cmd_handle_t i2c_cmd_handle = i2c_cmd_link_create();
i2c_master_start(i2c_cmd_handle); i2c_master_start(i2c_cmd_handle);
i2c_master_write_byte(i2c_cmd_handle, _init_config.i2c_address << 1 | I2C_MASTER_WRITE, true); i2c_master_write_byte(i2c_cmd_handle, I2C_ADDRESS << 1 | I2C_MASTER_WRITE, true);
i2c_master_write_byte(i2c_cmd_handle, command, true); i2c_master_write_byte(i2c_cmd_handle, status_read_command, true);
i2c_master_stop(i2c_cmd_handle); i2c_master_stop(i2c_cmd_handle);
esp_err = i2c_master_cmd_begin(_init_config.i2c_port, i2c_cmd_handle, 1000 / portTICK_PERIOD_MS); err = i2c_master_cmd_begin(_init_config.i2c_port, i2c_cmd_handle, 1000 / portTICK_PERIOD_MS);
i2c_cmd_link_delete(i2c_cmd_handle); i2c_cmd_link_delete(i2c_cmd_handle);
#else #else
esp_err = i2c_master_transmit(_aht_handle, &command, sizeof(command), 1000 / portTICK_PERIOD_MS); err = i2c_master_transmit(_aht_handle, &status_read_command, sizeof(status_read_command), 1000 / portTICK_PERIOD_MS);
#endif #endif
if (esp_err != ESP_OK) if (err != ESP_OK)
{ {
ESP_LOGE(TAG, "AHT initialization fail. I2C driver error at line %d.", __LINE__); ESP_LOGE(TAG, "AHT initialization fail. I2C driver error at line %d.", __LINE__);
return ESP_ERR_INVALID_RESPONSE; return ESP_ERR_INVALID_RESPONSE;
@ -64,44 +65,65 @@ esp_err_t zh_aht_init(const zh_aht_init_config_t *config)
#ifdef CONFIG_IDF_TARGET_ESP8266 #ifdef CONFIG_IDF_TARGET_ESP8266
i2c_cmd_handle = i2c_cmd_link_create(); i2c_cmd_handle = i2c_cmd_link_create();
i2c_master_start(i2c_cmd_handle); i2c_master_start(i2c_cmd_handle);
i2c_master_write_byte(i2c_cmd_handle, _init_config.i2c_address << 1 | I2C_MASTER_READ, true); 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_read_byte(i2c_cmd_handle, &sensor_data, I2C_MASTER_NACK);
i2c_master_stop(i2c_cmd_handle); i2c_master_stop(i2c_cmd_handle);
esp_err = i2c_master_cmd_begin(_init_config.i2c_port, i2c_cmd_handle, 1000 / portTICK_PERIOD_MS); err = i2c_master_cmd_begin(_init_config.i2c_port, i2c_cmd_handle, 1000 / portTICK_PERIOD_MS);
i2c_cmd_link_delete(i2c_cmd_handle); i2c_cmd_link_delete(i2c_cmd_handle);
#else #else
esp_err = i2c_master_receive(_aht_handle, &sensor_data, sizeof(sensor_data), 1000 / portTICK_PERIOD_MS); err = i2c_master_receive(_aht_handle, &sensor_data, sizeof(sensor_data), 1000 / portTICK_PERIOD_MS);
#endif #endif
if (esp_err != ESP_OK) if (err != ESP_OK)
{ {
ESP_LOGE(TAG, "AHT initialization fail. I2C driver error at line %d.", __LINE__); ESP_LOGE(TAG, "AHT initialization fail. I2C driver error at line %d.", __LINE__);
return ESP_ERR_INVALID_RESPONSE; return ESP_ERR_INVALID_RESPONSE;
} }
if ((sensor_data & 0x08) == 0) // If sensor is not calibrated. if ((sensor_data & 0x08) == 0) // If sensor is not calibrated.
{ {
uint8_t command[] = {I2C_INIT_COMMAND}; uint8_t init_command[] = {I2C_INIT_COMMAND};
if (_init_config.sensor_type == ZH_AHT1X) uint8_t check_command = I2C_INIT_AHT2X_FIRST_BYTE;
{ bool is_first_check = false;
command[0] = I2C_INIT_AHT1X_FIRST_BYTE; INIT_SENSOR:;
}
else
{
command[0] = I2C_INIT_AHT2X_FIRST_BYTE;
}
#ifdef CONFIG_IDF_TARGET_ESP8266 #ifdef CONFIG_IDF_TARGET_ESP8266
i2c_cmd_handle_t i2c_cmd_handle = i2c_cmd_link_create(); i2c_cmd_handle = i2c_cmd_link_create();
i2c_master_start(i2c_cmd_handle); i2c_master_start(i2c_cmd_handle);
i2c_master_write_byte(i2c_cmd_handle, _init_config.i2c_address << 1 | I2C_MASTER_WRITE, true); i2c_master_write_byte(i2c_cmd_handle, I2C_ADDRESS << 1 | I2C_MASTER_WRITE, true);
i2c_master_write_byte(i2c_cmd_handle, command[0], true); i2c_master_write_byte(i2c_cmd_handle, check_command, true);
i2c_master_write_byte(i2c_cmd_handle, command[1], true);
i2c_master_write_byte(i2c_cmd_handle, command[2], true);
i2c_master_stop(i2c_cmd_handle); i2c_master_stop(i2c_cmd_handle);
esp_err = i2c_master_cmd_begin(_init_config.i2c_port, i2c_cmd_handle, 1000 / portTICK_PERIOD_MS); err = i2c_master_cmd_begin(_init_config.i2c_port, i2c_cmd_handle, 1000 / portTICK_PERIOD_MS);
i2c_cmd_link_delete(i2c_cmd_handle); i2c_cmd_link_delete(i2c_cmd_handle);
#else #else
esp_err = i2c_master_transmit(_aht_handle, command, sizeof(command), 1000 / portTICK_PERIOD_MS); err = i2c_master_transmit(_aht_handle, &check_command, sizeof(check_command), 1000 / portTICK_PERIOD_MS);
#endif #endif
if (esp_err != ESP_OK) 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__); ESP_LOGE(TAG, "AHT initialization fail. I2C driver error at line %d.", __LINE__);
return ESP_ERR_INVALID_RESPONSE; return ESP_ERR_INVALID_RESPONSE;
@ -125,23 +147,23 @@ esp_err_t zh_aht_read(float *humidity, float *temperature)
ESP_LOGE(TAG, "AHT read fail. AHT not initialized."); ESP_LOGE(TAG, "AHT read fail. AHT not initialized.");
return ESP_ERR_NOT_FOUND; return ESP_ERR_NOT_FOUND;
} }
esp_err_t esp_err = ESP_OK; esp_err_t err = ESP_OK;
uint8_t sensor_data[I2C_MAX_DATA_SIZE] = {0}; uint8_t sensor_data[I2C_MAX_DATA_SIZE] = {0};
uint8_t command[] = {I2C_DATA_READ_COMMAND}; uint8_t data_read_command[] = {I2C_DATA_READ_COMMAND};
#ifdef CONFIG_IDF_TARGET_ESP8266 #ifdef CONFIG_IDF_TARGET_ESP8266
i2c_cmd_handle_t i2c_cmd_handle = i2c_cmd_link_create(); i2c_cmd_handle_t i2c_cmd_handle = i2c_cmd_link_create();
i2c_master_start(i2c_cmd_handle); i2c_master_start(i2c_cmd_handle);
i2c_master_write_byte(i2c_cmd_handle, _init_config.i2c_address << 1 | I2C_MASTER_WRITE, true); i2c_master_write_byte(i2c_cmd_handle, I2C_ADDRESS << 1 | I2C_MASTER_WRITE, true);
i2c_master_write_byte(i2c_cmd_handle, command[0], true); i2c_master_write_byte(i2c_cmd_handle, data_read_command[0], true);
i2c_master_write_byte(i2c_cmd_handle, command[1], true); i2c_master_write_byte(i2c_cmd_handle, data_read_command[1], true);
i2c_master_write_byte(i2c_cmd_handle, command[2], true); i2c_master_write_byte(i2c_cmd_handle, data_read_command[2], true);
i2c_master_stop(i2c_cmd_handle); i2c_master_stop(i2c_cmd_handle);
esp_err = i2c_master_cmd_begin(_init_config.i2c_port, i2c_cmd_handle, 1000 / portTICK_PERIOD_MS); err = i2c_master_cmd_begin(_init_config.i2c_port, i2c_cmd_handle, 1000 / portTICK_PERIOD_MS);
i2c_cmd_link_delete(i2c_cmd_handle); i2c_cmd_link_delete(i2c_cmd_handle);
#else #else
esp_err = i2c_master_transmit(_aht_handle, command, sizeof(command), 1000 / portTICK_PERIOD_MS); err = i2c_master_transmit(_aht_handle, data_read_command, sizeof(data_read_command), 1000 / portTICK_PERIOD_MS);
#endif #endif
if (esp_err != ESP_OK) if (err != ESP_OK)
{ {
ESP_LOGE(TAG, "AHT read fail. I2C driver error at line %d.", __LINE__); ESP_LOGE(TAG, "AHT read fail. I2C driver error at line %d.", __LINE__);
return ESP_ERR_INVALID_RESPONSE; return ESP_ERR_INVALID_RESPONSE;
@ -150,18 +172,18 @@ esp_err_t zh_aht_read(float *humidity, float *temperature)
#ifdef CONFIG_IDF_TARGET_ESP8266 #ifdef CONFIG_IDF_TARGET_ESP8266
i2c_cmd_handle = i2c_cmd_link_create(); i2c_cmd_handle = i2c_cmd_link_create();
i2c_master_start(i2c_cmd_handle); i2c_master_start(i2c_cmd_handle);
i2c_master_write_byte(i2c_cmd_handle, _init_config.i2c_address << 1 | I2C_MASTER_READ, true); i2c_master_write_byte(i2c_cmd_handle, I2C_ADDRESS << 1 | I2C_MASTER_READ, true);
for (uint8_t i = 0; i < sizeof(sensor_data); ++i) 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_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); i2c_master_stop(i2c_cmd_handle);
esp_err = i2c_master_cmd_begin(_init_config.i2c_port, i2c_cmd_handle, 1000 / portTICK_PERIOD_MS); err = i2c_master_cmd_begin(_init_config.i2c_port, i2c_cmd_handle, 1000 / portTICK_PERIOD_MS);
i2c_cmd_link_delete(i2c_cmd_handle); i2c_cmd_link_delete(i2c_cmd_handle);
#else #else
esp_err = i2c_master_receive(_aht_handle, sensor_data, sizeof(sensor_data), 1000 / portTICK_PERIOD_MS); err = i2c_master_receive(_aht_handle, sensor_data, sizeof(sensor_data), 1000 / portTICK_PERIOD_MS);
#endif #endif
if (esp_err != ESP_OK) if (err != ESP_OK)
{ {
ESP_LOGE(TAG, "AHT read fail. I2C driver error at line %d.", __LINE__); ESP_LOGE(TAG, "AHT read fail. I2C driver error at line %d.", __LINE__);
return ESP_ERR_INVALID_RESPONSE; return ESP_ERR_INVALID_RESPONSE;
@ -171,7 +193,7 @@ esp_err_t zh_aht_read(float *humidity, float *temperature)
ESP_LOGE(TAG, "AHT read fail. Timeout exceeded."); ESP_LOGE(TAG, "AHT read fail. Timeout exceeded.");
return ESP_ERR_TIMEOUT; return ESP_ERR_TIMEOUT;
} }
if (_init_config.sensor_type != ZH_AHT1X) if (sensor_data[6] != 0x00 || sensor_data[6] != 0xFF)
{ {
if (_calc_crc(sensor_data, I2C_MAX_DATA_SIZE - 1) != sensor_data[6]) if (_calc_crc(sensor_data, I2C_MAX_DATA_SIZE - 1) != sensor_data[6])
{ {
@ -193,20 +215,20 @@ esp_err_t zh_aht_reset(void)
ESP_LOGE(TAG, "AHT reset fail. AHT not initialized."); ESP_LOGE(TAG, "AHT reset fail. AHT not initialized.");
return ESP_ERR_NOT_FOUND; return ESP_ERR_NOT_FOUND;
} }
esp_err_t esp_err = ESP_OK; esp_err_t err = ESP_OK;
uint8_t command = I2C_RESET_COMMAND; uint8_t reset_command = I2C_RESET_COMMAND;
#ifdef CONFIG_IDF_TARGET_ESP8266 #ifdef CONFIG_IDF_TARGET_ESP8266
i2c_cmd_handle_t i2c_cmd_handle = i2c_cmd_link_create(); i2c_cmd_handle_t i2c_cmd_handle = i2c_cmd_link_create();
i2c_master_start(i2c_cmd_handle); i2c_master_start(i2c_cmd_handle);
i2c_master_write_byte(i2c_cmd_handle, _init_config.i2c_address << 1 | I2C_MASTER_WRITE, true); i2c_master_write_byte(i2c_cmd_handle, I2C_ADDRESS << 1 | I2C_MASTER_WRITE, true);
i2c_master_write_byte(i2c_cmd_handle, command, true); i2c_master_write_byte(i2c_cmd_handle, reset_command, true);
i2c_master_stop(i2c_cmd_handle); i2c_master_stop(i2c_cmd_handle);
esp_err = i2c_master_cmd_begin(_init_config.i2c_port, i2c_cmd_handle, 1000 / portTICK_PERIOD_MS); err = i2c_master_cmd_begin(_init_config.i2c_port, i2c_cmd_handle, 1000 / portTICK_PERIOD_MS);
i2c_cmd_link_delete(i2c_cmd_handle); i2c_cmd_link_delete(i2c_cmd_handle);
#else #else
esp_err = i2c_master_transmit(_aht_handle, &command, sizeof(command), 1000 / portTICK_PERIOD_MS); err = i2c_master_transmit(_aht_handle, &reset_command, sizeof(reset_command), 1000 / portTICK_PERIOD_MS);
#endif #endif
if (esp_err != ESP_OK) if (err != ESP_OK)
{ {
ESP_LOGE(TAG, "AHT reset fail. I2C driver error at line %d.", __LINE__); ESP_LOGE(TAG, "AHT reset fail. I2C driver error at line %d.", __LINE__);
return ESP_ERR_INVALID_RESPONSE; return ESP_ERR_INVALID_RESPONSE;