swaits/donglora
Archived
1
0 Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

fix: remove stale postcard/serde references from README, DESIGN.md, CHANGELOG, donglora.py

Browse Source
This commit is contained in:
swaits committed 2026-03-29 21:47:03 -06:00
1 parent 73a2d02e9c
commit 4e221486ee
4 files changed
+7 -8
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

CHANGELOG.md
+1 -1
View File
@@ -10,7 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
### Added ### Added
- Transparent LoRa radio over USB CDC-ACM (VID `1209`, PID `5741`) - Transparent LoRa radio over USB CDC-ACM (VID `1209`, PID `5741`)
- COBS-framed postcard binary protocol (8 commands, 6 responses) - COBS-framed fixed-size LE binary protocol (8 commands, 6 responses)
- Radio configuration: frequency, bandwidth, spreading factor, coding rate, TX power - Radio configuration: frequency, bandwidth, spreading factor, coding rate, TX power
- Continuous RX mode with RSSI/SNR per packet - Continuous RX mode with RSSI/SNR per packet
- Single-shot TX with optional per-packet config override - Single-shot TX with optional per-packet config override
DESIGN.md
+2 -2
View File
@@ -97,8 +97,8 @@ keep, but never prematurely.
| Decision | Choice | Why | | Decision | Choice | Why |
|---|---|---| |---|---|---|
| USB framing | COBS + postcard | Compact, `no_std` native, battle-tested | | USB framing | COBS | Compact, `no_std`, zero-overhead frame delimiting |
| Serialization | postcard + serde | Zero-alloc binary codec, perfect for embedded | | Serialization | Fixed-size LE | Every field at a known offset. No varints, no surprises |
| Async runtime | Embassy | De facto standard for async embedded Rust | | Async runtime | Embassy | De facto standard for async embedded Rust |
| Display | Radio status dashboard | Freq, BW, SF, packet counts, RSSI/SNR | | Display | Radio status dashboard | Freq, BW, SF, packet counts, RSSI/SNR |
| Boot behavior | Idle until host commands | Host-driven principle | | Boot behavior | Idle until host commands | Host-driven principle |
README.md
+3 -4
View File
@@ -23,10 +23,9 @@ and gets out of the way. No mesh logic, no protocol opinions, no config files.
## Protocol ## Protocol
DongLoRa speaks a binary protocol over USB CDC-ACM: COBS-framed DongLoRa speaks a binary protocol over USB CDC-ACM: COBS-framed,
[postcard](https://postcard.jamesmunns.com/) messages. 8 commands, fixed-size little-endian messages. 8 commands, 6 response types —
6 response types — everything you need to configure the radio, everything you need to configure the radio, transmit, and receive.
transmit, and receive.
See **[docs/PROTOCOL.md](docs/PROTOCOL.md)** for the complete wire format See **[docs/PROTOCOL.md](docs/PROTOCOL.md)** for the complete wire format
specification with worked examples. specification with worked examples.
examples/donglora.py
+1 -1
View File
@@ -1,7 +1,7 @@
"""DongLoRa host library — connect, configure, send/receive LoRa packets. """DongLoRa host library — connect, configure, send/receive LoRa packets.
This is a minimal helper for the example scripts. It implements the This is a minimal helper for the example scripts. It implements the
DongLoRa USB protocol (COBS-framed postcard) just enough to be useful. DongLoRa USB protocol (COBS-framed fixed-size LE) just enough to be useful.
See docs/PROTOCOL.md for the full specification. See docs/PROTOCOL.md for the full specification.
""" """
# /// script # /// script