diff --git a/docs/conf_common.py b/docs/conf_common.py index b8ac45f0db..00177a7459 100644 --- a/docs/conf_common.py +++ b/docs/conf_common.py @@ -114,7 +114,9 @@ BITSCRAMBLER_DOCS = ['api-reference/peripherals/bitscrambler.rst'] CLK_TREE_DOCS = ['api-reference/peripherals/clk_tree.rst'] -UART_DOCS = ['api-reference/peripherals/uart.rst', 'api-reference/peripherals/uhci.rst'] +UART_DOCS = ['api-reference/peripherals/uart.rst'] + +UHCI_DOCS = ['api-reference/peripherals/uhci.rst'] SDMMC_DOCS = ['api-reference/peripherals/sdmmc_host.rst'] @@ -330,6 +332,7 @@ conditional_include_dict = { 'SOC_CACHE_INTERNAL_MEM_VIA_L1CACHE': MM_SYNC_DOCS, 'SOC_CLK_TREE_SUPPORTED': CLK_TREE_DOCS, 'SOC_UART_SUPPORTED': UART_DOCS, + 'SOC_UHCI_SUPPORTED': UHCI_DOCS, 'SOC_SDMMC_HOST_SUPPORTED': SDMMC_DOCS, 'SOC_SDIO_SLAVE_SUPPORTED': SDIO_SLAVE_DOCS, 'SOC_MCPWM_SUPPORTED': MCPWM_DOCS, diff --git a/docs/en/api-reference/peripherals/temp_sensor.rst b/docs/en/api-reference/peripherals/temp_sensor.rst index ca7231e6e1..1c2ca965c5 100644 --- a/docs/en/api-reference/peripherals/temp_sensor.rst +++ b/docs/en/api-reference/peripherals/temp_sensor.rst @@ -8,29 +8,9 @@ Introduction 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. -Due to restrictions of hardware, the sensor has predefined measurement ranges with specific measurement errors. See the table below for details. - -.. list-table:: - :header-rows: 1 - :widths: 50 50 - :align: center - - * - Predefined Range (°C) - - Error (°C) - * - 50 ~ 125 - - < 3 - * - 20 ~ 100 - - < 2 - * - -10 ~ 80 - - < 1 - * - -30 ~ 50 - - < 2 - * - -40 ~ 20 - - < 3 - .. note:: - 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. + 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. Functional Overview ------------------- diff --git a/docs/en/api-reference/peripherals/uart.rst b/docs/en/api-reference/peripherals/uart.rst index 1a81bdd68f..3bb0d8ec1b 100644 --- a/docs/en/api-reference/peripherals/uart.rst +++ b/docs/en/api-reference/peripherals/uart.rst @@ -18,13 +18,13 @@ Each UART controller is independently configurable with parameters such as baud Additionally, the {IDF_TARGET_NAME} chip has one low-power (LP) UART controller. It is the cut-down version of regular UART. Usually, the LP UART controller only support basic UART functionality with a much smaller RAM size, and does not support IrDA or RS485 protocols. For a full list of difference between UART and LP UART, please refer to the **{IDF_TARGET_NAME} Technical Reference Manual** > **UART Controller (UART)** > **Features** [`PDF <{IDF_TARGET_TRM_EN_URL}#uart>`__]). -.. toctree:: - :hidden: - - uhci - .. only:: SOC_UHCI_SUPPORTED + .. toctree:: + :hidden: + + uhci + The {IDF_TARGET_NAME} chip also supports using DMA with UART. For details, see to :doc:`uhci`. Functional Overview @@ -239,7 +239,7 @@ The UART controller supports a number of communication modes. A mode can be sele Use Interrupts ^^^^^^^^^^^^^^^^ -There are many interrupts that can be generated depending on specific UART states or detected errors. The full list of available interrupts is provided in *{IDF_TARGET_NAME} Technical Reference Manual* > *UART Controller (UART)* > *UART Interrupts* and *UHCI Interrupts* [`PDF <{IDF_TARGET_TRM_EN_URL}#uart>`__]. You can enable or disable specific interrupts by calling :cpp:func:`uart_enable_intr_mask` or :cpp:func:`uart_disable_intr_mask` respectively. +There are many interrupts that can be generated depending on specific UART states or detected errors. The full list of available interrupts is provided in *{IDF_TARGET_NAME} Technical Reference Manual* > *UART Controller (UART)* > *UART Interrupts* [`PDF <{IDF_TARGET_TRM_EN_URL}#uart>`__]. You can enable or disable specific interrupts by calling :cpp:func:`uart_enable_intr_mask` or :cpp:func:`uart_disable_intr_mask` respectively. The UART driver provides a convenient way to handle specific interrupts by wrapping them into corresponding events. Events defined in :cpp:type:`uart_event_type_t` can be reported to a user application using the FreeRTOS queue functionality. diff --git a/docs/zh_CN/api-reference/peripherals/temp_sensor.rst b/docs/zh_CN/api-reference/peripherals/temp_sensor.rst index a53aace2fb..912e0c48d1 100644 --- a/docs/zh_CN/api-reference/peripherals/temp_sensor.rst +++ b/docs/zh_CN/api-reference/peripherals/temp_sensor.rst @@ -8,29 +8,9 @@ {IDF_TARGET_NAME} 内置传感器，用于测量芯片内部的温度。该温度传感器模组包含一个 8 位 Sigma-Delta 模拟-数字转换器 (ADC) 和一个数字-模拟转换器 (DAC)，可以补偿测量结果，减少温度测量的误差。 -由于硬件限制，温度传感器存在预定义的测量范围及其对应误差，详见下表： - -.. list-table:: - :header-rows: 1 - :widths: 50 50 - :align: center - - * - 预定义测量范围 (°C) - - 测量误差 (°C) - * - 50 ~ 125 - - < 3 - * - 20 ~ 100 - - < 2 - * - -10 ~ 80 - - < 1 - * - -30 ~ 50 - - < 2 - * - -40 ~ 20 - - < 3 - .. note:: - 温度传感器主要用于测量芯片内部的温度变化。芯片内部温度通常高于环境温度，并且受到微控制器的时钟频率或 I/O 负载、外部散热环境等因素影响。 + 温度传感器主要用于测量芯片内部的温度变化。温度值可用作衡量温度变化趋势，但无法提供精确的温度数值，因此不建议用作精准测量温度。 功能概述 ------------------- diff --git a/docs/zh_CN/api-reference/peripherals/uart.rst b/docs/zh_CN/api-reference/peripherals/uart.rst index f773911488..c99657641f 100644 --- a/docs/zh_CN/api-reference/peripherals/uart.rst +++ b/docs/zh_CN/api-reference/peripherals/uart.rst @@ -18,13 +18,13 @@ 此外，{IDF_TARGET_NAME} 芯片还有一个满足低功耗需求的 LP UART 控制器。LP UART 是原 UART 的功能剪裁版本。它只支持基础 UART 功能，不支持 IrDA 或 RS485 协议，并且只有一块较小的 RAM 存储空间。想要全面了解的 UART 及 LP UART 功能区别，请参考 **{IDF_TARGET_NAME} 技术参考手册** > UART 控制器 (UART) > 主要特性 [`PDF <{IDF_TARGET_TRM_EN_URL}#uart>`__]。 -.. toctree:: - :hidden: - - uhci - .. only:: SOC_UHCI_SUPPORTED + .. toctree:: + :hidden: + + uhci + {IDF_TARGET_NAME} 芯片也支持 UART DMA 模式, 请参考 :doc:`uhci` 以获得更多信息. 功能概述 @@ -239,7 +239,7 @@ UART 控制器支持多种通信模式，使用函数 :cpp:func:`uart_set_mode` 使用中断 ^^^^^^^^^^^^^^^^^ -根据特定的 UART 状态或检测到的错误，可以生成许多不同的中断。**{IDF_TARGET_NAME} 技术参考手册** > UART 控制器 (UART) > UART 中断 和 UHCI 中断 [`PDF <{IDF_TARGET_TRM_EN_URL}#uart>`__] 中提供了可用中断的完整列表。调用 :cpp:func:`uart_enable_intr_mask` 或 :cpp:func:`uart_disable_intr_mask` 能够分别启用或禁用特定中断。 +根据特定的 UART 状态或检测到的错误，可以生成许多不同的中断。**{IDF_TARGET_NAME} 技术参考手册** > UART 控制器 (UART) > UART 中断 [`PDF <{IDF_TARGET_TRM_EN_URL}#uart>`__] 中提供了可用中断的完整列表。调用 :cpp:func:`uart_enable_intr_mask` 或 :cpp:func:`uart_disable_intr_mask` 能够分别启用或禁用特定中断。 UART 驱动提供了一种便利的方法来处理特定的中断，即将中断包装成相应的事件。这些事件定义在 :cpp:type:`uart_event_type_t` 中，FreeRTOS 队列功能可将这些事件报告给用户应用程序。 diff --git a/examples/peripherals/temperature_sensor/temp_sensor/README.md b/examples/peripherals/temperature_sensor/temp_sensor/README.md index e868701c66..e7352045ab 100644 --- a/examples/peripherals/temperature_sensor/temp_sensor/README.md +++ b/examples/peripherals/temperature_sensor/temp_sensor/README.md @@ -7,13 +7,13 @@ The ESP32-S2/C3/S3/C2 has a built-in temperature sensor. The temperature sensor 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. -| DAC level | offset | measure range(℃) | measure error(℃) | -| :-------: | :----: | :--------------: | :--------------: | -| 0 | -2 | 50 ~ 125 | < 3 | -| 1 | -1 | 20 ~ 100 | < 2 | -| 2 | 0 | -10 ~ 80 | < 1 | -| 3 | 1 | -30 ~ 50 | < 2 | -| 4 | 2 | -40 ~ 20 | < 3 | +| DAC level | offset | measure range(℃) | +| :-------: | :----: | :--------------: | +| 0 | -2 | 50 ~ 125 | +| 1 | -1 | 20 ~ 100 | +| 2 | 0 | -10 ~ 80 | +| 3 | 1 | -30 ~ 50 | +| 4 | 2 | -40 ~ 20 | ## How to use example