Skip to content

Rust Spec

Pascal Dietrich edited this page Jul 19, 2023 · 8 revisions

This is the specification that is used by rust and the calliope mini to communicate with each other via USB/serial.

Rust to Calliope

Signal Meaning
COMMUNICATOR:<CHANNEL> Change the mode of the Calliope mini. In this mode the Calliope scans a single channel and sends logs to the middleware)
SCANNER:<FREQUENCY> Change the mode of the Calliope mini. In this mode the Calliope scans the network for networks by searching each network manually and listening for singals.
TESTER:<CHANNEL> Change the mode of the Calliope mini. In this mode the Calliope sends test signals on a specified channel.
MODE Ask for the current mode. Answer is the last MODE sent or an empty string if the device was not used yet.
SCANNER:RESTART Restarts the scanner. The scannner will resume scanning at channel 0.

Calliope to Rust

Signal Meaning
CHANNEL_FOUND:<CHANNEL> Reports that the scanner found a channel on channel_id <CHANNEL>
LOG:<CHANNEL>;<NUM> Reports that in channel <CHANNEL>, the number <NUM> was recieved.
LOG:<CHANNEL>;"<STR>" Reports that in channel <CHANNEL>, the string <STR> was recieved.
LOG:<CHANNEL>;{"<KEY>":"<VAL>"} Reports that in channel <CHANNEL>, the pair of key <KEY> and value <VAL> was recieved.
MODE:<MODE> Answer to MODE. Sends the current mode of the Calliope as <MODE>.
Clone this wiki locally