touch_sensor: update readme for all examples

This commit is contained in:
wangyuanze
2022-07-28 14:52:53 +08:00
parent 4a617e459a
commit 0e3bd7592f
9 changed files with 216 additions and 63 deletions
@@ -3,18 +3,28 @@
# Touch button example
(See the README.md file in the upper level 'examples' directory for more information about examples.)
This example demonstrates how to use the Touch Element library of capacitive touch sensor and set up touch button.
## How to use example
### Hardware Required
* A development board with ESP32-S2 or ESP32-S3 chip
* A touch extension board like [esp32-s2-touch-devkit-1](https://docs.espressif.com/projects/espressif-esp-dev-kits/en/latest/esp32s2/esp32-s2-touch-devkit-1/user_guide.html)
### Configure the project
* Set the target of the build (where `{IDF_TARGET}` stands for the target chip such as `esp32s2`).
* Run `menuconfig` to select a dispatch method for the example.
* Set the target of the build by following command, where TARGET can be `esp32s2` or `esp32s3`.
```
idf.py set-target TARGET
```
* Run `idf.py menuconfig` to select a dispatch method for the example.
### Build and Flash
Build the project and flash it to the target board, then run monitor tool to view serial output:
Build the project and flash it to the board, then run monitor tool to view serial output:
```
idf.py -p PORT flash monitor
@@ -56,4 +66,6 @@ I (11991) Touch Button Example: Button[9] LongPress
I (12881) Touch Button Example: Button[9] Release
```
See the README.md file in the upper level 'examples' directory for more information about examples.
## Troubleshooting
For any technical queries, please open an [issue](https://github.com/espressif/esp-idf/issues) on GitHub. We will get back to you soon.