|
|
||
|---|---|---|
| .. | ||
| README.md | ||
| architecture.md | ||
| configuration.md | ||
| hardware-validation.md | ||
| library.md | ||
| macos.md | ||
| mock-device.md | ||
| releases.md | ||
| roadmap.md | ||
| security-and-ci.md | ||
| sources.md | ||
| testing.md | ||
| tiny-wb-operations.md | ||
| tinysa-field-guide.md | ||
| ultra-support.md | ||
| usb-protocol.md | ||
README.md
tiny-wb technical documentation
This directory is the local reference for the project and the instruments it controls. It is deliberately split by concern so that maintainers normally do not need to reread the upstream wiki before changing the code.
Reading order
- Project architecture explains what
tiny-wbdoes and how control and data move through the Rust application. - tinySA field guide identifies the hardware, explains the RF signal paths, and covers safe and accurate use.
- USB console and
scanrawprotocol is the implementation reference for serial commands and binary acquisition. - tiny-wb compatibility and operations maps those facts onto the behavior, restrictions, and failure modes of this repository.
- Security, dependency policy, and MSRV documents the reproducible-build and supply-chain gates.
- Upstream source catalogue records the primary references and their scope.
- Hardware validation provides guided Basic and Ultra checklists and the interactive validator command.
Scope and authority
There are three different kinds of statement in these documents:
- Instrument facts come from the official tinySA wiki or the upstream firmware source.
- Application facts come from the code in this repository.
- Engineering conclusions are called out as implications, risks, or recommendations.
The material was verified on 2026-10-04. Specifications and console
commands can change with firmware and hardware revisions. When a connected
device disagrees with this documentation, record its version, info, and
help output and treat those results plus the matching firmware source as
authoritative.
Why this is not an mdBook yet
The documentation is a small, navigable set of Markdown files with direct
cross-links. Adding mdBook configuration and a CI publication stage now would
introduce a new build dependency without improving navigation. If the guide
grows into many chapters, the files are already organized so that a future
SUMMARY.md can include them with little restructuring.
Contributor references
- Configuration: embedded defaults, partial overrides and persistence.
- Testing: regression seams and hardware verification boundaries.
- Agent/contributor guidance: code structure, comments, documentation and atomic commits.
- Releases: release wrapper, prerequisites, collision checks and publication policy.
- macOS cross-compilation: automated Apple Silicon and Intel builds from Linux.
- Basic and Ultra support: implemented range, model detection and qualification status.
- Feature roadmap: model-aware Basic/Ultra completion tasks.
- Implementation task backlog: detailed milestones and optional stretch goals.
- Library integration: feature selection and public interfaces.
- Mock device: in-memory and TCP simulation.