BluEye-Robotics / blueye.sdk

A Python package for remote control of Blueye underwater drones.
GNU Lesser General Public License v3.0
17 stars 4 forks source link

Foxglove bridge example #165

Closed aviggen closed 1 month ago

aviggen commented 1 month ago

Description This PR makes it possible to visualize live telemetry data in Foxglove when connected to a drone. A great addition for students working with the SDK, and also internally for debugging and testing.

The example script foxglove_bridge_ws.py is using the drone object from the SDK to connect to the drone, and a web socket server provided by foxglove to forward the messages. With Foxglove it's now possible to subscribe to the web socket server on ws://localhost:8765 and visualize all the messages coming from the drone.

A new page on how to use it is also added to the docs.

Checklist before merging

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 73.83%. Comparing base (30a484f) to head (dea8b46).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #165 +/- ## ======================================= Coverage 73.83% 73.83% ======================================= Files 11 11 Lines 1265 1265 ======================================= Hits 934 934 Misses 331 331 ``` | [Flag](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/165/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | Coverage Δ | | |---|---|---| | [macos-latest_3.10](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/165/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | `73.83% <ø> (ø)` | | | [macos-latest_3.11](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/165/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | `73.83% <ø> (ø)` | | | [macos-latest_3.12](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/165/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | `73.83% <ø> (ø)` | | | [macos-latest_3.9](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/165/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | `73.81% <ø> (?)` | | | [ubuntu-latest_3.10](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/165/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | `73.83% <ø> (?)` | | | [ubuntu-latest_3.11](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/165/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | `73.83% <ø> (ø)` | | | [ubuntu-latest_3.12](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/165/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | `73.83% <ø> (ø)` | | | [ubuntu-latest_3.9](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/165/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | `73.81% <ø> (ø)` | | | [windows-latest_3.10](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/165/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | `73.81% <ø> (ø)` | | | [windows-latest_3.11](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/165/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | `73.81% <ø> (ø)` | | | [windows-latest_3.12](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/165/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | `73.81% <ø> (ø)` | | | [windows-latest_3.9](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/165/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | `73.79% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

follesoe commented 1 month ago

@aviggen Don't leave this one hanging 😿 😮‍💨