Archived

0 Fork 0

This repository has been archived on 2026-08-31. You can view files and clone it. You cannot open issues or pull requests or push a commit.

Files

T

swaits 5d66731413

feat: add Rust client library and mux daemon

Add donglora-client (clients/rust/) and donglora-mux (mux/rust/) as
Rust implementations of the existing Python client library and mux
daemon. Both are standalone Cargo projects with no-panic guarantees
enforced by clippy deny lints.

donglora-client provides protocol types, COBS framing, USB device
discovery, serial/mux transports, and a high-level Client<T> with
send/recv. donglora-mux is a fully async (tokio) multiplexer daemon
with dongle hot-plug reconnect, per-client bounded send queues,
SetConfig locking, and StartRx/StopRx reference counting.

52 unit tests across both crates. Updates README roadmap checkboxes
and CONTRIBUTING docs to reflect the new implementations.

2026-04-03 17:21:51 -06:00

2.2 KiB

Raw Blame History

Contributing to DongLoRa

Adding Board Support

DongLoRa is designed to make adding new boards easy:

Create firmware/src/board/your_board.rs implementing the init() function
Add a Cargo feature in firmware/Cargo.toml with the board's dependencies
Add the board's feature/target/chip to the justfile boards list
firmware/build.rs auto-discovers the new file and generates the module selector

See existing board files (heltec_v3.rs, rak_wisblock_4631.rs) as templates. Each board file owns all hardware init and returns peripheral bundles that the common tasks consume. No shared board code — each board is self-contained.

Code Style

Clippy-clean. just clippy <board> must pass with no warnings.
No panics in tasks. Use match/if let/warn! — never .unwrap() in async task code. Board init (runs once at startup) may use .expect("reason").
Display rendering uses .ok(). Drawing is best-effort; display errors are not recoverable.
Every let _ = gets an inline comment explaining why the result is discarded.

Client Libraries

Client libraries exist in Python and Rust. To add a library in another language:

Create a directory with the language's standard project layout
Implement the wire protocol from firmware/PROTOCOL.md
Include device discovery (USB VID 1209, PID 5741)
Include COBS framing, command encoding, and response decoding
Add a mux client (connect to the mux daemon's Unix socket or TCP)

The protocol is intentionally simple — 8 commands, 7 responses, fixed-size LE. A minimal client library should be implementable in a weekend.

Building and Testing

cd firmware
just check-all      # Compile-check all boards
just build-all      # Build release firmware for all boards
just clippy <board> # Lint a specific board
just test           # Host-side protocol unit tests

Tool versions are pinned in each project's mise.toml. Tools are installed automatically on first run.

Commits

Conventional Commits format
Logically grouped (one concern per commit)
We use jj for version control

2.2 KiB Raw Blame History