tiny-wb/docs
Dandaedre 8ed07cb60e
Rust CI tiny-wb passed CI.
Gitea/tiny-wb/pipeline/head This commit looks good Details
feat: automate macOS cross-compilation with Zig
2026-10-20 15:13:37 +02:00
..
README.md feat: automate macOS cross-compilation with Zig 2026-10-20 15:13:37 +02:00
architecture.md feat: add live scan mode 2026-10-08 09:39:05 +02:00
configuration.md feat: add live plot navigation and peak overlay 2026-10-08 12:51:59 +02:00
hardware-validation.md feat: support tinySA Ultra+ ZS406 2026-10-07 10:03:05 +02:00
library.md feat: add interactive CSV plot navigation 2026-10-07 16:15:26 +02:00
macos.md feat: automate macOS cross-compilation with Zig 2026-10-20 15:13:37 +02:00
mock-device.md feat: support tinySA Ultra+ ZS406 2026-10-07 10:03:05 +02:00
releases.md feat: automate macOS cross-compilation with Zig 2026-10-20 15:13:37 +02:00
roadmap.md feat: support tinySA Ultra+ ZS406 2026-10-07 10:03:05 +02:00
security-and-ci.md feat: prepare 0.1.3-rc.1 release candidate 2026-10-05 10:10:15 +02:00
sources.md feat: detect tinySA Ultra and apply model-aware scan decoding 2026-10-05 09:45:56 +02:00
testing.md feat: add live plot navigation and peak overlay 2026-10-08 12:51:59 +02:00
tiny-wb-operations.md feat: add live plot navigation and peak overlay 2026-10-08 12:51:59 +02:00
tinysa-field-guide.md feat: support tinySA Ultra+ ZS406 2026-10-07 10:03:05 +02:00
ultra-support.md feat: support tinySA Ultra+ ZS406 2026-10-07 10:03:05 +02:00
usb-protocol.md feat: add live scan mode 2026-10-08 09:39:05 +02:00

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

  1. Project architecture explains what tiny-wb does and how control and data move through the Rust application.
  2. tinySA field guide identifies the hardware, explains the RF signal paths, and covers safe and accurate use.
  3. USB console and scanraw protocol is the implementation reference for serial commands and binary acquisition.
  4. tiny-wb compatibility and operations maps those facts onto the behavior, restrictions, and failure modes of this repository.
  5. Security, dependency policy, and MSRV documents the reproducible-build and supply-chain gates.
  6. Upstream source catalogue records the primary references and their scope.
  7. 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