chore: release 1.0.0
This commit is contained in:
3 files changed
+75
-10
No files matched your search
@@ -6,27 +6,38 @@
|
||||
|
||||
Wire protocol types and COBS framing for [DongLoRa], shared between the
|
||||
firmware and host crates (`client-rs`, `mux-rs`, `bridge`). `no_std`,
|
||||
zero-alloc, fixed-width little-endian — see the firmware repo's
|
||||
[`PROTOCOL.md`][protocol-md] for the full spec.
|
||||
zero-alloc, fixed-width little-endian. See [`PROTOCOL.md`][protocol-md]
|
||||
in this repo for the normative DongLoRa Protocol v2 specification.
|
||||
|
||||
[DongLoRa]: https://github.com/donglora
|
||||
[protocol-md]: https://github.com/donglora/firmware/blob/main/PROTOCOL.md
|
||||
[protocol-md]: https://github.com/donglora/protocol/blob/main/PROTOCOL.md
|
||||
|
||||
## Install
|
||||
|
||||
```toml
|
||||
# Embedded / firmware (defmt::Format derives on by default):
|
||||
donglora-protocol = "0.1"
|
||||
donglora-protocol = "1"
|
||||
|
||||
# Host (no defmt):
|
||||
donglora-protocol = { version = "0.1", default-features = false }
|
||||
donglora-protocol = { version = "1", default-features = false }
|
||||
```
|
||||
|
||||
## Layout
|
||||
|
||||
- `src/lib.rs` — `Command`, `Response`, `RadioConfig`, `Bandwidth`,
|
||||
`ErrorCode` plus constants and validation/resolve helpers.
|
||||
- `src/framing.rs` — `CobsDecoder` (streaming) and `cobs_encode_response`.
|
||||
- `src/frame.rs`: `FrameDecoder` (streaming COBS + CRC decoder) and
|
||||
`encode_frame(type_id, tag, payload, out)`.
|
||||
- `src/commands.rs`: host-to-device `Command` enum, `type_id`
|
||||
constants, and `TxFlags`.
|
||||
- `src/events.rs`: device-to-host `DeviceMessage` (OK / ERR / RX /
|
||||
TX_DONE), with the `OkPayload`, `SetConfigResult`, `RxPayload`,
|
||||
`RxOrigin`, and `TxDonePayload` sub-shapes.
|
||||
- `src/modulation.rs`: `Modulation` enum (LoRa, FSK/GFSK, LR-FHSS,
|
||||
FLRC) and their typed parameter structs.
|
||||
- `src/info.rs`: `GET_INFO` response payload + capability bitmap
|
||||
helpers.
|
||||
- `src/errors.rs`: wire-level `ErrorCode` enum.
|
||||
- `src/chip_id.rs`: `RadioChipId` enum.
|
||||
- `src/crc.rs`: CRC-16/CCITT-FALSE helper.
|
||||
|
||||
## Features
|
||||
|
||||
@@ -46,7 +57,7 @@ The crate ships its own quality gate via `just test`:
|
||||
| `test-fmt` | `cargo fmt -- --check` |
|
||||
| `test-doc` | `cargo doc --no-deps --all-features` |
|
||||
| `test-deny` | `cargo deny check` |
|
||||
| `test-fuzz` | 60 s on each of 7 cargo-fuzz targets (nightly) |
|
||||
| `test-fuzz` | 60 s on each of 5 cargo-fuzz targets (nightly) |
|
||||
| `test-miri` | miri on lib + vector tests, both feature shapes (nightly) |
|
||||
| `test-mutants` | cargo-mutants under both feature configurations |
|
||||
|
||||
|
||||
Reference in new issue
Block a user