Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions .github/workflows/arduino-lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Check Arduino

# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
on:
push:
pull_request:
schedule:
# Run every Tuesday at 8 AM UTC to catch breakage caused by new rules added to Arduino Lint.
- cron: "0 8 * * TUE"
workflow_dispatch:
repository_dispatch:

jobs:
lint:
runs-on: ubuntu-latest
permissions:
contents: read

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Arduino Lint
uses: arduino/arduino-lint-action@v2
with:
compliance: strict
library-manager: submit # remember to change to 'update' after the library is published on the libraries index
# Always use this setting for official repositories. Remove for 3rd party projects.
official: true
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,7 @@
# RPClite
RPC lib for embedded based on MsgPack
# Arduino_RPClite

A MessagePack RPC library for Arduino allows to create a client/server architecture using MessagePack as the serialization format. It follows the [MessagePack-RPC protocol specification](https://github.com/msgpack-rpc/msgpack-rpc/blob/master/spec.md). It is designed to be lightweight and easy to use, making it suitable for embedded systems and IoT applications.

### Credits

This library is based on the MsgPack library by @hideakitai.
2 changes: 1 addition & 1 deletion examples/rpc_lite_client/rpc_lite_client.ino
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#include <RPClite.h>
#include <Arduino_RPClite.h>

SerialTransport transport(&Serial2);
RPCClient client(transport);
Expand Down
2 changes: 1 addition & 1 deletion examples/rpc_lite_dummy/rpc_lite_dummy.ino
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#include <RPClite.h>
#include <Arduino_RPClite.h>

DummyTransport transport;
RPCServer server(transport);
Expand Down
2 changes: 1 addition & 1 deletion examples/rpc_lite_server/rpc_lite_server.ino
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#include <RPClite.h>
#include <Arduino_RPClite.h>
#include <HardwareSerial.h>

HardwareSerial* uart = new HardwareSerial(0);
Expand Down
2 changes: 1 addition & 1 deletion examples/wrapper_example/wrapper_example.ino
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#include <RPClite.h>
#include <Arduino_RPClite.h>

int add(int x, int y) {
return x + y;
Expand Down
6 changes: 3 additions & 3 deletions library.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"name": "RPClite",
"name": "Arduino_RPClite",
"keywords": "rpclib,msgpack,serial",
"description": "RPClite for Arduino (based on hideakitai MsgPack)",
"description": "A MessagePack RPC library for Arduino",
"repository": {
"type": "git",
"url": "https://github.com/bcmi-labs/RPClite"
"url": "https://github.com/bcmi-labs/Arduino_RPClite"
},
"authors": {
"name": "Lucio Rossi",
Expand Down
8 changes: 4 additions & 4 deletions library.properties
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
name=RPClite
name=Arduino_RPClite
version=0.0.1
author=Lucio Rossi (eigen-value)
maintainer=Lucio Rossi (eigen-value)
sentence=RPClite for Arduino (based on hideakitai MsgPack)
paragraph=RPClite for Arduino (based on hideakitai MsgPack)
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
url=https://github.com/bcmi-labs/RPClite
url=https://www.arduino.cc/
architectures=*
depends=ArxContainer (>=0.6.0), ArxTypeTraits, DebugLog (>=0.8.1)
6 changes: 3 additions & 3 deletions src/RPClite.h → src/Arduino_RPClite.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
// Created by lucio on 4/8/25.
//

#ifndef RPCLITE_H
#define RPCLITE_H
#ifndef ARDUINO_RPCLITE_H
#define ARDUINO_RPCLITE_H

#include "Arduino.h"

Expand All @@ -16,4 +16,4 @@
#include "DummyTransport.h"
#include "SerialTransport.h"

#endif //RPCLITE_H
#endif //ARDUINO_RPCLITE_H