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
+23-15Lines changed: 23 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,11 +53,9 @@ source install/setup.bash
53
53
54
54
## Usage
55
55
56
-
Greenwave monitor provides two dashboard frontends, a lightweight ncurses interface and a rich terminal interface (a fork of [r2s](https://github.com/mjcarroll/r2s)). Note we rename the fork r2s_gw to avoid conflicts with the original r2s package.
56
+
Greenwave monitor provides a lightweight ncurses dashboard for monitoring topics. An optional rich TUI (r2s integration) with additional features is also available as a separate package.
57
57
58
-
We have found that the r2s dashboard gets sluggish when there are many topics, so we recommend using the ncurses dashboard for large deployments.
59
-
60
-
### ncurses Dashboard (Lightweight)
58
+
### ncurses Dashboard
61
59
62
60
After installing, you can launch the ncurses dashboard with:
63
61
@@ -71,27 +69,37 @@ You can also launch the dashboard with some demo publishers to see everything in
71
69
ros2 run greenwave_monitor ncurses_dashboard --demo
72
70
```
73
71
74
-
### r2s_gw Dashboard (Rich TUI)
72
+
### Rich TUI (r2s integration) - Optional
73
+
74
+
For users who want an advanced, feature-rich terminal interface, **r2s_gw** is available as a separate package. Built on the excellent [r2s](https://github.com/mjcarroll/r2s) TUI framework and powered by [Textual](https://github.com/textualize/textual/), r2s_gw provides a beautiful, modern interface with enhanced navigation and visualization capabilities.
75
75
76
-
First you need to build the r2s_gw package and some additional dependencies, r2s_gw is included in the greenwave_monitor package.
76
+
**r2s_gw** is perfect for interactive development and debugging sessions. For production deployments with many topics or minimal dependency requirements, the lightweight ncurses dashboard above is recommended.
77
77
78
+
To use r2s_gw:
79
+
80
+
1. Clone the r2s_gw repository into a workspace:
78
81
```bash
79
-
cd ros_ws/
80
-
colcon build --packages-up-to r2s_gw
81
-
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 ...
0 commit comments