feedc0de/esp-idf
1
0
Fork 0
forked from espressif/esp-idf
Code Pull Requests Activity

feat(temperature_sensor): Add sleep retention support for temperature sensor

Browse Source
This commit is contained in:
C.S.M
2024-09-27 19:11:30 +08:00
parent 39430c1404
commit 4cbc790628
30 changed files with 305 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/api-reference/peripherals/temp_sensor.rst
+1
View File
@@ -59,6 +59,7 @@ In order to install a built-in temperature sensor instance, the first thing is t
- :cpp:member:`range_min`: The minimum value of the testing range you have evaluated.
- :cpp:member:`range_max`: The maximum value of the testing range you have evaluated.
- :cpp:member:`allow_pd` configures if the driver allows the system to power down the peripheral in light sleep mode. Before entering sleep, the system will backup the temperature sensor register context, which will be restored later when the system exit the sleep mode. Powering down the peripheral can save more power, but at the cost of more memory consumed to save the register context. It's a tradeoff between power consumption and memory consumption. This configuration option relies on specific hardware feature, if you enable it on an unsupported chip, you will see error message like ``not able to power down in light sleep``.
After the ranges are set, the structure could be passed to :cpp:func:`temperature_sensor_install`, which will instantiate the temperature sensor instance and return a handle.