Update to 4.1.0

Added a userString system so that the user can include a String that is printed in help and query commands. The string can contain a device or product name, firmware version etc ...

Author: CreativeRobotics

Changelog.txt

@@ -1,6 +1,11 @@
 Commander changelog
 (Changelog started at 1.2.3)
 
+4.1.0
+
+Added setUserString(&String) and printUserString(). A String can be created with user defined information, for example a product name, web URL and firmware version. This String will be printed at the start of the help page and status query page (the '?' command). This allows the user to incorporate their own device or product information into the command system. The string can be formatted however the user wants, including with newlines, tabs etc, and will be printed exactly as is - Other help page items print the comment characterat the start of each line, if the user wants the user String to also appear as comment lines then they need to incorporate the comment characters in the String themselves.
+Updated test suite sketch with example use.
+
 Commander 4.0.0 - Method act
 
 Method CHAIN'O'RAMA! All methods that used to return void now return a *this reference allowing them to be chained.

examples/BasicCommands/BasicCommands.ino

@@ -6,12 +6,16 @@ Commander cmd;
 //Variables we can set or get
 int myInt = 0;
 float myFloat = 0.0;
+
+String deviceInfo = "#\tCommander basic commands example\n#\thttps://github.com/CreativeRobotics/Commander";
 //SETUP ---------------------------------------------------------------------------
 void setup() {
   Serial.begin(115200);
   initialiseCommander();
   while(!Serial){;}
-  Serial.println("Hello: Type 'help' to get help");
+  cmd.printUserString();
+  cmd.println();
+  Serial.println("Type 'help' to get help");
   cmd.printCommandPrompt();
 }
 

examples/BasicCommands/masterCommands.ino

@@ -27,6 +27,7 @@ void initialiseCommander(){
   cmd.echo(true);     //Echo incoming characters to theoutput port
   cmd.errorMessages(ON); //error messages are enabled - it will tell us if we issue any unrecognised commands
   cmd.autoChain(ON);
+  cmd.setUserString(deviceInfo);
 }
 
 //These are the command handlers, there needs to be one for each command in the command array myCommands[]

examples/TEST_SUITE1/TEST_SUITE1.ino

@@ -9,12 +9,17 @@ float myFloat1, myFloat2;
 float myFloat = 0.0;
 String myString1 = "";
 String myString2 = "";
+//User string - this can be anything you want, and is printed when the help and ? commands are used
+//Its a good idea to put the # symbol in front of each line so that if the response to these commands is fet to another commander, they will be interpreted as comments.
+String deviceInfo = "#\t(Start of user string)\n#\tCommander test suite\n#\tDevice firmware version 1.0.0 revision x\n#\thttps://github.com/CreativeRobotics/Commander\n#\t(End of user string)";
 //SETUP ---------------------------------------------------------------------------
 void setup() {
   Serial.begin(115200);
   while(!Serial){;}
   initialiseCommander();
-  Serial.println("Hello: Type 'help' to get help");
+  cmd.printUserString();
+  cmd.println();
+  Serial.println("Type 'help' to get help");
   cmd.printCommandPrompt();
 }
 

examples/TEST_SUITE1/masterCommands.ino

@@ -28,11 +28,12 @@ bool myFunc(Commander &Cmdr){
 
 //Initialisation function that avoids having to forward declare the command array and a size variable.
 void initialiseCommander(){
-  cmd.begin(&Serial, masterCommands, sizeof(masterCommands));
-  cmd.commandPrompt(ON); //enable the command prompt
-  cmd.echo(true);     //Echo incoming characters to theoutput port
-  cmd.errorMessages(ON); //error messages are enabled - it will tell us if we issue any unrecognised commands
-  cmd.autoChain(ON);
+  cmd.begin(&Serial, masterCommands, sizeof(masterCommands))
+                                                            .commandPrompt(ON)
+                                                            .echo(true)
+                                                            .errorMessages(ON)
+                                                            .autoChain(ON)
+                                                            .setUserString(deviceInfo);
 }
 
 

keywords.txt

@@ -15,6 +15,8 @@ update	KEYWORD2
 printCommands	KEYWORD2
 setPassPhrase	KEYWORD2
 printPassPhrase	KEYWORD2
+setUserString	KEYWORD2
+printUserString KEYWORD2
 lock	KEYWORD2
 unlock	KEYWORD2
 setLockType	KEYWORD2

library.properties

@@ -1,5 +1,5 @@
 name=Commander
-version=4.0.0
+version=4.1.0
 author=Bill Bigge
 maintainer=Bill Bigge <[email protected]>
 sentence=Command line library for Arduino.

src/Commander.cpp

@@ -1312,7 +1312,8 @@ bool Commander::isEndOfCommand(char dataByte){
 
 
 Commander& Commander::printCommandList(){
-	  //Prints all the commands
+	  //Prints all the commands, start with the user string if it exists
+	if(userString != NULL) println(*userString);
   uint8_t n = 0;
 	String cmdLine = String(commentCharacter);
 	cmdLine.concat(commanderName);
@@ -1354,7 +1355,8 @@ String Commander::getWhiteSpace(uint8_t spaces){
 //==============================================================================================================
 
 Commander& Commander::printCommanderVersion(){
-	
+	//add user string printing. This comes first because the users version number and other info might be more important than Commander ...
+	if(userString != NULL) println(*userString);
 	write(commentCharacter);
 	print(F("\tCommander version "));
 	print(majorVersion);

src/Commander.h

@@ -93,8 +93,8 @@ typedef union {
 //							31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10  9  8  7  6  5  4  3  2  1  0
 //default is 	0b 0  0  0  0  0  0  0  0  0  0  0  0  0  0  0  0  0  1  0  0  0  1  0  1  1  1  0  1  1  0  0  0
 //const String CommanderVersionNumber = "3.0.0";
-const uint8_t majorVersion = 3;
-const uint8_t minorVersion = 3;
+const uint8_t majorVersion = 4;
+const uint8_t minorVersion = 1;
 const uint8_t subVersion   = 0;
 
 typedef enum streamType_t{
@@ -171,6 +171,8 @@ class Commander{
 	bool   update();
 	Commander&	 setPassPhrase(String& phrase) 	{passPhrase = &phrase; return *this;}
 	Commander&   printPassPhrase() 							{print(*passPhrase); return *this;}
+	Commander&	 setUserString(String& str) 		{userString = &str; return *this;}
+	Commander&   printUserString() 							{print(*userString); return *this;}
 	Commander& 	 lock() 												{ports.settings.bit.locked = true; return *this;}
 	Commander& 	 unlock() 											{ports.settings.bit.locked = false; return *this;}
 	Commander& 	 setLockType(bool hlState) 			{ports.settings.bit.useHardLock = hlState; return *this;}
@@ -182,7 +184,7 @@ class Commander{
 	String 				getPayloadString();
 	bool   				feedString(String newString);
 	Commander&   	loadString(String newString);
-	Commander&   	setPending(bool pState)									{commandState.bit.isCommandPending = pState;} //sets the pending command bit - used if manually writing to the buffer
+	Commander&   	setPending(bool pState)									{commandState.bit.isCommandPending = pState; return *this;} //sets the pending command bit - used if manually writing to the buffer
 	Commander&	 	write(uint8_t character) 								{bufferString += character; return *this;}
 	bool 	 				endLine();
 	Commander& 	 	startStreaming() 												{commandState.bit.dataStreamOn = true; return *this;} //set the streaming function ON
@@ -510,7 +512,7 @@ class Commander{
 	uint8_t getInternalCmdLength(const char intCmd[]);
 	//utility to print the buffer contents as integer values
 	void printBuffer(){
-		for(int n = 0; n < bufferString.length(); n++){
+		for(uint32_t n = 0; n < bufferString.length(); n++){
 			write('[');
 			print((int)bufferString.charAt(n));
 			write(']');
@@ -541,7 +543,7 @@ class Commander{
 	uint16_t dataReadIndex = 0; //for parsing many numbers
 	const char* internalCommandArray[INTERNAL_COMMAND_ITEMS];
 	String *passPhrase = NULL;
-	
+	String *userString = NULL;
 	uint8_t primntDelayTime = 0; //
 };