CLIFTP Class Reference

CLI FTP configuration. More...

#include <ftp_cli.h>

Collaboration diagram for CLIFTP:

Static Public Member Functions
static void	dump (Stream &stream)
	Display current FTP configuration. More...
static BaseType_t	enter_cli (char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString)
	Command-line interface command for setting FTP parameters. More...

Static Public Attributes
static const std::string	cmd = "ftp"
	Prefix for all FTP related configuration commands. More...

Static Private Attributes
static DeviceConfig &	config = DeviceConfig::get()
	Get the current device configuration upon initialisation. More...

Detailed Description

CLI FTP configuration.

Provides an interface between the user and the FTP settings stored on the ESP32 in SPIFFS.

Member Function Documentation

dump()

void CLIFTP::dump ( Stream &  stream )

static

Display current FTP configuration.

Parameters

stream

Output stream.

enter_cli()

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

static

Command-line interface command for setting FTP parameters.

This function provides a command-line interface for setting FTP connection parameters such as the host, port, user, and password. Commands include:

• list: List FTP configuration.
• host: FTP server hostname.
• user: FTP username.
• password: FTP password.

Parameters

pcWriteBuffer	The buffer to write the command's output to.
xWriteBufferLen	The length of the write buffer.
pcCommandString	The command string to be parsed.

Returns

pdTRUE if there are more responses to come, pdFALSE if this is the final response.

Member Data Documentation

cmd

const std::string CLIFTP::cmd = "ftp"

inlinestatic

Prefix for all FTP related configuration commands.

config

DeviceConfig& CLIFTP::config = DeviceConfig::get()

inlinestaticprivate

Get the current device configuration upon initialisation.

---

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

• firmware/wombat/include/cli/device_config/ftp_cli.h
• firmware/wombat/src/cli/device_config/ftp_cli.cpp