aZholtikov/zh_aht
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

perf: updated error checks

Browse Source
This commit is contained in:
aZholtikov committed 2026-04-05 09:58:56 +03:00
1 parent 6ed641a5c7
commit 89ad22346c
8 files changed
+71 -137
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

ds/AHT10.pdf → AHT10 datasheet.pdf
View File
File renamed without changes.
ds/AHT15.pdf → AHT15 datasheet.pdf
View File
File renamed without changes.
ds/AHT20.pdf → AHT20 datasheet.pdf
View File
File renamed without changes.
ds/AHT21.pdf → AHT21 datasheet.pdf
View File
File renamed without changes.
ds/AHT25.pdf → AHT25 datasheet.pdf
View File
File renamed without changes.
ds/AHT30.pdf → AHT30 datasheet.pdf
View File
File renamed without changes.
include/zh_aht.h
-1
View File
@@ -8,7 +8,6 @@
#include "esp_log.h"
#include "driver/i2c_master.h"
#include "freertos/FreeRTOS.h"
// #include "freertos/task.h"
/**
* @brief AHT sensor initial default values.
zh_aht.c
+71 -136
View File
@@ -1,163 +1,98 @@
#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;
static i2c_master_dev_handle_t _aht_handle = {0};
static const char *TAG = "zh_aht";
static uint8_t _calc_crc(const uint8_t *buf, size_t len);
#define ZH_LOGI(msg, ...) ESP_LOGI(TAG, msg, ##__VA_ARGS__)
#define ZH_LOGE(msg, err, ...) ESP_LOGE(TAG, "[%s:%d:%s] " msg, __FILE__, __LINE__, esp_err_to_name(err), ##__VA_ARGS__)
#define ZH_ERROR_CHECK(cond, err, cleanup, msg, ...) \
if (!(cond)) \
{ \
ZH_LOGE(msg, err, ##__VA_ARGS__); \
cleanup; \
return err; \
}
static const uint8_t _aht_reset_command = 0xBA;
static const uint8_t _aht_read_command[] = {0xAC, 0x33, 0x00};
static const uint8_t _aht_init_command[] = {0xBE, 0x08, 0x00};
static zh_aht_init_config_t _init_config = {0};
volatile static bool _is_initialized = false;
static i2c_master_dev_handle_t _aht_handle = {0};
static esp_err_t _zh_aht_validate_config(const zh_aht_init_config_t *config);
static esp_err_t _zh_aht_i2c_init(const zh_aht_init_config_t *config);
static uint8_t _zh_aht_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;
}
ZH_LOGI("AHT initialization begin.");
ZH_ERROR_CHECK(config != NULL, ESP_ERR_INVALID_ARG, NULL, "AHT initialization failed. Invalid argument.");
ZH_ERROR_CHECK(_zh_aht_validate_config(config) == ESP_OK, ESP_FAIL, NULL, "AHT initialization failed. Initial configuration check failed.");
ZH_ERROR_CHECK(_zh_aht_i2c_init(config) == ESP_OK, ESP_FAIL, NULL, "AHT initialization failed. Failed to add I2C device.");
_init_config = *config;
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;
}
esp_err_t err = ESP_OK;
uint8_t status_read_command = I2C_STATUS_READ_COMMAND;
uint8_t sensor_data = 0;
err = i2c_master_transmit(_aht_handle, &status_read_command, sizeof(status_read_command), 1000 / portTICK_PERIOD_MS);
if (err != ESP_OK)
{
ESP_LOGE(TAG, "AHT initialization fail. I2C driver error at line %d.", __LINE__);
return ESP_ERR_INVALID_RESPONSE;
}
err = i2c_master_receive(_aht_handle, &sensor_data, sizeof(sensor_data), 1000 / portTICK_PERIOD_MS);
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)
{
uint8_t init_command[] = {I2C_INIT_COMMAND};
uint8_t check_command = I2C_INIT_AHT2X_FIRST_BYTE;
bool is_first_check = false;
INIT_SENSOR:
err = i2c_master_transmit(_aht_handle, &check_command, sizeof(check_command), 1000 / portTICK_PERIOD_MS);
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;
err = i2c_master_transmit(_aht_handle, init_command, sizeof(init_command), 1000 / portTICK_PERIOD_MS);
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;
ZH_LOGI("AHT initialization completed successfully.");
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};
err = i2c_master_transmit(_aht_handle, data_read_command, sizeof(data_read_command), 1000 / portTICK_PERIOD_MS);
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);
err = i2c_master_receive(_aht_handle, sensor_data, sizeof(sensor_data), 1000 / portTICK_PERIOD_MS);
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)
{
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;
}
}
ZH_LOGI("AHT read begin.");
ZH_ERROR_CHECK(_is_initialized == true, ESP_ERR_NOT_FOUND, NULL, "AHT read fail. AHT not initialized.");
ZH_ERROR_CHECK(humidity != NULL && temperature != NULL, ESP_ERR_INVALID_ARG, NULL, "AHT read fail. Invalid argument.");
uint8_t sensor_data[7] = {0};
ZH_ERROR_CHECK(i2c_master_transmit(_aht_handle, _aht_read_command, sizeof(_aht_read_command), 1000 / portTICK_PERIOD_MS) == ESP_OK, ESP_FAIL, NULL, "AHT read fail. I2C driver error.");
vTaskDelay(80 / portTICK_PERIOD_MS);
ZH_ERROR_CHECK(i2c_master_receive(_aht_handle, sensor_data, sizeof(sensor_data), 1000 / portTICK_PERIOD_MS) == ESP_OK, ESP_FAIL, NULL, "AHT read fail. I2C driver error.");
ZH_ERROR_CHECK((sensor_data[0] & 0x80) == 0, ESP_ERR_TIMEOUT, NULL, "AHT read fail. Timeout exceeded.");
ZH_ERROR_CHECK(_zh_aht_calc_crc(sensor_data, 6) == sensor_data[6], ESP_ERR_INVALID_CRC, NULL, "AHT read fail. 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.");
ZH_LOGI("AHT read completed successfully.");
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;
err = i2c_master_transmit(_aht_handle, &reset_command, sizeof(reset_command), 1000 / portTICK_PERIOD_MS);
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.");
ZH_LOGI("AHT reset begin.");
ZH_ERROR_CHECK(_is_initialized == true, ESP_ERR_NOT_FOUND, NULL, "AHT reset fail. AHT not initialized.");
ZH_ERROR_CHECK(i2c_master_transmit(_aht_handle, &_aht_reset_command, sizeof(_aht_reset_command), 1000 / portTICK_PERIOD_MS) == ESP_OK, ESP_FAIL, NULL, "AHT reset fail. I2C driver error.");
vTaskDelay(20 / portTICK_PERIOD_MS);
ZH_LOGI("AHT reset completed successfully.");
return ESP_OK;
}
static uint8_t _calc_crc(const uint8_t *buf, size_t len)
static esp_err_t _zh_aht_validate_config(const zh_aht_init_config_t *config)
{
ZH_ERROR_CHECK(config->i2c_handle != NULL, ESP_ERR_INVALID_ARG, NULL, "Invalid I2C handle.");
return ESP_OK;
}
static esp_err_t _zh_aht_i2c_init(const zh_aht_init_config_t *config)
{
i2c_device_config_t aht_config = {
.dev_addr_length = I2C_ADDR_BIT_LEN_7,
.device_address = 0x38,
.scl_speed_hz = 100000,
};
ZH_ERROR_CHECK(i2c_master_bus_add_device(config->i2c_handle, &aht_config, &_aht_handle) == ESP_OK, ESP_FAIL, NULL, "Add I2C device failed.");
vTaskDelay(100 / portTICK_PERIOD_MS);
ZH_ERROR_CHECK(i2c_master_probe(config->i2c_handle, 0x38, 1000 / portTICK_PERIOD_MS) == ESP_OK, ESP_ERR_NOT_FOUND,
ZH_ERROR_CHECK(i2c_master_bus_rm_device(_aht_handle) == ESP_OK, ESP_FAIL, NULL, "I2C remove device failed."), "Sensor not connected or not responded.");
uint8_t sensor_data = 0;
ZH_ERROR_CHECK(i2c_master_receive(_aht_handle, &sensor_data, sizeof(sensor_data), 1000 / portTICK_PERIOD_MS) == ESP_OK, ESP_FAIL,
ZH_ERROR_CHECK(i2c_master_bus_rm_device(_aht_handle) == ESP_OK, ESP_FAIL, NULL, "I2C remove device failed."), "I2C driver error.");
if ((sensor_data & 0x08) == 0)
{
ZH_ERROR_CHECK(i2c_master_transmit(_aht_handle, _aht_init_command, sizeof(_aht_init_command), 1000 / portTICK_PERIOD_MS) == ESP_OK, ESP_FAIL,
ZH_ERROR_CHECK(i2c_master_bus_rm_device(_aht_handle) == ESP_OK, ESP_FAIL, NULL, "I2C remove device failed."), "I2C driver error.");
vTaskDelay(20 / portTICK_PERIOD_MS);
}
return ESP_OK;
}
static uint8_t _zh_aht_calc_crc(const uint8_t *buf, size_t len)
{
uint8_t crc = 0xFF;
for (uint8_t byte = 0; byte < len; byte++)