Haddock

CLI tools for tracking your Sailaway voyages, or connecting them to external charting/routing applications via NMEA.

HADDOCK

Queries the Sailaway servers for information on your boats, and logs their position and other relevant information to a locally-stored log.

You can:

• browse your logbooks
• plot your boats' position using OpenSeaMap or EarthWindMap
• send NMEA sentences from one boat to an external charting application like qtVlm or OpenCPN, via a TCP server.

While running, the application will automatically update every 10 minutes.

usage: haddock [<port number>]

OPTIONAL: <port number> specifies the port number for the NMEA TCP server (11010 by default).

NMEA

The NMEA server only. Select one of your boats to start a TCP server and send NMEA sentences to an external charting application. (The server will also continue to update your logbooks in the background.)

usage: nmea [<port number>] [<boat number>]

OPTIONAL: <port number> specifies the port number for the NMEA TCP server (11010 by default).

OPTIONAL: <boat number> specifies the boat number for which to immediately launch a NMEA server.

Other commands

logmgr

Manage your locally-stored sailing logbooks. You can delete entries for any defunct boats, or wipe the logs entirely.

How to install

1. Download and install the latest release of Python 3.

2. Download the latest release of Haddock, and unzip it to a directory of your choice, e.g. ~/haddock.

3. Log into your Sailaway account and copy the URL below the line that reads "API access to all sailing related parameters of your boats."

4. From the command line, change to your Haddock directory and run install. When prompted, paste your Sailaway API URL into the terminal window, and press return. It should look something like this:

~/haddock $ ./install

Installing haddock...

Paste your Sailaway API URL here, then press return:
http://srv.sailaway.world/cgi-bin/sailaway/APIBoatInfo.pl?usrnr=69669&key=ZSDDSJBVNSDNNOTMYKEYDONTUSEME

Done! Run "haddock" to begin.

(Don't worry—if you mess it up, you can always run install again to start over.)

5. Haddock has been successfully installed! You can run haddock or nmea to get started.

Dependencies

• Python 3
• rich

Acknowledgements

• U.S. Department of State Office of the Geographer - World Water Body Limits Data Set