Chapter 2. API Reference
• ESP_ERR_INVALID_STATE, if repl has started already
Parameters
• [in] repl: REPL handle returned from esp_console_new_repl_xxx
Structures
struct esp_console_config_t
Parameters for console initialization.
Public Members
size_t max_cmdline_length
length of command line buffer, in bytes
size_t max_cmdline_args
maximum number of command line arguments to parse
int hint_color
ASCII color code of hint text.
int hint_bold
Set to 1 to print hint text in bold.
struct esp_console_repl_config_t
Parameters for console REPL (Read Eval Print Loop)
Public Members
uint32_t max_history_len
maximum length for the history
const char *history_save_path
file path used to save history commands, set to NULL won’t save to file system
uint32_t task_stack_size
repl task stack size
uint32_t task_priority
repl task priority
const char *prompt
prompt (NULL represents default: “esp> “)
size_t max_cmdline_length
maximum length of a command line. If 0, default value will be used
struct esp_console_dev_uart_config_t
Parameters for console device: UART.
Public Members
int channel
UART channel number (count from zero)
int baud_rate
Comunication baud rate.
int tx_gpio_num
GPIO number for TX path, -1 means using default one.
int rx_gpio_num
GPIO number for RX path, -1 means using default one.
Espressif Systems 803
Submit Document Feedback
Release v4.4
To Next Page
Loading...