simp_protocol
| Crates.io | simp_protocol |
| lib.rs | simp_protocol |
| version | 0.2.0 |
| source | src |
| created_at | 2024-08-25 16:51:01.680223 |
| updated_at | 2024-10-24 09:51:37.233445 |
| description | simp_protocol is a simplistic protocol to communicate over serial ports. It supports ack, automated escaping and unescaping of special bytes and checksum error detection. |
| homepage | |
| repository | |
| max_upload_size | |
| id | 1351251 |
| size | 65,364 |
Mikołaj Mikołajczyk (mikolajmikolajczyk)
documentation
README
Simp UART Protocol Library
A simple and reliable UART communication protocol implemented in Rust. This library provides functionality to send and receive data packets over UART, with optional acknowledgment (ACK) handling, making it suitable for embedded systems like the ESP32 and standard PC applications.
Features
- Packet-based communication with start and end delimiters.
- Automatic escaping and unescaping of special bytes.
- Checksum for error detection.
- Support for sending packets with or without waiting for ACK.
- Compatible with both embedded systems (e.g., ESP32) and standard PCs (Windows/Linux).
Getting Started
Prerequisites
- Rust: Make sure you have Rust installed. You can install it from rust-lang.org.
- ESP32: If you plan to use this library on an ESP32, read this guide first.
Installation
Add this library to your Cargo.toml:
[dependencies]
simp_protocol = { version = "0.2.0" } # Adjust the path as necessary
How to use?
Please check out examples directory as it contains all you need to start using this library.
License
This library is published with MIT license.