Wombat Environmental Node 1.0
An environmental node for SDI-12 and digital sensors.
Loading...
Searching...
No Matches
CLI.cpp File Reference

FreeRTOS CLI handler. More...

Include dependency graph for CLI.cpp:

Variables

static char cmd [CLI::MAX_CLI_CMD_LEN+1]
 Command buffer. More...
 
static char msg [CLI::MAX_CLI_MSG_LEN+1]
 Message buffer. More...
 
static const CLI_Command_Definition_t configCmd
 Node configuration commands. More...
 
static const CLI_Command_Definition_t intervalCmd
 Node measurement interval commands. More...
 
static const CLI_Command_Definition_t sdi12Cmd
 SDI-12 commands. More...
 
static const CLI_Command_Definition_t catM1Cmd
 CAT-M1 modem commands. More...
 
static const CLI_Command_Definition_t mqttCmd
 MQTT setup and connection commands. More...
 
static const CLI_Command_Definition_t ftpCmd
 FTP setup and connection commands. More...
 
static const CLI_Command_Definition_t powerCmd
 Power commands. More...
 
static const CLI_Command_Definition_t sdCmd
 SD card commands. More...
 
static const CLI_Command_Definition_t spiffsCmd
 SPIFFS commands. More...
 

Detailed Description

FreeRTOS CLI handler.

Date
January 2023

Variable Documentation

◆ catM1Cmd

const CLI_Command_Definition_t catM1Cmd
static
Initial value:
= {
CLICatM1::cmd.c_str(),
"c1:\r\n Configure and interface with Cat M1 modem\r\n",
-1
}
static const std::string cmd
CLI CAT-M1 reference, to send commands use "c1" followed by the command.
Definition: cat-m1.h:28
static BaseType_t enter_cli(char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString)
Command line interface handler for a Cat M1 device.
Definition: cat-m1.cpp:72

CAT-M1 modem commands.

◆ cmd

char cmd[CLI::MAX_CLI_CMD_LEN+1]
static

Command buffer.

◆ configCmd

const CLI_Command_Definition_t configCmd
static
Initial value:
= {
CLIConfig::cmd.c_str(),
"config:\r\n Load, save, or list the node configuration or reboot\r\n",
-1
}
static BaseType_t enter_cli(char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString)
Enter command line interface (CLI) mode for the given command string.
Definition: config_cli.cpp:47
static const std::string cmd
CLI prefix for configuration commands.
Definition: config_cli.h:22

Node configuration commands.

◆ ftpCmd

const CLI_Command_Definition_t ftpCmd
static
Initial value:
= {
CLIFTP::cmd.c_str(),
"ftp:\r\n Configure FTP connection parameters\r\n",
-1
}
static const std::string cmd
Prefix for all FTP related configuration commands.
Definition: ftp_cli.h:23
static BaseType_t enter_cli(char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString)
Command-line interface command for setting FTP parameters.
Definition: ftp_cli.cpp:53

FTP setup and connection commands.

◆ intervalCmd

const CLI_Command_Definition_t intervalCmd
static
Initial value:
= {
"interval:\r\n Configure acquisition interval settings\r\n",
-1
}
static BaseType_t enter_cli(char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString)
CLI entrypoint for measurement and uplink interval setup.
Definition: acquisition_intervals.cpp:75
static const std::string cmd
Command to change measurement and/or uplink interval.
Definition: acquisition_intervals.h:29

Node measurement interval commands.

◆ mqttCmd

const CLI_Command_Definition_t mqttCmd
static
Initial value:
= {
CLIMQTT::cmd.c_str(),
"mqtt:\r\n Configure MQTT connection parameters\r\n",
-1
}
static const std::string cmd
Prefix for all MQTT related configuration commands.
Definition: mqtt_cli.h:25
static BaseType_t enter_cli(char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString)
Command-line interface command for setting MQTT parameters.
Definition: mqtt_cli.cpp:63

MQTT setup and connection commands.

◆ msg

char msg[CLI::MAX_CLI_MSG_LEN+1]
static

Message buffer.

◆ powerCmd

const CLI_Command_Definition_t powerCmd
static
Initial value:
= {
CLIPower::cmd.c_str(),
"pwr:\r\n Show battery and solar information\r\n",
-1
}
static const std::string cmd
Power related commands in the CLI begin with "pwr".
Definition: cli_power.h:17
static BaseType_t enter_cli(char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString)
Command-line interface command for working with the power buses.
Definition: cli_power.cpp:35

Power commands.

◆ sdCmd

const CLI_Command_Definition_t sdCmd
static
Initial value:
= {
CLISDCard::cmd.c_str(),
"sd:\r\n Access the SD card\r\n",
-1
}
static BaseType_t enter_cli(char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString)
Command-line interface command for working with the power buses.
Definition: sd_card.cpp:29
static const std::string cmd
SD card related commands in the CLI begin with "sd".
Definition: sd_card.h:13

SD card commands.

◆ sdi12Cmd

const CLI_Command_Definition_t sdi12Cmd
static
Initial value:
= {
CLISdi12::cmd.c_str(),
"sdi12:\r\n Configure and interface with SDI-12 sensors\r\n",
-1
}
static BaseType_t enter_cli(char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString)
Command line interface handler for an SDI-12 sensor.
Definition: sdi12.cpp:57
static const std::string cmd
CLI SDI-12 reference, to send commands use "sdi12" followed by the cmd.
Definition: sdi12.h:30

SDI-12 commands.

◆ spiffsCmd

const CLI_Command_Definition_t spiffsCmd
static
Initial value:
= {
CLISPIFFS::cmd.c_str(),
"sd:\r\n Access the SPIFFS filesystem\r\n",
-1
}
static BaseType_t enter_cli(char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString)
Command-line interface command for working with the power buses.
Definition: cli_spiffs.cpp:37
static const std::string cmd
SPIFFS card related commands in the CLI begin with "spiffs".
Definition: cli_spiffs.h:13

SPIFFS commands.