Merge branch 'update_aht20'

Author: jeetrohan

components/audio/adc_mic/CHANGELOG.md

@@ -0,0 +1,13 @@
+# ChangeLog
+
+## v0.2.0 - 2024-05-22
+
+### Enhancements:
+
+* Add config ADC_MIC_APPLY_GAIN to apply gain to the ADC mic.
+
+## v0.1.0 - 2024-05-22
+
+### Enhancements:
+
+* Initial version.

components/audio/adc_mic/Kconfig

@@ -0,0 +1,23 @@
+menu "ADC Mic"
+
+    config ADC_MIC_APPLY_GAIN
+        int "Apply Gain"
+        default 3
+        range 0 4
+        help
+            Apply gain to the ADC mic.
+            0: No gain applied
+            1: Left shift 1 bit (2x gain)
+            2: Left shift 2 bits (4x gain)
+            3: Left shift 3 bits (8x gain)
+            4: Left shift 4 bits (16x gain)
+
+    config ADC_MIC_OFFSET
+        int
+        default 2048 if ADC_MIC_APPLY_GAIN = 0
+        default 4095 if ADC_MIC_APPLY_GAIN = 1
+        default 8190 if ADC_MIC_APPLY_GAIN = 2
+        default 16380 if ADC_MIC_APPLY_GAIN = 3
+        default 32760 if ADC_MIC_APPLY_GAIN = 4
+
+endmenu

components/audio/adc_mic/adc_mic.c

@@ -138,7 +138,7 @@ static int _adc_data_read(const audio_codec_data_if_t *h, uint8_t *data, int siz
         for (int i = 0; i < item_count; i++) {
             uint16_t raw_value = buffer[i].val;
             // Left shift to amplify audio.
-            p[i] = (raw_value << 4) - 32768;
+            p[i] = (raw_value << CONFIG_ADC_MIC_APPLY_GAIN) - CONFIG_ADC_MIC_OFFSET;
         }
 
         cnt += ret_num;
@@ -154,7 +154,7 @@ static int _adc_data_read(const audio_codec_data_if_t *h, uint8_t *data, int siz
         for (int i = 0; i < item_count; i++) {
             uint16_t raw_value = buffer[i].val & 0xFFFF;
             // Left shift to amplify audio.
-            p[i] = (raw_value << 4) - 32768;
+            p[i] = (raw_value << CONFIG_ADC_MIC_APPLY_GAIN) - CONFIG_ADC_MIC_OFFSET;
         }
         cnt += ret_num / 2;
         left_size -= ret_num / 2;

components/audio/adc_mic/idf_component.yml

@@ -1,4 +1,4 @@
-version: "0.1.0"
+version: "0.2.0"
 description: ADC mic input driver for ESP32 Series socs
 url: https://github.com/espressif/esp-iot-solution/tree/master/components/audio/adc_mic
 repository: https://github.com/espressif/esp-iot-solution.git

components/sensors/humiture/aht20/Kconfig

@@ -6,13 +6,4 @@ menu "AHT20 : CONFIGURATION"
             CRC check to be performed on results or not?.
 	default n
 
-
-    config AHT20_I2C_CLK_SPEED
-        int "I2C clock speed"
-		default 100000
-	range 1 400000
-        help
-            Clock speed used for i2c communication by AHT20 device.
-	    Limited to maximum of 400KHZ.
-
 endmenu

components/sensors/humiture/aht20/README.md

@@ -73,31 +73,17 @@ Following are the general guidelines.
     printf("Temperature = %.2f°C\n", temperature);
 ```
 
-## Senosr Hub
 
-Following are the general guidelines.
-``` 
-    
-    /*create a sensor with specific sensor_id and configurations*/
-    iot_sensor_create("aht20", &sensor_config, &sensor_handle); 
-   
-     /*register handler with sensor's handle*/
-    iot_sensor_handler_register(sensor_handle, sensor_event_handler, NULL);
-
-    /*start the sensor, data ready events will be posted once data is acquired successfully*/
-    iot_sensor_start(sensor_handle); 
- 
-```
-
-## How to Configure CRC and I2C clock speed
+## How to Configure CRC 
 Additionally, select in menuconfig under Component Config → AHT20; to use CRC(default is not used)
 or change the clock speed of device (default is 100KHz). 
 
 Note : It is recommended to use clock speeds in upper ranges of 100kHz to 200kHz.
 Higher clock speeds may cause occasional data inconsistencies depending on your board layout and wiring.
 
-![image](https://github.com/user-attachments/assets/fc8680fb-1567-477c-92f8-52dd126e6f9d)
+![image](https://github.com/user-attachments/assets/58a07cc9-5d87-4afe-9675-637b3e776faa)
+
 
 or 
 In sdkconfig under Component Config → AHT20,
-![image](https://github.com/user-attachments/assets/1f9612df-8d73-4ad1-bec7-75cbe6ed327a)
+

components/sensors/humiture/aht20/aht20.c

@@ -3,16 +3,6 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-/*
- * @File: aht20.c
- *
- * @brief: AHT20 driver function definitions
- *
- * @Date: May 2, 2025
- *
- * @Author: Rohan Jeet <[email protected]>
- *
- */
 
 #include <stdio.h>
 
@@ -24,6 +14,13 @@
 
 static const char *s_TAG = "AHT20";
 
+/**
+ * @brief AHT20 device object
+ */
+typedef struct {
+    i2c_bus_device_handle_t i2c_dev;   /*!< i2c device handle. */
+} aht20_dev_config_t;
+
 /**
  *@brief AHT20 raw result
  */
@@ -42,7 +39,7 @@ typedef struct {
 * @param[in] read_size data size to read
 *
 */
-static esp_err_t aht20_read_reg(aht20_handle_t sensor, uint8_t * read_buffer, uint8_t read_size);
+static esp_err_t aht20_read_reg(aht20_dev_config_t * aht20_handle, uint8_t * read_buffer, uint8_t read_size);
 
 /**
 * @brief a function used to handle resetting of registers of the device, if not found calibrated when initialized
@@ -54,15 +51,15 @@ static esp_err_t aht20_read_reg(aht20_handle_t sensor, uint8_t * read_buffer, ui
 * @param[in] write_size data size to write
 *
 */
-static esp_err_t aht20_write_reg(aht20_handle_t sensor, uint8_t * cmd, uint8_t write_size);
+static esp_err_t aht20_write_reg(aht20_dev_config_t * aht20_handle, uint8_t * cmd, uint8_t write_size);
 
 /**
 * @brief a function used to handle reinitialization of registers of the device, if not found calibrated when initialized
 *
 * @param[in] aht20_handle AHT20 device handle
 *
 */
-static esp_err_t aht20_Start_Init(aht20_handle_t aht20_handle);
+static esp_err_t aht20_Start_Init(aht20_dev_config_t * aht20_handle);
 
 /**
 * @brief a function used to handle resetting of registers of the device, if not found calibrated when initialized
@@ -72,7 +69,7 @@ static esp_err_t aht20_Start_Init(aht20_handle_t aht20_handle);
 * @param[in] addr AHT20 internal register, undocumented in datasheet
 *
 */
-static esp_err_t aht20_JH_Reset_REG(aht20_handle_t aht20_handle, uint8_t addr);
+static esp_err_t aht20_JH_Reset_REG(aht20_dev_config_t * aht20_handle, uint8_t addr);
 
 /**
 * @brief check crc validity of response received
@@ -99,25 +96,26 @@ static uint8_t calc_CRC8(uint8_t *message, uint8_t Num);
 *      - other error codes : failure in reading AHT20 busy status
 *
 */
-static esp_err_t aht20_busy_status(aht20_handle_t aht20_handle, bool *busy);
+static esp_err_t aht20_busy_status(aht20_dev_config_t * aht20_handle, bool *busy);
 
-static esp_err_t aht20_read_reg(aht20_handle_t sensor, uint8_t * read_buffer, uint8_t read_size)
+static esp_err_t aht20_read_reg(aht20_dev_config_t * aht20_handle, uint8_t * read_buffer, uint8_t read_size)
 {
-    ESP_RETURN_ON_ERROR(i2c_bus_read_bytes(sensor->i2c_dev, NULL_I2C_MEM_ADDR, read_size, read_buffer),
+
+    ESP_RETURN_ON_ERROR(i2c_bus_read_bytes(aht20_handle->i2c_dev, NULL_I2C_MEM_ADDR, read_size, read_buffer),
                         s_TAG, "unable to read from aht20");
 
     return ESP_OK;
 }
 
-static esp_err_t aht20_write_reg(aht20_handle_t sensor, uint8_t * cmd, uint8_t write_size)
+static esp_err_t aht20_write_reg(aht20_dev_config_t * aht20_handle, uint8_t * cmd, uint8_t write_size)
 {
-    ESP_RETURN_ON_ERROR(i2c_bus_write_bytes(sensor->i2c_dev, NULL_I2C_MEM_ADDR, write_size, cmd),
+    ESP_RETURN_ON_ERROR(i2c_bus_write_bytes(aht20_handle->i2c_dev, NULL_I2C_MEM_ADDR, write_size, cmd),
                         s_TAG, "unable to set mode for AHT20\n");
 
     return ESP_OK;
 }
 
-static esp_err_t aht20_busy_status(aht20_handle_t aht20_handle, bool *busy)
+static esp_err_t aht20_busy_status(aht20_dev_config_t * aht20_handle, bool *busy)
 {
     ESP_RETURN_ON_FALSE((aht20_handle != NULL), ESP_ERR_INVALID_ARG,
                         s_TAG, "empty handle, initialize AHT20 handle");
@@ -137,7 +135,7 @@ static esp_err_t aht20_busy_status(aht20_handle_t aht20_handle, bool *busy)
     return ESP_OK;
 }
 
-static esp_err_t aht20_JH_Reset_REG(aht20_handle_t aht20_handle, uint8_t addr)
+static esp_err_t aht20_JH_Reset_REG(aht20_dev_config_t * aht20_handle, uint8_t addr)
 {
 
     uint8_t reset_cmd[] = {addr, 0x00, 0x00}, read_bytes[3];
@@ -159,7 +157,7 @@ static esp_err_t aht20_JH_Reset_REG(aht20_handle_t aht20_handle, uint8_t addr)
     return ESP_OK;
 }
 
-static esp_err_t aht20_Start_Init(aht20_handle_t aht20_handle)
+static esp_err_t aht20_Start_Init(aht20_dev_config_t * aht20_handle)
 {
     ESP_RETURN_ON_ERROR(aht20_JH_Reset_REG(aht20_handle, 0x1b), "", "");
     ESP_RETURN_ON_ERROR(aht20_JH_Reset_REG(aht20_handle, 0x1c), "", "");
@@ -190,7 +188,7 @@ static uint8_t calc_CRC8(uint8_t *message, uint8_t Num)
 
 /******************************************** Public *********************************************/
 
-esp_err_t aht20_read_raw(aht20_handle_t aht20_handle, aht20_raw_reading_t *raw_read)
+static esp_err_t aht20_read_raw(aht20_dev_config_t * aht20_handle, aht20_raw_reading_t *raw_read)
 {
     ESP_RETURN_ON_FALSE((aht20_handle != NULL), ESP_ERR_INVALID_ARG, s_TAG, "empty handle, provide a valid AHT20 handle");
 
@@ -224,17 +222,25 @@ esp_err_t aht20_read_raw(aht20_handle_t aht20_handle, aht20_raw_reading_t *raw_r
     return ESP_OK;
 }
 
-esp_err_t aht20_read_humidity(aht20_handle_t aht20_handle, float_t *humidity)
+esp_err_t aht20_read_humidity(aht20_handle_t aht20, float_t *humidity)
 {
+    ESP_RETURN_ON_FALSE((aht20 != NULL), ESP_ERR_INVALID_ARG, s_TAG, "empty handle, initialize AHT20 handle");
+
+    aht20_dev_config_t * aht20_handle = (aht20_dev_config_t *) aht20;
+
     aht20_raw_reading_t raw_read;
     ESP_RETURN_ON_ERROR(aht20_read_raw(aht20_handle, &raw_read), "", "");
 
     *humidity = raw_read.humidity * 100.0 / 1024 / 1024; //Calculated humidity value
     return ESP_OK;
 }
 
-esp_err_t aht20_read_temperature(aht20_handle_t aht20_handle, float_t *temperature)
+esp_err_t aht20_read_temperature(aht20_handle_t aht20, float_t *temperature)
 {
+    ESP_RETURN_ON_FALSE((aht20 != NULL), ESP_ERR_INVALID_ARG, s_TAG, "empty handle, initialize AHT20 handle");
+
+    aht20_dev_config_t * aht20_handle = (aht20_dev_config_t *) aht20;
+
     aht20_raw_reading_t raw_read;
     ESP_RETURN_ON_ERROR(aht20_read_raw(aht20_handle, &raw_read), "", "");
 
@@ -243,10 +249,11 @@ esp_err_t aht20_read_temperature(aht20_handle_t aht20_handle, float_t *temperatu
     return ESP_OK;
 }
 
-esp_err_t aht20_init(aht20_handle_t aht20_handle)
+esp_err_t aht20_init(aht20_handle_t aht20)
 {
-    ESP_RETURN_ON_FALSE((aht20_handle != NULL), ESP_ERR_INVALID_ARG, s_TAG, "empty handle, initialize AHT20 handle");
+    ESP_RETURN_ON_FALSE((aht20 != NULL), ESP_ERR_INVALID_ARG, s_TAG, "empty handle, initialize AHT20 handle");
 
+    aht20_dev_config_t * aht20_handle = (aht20_dev_config_t *) aht20;
     vTaskDelay(20 / portTICK_PERIOD_MS); //time for AHT20 SCL to stabilize
 
     /***********************************************************************************/
@@ -281,26 +288,27 @@ esp_err_t aht20_init(aht20_handle_t aht20_handle)
 aht20_handle_t aht20_create(i2c_bus_handle_t bus_handle, uint8_t aht20_address)
 {
     ESP_LOGI(s_TAG, "adding aht20 as device to bus\n");
-    i2c_bus_device_handle_t dev_handle = i2c_bus_device_create(bus_handle, aht20_address, CONFIG_AHT20_I2C_CLK_SPEED);
+    i2c_bus_device_handle_t dev_handle = i2c_bus_device_create(bus_handle, aht20_address, i2c_bus_get_current_clk_speed(bus_handle));
     ESP_RETURN_ON_FALSE((dev_handle != NULL), NULL, s_TAG, "unable to create device\n");
     ESP_LOGI(s_TAG, "device added to bus\n");
 
-    aht20_handle_t my_aht20_handle = malloc(sizeof(aht20_dev_config_t));
+    aht20_dev_config_t * my_aht20_handle = malloc(sizeof(aht20_dev_config_t));
 
     ESP_RETURN_ON_FALSE((my_aht20_handle != NULL), NULL, s_TAG, "unable to allocate memory to initialize aht20 handle");
 
     my_aht20_handle->i2c_dev =  dev_handle;
-    return my_aht20_handle;
+    return (aht20_handle_t) my_aht20_handle;
 }
 
 esp_err_t aht20_remove(aht20_handle_t *aht20ptr)
 {
     if (*aht20ptr == NULL) {
         return ESP_ERR_INVALID_ARG;
     }
-    i2c_bus_device_delete(&((*aht20ptr)->i2c_dev));
-    free(*aht20ptr);
-    *aht20ptr = NULL; // now AHT20 handle is not a dangling pointer
+    aht20_dev_config_t ** aht20_handle = (aht20_dev_config_t **) aht20ptr;
+    i2c_bus_device_delete(&((*aht20_handle)->i2c_dev));
+    free(*aht20_handle);
+    *aht20_handle = NULL; // now AHT20 handle is not a dangling pointer
     return ESP_OK;
 }
 

components/sensors/humiture/aht20/include/aht20.h

@@ -3,16 +3,7 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-/*
- * @File: aht20.h
- *
- * @brief: AHT20 driver function declarations and typedefinitons
- *
- * @Date: May 2, 2025
- *
- * @Author: Rohan Jeet <[email protected]>
- *
- */
+
 #ifndef AHT20_H
 #define AHT20_H
 
@@ -42,17 +33,10 @@ extern "C" {
 #define AHT20_INIT_REG        0XBE  /*!< initialize the AHT20 */
 #define AHT20_MEASURE_CYC     0xAC  /*!< trigger measurement in cycle mode */
 
-/**
- * @brief AHT20 device object
- */
-typedef struct {
-    i2c_bus_device_handle_t i2c_dev;   /*!< i2c device handle. */
-} aht20_dev_config_t;
-
 /**
  * @brief AHT20 device handle
  */
-typedef aht20_dev_config_t *aht20_handle_t;
+typedef void * aht20_handle_t;
 
 /**
 * @brief soft reset AHT20

components/sensors/humiture/aht20/test_apps/aht20_driver_test/CMakeLists.txt

@@ -3,7 +3,8 @@
 cmake_minimum_required(VERSION 3.5)
 
 set(COMPONENTS main)
-set(EXTRA_COMPONENT_DIRS "$ENV{IDF_PATH}/tools/unit-test-app/components")
+set(EXTRA_COMPONENT_DIRS "$ENV{IDF_PATH}/tools/unit-test-app/components"
+			  "../../../aht20")
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 project(aht20_test)

components/sensors/humiture/aht20/test_apps/aht20_driver_test/main/aht20_test_app.c

@@ -3,16 +3,6 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-/*-
- * @File: aht20_test_app.c
- *
- * @brief: AHT20 driver unity test app
- *
- * @Date: May 2, 2025
- *
- * @Author: Rohan Jeet <[email protected]>
- *
- */
 
 #include <stdio.h>
 #include "unity.h"