Skip to content

Commit

Permalink
Doc update (#59)
Browse files Browse the repository at this point in the history
  • Loading branch information
Yachtie2020 authored Nov 11, 2020
1 parent c153b9f commit 1cabd13
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# signalk-to-nmea0183
Signal K Node server plugin to convert Signal K to NMEA 0183. See the code for a list of supported sentences.

To use the plugin you need to ctivate the plugin and the relevant sentences in server's Admin interface. This will make the conversion results available over the server's Tcp server on port 10110.
To use the plugin you need to activate the plugin and the relevant sentences in server's Admin interface. This will make the conversion results (NMEA 0183) available on Signalk's built-in TCP NMEA 0183 server (Port 10110).

As the plugin automatically sends NMEA 0183 data to Signalk's built-in TCP NMEA 0183 server, it is possible to have access to the NMEA 0183 strings without configuring anything (Aka a serial output device) by connecting to port 10110 with a TCP client (e.g. OpenCPN, Netcat, kplex etc)

If you want to output the conversion result into a serial connection you need to configure the serial connection in the server's Admin interface and add an extra line to the `settings.json`, specifying that the serial connection should output the plugin's output:

Expand Down Expand Up @@ -38,9 +40,9 @@ If you want to output the conversion result into a serial connection you need to
}
```

Internally the plugin emits events named `nmea0183out`. This configuration sends the data of these events to the serialport's output.
Note: Internally the plugin emits the converted NMEA 0183 messages as `Events` under the event identifier `nmea0183out`. The above configuration sends the converted data (NMEA 0183) under the `nmea0183out` events identifier to the serialport's output.

Be aware the data is sent by default to TCP port 10110 in which case it is possible to have access to the generated NMEA strings without configuring a serial output device by connecting to port 10110 with a TCP client (e.g. OpenCPN, Netcat, kplex etc)
Troubleshooting: If you cannot connect to Signalk's built-in TCP NMEA 0183 server, ensure it is enabled. To verify the TCP NMEA 0183 server is enabled go to Signalk's Dashboard, then Server->Settings->Interfaces->nmea-tcp .

![image](https://user-images.githubusercontent.com/1049678/63366888-64283700-c383-11e9-9a5f-7f9975e007f3.png)

0 comments on commit 1cabd13

Please sign in to comment.