|
|
||
|---|---|---|
| .cargo | ||
| assets | ||
| config | ||
| docs | ||
| examples | ||
| scripts | ||
| src | ||
| tests | ||
| .gitignore | ||
| .ignore | ||
| AGENTS.md | ||
| Cargo.lock | ||
| Cargo.toml | ||
| Jenkinsfile | ||
| LICENSE | ||
| README.md | ||
| build.rs | ||
| deny.toml | ||
| release.sh | ||
| rust-release.toml | ||
| rustfmt.toml | ||
README.md
tiny-wb
tiny-wb is an interactive terminal application that acquires a frequency
sweep from a tinySA over its USB serial console and exports the result as CSV.
It is written in Rust and uses Ratatui for the interface.
The current implementation is primarily shaped around the original tinySA Basic command set and its 0–960 MHz low/high input ranges. The tinySA Ultra family uses much of the same console protocol, but model detection and the Ultra frequency ranges are not implemented yet; see the compatibility notes before connecting an Ultra or Ultra+.
Documentation
-
Feature completion roadmap — prioritized Basic/Ultra tasks and acceptance criteria
-
Library integration — core-only builds and optional adapters
-
Mock device — portable TCP server and deterministic testing
-
Documentation index — where to start and source policy
-
Configuration — defaults, partial overrides, units, validation, and saved selections
-
Release guide — wrapper, target/artifact policy, token handling, and publication readiness
-
Testing guide — hardware-free regression tests and test boundaries
-
Hardware validation — guided Basic and Ultra acceptance checks
-
Project architecture — components, state, data flow, files, dependencies, and extension points
-
tinySA field guide — models, RF architecture, specifications, safe operation, measurement practice, calibration, and firmware
-
USB console and
scanrawprotocol — framing, commands, binary decoding, synchronization, and a worked example -
tiny-wb compatibility and operations — current behavior, setup, controls, files, troubleshooting, and known limitations
-
Security, dependency policy, and MSRV — Rust 1.88 compatibility floor, locked builds, RustSec, licenses, and CI gates
-
Upstream source catalogue — authoritative links and what each source is used for
The documentation was checked against the official tinySA wiki and firmware
source on 2026-10-04. Instrument firmware evolves, so help, version, and
info on the connected unit remain the final authority for its command set.
Build and run
Install Rust 1.88.0 or newer, connect and power on the instrument, then run:
cargo run --release
On Linux the USB CDC device is commonly /dev/ttyACM0; on Windows it appears
as a COM port. The user running tiny-wb must have permission to open it.
The interface uses arrow keys or Vim-style h, j, k, l. Left/right
selects a field, up/down changes its value, Enter advances, and q or Escape
quits. Scan frequencies shown in the UI are MHz. The selected settings are
stored in config.toml (or TINY_WB_CONFIG); scan results default to the current
directory with collision-safe timestamped names. Timing, scan defaults, chart
bounds, CSV output, and logging are configurable. See the commented
defaults and configuration guide.
Current scan flow
At a high level, tiny-wb:
- opens the selected serial port;
- identifies the instrument with
versionandinfo; - configures repeat count, raw-value zero offset, input mode, and sweep;
- requests a binary
scanrawacquisition; - decodes each level sample into dBm and writes
frequency_MHz,dBm; - resumes the instrument sweep and plots the acquired points.
For the exact command sequence and compatibility implications, read
USB console and scanraw protocol and
tiny-wb compatibility and operations.
Safety
Do not connect an unknown RF source directly to a tinySA. Use external attenuation for transmitters and a DC block where a DC component may be present. The Ultra family has an absolute RF input limit of +6 dBm at 0 dB internal attenuation; the Basic limit is +10 dBm. These are damage limits, not recommended measurement levels. See the safe-operation section.
Development
The Jenkins pipeline checks formatting, compilation, tests, documentation, coverage, Clippy, and a release build. Run the equivalent local checks with:
cargo fmt --all -- --check
cargo audit --deny warnings
cargo deny check
cargo +1.88.0 check --locked --all-targets --all-features
cargo check --locked --all-targets --all-features
cargo test --locked --all-targets --all-features
cargo test --locked --doc --all-features
RUSTDOCFLAGS="-D warnings" cargo doc --locked --no-deps --all-features
cargo clippy --locked --all-targets --all-features -- -D warnings
The binary builds on a reusable library for configuration, protocol decoding,
transport, acquisition, and CSV export. UI control flow, state, and rendering
live in src/ui/. See architecture for the source map
and AGENTS.md for code, documentation, and commit conventions.
License
See LICENSE.