esp_console_new_repl_uart() function

Establish a console REPL environment over UART driver @attention This function is meant to be used in the examples to make the code more compact. Applications which use console functionality should be based on the underlying linenoise and esp_console functions.

Syntax

Show:

Summary

Declaration

Definition

from esp_console.h:393

esp_err_t esp_console_new_repl_uart(const esp_console_dev_uart_config_t *dev_config, const esp_console_repl_config_t *repl_config, esp_console_repl_t **ret_repl);

Implemented in esp_console_repl_chip.c:183

Arguments

Argument

Description

dev_config

UART device configuration

repl_config

REPL configuration

ret_repl

return REPL handle after initialization succeed, return NULL otherwise

Return value

- ESP_OK on success - ESP_FAIL Parameter error

Notes

This is an all-in-one function to establish the environment needed for REPL, includes: - Install the UART driver on the console UART (8n1, 115200, REF_TICK clock source) - Configures the stdin/stdout to go through the UART driver - Initializes linenoise - Spawn new thread to run REPL in the background

Examples

esp_console_new_repl_uart() is referenced by 17 libraries and example projects:

References

from examples

esp_console_new_repl_uart() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle