Skip to content

Commit 339f7e7

Browse files
committed
document the "sans I/O" behaviour of this crate
1 parent a7ec442 commit 339f7e7

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ If you select neither or both you'll get a compile error.
2424
If other events are received, a `ProtocolParseError::DisabledControllerDataPackageType` will be returned.
2525

2626
## Usage
27-
The entry point to use this crate is the `parse` function.
27+
The entry point to use this crate is the `parse` function. Note that this is a [sans I/O](https://sans-io.readthedocs.io/)
28+
crate, i.e. you have to talk to the Adafruit device, the `parse` function just expects a byte sequence.
2829

2930
## Examples
3031
A simple example for the STM32F4 microcontrollers is [available](examples/stm32f4-event-printer/README.md).

src/lib.rs

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
//! This implements the [Adafruit Bluefruit LE Connect controller protocol](https://learn.adafruit.com/bluefruit-le-connect/controller)
22
//! which is e.g. used by the [Adafruit Bluefruit LE UART Friend](https://learn.adafruit.com/introducing-the-adafruit-bluefruit-le-uart-friend).
33
//!
4-
//! The entry point to use this crate is the [`parse`] function.
4+
//! The entry point to use this crate is the [`parse`] function. Note that this is a [sans I/O](https://sans-io.readthedocs.io/)
5+
//! crate, i.e. you have to talk to the Adafruit device, the `parse` function just expects a byte sequence.
56
//!
67
//! ## Optional features
78
//! * `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.

0 commit comments

Comments
 (0)