esp_console.h File Reference

#include <stddef.h>
#include <stdint.h>
#include "esp_err.h"
#include "esp_heap_caps.h"

Go to the source code of this file.

Data Structures
struct	esp_console_config_t
struct	esp_console_repl_config_t
struct	esp_console_cmd_t
struct	esp_console_repl_s

Macros
#define	ESP_CONSOLE_CONFIG_DEFAULT()
#define	ESP_CONSOLE_REPL_CONFIG_DEFAULT()

Typedefs
typedef struct linenoiseCompletions	linenoiseCompletions
typedef int(*	esp_console_cmd_func_t) (int argc, char **argv)
typedef int(*	esp_console_cmd_func_with_context_t) (void *context, int argc, char **argv)
typedef struct esp_console_repl_s	esp_console_repl_t

Enumerations
enum	esp_console_help_verbose_level_e {   ESP_CONSOLE_HELP_VERBOSE_LEVEL_0 = 0 ,   ESP_CONSOLE_HELP_VERBOSE_LEVEL_1 = 1 ,   ESP_CONSOLE_HELP_VERBOSE_LEVEL_MAX_NUM = 2 }

Functions
esp_err_t	esp_console_init (const esp_console_config_t *config)
esp_err_t	esp_console_deinit (void)
esp_err_t	esp_console_cmd_register (const esp_console_cmd_t *cmd)
esp_err_t	esp_console_cmd_deregister (const char *cmd_name)
esp_err_t	esp_console_run (const char *cmdline, int *cmd_ret)
size_t	esp_console_split_argv (char *line, char **argv, size_t argv_size)
esp_err_t	esp_console_register_help_command (void)
esp_err_t	esp_console_deregister_help_command (void)
esp_err_t	esp_console_set_help_verbose_level (esp_console_help_verbose_level_e verbose_level)
void	esp_console_get_completion (const char *buf, linenoiseCompletions *lc)
const char *	esp_console_get_hint (const char *buf, int *color, int *bold)
esp_err_t	esp_console_new_repl_stdio (const esp_console_repl_config_t *repl_config, esp_console_repl_t **ret_repl)
esp_err_t	esp_console_delete_repl_stdio (esp_console_repl_t *repl)
esp_err_t	esp_console_start_repl (esp_console_repl_t *repl)
esp_err_t	esp_console_stop_repl (esp_console_repl_t *repl)

Macro Definition Documentation

ESP_CONSOLE_CONFIG_DEFAULT

#define ESP_CONSOLE_CONFIG_DEFAULT

(

)

Value:

    {                                          \
        .max_cmdline_length = 256,             \
        .max_cmdline_args = 32,                \
        .heap_alloc_caps = MALLOC_CAP_DEFAULT, \
        .hint_color = 39,                      \
        .hint_bold = 0                         \
    }

ESP_CONSOLE_REPL_CONFIG_DEFAULT

#define ESP_CONSOLE_REPL_CONFIG_DEFAULT

(

)

Value:

    {                                     \
        .max_history_len = 32,            \
        .history_save_path = NULL,        \
        .task_stack_size = 4096,          \
        .task_priority = 2,               \
        .task_core_id = -1,               \
        .prompt = NULL,                   \
        .max_cmdline_length = 0,          \
    }

Typedef Documentation

linenoiseCompletions

typedef struct linenoiseCompletions linenoiseCompletions

esp_console_cmd_func_t

typedef int(* esp_console_cmd_func_t) (int argc, char **argv)

esp_console_cmd_func_with_context_t

typedef int(* esp_console_cmd_func_with_context_t) (void *context, int argc, char **argv)

esp_console_repl_t

typedef struct esp_console_repl_s esp_console_repl_t

Enumeration Type Documentation

esp_console_help_verbose_level_e

enum esp_console_help_verbose_level_e

Enumerator
ESP_CONSOLE_HELP_VERBOSE_LEVEL_0
ESP_CONSOLE_HELP_VERBOSE_LEVEL_1
ESP_CONSOLE_HELP_VERBOSE_LEVEL_MAX_NUM

Function Documentation

esp_console_init()

esp_err_t esp_console_init

(

const esp_console_config_t *

config

)

esp_console_deinit()

esp_err_t esp_console_deinit

(

void

)

esp_console_cmd_register()

esp_err_t esp_console_cmd_register

(

const esp_console_cmd_t *

cmd

)

esp_console_cmd_deregister()

esp_err_t esp_console_cmd_deregister

(

const char *

cmd_name

)

esp_console_run()

esp_err_t esp_console_run	(	const char *	cmdline,
		int *	cmd_ret
	)

esp_console_split_argv()

size_t esp_console_split_argv	(	char *	line,
		char **	argv,
		size_t	argv_size
	)

esp_console_register_help_command()

esp_err_t esp_console_register_help_command

(

void

)

esp_console_deregister_help_command()

esp_err_t esp_console_deregister_help_command

(

void

)

esp_console_set_help_verbose_level()

esp_err_t esp_console_set_help_verbose_level

(

esp_console_help_verbose_level_e

verbose_level

)

esp_console_get_completion()

void esp_console_get_completion	(	const char *	buf,
		linenoiseCompletions *	lc
	)

esp_console_get_hint()

const char * esp_console_get_hint	(	const char *	buf,
		int *	color,
		int *	bold
	)

esp_console_new_repl_stdio()

esp_err_t esp_console_new_repl_stdio	(	const esp_console_repl_config_t *	repl_config,
		esp_console_repl_t **	ret_repl
	)

esp_console_delete_repl_stdio()

esp_err_t esp_console_delete_repl_stdio

(

esp_console_repl_t *

repl

)

esp_console_start_repl()

esp_err_t esp_console_start_repl

(

esp_console_repl_t *

repl

)

esp_console_stop_repl()

esp_err_t esp_console_stop_repl

(

esp_console_repl_t *

repl

)