Skip to content

Commit 96283dd

Browse files
committed
doc(temperature_sensor): Update temperature snesor docs, remove inaccurate part
1 parent 0fde8d2 commit 96283dd

File tree

3 files changed

+9
-49
lines changed

3 files changed

+9
-49
lines changed

docs/en/api-reference/peripherals/temp_sensor.rst

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,29 +8,9 @@ Introduction
88

99
The {IDF_TARGET_NAME} has a built-in sensor used to measure the chip's internal temperature. The temperature sensor module contains an 8-bit Sigma-Delta analog-to-digital converter (ADC) and a digital-to-analog converter (DAC) to compensate for the temperature measurement.
1010

11-
Due to restrictions of hardware, the sensor has predefined measurement ranges with specific measurement errors. See the table below for details.
12-
13-
.. list-table::
14-
:header-rows: 1
15-
:widths: 50 50
16-
:align: center
17-
18-
* - Predefined Range (°C)
19-
- Error (°C)
20-
* - 50 ~ 125
21-
- < 3
22-
* - 20 ~ 100
23-
- < 2
24-
* - -10 ~ 80
25-
- < 1
26-
* - -30 ~ 50
27-
- < 2
28-
* - -40 ~ 20
29-
- < 3
30-
3111
.. note::
3212

33-
The temperature sensor is designed primarily to measure the temperature changes inside the chip. The internal temperature of a chip is usually higher than the ambient temperature, and is affected by factors such as the microcontroller's clock frequency or I/O load, and the external thermal environment.
13+
The temperature sensor is designed primarily to measure the temperature **inside** the silicon. The sensor can reflect the temperature changes very well but it can't give a precise measurement value. So it's not recommended to use it for ambient temperature measurement.
3414

3515
Functional Overview
3616
-------------------

docs/zh_CN/api-reference/peripherals/temp_sensor.rst

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,29 +8,9 @@
88

99
{IDF_TARGET_NAME} 内置传感器,用于测量芯片内部的温度。该温度传感器模组包含一个 8 位 Sigma-Delta 模拟-数字转换器 (ADC) 和一个数字-模拟转换器 (DAC),可以补偿测量结果,减少温度测量的误差。
1010

11-
由于硬件限制,温度传感器存在预定义的测量范围及其对应误差,详见下表:
12-
13-
.. list-table::
14-
:header-rows: 1
15-
:widths: 50 50
16-
:align: center
17-
18-
* - 预定义测量范围 (°C)
19-
- 测量误差 (°C)
20-
* - 50 ~ 125
21-
- < 3
22-
* - 20 ~ 100
23-
- < 2
24-
* - -10 ~ 80
25-
- < 1
26-
* - -30 ~ 50
27-
- < 2
28-
* - -40 ~ 20
29-
- < 3
30-
3111
.. note::
3212

33-
温度传感器主要用于测量芯片内部的温度变化。芯片内部温度通常高于环境温度,并且受到微控制器的时钟频率或 I/O 负载、外部散热环境等因素影响
13+
温度传感器主要用于测量芯片内部的温度变化。温度值可用作衡量温度变化趋势,但无法提供精确的温度数值,因此不建议用作精准测量温度
3414

3515
功能概述
3616
-------------------

examples/peripherals/temperature_sensor/temp_sensor/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ The ESP32-S2/C3/S3/C2 has a built-in temperature sensor. The temperature sensor
77

88
The conversion relationship is the first two columns of the table below. Among them, `offset = 0`(default) is the main measurement option, and other values are extended measurement options.
99

10-
| DAC level | offset | measure range(℃) | measure error(℃) |
11-
| :-------: | :----: | :--------------: | :--------------: |
12-
| 0 | -2 | 50 ~ 125 | < 3 |
13-
| 1 | -1 | 20 ~ 100 | < 2 |
14-
| 2 | 0 | -10 ~ 80 | < 1 |
15-
| 3 | 1 | -30 ~ 50 | < 2 |
16-
| 4 | 2 | -40 ~ 20 | < 3 |
10+
| DAC level | offset | measure range(℃) |
11+
| :-------: | :----: | :--------------: |
12+
| 0 | -2 | 50 ~ 125 |
13+
| 1 | -1 | 20 ~ 100 |
14+
| 2 | 0 | -10 ~ 80 |
15+
| 3 | 1 | -30 ~ 50 |
16+
| 4 | 2 | -40 ~ 20 |
1717

1818
## How to use example
1919

0 commit comments

Comments
 (0)