Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

General usage: choose an input route

After completing Getting started, use this page to choose the shortest command for a monitoring route. The focused tutorials contain the complete prerequisites, observations, lifetime, and cleanup for each route.

Command shape

The command examples on this page use a POSIX shell on Linux or Unix. Run from the repository root:

cargo run -- <MODEL> <ONE_INPUT_SELECTION> [ONE_OUTPUT_SELECTION]

Exactly one input selection is required. The common selections are:

TaskInput selectionProcess shape
Replay a checked-in or user-created trace--input-file PATHFinite; exits after the file
Subscribe to MQTT topics named after model inputs--mqtt-inputLive; waits for messages
Subscribe to Redis Pub/Sub channels--redis-inputLive; waits for messages
Read selected Redis knowledge keys--redis-knowledge-inputLive; key changes and optional startup snapshot
Read ROS 2 topics from a mapping--input-ros-file PATHLive; requires --features ros
Combine named local sources--input-config PATHUsually live; source lifetime applies

With no output option, results go to stdout. Use --output-stdout to make that choice explicit, or choose one output route such as --mqtt-output, --redis-output, --output-ros-file PATH, or --output-config PATH.

The default language is dsrv, with gradually typed untimed semantics, the dataflow runtime, and buffered execution. See cargo run -- --help for the complete option set.

Compatibility boundaries

  • --language mstlo selects the MSTLO runtime; do not also provide --runtime. Redis knowledge input is not compatible with MSTLO because it produces ordinary Value input. ROS MSTLO input instead requires the generated MstloTimedValue codec.
  • --input-file is finite replay input and cannot carry reconfiguration for a reconfigurable runtime. Use a live, control-capable source when runtime reconfiguration is required.
  • --input-window-mode needs --input-window-ms or --input-window-update-limit. batch preserves logical ticks; atomic-step uses last-update-wins within the local window. It is not a transaction.
  • --redis-input means Redis Pub/Sub channels. --redis-knowledge-input means selected keys plus keyspace notifications; it does not derive keys from variable names.

Choose a focused page