0.1.0 • Published 5 years ago

@ntrip/nmea v0.1.0

Weekly downloads
-
License
LGPL-3.0-or-later
Repository
github
Last release
5 years ago

NMEA-0183 Decoder/Encoder

Decoder/encoder for NMEA-0183 message types.

Basic Usage

Decoding

let buffer: string = ...; // String containing NMEA sentence
let message: NmeaMessage = NmeaTransport.decode(buffer);

Encoding

let message = ...; // Message to be encoded
let buffer: string = NmeaTransport.encode(message);

Streams

Built in transform streams to convert from NmeaMessages to sentence strings and vice-versa.

let input: stream.Readable = ...;
let output: stream.Writable = ...;
input                                      // Stream of sentence strings
    .pipe(new NmeaDecodeTransformStream()) // Stream of NmeaMessage objects
    .pipe(new NmeaEncodeTransformStream()) // Stream of (identical) sentence strings
    .pipe(output);

NmeaDecodeTransformStream can optionally synchronize with the data stream e.g. if it starts receiving data from the middle of a message.

Messages Supported

  • DTM (NmeaMessageDtm)
  • GBS (NmeaMessageGbs)
  • GGA (NmeaMessageGga)
  • GLL (NmeaMessageGll)
  • GNS (NmeaMessageGns)
  • GRS (NmeaMessageGrs)
  • GSA (NmeaMessageGsa)
  • GST (NmeaMessageGst)
  • RMC (NmeaMessageRmc)
  • TXT (NmeaMessageTxt)
  • VLW (NmeaMessageVlw)
  • VTG (NmeaMessageVtg)
  • ZDA (NmeaMessageZda)

License

LGPL

0.1.0

5 years ago