Home

Welcome to the Commander wiki!

Commander API:

#Constructor and update Commander(); Commander(uint16_t reservedBuffer) void begin(Stream *sPort) void begin(Stream *sPort, const commandList_t *commands, uint32_t size) void begin(Stream *sPort, Stream *oPort, const commandList_t *commands, uint32_t size) bool update()

#Locking void setPassPhrase(String& phrase) void printPassPhrase() void lock() void unlock() void setLockType(bool hlState) bool isLocked() bool getLockType() bool feed(Commander& Cmdr) bool feedString(String newString) void loadString(String newString) bool endLine()

#File streaming and number commands: void startStream() void stopStream() void setStream(bool streamState) Set the state of the streaming system – on or off. bool isStreaming() void attachSpecialHandler(cmdHandler handler) void transfer(Commander& Cmdr) bool transferTo(const commandList_t *commands, uint32_t size, String newName) void transferBack(const commandList_t *commands, uint32_t size, String newName)

#Streams void attachOutputPort(Stream oPort) Stream* getOutputPort() void attachAltPort(Stream *aPort) Stream getAltPort() void attachInputPort(Stream iPort) Stream getInputPort() void deleteAltPort() void attachDefaultHandler(cmdHandler handler) void setBuffer(uint16_t buffSize) void attachCommands(const commandList_t *commands, uint32_t size) void setStreamType(streamType_t newType) streamType_t getStreamType()

#Quick set and get system void quickSetHelp() bool quickSet(String cmd, int& var) bool quickSet(String cmd, float& var) bool quickSet(String cmd, double& var) void quickGet(String cmd, int var) void quickGet(String cmd, float var)

#Print methods: size_t println() size_t print(printType printableVariable) size_t print(printType printableVariable, int fmt) size_t println(printType printableVariable) size_t println(printType printableVariable, int fmt) size_t write(printType printableVariable) size_t write(printType printableVariable, int length) #Prefix and Postfix methods void setPrefix(String prfx) void startPrefix() void setPostfix(String pofx) void startFormatting() void setAutoFormat(bool state) bool getAutoFormat()

#Configuration: void printCommandPrompt() void setCommentChar(char cmtChar) void setReloadChar(char reloadChar) void setEndOfLineChar(char eol) void setPromptChar(char eol) void setDelimChar(char eol) void echo(bool sState) void printComments(bool cState) void echoToAlt(bool sState) void copyRepyAlt(bool sState) void commandProcessor(bool state) bool commandProcessor() void stripCR(bool sState) bool stripCR() void multiCommander(bool enable) bool multiCommander() void errorMessages(bool state) bool errorMessages() void commandPrompt(bool state) bool commandPrompt() void showHelp(bool state)} bool showHelp() void internalCommands(bool state) bool internalCommands() void showInternalCommands(bool state) bool showInternalCommands() cmdSettings_t getSettings() void setSettings(cmdSettings_t newSet) portSettings_t getPortSettings() void setPortSettings(portSettings_t newPorts) void printDiagnostics()

#Payload processing bool containsTrue() bool containsOn() bool hasPayload() String getPayload() String getPayloadString() bool getInt(iType &myIvar) bool getFloat(float &myFloat) bool getDouble(double &myDouble) bool getString(String &myString)

#Help system uint16_t getCommandListLength() String getCommandItem(uint16_t commandItem) uint8_t getInternalCommandLength() String getInternalCommandItem(uint8_t internalItem) void printCommandList() void printCommanderVersion()