Skip to content

Commit

Permalink
Updated README and bumped version
Browse files Browse the repository at this point in the history
  • Loading branch information
gabryelreyes committed Nov 21, 2023
1 parent 4e87162 commit 1044d41
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 4 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -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
Expand Down Expand Up @@ -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).
A sample file can be found in [here](examples/SerialMuxChannels.h).
4 changes: 2 additions & 2 deletions library.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down

0 comments on commit 1044d41

Please sign in to comment.