You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+49-11Lines changed: 49 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,18 +6,24 @@ The diagnostics messages follow conventions from [Isaac ROS NITROS](https://gith
6
6
7
7
Finally, we provide monitoring code as a standalone C++ header, which can be integrated into your own nodes.
8
8
9
-
## Dashboard Interface
9
+
## Dashboard Interfaces
10
10
11
-
The Greenwave Monitor ships with a fork of [r2s](https://github.com/mjcarroll/r2s) to provide an intuitive terminal interface that displays real-time statistics for all monitored topics. Click around with your mouse and tab key, and see the bottom bar with keyboard shortcuts.
11
+
The Greenwave Monitor provides two terminal-based dashboard options:
12
+
13
+
### r2s_gw Dashboard (Rich TUI)
14
+
Ships with a fork of [r2s](https://github.com/mjcarroll/r2s) to provide an intuitive terminal interface that displays real-time statistics for all monitored topics. Click around with your mouse and tab key, and see the bottom bar with keyboard shortcuts.
A lightweight ncurses-based interface focused specifically on topic monitoring with keyboard navigation. Features color-coded status indicators, interactive frequency management, and filtering options.
20
+
15
21
## Key Features
16
22
17
23
-**High Performance**: Up to 10x more CPU efficient than the built-in `ros2 topic hz` command
18
-
-**Interactive Dashboard**: Real-time visualization of monitoring data with an easy-to-use terminal interface
19
-
-**Dynamic Topic Management**: Add or remove topics from monitoring without restarting
20
-
-**Topic Status Indicators**: Color-coded topic status to easily catch topics that are not working as expected
24
+
-**Multiple Dashboard Options**: Choose between rich TUI (r2s_gw) or lightweight ncurses interface
25
+
-**Real-time Monitoring**: Live visualization of topic rates, latency, and status with color-coded indicators
26
+
-**Interactive Management**: Add/remove topics and set expected frequencies directly from the interface
21
27
-**Universal Compatibility**: Displays diagnostics from any source that publishes a compatible `/diagnostics` topic, including NVIDIA Nova sensors and other hardware drivers
22
28
23
29
## Installation
@@ -34,27 +40,59 @@ source install/setup.sh
34
40
35
41
## Usage
36
42
37
-
### Monitor Dashboard (Recommended)
43
+
### Monitor Dashboards
44
+
45
+
The easiest way to use Greenwave Monitor is with one of the all-in-one dashboard commands, which provide visibility into all diagnostics, including those from drivers that publish their own diagnostic data.
38
46
39
-
The easiest way to use Greenwave Monitor is with the all-in-one dashboard, which provides visibility into all diagnostics, including those from drivers that publish their own diagnostic data:
47
+
#### r2s_gw Dashboard (Rich TUI)
40
48
41
49
```bash
42
50
ros2 run greenwave_monitor r2s_gw_dashboard
43
51
```
44
52
45
-
This command:
46
-
- Starts the greenwave monitor node in the background
47
-
- Launches the r2s_gw TUI frontend in the foreground
0 commit comments