signalk-walkthedock
v0.1.1
Published
Syncs vessel position and instrument data to WalkTheDock — position, speed, heading, wind, and depth pushed over Starlink or marina Wi-Fi.
Maintainers
Readme
signalk-walkthedock
A SignalK server plugin that syncs your vessel's live position and instrument data to WalkTheDock — a directory and community for cruising boaters in the Pacific Northwest and Alaska.
Pushes position, speed, heading, wind, and depth to your WalkTheDock boat listing whenever internet is available (Starlink, marina Wi-Fi, cellular). Retries silently when offline.
What it sends
| Data | SignalK path |
|---|---|
| Position (lat/lng) | navigation.position |
| Speed over ground | navigation.speedOverGround |
| Course over ground | navigation.courseOverGroundTrue |
| True heading | navigation.headingTrue |
| Speed through water | navigation.speedThroughWater |
| True wind speed | environment.wind.speedTrue |
| True wind direction | environment.wind.directionTrue |
| Depth below keel | environment.depth.belowKeel |
Only paths that are actually available on your vessel are sent — missing instruments are silently skipped.
Installation
Via SignalK App Store (recommended)
In your SignalK admin UI go to App Store, search for walkthedock, and click Install.
Manual
cd ~/.signalk
npm install signalk-walkthedockThen restart SignalK.
Setup
- Go to your boat listing on WalkTheDock
- In the Vessel Tracking widget, select SignalK or SignalK + AIS Backup
- Click Generate Token and copy the token
- In SignalK admin → Plugin Config → WalkTheDock, paste:
- Site URL —
https://walkthedock.com - Auth Token — the token you copied
- Site URL —
- Set your preferred push interval (default 30 s) and enable the plugin
The plugin status line will show the last successful sync time and coordinates.
Requirements
- SignalK Server 2.x or later
- Node.js 16 or later
- A WalkTheDock account with a boat listing
License
MIT
