This package is designed to transport signalk messages over mqtt multiple messages are bundled together and then compressed and encrypted.
To install this package clone it from git and run npm install, this needs to happen on both the client and the server.
git clone https://github.com/codekilo/signalk-cloud-transport.git
cd signalk-cloud-transport
sudo npm -g install
run signalk-cloud-tx in a directory that also has the config/ directory
run signalk-cloud-rx in a directory that also has the config/ directory. This config file should contain the token for the websocket connection if required.
To generate a token to connect to a signalk server with security enabled see the signalK specification.
The configuration for the transmitter is in config/transmitter/default.json. The configuration for the receiver is located in config/receiver/default.json.
The following options are shared by both the transmitter and receiver.
The IP address of the signalk server.
The port of the signalk server
The mqtt topic the messages will appear on
The address of the mqtt broker.
the password to derive the key from.
The maximum size of the buffer in bytes, the message will be transmitted when the buffer is full.
The maximum time between two messages in seconds.
If true send data about all known vessels, when false only send data about the own vessel.
An array of paths to include in messages, paths can inlcude * as wildcard.
The token used to connect to the signalk server (optional). To generate a token see the signalk documentation.