Skip to content

Commit

Permalink
Add description for foxglove docker
Browse files Browse the repository at this point in the history
  • Loading branch information
aviggen committed Sep 2, 2024
1 parent 7fc7d5c commit 0772f3b
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/foxglove-bridge.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,14 @@ With some simple steps you can visualize live sensor data from the drone in Foxg
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.

### Alternative with Docker
We have also provided a docker container that you can use to automatically starts the blueye-foxglove server.
1. Pull the image:
- `docker pull blueyerobotics/foxglove-bridge`
2. Run the image in a container with port 8765 open:
- `docker run --rm -p 8765:8765 blueyerobotics/foxglove-bridge`
3. Connect as above in step 5.

### 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`.

Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ nav:
- "Legacy log file format": "logs/legacy-log-file-format.md"
- "Configure drone parameters": "configuration.md"
- "Subscribing to a telemetry message": "telemetry-callback.md"
- "Live plotting with Foxglove": "foxglove-bridge.md"
- "Peripherals": "peripherals.md"
- "Visualizing with Foxglove": "foxglove-bridge.md"
- "Updating from v1 to v2": "migrating-to-v2.md"
Expand Down

0 comments on commit 0772f3b

Please sign in to comment.