Feature: component hosted

.gitmodules

@@ -194,7 +194,7 @@
 [submodule "Libraries.flatbuffers"]
 	path = Sming/Libraries/flatbuffers/src
 	url = https://github.com/google/flatbuffers.git
- 	ignore = dirty       
+ 	ignore = dirty
 [submodule "Libraries.GoogleCast"]
 	path = Sming/Libraries/GoogleCast
 	url = https://github.com/slaff/Sming-GoogleCast.git
@@ -259,6 +259,10 @@
 	path = Sming/Libraries/SignalGenerator
 	url = https://github.com/mikee47/SignalGenerator
 	ignore = dirty
+[submodule "Libraries.simpleRPC"]
+	path = Sming/Libraries/simpleRPC/simpleRPC
+	url = https://github.com/jfjlaros/simpleRPC.git
+	ignore = dirty
 [submodule "Libraries.SmingTest"]
 	path = Sming/Libraries/SmingTest
 	url = https://github.com/mikee47/SmingTest

Sming/Arch/Host/Components/hostlib/include/hostlib/hostlib.h

@@ -59,6 +59,9 @@ int msleep(unsigned ms);
  */
 size_t getHostAppDir(char* path, size_t bufSize);
 
+
+void host_main_loop();
+
 #ifdef __cplusplus
 }
 #endif

Sming/Arch/Host/Components/hostlib/startup.cpp

@@ -31,6 +31,7 @@
 #include <esp_tasks.h>
 #include <host_lwip.h>
 #include <stdlib.h>
+#include "include/hostlib/hostlib.h"
 #include "include/hostlib/CommandLine.h"
 #include <Storage.h>
 
@@ -39,11 +40,18 @@
 
 static int exitCode = 0;
 static bool done = false;
+static bool lwip_initialised = false;
+static OneShotElapseTimer<NanoTime::Milliseconds> lwipServiceTimer;
 
 extern void init();
 extern void host_wifi_lwip_init_complete();
 extern void host_init_bootloader();
 
+void  __attribute__((weak)) host_init()
+{
+	init();
+}
+
 static void cleanup()
 {
 	hw_timer_cleanup();
@@ -104,6 +112,17 @@ static void pause(int secs)
 	}
 }
 
+void host_main_loop()
+{
+	host_service_tasks();
+	host_service_timers();
+	if (lwip_initialised && lwipServiceTimer.expired()) {
+		host_lwip_service();
+		lwipServiceTimer.start();
+	}
+	system_soft_wdt_feed();
+}
+
 int main(int argc, char* argv[])
 {
 	trap_exceptions();
@@ -230,7 +249,7 @@ int main(int argc, char* argv[])
 		sockets_initialise();
 		CUartServer::startup(config.uart);
 
-		bool lwip_initialised = false;
+
 		if(config.enable_network) {
 			lwip_initialised = host_lwip_init(&config.lwip);
 			if(lwip_initialised) {
@@ -247,18 +266,11 @@ int main(int argc, char* argv[])
 
 		System.initialize();
 
-		init();
+		host_init();
 
-		OneShotElapseTimer<NanoTime::Milliseconds> lwipServiceTimer;
 		lwipServiceTimer.reset<LWIP_SERVICE_INTERVAL>();
 		while(!done) {
-			host_service_tasks();
-			host_service_timers();
-			if(lwip_initialised && lwipServiceTimer.expired()) {
-				host_lwip_service();
-				lwipServiceTimer.start();
-			}
-			system_soft_wdt_feed();
+			host_main_loop();
 		}
 
 		host_debug_i(">> Normal Exit <<\n");

Sming/Arch/Host/Components/sming-arch/component.mk

@@ -37,6 +37,11 @@ COMPONENT_DEPENDS := \
 	spi_flash \
 	vflash \
 	rboot
+
+
+ifneq ($(ENABLE_HOSTED),)
+	COMPONENT_DEPENDS += Hosted-Lib
+endif
 
 # => Platform WiFi
 COMPONENT_VARS := \

Sming/Arch/Host/Core/SPI.cpp

@@ -0,0 +1,14 @@
+#include "SPI.h"
+
+bool SPIClass::begin()
+{
+	return false;
+}
+
+void SPIClass::transfer(uint8_t* buffer, size_t numberBytes)
+{
+}
+
+void SPIClass::prepare(SPISettings& settings)
+{
+}

Sming/Arch/Host/Core/SPI.h

@@ -30,24 +30,18 @@
 class SPIClass : public SPIBase
 {
 public:
-	bool begin() override
-	{
-		return false;
-	}
+	bool begin() override;
 
 	void end() override
 	{
 	}
 
+	using SPIBase::beginTransaction;
 	using SPIBase::transfer;
-	void transfer(uint8_t* buffer, size_t numberBytes) override
-	{
-	}
+	void transfer(uint8_t* buffer, size_t numberBytes) override;
 
 protected:
-	void prepare(SPISettings& settings) override
-	{
-	}
+	void prepare(SPISettings& settings) override;
 };
 
 /** @brief  Global instance of SPI class */

Sming/Arch/Host/app.mk

@@ -12,6 +12,11 @@ LDFLAGS += \
 # Executable
 TARGET_OUT_0			:= $(FW_BASE)/$(APP_NAME)$(TOOL_EXT)
 
+# Hosted Settings
+ifneq ($(ENABLE_HOSTED),)
+	COMPONENTS_AR := $(USER_LIBDIR)/$(CLIB_PREFIX)Hosted-$(CMP_Hosted_LIBHASH).a $(USER_LIBDIR)/$(CLIB_PREFIX)Hosted-Lib-$(CMP_Hosted-Lib_LIBHASH).a $(COMPONENTS_AR)
+endif
+
 # Target definitions
 
 .PHONY: application

Sming/Components/Hosted-Lib/component.mk

@@ -0,0 +1,2 @@
+COMPONENT_SRCDIRS := $(COMPONENT_PATH)/src
+COMPONENT_DEPENDS := Hosted

Sming/Components/Hosted-Lib/src/Digital.cpp

@@ -0,0 +1,35 @@
+/****
+ * Sming Framework Project - Open Source framework for high efficiency native ESP8266 development.
+ * Created 2015 by Skurydin Alexey
+ * http://github.com/SmingHub/Sming
+ * All files of the Sming Core are provided under the LGPL v3 license.
+ *
+ * Digital.cpp
+ *
+ * @author 2021 Slavey Karadzhov <slav@attachix.com>
+ *
+ *
+ ****/
+
+#include <Digital.h>
+#include <Hosted/Client.h>
+
+extern Hosted::Client* hostedClient;
+
+void pinMode(uint16_t pin, uint8_t mode)
+{
+	hostedClient->send(__func__, pin, mode);
+}
+
+void digitalWrite(uint16_t pin, uint8_t val)
+{
+	hostedClient->send(__func__, pin, val);
+}
+
+uint8_t digitalRead(uint16_t pin)
+{
+	hostedClient->send(__func__, pin);
+	uint8_t response = hostedClient->wait<uint8_t>();
+
+	return response;
+}

Sming/Components/Hosted/README.rst

@@ -0,0 +1,52 @@
+HostEd
+======
+
+.. highlight:: bash
+
+The hosted component allows Sming's host emulator to run parts of the commands on an actual microcontroller.
+The communication is done via `simplePRC <https://simplerpc.readthedocs.io/>`_ and the microcontroller has to be flashed with a special application.
+
+Overview
+--------
+Sming's host emulator allows easier debugging and development of embedded applications. This component named "HostEd" extends the host emulator
+and facilitates testing functionality that only a real microcontroller can provide as for example digital I/O operations or SPI operations.
+
+For example in order to run the Basic_Blink application under the host emulator and run the actual blinking of a LED on a microcontroller
+we can compile the application using the following directives::
+
+   make SMING_ARCH=Host ENABLE_HOSTED=tcp HOSTED_SERVER_IP=192.168.4.1
+
+`SMING_ARCH=Host` instructs the build system to build the application for the Host architecture.
+`ENABLE_HOSTED=tcp` instructs the host emulator to communication with the real microcontroller using TCP
+`HOSTED_SERVER_IP=192.168.4.1` instructs the host emulator to connect to IP `192.168.4.1`.
+
+We need to compile and flash also a special application on the desired microcontroller.
+This application will act as an RPC Server and will execute the commands from the host emulator on the microcontroller.
+
+In the sub-directory ``samples`` inside this directory you will find the sample applications that will turn your microcontroller into
+RCP server.
+
+The compilation and flashing for ESP32, for example, can be done using the following commands::
+
+   cd samples/tcp
+   make SMING_ARCH=Esp32 WIFI_SSID=YourSSID WIFI_PWD=YourPassword
+   make flash
+
+If you replace ``SMING_ARCH=Esp32`` with ``SMING_ARCH=Esp8266`` then the hosted application will be compiled and flashed on a ESP8266 microcontroller.
+Make sure to replace the values of  WIFI_SSID and WIFI_PWD with the actual name and password for the Access Point (AP).
+
+Communication
+-------------
+At the moment the communication between an application running on the Host and the RCP server running on a microcontroller
+can be done using TCP or serial interface.
+The ``transport`` classes are located under ``include/Hosted/Transport``.
+
+Configuration
+-------------
+.. envvar:: ENABLE_HOSTED
+
+   Default: empty (disabled)
+
+   Enables the hosted component. Valid values for the moment are:
+   - tcp - for communication over TCP network.
+   - serial - for communication over serial interface

Sming/Components/Hosted/component.mk

@@ -0,0 +1,19 @@
+COMPONENT_SRCDIRS := $(COMPONENT_PATH)/src
+COMPONENT_INCDIRS := $(COMPONENT_SRCDIRS) $(COMPONENT_PATH)/include 
+COMPONENT_DEPENDS := simpleRPC
+
+# Architecture of the device where the hosted service will be flashed
+HOSTED_ARCH ?= Esp8266
+
+COMPONENT_VARS := ENABLE_HOSTED
+
+ENABLE_HOSTED ?=
+
+ifneq ($(ENABLE_HOSTED),)
+	COMPONENT_SRCDIRS += $(COMPONENT_PATH)/init/$(ENABLE_HOSTED) 
+endif
+
+COMPONENT_VARS += HOSTED_SERVER_IP
+
+COMPONENT_CFLAGS = -DHOSTED_SERVER_IP=$(HOSTED_SERVER_IP)
+COMPONENT_CXXFLAGS := $(COMPONENT_CFLAGS)