signalk-garmin-keypad-plugin 1.0.2

package/dist/n2k.js

@@ -0,0 +1,143 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildDisplaySelect = exports.buildSleepWake = exports.setFingerprint = exports.ensureCounterAbove = exports.decodeCounter = exports.resetCounters = exports.buildPageNav = exports.buildSavePreset = exports.buildSelectPreset = exports.extractGroupIdFromPayload = exports.setGroupId = void 0;
+const protocol_1 = require("./protocol");
+let currentGroupId = protocol_1.DEFAULT_GROUP_ID;
+function setGroupId(groupId) {
+    currentGroupId = groupId;
+}
+exports.setGroupId = setGroupId;
+// Group ID is at payload bytes 7-10 in both 0xe5 and 0xe7 messages.
+function extractGroupIdFromPayload(payload) {
+    if (!payload || !Buffer.isBuffer(payload) || payload.length < 11)
+        return null;
+    const id = payload.slice(7, 11);
+    if (id.every(b => b === 0))
+        return null;
+    return id;
+}
+exports.extractGroupIdFromPayload = extractGroupIdFromPayload;
+// --- PGN 61184 builders (field-based, encoded by canboatjs) ---
+function buildButtonPgn(command, paramName, paramValue, src) {
+    return {
+        pgn: protocol_1.PGN_SINGLE,
+        dst: protocol_1.DEFAULT_DST,
+        prio: protocol_1.DEFAULT_PRIO,
+        src,
+        'Manufacturer Code': 229,
+        'Industry Code': 4,
+        'Command': command,
+        'Product ID': protocol_1.PRODUCT_ID,
+        'Unknown 1': protocol_1.UNK1,
+        'Unknown 2': protocol_1.UNK2,
+        [paramName]: paramValue
+    };
+}
+function buildSelectPreset(index, src = protocol_1.DEFAULT_SRC) {
+    if (!Number.isInteger(index) || index < 0 || index > 3) {
+        throw new Error(`Preset index must be 0-3, got ${index}`);
+    }
+    return buildButtonPgn(protocol_1.CMD_SELECT_PRESET, 'Preset Index', index, src);
+}
+exports.buildSelectPreset = buildSelectPreset;
+function buildSavePreset(index, src = protocol_1.DEFAULT_SRC) {
+    if (!Number.isInteger(index) || index < 0 || index > 3) {
+        throw new Error(`Preset index must be 0-3, got ${index}`);
+    }
+    return buildButtonPgn(protocol_1.CMD_SAVE_PRESET, 'Preset Index', index, src);
+}
+exports.buildSavePreset = buildSavePreset;
+function buildPageNav(direction, src = protocol_1.DEFAULT_SRC) {
+    const param = direction === 'next' ? 0 : 1;
+    return buildButtonPgn(protocol_1.CMD_PAGE_NAV, 'Direction', param, src);
+}
+exports.buildPageNav = buildPageNav;
+// --- PGN 126720 builders (payload as pre-built Buffer) ---
+// Per-property sequence counters (mimics real keypad behavior).
+// Each property name maintains its own independent counter.
+// Counter space is 10-bit (0-1023), wrapping at 1024.
+// Bytes 5-6 encode counter C as: byte5 = 0x8e + (C & 7) * 0x10, byte6 = C >> 3.
+// T6 must stay in 0x00-0x7f range (max counter 1023); displays silently
+// reject messages with T6 >= 0x80.
+const propertyCounters = new Map();
+const MAX_SEQ = 0x3FF; // 1023 — maximum valid counter value
+function resetCounters() {
+    propertyCounters.clear();
+}
+exports.resetCounters = resetCounters;
+function decodeCounter(t5, t6) {
+    return (t6 << 3) | ((t5 - 0x8e) >> 4);
+}
+exports.decodeCounter = decodeCounter;
+// Next buildTrailing call will send (stored + 1) & MAX_SEQ.
+function ensureCounterAbove(property, minSeq) {
+    var _a;
+    const current = (_a = propertyCounters.get(property)) !== null && _a !== void 0 ? _a : -1;
+    const clamped = minSeq & MAX_SEQ;
+    if (current < clamped) {
+        propertyCounters.set(property, clamped);
+    }
+}
+exports.ensureCounterAbove = ensureCounterAbove;
+// Keypad fingerprint bytes — must match the fingerprint stored on the GNX
+// displays for the property being set.  Displays persist the fingerprint of
+// the last keypad that successfully changed each property and reject commands
+// from a different fingerprint.  Auto-discovered from bus traffic or set
+// manually via config.
+let keypadFingerprint = null;
+function setFingerprint(fp) {
+    keypadFingerprint = fp;
+}
+exports.setFingerprint = setFingerprint;
+function buildTrailing(property) {
+    var _a, _b, _c;
+    const prev = (_a = propertyCounters.get(property)) !== null && _a !== void 0 ? _a : -1;
+    const seq = (prev + 1) & MAX_SEQ;
+    propertyCounters.set(property, seq);
+    const buf = Buffer.alloc(7);
+    buf[0] = 0x2e;
+    buf[1] = 0x80 | (Math.random() * 128 | 0); // T1: random nonce, bit 7 must be set or displays reject
+    buf[2] = 0xb0; // T2: 1-bit state flag — 0xb0 is safe constant
+    buf[3] = (_b = keypadFingerprint === null || keypadFingerprint === void 0 ? void 0 : keypadFingerprint[0]) !== null && _b !== void 0 ? _b : 0; // T3: keypad fingerprint byte 1
+    buf[4] = (_c = keypadFingerprint === null || keypadFingerprint === void 0 ? void 0 : keypadFingerprint[1]) !== null && _c !== void 0 ? _c : 0; // T4: keypad fingerprint byte 2
+    buf[5] = 0x8e + (seq & 7) * 0x10; // T5: counter low bits
+    buf[6] = (seq >> 3) & 0x7f; // T6: counter high bits (must be 0x00-0x7f)
+    return buf;
+}
+function buildPropertyPayload(property, value) {
+    const strLen = property.length + 1;
+    const strBuf = Buffer.from(property + '\0', 'ascii');
+    const valueBuf = Buffer.from([value]);
+    // Skip first byte of header (command byte 0xe5) — canboatjs writes it from PGN Match
+    return Buffer.concat([
+        (0, protocol_1.buildPropertyHeader)(currentGroupId).slice(1),
+        Buffer.from([strLen]),
+        strBuf,
+        protocol_1.PROPERTY_SEPARATOR,
+        valueBuf,
+        buildTrailing(property)
+    ]);
+}
+function buildPropertyPgn(property, value, src) {
+    return {
+        pgn: protocol_1.PGN_FAST,
+        dst: protocol_1.DEFAULT_DST,
+        prio: protocol_1.DEFAULT_PRIO,
+        src,
+        'Manufacturer Code': 229,
+        'Industry Code': 4,
+        'Command': 0xe5,
+        'Payload': buildPropertyPayload(property, value)
+    };
+}
+function buildSleepWake(sleep, src = protocol_1.DEFAULT_SRC) {
+    return buildPropertyPgn(protocol_1.PROP_SLEEP, sleep ? protocol_1.SLEEP : protocol_1.WAKE, src);
+}
+exports.buildSleepWake = buildSleepWake;
+function buildDisplaySelect(index, src = protocol_1.DEFAULT_SRC) {
+    if (!Number.isInteger(index) || index < 0) {
+        throw new Error(`Display index must be a non-negative integer, got ${index}`);
+    }
+    return buildPropertyPgn(protocol_1.PROP_DISPLAY, index, src);
+}
+exports.buildDisplaySelect = buildDisplaySelect;

package/dist/pgns.d.ts

@@ -0,0 +1,169 @@
+export const PGNs: ({
+    PGN: number;
+    Id: string;
+    Description: string;
+    Type: string;
+    Complete: boolean;
+    Length: number;
+    Fields: ({
+        Order: number;
+        Id: string;
+        Name: string;
+        BitLength: number;
+        BitOffset: number;
+        BitStart: number;
+        Match: number;
+        FieldType: string;
+        LookupEnumeration: string;
+        Signed: boolean;
+        Resolution?: undefined;
+    } | {
+        Order: number;
+        Id: string;
+        Name: string;
+        BitLength: number;
+        BitOffset: number;
+        BitStart: number;
+        FieldType: string;
+        Match?: undefined;
+        LookupEnumeration?: undefined;
+        Signed?: undefined;
+        Resolution?: undefined;
+    } | {
+        Order: number;
+        Id: string;
+        Name: string;
+        BitLength: number;
+        BitOffset: number;
+        BitStart: number;
+        FieldType: string;
+        Resolution: number;
+        Signed: boolean;
+        Match: number;
+        LookupEnumeration?: undefined;
+    } | {
+        Order: number;
+        Id: string;
+        Name: string;
+        BitLength: number;
+        BitOffset: number;
+        BitStart: number;
+        FieldType: string;
+        Resolution: number;
+        Signed: boolean;
+        Match?: undefined;
+        LookupEnumeration?: undefined;
+    })[];
+} | {
+    PGN: number;
+    Id: string;
+    Description: string;
+    Type: string;
+    Complete: boolean;
+    Fields: ({
+        Order: number;
+        Id: string;
+        Name: string;
+        BitLength: number;
+        BitOffset: number;
+        BitStart: number;
+        Match: number;
+        FieldType: string;
+        LookupEnumeration: string;
+        Signed: boolean;
+        Resolution?: undefined;
+    } | {
+        Order: number;
+        Id: string;
+        Name: string;
+        BitLength: number;
+        BitOffset: number;
+        BitStart: number;
+        FieldType: string;
+        Match?: undefined;
+        LookupEnumeration?: undefined;
+        Signed?: undefined;
+        Resolution?: undefined;
+    } | {
+        Order: number;
+        Id: string;
+        Name: string;
+        BitLength: number;
+        BitOffset: number;
+        BitStart: number;
+        FieldType: string;
+        Resolution: number;
+        Signed: boolean;
+        Match: number;
+        LookupEnumeration?: undefined;
+    } | {
+        Order: number;
+        Id: string;
+        Name: string;
+        BitLength: number;
+        BitOffset: number;
+        BitStart: number;
+        FieldType: string;
+        Signed: boolean;
+        Match?: undefined;
+        LookupEnumeration?: undefined;
+        Resolution?: undefined;
+    })[];
+    Length?: undefined;
+} | {
+    PGN: number;
+    Id: string;
+    Description: string;
+    Type: string;
+    Complete: boolean;
+    Length: number;
+    Fields: ({
+        Order: number;
+        Id: string;
+        Name: string;
+        BitLength: number;
+        BitOffset: number;
+        BitStart: number;
+        Match: number;
+        FieldType: string;
+        LookupEnumeration: string;
+        Signed: boolean;
+        Resolution?: undefined;
+    } | {
+        Order: number;
+        Id: string;
+        Name: string;
+        BitLength: number;
+        BitOffset: number;
+        BitStart: number;
+        FieldType: string;
+        Match?: undefined;
+        LookupEnumeration?: undefined;
+        Signed?: undefined;
+        Resolution?: undefined;
+    } | {
+        Order: number;
+        Id: string;
+        Name: string;
+        BitLength: number;
+        BitOffset: number;
+        BitStart: number;
+        FieldType: string;
+        Resolution: number;
+        Signed: boolean;
+        Match: number;
+        LookupEnumeration?: undefined;
+    } | {
+        Order: number;
+        Id: string;
+        Name: string;
+        BitLength: number;
+        BitOffset: number;
+        BitStart: number;
+        FieldType: string;
+        Signed: boolean;
+        Match?: undefined;
+        LookupEnumeration?: undefined;
+        Resolution?: undefined;
+    })[];
+})[];