Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: clarify default TCP output #38

Merged
merged 1 commit into from
Jul 23, 2019
Merged

docs: clarify default TCP output #38

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Signal K Node server plugin to convert Signal K to NMEA 0183. See the code for a

To use the plugin you need to
1. activate the plugin and the relevant sentences under /plugins/configure (see image below)
2. add a configuration `toStdout` to the `serialport` you want the sentences to go to
2. add a configuration to the pipedProviders section of the .signalk/settings.json file. Add a `toStdout` to the `serialport` where you want the sentences to go as per the example below.

```
...
Expand All @@ -20,7 +20,9 @@ To use the plugin you need to
...
```

Internally the plugin emits events named `nmea0183out`. This configuration sends the data of these events to the serialport's output.
Internally the plugin emits events named `nmea0183out`. This configuration sends the data of these events to the serialport's output.

Be aware the data is also 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)



Expand Down