ucpack

Crates.ioucpack
lib.rsucpack
version0.1.3
sourcesrc
created_at2024-10-31 16:27:59.484227
updated_at2024-11-02 09:40:47.929788
descriptionRust implementation of the ucpack serialization format used in the Arduino Alvik
homepage
repository
max_upload_size
id1430318
size103,386
Pietro Tamilia (BRA1L0R)

documentation

README

ucpack docs.rs

Rust implementation of the ucpack serialization format used in the Arduino Alvik using serde.

This crate does not implement the body API itself, but rather the binary protocol and format it uses to encode its messages.

The crate

This crate exposes a struct called UcPack which you can initialize to start encoding and decoding serde compatible data types and structures.

[!WARNING] Not every type is compatible with ucpack. Namely any integer above 16 bits, lists and maps.

You can also const initialize UcPack and use it const-ly from anywhere if carrying state isn't an option:

const packer: UcPack = UcPack::new(b'A', b'#');

fn main() {
    packer.serialize_slice(...); // ecc..
}

The protocol

NOTE: Table gently borrowed from ucpack's c++ repo

A packet is managed as:

index_byte message length message stop_byte crc8
1 byte (default A) 1 byte N bytes from message length 1 byte (default #) 1 byte

This crate, opposed to the c++ and micropython respectives, is agnostic across the message content (referred to by the name payload in this crate).

Commit count: 0

cargo fmt