components/console/private_include/console_private.h (ESP-IDF)

Outline

#include <stddef.h>

#include <stdint.h>

#include "sdkconfig.h"

#include "freertos/FreeRTOS.h"

#include "freertos/task.h"

#include "esp_console.h"

#define CONSOLE_PROMPT_MAX_LEN

#define CONSOLE_PATH_MAX_LEN

#include "esp_vfs_dev.h"

#define CONSOLE_PATH_MAX_LEN

repl_state_t

esp_console_repl_com_t

esp_console_repl_universal_t

esp_console_repl_task(void *);

esp_console_common_init(size_t, esp_console_repl_com_t *);

esp_console_setup_prompt(const char *, esp_console_repl_com_t *);

esp_console_setup_history(const char *, uint32_t, esp_console_repl_com_t *);

Files

ESP-IDF

components

app_trace

app_update

bootloader_support

cmock

console

argtable3

linenoise

private_include

console_private.h

commands.c

esp_console_common.c

esp_console_repl_chip.c

esp_console.h

split_argv.c

cxx

driver

efuse

esp_adc

esp_app_format

esp_bootloader_format

esp_coex

esp_common

esp_driver_ana_cmpr

esp_driver_cam

esp_driver_dac

esp_driver_gpio

esp_driver_gptimer

esp_driver_i2c

esp_driver_i2s

esp_driver_jpeg

esp_driver_ledc

esp_driver_mcpwm

esp_driver_parlio

esp_driver_pcnt

esp_driver_rmt

esp_driver_sdio

esp_driver_sdm

esp_driver_sdmmc

esp_driver_sdspi

esp_driver_spi

esp_driver_tsens

esp_driver_uart

esp_driver_usb_serial_jtag

esp_eth

esp_event

esp_gdbstub

esp_hid

esp_http_client

esp_http_server

esp_https_ota

esp_https_server

esp_hw_support

esp_lcd

esp_local_ctrl

esp_mm

esp_netif

esp_partition

esp_phy

esp_pm

esp_psram

esp_ringbuf

esp_rom

esp_security

esp_system

esp_timer

esp_vfs_console

esp_wifi

esp-tls

espcoredump

hal

heap

http_parser

ieee802154

log

mqtt

newlib

nvs_flash

nvs_sec_provider

openthread

perfmon

protobuf-c

protocomm

pthread

sdmmc

soc

spi_flash

spiffs

tcp_transport

ulp

unity

vfs

wear_levelling

wifi_provisioning

wpa_supplicant

xtensa

examples

lwIP

FreeRTOS

cJSON

mbedTLS

SourceVuESP-IDF Framework and ExamplesESP-IDFcomponents/console/private_include/console_private.h

/* * SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ #pragma once #include <stddef.h> #include <stdint.h> #include "sdkconfig.h" #include "freertos/FreeRTOS.h" #include "freertos/task.h" #include "esp_console.h" #define CONSOLE_PROMPT_MAX_LEN (32) #if CONFIG_IDF_TARGET_LINUX #define CONSOLE_PATH_MAX_LEN (128) #else #include "esp_vfs_dev.h" #define CONSOLE_PATH_MAX_LEN (ESP_VFS_PATH_MAX) #endif typedef enum { CONSOLE_REPL_STATE_DEINIT, CONSOLE_REPL_STATE_INIT, CONSOLE_REPL_STATE_START, } repl_state_t; typedef struct { esp_console_repl_t repl_core; // base class char prompt[CONSOLE_PROMPT_MAX_LEN]; // Prompt to be printed before each line repl_state_t state; const char *history_save_path; TaskHandle_t task_hdl; // REPL task handle size_t max_cmdline_length; // Maximum length of a command line. If 0, default value will be used. } esp_console_repl_com_t; typedef struct { esp_console_repl_com_t repl_com; // base class int uart_channel; // uart channel number } esp_console_repl_universal_t; void esp_console_repl_task(void *args); esp_err_t esp_console_common_init(size_t max_cmdline_length, esp_console_repl_com_t *repl_com); esp_err_t esp_console_setup_prompt(const char *prompt, esp_console_repl_com_t *repl_com); esp_err_t esp_console_setup_history(const char *history_path, uint32_t max_history_len, esp_console_repl_com_t *repl_com);

Details