aZholtikov/zh_aht
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
e8c79cf07844fdc5964543587c4412d785828cdb
zh_aht/WIKI_RU.md
T
aZholtikov e8c79cf078 style: updated examples
2026-06-13 08:21:09 +03:00

16 KiB
Raw Blame History

zh_aht - Компонент датчика влажности и температуры AHT для ESP-IDF

Содержание

Обзор

zh_aht - это легковесный компонент ESP-IDF для датчиков влажности и температуры AHT10/AHT15/AHT20/AHT21/AHT25/AHT30. Он предоставляет простой API для считывания значений влажности от 0 до 100% и температуры от -40 до +85°C. Компонент поддерживает несколько датчиков на одной шине I2C с использованием I2C мультиплексатора zh_pca9548a.

Компонент разработан специально для микроконтроллеров ESP32 и использует API драйвера I2C ESP-IDF v5.0+.

Возможности

  1. Измерение влажности и температуры: Считывание значений влажности от 0 до 100% и температуры от -40 до +85°C
  2. Интерфейс I2C: Использует стандартный протокол I2C (макс. частота 400 кГц)
  3. Настраиваемый адрес I2C: Поддерживает адреса 0x38 и 0x39
  4. Поддержка нескольких моделей: AHT10, AHT15, AHT20, AHT21, AHT25, AHT30
  5. Статистика ошибок: Встроенный счетчик ошибок драйвера I2C
  6. Низкое энергопотребление: Работает с системой управления питанием ESP-IDF
  7. Потокобезопасность: Использует драйвер I2C ESP-IDF (потокобезопасен)
  8. Минимальные накладные расходы: Низкие накладные расходы на память и процессор
  9. Поддержка нескольких датчиков: Совместим с I2C мультиплексатором (zh_pca9548a)

Установка

  1. Перейдите в каталог компонентов вашего проекта:
cd ../ваш_проект/components
  1. Клонируйте репозиторий:
git clone https://github.com/aZholtikov/zh_aht.git
  1. В вашем приложении подключите заголовочный файл:
#include "zh_aht.h"
  1. Компонент будет автоматически собран вместе с вашим проектом.

Обязательные настройки в menuconfig

Для корректной работы компонента включите следующие настройки в menuconfig:

I2C_ISR_IRAM_SAFE
I2C_MASTER_ISR_HANDLER_IN_IRAM

Опционально: Использование с I2C мультиплексатором (zh_pca9548a)

Для использования нескольких датчиков AHT на одной шине I2C, также установите компонент zh_pca9548a.

Справочник API

Структура zh_aht_init_config_t

typedef struct
{
    i2c_master_bus_handle_t i2c_handle; // Уникальный дескриптор шины I2C
    uint8_t i2c_address;                // Адрес устройства датчика I2C (0x38 или 0x39)
    uint32_t i2c_frequency;             // Частота I2C датчика (макс. 400000 Гц)
} zh_aht_init_config_t;

Используйте макрос ZH_AHT_INIT_CONFIG_DEFAULT() для инициализации значениями по умолчанию:

  • i2c_frequency: 400000 Гц
  • i2c_address: 0x38

Структура zh_aht_handle_t

typedef struct
{
    bool is_initialized;                // Флаг инициализации датчика
    i2c_master_dev_handle_t dev_handle; // Уникальный дескриптор устройства I2C
} zh_aht_handle_t;

Структура zh_aht_stats_t

typedef struct
{
    uint32_t i2c_driver_error; // Количество ошибок драйвера I2C
} zh_aht_stats_t;

zh_aht_init()

Инициализирует датчик AHT.

Параметры:

  • config - Указатель на структуру конфигурации инициализации AHT
  • handle - Указатель на уникальный дескриптор AHT

Возвращает:

  • ESP_OK - Успех
  • ESP_ERR_INVALID_ARG - Неверный аргумент (NULL config или handle)
  • ESP_FAIL - Ошибка инициализации (проверка конфигурации или добавление устройства I2C)

Пример:

zh_aht_handle_t aht_handle = {0};
zh_aht_init_config_t config = ZH_AHT_INIT_CONFIG_DEFAULT();
config.i2c_handle = i2c_bus_handle;
zh_aht_init(&config, &aht_handle);

zh_aht_deinit()

Деинициализирует датчик AHT и удаляет его из шины I2C.

Параметры:

  • handle - Указатель на уникальный дескриптор AHT

Возвращает:

  • ESP_OK - Успех
  • ESP_ERR_INVALID_ARG - Неверный аргумент (NULL handle)
  • ESP_ERR_INVALID_STATE - Датчик не инициализирован
  • ESP_FAIL - Ошибка удаления устройства I2C

zh_aht_read()

Считывает значения влажности и температуры с датчика.

Параметры:

  • handle - Указатель на уникальный дескриптор AHT
  • humidity - Указатель для хранения значения влажности (в %)
  • temperature - Указатель для хранения значения температуры (в °C)

Возвращает:

  • ESP_OK - Успех
  • ESP_ERR_INVALID_ARG - Неверный аргумент (NULL handle, humidity или temperature)
  • ESP_ERR_NOT_FOUND - Датчик не инициализирован
  • ESP_ERR_TIMEOUT - Превышено время ожидания готовности данных
  • ESP_ERR_INVALID_CRC - Неверная CRC контрольная сумма
  • ESP_FAIL - Ошибка связи I2C

Примечание: Функция выполняет измерение и ожидает ~80 мс готовности данных.

zh_aht_reset()

Сбрасывает датчик AHT.

Параметры:

  • handle - Указатель на уникальный дескриптор AHT

Возвращает:

  • ESP_OK - Успех
  • ESP_ERR_INVALID_ARG - Неверный аргумент (NULL handle)
  • ESP_ERR_NOT_FOUND - Датчик не инициализирован
  • ESP_FAIL - Ошибка связи I2C

zh_aht_get_stats()

Получает статистику ошибок с момента последнего сброса.

Возвращает:

  • Указатель на структуру статистики

Пример:

const zh_aht_stats_t *stats = zh_aht_get_stats();
printf("Ошибки I2C: %ld\n", stats->i2c_driver_error);

zh_aht_reset_stats()

Сбрасывает счетчик статистики ошибок.

Пример:

zh_aht_reset_stats();

Примеры использования

Базовый пример: Один датчик

#include "zh_aht.h"

#define I2C_PORT (I2C_NUM_MAX - 1)

zh_aht_handle_t aht_handle = {0};

void app_main(void)
{
    esp_log_level_set("zh_aht", ESP_LOG_ERROR);
    i2c_master_bus_config_t i2c_bus_config = {
        .clk_source = I2C_CLK_SRC_DEFAULT,
        .i2c_port = I2C_PORT,
        .scl_io_num = GPIO_NUM_22,
        .sda_io_num = GPIO_NUM_21,
        .glitch_ignore_cnt = 7,
        .flags.enable_internal_pullup = true,
    };
    i2c_master_bus_handle_t i2c_bus_handle = NULL;
    i2c_new_master_bus(&i2c_bus_config, &i2c_bus_handle);
    zh_aht_init_config_t config = ZH_AHT_INIT_CONFIG_DEFAULT();
    config.i2c_handle = i2c_bus_handle;
    zh_aht_init(&config, &aht_handle);
    float humidity = 0.0;
    float temperature = 0.0;
    for (;;)
    {
        zh_aht_read(&aht_handle, &humidity, &temperature);
        printf("Влажность: %.2f%%\n", humidity);
        printf("Температура: %.2f°C\n", temperature);
        const zh_aht_stats_t *stats = zh_aht_get_stats();
        printf("Ошибки I2C: %ld\n", stats->i2c_driver_error);
        vTaskDelay(5000 / portTICK_PERIOD_MS);
    }
}

Несколько датчиков: Использование I2C мультиплексатора (zh_pca9548a)

#include "zh_pca9548a.h"
#include "zh_aht.h"

#define I2C_PORT (I2C_NUM_MAX - 1)

zh_pca9548a_handle_t pca9548a_handle = {0};
zh_aht_handle_t aht_handle_chan_0 = {0};
zh_aht_handle_t aht_handle_chan_1 = {0};
zh_aht_handle_t aht_handle_chan_2 = {0};

void app_main(void)
{
    esp_log_level_set("zh_pca9548a", ESP_LOG_ERROR);
    esp_log_level_set("zh_aht", ESP_LOG_ERROR);
    i2c_master_bus_config_t i2c_bus_config = {
        .clk_source = I2C_CLK_SRC_DEFAULT,
        .i2c_port = I2C_PORT,
        .scl_io_num = GPIO_NUM_22,
        .sda_io_num = GPIO_NUM_21,
        .glitch_ignore_cnt = 7,
        .flags.enable_internal_pullup = true,
    };
    i2c_master_bus_handle_t i2c_bus_handle = NULL;
    i2c_new_master_bus(&i2c_bus_config, &i2c_bus_handle);
    // Инициализация I2C мультиплексатора
    zh_pca9548a_init_config_t pca_config = ZH_PCA9548A_INIT_CONFIG_DEFAULT();
    pca_config.i2c_handle = i2c_bus_handle;
    pca_config.i2c_address = 0x70;
    zh_pca9548a_init(&pca_config, &pca9548a_handle);
    // Инициализация датчиков AHT на разных каналах
    zh_aht_init_config_t aht_config = ZH_AHT_INIT_CONFIG_DEFAULT();
    aht_config.i2c_handle = i2c_bus_handle;
    zh_pca9548a_set(&pca9548a_handle, ZH_PCA9548A_CHAN_NUM_0);
    zh_aht_init(&aht_config, &aht_handle_chan_0);
    zh_pca9548a_set(&pca9548a_handle, ZH_PCA9548A_CHAN_NUM_1);
    zh_aht_init(&aht_config, &aht_handle_chan_1);
    zh_pca9548a_set(&pca9548a_handle, ZH_PCA9548A_CHAN_NUM_2);
    zh_aht_init(&aht_config, &aht_handle_chan_2);
    float humidity = 0.0;
    float temperature = 0.0;
    for (;;)
    {
        // Считывание с датчика на канале 0
        zh_pca9548a_set(&pca9548a_handle, ZH_PCA9548A_CHAN_NUM_0);
        zh_aht_read(&aht_handle_chan_0, &humidity, &temperature);
        printf("Датчик 1. Влажность: %.2f%%\n", humidity);
        printf("Датчик 1. Температура: %.2f°C\n", temperature);
        // Считывание с датчика на канале 1
        zh_pca9548a_set(&pca9548a_handle, ZH_PCA9548A_CHAN_NUM_1);
        zh_aht_read(&aht_handle_chan_1, &humidity, &temperature);
        printf("Датчик 2. Влажность: %.2f%%\n", humidity);
        printf("Датчик 2. Температура: %.2f°C\n", temperature);
        // Считывание с датчика на канале 2
        zh_pca9548a_set(&pca9548a_handle, ZH_PCA9548A_CHAN_NUM_2);
        zh_aht_read(&aht_handle_chan_2, &humidity, &temperature);
        printf("Датчик 3. Влажность: %.2f%%\n", humidity);
        printf("Датчик 3. Температура: %.2f°C\n", temperature);
        vTaskDelay(5000 / portTICK_PERIOD_MS);
    }
}

Технические характеристики

Параметр Значение
Диапазон влажности 0 - 100%
Диапазон температуры -40 - +85°C
Разрешение измерения влажности 0.01%
Разрешение измерения температуры 0.01°C
Адрес I2C 0x38, 0x39
Частота I2C До 400 кГц
Время измерения ~80 мс
Поддерживаемые модели AHT10, AHT15, AHT20, AHT21, AHT25, AHT30
Версия ESP-IDF >= 5.0
Платформа Семейство ESP32
Язык C (C99)

Коды ошибок

Код ошибки Описание
ESP_OK Операция выполнена успешно
ESP_ERR_INVALID_ARG Неверный аргумент (NULL указатель или неверная конфигурация)
ESP_ERR_INVALID_STATE Датчик не инициализирован
ESP_ERR_NOT_FOUND Датчик не инициализирован или не отвечает
ESP_ERR_TIMEOUT Превышено время ожидания готовности данных
ESP_ERR_INVALID_CRC Неверная CRC контрольная сумма
ESP_FAIL Общая ошибка (ошибка связи I2C)

Вклад в проект

Вклад приветствуется! Чтобы внести свой вклад:

  1. Сделайте форк репозитория
  2. Создайте ветку функции (git checkout -b feature/AmazingFeature)
  3. Закоммитьте ваши изменения (git commit -m 'Add some AmazingFeature')
  4. Отправьте в ветку (git push origin feature/AmazingFeature)
  5. Откройте Pull Request

Пожалуйста, убедитесь, что ваш код следует существующему стилю и включает соответствующую документацию.

Лицензия

Этот проект лицензирован по лицензии Apache, версия 2.0 - см. файл LICENSE для подробной информации.

Apache License, Version 2.0

Авторское право (c) 2026 Алексей Жолтиков

Лицензировано по лицензии Apache License, Version 2.0 (далее — "Лицензия"); вы не можете использовать этот файл, кроме случаев, предусмотренных Лицензией. Копию Лицензии можно получить по адресу:

http://www.apache.org/licenses/LICENSE-2.0

Если иное не требуется действующим законодательством или не согласовано в письменном виде, программное обеспечение, распространяемое по Лицензии, распространяется на условиях "КАК ЕСТЬ", БЕЗ КАКИХ-ЛИБО ГАРАНТИЙ, явных или подразумеваемых, включая, но не ограничиваясь, гарантии ТОВАРНОГО СОСТОЯНИЯ, ПРИГОДНОСТИ ДЛЯ КОНКРЕТНОЙ ЦЕЛИ И НЕНАРУШЕНИЯ ПРАВ. Смотрите Лицензию для получения конкретных прав и ограничений.

Дополнительные заметки

  • Подтягивающие резисторы I2C: Убедитесь, что к линиям SDA и SCL подключены соответствующие подтягивающие резисторы
  • Время измерения: Датчик требует ~80 мс для каждого измерения
  • I2C_ISR_IRAM_SAFE: Для правильной работы включите I2C_ISR_IRAM_SAFE и I2C_MASTER_ISR_HANDLER_IN_IRAM в menuconfig
  • Потокобезопасность: Компонент использует драйвер I2C ESP-IDF, который является потокобезопасным

Сгенерировано для zh_aht v3.4.0

Reference in new issue View Git Blame Copy Permalink