Compare commits
2 Commits
Author | SHA1 | Date | |
---|---|---|---|
eb84f82b89 | |||
0cdf40a823 |
@ -1,10 +1,14 @@
|
||||
# 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
|
||||
|
||||
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:
|
||||
|
BIN
ds/AHT10.pdf
Normal file
BIN
ds/AHT10.pdf
Normal file
Binary file not shown.
BIN
ds/AHT15.pdf
Normal file
BIN
ds/AHT15.pdf
Normal file
Binary file not shown.
BIN
ds/AHT20.pdf
Normal file
BIN
ds/AHT20.pdf
Normal file
Binary file not shown.
BIN
ds/AHT21.pdf
Normal file
BIN
ds/AHT21.pdf
Normal file
Binary file not shown.
BIN
ds/AHT25.pdf
Normal file
BIN
ds/AHT25.pdf
Normal file
Binary file not shown.
BIN
ds/AHT30.pdf
Normal file
BIN
ds/AHT30.pdf
Normal file
Binary file not shown.
@ -26,7 +26,6 @@ extern "C"
|
||||
#ifndef CONFIG_IDF_TARGET_ESP8266
|
||||
i2c_master_bus_handle_t i2c_handle; // Unique I2C bus handle.
|
||||
#endif
|
||||
|
||||
} zh_aht_init_config_t;
|
||||
|
||||
/**
|
||||
|
@ -1 +1 @@
|
||||
1.0.1
|
||||
1.1.1
|
122
zh_aht.c
122
zh_aht.c
@ -1,12 +1,14 @@
|
||||
#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_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 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};
|
||||
@ -41,21 +43,21 @@ esp_err_t zh_aht_init(const zh_aht_init_config_t *config)
|
||||
return ESP_ERR_NOT_FOUND;
|
||||
}
|
||||
#endif
|
||||
esp_err_t esp_err = ESP_OK;
|
||||
uint8_t command = I2C_STATUS_READ_COMMAND;
|
||||
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, command, true);
|
||||
i2c_master_write_byte(i2c_cmd_handle, status_read_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);
|
||||
err = i2c_master_cmd_begin(_init_config.i2c_port, i2c_cmd_handle, 1000 / portTICK_PERIOD_MS);
|
||||
i2c_cmd_link_delete(i2c_cmd_handle);
|
||||
#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
|
||||
if (esp_err != ESP_OK)
|
||||
if (err != ESP_OK)
|
||||
{
|
||||
ESP_LOGE(TAG, "AHT initialization fail. I2C driver error at line %d.", __LINE__);
|
||||
return ESP_ERR_INVALID_RESPONSE;
|
||||
@ -66,33 +68,62 @@ esp_err_t zh_aht_init(const zh_aht_init_config_t *config)
|
||||
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);
|
||||
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);
|
||||
#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
|
||||
if (esp_err != ESP_OK)
|
||||
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 & 0b00001000) == 0)
|
||||
if ((sensor_data & 0x08) == 0) // If sensor is not calibrated.
|
||||
{
|
||||
uint8_t command[] = {I2C_INIT_COMMAND};
|
||||
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_t i2c_cmd_handle = i2c_cmd_link_create();
|
||||
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, command[0], true);
|
||||
i2c_master_write_byte(i2c_cmd_handle, command[1], true);
|
||||
i2c_master_write_byte(i2c_cmd_handle, command[2], true);
|
||||
i2c_master_write_byte(i2c_cmd_handle, check_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);
|
||||
err = i2c_master_cmd_begin(_init_config.i2c_port, i2c_cmd_handle, 1000 / portTICK_PERIOD_MS);
|
||||
i2c_cmd_link_delete(i2c_cmd_handle);
|
||||
#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
|
||||
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__);
|
||||
return ESP_ERR_INVALID_RESPONSE;
|
||||
@ -116,23 +147,23 @@ esp_err_t zh_aht_read(float *humidity, float *temperature)
|
||||
ESP_LOGE(TAG, "AHT read fail. AHT not initialized.");
|
||||
return ESP_ERR_NOT_FOUND;
|
||||
}
|
||||
esp_err_t esp_err = ESP_OK;
|
||||
uint8_t sensor_data[I2C_DATA_SIZE] = {0};
|
||||
uint8_t command[] = {I2C_DATA_READ_COMMAND};
|
||||
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, command[0], true);
|
||||
i2c_master_write_byte(i2c_cmd_handle, command[1], true);
|
||||
i2c_master_write_byte(i2c_cmd_handle, command[2], 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);
|
||||
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);
|
||||
#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
|
||||
if (esp_err != ESP_OK)
|
||||
if (err != ESP_OK)
|
||||
{
|
||||
ESP_LOGE(TAG, "AHT read fail. I2C driver error at line %d.", __LINE__);
|
||||
return ESP_ERR_INVALID_RESPONSE;
|
||||
@ -147,25 +178,28 @@ esp_err_t zh_aht_read(float *humidity, float *temperature)
|
||||
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);
|
||||
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);
|
||||
#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
|
||||
if (esp_err != ESP_OK)
|
||||
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] & 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 (sensor_data[6] != 0x00 || sensor_data[6] != 0xFF)
|
||||
{
|
||||
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;
|
||||
@ -181,20 +215,20 @@ esp_err_t zh_aht_reset(void)
|
||||
ESP_LOGE(TAG, "AHT reset fail. AHT not initialized.");
|
||||
return ESP_ERR_NOT_FOUND;
|
||||
}
|
||||
esp_err_t esp_err = ESP_OK;
|
||||
uint8_t command = I2C_RESET_COMMAND;
|
||||
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, command, true);
|
||||
i2c_master_write_byte(i2c_cmd_handle, reset_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);
|
||||
err = i2c_master_cmd_begin(_init_config.i2c_port, i2c_cmd_handle, 1000 / portTICK_PERIOD_MS);
|
||||
i2c_cmd_link_delete(i2c_cmd_handle);
|
||||
#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
|
||||
if (esp_err != ESP_OK)
|
||||
if (err != ESP_OK)
|
||||
{
|
||||
ESP_LOGE(TAG, "AHT reset fail. I2C driver error at line %d.", __LINE__);
|
||||
return ESP_ERR_INVALID_RESPONSE;
|
||||
|
Loading…
x
Reference in New Issue
Block a user