update readme and add CI for readme commands

Author: sgillen

.github/workflows/debian-packages.yml

@@ -145,7 +145,7 @@ jobs:
         # Run ncurses frontend with simulated terminal and quit command
         # Exit code 0 means clean exit (not 11 for SIGSEGV or 134 for SIGABRT)
         set +e
-        timeout 10s script -qfec 'python3 -m greenwave_monitor.ncurses_frontend' /dev/null <<< $'q'
+        timeout 10s script -qfec 'ros2 run greenwave_monitor ncurses_dashboard' /dev/null <<< $'q'
         EXIT_CODE=$?
         set -e
 
@@ -190,6 +190,7 @@ jobs:
       run: |
         source /opt/ros/${{ matrix.ros_distro }}/setup.bash
         timeout 10s bash -lc "script -qfec 'ros2 run r2s_gw r2s_gw' /dev/null <<< \$'q'" || true
+        timeout 10s bash -lc "script -qfec 'ros2 run greenwave_monitor r2s_gw_dashboard' /dev/null <<< \$'q'" || true
       shell: bash
 
     - name: Test greenwave_monitor execution

.github/workflows/ros-tests.yml

@@ -61,6 +61,16 @@ jobs:
         colcon build --packages-up-to r2s_gw
       shell: bash
 
+    - name: Smoke test README commands
+      run: |
+        source /opt/ros/${{ matrix.ros_distro }}/setup.bash
+        source install/setup.bash
+        set -e
+        timeout 10s bash -lc "script -qfec 'ros2 run greenwave_monitor ncurses_dashboard' /dev/null <<< \$'q'" || true
+        timeout 10s bash -lc "script -qfec 'ros2 run greenwave_monitor r2s_gw_dashboard' /dev/null <<< \$'q'" || true
+        timeout 5s ros2 launch greenwave_monitor hz.launch.py topics:='["/topic1"]' || true
+      shell: bash
+
     - name: Run tests
       run: |
         source /opt/ros/${{ matrix.ros_distro }}/setup.bash

README.md

@@ -5,23 +5,23 @@ Greenwave monitor is a tool for runtime monitoring of ROS 2 topics.
 
 It provides the following features:
 
-1. A node that behaves like C++ based ros2 topic hz. I.E. subscribes to topics to determine the frame rate and latency. compared to ro2s topic hs the greenwave node is more performant, publishes ROS2 Diagnostics, and offers services to manage topics and expected frequencies.
+1. A node similar to a C++ based ros2 topic hz. I.E. subscribes to topics to determine the frame rate and latency. compared to ros2 topic hz the greenwave node is more performant, publishes Diagnostics, and offers services to manage topics and expected frequencies.
 
 2. A terminal based dashboard that displays the topic rates, latency, and status, and allows you to add/remove topics and set expected frequencies.
 
 3. A header only C++ library so you can calculate and publish compatible diagnostics directly from your own nodes for reduced overhead.
 
 This diagram shows an overview of the ![architecture](docs/images/greenwave_diagram.png)
 
-## Diagnostics Messages
+## Diagnostic messages
 
-The diagnostics messages published by greenwave monitor are valid ROS2 Diagnostics messages, however the dashboard does rely on specific keys to associate the data with the correct topic, and to display the data in the correct format.
+The diagnostics messages published by greenwave monitor are valid ROS 2 Diagnostics messages, however the dashboard does rely on specific keys to associate the data with the correct topic, and to find frequency and latency data.
 
-In particular, the messages follow conventions from [Isaac ROS NITROS](https://github.com/NVIDIA-ISAAC-ROS/isaac_ros_nitros), which means configured NITROS nodes can be monitored by greenwave monitor frontends without any additional subscriber overhead. For example the drivers from [Isaac ROS NOVA](https://github.com/NVIDIA-ISAAC-ROS/isaac_ros_nova) can be monitored out of the box. Furthermore, you can set ENABLE_GLOBAL_NITROS_DIAGNOSTICS=1 to configure all NITROS nodes to publish diagnostics (more info [here](https://nvidia-isaac-ros.github.io/repositories_and_packages/isaac_ros_nitros/isaac_ros_nitros/index.html)).
+In particular, the messages follow conventions from [Isaac ROS NITROS](https://github.com/NVIDIA-ISAAC-ROS/isaac_ros_nitros), which means configured NITROS nodes can be monitored by greenwave monitor frontends without any additional subscriber overhead. For example the drivers from [Isaac ROS NOVA](https://github.com/NVIDIA-ISAAC-ROS/isaac_ros_nova) can be monitored out of the box. Furthermore, you can set `ENABLE_GLOBAL_NITROS_DIAGNOSTICS=1` to configure all NITROS nodes to publish diagnostics (more info [here](https://nvidia-isaac-ros.github.io/repositories_and_packages/isaac_ros_nitros/isaac_ros_nitros/index.html)).
 
 ## Compatibility
 
-Greenwave monitor is a standalone package tested on Humble, Iron, Jazzy, Kilted, and Rolling ROS2 releases, under Ubuntu 22.04 and Ubuntu 24.04. It does not depend on Isaac ROS.
+Greenwave monitor is a standalone package tested on Humble, Iron, Jazzy, Kilted, and Rolling ROS 2 releases, under Ubuntu 22.04 and Ubuntu 24.04. It does not depend on Isaac ROS.
 
 ## Installation
 
@@ -31,7 +31,7 @@ cd ros_ws/src
 git clone https://github.com/NVIDIA-ISAAC-ROS/greenwave_monitor.git
 cd ..
 colcon build --packages-up-to greenwave_monitor
-source install/setup.sh
+source install/setup.bash
 ```
 
 ## Usage
@@ -61,9 +61,8 @@ First you need to build the r2s_gw package and some additional dependencies, r2s
 ```bash
 cd ros_ws/
 colcon build --packages-up-to r2s_gw
-pip install -I textual # There is a requirements file in the r2s_gw package, but in case you installed from debian and that's not handy ...
-source install/setup.sh
-ros2 run greenwave_monitor r2s_gw_dashboard
+pip install -I textual # There is a requirements.txt file in the r2s_gw package, but in case you installed from debian and that's not handy ...
+source install/setup.bash
 ```
 
 Then you can launch the dashboard with the following. Use tab to navigate between different UI elements.
@@ -75,7 +74,7 @@ ros2 run greenwave_monitor r2s_gw_dashboard
 Just like before, you can also launch the dashboard with some demo publishers to see everything in action.
 
 ```bash
-ros2 run greenwave_monitor r2s_gw_dashboard --demo
+ros2 run greenwave_monitor r2s_gw_dashboard -- --demo
 ```
 
 ### Manual Launch (ros2 topic hz mode)