Skip to content

Latest commit

 

History

History
32 lines (25 loc) · 2.33 KB

README.md

File metadata and controls

32 lines (25 loc) · 2.33 KB
Raw

Adafruit Bluefruit LE Connect Controller Protocol Parser

CI Crates.io Licenses unsafe forbidden

This implements the Adafruit Bluefruit LE Connect controller protocol which is e.g. used by the Adafruit Bluefruit LE UART Friend.

Note that this work is not affiliated with Adafruit.

Optional Features

  • defmt: you can enable the defmt feature to get a defmt::Format implementation for all structs & enums and a defmt::debug! call for each command being parsed.
  • rgb: if enabled, From<ColorEvent> for RGB8 is implemented to support the RGB crate.
  • serde: if enabled, all events implement the serde #[derive(Serialize, Deserialize)].
  • All events can be selected as individual features. By default, they are all selected, but you can opt to only select the event(s) you are interested in which will result in a small binary size. If other events are received, a ProtocolParseError::DisabledControllerDataPackageType will be returned.

Usage

The entry point to use this crate is Parser which implements Iterator to access the events in the input. Note that this is a sans I/O crate, i.e. you have to talk to the Adafruit device, the parser just expects a byte sequence.

Examples

A simple example for the STM32F4 microcontrollers is available.

Changelog

For the changelog please see the dedicated CHANGELOG.md.

Minimum Supported Rust Version (MSRV)

This crate is guaranteed to compile on stable Rust 1.81 and up. It might compile with older versions but that may change in any new patch release.