custom-rviz-overlay

Create real-time RViz overlay displays for ROS 2 robot telemetry.

18|2|Updated Apr 20, 2026
One-click install
npx skills add https://github.com/wimblerobotics/ros2-copilot-skills --skill custom-rviz-overlay
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: custom-rviz-overlay
Source: https://github.com/wimblerobotics/ros2-copilot-skills/tree/main/custom-rviz-overlay
Command: npx skills add https://github.com/wimblerobotics/ros2-copilot-skills --skill custom-rviz-overlay

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

RViz overlays render 2D text and status indicators directly on the RViz viewport to provide at-a-glance telemetry for battery, velocity, and navigation state during development and operations.

Core Features & Use Cases

  • OverlayText-based displays powered by rviz_2d_overlay_plugins to render battery, velocity, and nav state.
  • BatteryOverlayPublisher and DashboardOverlay nodes provide real-time telemetry overlays.
  • Use cases include on-robot dashboards during field deployments, SITL simulations, and testing where quick telemetry at-a-glance is needed.
  • RViz configuration guidance shown in the examples.

Quick Start

Launch the RViz overlays by running the BatteryOverlayPublisher and DashboardOverlay nodes and add the rviz_2d_overlay_plugins overlays to your RViz configuration.

Frequently Asked Questions about custom-rviz-overlay

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I display real-time battery and velocity telemetry on an RViz viewport in ROS 2?

To display real-time telemetry on an RViz viewport, you can use ROS 2 Python nodes that subscribe to BatteryState and Twist messages, then publish OverlayText data to render 2D status indicators directly on the 3D view.

What are RViz overlays and when do I need them for ROS 2 robot operations?

RViz overlays are 2D text and status indicators rendered directly on the RViz viewport. You need them during development, SITL simulations, and field deployments when operators require at-a-glance telemetry for battery, velocity, and navigation state.

Does displaying RViz overlays require rviz_2d_overlay_plugins?

Yes, displaying RViz overlays requires rviz_2d_overlay_plugins and OverlayText message support to render the 2D text and status indicators directly on the viewport for your ROS 2 robot telemetry.

Can I use ROS 2 overlays to create an on-robot dashboard for field deployments?

Yes, you can use ROS 2 overlays to create on-robot dashboards for field deployments. By running BatteryOverlayPublisher and DashboardOverlay nodes, you can monitor real-time navigation state and telemetry at a glance.

How do I set up RViz configuration to show navigation state and battery overlays?

To set up RViz configuration for navigation and battery overlays, launch the BatteryOverlayPublisher and DashboardOverlay nodes, then add the rviz_2d_overlay_plugins overlays to your RViz configuration file.

What is the best way to monitor ROS 2 nav status without switching away from the 3D visualization?

The best way to monitor nav status within 3D visualization is using RViz overlays. They subscribe to Nav status topics and render the telemetry as 2D text directly on the viewport, eliminating the need to switch windows.