From c07862cee84f6d78987833987aaa00dc77223ea2 Mon Sep 17 00:00:00 2001 From: BOT Date: Wed, 6 Mar 2024 10:11:40 +0800 Subject: [PATCH] Update temp_sensor.rst documentation to match example (GitHub PR) --- components/esp_driver_tsens/src/temperature_sensor.c | 6 +++++- docs/en/api-reference/peripherals/temp_sensor.rst | 7 ++----- docs/zh_CN/api-reference/peripherals/temp_sensor.rst | 7 ++----- 3 files changed, 9 insertions(+), 11 deletions(-) diff --git a/components/esp_driver_tsens/src/temperature_sensor.c b/components/esp_driver_tsens/src/temperature_sensor.c index 584f15e364..b1f80d9140 100644 --- a/components/esp_driver_tsens/src/temperature_sensor.c +++ b/components/esp_driver_tsens/src/temperature_sensor.c @@ -104,7 +104,11 @@ esp_err_t temperature_sensor_install(const temperature_sensor_config_t *tsens_co temperature_sensor_handle_t tsens = NULL; tsens = (temperature_sensor_obj_t *) heap_caps_calloc(1, sizeof(temperature_sensor_obj_t), MALLOC_CAP_DEFAULT); ESP_RETURN_ON_FALSE((tsens != NULL), ESP_ERR_NO_MEM, TAG, "no mem for temp sensor"); - tsens->clk_src = tsens_config->clk_src; + if (tsens->clk_src == 0) { + tsens->clk_src = TEMPERATURE_SENSOR_CLK_SRC_DEFAULT; + } else { + tsens->clk_src = tsens_config->clk_src; + } temperature_sensor_power_acquire(); temperature_sensor_ll_clk_sel(tsens->clk_src); diff --git a/docs/en/api-reference/peripherals/temp_sensor.rst b/docs/en/api-reference/peripherals/temp_sensor.rst index 5a0be3676a..1e18f13053 100644 --- a/docs/en/api-reference/peripherals/temp_sensor.rst +++ b/docs/en/api-reference/peripherals/temp_sensor.rst @@ -75,11 +75,8 @@ Creating a Temperature Sensor Handle .. code:: c temperature_sensor_handle_t temp_handle = NULL; - temperature_sensor_config_t temp_sensor = { - .range_min = 20, - .range_max = 50, - }; - ESP_ERROR_CHECK(temperature_sensor_install(&temp_sensor, &temp_handle)); + temperature_sensor_config_t temp_sensor_config = TEMPERATURE_SENSOR_CONFIG_DEFAULT(20, 50); + ESP_ERROR_CHECK(temperature_sensor_install(&temp_sensor_config, &temp_handle)); .. _temp-enable-and-disable-temperature-sensor: diff --git a/docs/zh_CN/api-reference/peripherals/temp_sensor.rst b/docs/zh_CN/api-reference/peripherals/temp_sensor.rst index 6d0cc25507..a1d4a15e8c 100644 --- a/docs/zh_CN/api-reference/peripherals/temp_sensor.rst +++ b/docs/zh_CN/api-reference/peripherals/temp_sensor.rst @@ -74,11 +74,8 @@ .. code:: c temperature_sensor_handle_t temp_handle = NULL; - temperature_sensor_config_t temp_sensor = { - .range_min = 20, - .range_max = 50, - }; - ESP_ERROR_CHECK(temperature_sensor_install(&temp_sensor, &temp_handle)); + temperature_sensor_config_t temp_sensor_config = TEMPERATURE_SENSOR_CONFIG_DEFAULT(20, 50); + ESP_ERROR_CHECK(temperature_sensor_install(&temp_sensor_config, &temp_handle)); .. _temp-enable-and-disable-temperature-sensor: