olcai / ais-logger

A simple viewer and logger for data received by AIS-transponders or AIS-receivers.
16 stars 8 forks source link

AIS Logger

AIS Logger is a simple viewer and logger for data received by AIS-transponders or -receivers.

In summary:

Features

Status

The software is quite stable for daily use, but has some rough edges. The GUI is not as friendly as it could be with regards to helpful error messages and wizards. There are also a few GUI problems when running on *nix systems, but it is usable.

Dependencies

AIS Logger has a few, but large, dependencies that needs to be installed in order to use it. All of these should be readily available in package repositories on *nix systems. If you plan to use AIS Logger under Windows, please use a release binary as they are mostly self contained (see the install instructions below).

These are the run-time dependencies:

Installing

Uninstalling

Configuring

When running on Windows and saving the configuration file, you can safely save the configuration file to the program directory.

Under *nix, you cannot save the configuration file directly to the suggested directory because you don't have permission to write to the AIS Logger directory. Please save the configuration file in your home directory and start the program with the -c switch and the config file:

    $ aislogger -c myconfigfile.ini

Building on Windows

To build AIS Logger on Windows, first install all dependencies given above. You will also need to install py2exe to build the distribution (any modern version should do).

Extract the source archive to a directory. Then run the following command:

    > python setup.py py2exe

You may need to use the full path to your python installation if it's not in your $PATH. The result of the build is now in the directory "dist" and is ready to run and distribute.

Known issues

Questions, comments or code

Background information on AIS

Automatic Identification System is a system used to identify and locate maritime vessels. Transponders automatically broadcast information via a VHF transceiver, so called “messages”, containing data such as the vessels current position, heading, speed, name and radio callsign. To receive these messages you will need either a full-fledged transponder or a special receiver that communicate with a computer through a serial interface. In theory, you could use a standard VHF-scanner and a sound card to intercept AIS messages, but this is currently not supported in AIS Logger. For this you could try GNU AIS instead.

External code in AIS Logger

The following code is used by, and distributed with, AIS Logger but is externally developed: