Refactor command processor (#2687)

Read the upgrade document https://sming.readthedocs.io/en/latest/upgrading/4.7-5.1.html in you are using Command Processing in your applications.

---------

Co-authored-by: Slavey Karadzhov <[email protected]>
Co-authored-by: Mike <[email protected]>
Co-authored-by: mikee47 <[email protected]>

Sming/Components/CommandProcessing/README.rst

@@ -0,0 +1,62 @@
+Command Processing
+==================
+
+.. highlight:: c++
+
+Introduction
+------------
+
+Command handler provides a common command line interface (CLI). Command line must be text. Commands should be separated with a single character.
+CLI can be used with: 
+
+- Serial
+- Network (Websockets, Telnet)
+
+and all communication protocols that are exchanging text data.
+
+Commands can be added to and removed from the command handler. Each command will trigger a defined Delegate.
+
+A welcome message may be shown when a user connects and end-of-line (EOL) character may be defined. An automatic "help" display is available.
+
+For more examples take a look at the
+:sample:`CommandLine`,
+:sample:`TelnetServer`
+and :sample:`HttpServer_WebSockets`
+samples.
+
+
+Using
+-----
+
+1. Add these lines to your application componenent.mk file::
+
+       COMPONENT_DEPENDS += CommandProcessing
+
+2. Add these lines to your application::
+
+      #include <CommandProcessing/Utils.h>
+
+3. Basic example::
+
+      #include <CommandProcessing/Utils.h>
+
+      CommandProcessing::Handler commandHandler;
+      
+      void processShutdownCommand(String commandLine, ReadWriteStream& commandOutput)
+      {
+      	// ...
+      }
+
+      void init()
+      {
+        commandHandler.registerSystemCommands();
+		commandHandler.registerCommand(CommandProcessing::Command("shutdown", "Shutdown Server Command", "Application", processShutdownCommand));
+      }
+
+API Documentation
+-----------------
+
+.. doxygengroup:: commandhandler
+   :content-only:
+   :members:
+

Sming/Components/CommandProcessing/component.mk

@@ -0,0 +1,10 @@
+COMPONENT_SRCDIRS := \
+	src \
+	$(call ListAllSubDirs,$(COMPONENT_PATH)/src) \
+
+COMPONENT_INCDIRS := $(COMPONENT_SRCDIRS)
+
+COMPONENT_DOXYGEN_INPUT := src
+
+COMPONENT_DOCFILES := \
+	docs/*

Sming/Components/CommandProcessing/samples/Arducam/app/ArduCamCommand.cpp

@@ -0,0 +1,226 @@
+
+#include <ArduCamCommand.h>
+#include <Libraries/ArduCAM/ArduCAM.h>
+#include <Libraries/ArduCAM/ov2640_regs.h>
+
+ArduCamCommand::ArduCamCommand(ArduCAM& CAM, CommandProcessing::Handler& commandHandler)
+	: myCAM(CAM), commandHandler(&commandHandler), imgSize(OV2640_320x240), imgType(JPEG)
+{
+	debug_d("ArduCamCommand Instantiating");
+}
+
+ArduCamCommand::~ArduCamCommand()
+{
+}
+
+void ArduCamCommand::initCommand()
+{
+	commandHandler->registerCommand(
+		CommandProcessing::Command("set", "ArduCAM config commands", "Application",
+								   CommandProcessing::Command::Callback(&ArduCamCommand::processSetCommands, this)));
+}
+
+void ArduCamCommand::showSettings(ReadWriteStream& commandOutput)
+{
+	// review settings
+	commandOutput << _F("ArduCam Settings:") << endl
+				  << _F("    img Type: [") << getImageType() << ']' << endl
+				  << _F("    img Size: [") << getImageSize() << ']' << endl;
+};
+
+void ArduCamCommand::processSetCommands(String commandLine, ReadWriteStream& commandOutput)
+{
+	Vector<String> commandToken;
+	int numToken = splitString(commandLine, ' ', commandToken);
+
+	if(numToken == 1) {
+		// review settings
+		showSettings(commandOutput);
+	}
+	// handle command ->   set
+	else if(commandToken[1] == "help") {
+		commandOutput << _F("set img 	[bmp|jpeg]") << endl;
+		commandOutput << _F("set size [160|176|320|352|640|800|1024|1280|1600]") << endl;
+	}
+
+	// handle command ->   set
+	else if(commandToken[1] == "img") {
+		if(numToken == 3) {
+			if(commandToken[2] == "bmp") {
+				// TODO: set image size and init cam
+				//				settings->setImageType(BMP);
+				setFormat(BMP);
+			} else if(commandToken[2] == "jpg") {
+				setFormat(JPEG);
+			} else {
+				commandOutput << _F("invalid image format [") << commandToken[2] << ']' << endl;
+			}
+		} else {
+			commandOutput << _F("Syntax: set img [bmp|jpeg]") << endl;
+		}
+		showSettings(commandOutput);
+	}
+
+	else if(commandToken[1] == "size") {
+		if(numToken == 3) {
+			if(commandToken[2] == "160") {
+				imgSize = OV2640_160x120;
+				myCAM.OV2640_set_JPEG_size(OV2640_160x120);
+				setFormat(JPEG);
+			} else if(commandToken[2] == "176") {
+				imgSize = OV2640_176x144;
+				myCAM.OV2640_set_JPEG_size(OV2640_176x144);
+				setFormat(JPEG);
+			} else if(commandToken[2] == "320") {
+				imgSize = OV2640_320x240;
+				myCAM.OV2640_set_JPEG_size(OV2640_320x240);
+			} else if(commandToken[2] == "352") {
+				imgSize = OV2640_352x288;
+				myCAM.OV2640_set_JPEG_size(OV2640_352x288);
+				setFormat(JPEG);
+			} else if(commandToken[2] == "640") {
+				imgSize = OV2640_640x480;
+				myCAM.OV2640_set_JPEG_size(OV2640_640x480);
+				setFormat(JPEG);
+			} else if(commandToken[2] == "800") {
+				imgSize = OV2640_800x600;
+				myCAM.OV2640_set_JPEG_size(OV2640_800x600);
+				setFormat(JPEG);
+			} else if(commandToken[2] == "1024") {
+				imgSize = OV2640_1024x768;
+				myCAM.OV2640_set_JPEG_size(OV2640_1024x768);
+				setFormat(JPEG);
+			} else if(commandToken[2] == "1280") {
+				imgSize = OV2640_1280x1024;
+				myCAM.OV2640_set_JPEG_size(OV2640_1280x1024);
+				setFormat(JPEG);
+			} else if(commandToken[2] == "1600") {
+				imgSize = OV2640_1600x1200;
+				myCAM.OV2640_set_JPEG_size(OV2640_1600x1200);
+				setFormat(JPEG);
+			} else {
+				commandOutput << _F("invalid size definition[") << commandToken[2] << ']' << endl;
+			}
+		} else {
+			commandOutput << _F("Syntax: set size [160|176|320|352|640|800|1024|1280|1600]") << endl;
+		}
+		showSettings(commandOutput);
+	}
+}
+
+void ArduCamCommand::setSize(const String& size)
+{
+	if(size == "160x120") {
+		imgSize = OV2640_160x120;
+		myCAM.OV2640_set_JPEG_size(OV2640_160x120);
+		setFormat(JPEG);
+	} else if(size == "176x144") {
+		imgSize = OV2640_176x144;
+		myCAM.OV2640_set_JPEG_size(OV2640_176x144);
+		setFormat(JPEG);
+	} else if(size == "320x240") {
+		imgSize = OV2640_320x240;
+		myCAM.OV2640_set_JPEG_size(OV2640_320x240);
+	} else if(size == "352x288") {
+		imgSize = OV2640_352x288;
+		myCAM.OV2640_set_JPEG_size(OV2640_352x288);
+		setFormat(JPEG);
+	} else if(size == "640x480") {
+		imgSize = OV2640_640x480;
+		myCAM.OV2640_set_JPEG_size(OV2640_640x480);
+		setFormat(JPEG);
+	} else if(size == "800x600") {
+		imgSize = OV2640_800x600;
+		myCAM.OV2640_set_JPEG_size(OV2640_800x600);
+		setFormat(JPEG);
+	} else if(size == "1024x768") {
+		imgSize = OV2640_1024x768;
+		myCAM.OV2640_set_JPEG_size(OV2640_1024x768);
+		setFormat(JPEG);
+	} else if(size == "1280x1024") {
+		imgSize = OV2640_1280x1024;
+		myCAM.OV2640_set_JPEG_size(OV2640_1280x1024);
+		setFormat(JPEG);
+	} else if(size == "1600x1200") {
+		imgSize = OV2640_1600x1200;
+		myCAM.OV2640_set_JPEG_size(OV2640_1600x1200);
+		setFormat(JPEG);
+	} else {
+		debugf("ERROR: invalid size definition[%s]\r\n", size.c_str());
+	}
+}
+
+void ArduCamCommand::setType(const String& type)
+{
+	setFormat(type == "BMP" ? BMP : JPEG);
+}
+
+void ArduCamCommand::setFormat(uint8 type)
+{
+	if(type == BMP) {
+		myCAM.set_format(BMP);
+		if(imgType != BMP) {
+			// reset the cam
+			myCAM.InitCAM();
+			imgType = BMP;
+			imgSize = OV2640_320x240;
+		}
+	} else {
+		myCAM.set_format(JPEG);
+		// reset the cam
+		if(imgType != JPEG) {
+			// reset the cam
+			myCAM.InitCAM();
+			myCAM.OV2640_set_JPEG_size(imgSize);
+			imgType = JPEG;
+		}
+	}
+}
+
+const char* ArduCamCommand::getImageType()
+{
+	switch(imgType) {
+	case JPEG:
+		return "JPEG";
+	case BMP:
+	default:
+		return "BMP";
+	}
+}
+
+const char* ArduCamCommand::getContentType()
+{
+	switch(imgType) {
+	case JPEG:
+		return "image/jpeg";
+	case BMP:
+	default:
+		return "image/x-ms-bmp";
+	}
+}
+
+const char* ArduCamCommand::getImageSize()
+{
+	switch(imgSize) {
+	case OV2640_1600x1200:
+		return "1600x1200";
+	case OV2640_1280x1024:
+		return "1280x1024";
+	case OV2640_1024x768:
+		return "1024x768";
+	case OV2640_800x600:
+		return "800x600";
+	case OV2640_640x480:
+		return "640x480";
+	case OV2640_352x288:
+		return "352x288";
+	case OV2640_320x240:
+		return "320x240";
+	case OV2640_176x144:
+		return "176x144";
+	case OV2640_160x120:
+		return "160x120";
+	default:
+		return "320x240";
+	}
+}