Mesh Network Protocol for embedded devices

This is the radio mesh network protocol for almost every device, that can run rust code. The protocol uses serial port of your MCU in order to interact with radio module connected to it. The protocol allows to use any kind of radio module with USART interface, so you can use any radio module with any frequency you want.

The protocol is designed to utilize UART interface of your MCU and has been tested with cheap radio modules JDY-40. The protocol potentially can use radio modules with similar UART interface, the devices are:

• JDY-41
• SV-610
• HC-11
• HC-12
• LC12S
• GT-38
• LoRa modules

Goal

The goal of this project is to provide ability to build easy to use, mesh like, data transferring protocol using cheap, low memory, components. This protocol can be used for:

• Home automation
• Remote control
• Remote monitoring (telemetry)
• Decentralized messaging
• etc.

Status

The following functionalities of protocol have been tested and verified:

• Send data.
• Receive data.
• Send data with ignorance of duplicated packets.
• Send data with limited of number of hops.
• Broadcast data to all nodes.
• Message transition by the intermediate nodes.
• Send data with ping flag, and receive answer with pong flag set.
• Send data via Transaction and receive packet about transaction being finished.

Cross-platform compatibility

The mesh metwork was tested using few Arduino boards and one Linux machine.

For now the protocol was tested on:

• Arduino nano
• Linux (Raspberry PI, Desktop)

Potentially can be ported to:

• Windows
• Mac
• STM32
• ESP8266
• Raspberry PI pico

Porting to other platforms

While initially designed to be able to run at least on Atmega328p chips - it can be ported to many other platforms, which are supported by embedded-hal.

Also this protocol is welcomed to be ported on other platforms. In order to simplify process of porting of this protocol to the new platforms - the common behaviour is moved out of implementation to make it interchangable with implementations of PlatformMillis and PlatformSerial traits for each other platform.

These are two generic interfaces.

• The library uses PlatformSerial interface to communicate with radio module over USART.
• The library uses PlatformMillis interface to be able to keep track of time.

In case, if implementations are already present for platform, you need - you just simply include those and use them into your project.

Arduino nano port.

The implementation of PlatformSerial for Arduino nano board is done by:

• platform-serial-arduino-nano

The implementation of PlatformMillis for Arduino nano board is done by:

• platform-millis-arduino-nano

Usage examples can be found here:

• arduino-nano

Sometimes code binary might not fit onto your arduino board memory, in order to reduce the size of final binary - it is recommended to compile it with --release flag - it increases optimisation level tlat leads to smaller binary.

Linux port.

The implementation of PlatformSerial for Linux is done by:

• platform-serial-linux

The implementation of PlatformMillis for Linux is done by:

• platform-millis-linux

Usage examples can be found here:

• linux

Usage

Main Components

The central component of this protocol is the Node structure, which offers a user-friendly interface for actions like send, receive, broadcast, ping-pong, and send message with transaction. The Node should be constantly updated by call its update method, it - does all internal work:

• routes packets trough the network, transits packets that were sent to other devices
• handles special packets like ping and pong, or any kind of transaction one.
• saves received packets that wil lbe available trough receive method.

To initialize a Node, you need to provide two values:

• ExactAddressType: Represents the device's identification address in the node pool.
• listen_period: A value in milliseconds that determines how long the device will wait before transmitting on the network to prevent network congestion.

You can regulate the number of hops that the packet will be able to make - by configuring the lifetime during making the send of the message. For example:

• setting lifetime to 1 will limit the message's reach to the nearest devices in the network.
• setting lifetime to 10 will make the packet able to pass 10 nodes before being destroyed.

To send the message to all nodes in the network, you can send it with standard send method, and put GeneralAddressType::BROADCAST as the destination_device_identifier. Every device will treat GeneralAddressType::BROADCAST as it's own address, will keep the message as received and will transit copy of that message further.

The term "echoed message" refers to a duplicated message that has been re-transmitted into the ether by an intermediate device.

Receive Method

The receive method optionally returns received data in a PacketDataBytes instance in case if that packet was previously delivered by the network to this exact device.

Send Method

The send method requires the following arguments:

• data: A PacketDataBytes instance to hold the message bytes.
• destination_device_identifier: A GeneralAddressType instance indicating exact target device while using GeneralAddressType::Exact(...) or indicating all devices to receive the message by using GeneralAddressType::BROADCAST.
• lifetime: A LifeTimeType instance to control for how far the message can travel.
• filter_out_duplication: A boolean flag to filter out echoed messages from the network.

Send Ping-Pong Method

The send_ping_pong method sends a message with a "ping" flag to the destination node and waits for the same message with a "pong" flag. It returns an error if the ping-pong exchange fails. The following arguments are required:

• data: A PacketDataBytes instance.
• destination_device_identifier: A ExactAddressType instance, that indicates exact target device address.
• lifetime: A LifeTimeType instance.
• timeout: An ms instance specifying how long to wait for a response.

Send with Transaction Method

The send_with_transaction method sends a message and handles all further work to ensure the target device have received it correctly. It returns an error if the transaction failed. The required arguments are:

• data: A PacketDataBytes instance.
• destination_device_identifier: A ExactAddressType instance, that indicates exact target device address.
• lifetime: A LifeTimeType instance.
• timeout: An ms instance to specify the response wait time.

Reduce packet collisions

It is recommended to set listen_period value on multiple devices different from each other, like:

• device 1 - 230 ms,
• device 2 - 240 ms,
• device 3 - 250 ms, this will reduce chance of the network to sychronize, which will lead to packet collisions.

Note: The higher count of nodes in the network leads to the more network stability. In the stable networks - there is less need to use transaction or ping_pong sending, unless, you send something very important.

Warning

This protocol does not provide data encryption. To secure your data from being stolen, you should implement (de/en)cryption mechanisms independently.

All nodes must have the same version of the protocol installed to communicate. Different implementations of the Packet structure, or serialization or deserealization methods will lead to communication issues.

Note

Under the hood, data is packed into a Packet instance. If you need customize packets - you can configure the Packet fields in src/Node/packet/config.rs and src/Node/packet/types.rs. Also serialization and deserealization part will be touched too.

License

This project is licensed under:

• GNU General Public License, Version 3.0 (LICENSE-GPL or GPL License)
• Apache License, Version 2.0 (LICENSE-APACHE or Apache License 2.0)
• MIT License (LICENSE-MIT or MIT License)

You can choose the license that best suits your preferences.

Contribution

Unless you specify otherwise, any contributions submitted for inclusion in this project, as defined in the Apache-2.0 license, will be dual-licensed under both licenses without additional terms or conditions.

Donation

Also you can support the project by donating few bucks on the bitcoin address: bc1qc50tm0ppj3hh7fecd6d0rv8tdygy8uhe2cemzt