From 1044d41d46f213d256ea862d19ed08c3fb645659 Mon Sep 17 00:00:00 2001 From: gabryelreyes Date: Tue, 21 Nov 2023 11:05:54 +0100 Subject: [PATCH] Updated README and bumped version --- README.md | 21 +++++++++++++++++++-- library.json | 4 ++-- 2 files changed, 21 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4c0814b..b10b51d 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,11 @@ # Serial Multiplexer Protocol (SerialMuxProt) -The SerialMuxProt is being developed for the communication between the Zumo Robot and a client application. +Communication Protocol based on Streams. Uses Multiplexing to differentiate data channels. +It is originally being developed for the communication between the [RadonUlzer](https://github.com/BlueAndi/RadonUlzer) and the [DroidControlShip](https://github.com/BlueAndi/DroidControlShip) projects. ## Table of Contents +- [Installation](#installation) - [Network Architecture](#network-architecture) - [Frame](#frame) - [Control Channel](#control-channel-channel-0) @@ -16,6 +18,21 @@ The SerialMuxProt is being developed for the communication between the Zumo Robo --- +## Installation + +- Using PlatformIO CLI: + +```bash +pio pkg install --library "gabryelreyes/SerialMuxProt@^2.0.0" +``` + +- Adding library to `lib_deps` manually: + +```ini +lib_deps = + gabryelreyes/SerialMuxProt@^2.0.0 +``` + ## Network Architecture - Server-Client Architecture @@ -215,4 +232,4 @@ typedef void (*ChannelCallback)(const uint8_t* payload, const uint8_t payloadSiz The `SerialMuxChannels.h` file should be used to define the structures and channel information to be shared between two instances of the SerialMuxServer. This file defines the Channel Names, DLCs, and the data structures of the payloads. It is important to note that the structs must include the `packed` attribute in order to ensure the access to the data correctly. -A sample file can be found in [here](examples/SerialMuxChannels.h). \ No newline at end of file +A sample file can be found in [here](examples/SerialMuxChannels.h). diff --git a/library.json b/library.json index 4a700ff..bae4830 100644 --- a/library.json +++ b/library.json @@ -1,7 +1,7 @@ { "name": "SerialMuxProt", - "version": "1.0.0", - "description": "Communication Protocol based on Streams. Uses Multiplexing to differenciate data channels.", + "version": "2.0.0", + "description": "Communication Protocol based on Streams. Uses Multiplexing to differentiate data channels.", "keywords": "SerialMuxProt", "repository": { "type": "git",