An implementation of a Signal K server for vessels. Intended to run on embedded devices (e.g. Raspberry Pi, Beaglebone or UDOO).
The Server acts as a multiplexer/aggregator of the SignalK streams input by one or more Providers. The merged SignalK data is available in streaming format over a WebSocket connection and via a REST interface.
Prerequisites
- node and npm installed
See these instructions for Node installation on Raspberry Pi.
Get the repo with either git clone https://github.com/SignalK/signalk-server-node.git
or as a simple zip file from https://github.com/SignalK/signalk-server-node/archive/master.zip and extract it.
Go to the directory where you put the downloaded code and install dependencies with
npm install
```
[Firewall giving you trouble?](https://github.com/npm/npm/wiki/Troubleshooting#npm-only-uses-git-and-sshgit-urls-for-github-repos-breaking-proxies)
Start the server with
```
bin/nmea-from-file
```
This will start the server with a sample configuration file and the server will start playing back set of [NMEA 0183](http://en.wikipedia.org/wiki/NMEA_0183) data from file. The data is available immediately via the REST interface at http://localhost:3000/signalk/api/v1/.
A simple way to connect to the WebSocket interface from the command line is to install wscat and use that:
```
npm install -g wscat
wscat --connect 'ws://localhost:3000/signalk/stream/v1?stream=delta'
If you want to use NMEA2000 data you need at least Canboat analyzer to parse NMEA 2000 data to json and Canboat actisense-serial for getting live data from Actisense NGT-1.
If you have analyzer available on your PATH you can start the server with a sample NMEA2000 data file with bin/n2k-from-file.
For getting live data from your NGT-1 you need to figure out what device path your device is mounted on, edit the configuration file to match you path and start server with bin/n2k-from-actisense.
If you have your own n2k data file you can use that with bin/n2k-from-file --n2kfilename your-file-name.
Once you have the data streams in place you probably want to use the data or at least see it in a nice format. See Consumers for details.
Bonjour support is not activated by default, because it requires operating system support that is not present by default on all platforms. You can enable it by installing mdns with npm install mdns issued in the server's root folder. See also https://github.com/agnat/node_mdns#installation for more information.
Once Bonjour is enabled the server advertises itself via Bonjour. This means that Bonjour-aware software running in the same network can discover the Signal K server and access it. For example the server shows up in Safari at Bookmarks => Bonjour => Webpages.
You can disable Bonjour/mDNS by adding the entry "mdns": false to the config file. See settings/volare-gpsd-settings.json for example.
Copyright [2015] [Fabian Tollenaar, Teppo Kurki and SignalK committers]
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.