Skip to content

Commit

Permalink
Add docs page for NMEA publisher
Browse files Browse the repository at this point in the history
  • Loading branch information
sindrehan committed Oct 9, 2024
1 parent 653d031 commit 0036944
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/nmea-publisher.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# NMEA Position Publisher

This example shows how one can use the blueye.sdk to forward position messages from the drone as NMEA 0183 messages, eg. to use in a chart plotter on a boat, etc.

The script performs the following steps:

1. **UDP Configuration**: Sets up the UDP IP and port for sending NMEA messages. If your receiver expects to receive data on a different port you need to change it here
2. **Drone Connection**: Establishes a connection to the Blueye drone.
3. **Callback Registration**: Registers a callback function to handle position estimate telemetry messages.
4. **Main Loop**: Keeps the script running to continuously receive and send messages.

{{code_from_file("../examples/nmea_publisher.py", "python")}}
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ nav:
- "Subscribing to a telemetry message": "telemetry-callback.md"
- "Peripherals": "peripherals.md"
- "Visualizing with Foxglove": "foxglove-bridge.md"
- "Forwarding positioning to NMEA": "nmea-publisher.md"
- "Updating from v1 to v2": "migrating-to-v2.md"
- "Protobuf protocol": "protobuf-protocol.md"
- "HTTP API": "http-api.html"
Expand Down

0 comments on commit 0036944

Please sign in to comment.