esp-idf/examples/system/console
Lou Tian Hao 3b14a9d58e Merge branch 'support/deep_sleep_test_for_esp32h2' into 'master'
Support: enable CI test for esp32h2 deep_sleep

Closes IDF-7838

See merge request espressif/esp-idf!25002
2023-08-01 17:37:10 +08:00
..
advanced Merge branch 'support/deep_sleep_test_for_esp32h2' into 'master' 2023-08-01 17:37:10 +08:00
advanced_usb_cdc refactor(examples/console): Warn if secondary console is active 2023-07-03 13:42:35 +08:00
basic remove(pm/deep_sleep): enable CI test for esp32h2 deepsleep 2023-07-27 12:11:35 +08:00
README.md doc: redirect console page 2022-11-02 14:21:57 +08:00

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 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 works with UART only.

advanced_usb_cdc example

This example is similar to the one above, except it works over USB CDC provided by USB_OTG peripheral.

Currently it can be used on ESP32-S2.