From 931a1791710bad47bcde8d60df5d23c5bf065e34 Mon Sep 17 00:00:00 2001 From: Lucio Rossi Date: Wed, 23 Jul 2025 11:29:09 +0200 Subject: [PATCH 01/12] feat: BridgeMonitor class stub --- examples/monitor/monitor.ino | 59 +++++++++++++++++++++++++++ src/Arduino_RouterBridge.h | 1 + src/bridge.h | 4 ++ src/monitor.h | 79 ++++++++++++++++++++++++++++++++++++ 4 files changed, 143 insertions(+) create mode 100644 examples/monitor/monitor.ino create mode 100644 src/monitor.h diff --git a/examples/monitor/monitor.ino b/examples/monitor/monitor.ino new file mode 100644 index 0000000..3638134 --- /dev/null +++ b/examples/monitor/monitor.ino @@ -0,0 +1,59 @@ +#include + + +bool set_led(bool state) { + digitalWrite(LED_BUILTIN, state); + return state; +} + +int add(int a, int b) { + return a + b; +} + +String greet() { + return String("Hello Friend"); +} + +void setup() { + Serial.begin(115200); + while (!Serial); + + if (!Bridge.begin()) { + Serial.println("cannot setup Bridge"); + } + + if(!Monitor.begin()){ + Serial.println("cannot setup Monitor"); + } + + pinMode(LED_BUILTIN, OUTPUT); + + if (!Bridge.provide("set_led", set_led)) { + Serial.println("Error providing method: set_led"); + } else { + Serial.println("Registered method: set_led"); + } + + Bridge.provide("add", add); + Bridge.provide("greet", greet); + +} + +void loop() { + + Bridge.notify("signal", 200); + + Monitor.write("DEBUG: a debug message"); + + // read needs to be fixed + // String incoming_msg; + // if (Monitor.read(incoming_msg, 64)) { + // Serial.println(incoming_msg); + // } else { + // Serial.println("ERROR on Monitor.read"); + // } + + Bridge.update(); + + delay(500); +} \ No newline at end of file diff --git a/src/Arduino_RouterBridge.h b/src/Arduino_RouterBridge.h index be9da6e..40f7e5b 100644 --- a/src/Arduino_RouterBridge.h +++ b/src/Arduino_RouterBridge.h @@ -3,5 +3,6 @@ #include "Arduino.h" #include "bridge.h" +#include "monitor.h" #endif //ARDUINO_ROUTER_BRIDGE_H diff --git a/src/bridge.h b/src/bridge.h index afc1d25..8c226e8 100644 --- a/src/bridge.h +++ b/src/bridge.h @@ -174,6 +174,10 @@ class BridgeClassUpdater { BridgeClass Bridge(Serial1); void updateEntryPoint(void *, void *, void *){ + + Serial1.begin(115200); + while (!Serial1); + while(1){ Bridge.update(); } diff --git a/src/monitor.h b/src/monitor.h new file mode 100644 index 0000000..42ca6ab --- /dev/null +++ b/src/monitor.h @@ -0,0 +1,79 @@ +#pragma once + +#ifndef BRIDGE_MONITOR_H +#define BRIDGE_MONITOR_H + +#include +#include "bridge.h" + +#define MON_CONNECTED_METHOD "mon/connected" +#define MON_RESET_METHOD "mon/reset" +#define MON_READ_METHOD "mon/read" +#define MON_WRITE_METHOD "mon/write" + +#define DEFAULT_MONITOR_BUF_SIZE 512 + +template +class BridgeMonitor: public Stream { + +private: + BridgeClass& bridge; + RingBufferN buffer; + bool is_connected = false; + +public: + BridgeMonitor(BridgeClass& bridge): bridge(bridge) {} + + bool begin() { + return bridge.call(MON_CONNECTED_METHOD, is_connected); + } + + bool isConnected() const { + return is_connected; + } + + int read() override { + return 0; + } + + int available() override { + return 0; + } + + int peek() override { + return 0; + } + + size_t write(uint8_t c) override { + return 0; + } + + bool reset() { + bool res; + bool ok = bridge.call(MON_RESET_METHOD, res); + if (ok && res) { + is_connected = false; + } + return (ok && res); + } + + size_t write(String message) { + size_t size; + bool ok = bridge.call(MON_WRITE_METHOD, size, message); + + if (!ok) return 0; + + return size; + } + + bool read(String& message, size_t size) { + return bridge.call(MON_READ_METHOD, message, size); + } + + +}; + +extern BridgeClass Bridge; +BridgeMonitor<> Monitor(Bridge); + +#endif // BRIDGE_MONITOR_H \ No newline at end of file From 36cc03ae4e4c0cbe9539c8a898b688c0bea066f0 Mon Sep 17 00:00:00 2001 From: Lucio Rossi Date: Wed, 23 Jul 2025 14:19:40 +0200 Subject: [PATCH 02/12] feat: monitor Stream methods impl TBT --- src/monitor.h | 65 ++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 59 insertions(+), 6 deletions(-) diff --git a/src/monitor.h b/src/monitor.h index 42ca6ab..7c8dc9f 100644 --- a/src/monitor.h +++ b/src/monitor.h @@ -18,7 +18,7 @@ class BridgeMonitor: public Stream { private: BridgeClass& bridge; - RingBufferN buffer; + RingBufferN temp_buffer; bool is_connected = false; public: @@ -33,18 +33,53 @@ class BridgeMonitor: public Stream { } int read() override { - return 0; + uint8_t c; + read(&c, 1); + return c; + } + + int read(uint8_t* buffer, size_t size) { + int i = 0; + while (temp_buffer.available() && i < size) { + buffer[i++] = temp_buffer.read_char(); + } + return i; } int available() override { - return 0; + int size = temp_buffer.availableForStore(); + if (size > 0) _read(size); + return temp_buffer.available(); } int peek() override { - return 0; + if (temp_buffer.available()) { + return temp_buffer.peek(); + } } size_t write(uint8_t c) override { + return write(&c, 1); + } + + size_t write(const uint8_t* buffer, size_t size) override { + + MsgPack::str_t send_buffer; + + for (size_t i = 0; i < size; ++i) { +#ifdef ARDUINO + send_buffer += (char)buffer[i]; +#else + send_buffer.push_back(static_cast(buffer[i])); +#endif + } + + size_t written; + bool ret = bridge.call(MON_WRITE_METHOD, written, send_buffer); + if (ret) { + return written; + } + return 0; } @@ -66,8 +101,26 @@ class BridgeMonitor: public Stream { return size; } - bool read(String& message, size_t size) { - return bridge.call(MON_READ_METHOD, message, size); + int _read(size_t size) { + + if (size == 0) return 0; + + MsgPack::str_t message; + bool ret = bridge.call(MON_READ_METHOD, message, size); + + if (ret) { + for (size_t i = 0; i < message.length(); ++i) { + temp_buffer.store_char(message[i]); + } + return message.length(); + } + + // if (bridge.lastError.code > NO_ERR) { + // is_connected = false; + // } + + return 0; + } From f2be0286e60307175f3ce52e7e33ee172c41e449 Mon Sep 17 00:00:00 2001 From: Lucio Rossi Date: Mon, 28 Jul 2025 16:54:24 +0200 Subject: [PATCH 03/12] mod: timeout MUXes + process mux --- src/bridge.h | 96 ++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 75 insertions(+), 21 deletions(-) diff --git a/src/bridge.h b/src/bridge.h index afc1d25..90d47b9 100644 --- a/src/bridge.h +++ b/src/bridge.h @@ -26,6 +26,7 @@ class BridgeClass { struct k_mutex read_mutex; struct k_mutex write_mutex; + struct k_mutex proc_mutex; k_tid_t upd_tid; k_thread_stack_t *upd_stack_area; @@ -44,6 +45,7 @@ class BridgeClass { k_mutex_init(&read_mutex); k_mutex_init(&write_mutex); + k_mutex_init(&proc_mutex); client = new RPCClient(*transport); server = new RPCServer(*transport); @@ -81,21 +83,41 @@ class BridgeClass { void update() { - k_msleep(1); // Lock read mutex - k_mutex_lock(&read_mutex, K_FOREVER); + if (k_mutex_lock(&read_mutex, K_MSEC(10)) != 0 ) return; + if (!server->get_rpc()) { k_mutex_unlock(&read_mutex); + k_msleep(1); return; } + k_mutex_unlock(&read_mutex); - server->process_request(); + while (true) { + if (k_mutex_lock(&proc_mutex, K_MSEC(10)) == 0){ + server->process_request(); + k_mutex_unlock(&proc_mutex); + k_msleep(1); + break; + } else { + k_msleep(1); + } + } // Lock write mutex - k_mutex_lock(&write_mutex, K_FOREVER); - server->send_response(); - k_mutex_unlock(&write_mutex); + while (true) { + + if (k_mutex_lock(&write_mutex, K_MSEC(10)) == 0){ + server->send_response(); + k_mutex_unlock(&write_mutex); + k_msleep(1); + break; + } else { + k_msleep(1); + } + + } } @@ -103,19 +125,31 @@ class BridgeClass { bool call(const MsgPack::str_t method, RType& result, Args&&... args) { // Lock write mutex - k_mutex_lock(&write_mutex, K_FOREVER); - client->send_rpc(method, std::forward(args)...); - k_mutex_unlock(&write_mutex); + while (true) { + if (k_mutex_lock(&write_mutex, K_MSEC(10)) == 0) { + client->send_rpc(method, std::forward(args)...); + k_mutex_unlock(&write_mutex); + k_msleep(1); + break; + } else { + k_msleep(1); + } + } // Lock read mutex - while(1) { - k_mutex_lock(&read_mutex, K_FOREVER); - if (client->get_response(result)) { + while(true) { + if (k_mutex_lock(&read_mutex, K_MSEC(10) == 0 )) { + if (client->get_response(result)) { + k_mutex_unlock(&read_mutex); + k_msleep(1); + break; + } k_mutex_unlock(&read_mutex); - break; + k_msleep(1); + } else { + k_msleep(1); } - k_mutex_unlock(&read_mutex); - k_msleep(1); + } return (client->lastError.code == NO_ERR); @@ -140,20 +174,40 @@ class BridgeClass { void update_safe() { // Lock read mutex - k_msleep(1); - k_mutex_lock(&read_mutex, K_FOREVER); + if (k_mutex_lock(&read_mutex, K_MSEC(10)) != 0 ) return; + if (!server->get_rpc()) { k_mutex_unlock(&read_mutex); + k_msleep(1); return; } + k_mutex_unlock(&read_mutex); - server->process_request("__safe__"); + while (true) { + if (k_mutex_lock(&proc_mutex, K_MSEC(10)) == 0){ + server->process_request("__safe__"); + k_mutex_unlock(&proc_mutex); + k_msleep(1); + break; + } else { + k_msleep(1); + } + } // Lock write mutex - k_mutex_lock(&write_mutex, K_FOREVER); - server->send_response(); - k_mutex_unlock(&write_mutex); + while (true) { + + if (k_mutex_lock(&write_mutex, K_MSEC(10)) == 0){ + server->send_response(); + k_mutex_unlock(&write_mutex); + k_msleep(1); + break; + } else { + k_msleep(1); + } + + } } From fa744bfaa6000a993b85dee8f844b07f04846394 Mon Sep 17 00:00:00 2001 From: Lucio Rossi Date: Mon, 28 Jul 2025 16:59:52 +0200 Subject: [PATCH 04/12] fix ... --- src/bridge.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/bridge.h b/src/bridge.h index 90d47b9..f7963f4 100644 --- a/src/bridge.h +++ b/src/bridge.h @@ -138,7 +138,7 @@ class BridgeClass { // Lock read mutex while(true) { - if (k_mutex_lock(&read_mutex, K_MSEC(10) == 0 )) { + if (k_mutex_lock(&read_mutex, K_MSEC(10)) == 0 ) { if (client->get_response(result)) { k_mutex_unlock(&read_mutex); k_msleep(1); From 5f0df16f865e9169a9f521a9e7ea9b4e745dbd8f Mon Sep 17 00:00:00 2001 From: Lucio Rossi Date: Mon, 28 Jul 2025 18:07:49 +0200 Subject: [PATCH 05/12] fix: bridge updates getting stuck: threads miss yielding --- library.json | 2 +- library.properties | 2 +- src/bridge.h | 2 ++ 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/library.json b/library.json index ce24b6d..f248494 100644 --- a/library.json +++ b/library.json @@ -11,7 +11,7 @@ "url": "https://github.com/bcmi-labs/Arduino_RouterBridge", "maintainer": true }, - "version": "0.1.0", + "version": "0.1.2", "license": "MIT", "frameworks": "arduino", "platforms": "*", diff --git a/library.properties b/library.properties index 9e0dfb5..1229434 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=Arduino_RouterBridge -version=0.1.0 +version=0.1.2 author=BCMI-labs maintainer=BCMI-labs sentence=A RPC bridge for Arduino UNO Q boards diff --git a/src/bridge.h b/src/bridge.h index f7963f4..fa03906 100644 --- a/src/bridge.h +++ b/src/bridge.h @@ -230,6 +230,7 @@ BridgeClass Bridge(Serial1); void updateEntryPoint(void *, void *, void *){ while(1){ Bridge.update(); + k_msleep(1); } } @@ -238,6 +239,7 @@ static void safeUpdate(){ } void __loopHook(){ + k_msleep(1); safeUpdate(); } From 4a63d27a1823bbf4b08b56ee2ed3379c817dff08 Mon Sep 17 00:00:00 2001 From: Lucio Rossi Date: Tue, 29 Jul 2025 11:40:10 +0200 Subject: [PATCH 06/12] feat: server_mux and client_mux --- src/bridge.h | 40 ++++++++++++++++++---------------------- 1 file changed, 18 insertions(+), 22 deletions(-) diff --git a/src/bridge.h b/src/bridge.h index fa03906..5bf57fe 100644 --- a/src/bridge.h +++ b/src/bridge.h @@ -26,7 +26,8 @@ class BridgeClass { struct k_mutex read_mutex; struct k_mutex write_mutex; - struct k_mutex proc_mutex; + struct k_mutex server_mutex; + struct k_mutex client_mutex; k_tid_t upd_tid; k_thread_stack_t *upd_stack_area; @@ -45,7 +46,8 @@ class BridgeClass { k_mutex_init(&read_mutex); k_mutex_init(&write_mutex); - k_mutex_init(&proc_mutex); + k_mutex_init(&server_mutex); + k_mutex_init(&client_mutex); client = new RPCClient(*transport); server = new RPCServer(*transport); @@ -83,6 +85,8 @@ class BridgeClass { void update() { + if (k_mutex_lock(&server_mutex, K_MSEC(10)) != 0) return; + // Lock read mutex if (k_mutex_lock(&read_mutex, K_MSEC(10)) != 0 ) return; @@ -94,16 +98,7 @@ class BridgeClass { k_mutex_unlock(&read_mutex); - while (true) { - if (k_mutex_lock(&proc_mutex, K_MSEC(10)) == 0){ - server->process_request(); - k_mutex_unlock(&proc_mutex); - k_msleep(1); - break; - } else { - k_msleep(1); - } - } + server->process_request(); // Lock write mutex while (true) { @@ -119,11 +114,15 @@ class BridgeClass { } + k_mutex_unlock(&server_mutex); + } template bool call(const MsgPack::str_t method, RType& result, Args&&... args) { + k_mutex_lock(&client_mutex, K_FOREVER); + // Lock write mutex while (true) { if (k_mutex_lock(&write_mutex, K_MSEC(10)) == 0) { @@ -154,6 +153,8 @@ class BridgeClass { return (client->lastError.code == NO_ERR); + k_mutex_unlock(&client_mutex); + } template @@ -173,6 +174,8 @@ class BridgeClass { void update_safe() { + if (k_mutex_lock(&server_mutex, K_MSEC(10)) != 0) return; + // Lock read mutex if (k_mutex_lock(&read_mutex, K_MSEC(10)) != 0 ) return; @@ -184,16 +187,7 @@ class BridgeClass { k_mutex_unlock(&read_mutex); - while (true) { - if (k_mutex_lock(&proc_mutex, K_MSEC(10)) == 0){ - server->process_request("__safe__"); - k_mutex_unlock(&proc_mutex); - k_msleep(1); - break; - } else { - k_msleep(1); - } - } + server->process_request("__safe__"); // Lock write mutex while (true) { @@ -209,6 +203,8 @@ class BridgeClass { } + k_mutex_unlock(&server_mutex); + } friend class BridgeClassUpdater; From 9e5d4a31f133fc37027a3c159e6396cdaa6f5c0e Mon Sep 17 00:00:00 2001 From: Lucio Rossi Date: Tue, 29 Jul 2025 15:37:19 +0200 Subject: [PATCH 07/12] examp: monitor.ino with user input TBT --- examples/monitor/monitor.ino | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/examples/monitor/monitor.ino b/examples/monitor/monitor.ino index 3638134..f645337 100644 --- a/examples/monitor/monitor.ino +++ b/examples/monitor/monitor.ino @@ -43,15 +43,13 @@ void loop() { Bridge.notify("signal", 200); - Monitor.write("DEBUG: a debug message"); - - // read needs to be fixed - // String incoming_msg; - // if (Monitor.read(incoming_msg, 64)) { - // Serial.println(incoming_msg); - // } else { - // Serial.println("ERROR on Monitor.read"); - // } + Monitor.println("DEBUG: a debug message"); + + if (Monitor.available()) { + String input = Monitor.readStringUntil('\n'); // Read until newline + Monitor.print("You entered: "); + Monitor.println(input); + } Bridge.update(); From 9f48f56970cacaae2de4b7d74e451d35685db707 Mon Sep 17 00:00:00 2001 From: Giovanni Bruno Date: Tue, 29 Jul 2025 16:14:18 +0200 Subject: [PATCH 08/12] fix: serial1 is already begun --- src/bridge.h | 4 ---- 1 file changed, 4 deletions(-) diff --git a/src/bridge.h b/src/bridge.h index c2964f8..5bf57fe 100644 --- a/src/bridge.h +++ b/src/bridge.h @@ -224,10 +224,6 @@ class BridgeClassUpdater { BridgeClass Bridge(Serial1); void updateEntryPoint(void *, void *, void *){ - - Serial1.begin(115200); - while (!Serial1); - while(1){ Bridge.update(); k_msleep(1); From a4ddc3decd02e9e3ae5916dcd93ad45c44fbfaf9 Mon Sep 17 00:00:00 2001 From: Lucio Rossi Date: Wed, 30 Jul 2025 12:30:42 +0200 Subject: [PATCH 09/12] fix: Monitor read must expect bytes not string. impr: Monitor internal buffer thread protected --- src/monitor.h | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/src/monitor.h b/src/monitor.h index 7c8dc9f..2060f9f 100644 --- a/src/monitor.h +++ b/src/monitor.h @@ -19,6 +19,7 @@ class BridgeMonitor: public Stream { private: BridgeClass& bridge; RingBufferN temp_buffer; + struct k_mutex monitor_mutex; bool is_connected = false; public: @@ -26,6 +27,7 @@ class BridgeMonitor: public Stream { bool begin() { return bridge.call(MON_CONNECTED_METHOD, is_connected); + k_mutex_init(&monitor_mutex); } bool isConnected() const { @@ -39,23 +41,30 @@ class BridgeMonitor: public Stream { } int read(uint8_t* buffer, size_t size) { + k_mutex_lock(&monitor_mutex, K_FOREVER); int i = 0; while (temp_buffer.available() && i < size) { buffer[i++] = temp_buffer.read_char(); } + k_mutex_unlock(&monitor_mutex); return i; } int available() override { + k_mutex_lock(&monitor_mutex, K_FOREVER); int size = temp_buffer.availableForStore(); if (size > 0) _read(size); - return temp_buffer.available(); + int available = temp_buffer.available(); + k_mutex_unlock(&monitor_mutex); + return available; } int peek() override { + k_mutex_lock(&monitor_mutex, K_FOREVER); if (temp_buffer.available()) { return temp_buffer.peek(); } + k_mutex_unlock(&monitor_mutex); } size_t write(uint8_t c) override { @@ -105,20 +114,21 @@ class BridgeMonitor: public Stream { if (size == 0) return 0; - MsgPack::str_t message; + MsgPack::arr_t message; bool ret = bridge.call(MON_READ_METHOD, message, size); + k_mutex_lock(&monitor_mutex, K_FOREVER); if (ret) { - for (size_t i = 0; i < message.length(); ++i) { - temp_buffer.store_char(message[i]); + for (size_t i = 0; i < message.size(); ++i) { + temp_buffer.store_char(static_cast(message[i])); } - return message.length(); + return message.size(); } // if (bridge.lastError.code > NO_ERR) { // is_connected = false; // } - + k_mutex_unlock(&monitor_mutex); return 0; } From aab4a2d29816cfd125243a59d1e82b61ce7890d0 Mon Sep 17 00:00:00 2001 From: Lucio Rossi Date: Wed, 30 Jul 2025 15:43:46 +0200 Subject: [PATCH 10/12] mod: concurrent bridge calls --- src/bridge.h | 41 ++++++++++++++++++++++------------------- 1 file changed, 22 insertions(+), 19 deletions(-) diff --git a/src/bridge.h b/src/bridge.h index 5bf57fe..9f15408 100644 --- a/src/bridge.h +++ b/src/bridge.h @@ -26,8 +26,8 @@ class BridgeClass { struct k_mutex read_mutex; struct k_mutex write_mutex; - struct k_mutex server_mutex; - struct k_mutex client_mutex; + //struct k_mutex server_mutex; + //struct k_mutex client_mutex; k_tid_t upd_tid; k_thread_stack_t *upd_stack_area; @@ -46,8 +46,8 @@ class BridgeClass { k_mutex_init(&read_mutex); k_mutex_init(&write_mutex); - k_mutex_init(&server_mutex); - k_mutex_init(&client_mutex); + //k_mutex_init(&server_mutex); + //k_mutex_init(&client_mutex); client = new RPCClient(*transport); server = new RPCServer(*transport); @@ -85,12 +85,13 @@ class BridgeClass { void update() { - if (k_mutex_lock(&server_mutex, K_MSEC(10)) != 0) return; + //if (k_mutex_lock(&server_mutex, K_MSEC(10)) != 0) return; // Lock read mutex if (k_mutex_lock(&read_mutex, K_MSEC(10)) != 0 ) return; - if (!server->get_rpc()) { + RPCRequest<> req; + if (!server->get_rpc(req)) { k_mutex_unlock(&read_mutex); k_msleep(1); return; @@ -98,13 +99,13 @@ class BridgeClass { k_mutex_unlock(&read_mutex); - server->process_request(); + server->process_request(req); // Lock write mutex while (true) { if (k_mutex_lock(&write_mutex, K_MSEC(10)) == 0){ - server->send_response(); + server->send_response(req); k_mutex_unlock(&write_mutex); k_msleep(1); break; @@ -114,19 +115,20 @@ class BridgeClass { } - k_mutex_unlock(&server_mutex); + //k_mutex_unlock(&server_mutex); } template bool call(const MsgPack::str_t method, RType& result, Args&&... args) { - k_mutex_lock(&client_mutex, K_FOREVER); - + //k_mutex_lock(&client_mutex, K_FOREVER); + uint32_t msg_id_wait; + // Lock write mutex while (true) { if (k_mutex_lock(&write_mutex, K_MSEC(10)) == 0) { - client->send_rpc(method, std::forward(args)...); + client->send_rpc(method, msg_id_wait, std::forward(args)...); k_mutex_unlock(&write_mutex); k_msleep(1); break; @@ -138,7 +140,7 @@ class BridgeClass { // Lock read mutex while(true) { if (k_mutex_lock(&read_mutex, K_MSEC(10)) == 0 ) { - if (client->get_response(result)) { + if (client->get_response(msg_id_wait, result)) { k_mutex_unlock(&read_mutex); k_msleep(1); break; @@ -153,7 +155,7 @@ class BridgeClass { return (client->lastError.code == NO_ERR); - k_mutex_unlock(&client_mutex); + //k_mutex_unlock(&client_mutex); } @@ -174,12 +176,13 @@ class BridgeClass { void update_safe() { - if (k_mutex_lock(&server_mutex, K_MSEC(10)) != 0) return; + //if (k_mutex_lock(&server_mutex, K_MSEC(10)) != 0) return; // Lock read mutex if (k_mutex_lock(&read_mutex, K_MSEC(10)) != 0 ) return; - if (!server->get_rpc()) { + RPCRequest<> req; + if (!server->get_rpc(req, "__safe__")) { k_mutex_unlock(&read_mutex); k_msleep(1); return; @@ -187,13 +190,13 @@ class BridgeClass { k_mutex_unlock(&read_mutex); - server->process_request("__safe__"); + server->process_request(req); // Lock write mutex while (true) { if (k_mutex_lock(&write_mutex, K_MSEC(10)) == 0){ - server->send_response(); + server->send_response(req); k_mutex_unlock(&write_mutex); k_msleep(1); break; @@ -203,7 +206,7 @@ class BridgeClass { } - k_mutex_unlock(&server_mutex); + //k_mutex_unlock(&server_mutex); } From c5b63476f48704458284fe9891285769dd33cf48 Mon Sep 17 00:00:00 2001 From: Lucio Rossi Date: Wed, 30 Jul 2025 16:02:54 +0200 Subject: [PATCH 11/12] rem: commented muxes --- src/bridge.h | 17 +---------------- 1 file changed, 1 insertion(+), 16 deletions(-) diff --git a/src/bridge.h b/src/bridge.h index 9f15408..d8d1e23 100644 --- a/src/bridge.h +++ b/src/bridge.h @@ -26,8 +26,6 @@ class BridgeClass { struct k_mutex read_mutex; struct k_mutex write_mutex; - //struct k_mutex server_mutex; - //struct k_mutex client_mutex; k_tid_t upd_tid; k_thread_stack_t *upd_stack_area; @@ -46,8 +44,6 @@ class BridgeClass { k_mutex_init(&read_mutex); k_mutex_init(&write_mutex); - //k_mutex_init(&server_mutex); - //k_mutex_init(&client_mutex); client = new RPCClient(*transport); server = new RPCServer(*transport); @@ -85,8 +81,6 @@ class BridgeClass { void update() { - //if (k_mutex_lock(&server_mutex, K_MSEC(10)) != 0) return; - // Lock read mutex if (k_mutex_lock(&read_mutex, K_MSEC(10)) != 0 ) return; @@ -115,16 +109,13 @@ class BridgeClass { } - //k_mutex_unlock(&server_mutex); - } template bool call(const MsgPack::str_t method, RType& result, Args&&... args) { - //k_mutex_lock(&client_mutex, K_FOREVER); uint32_t msg_id_wait; - + // Lock write mutex while (true) { if (k_mutex_lock(&write_mutex, K_MSEC(10)) == 0) { @@ -155,8 +146,6 @@ class BridgeClass { return (client->lastError.code == NO_ERR); - //k_mutex_unlock(&client_mutex); - } template @@ -176,8 +165,6 @@ class BridgeClass { void update_safe() { - //if (k_mutex_lock(&server_mutex, K_MSEC(10)) != 0) return; - // Lock read mutex if (k_mutex_lock(&read_mutex, K_MSEC(10)) != 0 ) return; @@ -205,8 +192,6 @@ class BridgeClass { } } - - //k_mutex_unlock(&server_mutex); } From f57682ecef4722493d09579e7d611d4f9f86f2fa Mon Sep 17 00:00:00 2001 From: Giovanni Bruno Date: Wed, 30 Jul 2025 17:47:28 +0200 Subject: [PATCH 12/12] mod: now license is MPL --- LICENSE | 394 +++++++++++++++++++++-- README.md | 8 +- examples/monitor/monitor.ino | 14 +- examples/simple_bridge/simple_bridge.ino | 14 +- library.json | 2 +- src/Arduino_RouterBridge.h | 11 + src/bridge.h | 11 + src/monitor.h | 11 + 8 files changed, 431 insertions(+), 34 deletions(-) diff --git a/LICENSE b/LICENSE index b77bf2a..fa0086a 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,373 @@ -MIT License - -Copyright (c) 2025 - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. \ No newline at end of file diff --git a/README.md b/README.md index 64792b7..8eed4d7 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,5 @@ In this repo it will be implemented an Arduino library wrapper for RPClite to be run on Arduino UNO Q boards. -The desired API is shown in https://github.com/bcmi-labs/Arduino_RouterBridge/blob/main/desired.ino. - -This is WIP. Expects changes soon. - ## The Bridge object ## Including Arduino_RouterBridge.h gives the user access to a Bridge object that can be used both as a RPC client and/or server to execute and serve RPCs to/from the CPU Host running a GOLANG router. @@ -16,6 +12,8 @@ Including Arduino_RouterBridge.h gives the user access to a Bridge object that c ```cpp +#include + bool set_led(bool state) { digitalWrite(LED_BUILTIN, state); return state; @@ -50,7 +48,5 @@ void loop() { }; Bridge.notify("signal", 200); - - //Bridge.update(); // Thread-unsafe update execution is granted in its own thread. It can be called manually with caution } ``` diff --git a/examples/monitor/monitor.ino b/examples/monitor/monitor.ino index f645337..87bb7e8 100644 --- a/examples/monitor/monitor.ino +++ b/examples/monitor/monitor.ino @@ -1,3 +1,14 @@ +/* + This file is part of the Arduino_RouterBridge library. + + Copyright (c) 2025 Arduino SA + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +*/ + #include @@ -16,7 +27,6 @@ String greet() { void setup() { Serial.begin(115200); - while (!Serial); if (!Bridge.begin()) { Serial.println("cannot setup Bridge"); @@ -51,7 +61,5 @@ void loop() { Monitor.println(input); } - Bridge.update(); - delay(500); } \ No newline at end of file diff --git a/examples/simple_bridge/simple_bridge.ino b/examples/simple_bridge/simple_bridge.ino index 24ea246..6f4815e 100644 --- a/examples/simple_bridge/simple_bridge.ino +++ b/examples/simple_bridge/simple_bridge.ino @@ -1,6 +1,16 @@ +/* + This file is part of the Arduino_RouterBridge library. + + Copyright (c) 2025 Arduino SA + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +*/ + #include -//BridgeClass Bridge(Serial1); bool set_led(bool state) { digitalWrite(LED_BUILTIN, state); @@ -42,6 +52,4 @@ void loop() { }; Bridge.notify("signal", 200); - - //Bridge.update(); // Thread-unsafe update execution is granted in its own thread. It can be called manually with caution } diff --git a/library.json b/library.json index f248494..720052b 100644 --- a/library.json +++ b/library.json @@ -12,7 +12,7 @@ "maintainer": true }, "version": "0.1.2", - "license": "MIT", + "license": "MPL2.0", "frameworks": "arduino", "platforms": "*", "dependencies": diff --git a/src/Arduino_RouterBridge.h b/src/Arduino_RouterBridge.h index 40f7e5b..26f6b51 100644 --- a/src/Arduino_RouterBridge.h +++ b/src/Arduino_RouterBridge.h @@ -1,3 +1,14 @@ +/* + This file is part of the Arduino_RouterBridge library. + + Copyright (c) 2025 Arduino SA + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +*/ + #ifndef ARDUINO_ROUTER_BRIDGE_H #define ARDUINO_ROUTER_BRIDGE_H diff --git a/src/bridge.h b/src/bridge.h index d8d1e23..51482be 100644 --- a/src/bridge.h +++ b/src/bridge.h @@ -1,3 +1,14 @@ +/* + This file is part of the Arduino_RouterBridge library. + + Copyright (c) 2025 Arduino SA + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +*/ + #pragma once #ifndef ROUTER_BRIDGE_H diff --git a/src/monitor.h b/src/monitor.h index 2060f9f..e4513b5 100644 --- a/src/monitor.h +++ b/src/monitor.h @@ -1,3 +1,14 @@ +/* + This file is part of the Arduino_RouterBridge library. + + Copyright (c) 2025 Arduino SA + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +*/ + #pragma once #ifndef BRIDGE_MONITOR_H