Add output setting support to CLI

Author: DreamerDeLy

.circleci/config.yml

@@ -6,8 +6,7 @@ jobs:
     steps:
       - checkout
       - run: pio upgrade
-      - run: pio ci --board=esp32dev examples/CLI_Basic/ --lib src/
-      - run: pio ci --board=esp32dev examples/CLI_Continuous/ --lib src/
+      - run: pio ci --board=esp32dev examples/CLI/ --lib src/
       - run: pio ci --board=esp32dev examples/SerialLogging/ --lib src/
       - run: pio ci --board=esp32dev examples/UnitsConversion/ --lib src/
       - run: pio ci --board=esp32dev examples/Values/ --lib src/

…amples/CLI_Continuous/CLI_Continuous.ino examples/CLI/CLI.inoexamples/CLI_Continuous/CLI_Continuous.ino renamed to examples/CLI/CLI.ino examples/CLI_Continuous/CLI_Continuous.ino renamed to examples/CLI/CLI.ino

@@ -10,24 +10,25 @@ void setup()
 	// Setup Serial port
 	Serial.begin(115200);
 
-	// Add Serial as source for CLI
+	// Add Serial as source and output for CLI
 	cli.setSource(Serial);
+	cli.setOutput(Serial);
 
 	// Set function to call in case of error
 	cli.onError([](String error_message){ 
 		Serial.println("Error in CLI: " + error_message);
 	});
 
 	// Add commands
-	cli.addCommand({"help", "Show available commands", [](dream::CommandParams p){
-		Serial.println("Available commands: ");
+	cli.addCommand({"help", "Show available commands", [](dream::CommandParams p, Print &output){
+		output.println("Available commands: ");
 		for (auto c : cli.getCommands())
 		{
-			Serial.println(" - " + c.name + " " + c.info);
+			output.println(" - " + c.name + " " + c.info);
 		}
 	}});
 
-	cli.addCommand({"on", "[pin] Set HIGH signal on pin", [](dream::CommandParams p){
+	cli.addCommand({"on", "[pin] Set HIGH signal on pin", [](dream::CommandParams p, Print &output){
 		// Get pin from parameters 
 		int pin = p[0].toInt();
 
@@ -36,11 +37,19 @@ void setup()
 		digitalWrite(pin, HIGH);
 	}});
 
-	cli.addCommand({"off", "[pin] Set LOW signal on pin", [](dream::CommandParams p){
+	cli.addCommand({"off", "[pin] Set LOW signal on pin", [](dream::CommandParams p, Print &output){
 		int pin = p[0].toInt();
 		pinMode(pin, OUTPUT);
 		digitalWrite(pin, LOW);
 	}});
+
+	cli.addCommand({"read", "[pin] Read ADC on pin", [](dream::CommandParams p, Print &output){
+		int pin = p[0].toInt();
+		pinMode(pin, INPUT);
+		
+		// Print ADC value
+		output.println("ADC: " + String(analogRead(pin)) + " on pin " + String(pin));
+	}});
 }
 
 void loop()

examples/CLI_Basic/CLI_Basic.ino

@@ -24,7 +24,7 @@ namespace dream
 	typedef std::vector<String> CommandParams;
 
 	// Command function
-	typedef std::function<void(CommandParams)> CommandFunction;
+	typedef std::function<void(CommandParams params, Print& output)> CommandFunction;
 
 	class CommandLineInterface
 	{
@@ -44,6 +44,9 @@ namespace dream
 		// Source for continuous reading
 		Stream *_source = nullptr;
 
+		// Output for command result
+		Print *_output = nullptr;
+
 		// Function to call in case of error
 		std::function<void(String)> _errorHandler;
 
@@ -95,21 +98,61 @@ namespace dream
 			return result;
 		}
 
+		// Run command
+		void runCommand(String command, Print *output)
+		{
+			if (command.isEmpty()) 
+			{
+				_errorHandler("Command is empty");
+				return;
+			}
+
+			if (output == nullptr)
+			{
+				_errorHandler("Output not specified");
+				return;
+			}
+
+			// Trim string
+			command.trim();
+
+			// Parse command name and arguments
+			const String name = getFirstArgument(command, ' ');
+			const std::vector<String> params = splitString(command.substring(name.length()), ' ');
+
+			// Find command
+			for (const Command &c : _commands)
+			{
+				if (c.name == name)
+				{
+					// Run command
+					c.run(params, *output);
+
+					return;
+				}
+			}
+			
+			// Command wasn't found
+			_errorHandler("Command " + command + " not found");
+			return;
+		}
+
 		public: //--------------------------------------------------------------
 
-		// Init CLI in basic mode
-		// In this mode you have to manually cal `run(string)` method.
-		CommandLineInterface() { }
+		// Init CLI with default input and output
+		CommandLineInterface() : _source(&Serial), _output(&Serial) { }
 
-		// Init CLI with reading from source 
-		// In this mode you have to place `tick()` method call to your `loop()` 
-		// or you still can use `run(string)` method as well.
-		CommandLineInterface(Stream *s) : _source(s) { }
-		CommandLineInterface(Stream &s) : _source(&s) { }
+		// Init CLI with input and output specified
+		CommandLineInterface(Stream *source, Print *output) : _source(source), _output(output) { }
+		CommandLineInterface(Stream &source, Print &output) : _source(&source), _output(&output) { }
 
-		// Change mode to reading from source
+		// Change source
 		void setSource(Stream *s) { _source = s; }
 		void setSource(Stream &s) { _source = &s; }
+		
+		// Change source
+		void setOutput(Print *s) { _output = s; }
+		void setOutput(Print &s) { _output = &s; }
 
 		// Set function to call in case of error
 		// Error message will be set as String argument
@@ -144,30 +187,19 @@ namespace dream
 		// Run command from string
 		void run(String command)
 		{
-			if (command.isEmpty()) return;
-
-			// Trim string
-			command.trim();
-
-			// Parse command name and arguments
-			const String name = getFirstArgument(command, ' ');
-			const std::vector<String> params = splitString(command.substring(name.length()), ' ');
+			runCommand(command, _output);
+		}
 
-			// Find command
-			for (const Command &c : _commands)
-			{
-				if (c.name == name)
-				{
-					// Run command
-					c.run(params);
+		// Run command from string with separate output
+		void run(String command, Print &output)
+		{
+			runCommand(command, &output);
+		}
 
-					return;
-				}
-			}
-			
-			// Command wasn't found
-			_errorHandler("[CLI] Command " + command + " not found");
-			return;
+		// Run command from string with separate output
+		void run(String command, Print *output)
+		{
+			runCommand(command, output);
 		}
 	};
 }