Skip to content

Conversation

@Kaweees
Copy link
Member

@Kaweees Kaweees commented Jan 18, 2026

This merge request brings the work-in-progress changes from (#1038) so that DDSTransport (#1036) can be benchmarked against the transport protocol benchmark suite before merging

@greptile-apps
Copy link

greptile-apps bot commented Jan 18, 2026

Greptile Summary

Adds comprehensive transport benchmarking suite comparing LCM, SharedMemory, Redis, and ROS 2 pub/sub implementations, plus new RawROS transport for direct ROS messaging.

Major changes:

  • Implemented RawROS class for ROS 2 pub/sub with configurable QoS profiles (best-effort and reliable modes)
  • Added benchmark framework with throughput, latency, and message loss metrics across 12 message sizes (64B to 10MB)
  • Enhanced PubSubEncoderMixin to support generic encoding types beyond bytes using new EncodingT type parameter
  • Improved logging by reducing SharedMemory start/stop messages from info to debug level
  • Added comprehensive type annotations across test files for better type safety

Implementation notes:

  • Benchmark uses threading with proper synchronization to measure concurrent pub/sub performance
  • Results displayed via rich tables and color-coded heatmaps for throughput, bandwidth, and latency
  • ROS implementation spawns background thread for executor spinning with non-blocking spin_once(timeout_sec=0)

Confidence Score: 4/5

  • Safe to merge with minor race condition fixes needed in ROS implementation
  • Well-structured benchmark suite with proper abstractions and comprehensive testing, but ROS pub/sub has race conditions in publish/subscribe methods where _running and _node are accessed without lock protection while stop() can modify them concurrently
  • Pay close attention to dimos/protocol/pubsub/rospubsub.py - fix race conditions in publish() and subscribe() methods before benchmarking under high load

Important Files Changed

Filename Overview
dimos/protocol/pubsub/rospubsub.py Adds RawROS and DimosROS classes for ROS 2 pub/sub support with configurable QoS profiles
dimos/protocol/pubsub/benchmark/test_benchmark.py Implements throughput benchmarking test suite for various transport protocols with parametrized message sizes
dimos/protocol/pubsub/benchmark/testdata.py Configures test cases for LCM, SHM, Redis, and ROS transports with message generators
dimos/protocol/pubsub/spec.py Adds EncodingT type parameter to PubSubEncoderMixin for flexible encoding types beyond bytes

Sequence Diagram

sequenceDiagram
    participant Test as test_throughput
    participant PS as PubSub Implementation
    participant Sub as Subscriber Thread
    participant Pub as Publisher Loop
    
    Test->>PS: subscribe(topic, callback)
    PS-->>Test: unsubscribe_fn
    Test->>Test: sleep(0.1) warmup
    
    Note over Test,Pub: Benchmarking Phase
    Test->>Pub: Start publishing loop
    
    loop Until time_limit OR max_messages OR all_received
        Pub->>PS: publish(topic, msg)
        PS->>Sub: callback(msg, topic)
        Sub->>Sub: received_count++
        Sub->>Sub: Check if target reached
        opt All messages received
            Sub->>Test: all_received.set()
        end
    end
    
    Pub->>Test: Record publish_end time
    Test->>Test: Update target_count to actual sent
    
    opt Not all received yet
        Test->>Test: wait(RECEIVE_TIMEOUT)
    end
    
    Test->>Test: Record latency_end time
    Test->>Test: Calculate metrics (throughput, latency, loss)
    Test->>Test: Add result to benchmark_results
Loading

Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

11 files reviewed, 4 comments

Edit Code Review Agent Settings | Greptile

Comment on lines +181 to +182
if not self._running or not self._node:
return
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

logic: Race condition - _running and _node are checked without lock protection, while stop() modifies them from another thread

Suggested change
if not self._running or not self._node:
return
with self._lock:
if not self._running or not self._node:
return

Comment on lines +199 to +200
if not self._running or not self._node:
raise RuntimeError("ROS pubsub not started")
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

logic: Race condition - check happens outside lock, then _node is used inside lock. stop() could set _node = None between the check and use

Suggested change
if not self._running or not self._node:
raise RuntimeError("ROS pubsub not started")
with self._lock:
if not self._running or not self._node:
raise RuntimeError("ROS pubsub not started")

all_received = threading.Event()

def callback(message: Any, _topic: Any) -> None:
nonlocal received_count
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

style: nonlocal received_count is redundant since received_count is already modified within lock context

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Comment on lines +153 to +155
ctx_name = pubsub_context.__name__
prefix = ctx_name.replace("_pubsub_channel", "").replace("_", " ")
transport_name = prefix.upper() if len(prefix) <= 3 else prefix.title().replace(" ", "")
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

style: Duplicate transport name extraction logic - same code exists in pubsub_id() function at lines 68-73

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

@Kaweees Kaweees merged commit 23e3c2e into miguel_pickle_dds Jan 18, 2026
21 of 26 checks passed
Nabla7 pushed a commit that referenced this pull request Jan 19, 2026
* raw rospubsub and benchmarks

* typefixes, shm added to the benchmark

* SHM is not so important to tell us every time when it starts

* greptile comments

* Add co-authorship line to commit message filter patterns

* Remove unused contextmanager import

---------

Co-authored-by: Ivan Nikolic <lesh@sysphere.org>
Nabla7 added a commit that referenced this pull request Jan 20, 2026
* feat(sim): add MJLab G1 velocity policy profile

Introduce a 'mujoco_profile' concept allowing self-contained MuJoCo
simulation bundles (MJCF + ONNX policy + assets) to be loaded by name.

Key changes:
- GlobalConfig: new 'mujoco_profile' field (--mujoco-profile CLI flag)
- model.py: profile-scoped asset loading and bundle.json support
- mujoco_process.py: read camera names from bundle.json per profile
- policy.py: MjlabVelocityOnnxController reads joint_names,
  default_joint_pos, action_scale from ONNX metadata for exact
  MJLab action contract (per-joint scaling & named ordering)
- mujoco_connection.py: skip menagerie download when profile is set
- blueprints.py / rerun_init.py: gate Rerun init on rerun_enabled

Bundle added to data/.lfs/mujoco_sim.tar.gz (LFS-tracked):
  data/mujoco_sim/unitree_g1_mjlab/
    ├── model.xml      (MJLab-compiled G1 MJCF with correct actuators)
    ├── policy.onnx    (trained velocity policy with metadata)
    ├── bundle.json    (camera name mappings)
    └── assets/        (STL meshes from MJLab asset_zoo)

Usage:
  dimos --simulation \
        --mujoco-profile unitree_g1_mjlab \
        run unitree-g1-basic-sim

* CI code cleanup

* fix(sim): resolve meshdir/profile asset conflicts for GO2 and G1

- mujoco_process.py: only use mujoco_profile when explicitly set
  (fixes GO2 accidentally being treated as a profile bundle)
- model.py: rewrite scene XML to remove meshdir/texturedir attrs
  and prefix mesh/texture filenames explicitly, preventing scene
  compiler settings from hijacking robot mesh resolution

* configure unitree go2 mapper to use 10 cm voxels (#1032)

* feat(sim): add MuJoCo subprocess profiler for performance debugging

Adds a built-in timing breakdown for the MuJoCo simulation subprocess.
When enabled, logs rolling averages of time spent in each component:
- physics_ms: mj_step loop
- viewer_sync_ms: MuJoCo viewer synchronization
- rgb_render_ms, depth_render_ms: camera rendering
- pcd_ms: depth-to-pointcloud + voxel downsample
- *_shm_ms: shared memory writes
- ctrl_calls, ctrl_obs_ms, ctrl_onnx_ms: policy cost breakdown

This helps diagnose performance issues (e.g. 'molasses' effect) by
showing exactly where frame time is being spent.

Usage:
  # Standard G1 sim with profiler:
  dimos --simulation --mujoco-profiler --mujoco-profiler-interval-s 2 run unitree-g1-basic-sim

  # MJLab bundle with profiler:
  dimos --simulation --mujoco-profile unitree_g1_mjlab --mujoco-profiler --mujoco-profiler-interval-s 2 run unitree-g1-basic-sim

New GlobalConfig flags:
- mujoco_profiler: bool (default False)
- mujoco_profiler_interval_s: float (default 2.0)

* pre commit

* small docs clarification (#1043)

* Fix split view on wide monitors (#1048)

* fix print to be correct URL based on rerun web or not

* make width of rerun/command center adjustable

* swap sides

* Docs: Install & Develop  (#1022)

* minimal edit

* rice the readme

* grammar

* formatting

* fix examples

* change links to reduce change count

* improve wording

* wording

* remove acknowledgements

* improve the humancli example

* formatting

* Update README.md

* switch to dev branch for development

* changes for paul

* Update README.md

* fix broken link

* update broken link

* Add uv to nix and fix resulting problems (#1021)

* add uv to nix and fix resulting problems

* fix for linux

* v0.0.8 version update (#1050)

* Style changes in docs (#1051)

* capitalization

* punctuation

* more small fixes

* Revert "Add uv to nix and fix resulting problems (#1021)" (#1053)

This reverts commit 8af8f8f.

* Transport benchmarks & Raw ROS transport (#1038)

* raw rospubsub and benchmarks

* typefixes, shm added to the benchmark

* SHM is not so important to tell us every time when it starts

* greptile comments

* Add co-authorship line to commit message filter patterns

* Remove unused contextmanager import

* lcmservice correct kernel settings reintroduced

* mixin mixin resolved

* lcmservice tests fix

* macos lcm rmem fix

* feat: default to rerun-web and auto-open browser on startup (#1019)

- Changed GlobalConfig.viewer_backend default from rerun-native to rerun-web
- WebsocketVisModule now opens dashboard in browser automatically on start
- Requested by Jeff

Co-authored-by: s <pomichterstash@gmail.com>

* chore: fix indentation in blueprints ambiguity check

* CI code cleanup

* use p controller to stop oscillations on unitree go2 (#1014)

* Dynamic session providers for onnxruntime (#983)

* refactor(policy): update inference session initialization

* refactor(policy): simplify inference session provider initialization

* Log the policy directory and provider

* Perception Full Refactor and Cleanup, deprecated Manipulation AIO Pipeline and replaced with Object Scene Registration  (#936)

* added rate limiting and backpressure to pointcloud publishing

CI code cleanup

updated ZED module to the same standard as realsense

CI code cleanup

fixed stash's comments

CI code cleanup

mypy fixes + comments

removed property of camera_info

should pass CI now

added detection3d pointcloud types from depth image

added yoloe support and 3D object segmentation

CI code cleanup

use yoloe-s instead for nuc

CI code cleanup

removed deprecated perception code

some pointcloud color changes

major refactor and added object class for object scene registration

CI code cleanup

refactored, added objectDB for persistent object memory

CI code cleanup

made objectDB a normal class instead of a module

CI code cleanup

revert to dev

reverted more files

CI code cleanup

completely refactored object scene registration to work natively in dimos instead of using ROS as transport. Made everything super clean and working

CI code cleanup

bug fixed + use yoloe-l by default

added yolo object exlusion list

CI code cleanup

added zed camera to the object registration demo

CI code cleanup

added image and pointclou2 fixes and as_numpy function

working promptable object scene registration

CI code cleanup

bug fixes

bug fix + remove ros imports

should not fail CI now

CI code cleanup

more CI fixes, somehow local CI did not catch

changed prompt fixed bug

CI code cleanup

reverted some changes

Cleanup very dead code and fixed mypy errors

CI code cleanup

fixed more mypy

CI code cleanup

* one last mypy fix

* added default to imagedetection2d to not set off mypy

* fixed bug and default to open vocab for detection

* mypy fixes

* fixed one last mypy error

* fixed all of Stash's comments

* should pass mypy now

* added uv lock

* sync uv.lock with dev

* fixed the last mypy error

* fixed mypy errors from source

* reverted mypy import error fixes

* fixed Ivan's comment

* fixed last of ivan's comment

* remove all to_ros_msgs stuff in this commit

* passed Ivan's detector tests

* added README for depth camera integration

* fixed last of Stash's comments

* feat(cli): type-free topic echo via /topic#pkg.Msg inference, this mi… (#988)

* feat(cli): type-free topic echo via /topic#pkg.Msg inference, this mirrors ros topic echo functionality.

- Make type_name optional in 'dimos topic echo'
- Infer message type from LCM channel suffix (e.g. /odom#nav_msgs.Odometry)
- Dynamically import dimos.msgs.<pkg> and call cls.lcm_decode(data)
- Keep existing explicit-type mode working
- Update transports.md docs

* fix(cli): use LCMPubSubBase instead of raw lcm.LCM for topic echo, my bad

* verify blueprints (#1018)

* verify blueprints

* Fix geometry msgs check failure in CI

---------

Co-authored-by: stash <pomichterstash@gmail.com>

* Experimental Streamed Temporal Memory with SpatioTemporal & Entity based RAG (#973)

* temporal memory + vlm agent + blueprints

* fixing module issue and style

* fix skill registration

* removing state functions unpickable

* inheritancefixes and memory management

* docstring for query

* microcommit: fixing memory buffer

* sharpness filter and simplified frame filtering

* CI code cleanup

* initial graph database implementation

* db implementation, working and stylized, best reply is unitree_go2_office_walk2

* type checking issues

* final edits, move into experimental, revert non-memory code edits, typechecking

* persistent db flag enabled in config

* Fix test to not run in CI due to LFS pull

* Fix CLIP filter to use dimensional clip

* Add path to temporal memory

* revert video operators

* Revert moondream

* added temporal memory docs

* Refactor move to /experimental/temporal_memory

---------

Co-authored-by: Paul Nechifor <paul@nechifor.net>
Co-authored-by: Stash Pomichter <pomichterstash@gmail.com>
Co-authored-by: shreyasrajesh0308 <shreyasrajesh0308@users.noreply.github.com>
Co-authored-by: spomichter <12108168+spomichter@users.noreply.github.com>

* Control Orchestrator - Unified Controller for multi-arm and full body controller (#970)

* archive old driver to manipulators_old for redesign

* spec.py defining minimal protocol for an arm driver

* xarm driver driver added - driver owns control thread and robot state threads also invokes rpc calls to arm specific SDK backends

* xarm SDK specific wrapper to interface with dimos RPC calls from the driver

* removed type checking for  old armdriver spec from the cartesian controller

* replicated piper driver to meet the new architecture

* added mock backend

* updated all blueprints to add new arm module

* Added readme explaining new driver architecture overview

* config now parsed in backend init instead of connect method

* addded dual arm control blueprint using trajectory controller

* adding a control orchestrator for single control loop for multiple arms and joint control -  added dataclasses for orchestrator and protocol for ControlTask

* hardware interface protocol that wraps specific arm SDK to work with orchestrator. Also solves namespace for multiple arm and hardware

* main orchestrator module and control loop that claims resources computes next commands,  and arbitrates priority of different tasks and controllers

* added a trajectory task implementation that performs trajecotry control

* added blueprints to launch orchestratory module with differnt arms for testing

* updated blueprints to add piper + xarm blueprint

* orchestrator client that can send tasks to the control orchestrator module

* added a readme

* added pytest and e2e test

* Update dimos/control/hardware_interface.py

explicit false added to the Torque Mode command sent, to avoid silent failing scenario

* CI code cleanup

* Fixed issues flagged by greptile

Mode conflict detection in routing: Added check in _route_to_hardware
Preemption tracking: Changed structure to {preempted_task: {joint: winning_task}}
Mode conflict preemption: Tasks dropped due to mode conflict at same priority
Trajectory completion edge case: Returns final position instead of None on completion
Dead code removal: and Piper backend cleanup

* Renamed deprecated old manipuialtion test file and Mypy type fixes

* fix mypy test

* mypy test fix added explicit  type

* Remove deprecated manipulators_old folder

* fixed redef error in dual trajectory setter

* Fixed bugs identified by greptile overview:
1. tick_loop.py - Race condition in _route_to_hardware
2. orchestrator.py  -  Added hardware_added tracking list and rollback in outer except block
3. hardware_interface.py - Added disconnect() to both HardwareInterface protocol and BackendHardwareInterface
4. Added disconnect() to both HardwareInterface protocol and BackendHardwareInterface
5. orchestrator.py - Start order fix Moved super().start() to end, after tick loop starts successfully
6. trajectory_task.py - Added Empty joint_names validation

* addressed greptile suggestion:
hardware_interface.py - Torque mode logging fix
orchestrator.py - Fail hardware removal if joints in use
tick_loop.py - Rate control drift fix

* undo change to pyproject.toml

* Replaced _running bool with threading.Event (_stop_event) for thread safety
Removed duplicate _auto_start() call from __init__ - connection now only happens in start()
orchestrator_client.py	IPython conversion

* added type ignore for ipythin

* removed check for has attribute in hardware interface

Moved super.start() at the beginning

replaced running bool with stop_event in tick_loop to improve thread safety

removed default ip from init

removed simple dataclasses test

* orchestrator.py: Use match statement for backend factory, restructure backend cleanup
task.py: Use match statement in get_values()
tick_loop.py: Add JointWinner NamedTuple for cleaner arbitration logic
xarm/backend.py: Extract unit conversions into static helper methods

* tick_loop.py: Notify preemption when lower-priority task loses to existing winner
hardware_interface.py: Call set_control_mode() before mode-specific writes, Convert if/elif to match statement for control mode dispatch

* tick_loop.py: Notify preemption when lower-priority task loses to existing winner
hardware_interface.py: Call set_control_mode() before mode-specific writes, convert if/elif to match statement
trajectory_task.py: Defer start time to first compute() for consistent timing
orchestrator.py: Extract _setup_hardware() helper for cleaner config setup
piper and xarm/backend.py: Fail fast on read_joint_positions(), map SERVO_POSITION to mode 1
hardware_interface.py: Retry initialization with proper error propagation,
spec.py: Add SERVO_POSITION control mode for confusion between position planning and position servo
task.py: added SERVO_POSITION to JointCommandOutput helper

* cleaned up legacy blueprints for manipulator drivers

* enforce ManipulatorBackend Protocol on the backend.py

* feat: add runtime protocol checks for manipulator backends

* added runtime checking for controlTask protocol

* Add TaskStatus dataclass, refactor get_trajectory_status and Explicitly inherit from ControlTask protocol

---------

Co-authored-by: stash <pomichterstash@gmail.com>

* configure unitree go2 mapper to use 10 cm voxels (#1032)

* Create DDSPubSubBase, DDSTopic

* Create PickleDDS

* Fix hash/equality inconsistency in DDSTopic

* Add DDSMsg

* Create DDSTransport

* Add broadcast and subscribe methods to DDSTransport

* Create DDSService

* Add CycloneDDS package

* Remove unnecessary attributes

* Add threading and serialization methods to DDSService

* Ensure broadcast and subscribe methods initialize DDS if not started

* Add Transport benchmarking capabilities to CycloneDDS (#1055)

* raw rospubsub and benchmarks

* typefixes, shm added to the benchmark

* SHM is not so important to tell us every time when it starts

* greptile comments

* Add co-authorship line to commit message filter patterns

* Remove unused contextmanager import

---------

Co-authored-by: Ivan Nikolic <lesh@sysphere.org>

* Fix DDS segmentation fault using bytearray for binary data storage

Replace base64 string encoding with native IDL bytearray type to eliminate
buffer overflow issues. The original base64 encoding exceeded CycloneDDS's
default string size limit (~256 bytes) and caused crashes on messages >= 1KB.

Key changes:
- Use make_idl_struct with bytearray field instead of string
- Convert bytes to bytearray when publishing to DDS
- Convert bytearray back to bytes when receiving from DDS
- Add _DDSMessageListener for async message dispatch
- Implement thread-safe DataWriter/DataReader management
- Add pickle support via __getstate__/__setstate__

Result: All 12 DDS benchmark tests pass (64B to 10MB messages).

* Refactor DDS PubSub implementation to use CycloneDDS Topic

* Remove DDS pickling

* CI code cleanup

* bugfix

* CI code cleanup

---------

Co-authored-by: leshy <lesh@sysphere.org>
Co-authored-by: Jeff Hykin <jeff.hykin@gmail.com>
Co-authored-by: Paul Nechifor <paul@nechifor.net>
Co-authored-by: s <pomichterstash@gmail.com>
Co-authored-by: Miguel Villa Floran <miguel.villafloran@gmail.com>
Co-authored-by: alexlin2 <44330195+alexlin2@users.noreply.github.com>
Co-authored-by: claire wang <clara32356@gmail.com>
Co-authored-by: shreyasrajesh0308 <shreyasrajesh0308@users.noreply.github.com>
Co-authored-by: spomichter <12108168+spomichter@users.noreply.github.com>
Co-authored-by: Mustafa Bhadsorawala <39084056+mustafab0@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants