Class TerminalSerialCallbackInterface

Inheritance Relationships

Derived Types

Class Documentation

class TerminalSerialCallbackInterface

If you would like to interact with the terminal, extend this class and implement the callback.

Subclassed by tap::communication::sensors::imu::ImuTerminalSerialHandler, tap::control::SchedulerTerminalHandler, tap::errors::ErrorController, tap::motor::DjiMotorTerminalSerialHandler

Public Functions

virtual bool terminalSerialCallback(char *inputLine, modm::IOStream &outputStream, bool streamingEnabled) = 0
Parameters:
  • inputLine[in] The user input to be processed.

  • outputStream[out] The stream to write information to.

  • streamingEnabled[in] Set to true when the streaming is initially enabled. Subsequent interactions with the callback handler will be via terminalSerialStreamCallback until streaming has been disabled.

Returns:

true if the inputLine was valid and was parsed correctly, false otherwise.

virtual void terminalSerialStreamCallback(modm::IOStream &outputStream) = 0

Called repeatedly by the TerminalSerial when in streaming mode.