alexey.zholtikov/zh_htu
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

WIP

Browse Source
This commit is contained in:
Alexey Zholtikov
2024-07-24 14:12:16 +03:00
parent 958f4c29e1
commit f6329c5d99
8 changed files with 394 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
CMakeLists.txt Normal file → Executable file
View File

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

0
LICENSE Normal file → Executable file
View File

77
README.md Normal file → Executable file
View File

@@ -1,3 +1,76 @@
# esp_component_template
# ESP32 ESP-IDF and ESP8266 RTOS SDK component for HTU20/HTU21 humidity & temperature sensor
esp_component_template
## Tested on
1. ESP8266 RTOS_SDK v3.4
2. ESP32 ESP-IDF v5.2
## 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_htu.git
```
In the application, add the component:
```c
#include "zh_htu.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.

0
component.mk Normal file → Executable file
View File

0
include/main.h
View File

88
include/zh_htu.h Executable file
View File

@@ -0,0 +1,88 @@
#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_HTU_INIT_CONFIG_DEFAULT() \
{ \
.i2c_port = 0, \
.resolution = HTU_RES_12_14 \
}
#ifdef __cplusplus
extern "C"
{
#endif
typedef enum
{
HTU_RES_8_12 = 0x1, // 8 bit humidity resolution / 12 bit temperature resolution.
HTU_RES_10_13 = 0x40, // 10 bit humidity resolution / 13 bit temperature resolution.
HTU_RES_11_11 = 0x41, // 11 bit humidity resolution / 11 bit temperature resolution.
HTU_RES_12_14 = 0x0 // 12 bit humidity resolution / 14 bit temperature resolution.
} zh_htu_resolution_t;
typedef struct // Structure for initial initialization of AHT sensor.
{
bool i2c_port; // I2C port.
zh_htu_resolution_t resolution; // Sensor measurement resolution.
#ifndef CONFIG_IDF_TARGET_ESP8266
i2c_master_bus_handle_t i2c_handle; // Unique I2C bus handle.
#endif
} zh_htu_init_config_t;
/**
* @brief Initialize HTU sensor.
*
* @param[in] config Pointer to HTU initialized configuration structure. Can point to a temporary variable.
*
* @attention I2C driver must be initialized first.
*
* @note Before initialize the sensor recommend initialize zh_htu_init_config_t structure with default values.
*
* @code zh_htu_init_config_t config = ZH_HTU_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_htu_init(const zh_htu_init_config_t *config);
/**
* @brief Read HTU sensor.
*
* @param[out] humidity Pointer for HTU sensor reading data of humidity.
* @param[out] temperature Pointer for HTU 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_htu_read(float *humidity, float *temperature);
/**
* @brief Reset HTU 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_htu_reset(void);
#ifdef __cplusplus
}
#endif

1
version.txt Normal file → Executable file
View File

@@ -0,0 +1 @@
1.0.1

229
zh_htu.c Executable file
View File

@@ -0,0 +1,229 @@
#include "zh_htu.h"
#define I2C_DATA_SIZE 3 // Sensor data size (in bytes).
#define TEMPERATURE_MEASUREMENT_TIME 50 // Sensor temperature measurement time (in milliseconds).
#define HUMIDITY_MEASUREMENT_TIME 20 // Sensor humidity measurement time (in milliseconds).
#define RESET_TIME 20 // Sensor reset time (in milliseconds).
#define I2C_ADDRESS 0x40 // Sensor I2C address.
#define I2C_TEMPERATURE_DATA_READ_COMMAND 0xF3 // Command for read sensor temperature data.
#define I2C_HUMIDITY_DATA_READ_COMMAND 0xF5 // Command for read sensor humidity data.
#define I2C_RESET_COMMAND 0xFE // Command for reset sensor.
#define I2C_REGISTER_READ_COMMAND 0xE7 // Command for read sensor register.
#define I2C_REGISTER_WRITE_COMMAND 0xE6 // Command for write sensor register.
static zh_htu_init_config_t _init_config = {0};
static bool _is_initialized = false;
#ifndef CONFIG_IDF_TARGET_ESP8266
static i2c_master_dev_handle_t _htu_handle = {0};
#endif
static const char *TAG = "zh_htu";
static uint8_t _calc_crc(const uint8_t *buf, size_t len);
esp_err_t zh_htu_init(const zh_htu_init_config_t *config)
{
ESP_LOGI(TAG, "HTU initialization begin.");
if (config == NULL)
{
ESP_LOGE(TAG, "HTU initialization fail. Invalid argument.");
return ESP_ERR_INVALID_ARG;
}
_init_config = *config;
#ifndef CONFIG_IDF_TARGET_ESP8266
i2c_device_config_t htu_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, &htu_config, &_htu_handle);
if (i2c_master_probe(_init_config.i2c_handle, I2C_ADDRESS, 1000 / portTICK_PERIOD_MS) != ESP_OK)
{
ESP_LOGE(TAG, "HTU initialization fail. Sensor not connected or not responded.");
return ESP_ERR_NOT_FOUND;
}
#endif
esp_err_t esp_err = ESP_OK;
uint8_t 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_stop(i2c_cmd_handle);
esp_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(_htu_handle, &command, sizeof(command), 1000 / portTICK_PERIOD_MS);
#endif
if (esp_err != ESP_OK)
{
ESP_LOGE(TAG, "HTU 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);
esp_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(_htu_handle, &sensor_data, sizeof(sensor_data), 1000 / portTICK_PERIOD_MS);
#endif
if (esp_err != ESP_OK)
{
ESP_LOGE(TAG, "HTU initialization fail. I2C driver error at line %d.", __LINE__);
return ESP_ERR_INVALID_RESPONSE;
}
if ((sensor_data & 0b00001000) == 0)
{
uint8_t command[] = {I2C_INIT_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_stop(i2c_cmd_handle);
esp_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(_htu_handle, command, sizeof(command), 1000 / portTICK_PERIOD_MS);
#endif
if (esp_err != ESP_OK)
{
ESP_LOGE(TAG, "HTU initialization fail. I2C driver error at line %d.", __LINE__);
return ESP_ERR_INVALID_RESPONSE;
}
}
ESP_LOGI(TAG, "HTU initialization success.");
_is_initialized = true;
return ESP_OK;
}
esp_err_t zh_htu_read(float *humidity, float *temperature)
{
ESP_LOGI(TAG, "HTU read begin.");
if (humidity == NULL || temperature == NULL)
{
ESP_LOGE(TAG, "HTU read fail. Invalid argument.");
return ESP_ERR_INVALID_ARG;
}
if (_is_initialized == false)
{
ESP_LOGE(TAG, "HTU read fail. HTU 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};
#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_stop(i2c_cmd_handle);
esp_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(_htu_handle, command, sizeof(command), 1000 / portTICK_PERIOD_MS);
#endif
if (esp_err != ESP_OK)
{
ESP_LOGE(TAG, "HTU 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);
esp_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(_htu_handle, sensor_data, sizeof(sensor_data), 1000 / portTICK_PERIOD_MS);
#endif
if (esp_err != ESP_OK)
{
ESP_LOGE(TAG, "HTU read fail. I2C driver error at line %d.", __LINE__);
return ESP_ERR_INVALID_RESPONSE;
}
if ((sensor_data[0] & 0b01000000) != 0)
{
ESP_LOGE(TAG, "HTU read fail. Timeout exceeded.");
return ESP_ERR_TIMEOUT;
}
if (_calc_crc(sensor_data, I2C_DATA_SIZE - 1) != sensor_data[6])
{
ESP_LOGE(TAG, "HTU 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, "HTU read success.");
return ESP_OK;
}
esp_err_t zh_htu_reset(void)
{
ESP_LOGI(TAG, "HTU reset begin.");
if (_is_initialized == false)
{
ESP_LOGE(TAG, "HTU reset fail. HTU not initialized.");
return ESP_ERR_NOT_FOUND;
}
esp_err_t esp_err = ESP_OK;
uint8_t 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_stop(i2c_cmd_handle);
esp_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(_htu_handle, &command, sizeof(command), 1000 / portTICK_PERIOD_MS);
#endif
if (esp_err != ESP_OK)
{
ESP_LOGE(TAG, "HTU reset fail. I2C driver error at line %d.", __LINE__);
return ESP_ERR_INVALID_RESPONSE;
}
vTaskDelay(RESET_TIME / portTICK_PERIOD_MS);
// Write user register.
ESP_LOGI(TAG, "HTU 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;
}