diff --git a/LICENSE b/LICENSE index 08a9bea..fa0086a 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,373 @@ -MIT License - -Copyright (c) 2025 Lucio Rossi - -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/examples/decoder_tests/DummyTransport.h b/examples/decoder_tests/DummyTransport.h index 6d53b0f..de013a9 100644 --- a/examples/decoder_tests/DummyTransport.h +++ b/examples/decoder_tests/DummyTransport.h @@ -1,3 +1,14 @@ +/* + This file is part of the Arduino_RPClite 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 DUMMY_TRANSPORT_H #define DUMMY_TRANSPORT_H #include "transport.h" diff --git a/examples/decoder_tests/decoder_tester.h b/examples/decoder_tests/decoder_tester.h new file mode 100644 index 0000000..266064f --- /dev/null +++ b/examples/decoder_tests/decoder_tester.h @@ -0,0 +1,42 @@ +/* + This file is part of the Arduino_RPClite 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 RPCLITE_DECODER_TESTER_H +#define RPCLITE_DECODER_TESTER_H + +class DecoderTester { + + RpcDecoder<>& decoder; + +public: + + DecoderTester(RpcDecoder<>& _d): decoder(_d){} + + void crop_bytes(size_t size, size_t offset){ + decoder.consume(size, offset); + } + + void print_raw_buf(){ + + Serial.print("Decoder raw buffer content: "); + + for (size_t i = 0; i < decoder._bytes_stored; i++) { + + Serial.print(decoder._raw_buffer[i], HEX); + Serial.print(" "); + } + Serial.println(""); + } + +}; + +#endif // RPCLITE_DECODER_TESTER_H \ No newline at end of file diff --git a/examples/decoder_tests/decoder_tests.ino b/examples/decoder_tests/decoder_tests.ino index 223564b..b823bf9 100644 --- a/examples/decoder_tests/decoder_tests.ino +++ b/examples/decoder_tests/decoder_tests.ino @@ -1,5 +1,17 @@ +/* + This file is part of the Arduino_RPClite 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 #include "DummyTransport.h" +#include "decoder_tester.h" // Shorthand MsgPack::Packer packer; @@ -36,6 +48,35 @@ void runDecoderTest(const char* label) { Serial.println("-- Done --\n"); } +void runDecoderConsumeTest(const char* label, size_t second_packet_sz) { + Serial.println(label); + + print_buf(); + DummyTransport dummy_transport(packer.data(), packer.size()); + RpcDecoder<> decoder(dummy_transport); + + DecoderTester dt(decoder); + + while (!decoder.packet_incoming()) { + Serial.println("Packet not ready"); + decoder.decode(); + delay(50); + } + + size_t pack_size = decoder.get_packet_size(); + Serial.print("1st Packet size: "); + Serial.println(pack_size); + + Serial.print("Consuming 2nd packet of given size: "); + Serial.println(second_packet_sz); + + dt.crop_bytes(second_packet_sz, pack_size); + + dt.print_raw_buf(); + + Serial.println("-- Done --\n"); +} + void testNestedArrayRequest() { packer.clear(); MsgPack::arr_size_t outer_arr(3); @@ -120,6 +161,9 @@ void testMultipleRpcPackets() { packer.serialize(req_sz, 0, 2, "echo", par_sz, "Hello", true); runDecoderTest("== Test: Multiple RPCs in Buffer =="); + + runDecoderConsumeTest("== Test: Mid-buffer consume ==", 5); + } // Binary parameter (e.g., binary blob) @@ -170,6 +214,8 @@ void testCombinedComplexBuffer() { void setup() { Serial.begin(115200); + while(!Serial); + delay(1000); Serial.println("=== RPC Decoder Nested Tests ==="); diff --git a/examples/dispatcher_example/dispatcher_example.ino b/examples/dispatcher_example/dispatcher_example.ino index d441fbc..cc91968 100644 --- a/examples/dispatcher_example/dispatcher_example.ino +++ b/examples/dispatcher_example/dispatcher_example.ino @@ -1,3 +1,14 @@ +/* + This file is part of the Arduino_RPClite 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 int add(int x, int y) { diff --git a/examples/rpc_lite_client/rpc_lite_client.ino b/examples/rpc_lite_client/rpc_lite_client.ino index 1012165..42971de 100644 --- a/examples/rpc_lite_client/rpc_lite_client.ino +++ b/examples/rpc_lite_client/rpc_lite_client.ino @@ -1,3 +1,14 @@ +/* + This file is part of the Arduino_RPClite 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 SerialTransport transport(Serial1); diff --git a/examples/rpc_lite_server/rpc_lite_server.ino b/examples/rpc_lite_server/rpc_lite_server.ino index 657ee66..39c42ce 100644 --- a/examples/rpc_lite_server/rpc_lite_server.ino +++ b/examples/rpc_lite_server/rpc_lite_server.ino @@ -1,3 +1,14 @@ +/* + This file is part of the Arduino_RPClite 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 SerialTransport transport(Serial1); diff --git a/examples/wrapper_example/wrapper_example.ino b/examples/wrapper_example/wrapper_example.ino index 6ed4f26..eed5e68 100644 --- a/examples/wrapper_example/wrapper_example.ino +++ b/examples/wrapper_example/wrapper_example.ino @@ -1,3 +1,14 @@ +/* + This file is part of the Arduino_RPClite 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 int add(int x, int y) { @@ -55,9 +66,9 @@ void loop() { out_packer.clear(); blink_before(); - int out = wrapped_add(5, 3); + int out = (*wrapped_add)(5, 3); - bool unpack_ok = wrapped_add(unpacker, out_packer); + bool unpack_ok = (*wrapped_add)(unpacker, out_packer); Serial.print("simple call: "); Serial.println(out); @@ -82,7 +93,7 @@ void loop() { unpacker.feed(packer.data(), packer.size()); out_packer.clear(); - bool should_be_false = wrapped_divide(unpacker, out_packer); + bool should_be_false = (*wrapped_divide)(unpacker, out_packer); if (!should_be_false){ Serial.println("RPC error call divide by zero "); @@ -103,7 +114,7 @@ void loop() { unpacker.clear(); unpacker.feed(packer.data(), packer.size()); out_packer.clear(); - wrapped_hello(unpacker, out_packer); + (*wrapped_hello)(unpacker, out_packer); for (size_t i=0; i #ifdef ARDUINO_SAMD_ZERO diff --git a/extras/integration_test/TestRPCServer/TestRPCServer.ino b/extras/integration_test/TestRPCServer/TestRPCServer.ino index 8ba1342..c3c9ebc 100644 --- a/extras/integration_test/TestRPCServer/TestRPCServer.ino +++ b/extras/integration_test/TestRPCServer/TestRPCServer.ino @@ -1,3 +1,14 @@ +/* + This file is part of the Arduino_RPClite 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 #include "serial_ports.h" diff --git a/extras/integration_test/testsuite.go b/extras/integration_test/testsuite.go index d783640..8eff43e 100644 --- a/extras/integration_test/testsuite.go +++ b/extras/integration_test/testsuite.go @@ -1,3 +1,11 @@ +// This file is part of the Arduino_RPClite 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/. + package testsuite import ( diff --git a/extras/serial_client.py b/extras/serial_client.py index 8fe38d2..c0753be 100644 --- a/extras/serial_client.py +++ b/extras/serial_client.py @@ -1,3 +1,11 @@ +# This file is part of the Arduino_RPClite 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/. + import serial import time import msgpack diff --git a/extras/serial_server.py b/extras/serial_server.py index 453681b..8608155 100644 --- a/extras/serial_server.py +++ b/extras/serial_server.py @@ -1,3 +1,11 @@ +# This file is part of the Arduino_RPClite 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/. + import serial import msgpack import threading diff --git a/library.json b/library.json index d368dc4..168f631 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/library.properties b/library.properties index 4fdd443..df4bc5b 100644 --- a/library.properties +++ b/library.properties @@ -1,7 +1,7 @@ name=Arduino_RPClite version=0.1.2 -author=Lucio Rossi (eigen-value) -maintainer=Lucio Rossi (eigen-value) +author=Arduino, Lucio Rossi (eigen-value) +maintainer=Arduino, Lucio Rossi (eigen-value) sentence=A MessagePack RPC library for Arduino paragraph=allows to create a client/server architecture using MessagePack as the serialization format. It follows the MessagePack-RPC protocol specification. It is designed to be lightweight and easy to use, making it suitable for embedded systems and IoT applications. category=Communication diff --git a/src/Arduino_RPClite.h b/src/Arduino_RPClite.h index faf2eed..eb0cbf0 100644 --- a/src/Arduino_RPClite.h +++ b/src/Arduino_RPClite.h @@ -1,3 +1,14 @@ +/* + This file is part of the Arduino_RPClite 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_RPCLITE_H #define ARDUINO_RPCLITE_H diff --git a/src/SerialTransport.h b/src/SerialTransport.h index 982a655..861e0f1 100644 --- a/src/SerialTransport.h +++ b/src/SerialTransport.h @@ -1,3 +1,14 @@ +/* + This file is part of the Arduino_RPClite 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 SERIALTRANSPORT_H #define SERIALTRANSPORT_H #include "transport.h" diff --git a/src/client.h b/src/client.h index b22d81a..655f1d4 100644 --- a/src/client.h +++ b/src/client.h @@ -1,3 +1,14 @@ +/* + This file is part of the Arduino_RPClite 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 RPCLITE_CLIENT_H #define RPCLITE_CLIENT_H #include "error.h" @@ -7,7 +18,6 @@ class RPCClient { RpcDecoder<>* decoder = nullptr; - uint32_t _waiting_msg_id; public: RpcError lastError; @@ -29,14 +39,17 @@ class RPCClient { template bool call(const MsgPack::str_t method, RType& result, Args&&... args) { - if(!send_rpc(method, std::forward(args)...)) { + uint32_t msg_id_wait; + + if(!send_rpc(method, msg_id_wait, std::forward(args)...)) { lastError.code = GENERIC_ERR; lastError.traceback = "Failed to send RPC call"; return false; } // blocking call - while (!get_response(result)){ + while (!get_response(msg_id_wait, result)){ + //delay(1); } return (lastError.code == NO_ERR); @@ -44,21 +57,21 @@ class RPCClient { } template - bool send_rpc(const MsgPack::str_t method, Args&&... args) { + bool send_rpc(const MsgPack::str_t method, uint32_t& wait_id, Args&&... args) { uint32_t msg_id; if (decoder->send_call(CALL_MSG, method, msg_id, std::forward(args)...)) { - _waiting_msg_id = msg_id; + wait_id = msg_id; return true; } return false; } template - bool get_response(RType& result) { + bool get_response(const uint32_t wait_id, RType& result) { RpcError tmp_error; decoder->decode(); - if (decoder->get_response(_waiting_msg_id, result, tmp_error)) { + if (decoder->get_response(wait_id, result, tmp_error)) { lastError.code = tmp_error.code; lastError.traceback = tmp_error.traceback; return true; diff --git a/src/decoder.h b/src/decoder.h index 89f76f3..234adae 100644 --- a/src/decoder.h +++ b/src/decoder.h @@ -1,3 +1,14 @@ +/* + This file is part of the Arduino_RPClite 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 RPCLITE_DECODER_H #define RPCLITE_DECODER_H @@ -46,7 +57,7 @@ class RpcDecoder { } template - bool get_response(const int msg_id, RType& result, RpcError& error) { + bool get_response(const uint32_t msg_id, RType& result, RpcError& error) { if (!packet_incoming() || _packet_type!=RESP_MSG) return false; @@ -82,6 +93,56 @@ class RpcDecoder { return send(reinterpret_cast(packer.data()), packer.size()) == packer.size(); } + MsgPack::str_t fetch_rpc_method(){ + + if (!packet_incoming()){return "";} + + if (_packet_type != CALL_MSG && _packet_type != NOTIFY_MSG) { + return ""; // No RPC + } + + MsgPack::Unpacker unpacker; + + unpacker.clear(); + if (!unpacker.feed(_raw_buffer, _packet_size)) { // feed should not fail at this point + consume(_packet_size); + reset_packet(); + return ""; + }; + + int msg_type; + uint32_t msg_id; + MsgPack::str_t method; + MsgPack::arr_size_t req_size; + + if (!unpacker.deserialize(req_size, msg_type)) { + consume(_packet_size); + reset_packet(); + return ""; // Header not unpackable + } + + if (msg_type == CALL_MSG && req_size.size() == REQUEST_SIZE) { + if (!unpacker.deserialize(msg_id, method)) { + consume(_packet_size); + reset_packet(); + return ""; // Method not unpackable + } + } else if (msg_type == NOTIFY_MSG && req_size.size() == NOTIFY_SIZE) { + if (!unpacker.deserialize(method)) { + consume(_packet_size); + reset_packet(); + return ""; // Method not unpackable + } + } else { + consume(_packet_size); + reset_packet(); + return ""; // Invalid request size/type + } + + return method; + + } + size_t get_request(uint8_t* buffer, size_t buffer_size) { if (_packet_type != CALL_MSG && _packet_type != NOTIFY_MSG) { @@ -151,6 +212,8 @@ class RpcDecoder { inline size_t size() const {return _bytes_stored;} + friend class DecoderTester; + private: ITransport& _transport; uint8_t _raw_buffer[BufferSize]; @@ -197,22 +260,19 @@ class RpcDecoder { _packet_size = 0; } - size_t consume(size_t size) { - - if (size > _bytes_stored) return 0; - - const size_t remaining_bytes = _bytes_stored - size; - - // Shift remaining data forward (manual memmove for compatibility) - for (size_t i = 0; i < remaining_bytes; i++) { - _raw_buffer[i] = _raw_buffer[size + i]; - } - - _bytes_stored = remaining_bytes; - - return size; +size_t consume(size_t size, size_t offset = 0) { + // Boundary checks + if (offset + size > _bytes_stored || size == 0) return 0; + + size_t remaining_bytes = _bytes_stored - size; + for (size_t i=offset; i(f))); - WrapperT* instance = new WrapperT(wrap(std::forward(f))); - _entries[_count++] = {name, tag, instance}; + _entries[_count++] = {name, tag, wrap(std::forward(f))}; return true; } @@ -34,7 +43,7 @@ class RpcFunctionDispatcher { return false; } - bool hasTag(MsgPack::str_t name,MsgPack::str_t tag) const { + bool hasTag(MsgPack::str_t name, MsgPack::str_t tag) const { for (size_t i = 0; i < _count; ++i) { if (_entries[i].name == name && _entries[i].tag == tag) { return true; diff --git a/src/error.h b/src/error.h index ea8d4be..d3713c5 100644 --- a/src/error.h +++ b/src/error.h @@ -1,3 +1,14 @@ +/* + This file is part of the Arduino_RPClite 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 RPCLITE_ERROR_H #define RPCLITE_ERROR_H diff --git a/src/request.h b/src/request.h new file mode 100644 index 0000000..5460408 --- /dev/null +++ b/src/request.h @@ -0,0 +1,97 @@ +/* + This file is part of the Arduino_RPClite 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 RPCLITE_REQUEST_H +#define RPCLITE_REQUEST_H + +#define DEFAULT_RPC_BUFFER_SIZE 256 + + +#include "rpclite_utils.h" + +template +class RPCRequest { + +public: + uint8_t buffer[BufferSize]; + size_t size = 0; + int type = NO_MSG; + uint32_t msg_id = 0; + MsgPack::str_t method; + MsgPack::Packer packer; + MsgPack::Unpacker unpacker; + + // void print(){ + + // Serial.print("internal buffer "); + // for (size_t i=0; idecode(); - if (_rpc_size > 0) return true; // Already have a request - _rpc_size = decoder->get_request(_rpc_buffer, RPC_BUFFER_SIZE); - return _rpc_size > 0; - } + RPCRequest<> req; - void process_request(MsgPack::str_t tag="") { - if (_rpc_size == 0) return; + if (!get_rpc(req)) return; // Populate local request - MsgPack::Unpacker unpacker; + process_request(req); // Process local data - unpacker.clear(); - if (!unpacker.feed(_rpc_buffer, _rpc_size)) { - _rpc_size = 0; // Reset size on error - return; // Error in unpacking - } + send_response(req); // Send from local data - int msg_type; - uint32_t msg_id; - MsgPack::str_t method; - MsgPack::arr_size_t req_size; + } - if (!unpacker.deserialize(req_size, msg_type)) { - reset_rpc(); - return; // Header not unpackable - } + bool get_rpc(RPCRequest<>& req, MsgPack::str_t tag="") { + decoder->decode(); - if (msg_type == CALL_MSG && req_size.size() == REQUEST_SIZE) { - if (!unpacker.deserialize(msg_id, method)) { - reset_rpc(); - return; // Method not unpackable - } - } else if (msg_type == NOTIFY_MSG && req_size.size() == NOTIFY_SIZE) { - if (!unpacker.deserialize(method)) { - reset_rpc(); - return; // Method not unpackable - } - } else { - reset_rpc(); - return; // Invalid request size/type - } + MsgPack::str_t method = decoder->fetch_rpc_method(); + + if (method == "" || !hasTag(method, tag)) return false; + + req.size = decoder->get_request(req.buffer, req.get_buffer_size()); // todo overload get_request(RPCRequest& req) so all the request info is in req + return req.size > 0; + } - if (!hasTag(method, tag)) return; + void process_request(RPCRequest<>& req) { - _rpc_type = msg_type; + if (!req.unpack_request_headers()) { + req.reset(); + return; + } - MsgPack::arr_size_t resp_size(RESPONSE_SIZE); - res_packer.clear(); - if (msg_type == CALL_MSG) res_packer.serialize(resp_size, RESP_MSG, msg_id); + req.pack_response_headers(); - dispatcher.call(method, unpacker, res_packer); + dispatcher.call(req.method, req.unpacker, req.packer); } - bool send_response() { - if (_rpc_type == NO_MSG || res_packer.size() == 0) { + bool send_response(RPCRequest<>& req) { + + if (req.type == NO_MSG || req.packer.size() == 0) { return true; // No response to send } - if (_rpc_type == NOTIFY_MSG) { - reset_rpc(); - return true; - } + if (req.type == NOTIFY_MSG) return true; - bool send_res = decoder->send_response(res_packer); - reset_rpc(); - return send_res; + return decoder->send_response(req.packer); } private: RpcDecoder<>* decoder = nullptr; RpcFunctionDispatcher dispatcher; - uint8_t _rpc_buffer[RPC_BUFFER_SIZE]; - size_t _rpc_size = 0; - int _rpc_type = NO_MSG; - MsgPack::Packer res_packer; - void reset_rpc() { - _rpc_size = 0; - _rpc_type = NO_MSG; - } - }; #endif //RPCLITE_SERVER_H diff --git a/src/transport.h b/src/transport.h index e459da3..37e3f10 100644 --- a/src/transport.h +++ b/src/transport.h @@ -1,3 +1,14 @@ +/* + This file is part of the Arduino_RPClite 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 RPCLITE_TRANSPORT_H #define RPCLITE_TRANSPORT_H diff --git a/src/wrapper.h b/src/wrapper.h index 9cda668..fb9af84 100644 --- a/src/wrapper.h +++ b/src/wrapper.h @@ -1,3 +1,14 @@ +/* + This file is part of the Arduino_RPClite 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 RPCLITE_WRAPPER_H #define RPCLITE_WRAPPER_H @@ -10,16 +21,15 @@ using namespace RpcUtils::detail; #include #endif +class IFunctionWrapper { +public: + virtual ~IFunctionWrapper() {} + virtual bool operator()(MsgPack::Unpacker& unpacker, MsgPack::Packer& packer) = 0; +}; template class RpcFunctionWrapper; -class IFunctionWrapper { - public: - virtual ~IFunctionWrapper() {} - virtual bool operator()(MsgPack::Unpacker& unpacker, MsgPack::Packer& packer) = 0; - }; - template class RpcFunctionWrapper>: public IFunctionWrapper { public: @@ -100,11 +110,9 @@ class RpcFunctionWrapper>: public IFunctionWrapper { } }; - -template -auto wrap(F&& f) -> RpcFunctionWrapper::type>::function_type> { - using Signature = typename arx::function_traits::type>::function_type; - return RpcFunctionWrapper(std::forward(f)); +template::type>::function_type> +auto wrap(F&& f) -> RpcFunctionWrapper* { + return new RpcFunctionWrapper(std::forward(f)); }; #endif \ No newline at end of file