Skip to main content

LCM Message Definitions

This repository contains LCM message definitions for the Dimos project and tools to generate those language bindings.

It depends on our LCM fork for generation since we introduced some convinience changes to python message definitions.

lcmgen from our lcm fork is conviniently pulled and built by our flake.nix

Generating Bindings

Run generate.sh to regenerate all bindings:

./generate.sh

This will:

  1. Convert ROS messages to LCM definitions (from sources/ros_msgs/ to lcm_types/)
  2. Generate Python bindings (generated/python_lcm_msgs/)
  3. Generate C++ bindings (generated/cpp_lcm_msgs/)
  4. Generate C# bindings (generated/cs_lcm_msgs/)
  5. Generate Java bindings (generated/java_lcm_msgs/)
  6. Generate Typescript bindings (generated/ts_lcm_msgs/)
  7. Generate Rust bindings (generated/rust_lcm_msgs/)

Directory Structure

  • sources/ - Source ROS message definitions and conversion tools
  • lcm_types/ - Generated LCM message definitions
  • generated/ - Generated language bindings

Python Package

This repo is also a Python package and you can install it via pip install dimos-lcm It is not very useful standalone and is meant to be used in conjuction with actual dimOS

Control values

control_msgs.ControlValues carries continuous command or state data between a control coordinator and device-owning connections. The stream/topic determines the direction; both use the same wire type.

Field Meaning
source Publisher identity
source_ts Publisher Unix timestamp in seconds
epoch State generation or command session, established outside the data message
sequence Increasing frame number within that source, stream, and epoch
interface_names Canonical interface names declared by startup configuration
values Corresponding float64 values

The two array-length fields are LCM encoding fields and must match their arrays and each other. Consumers must reject duplicate or undeclared names, non-finite values, and invalid or stale epochs/sequences. The generated codecs serialize data; they do not enforce these application-level checks. Timestamps alone do not establish freshness across machines with unsynchronized clocks.

Interface names and their units, ownership, and supported combinations come from the resolved connection configuration. The codec does not interpret names or distinguish robot families. Examples include joint position/velocity for arms, position/velocity/effort/gains for whole-body control, pose coordinates, and linear/angular velocity for bases. Pose reference frames must be defined by the interface contract; they are not inferred from the values.

Empty frames are encodable. Whether they serve as heartbeats, whether frames are complete or sparse, and what an omitted command means are runtime contract decisions, not codec behavior. This schema does not authorize motion or implement a watchdog.

Descriptions are supplied through startup configuration, not LCM announcements. Discrete lifecycle requests and their results belong to RPC. No description, readiness, or lifecycle message types are added by this contract.

Validate the Python codec with:

python -m unittest discover -s tests -v

Metadata

Release files for dimos-lcm 0.1.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for dimos-lcm 0.1.4
File Size Uploaded
dimos_lcm-0.1.4.tar.gz 303.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for dimos-lcm 0.1.4
File Interpreter ABI Platform
dimos_lcm-0.1.4-py3-none-any.whl Python 3 none any Details

Total release size: 897.5 kB

Release files / dimos_lcm-0.1.4.tar.gz

Download URL dimos_lcm-0.1.4.tar.gz
Size 303.9 kB
Tags Source
SHA-256 checksum
How to use checksums
4cef49c386860b94bd18a5da8b0a195459f56d883eaf7ede4fe297167bb773da
BLAKE2b-256 checksum
How to use checksums
4b052c1d03a588ede64ea19c5c22ee72d2a4ac5e5e29c452920aa0e56a578fad
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.11

Release files / dimos_lcm-0.1.4-py3-none-any.whl

Download URL dimos_lcm-0.1.4-py3-none-any.whl
Size 593.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
65efc67a5055b8d53a885bb46a7f49cc6bd07929cbd18403784efe65e186d3a2
BLAKE2b-256 checksum
How to use checksums
d0d0f93e2a2d9062ad0b3981b80db12b34494d231917243ab213265e926b5fa9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.11

Release history Release notifications | RSS feed

0.1.5

2 release files

This release

0.1.4 This release

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page