Skip to content

Commit

Permalink
doc: amendments based on PR comments
Browse files Browse the repository at this point in the history
  • Loading branch information
tkurki committed Sep 8, 2024
1 parent a4177d1 commit a1b5e45
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/src/setup/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,15 +46,15 @@ Please refer to the [Canboat PGN database](https://canboat.github.io/canboat/can

#### NMEA 0183 Options

- _Suppress nmea0183out event_ - All incoming NMEA0183 data is made available over TCP on port 10110 by default. This happens by incoming data emitting _nmea0183out_ event. Suppressing the event will prevent data from this connection to being routed to TCP.
- _Suppress nmea0183 event_ - All incoming NMEA0183 data is made available over TCP on port 10110 by default. This happens by incoming data being emitted as _nmea0183_ events. Selecting this option will prevent data from this connection appearing on the NEMA0183 TCP service.

- _Input Event_ - All incoming data is being emitted as _nmea0183_ and _nmea0183out_ events by default, but with these events you can not distinguish between input from multiple NMEA 0183 connections. By adding your own input event you can process data from this connection specifically.
- _Input Event_ - By default, data received on this connection will cause the nmea0183 event to be emitted. In order to distinguish input from this connection from other NMEA 0183 connections, enter an input event name which will be emitted (in addition to the nmea0183 event) when data is received on this connection.

- _Validate checksum_ - Usually [NMEA 0183 sentences](https://en.wikipedia.org/wiki/NMEA_0183) contain a checksum that can be used to check that the data is not garbled so that erroneous data is discarded. However some data sources do not include the checksum or it is simply wrong. Unchecking this option will disable validating the checksum.

- _Append Checksum_ - See previous point. Some data sources do not include a checksum, but for example a mobile app you are using may require them. Activating this option will add checksums to the data.

- _Remove NULL characters_ - Some data sources include superfluous NULL characters in the input data stream, making the data invalid for consumption. This option will remove the NULL characters. It causes a bit of extra processing, so not on by default.
- _Remove NULL characters_ - Some data sources include superfluous NULL characters in the input data stream, making the data invalid for consumption. This option will remove the NULL characters. It causes additional processing, so not on by default.

- _Ignored Sentences_ - NMEA0183 sentences to throw away from the input data. Sometimes you may want to ignore certain sentences from a connection, because the data is invalid or missing or just not needed.

Expand Down

0 comments on commit a1b5e45

Please sign in to comment.