protocol

nmea_protocol

Protocol for parsing NMEA 0183 sentences and projecting supported sentence types into typed semantic terms.

Availability:
logtalk_load(nmea(loader))
Author: Paulo Moura
Version: 2:0:0
Date: 2026-07-13
Compilation flags:
static
Dependencies:
(none)
Remarks:
(none)
Inherited public predicates:
(none)

Public predicates

parse/2

Parses NMEA sentences from a source specification into canonical raw sentence terms. Supported source specifications are atom(Atom), chars(List), codes(List), stream(Stream), and file(Path).

Compilation flags:
static
Template:
parse(Source,Sentences)
Mode and number of proofs:
parse(++compound,--list(compound)) - one_or_error
Exceptions:
Source is a variable or contains a variable source argument:
instantiation_error
Source is neither a variable nor a valid source specification:
domain_error(nmea_source,Source)
Source is a valid source specification but contains a line that cannot be parsed as a sentence:
domain_error(nmea_sentence,Line)

parse/3

Parses NMEA sentences from a source specification using parser options. Supported options are checksum(required), checksum(optional), checksum(ignore), unknown_type(keep), and unknown_type(error).

Compilation flags:
static
Template:
parse(Source,Sentences,Options)
Mode and number of proofs:
parse(++compound,--list(compound),++list(compound)) - one_or_error
Exceptions:
Source is a variable or contains a variable source argument:
instantiation_error
Source is neither a variable nor a valid source specification:
domain_error(nmea_source,Source)
Source is a valid source specification but contains a line that cannot be parsed as a sentence:
domain_error(nmea_sentence,Line)
Options is a variable or a partial list:
instantiation_error
Options is neither a variable nor a list:
type_error(list,Options)
An element Option of the list Options is neither a variable nor a compound term:
type_error(compound,Option)
An element Option of the list Options is a compound term but not a valid option:
domain_error(option,Option)

talker/2

Returns the normalized talker identifier for a parsed sentence. Proprietary sentences use the atom proprietary.

Compilation flags:
static
Template:
talker(Sentence,Talker)
Mode and number of proofs:
talker(+compound,-atom) - one

sentence_type/2

Returns the normalized sentence type identifier for a parsed sentence.

Compilation flags:
static
Template:
sentence_type(Sentence,Type)
Mode and number of proofs:
sentence_type(+compound,-atom) - one

fields/2

Returns the lossless ordered list of sentence fields after the sentence identifier.

Compilation flags:
static
Template:
fields(Sentence,Fields)
Mode and number of proofs:
fields(+compound,-list(atom)) - one

checksum/2

Returns the checksum information as checksum(Provided,Computed) where Provided is either a normalized two-digit hexadecimal atom or missing.

Compilation flags:
static
Template:
checksum(Sentence,Checksum)
Mode and number of proofs:
checksum(+compound,-compound) - one

data/2

Projects a parsed sentence into a typed semantic term for the supported sentence types gga, rmc, gsa, gsv, vtg, and gll.

Compilation flags:
static
Template:
data(Sentence,Data)
Mode and number of proofs:
data(+compound,-compound) - zero_or_one

Protected predicates

(none)

Private predicates

(none)

Operators

(none)