mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
82a4c12817
- removed examples/system/console/advanced_usb_cdc
- refactor resulting console/advanced example
- enabled advanced console for all peripherals (UART, USB_OTG, USB_JTAG)
- added pytest to check UART console output
- update docs
22 lines
1.1 KiB
Markdown
22 lines
1.1 KiB
Markdown
# Console examples
|
|
|
|
(See the README.md file in the upper level 'examples' directory for more information about examples.)
|
|
|
|
Examples in this directory illustrate the usage of the [Console Component](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/system/console.html#console) to create an interactive shell on the ESP chip.
|
|
|
|
## basic example
|
|
|
|
This example illustrates high-level Read-Eval-Print Loop API (`esp_console_repl`).
|
|
|
|
This example can be used with UART, USB_OTG or USB_SERIAL_JTAG peripherals. It works on all ESP chips.
|
|
|
|
It is the recommended starting point when getting familiar with console component.
|
|
|
|
## advanced example
|
|
|
|
This example illustrates lower-level APIs for line editing and autocompletion (`linenoise`), argument parsing (`argparse3`) and command registration (`esp_console`).
|
|
|
|
These APIs allow for a lot of flexibility when building a console application, but require more code to be written.
|
|
|
|
While these APIs allow for a console to be implemented over various interfaces (UART, USB, TCP), this example can be used with UART, USB_OTG or USB_SERIAL_JTAG peripherals.
|