nmea0183-signalk
Advanced tools
NMEA0183 to Signal K (signalk.github.io) Parser.
(I still need to write proper documentation, but this should be sufficient for now)
Single line mode
$ nmea-signalk --line '$GPRMC,085411.000,A,5222.3215,N,00454.5778,E,0.58,251.34,030414,,,A*63'
$
// OUTPUT EXAMPLE:
// {"self":"a34af45a","vessels":{"a34af45a":{"source":{"type":"NMEA0183","label":"signalk/nmea-signalk"},"timestamp":"2014-05-06T15:52:31.990Z","uuid":"a34af45a","navigation":{"courseOverGroundTrue":{"source":{"type":"NMEA0183","sentence":"RMC","device":"nmea-signalk"},"timestamp":"2014-05-03T08:54:11.000Z","value":251.34},"location":{"latitude":52.372025,"longitude":4.90963,"source":{"type":"NMEA0183","sentence":"RMC","device":"nmea-signalk"},"timestamp":"2014-05-03T08:54:11.000Z"},"magneticVariaton":{"source":{"type":"NMEA0183","sentence":"RMC","device":"nmea-signalk"},"timestamp":"2014-05-03T08:54:11.000Z","value":0},"speedOverGround":{"source":{"type":"NMEA0183","sentence":"RMC","device":"nmea-signalk"},"timestamp":"2014-05-03T08:54:11.000Z","value":0.58}}}},"version":"2.0","timestamp":"2014-05-06T15:52:31.990Z","source":{"type":"NMEA0183","label":"signalk/nmea-signalk"}}
Usage in piped mode
$ tail -n 1000 gps.log | nmea-signalk
$
// OUTPUT EXAMPLE:
// {"self":"a34af45a","vessels":{"a34af45a":{"source":{"type":"NMEA0183","label":"signalk/nmea-signalk"},"timestamp":"2014-05-06T15:51:30.241Z","uuid":"a34af45a","navigation":{"courseOverGroundTrue":{"source":{"type":"NMEA0183","sentence":"RMC","device":"nmea-signalk"},"timestamp":"2014-05-03T09:14:11.000Z","value":28.17},"location":{"latitude":52.371901666666666,"longitude":4.90974,"source":{"type":"NMEA0183","sentence":"RMC","device":"nmea-signalk"},"timestamp":"2014-05-03T09:14:11.000Z"},"magneticVariaton":{"source":{"type":"NMEA0183","sentence":"RMC","device":"nmea-signalk"},"timestamp":"2014-05-03T09:14:11.000Z","value":0},"speedOverGround":{"source":{"type":"NMEA0183","sentence":"RMC","device":"nmea-signalk"},"timestamp":"2014-05-03T09:14:11.000Z","value":0.18},"gnss":{"source":{"type":"NMEA0183","sentence":"GGA","device":"nmea-signalk"},"timestamp":"2014-06-06T09:14:00.000Z","quality":1,"satellites":8,"antennaAltitude":1,"horizontalDilution":0,"geoidalSeparation":47,"differentialAge":0,"differentialReference":0},"position":{"source":{"type":"NMEA0183","sentence":"GGA","device":"nmea-signalk"},"timestamp":"2014-06-06T09:14:00.000Z","longitude":52.371903333333336,"latitude":4.909741666666667}}}},"version":"2.0","timestamp":"2014-05-06T15:51:30.123Z","source":{"type":"NMEA0183","label":"signalk/nmea-signalk"}}
// [...]
Usage with file input
$ nmea-signalk -f gps.log
$
// OUTPUT EXAMPLE:
// {"self":"a34af45a","vessels":{"a34af45a":{"source":{"type":"NMEA0183","label":"signalk/nmea-signalk"},"timestamp":"2014-05-06T15:51:30.241Z","uuid":"a34af45a","navigation":{"courseOverGroundTrue":{"source":{"type":"NMEA0183","sentence":"RMC","device":"nmea-signalk"},"timestamp":"2014-05-03T09:14:11.000Z","value":28.17},"location":{"latitude":52.371901666666666,"longitude":4.90974,"source":{"type":"NMEA0183","sentence":"RMC","device":"nmea-signalk"},"timestamp":"2014-05-03T09:14:11.000Z"},"magneticVariaton":{"source":{"type":"NMEA0183","sentence":"RMC","device":"nmea-signalk"},"timestamp":"2014-05-03T09:14:11.000Z","value":0},"speedOverGround":{"source":{"type":"NMEA0183","sentence":"RMC","device":"nmea-signalk"},"timestamp":"2014-05-03T09:14:11.000Z","value":0.18},"gnss":{"source":{"type":"NMEA0183","sentence":"GGA","device":"nmea-signalk"},"timestamp":"2014-06-06T09:14:00.000Z","quality":1,"satellites":8,"antennaAltitude":1,"horizontalDilution":0,"geoidalSeparation":47,"differentialAge":0,"differentialReference":0},"position":{"source":{"type":"NMEA0183","sentence":"GGA","device":"nmea-signalk"},"timestamp":"2014-06-06T09:14:00.000Z","longitude":52.371903333333336,"latitude":4.909741666666667}}}},"version":"2.0","timestamp":"2014-05-06T15:51:30.123Z","source":{"type":"NMEA0183","label":"signalk/nmea-signalk"}}
// [...]
Usage with serial input
$ nmea-signalk --serial /dev/USB0
$
// OUTPUT EXAMPLE:
// {"self":"a34af45a","vessels":{"a34af45a":{"source":{"type":"NMEA0183","label":"signalk/nmea-signalk"},"timestamp":"2014-05-06T15:51:30.241Z","uuid":"a34af45a","navigation":{"courseOverGroundTrue":{"source":{"type":"NMEA0183","sentence":"RMC","device":"nmea-signalk"},"timestamp":"2014-05-03T09:14:11.000Z","value":28.17},"location":{"latitude":52.371901666666666,"longitude":4.90974,"source":{"type":"NMEA0183","sentence":"RMC","device":"nmea-signalk"},"timestamp":"2014-05-03T09:14:11.000Z"},"magneticVariaton":{"source":{"type":"NMEA0183","sentence":"RMC","device":"nmea-signalk"},"timestamp":"2014-05-03T09:14:11.000Z","value":0},"speedOverGround":{"source":{"type":"NMEA0183","sentence":"RMC","device":"nmea-signalk"},"timestamp":"2014-05-03T09:14:11.000Z","value":0.18},"gnss":{"source":{"type":"NMEA0183","sentence":"GGA","device":"nmea-signalk"},"timestamp":"2014-06-06T09:14:00.000Z","quality":1,"satellites":8,"antennaAltitude":1,"horizontalDilution":0,"geoidalSeparation":47,"differentialAge":0,"differentialReference":0},"position":{"source":{"type":"NMEA0183","sentence":"GGA","device":"nmea-signalk"},"timestamp":"2014-06-06T09:14:00.000Z","longitude":52.371903333333336,"latitude":4.909741666666667}}}},"version":"2.0","timestamp":"2014-05-06T15:51:30.123Z","source":{"type":"NMEA0183","label":"signalk/nmea-signalk"}}
// [...]
Usage as module
var Parser = require('nmea0183-signalk').Parser;
var parser = new Parser({
debug: false,
vessel: require('./vessel.json')
});
someinputstream.pipe(parser);
parser.on('sentence', function(signalk, lineno) {
// do something with signalK object
});
Usage with --debug specified
$ tail -n 10000 gps.log | nmea-signalk --debug
$
/*
SENTENCE #5741
{
"self": "a34af45a",
"vessels": {
"a34af45a": {
"source": {
"type": "NMEA0183",
"label": "signalk/nmea-signalk"
},
"timestamp": "2014-05-06T15:49:01.065Z",
"uuid": "a34af45a",
"navigation": {
"gnss": {
"source": {
"type": "NMEA0183",
"sentence": "GGA",
"device": "nmea-signalk"
},
"timestamp": "2014-06-06T09:14:00.000Z",
"quality": 1,
"satellites": 8,
"antennaAltitude": 1,
"horizontalDilution": 0,
"geoidalSeparation": 47,
"differentialAge": 0,
"differentialReference": 0
},
"position": {
"source": {
"type": "NMEA0183",
"sentence": "GGA",
"device": "nmea-signalk"
},
"timestamp": "2014-06-06T09:14:00.000Z",
"longitude": 52.371903333333336,
"latitude": 4.909741666666667
},
"courseOverGroundTrue": {
"source": {
"type": "NMEA0183",
"sentence": "RMC",
"device": "nmea-signalk"
},
"timestamp": "2014-05-03T09:14:11.000Z",
"value": 28.17
},
"location": {
"latitude": 52.371901666666666,
"longitude": 4.90974,
"source": {
"type": "NMEA0183",
"sentence": "RMC",
"device": "nmea-signalk"
},
"timestamp": "2014-05-03T09:14:11.000Z"
},
"magneticVariaton": {
"source": {
"type": "NMEA0183",
"sentence": "RMC",
"device": "nmea-signalk"
},
"timestamp": "2014-05-03T09:14:11.000Z",
"value": 0
},
"speedOverGround": {
"source": {
"type": "NMEA0183",
"sentence": "RMC",
"device": "nmea-signalk"
},
"timestamp": "2014-05-03T09:14:11.000Z",
"value": 0.18
}
}
}
},
"version": "2.0",
"timestamp": "2014-05-06T15:49:00.284Z",
"source": {
"type": "NMEA0183",
"label": "signalk/nmea-signalk"
}
}
*/
Usage from CLI:
a. Supports data piped in from another process (e.g. tail -n 100 | nmea-signalk)
b. Supports file input (with an NMEA0183 sentence on each line)
c. Supports serial input
d. Supports single line input
When using the parser as a CLI program, it will output a JSON encoded Signal K object on each line on stdout.
Used as node.js module
a. Forked mode: fork a parser in another process, and the parser will send parsed Signal K objects using process.send() (available in the parent process using fork.on('message', function(data) {})).
b. require'ed mode: parser is available as a Transform Stream, ready to accept any streamed input.
Notes
a. Parser output (via whatever method) is always a full spec-compatible Signal K JSON object
b. If the parser receives conflicting input (e.g. a new version of a GLL sentence) the conflict is automatically resolved using the timestamps (see SignalK/signalk-merge for more on merging).
Special thanks to @jamesp for his hard work on node-nmea, as his work somewhat inspired the codecs in this parser. Even if the codecs look quite different, we wouldn't have gotten to this point without him!
FAQs
NMEA0183 to Signal K parser
The npm package nmea0183-signalk receives a total of 1 weekly downloads. As such, nmea0183-signalk popularity was classified as not popular.
We found that nmea0183-signalk demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers uncovered a malicious PyPI package exploiting Deezer’s API to enable coordinated music piracy through API abuse and C2 server control.
Research
The Socket Research Team discovered a malicious npm package, '@ton-wallet/create', stealing cryptocurrency wallet keys from developers and users in the TON ecosystem.
Security News
Newly introduced telemetry in devenv 1.4 sparked a backlash over privacy concerns, leading to the removal of its AI-powered feature after strong community pushback.