CLI Class Reference

FreeRTOS command line interface. More...

#include <CLI.h>

Collaboration diagram for CLI:

Static Public Member Functions
static void	init ()
	Initialise the FreeRTOS command line interface. More...
static void	repl (Stream &input, Stream &output)
	Read-eval-print loop (REPL) for the command line interface (CLI). More...

Static Public Attributes
static Stream *	cliInput = nullptr
	Command line stream. More...
static Stream *	cliOutput = nullptr
static const size_t	MAX_CLI_CMD_LEN = 256
	Maximum command (input) length. More...
static const size_t	MAX_CLI_MSG_LEN = 256
	Maximum command (output) length. More...

Detailed Description

FreeRTOS command line interface.

Provides callbacks to various CLI components such as CAT-M1, configuration, bluetooth and sdi-12 sensor configuration.

Member Function Documentation

init()

void CLI::init ( )

static

Initialise the FreeRTOS command line interface.

repl()

void CLI::repl ( Stream &  input, Stream &  output  )

static

Read-eval-print loop (REPL) for the command line interface (CLI).

This function implements a REPL for the CLI. It reads a command from the user, processes the command, and prints the result of the command. The REPL loop is exited by typing the "exit" command.

Parameters

io	A stream object used for reading input from the user and writing output to the user.

Member Data Documentation

cliInput

Stream * CLI::cliInput = nullptr

static

Command line stream.

cliOutput

Stream * CLI::cliOutput = nullptr

static

MAX_CLI_CMD_LEN

const size_t CLI::MAX_CLI_CMD_LEN = 256

static

Maximum command (input) length.

MAX_CLI_MSG_LEN

const size_t CLI::MAX_CLI_MSG_LEN = 256

static

Maximum command (output) length.

---

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

• firmware/wombat/include/cli/CLI.h
• firmware/wombat/src/cli/CLI.cpp