2023-08-16 22:45:23 -04:00
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-P4 | ESP32-S2 | ESP32-S3 |
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- | -------- |
2022-07-12 22:41:36 -04:00
2017-09-27 16:03:22 -04:00
# UART Events Example
2018-11-01 06:57:24 -04:00
(See the README.md file in the upper level 'examples' directory for more information about examples.)
2017-09-27 16:03:22 -04:00
2018-11-01 06:57:24 -04:00
This example shows how to use the UART driver to handle special UART events. It also reads data from `UART0` directly,
and echoes it back to the monitoring console.
2017-09-27 16:03:22 -04:00
2018-11-01 06:57:24 -04:00
## How to use example
2017-09-27 16:03:22 -04:00
2018-11-01 06:57:24 -04:00
### Hardware Required
2023-01-31 02:09:24 -05:00
The example can be run on any development board, that is based on the Espressif SoC. The board shall be connected to a computer with a single USB cable for flashing and monitoring.
2018-11-01 06:57:24 -04:00
### Configure the project
```
2019-08-01 23:31:20 -04:00
idf.py menuconfig
2018-11-01 06:57:24 -04:00
```
### Build and Flash
Build the project and flash it to the board, then run monitor tool to view serial output:
```
2019-08-01 23:31:20 -04:00
idf.py -p PORT flash monitor
2018-11-01 06:57:24 -04:00
```
(To exit the serial monitor, type ``Ctrl-]``.)
See the Getting Started Guide for full steps to configure and use ESP-IDF to build projects.
## Example Output
Pushing `a` followed by a `b` on the keyboard will generate the following output:
```
...
I (0) cpu_start: Starting scheduler on APP CPU.
I (299) uart: queue free spaces: 20
I (2249) uart_events: uart[0] event:
I (2249) uart_events: [UART DATA]: 1
I (2249) uart_events: [DATA EVT]:
aI (12089) uart_events: uart[0] event:
I (12089) uart_events: [UART DATA]: 1
I (12089) uart_events: [DATA EVT]:
b
```