From 0772f3b64d86c7335a4f53fe198e254e3128932a Mon Sep 17 00:00:00 2001 From: Andreas Viggen Date: Mon, 2 Sep 2024 17:08:49 +0200 Subject: [PATCH] Add description for foxglove docker --- docs/foxglove-bridge.md | 8 ++++++++ mkdocs.yml | 1 + 2 files changed, 9 insertions(+) diff --git a/docs/foxglove-bridge.md b/docs/foxglove-bridge.md index e8ef9703..156861e1 100644 --- a/docs/foxglove-bridge.md +++ b/docs/foxglove-bridge.md @@ -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`. diff --git a/mkdocs.yml b/mkdocs.yml index 684d159f..0232ba6b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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"