README
¶
Argo
Argo is a Signal K compliant server written in Go. The goal of Argo is to consume as many different sources of data as possible and convert them to Signal K on as many different transports as possible.
It currently supports WebSockets, ZeroMQ and MQTT transports and ingestion of NMEA 2000 data using an Actisense NGT-1 NMEA 2000 to USB converter or a Lawicel CAN-USB adapter. It can also read CANboat JSON from a file.
Installation
If you don't have go, you'll need to install it first. See the golang Getting
Started guide for information. On Debian/Ubuntu
systems apt-get install golang may be sufficient.
After that, you can install argo. Go has some opinions on how you should manage your source code workspaces, so use the commands below to get the paths right.
$ cd $GOPATH/src
$ git clone git@github.com:timmathews/argo github.com/timmathews/argo
$ cd github.com/timmathews/argo
$ ./build.sh
$ sudo ./build.sh --install
If you're not interested in hacking on Argo, then just run
go get github.com/timmathews/argo. Argo will be installed in $GOPATH/bin.
By default, argo will try to use /dev/ttyUSB0 for the Actisense NGT-1, but you
can change this by calling argo with a specific device like argo /dev/ttyUSB3.
There are utility scripts in the canusb and actisense folders which will
install udev rules for those devices. You probably won't need these, but if for
some reason your distro doesn't recognize the vendor IDs for those devices,
these scripts can help.
Other Platforms
You can cross compile for other platforms by setting the GOARCH environment
variable.
MIPS (OpenWRT and lots of routers):
$ export GOARCH=mips GOARCH=softfloat
ARM (Raspberry Pi and clones):
$ export GOARCH=arm GOARM=7
If your target OS is not the same as your host OS (e.g. you're compiling on Mac
and targeting a Raspberry Pi), be sure to also set GOOS.
$ export GOOS=linux
Notes
You shouldn't need to install the libzmq-dev package any longer, but if your
build fails, then sudo apt install libzmq-dev may help.
TODO
- Daemonize argo and write an upstart script for it
- Better Signal K support
- Simplify commandline arguments and move more settings into the config file
- Set the default path for the config file to /etc
- Add support for reading raw CAN packet captures in Actisense and CANUSB formats (maybe others)
- Add SocketCAN support
- Web GUI for configuration
- CLI for configuration
Directories