ustd::Console Class Reference

muwerk Console Class More...

#include <console.h>

Inheritance diagram for ustd::Console:

Public Member Functions
	Console (String name, Print *printer)
bool	execute (String command)
int	extend (String command, T_COMMANDFN handler)
bool	unextend (String command)
bool	unextend (int commandHandle)

Detailed Description

muwerk Console Class

The console class implements a simple but effective console shell that is the base for ustd::SerialConsole and can also be used for implementing shells over other transport mechanisms. The simple interpreter has the follwing builtin commands:

help: displays a list of supported commands reboot: restarts the device sub: add or remove message subscriptions shown on console pub: allows to publish a message debug: enable or disable wifi diagnostics (if available) wifi: show wifi status (if available) info: show system status

If a file system is available (usually when compiling for ESP8266 or ESP32) there are additional builtin commands available:

ls: display directory contents cat: outputs the specified files rm: removes the specified files jf: read, write or delete values in json files

The commandline parser can be extended (see example below)

Sample of a serial console with extension

#include "scheduler.h"
#include "console.h"
 
ustd::Scheduler sched( 10, 16, 32 );
ustd::SerialConsole con;
 
void apploop() {}
 
void setup() {
    // initialize the serial interface
    Serial.begin( 115200 );
 
    // extend console
    con.extend( "hurz", []( String cmd, String args, Print *printer ) {
        printer->println( "Der Wolf... Das Lamm.... Auf der grünen Wiese....  HURZ!" );
        while ( args.length() ) {
            String arg = ustd::shift( args );
            printer->println( arg + "   HURZ!" );
        }
    } );
 
    con.begin( &sched );
    int tID = sched.add( apploop, "main", 50000 );
}
 
void loop() {
    sched.loop();
}

Constructor & Destructor Documentation

Console()

ustd::Console::Console ( String  name, Print *  printer  )

inline

Creates a console

Parameters

name	Name used for task registration and message origin
printer	Pointer to a printer that receives the output

Member Function Documentation

execute()

bool ustd::Console::execute ( String  command )

inline

Executes the given command

Parameters

command

The command to execute

Returns

true if something happened (also if the commad is invalid)

extend()

int ustd::Console::extend ( String  command, T_COMMANDFN  handler  )

inline

Extend the console with a custom command

Parameters

command	The name of the command
handler	Callback of type void myCallback(String command, String args) that is called, if a matching command is entered.

Returns

commandHandle on success (needed for unextend), or -1 on error.

unextend() [1/2]

bool ustd::Console::unextend ( int  commandHandle )

inline

Removes a custom command from the console

Parameters

commandHandle

The commandHandle of the command to remove.

Returns

true on success.

unextend() [2/2]

bool ustd::Console::unextend ( String  command )

inline

Removes a custom command from the console

Parameters

command

The name of the command to remove.

Returns

true on success.

---

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

• console.h