Skip to content

Commit 54bf841

Browse files
committed
updated readme
1 parent 0c5df0c commit 54bf841

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

src/wr_hci_hud/README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,16 @@
33
@defgroup wr_hci_hud wr_hci_hud
44
@brief A package (currently empty) to act as a HUD for drivers
55

6-
This package was intended to be a display for the current state of the rover and act as an interface. This node has never had any code.
6+
# To start the GUI
7+
8+
Run test.py in wr_hci_hud/src
9+
run roscore
10+
run roslaunch rosbridge_server rosbridge_websocket.launch
11+
12+
# Video streaming
13+
for webRTC Streaming, might require more steps. WebRTC isn't implemented fully yet.
14+
Plan to use https://wiki.ros.org/web_video_server for video streaming for now
15+
716

817
## History
918

@@ -44,3 +53,4 @@ Ideas for this node have gone through several iterations. None of the following
4453
* Little to no visual support outside of `rqt`
4554

4655
Given past experience at competition, even a small GUI with no input options (a literal HUD) would be massively beneficial compared to reading individaul diagnostics one at a time. This could then be expanded to provide more detailed insights, inputs to the WRover, and specializations for the different competition modes.
56+

0 commit comments

Comments
 (0)