Feature: component hosted #2305

slaff · 2021-04-16T06:40:02Z

The hosted component allows Sming's host emulator to run parts of the commands on an actual microcontroller.
The communication is done via simplePRC 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.

In the sub-directory samples inside this component you will find the sample applications that will turn your microcontroller into
a remote 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).

TODO: - [ ] get id for a remote RPC function(class method) - [x] fix the documentation - [x] add to the tcp sample also an example of creating own access point and connecting to it. - [ ] fix copyright headers

TODO: - [x] move the parser to be part of the rcp component. - [x] add parser test case.

slaff · 2021-04-16T06:43:36Z

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)


@mikee47 Is it possible with the existing build system for a component to put its library at the front of the list of compiled libraries?

This is probably the only way. I'm guessing the reason for this is to get the linkage with weak functions working properly? Note that weak functions won't work at all in Windows! Function wrappers are more reliable - the malloc_count Component uses these a lot so a good reference.

Function wrappers are more reliable - the malloc_count Component uses these a lot so a good reference.

Ok, thanks for pointing this out. The host_init weak function is replaced with wrapper.

Sming/Components/Hosted/include/Hosted/Client.h

mikee47 · 2021-04-16T14:13:39Z

Sming/Arch/Host/Core/SPI.h

 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 */


You've added SPI.cpp but not made any changes to the code. Revert SPI.cpp and SPI.h.

I have split them into header and implementation to make it easier for the hosted component to replace the real implementation with its own implementation. I would prefer to leave it as it is and add the SPI hosted implementation in a separate PR if that is ok for you.

Sming/Components/Hosted/include/Hosted/Transport/TcpServerTransport.h

Sming/Components/Hosted/include/Hosted/Transport/BaseTransport.h

Sming/Components/Hosted/samples/tcp/app/application.cpp

mikee47 · 2021-04-16T19:15:09Z

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)


This is probably the only way. I'm guessing the reason for this is to get the linkage with weak functions working properly? Note that weak functions won't work at all in Windows! Function wrappers are more reliable - the malloc_count Component uses these a lot so a good reference.

…with Windows compilation.

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`. In the sub-directory ``samples`` inside this component you will find the sample applications that will turn your microcontroller into a remote 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).

slav-at-attachix and others added 18 commits April 9, 2021 17:24

Drafting ideas about app on host and some parts on the device.

304c805

further research ...

7334e0b

And we have a running minimal HostedServer using Tcp transport.

60a6960

Replaced nanopb code with submodule.

b0bd00a

Ready with the initial version of Hosted.

3fe8f77

Added initial documentation.

5aa9226

Initial work on SPI support.

27633cb

Feature/component hosted review (#68)

711ddc3

Removed Components/nanopb. Will be using Libraries/nanopb.

48abae7

Trying to compile the code with the latest develop version.

4093b3f

Initial code. Nothing to see yet.

9658b9e

Untested changes.

c17a553

Some progress ....

6ce358f

PoC is ready.

c4755f3

TODO: - [ ] get id for a remote RPC function(class method) - [x] fix the documentation - [x] add to the tcp sample also an example of creating own access point and connecting to it. - [ ] fix copyright headers

Initial version of the SimpleRPC stream parser for the headers.

49013b8

TODO: - [x] move the parser to be part of the rcp component. - [x] add parser test case.

Fixes.

9d56171

Added Hosted tests.

b9115e5

Headers and coding style.

a465ba1

slaff mentioned this pull request Apr 16, 2021

[WIP] Feature: component hosted #2093

Closed

slaff commented Apr 16, 2021

View reviewed changes

Sming/Components/Hosted/include/Hosted/Client.h Outdated Show resolved Hide resolved

slaff added this to the 4.3.1 milestone Apr 16, 2021

slaff added the 3 - Review label Apr 16, 2021

slaff requested a review from mikee47 April 16, 2021 06:46

slaff force-pushed the feature/rpc-with-simplerpc branch 6 times, most recently from e7d5de6 to 3ae47cd Compare April 16, 2021 07:33

slav-at-attachix added 2 commits April 16, 2021 09:46

Travis is up and clang-format has to be updated.

e0a2128

Run Hosted Tcp tests only if network is present.

b51536a

slaff force-pushed the feature/rpc-with-simplerpc branch from 3ae47cd to b51536a Compare April 16, 2021 07:47

slav-at-attachix added 3 commits April 16, 2021 14:30

Update Travis to use GCC 9.

d67b771

Final touches for the initial and not reviewed yet version.

be59a41

Applied recommendations from mikee.

cbb1f81

mikee47 reviewed Apr 16, 2021

View reviewed changes

slav-at-attachix added 5 commits April 18, 2021 13:10

Applying review recommendations.

583b640

Decrease lag when using TCP.

563f25a

Moving the main_loop function to a separate header. Should fix issue …

54882dc

…with Windows compilation.

Replace weak function with function wrapper.

24ec69e

Use only Esp8266 EQT for Travis builds.

369c483

slaff merged commit 07ecd3b into SmingHub:develop Apr 20, 2021

slaff changed the title ~~[WIP] Feature: component hosted~~ Feature: component hosted Apr 20, 2021

slaff removed the 3 - Review label Apr 20, 2021

slaff mentioned this pull request Apr 20, 2021

Preparation for Release 4.4.0 #2298

Closed

5 tasks

slaff deleted the feature/rpc-with-simplerpc branch July 9, 2021 09:03

jfjlaros mentioned this pull request Dec 22, 2021

Java client for Android jfjlaros/simpleRPC#26

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature: component hosted #2305

Feature: component hosted #2305

slaff commented Apr 16, 2021 •

edited

Loading

slaff Apr 16, 2021

mikee47 Apr 16, 2021

slaff Apr 19, 2021

mikee47 Apr 16, 2021

slaff Apr 19, 2021

mikee47 Apr 16, 2021

Feature: component hosted #2305

Feature: component hosted #2305

Conversation

slaff commented Apr 16, 2021 • edited Loading

Overview

slaff Apr 16, 2021

Choose a reason for hiding this comment

mikee47 Apr 16, 2021

Choose a reason for hiding this comment

slaff Apr 19, 2021

Choose a reason for hiding this comment

mikee47 Apr 16, 2021

Choose a reason for hiding this comment

slaff Apr 19, 2021

Choose a reason for hiding this comment

mikee47 Apr 16, 2021

Choose a reason for hiding this comment

slaff commented Apr 16, 2021 •

edited

Loading