Skip to main content

Crate ops

Crate ops 

Source
Expand description

The rxp commands as functions. cli wraps them in clap and prints through Stdio; daemon runs them as jobs and collects their lines. Every command takes a Ctx (the former global flags) and, when it has anything to say, a &mut dyn Progress.

Re-exports§

pub use colorlight as protocol;
pub use panelspec;
pub use rcvbp;
pub use receivers;

Modules§

capture
Talking to the card directly: discovery, listening, replay, raw frames.
config
Inspecting, composing and comparing .rcvbp configuration files.
display
Putting images on the wall: patterns, stills, and video. Every content command sends through driver::Wall, so the frame recipe lives once.
firmware
Firmware images by manifest name or path.
flash
Reading and writing the card’s flash: configuration, dumps, and firmware.
ingest
Frames from other processes: raw rgb24 on stdin (show stream) or over a unix socket with a header per client (show serve). Both send through the same Wall/Pacer path as show video.
model
Which card is on the link: --card or the daemon’s setting names a model, otherwise the discovery reply’s id byte picks one from config/cards/.
params
Pushing parameter packs into the card’s RAM, generated from a panel spec.
probe
rxp card probe: read the card and check every claim in its model file that a read can check. Nothing is written; guarded blocks stay not checked because checking them means writing.
provision
Bring a receiver card to a working state in one command: snapshot, firmware, configuration, cabinet identity, verification.
restore
Snapshots of the card’s flash, and restoring the configuration from one.
screen
The screen-size record: a 256-byte EEPROM-backed record at a linear flash address that the page-addressed frames cannot reach.
upgrade
Installing firmware by the route the card supports: upload the whole image into SDRAM, then ask the card to erase and program itself.
util
Small helpers shared across the command modules.

Structs§

Ctx
The former global flags.
Stdio
The CLI’s sink: println! and eprintln!, the transient line redrawn with \r when stderr is a terminal and dropped otherwise.

Traits§

Progress
Where a command’s lines go. out is what the CLI prints to stdout, err what it prints to stderr: progress, plans, warnings.

Functions§

check
Fails with cancelled once the sink asks the command to stop.
read_library
The filesystem loader: the file at the path, relative to the working directory.

Type Aliases§

Loader
Maps a spec’s [chip].library path to the library’s TOML text: the filesystem for the CLI, an embedded set in the browser.