Historia

Jakob Hasse ad184e979a refactor (nvs)!: New interface for iterator functions Closes https://github.com/espressif/esp-idf/issues/7826 * nvs_entry_find(), nvs_entry_next() and nvs_entry_info() return error codes now * nvs_entry_find() and nvs_entry_next() access/modify iterator via parameters, instead of returning an new iterator. Added appropriate documentation in Chinese and English		2022-05-30 09:28:42 +08:00
..
advanced	refactor (nvs)!: New interface for iterator functions	2022-05-30 09:28:42 +08:00
advanced_usb_cdc	examples: move console_usb example to console directory	2022-05-04 11:34:06 +02:00
basic	examples: support USB_CDC and USB_SERIAL_JTAG in basic console example	2022-05-04 11:34:06 +02:00
README.md	examples: console: add a readme with an overview of examples	2022-05-04 11:34:07 +02:00

README.md

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.