search

SignalK / signalk-to-nmea0183

Signal K Node server plugin to convert Signal K to NMEA 0183
Apache License 2.0
13 stars 28 forks source link

Doc update #59

Closed Yachtie2020 closed 4 years ago

Yachtie2020 commented 4 years ago

Updated README.md to make references to the built-in NMEA 0183 server and changed wording/layout.

tkurki commented 4 years ago

Hmmm. I appreciate the effort, but your update has some problems:

Yachtie2020 commented 4 years ago

Hmmm. I appreciate the effort, but your update has some problems:

  • as the tcp server on port 10110 is enabled by default I don't think the wording is correct here: it does not need to be enabled. If you feel this should be added here you should fix wording
  • underneath the hood there are concepts named streams and events. the plugin does not use streams for output, so I don't want to use that word here

Yes I can fix wording for first issue.

It took me awhile to work out the difference between nmea0183 vs nmea0183out etc and what it was, because the wording on different sites was different (probably indication wording isn’t great). Once I realized to view it as a stream it made sense to me. All NMEA 0183 events/msgs being received by a NMEA 0183 data source are piped into the stream nmea0183 for use throughout Signalk. nmea0183out stream was for NMEA 0183 not received via data source, it was the output generated from this plugin. I will edit wording to remove word stream.

Cheers