@signalk/nmea0183-signalk
Version:
A node.js/javascript parser for NMEA0183 sentences. Sentences are parsed to Signal K format.
105 lines • 4.04 kB
JavaScript
;
/**
* Copyright 2019 Signal K and Fabian Tollenaar <fabian@decipher.industries>.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || (function () {
var ownKeys = function(o) {
ownKeys = Object.getOwnPropertyNames || function (o) {
var ar = [];
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
return ar;
};
return ownKeys(o);
};
return function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
__setModuleDefault(result, mod);
return result;
};
})();
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
const utils = __importStar(require("@signalk/nmea0183-utilities"));
const debug_1 = __importDefault(require("debug"));
const debug = (0, debug_1.default)('signalk-parser-nmea0183/XTE');
/**
* 0 1 2 3 4
* | | | | |
* $--XTE,A,A,x.x,a,N,*hh
*
* 0) Status V = LORAN-C blink or SNR warning
* A = general warning flag or other navigation systems when a reliable fix is not available
*
* 1) Status V = Loran-C cycle lock warning flag
* A = OK or not used
*
* 2) Cross track error magnitude
* 3) Direction to steer, L or R
* 4) Cross track units. N = Nautical Miles
**/
const XTE = function (input, _session) {
const { id, sentence, parts, tags } = input;
debug(`[XTEHook] decoding sentence ${id} => ${sentence}`);
if (parts[0].trim().toUpperCase() === 'V') {
// Don't parse this sentence as it's void.
throw new Error("Not parsing sentence for it's void (LORAN-C blink/SNR warning)");
}
if (parts[1].trim().toUpperCase() === 'V') {
throw new Error("Not parsing sentence for it's void (LORAN-C cycle warning)");
}
if (parts[2].trim() === '' && parts[3].trim() === '') {
return null;
}
const direction = parts[3].trim().toUpperCase() === 'L' ? 1 : -1;
const value = direction *
utils.transform(parts[2], parts[4].trim().toUpperCase() === 'N' ? 'nm' : 'km', 'm');
const path = 'navigation.courseRhumbline.crossTrackError';
return {
updates: [
{
source: tags.source,
timestamp: tags.timestamp,
values: [
{
path,
value
}
]
}
]
};
};
exports.default = XTE;
//# sourceMappingURL=XTE.js.map