Debug Console API

Debug console related APIs for ESP-NOW.

API Reference

Header File

Functions

esp_err_t espnow_console_init(const espnow_console_config_t *config)

Initialize console module.

  • Initialize the console

  • Register help commands

  • Initialize filesystem

  • Create console handle task

Parameters:

config – [in] pointer to the console configuration structure

Returns:

  • ESP_OK

  • ESP_FAIL

esp_err_t espnow_console_deinit(void)

De-initialize console module Call this once when done using console module functions.

Returns:

  • ESP_OK

  • ESP_FAIL

void espnow_console_commands_register()

Register Common commands.

_cplusplus

Structures

struct espnow_console_config_s

Console configuration.

< _cplusplus

Public Members

bool uart

Receiving command from uart

bool espnow

Receiving command from espnow

struct espnow_console_config_s::[anonymous] monitor_command

Command monitor configuration

const char *base_path

Path where partition should be registered (e.g. “/spiflash”)

const char *partition_label

Label of the partition which should be used

struct espnow_console_config_s::[anonymous] store_history

Command story history configuration

Type Definitions

typedef struct espnow_console_config_s espnow_console_config_t

Console configuration.

< _cplusplus