chore: release 1.0.0

This commit is contained in:
swaits committed 2026-04-22 09:21:12 -06:00
1 parent 4cccb65124
commit 85420dc673
3 files changed
+75 -10

No files matched your search

+54
View File
@@ -4,6 +4,60 @@ All notable changes to this crate are documented here. The format
follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and
this project adheres to [Semantic Versioning](https://semver.org/).
## 1.0.0 — 2026-04-22
The 1.0 wire-format rewrite. Every message shape, tag-correlation
rule, and field layout is re-specified in the new normative
`PROTOCOL.md` and is incompatible with the 0.1.x line.
### Breaking
- **DongLoRa Protocol v2 wire format.** Every `type_id`, tag-correlation
rule, and field layout is redefined in `PROTOCOL.md` §2 through §16.
No byte compatibility with 0.1.x.
- **Module split.** The single-file `lib.rs` is replaced with dedicated
modules: `frame`, `commands`, `events`, `errors`, `modulation`,
`info`, `crc`, `chip_id`. Re-exports at the crate root preserve the
short-form imports (`Command`, `ErrorCode`, etc.), but full paths to
the old `framing` module and `Response` / `RadioConfig` / `Bandwidth`
types no longer resolve.
- **Framing replaced.** `src/framing.rs` is gone. The new
`frame::FrameDecoder` streams inbound bytes and yields
`FrameResult::Ok { type_id, tag, payload }` on each COBS-delimited,
CRC-verified frame. Encoding moves to `encode_frame(type_id, tag,
payload, out)`.
- **`Modulation` replaces `RadioConfig` + `Bandwidth`.** New enum
covering LoRa, FSK/GFSK, LR-FHSS, and FLRC, each with its own typed
parameter struct.
- **New response shapes.** `OkPayload`, `SetConfigResult`,
`TxDonePayload`, `RxPayload`, `RxOrigin`, and `TxFlags` model the
richer response surface required by v2.
### Added
- `PROTOCOL.md`: the normative specification of DongLoRa Protocol v2,
including wire examples, error taxonomy, state machine, and
multi-client semantics (§13).
- `RadioChipId` enum for `GET_INFO` chip identification.
- CRC-16/CCITT-FALSE helper (`crc`) exposed for integrity checks on
arbitrary payload slices.
- `cap` bitflag helpers on the `Info` struct for decoding capability
bitmaps.
### Changed
- Fuzz corpus rewritten: `decoder_feed`, `frame_roundtrip`,
`lora_config_roundtrip`, `parse_command`, `parse_device_message`
replace the 0.1 `cobs_*` and `command_roundtrip` targets.
- Proptest suite and mutation-killer set expanded to cover the new
wire shape.
- Canonical-byte vectors rewritten against `PROTOCOL.md` §C.
### CI
- Workflow now runs on pushes to `dev` in addition to `main`.
- Fuzz jobs pinned to `x86_64-unknown-linux-gnu` for reproducibility.
## 0.1.0 — 2026-04-13
Initial release. The DongLoRa wire-protocol types and COBS framing,