alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2026-01-06 18:01:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add application examples for i2c, jpeg, temp_sensor and usb_serial-jtag-console

Browse Source
This commit is contained in:
Ren Peiying
2024-09-18 17:31:59 +08:00
parent 965986bcf1
commit fb1b91c8d7
8 changed files with 38 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/en/api-reference/peripherals/i2c.rst
View File

@@ -649,10 +649,10 @@ Kconfig Options
Application Examples
--------------------
.. list::
- :example:`peripherals/i2c/i2c_eeprom` demonstrates how to use the I2C master mode to read and write data from a connected EEPROM.
- :example:`peripherals/i2c/i2c_tools` demonstrates how to use the I2C Tools for developing I2C related applications, providing command-line tools for configuring the I2C bus, scanning for devices, reading and setting registers, and examining registers.
- :example:`peripherals/i2c/i2c_eeprom` demonstrates the basic usage of I2C driver by reading and writing from an I2C connected EEPROM.
- :example:`peripherals/i2c/i2c_tools` implements some basic features of I2C tools based on the ESP32 console component.
API Reference
-------------

6
docs/en/api-reference/peripherals/jpeg.rst
View File

@@ -448,8 +448,10 @@ The JPEG driver usage of hardware resources and its dependency status are shown
Application Examples
--------------------
* JPEG decoder application example: :example:`peripherals/jpeg/jpeg_decode`.
* JPEG encoder application example: :example:`peripherals/jpeg/jpeg_encode`.
- :example:`peripherals/jpeg/jpeg_decode` demonstrates how to use the JPEG hardware decoder to decode JPEG pictures of different sizes (1080p and 720p) into RGB format, showcasing the flexibility and speed of hardware decoding.
- :example:`peripherals/jpeg/jpeg_encode` demonstrates how to use the JPEG hardware encoder to encode a 1080p picture, specifically converting `*.rgb` files to `*.jpg` files.
API Reference
-------------

12
docs/en/api-reference/peripherals/temp_sensor.rst
View File

@@ -203,13 +203,15 @@ Unexpected Behaviors
(1) Totally out of range, like 200 °C ~ 300 °C.
(2) Cross the boundary of each predefined measurement. like 40 °C ~ 110 °C.
Application Example
-------------------
Application Examples
--------------------
.. list::
* :example:`peripherals/temperature_sensor/temp_sensor` demonstrates how to use the built-in temperature sensor, showcasing the measurement range and error based on different DAC levels and offsets.
.. only:: SOC_TEMPERATURE_SENSOR_INTR_SUPPORT
* :example:`peripherals/temperature_sensor/temp_sensor_monitor` demonstrates how to use the temperature sensor to automatically monitor temperature values continuously, triggering an interrupt when a specific value is reached or when the change between two consecutive samplings is larger/smaller than the settings.
* Temperature sensor reading example: :example:`peripherals/temperature_sensor/temp_sensor`.
:SOC_TEMPERATURE_SENSOR_INTR_SUPPORT: * Temperature sensor value monitor example: :example:`peripherals/temperature_sensor/temp_sensor_monitor`.
API Reference
----------------------------------