temp_sensor: add docs for esp32c3
This commit is contained in:
@@ -1,10 +1,10 @@
|
||||
ESP32-S2 Temperature Sensor
|
||||
===========================
|
||||
Temperature Sensor
|
||||
==================
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
The ESP32-S2 has a built-in temperature sensor. The temperature sensor module contains an 8-bit Sigma-Delta ADC and a temperature offset DAC.
|
||||
The {IDF_TARGET_NAME} has a built-in temperature sensor used to measure the chip's internal temperature, and hard to measure the environmental temperature accurately. Being built-in means that the temperature sensor should work on any {IDF_TARGET_NAME} regardless of what board the chip is embedded in. The temperature sensor module contains an 8-bit Sigma-Delta ADC and a temperature offset DAC.
|
||||
|
||||
The conversion relationship is the first columns of the table below. Among them, offset = 0 is the main measurement option, and other values are extended measurement options.
|
||||
|
||||
@@ -22,6 +22,34 @@ The conversion relationship is the first columns of the table below. Among them,
|
||||
| 2 | -40 ~ 20 | < 3 |
|
||||
+--------+------------------------+------------------------+
|
||||
|
||||
Driver Usage
|
||||
------------
|
||||
|
||||
1. Initialize the temperature sensor by calling the function :cpp:func:`temp_sensor_set_config` and pass to it a :cpp:type:`temp_sensor_config_t` structure. The :cpp:type:`temp_sensor_config_t` structure should contain all the required parameters. See the example below.
|
||||
|
||||
.. code-block:: c
|
||||
|
||||
temp_sensor_config_t temp_sensor = {
|
||||
.dac_offset = TSENS_DAC_L2,
|
||||
.clk_div = 6,
|
||||
};
|
||||
temp_sensor_set_config(temp_sensor);
|
||||
|
||||
2. Start the temp_sensor by calling :cpp:func:'temp_sensor_start'. The temperature sensor will now measure the temperature.
|
||||
|
||||
3. To get the current temperature, take the example below as a reference, the value you get is in Celsius.
|
||||
|
||||
.. code-block:: c
|
||||
|
||||
float tsens_out;
|
||||
temp_sensor_read_celsius(&tsens_out);
|
||||
|
||||
4. To stop the temperature sensor, please call :cpp:func:'temp_sensor_stop'.
|
||||
|
||||
.. note::
|
||||
|
||||
If you want dynamic reconfiguration, you need to stop the sensor first (temp_sensor_stop), set the new configuration (temp_sensor_set_config), then start the sensor again (temp_sensor_start).
|
||||
|
||||
Application Example
|
||||
-------------------
|
||||
|
||||
|
||||
Reference in New Issue
Block a user