Skip to content

Commit

Permalink
Update Foxglove docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sindrehan committed Sep 2, 2024
1 parent dea8b46 commit 4366d22
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions docs/foxglove-bridge.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,13 @@ With some simple steps you can visualize live sensor data from the drone in Foxg

1. Download foxglove [here](https://foxglove.dev/download) and create an account.
2. Power on the drone and connect your computer to the Blueye wifi.
3. Run `pip install foxglove_websocket` in your pyenv.
4. In the examples folder you simply run the foxglove_bridge_ws.py.
3. Run `pip install "blueye.sdk[examples]"` to get the necessary dependencies, if you have not done so already.
4. Clone the [blueye.sdk repository](https://github.com/BluEye-Robotics/blueye.sdk) to get the examples, or copy the script below into a file. In the examples folder you simply run `python foxglove_bridge_ws.py` to start the bridge.
5. Open foxglove and open a new `Foxglove WebSocket` connection and leave it on default (`ws://localhost:8765`).
6. Add panel, Raw message, or Plot and select the topic you want to display.

How it works. The `foxglove_bridge_ws.py` script is using the Blueye SDK to subscribe to the drone telemetry messages with `ZeroMQ`. Then the foxglove websocket server is forwarding the protobuf messages so they can be subscribed to in the `Foxglove GUI`.
### How it works
The script below uses the Blueye SDK to subscribe to the drone telemetry messages with `ZeroMQ`. Then the foxglove websocket server is forwarding the protobuf messages so they can be subscribed to in the `Foxglove GUI`.

View the script here: [foxglove_bridge_ws.py](../examples/foxglove_bridge_ws.py)
### Example of a websocket bridge
{{code_from_file("../examples/foxglove_bridge_ws.py", "python")}}

0 comments on commit 4366d22

Please sign in to comment.