Skip to content

Docs/Example For New Rerun API#1262

Open
jeff-hykin wants to merge 5 commits intodevfrom
jeff/docs/rerun
Open

Docs/Example For New Rerun API#1262
jeff-hykin wants to merge 5 commits intodevfrom
jeff/docs/rerun

Conversation

@jeff-hykin
Copy link
Member

Closes DIM-540

@greptile-apps
Copy link

greptile-apps bot commented Feb 15, 2026

Greptile Overview

Greptile Summary

This PR adds documentation and examples for the new Rerun visualization API. The changes demonstrate how to use RerunBridgeModule with custom blueprints to automatically visualize LCM streams in Rerun.

Key Changes:

  • Added rerun_bridge() to the camera demo for easier visualization testing
  • Documented how to integrate RerunBridgeModule into custom blueprints
  • Created a new grayscale camera example showing the full pipeline from camera → processing → visualization

Issues Found:

  • Documentation contains incorrect import path for CameraModule (missing .sensors in path)

Confidence Score: 4/5

  • Safe to merge after fixing the import path in documentation
  • The code changes are minimal and correct - adding rerun visualization to camera demo and creating a well-structured example. However, the documentation contains an incorrect import path that will cause runtime errors if users copy it directly. This is a simple fix that prevents the PR from receiving a perfect score.
  • Pay close attention to docs/usage/visualization.md - fix the import path before merging

Important Files Changed

Filename Overview
dimos/hardware/sensors/camera/module.py Added rerun_bridge() import and included it in demo_camera autoconnect, enabling visualization for camera demo
docs/usage/visualization.md Added documentation section for custom blueprints with RerunBridgeModule, but contains incorrect import path for CameraModule
examples/camera_grayscale.py New example showing grayscale image processing with camera and rerun visualization

Flowchart

flowchart TD
    A[CameraModule] -->|publishes color_image| B[LCM Topic: color_image]
    B -->|subscribed by| C[RerunBridgeModule]
    C -->|calls to_rerun| D[Image.to_rerun]
    D -->|logs to| E[Rerun Viewer]
    
    F[Grayscale Module] -->|subscribes| B
    F -->|processes| G[image.to_grayscale]
    G -->|publishes| H[LCM Topic: gray_image]
    H -->|subscribed by| C
    C -->|calls to_rerun| I[Image.to_rerun]
    I -->|logs to| E
    
    style A fill:#4a9eff
    style F fill:#4a9eff
    style C fill:#ff9800
    style E fill:#4caf50
Loading

Last reviewed commit: 2790247

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.

3 files reviewed, 1 comment

Edit Code Review Agent Settings | Greptile


To enable rerun within your own blueprint simply include `RerunBridgeModule`:

```py
Copy link
Contributor

@paul-nechifor paul-nechifor Feb 15, 2026

Choose a reason for hiding this comment

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

Is this supposed to be python not py?

Copy link
Member Author

Choose a reason for hiding this comment

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

Both get highlighting, same with js and JavaScript. But it would be good to be consistent.

Copy link
Contributor

@paul-nechifor paul-nechifor left a comment

Choose a reason for hiding this comment

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

Invalid path.

@spomichter
Copy link
Contributor

Between the old Rerun API and the new lies a membrane of translation. The examples compile, but do they understand? Documentation bridges realities—choose your words carefully.

— observing the migration

Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@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

Comments