Version 2.0.0

Some big additions and updates plus changes to the API which may break old sketches.

Author: CreativeRobotics

Changelog.txt

@@ -1,5 +1,35 @@
 Commander changelog
-Starting at 1.2.3
+(Changelog started at 1.2.3)
+
+Commander 2.0.0
+
+Re-worked several methods and method names and probably broke several things, for example setLockType(bool) replaces enableHardLock(), commandPrompt(bool) replaces enablePrompt() and disablePrompt(). Setting parameters like these are now all done by passing an argument, and macros for ON and OFF are defined.
+errorMessagesEnabled now controls all internal messages so disabling them will prevent replies from internal commands like 'echo' or 'U'
+bugfix: internal commands did not check length so, for example, sending helpaxfgqerg was recognised as a help command
+Added PRINT_LINE_DELAY macro - if defined at the start of a sketch it will insert the defined marco before a line of text is printed - used to slow down transmission when sending many lines of data so a slow reciever can handle it.
+Added a defaultHandler function pointer that will be called whenever an unknown command is found. The user can now attach their own command handler for dealing with unrecognised commands. If not specified, the internal handler will be used.
+Added a method that returns the number of items in the command list.
+Added a method to return a String with the command help text for a specified item in the command list.
+Added a method that returns the number of items in the internal command list.
+Added a method to return a String with the command and help text for a specified item in the internal command list.
+Added a hide Internal Commands bit to prevent internal commands being displayed in help.
+Added an enable internal commands bit to stop internal commands from working.
+Added getString() method to extract sequential strings seperated by a space or special delimiter
+Added a countItems method to return the number of items in the payload. An idem is defined as a string with a space or delimChar at each end (or an end of line char)
+Renamed the eocChar into a delimChar, it is used as a delimiter between any items in the payload alongside the space character
+Added methods to set the delimChar and endOfLine char.
+Added two bit StreamType code to indicate if the attached stream is a serial port, file or web - this is to allow handlers to interrogate the Commander object calling the handler to adjust its response for that stream, for example by adding formatting to a response.
+Methods containsOn and containsTrue now work for both lower case and capitals.
+Updated the basic example sketch to demonstrate countItems() and getString() methods. These count and display all items in the payload.
+Added an HTML web server example using Commander to deliver formatted web pages.
+Removed updatePending() because this function is prformed within update()
+
+Utilities:
+Added a function to convert an HTTP GET line to a command string - It finds the start and end of the GET message and converts and / or + chars to spaces. A line with "GET /help HTTP/1.1" will return a string containing "help" or "GET /setLED/on HTTP/1.1" will return "setLED on" The function can return a default string if nothing is found.
+String GET_CommandString(String serverGetLine, String defaultString)
+
+Commander 1.3.2:
+Changed getInt() to a template method so it will work for any int type (byte, long, unsigned etc)
 
 Commander 1.3.1:
 Restructured directories so everything is in src
@@ -13,4 +43,4 @@ Minor edits to readme
 Changes to how help is formatted
 
 Commander 1.2.3:
-Added enable bit for help system and query command. The help system an now be disabled if required.
+Added enable bit for help system and query command. The help system can now be disabled if required.

examples/BasicCommands/BasicCommands.ino

@@ -13,9 +13,9 @@ float myFloat = 0.0;
 void setup() {
   Serial.begin(115200);
   cmd.begin(&Serial, masterCommands, numOfMasterCmds);
-  cmd.enablePrompt(); //enable the command prompt
+  cmd.commandPrompt(ON); //enable the command prompt
   cmd.echo(true);     //Echo incoming characters to theoutput port
-  cmd.enableErrors(); //error messages are enabled - it will tell us if we issue any unrecognised commands
+  cmd.errorMessages(ON); //error messages are enabled - it will tell us if we issue any unrecognised commands
 
   while(!Serial){;}
   Serial.println("Hello: Type 'help' to get help");

examples/BasicCommands/masterCommands.ino

@@ -1,15 +1,16 @@
 //All commands for 'master'
 //COMMAND ARRAY ------------------------------------------------------------------------------
 const commandList_t masterCommands[] = {
-  {"hello",      helloHandler,    "hello"},
-  {"get int",    getIntHandler,   "get an int"},
-  {"set int",    setIntHandler,   "set an int"},
-  {"get float",  getFloatHandler, "get a float"},
-  {"set float",  setFloatHandler, "set a float"},
-  {"myint",      setIntHandler,   "try myint=23"},
-  {"myfloat",    setFloatHandler, "try myfloat=23.5"},
-  {"set ints",   getIntsHandler,   "set up to four ints"},
-  {"set floats",   getFloatsHandler,   "set up to four floats"},
+  {"hello",       helloHandler,     "hello"},
+  {"get int",     getIntHandler,    "get an int"},
+  {"set int",     setIntHandler,    "set an int"},
+  {"get float",   getFloatHandler,  "get a float"},
+  {"set float",   setFloatHandler,  "set a float"},
+  {"myint",       setIntHandler,    "try myint=23"},
+  {"myfloat",     setFloatHandler,  "try myfloat=23.5"},
+  {"set ints",    setIntsHandler,   "set up to four ints"},
+  {"set floats",  setFloatsHandler, "set up to four floats"},
+  {"set strings", setStringsHandler,"set up to four Strings"},
 };
  /*
   * This needs to be passed to the commander object so it knows how big the array of commands is, but this happens earlier in setup().
@@ -61,9 +62,15 @@ bool setFloatHandler(Commander &Cmdr){
   return 0;
 }
 
-bool getIntsHandler(Commander &Cmdr){
+bool setIntsHandler(Commander &Cmdr){
   //create an array to store any values we find
   int values[4] = {0,0,0,0};
+
+  int itms = Cmdr.countItems();
+  Cmdr.print("There are ");
+  Cmdr.print(itms);
+  Cmdr.println(" items in the payload");
+  
   for(int n = 0; n < 4; n++){
     //try and unpack an int, if it fails there are no more left so exit the loop
     if(Cmdr.getInt(values[n])){
@@ -81,20 +88,41 @@ bool getIntsHandler(Commander &Cmdr){
   return 0;
 }
 
-bool getFloatsHandler(Commander &Cmdr){
+bool setFloatsHandler(Commander &Cmdr){
   float values[4] = {0.0,0.0,0.0,0.0};
-  int n = 0;
-  for(n = 0; n < 4; n++){
+  int itms = Cmdr.countItems();
+  Cmdr.print("There are ");
+  Cmdr.print(itms);
+  Cmdr.println(" items in the payload");
+  
+  for(int n = 0; n < 4; n++){
     if(Cmdr.getFloat(values[n])){
       Cmdr.print("unpacked ");
       Cmdr.println(values[n]);
     }else break;
   }
   Cmdr.println("Array contents after processing:");
-  for(n = 0; n < 4; n++){
+  for(int n = 0; n < 4; n++){
     Cmdr.print(n);
     Cmdr.print(" = ");
     Cmdr.println(values[n]);
   }
   return 0;
 }
+
+bool setStringsHandler(Commander &Cmdr){
+  String myString = "";
+  int itms = Cmdr.countItems();
+  Cmdr.print("There are ");
+  Cmdr.print(itms);
+  Cmdr.println(" items in the payload");
+  for(int n = 0; n < itms; n++){
+    if(Cmdr.getString(myString)){
+      Cmdr.print("String ");
+      Cmdr.print(n);
+      Cmdr.print(" = ");
+      Cmdr.println(myString);
+    }else Cmdr.println("Operation failed");
+  }
+  return 0;
+}

examples/ESP32/SerialBTCommands/SerialBTCommands.ino

@@ -25,21 +25,11 @@ void setup() {
   Serial.println("The device started, now you can pair it with bluetooth!");
 
   cmd.begin(&SerialBT, masterCommands, numOfMasterCmds);
-  cmd.enablePrompt(); //enable the command prompt
-  //cmd.echo(true);     //Echo incoming characters to the output port
-  cmd.enableErrors(); //error messages are enabled - it will tell us if we issue any unrecognised commands
-  //while(!Serial){;}
-  //Serial.println("Hello: Type 'help' to get help");
+  cmd.commandPrompt(ON);; //enable the command prompt
   cmd.printCommandPrompt();
 }
 
 void loop() {
   cmd.update();
-  /*if (Serial.available()) {
-    SerialBT.write(Serial.read());
-  }
-  if (SerialBT.available()) {
-    Serial.write(SerialBT.read());
-  }*/
   delay(20);
 }

examples/ESP32/TelnetCommands/TelnetCommands.ino

@@ -58,11 +58,7 @@ void setup() {
 
 
   cmd.begin(&serverClient, masterCommands, numOfMasterCmds);
-  cmd.enablePrompt(); //enable the command prompt
-  //cmd.echo(true);     //Echo incoming characters to the output port
-  cmd.enableErrors(); //error messages are enabled - it will tell us if we issue any unrecognised commands
-  //while(!Serial){;}
-  //Serial.println("Hello: Type 'help' to get help");
+  cmd.commandPrompt(ON);; //enable the command prompt
   cmd.printCommandPrompt();
 }
 
@@ -77,9 +73,7 @@ void loop() {
         serverClient = server.available();
         if (!serverClient) Serial.println("available broken");
         Serial.print("New client: ");
-        Serial.print(i); Serial.print(' ');
         Serial.println(serverClient.remoteIP());
-        break;
       }
     }
     //check clients for data

examples/ESP32/wifiHTMLServer/Commander.ino

@@ -0,0 +1,183 @@
+//connect to VM4789902 vrtqvfDxr8hq
+//connect to AndroidAP hvpm2495
+
+//bool query(serialBuffer_t &sBuff);
+//bool help(serialBuffer_t &sBuff);
+
+const commandList_t Commands[] = {
+  {"set help",     setHelpState,    "help sys on or off"},
+  {"set internal",     setIntCmdState,    "internal cmds on or off"},
+  {"show internal",     hideIntCmd,    "internal cmds print on or off"},
+  {"enable server",     startEnableServer,    "enable web server"},
+  {"disable server",    disableServer,        "disable web server"},
+  {"set SSID",          setSSID,              "set WiFI SSID"}, //setSSID0=
+  {"set Pass",          setPassword,          "set WiFi password"}, //setWiFiPass0=
+  {"connect to",        wifiConnectTo,        "connect to WiFI (SSID) (Password)"},
+  {"set WiFi Timeout",  setWiFiTimeout,       "set WiFi connect timeout"}, //setWiFiPass0=
+  {"hello",             helloHandler,         "say hello"}, //setWiFiPass0=
+  {"webhelp",           callHelp,             "call help www style"}, //setWiFiPass0=
+  {"test",              callTest,             "Show the test page"}, //setWiFiPass0=
+  {"homework",          callHomework,         "Show homework page"}, //setWiFiPass0=
+  {"robots.txt",        callRobots,           "Robots page"}, //setWiFiPass0=
+  {"?",                 query,                "query"}, //setWiFiPass0=
+};
+const uint16_t numOfCmds = sizeof(Commands);// /  sizeof(ESPCommands[0]); //calculate the number of commands so we know the array bounds
+
+
+
+const commandList_t WiFiCommands[] = {
+  {"hello",       helloHandler,       "say hello"}, //setWiFiPass0=
+  {"help",        callHelp,           "call help"}, //setWiFiPass0=
+  {"test",        callTest,           "Show the test page"}, //setWiFiPass0=
+  {"homework",    callHomework,       "Show homework page"}, //setWiFiPass0=
+  {"robots.txt",  callRobots,         "Robots page"}, //setWiFiPass0=
+  {"?",           query,              "query"}, //setWiFiPass0=
+};
+const uint16_t numOfWiFICmds = sizeof(WiFiCommands);// /  sizeof(ESPCommands[0]); //calculate the number of commands so we know the array bounds
+
+
+//Serial port command handlers ======================================================================================================
+//Default handler - for error messages
+
+
+
+bool setHelpState(Commander &Cmdr){
+  if(Cmdr.containsOn()){
+    Cmdr.enableHelp();
+    Cmdr.println("Help Visible");
+  }else{
+    Cmdr.disableHelp();
+    
+    Cmdr.println("Help hidden");
+  }
+  return 0;
+}
+bool setIntCmdState(Commander &Cmdr){
+  if(Cmdr.containsOn()){
+    Cmdr.enableInternalCommands();
+    Cmdr.println("Int cmds ON");
+  }else{
+    Cmdr.disableInternalCommands();
+    
+    Cmdr.println("Int cmds OFF");
+  }
+  return 0;
+}
+
+bool hideIntCmd(Commander &Cmdr){
+  if(Cmdr.containsOn()){
+    Cmdr.enableInternalCommandPrint();
+    Cmdr.println("Int cmds visible");
+  }else{
+    Cmdr.disableInternalCommandPrint();
+    
+    Cmdr.println("Int cmds hidden");
+  }
+  return 0;
+}
+bool callRobots(Commander &Cmdr){
+  
+  Cmdr.print(robotsPage);
+  return 0;
+}
+
+
+bool defaultHandler(Commander &Cmdr){
+  Serial.println("Default Handler called");
+  Cmdr.print(cmdHeadErrorPage);
+  for(uint16_t n = 0; n < Cmdr.getCommandListLength(); n++){
+    Cmdr.println(Cmdr.getCommandItem(n));
+  }
+  Cmdr.print(cmdForm);
+  Cmdr.print(cmdFootPage);
+  return 0;
+}
+bool helloHandler(Commander &Cmdr){
+  
+  Cmdr.print(helloPage);
+  return 0;
+}
+bool callHomework(Commander &Cmdr){
+  
+  Cmdr.print(myHomework);
+  return 0;
+}
+bool callTest(Commander &Cmdr){
+  
+  Cmdr.print(testPage);
+  return 0;
+}
+bool callHelp(Commander &Cmdr){
+  
+  //cmdWiFi.setAutoFormat(false);
+  Cmdr.print(cmdHeadPage);
+  for(uint16_t n = 0; n < Cmdr.getCommandListLength(); n++){
+    Cmdr.println(Cmdr.getCommandItem(n));
+  }
+  //Cmdr.printCommandList();
+  Cmdr.print(cmdForm);
+  Cmdr.print(cmdFootPage);
+  //cmdWiFi.setAutoFormat(true);
+  return 0;
+}
+bool query(Commander &Cmdr){
+  Cmdr.startFormatting();
+  Cmdr.printCommanderVersion();
+  return 0;
+}
+bool setWiFiTimeout(Commander &Cmdr){
+  if( Cmdr.getInt(wifiConnectTimeout) ){
+    if(wifiConnectTimeout < 10) wifiConnectTimeout = 10;
+  }
+  return 0;
+}
+
+
+
+bool wifiConnectTo(Commander &Cmdr){
+  if(DEBUGGING) DEBUG.println("Trying to connect to ...");
+  Cmdr.getString(myssid);
+  Cmdr.getString(password);
+  if(DEBUGGING) {DEBUG.print("SSID=["); DEBUG.print(myssid); DEBUG.println(']');}
+  if(DEBUGGING) {DEBUG.print("PSWD=["); DEBUG.print(password); DEBUG.println(']');}
+  return 0;
+}
+
+bool wifiDisconnect(Commander &Cmdr){
+  WiFi.mode(WIFI_OFF);
+  Cmdr.println("WiFi Disconnected");
+}
+
+
+bool setSSID(Commander &Cmdr){
+  if(DEBUGGING) DEBUG.println("Setting SSID");
+  if(Cmdr.hasPayload()){
+    myssid = Cmdr.getPayloadString();
+  }
+  if(DEBUGGING){
+    DEBUG.print("Set SSID to: ");
+    DEBUG.println(myssid);
+  }
+  return 0;
+}
+
+bool setPassword(Commander &Cmdr){
+  if(DEBUGGING) DEBUG.println("Setting Password");
+  if(Cmdr.hasPayload()){
+    password = Cmdr.getPayloadString();
+  }
+  if(DEBUGGING){
+    Cmdr.print("Set Password to: ");
+    Cmdr.println(password);
+  }
+  return 0;
+}
+bool startEnableServer(Commander &Cmdr){
+  server.begin();
+  return 0;
+}
+
+bool disableServer(Commander &Cmdr){
+  server.end();
+  return 0;
+}

examples/ESP32/wifiHTMLServer/data/config.html

@@ -0,0 +1,16 @@
+<!DOCTYPE html><html><body>
+<form action="/action_page.php">
+<p>Enactive Torch RT Configuration page.</p>
+<form action="CONFIGURE">
+Device Name: <input type="text" name="DeviceName" value="ETRT2.0 The NEw One!"><br>
+Bluetooth Name: <input type="text" name="BTName" value="ETRT2:01"><br>
+Streaming Port: <input type="text" name="StreamingPort" value="80"><br>
+<input type="submit" value="Submit">
+</form>
+<p>Click the "Submit\ button and the form-data will be sent to the device with the heading "CONFIGURE".</p>
+<br>
+<form action="PARTYTIME">
+Party Name: <input type="text" name="PartyName" value="Hector"><br>
+Disguise: <input type="text" name="Disguise" value="Rabbit"><br>
+Value: <input type="text" name="Value" value="1000000"><br>
+</body></html>