Skip to main content
Version: Next

reduct-bridge

GitHub release (latest SemVer) GitHub Workflow Status Docker Pulls GitHub all releases codecov

ReductBridge bridges live robotics and IIoT data with long-term storage in ReductStore. You can configure the bridge using a simple TOML file to define inputs, pipelines, and remotes. Inputs produce data, pipelines route and modify it, and remotes store it.

Inputs​

An input is a data source. It reads data from a system and produces records for the bridge.

Supported input types include:

  • Shell - run shell commands on a fixed interval and store output lines as records.
  • ROS1 - subscribe to ROS1 topics and store ROS messages as records.
  • ROS2 - subscribe to ROS2 topics and store serialized CDR payloads as records.

Remotes​

A remote is a data destination. It receives records from pipelines and writes them to external storage.

Supported remote types include:

  • ReductStore - write pipeline records and attachments to ReductStore with configurable batching.

Pipelines​

Pipelines connect one or more inputs to one remote.

# Pipeline definition path:
# [pipelines.<pipeline_name>]
[pipelines.telemetry]

# Required: remote name from [[remotes.*]].
remote = "local"

# Required: one or more input names from [inputs.*.*].
inputs = ["ros_local"]

# Optional label rules (default = []):
# 1) Static labels:
#    { static = { source = "robot" }, to = "*" }
#    - adds labels to matching target entries
# 2) Copy labels from one entry to another:
#    { from = "time", labels = ["timestamp"], to = "echo" }
#    - remembers labels seen on matching source entries
#    - applies them to matching target entries
labels = [
  { static = { source = "ros1" }, to = "*" }
]

Installation​

cargo install reduct-bridge

cargo install reduct-bridge builds the default feature set, which includes only the shell input.

To build additional inputs explicitly from source:

cargo build --no-default-features --features ros1
cargo build --no-default-features --features ros2
cargo build --no-default-features --features all-inputs

ROS2 builds require a local ROS2 installation and a sourced environment, for example:

source /opt/ros/jazzy/setup.bash
cargo build --no-default-features --features ros2

For ROS2 builds, the installation must include the standard interface packages required by rclrs.

Usage​

reduct-bridge /path/to/config.toml

For ROS2 inputs, start the bridge from a sourced ROS2 environment and set ROS_HOME to a writable directory, especially under systemd:

source /opt/ros/jazzy/setup.bash
export ROS_HOME=/var/lib/reduct-bridge/.ros
mkdir -p "$ROS_HOME"
reduct-bridge /path/to/config.toml

Documentation​

For detailed documentation, please refer to the ReductBridge Documentation.