CLI interface to get and set device configuration options. More...

#include <config_cli.h>

Collaboration diagram for CLIConfig:

Static Public Member Functions
static BaseType_t	enter_cli (char pcWriteBuffer, size_t xWriteBufferLen, const char pcCommandString)
	Enter command line interface (CLI) mode for the given command string. More...

Static Public Attributes
static const std::string	cmd = "config"
	CLI prefix for configuration commands. More...

Static Private Attributes
static DeviceConfig &	config = DeviceConfig::get()
	Current device configuration (called upon initialisation) More...

Detailed Description

CLI interface to get and set device configuration options.

Member Function Documentation

BaseType_t CLIConfig::enter_cli	(	char *	pcWriteBuffer,
		size_t	xWriteBufferLen,
		const char *	pcCommandString
	)

static

Enter command line interface (CLI) mode for the given command string.

This function handles the following commands:

list: Lists the current configuration settings to the response buffer.
load: Loads the configuration from SPIFFS storage and outputs it to the response buffer.
save: Saves the current configuration to persistent storage (SPIFFS).

If an invalid command or argument is given, an error message is added to the response buffer.

Parameters

pcWriteBuffer	Pointer to the buffer where the output string is to be written.
xWriteBufferLen	Maximum length of the output string, including the null terminator.
pcCommandString	Pointer to the command string input by the user.

const std::string CLIConfig::cmd = "config"

inlinestatic

CLI prefix for configuration commands.

inlinestaticprivate

Current device configuration (called upon initialisation)

The documentation for this class was generated from the following files: