Wombat Environmental Node 1.0
An environmental node for SDI-12 and digital sensors.
Loading...
Searching...
No Matches
Static Public Member Functions | Static Public Attributes | Static Private Attributes | List of all members
CLIMQTT Class Reference

CLI MQTT configuration. More...

#include <mqtt_cli.h>

Collaboration diagram for CLIMQTT:

Static Public Member Functions

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

Static Public Attributes

static const std::string cmd = "mqtt"
 Prefix for all MQTT related configuration commands. More...
 

Static Private Attributes

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

Detailed Description

CLI MQTT configuration.

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

Member Function Documentation

◆ dump()

void CLIMQTT::dump ( Stream &  stream)
static

Display current MQTT configuration.

Parameters
streamOutput stream.

◆ enter_cli()

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

Command-line interface command for setting MQTT parameters.

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

  • list: List MQTT configuration.
  • host: MQTT broker host.
  • port: MQTT broker port.
  • user: MQTT broker username.
  • password: MQTT broker password.
Parameters
pcWriteBufferThe buffer to write the command's output to.
xWriteBufferLenThe length of the write buffer.
pcCommandStringThe 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 CLIMQTT::cmd = "mqtt"
inlinestatic

Prefix for all MQTT related configuration commands.

◆ config

DeviceConfig& CLIMQTT::config = DeviceConfig::get()
inlinestaticprivate

Get the current device configuration upon initialisation.

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