@hangtime/grip-connect 0.8.6 → 0.9.0

package/dist/cjs/models/device/kilterboard.model.d.ts

@@ -0,0 +1,144 @@
+import { Device } from "../device.model.js";
+import type { IKilterBoard } from "../../interfaces/device/kilterboard.interface.js";
+/**
+ * For API level 2 and API level 3.
+ * The first byte in the data is dependent on where the packet is in the message as a whole.
+ * More details: https://github.com/1-max-1/fake_kilter_board
+ */
+export declare enum KilterBoardPacket {
+    /** If this packet is in the middle, the byte gets set to 77 (M). */
+    V2_MIDDLE = 77,
+    /** If this packet is the first packet in the message, then this byte gets set to 78 (N). */
+    V2_FIRST = 78,
+    /** If this is the last packet in the message, this byte gets set to 79 (0). */
+    V2_LAST = 79,
+    /** If this packet is the only packet in the message, the byte gets set to 80 (P). Note that this takes priority over the other conditions. */
+    V2_ONLY = 80,
+    /** If this packet is in the middle, the byte gets set to 81 (Q). */
+    V3_MIDDLE = 81,
+    /** If this packet is the first packet in the message, then this byte gets set to 82 (R). */
+    V3_FIRST = 82,
+    /** If this is the last packet in the message, this byte gets set to 83 (S). */
+    V3_LAST = 83,
+    /** If this packet is the only packet in the message, the byte gets set to 84 (T). Note that this takes priority over the other conditions. */
+    V3_ONLY = 84
+}
+/**
+ * Extracted from placement_roles database table.
+ */
+export declare const KilterBoardPlacementRoles: {
+    id: number;
+    product_id: number;
+    position: number;
+    name: string;
+    full_name: string;
+    led_color: string;
+    screen_color: string;
+}[];
+/**
+ * Represents a Aurora Climbing device.
+ * Kilter Board, Tension Board, Decoy Board, Touchstone Board, Grasshopper Board, Aurora Board, So iLL Board
+ * {@link https://auroraclimbing.com}
+ */
+export declare class KilterBoard extends Device implements IKilterBoard {
+    /**
+     * UUID for the Aurora Climbing Advertising service.
+     * This constant is used to identify the specific Bluetooth service for Kilter Boards.
+     * @type {string}
+     * @static
+     * @readonly
+     * @constant
+     */
+    static readonly AuroraUUID: string;
+    /**
+     * Maximum length of the message body for byte wrapping.
+     * This value defines the limit for the size of messages that can be sent or received
+     * to ensure proper byte wrapping in communication.
+     * @type {number}
+     * @private
+     * @readonly
+     * @constant
+     */
+    private static readonly messageBodyMaxLength;
+    /**
+     * Maximum length of the Bluetooth message chunk.
+     * This value sets the upper limit for the size of individual Bluetooth messages
+     * sent to and from the device to comply with Bluetooth protocol constraints.
+     * @type {number}
+     * @private
+     * @readonly
+     * @constant
+     */
+    private static readonly maxBluetoothMessageSize;
+    constructor();
+    /**
+     * Calculates the checksum for a byte array by summing up all bytes ot hre packet in a single-byte variable.
+     * @param data - The array of bytes to calculate the checksum for.
+     * @returns {number} The calculated checksum value.
+     */
+    private checksum;
+    /**
+     * Wraps a byte array with header and footer bytes for transmission.
+     * @param data - The array of bytes to wrap.
+     * @returns {number[]} The wrapped byte array.
+     */
+    private wrapBytes;
+    /**
+     * Encodes a position into a byte array.
+     * The lowest 8 bits of the position get put in the first byte of the group.
+     * The highest 8 bits of the position get put in the second byte of the group.
+     * @param position - The position to encode.
+     * @returns {number[]} The encoded byte array representing the position.
+     */
+    private encodePosition;
+    /**
+     * Encodes a color string into a numeric representation.
+     * The rgb color, 3 bits for the R and G components, 2 bits for the B component, with the 3 R bits occupying the high end of the byte and the 2 B bits in the low end (hence 3 G bits in the middle).
+     * @param color - The color string in hexadecimal format (e.g., 'FFFFFF').
+     * @returns The encoded /compressed color value.
+     */
+    private encodeColor;
+    /**
+     * Encodes a placement (requires a 16-bit position and a 24-bit rgb color. ) into a byte array.
+     * @param position - The position to encode.
+     * @param ledColor - The color of the LED in hexadecimal format (e.g., 'FFFFFF').
+     * @returns The encoded byte array representing the placement.
+     */
+    private encodePlacement;
+    /**
+     * Prepares byte arrays for transmission based on a list of climb placements.
+     * @param {{ position: number; role_id: number }[]} climbPlacementList - The list of climb placements containing position and role ID.
+     * @returns {number[]} The final byte array ready for transmission.
+     */
+    private prepBytesV3;
+    /**
+     * Splits a collection into slices of the specified length.
+     * https://github.com/ramda/ramda/blob/master/source/splitEvery
+     * @param {Number} n
+     * @param {Array} list
+     * @return {Array<number[]>}
+     */
+    private splitEvery;
+    /**
+     * The kilter board only supports messages of 20 bytes
+     * at a time. This method splits a full message into parts
+     * of 20 bytes
+     *
+     * @param buffer
+     */
+    private splitMessages;
+    /**
+     * Sends a series of messages to a device.
+     */
+    private writeMessageSeries;
+    /**
+     * Configures the LEDs based on an array of climb placements.
+     * @param {{ position: number; role_id: number }[]} config - Array of climb placements for the LEDs.
+     * @returns {Promise<number[] | undefined>} A promise that resolves with the payload array for the Kilter Board if LED settings were applied, or `undefined` if no action was taken or for the Motherboard.
+     */
+    led: (config: {
+        position: number;
+        role_id: number;
+    }[]) => Promise<number[] | undefined>;
+}
+//# sourceMappingURL=kilterboard.model.d.ts.map

package/dist/cjs/models/device/kilterboard.model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"kilterboard.model.d.ts","sourceRoot":"","sources":["../../../../src/models/device/kilterboard.model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAC3C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kDAAkD,CAAA;AAEpF;;;;GAIG;AACH,oBAAY,iBAAiB;IAC3B,oEAAoE;IACpE,SAAS,KAAK;IACd,4FAA4F;IAC5F,QAAQ,KAAA;IACR,+EAA+E;IAC/E,OAAO,KAAA;IACP,8IAA8I;IAC9I,OAAO,KAAA;IACP,oEAAoE;IACpE,SAAS,KAAA;IACT,4FAA4F;IAC5F,QAAQ,KAAA;IACR,+EAA+E;IAC/E,OAAO,KAAA;IACP,8IAA8I;IAC9I,OAAO,KAAA;CACR;AACD;;GAEG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;GAqCrC,CAAA;AAED;;;;GAIG;AACH,qBAAa,WAAY,SAAQ,MAAO,YAAW,YAAY;IAC7D;;;;;;;OAOG;IACH,MAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAyC;IAE3E;;;;;;;;OAQG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAc;IAE1D;;;;;;;;OAQG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,uBAAuB,CAAa;;IA+B5D;;;;OAIG;IACH,OAAO,CAAC,QAAQ;IAQhB;;;;OAIG;IACH,OAAO,CAAC,SAAS;IAiBjB;;;;;;OAMG;IACH,OAAO,CAAC,cAAc;IAOtB;;;;;OAKG;IACH,OAAO,CAAC,WAAW;IAenB;;;;;OAKG;IACH,OAAO,CAAC,eAAe;IAIvB;;;;OAIG;IACH,OAAO,CAAC,WAAW;IAkCnB;;;;;;OAMG;IACH,OAAO,CAAC,UAAU;IAYlB;;;;;;OAMG;IACH,OAAO,CAAC,aAAa,CAC2E;IAEhG;;OAEG;YACW,kBAAkB;IAMhC;;;;OAIG;IACH,GAAG,GAAU,QAAQ;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,EAAE,KAAG,OAAO,CAAC,MAAM,EAAE,GAAG,SAAS,CAAC,CAW3F;CACF"}

package/dist/cjs/models/device/kilterboard.model.js

@@ -0,0 +1,291 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KilterBoard = exports.KilterBoardPlacementRoles = exports.KilterBoardPacket = void 0;
+const device_model_js_1 = require("../device.model.js");
+/**
+ * For API level 2 and API level 3.
+ * The first byte in the data is dependent on where the packet is in the message as a whole.
+ * More details: https://github.com/1-max-1/fake_kilter_board
+ */
+var KilterBoardPacket;
+(function (KilterBoardPacket) {
+    /** If this packet is in the middle, the byte gets set to 77 (M). */
+    KilterBoardPacket[KilterBoardPacket["V2_MIDDLE"] = 77] = "V2_MIDDLE";
+    /** If this packet is the first packet in the message, then this byte gets set to 78 (N). */
+    KilterBoardPacket[KilterBoardPacket["V2_FIRST"] = 78] = "V2_FIRST";
+    /** If this is the last packet in the message, this byte gets set to 79 (0). */
+    KilterBoardPacket[KilterBoardPacket["V2_LAST"] = 79] = "V2_LAST";
+    /** If this packet is the only packet in the message, the byte gets set to 80 (P). Note that this takes priority over the other conditions. */
+    KilterBoardPacket[KilterBoardPacket["V2_ONLY"] = 80] = "V2_ONLY";
+    /** If this packet is in the middle, the byte gets set to 81 (Q). */
+    KilterBoardPacket[KilterBoardPacket["V3_MIDDLE"] = 81] = "V3_MIDDLE";
+    /** If this packet is the first packet in the message, then this byte gets set to 82 (R). */
+    KilterBoardPacket[KilterBoardPacket["V3_FIRST"] = 82] = "V3_FIRST";
+    /** If this is the last packet in the message, this byte gets set to 83 (S). */
+    KilterBoardPacket[KilterBoardPacket["V3_LAST"] = 83] = "V3_LAST";
+    /** If this packet is the only packet in the message, the byte gets set to 84 (T). Note that this takes priority over the other conditions. */
+    KilterBoardPacket[KilterBoardPacket["V3_ONLY"] = 84] = "V3_ONLY";
+})(KilterBoardPacket || (exports.KilterBoardPacket = KilterBoardPacket = {}));
+/**
+ * Extracted from placement_roles database table.
+ */
+exports.KilterBoardPlacementRoles = [
+    {
+        id: 12,
+        product_id: 1,
+        position: 1,
+        name: "start",
+        full_name: "Start",
+        led_color: "00FF00",
+        screen_color: "00DD00",
+    },
+    {
+        id: 13,
+        product_id: 1,
+        position: 2,
+        name: "middle",
+        full_name: "Middle",
+        led_color: "00FFFF",
+        screen_color: "00FFFF",
+    },
+    {
+        id: 14,
+        product_id: 1,
+        position: 3,
+        name: "finish",
+        full_name: "Finish",
+        led_color: "FF00FF",
+        screen_color: "FF00FF",
+    },
+    {
+        id: 15,
+        product_id: 1,
+        position: 4,
+        name: "foot",
+        full_name: "Foot Only",
+        led_color: "FFB600",
+        screen_color: "FFA500",
+    },
+];
+/**
+ * Represents a Aurora Climbing device.
+ * Kilter Board, Tension Board, Decoy Board, Touchstone Board, Grasshopper Board, Aurora Board, So iLL Board
+ * {@link https://auroraclimbing.com}
+ */
+class KilterBoard extends device_model_js_1.Device {
+    constructor() {
+        super({
+            filters: [
+                {
+                    services: [KilterBoard.AuroraUUID],
+                },
+            ],
+            services: [
+                {
+                    name: "UART Nordic Service",
+                    id: "uart",
+                    uuid: "6e400001-b5a3-f393-e0a9-e50e24dcca9e",
+                    characteristics: [
+                        {
+                            name: "TX",
+                            id: "tx",
+                            uuid: "6e400002-b5a3-f393-e0a9-e50e24dcca9e",
+                        },
+                        // {
+                        //   name: "RX",
+                        //   id: "rx",
+                        //   uuid: "6e400003-b5a3-f393-e0a9-e50e24dcca9e",
+                        // },
+                    ],
+                },
+            ],
+        });
+        /**
+         * The kilter board only supports messages of 20 bytes
+         * at a time. This method splits a full message into parts
+         * of 20 bytes
+         *
+         * @param buffer
+         */
+        this.splitMessages = (buffer) => this.splitEvery(KilterBoard.maxBluetoothMessageSize, buffer).map((arr) => new Uint8Array(arr));
+        /**
+         * Configures the LEDs based on an array of climb placements.
+         * @param {{ position: number; role_id: number }[]} config - Array of climb placements for the LEDs.
+         * @returns {Promise<number[] | undefined>} A promise that resolves with the payload array for the Kilter Board if LED settings were applied, or `undefined` if no action was taken or for the Motherboard.
+         */
+        this.led = async (config) => {
+            // Handle Kilterboard logic: process placements and send payload if connected
+            if (Array.isArray(config)) {
+                // Prepares byte arrays for transmission based on a list of climb placements.
+                const payload = this.prepBytesV3(config);
+                if (this.isConnected()) {
+                    await this.writeMessageSeries(this.splitMessages(payload));
+                }
+                return payload;
+            }
+            return undefined;
+        };
+    }
+    /**
+     * Calculates the checksum for a byte array by summing up all bytes ot hre packet in a single-byte variable.
+     * @param data - The array of bytes to calculate the checksum for.
+     * @returns {number} The calculated checksum value.
+     */
+    checksum(data) {
+        let i = 0;
+        for (const value of data) {
+            i = (i + value) & 255;
+        }
+        return ~i & 255;
+    }
+    /**
+     * Wraps a byte array with header and footer bytes for transmission.
+     * @param data - The array of bytes to wrap.
+     * @returns {number[]} The wrapped byte array.
+     */
+    wrapBytes(data) {
+        if (data.length > KilterBoard.messageBodyMaxLength) {
+            return [];
+        }
+        /**
+      - 0x1
+      - len(packets)
+      - checksum(packets)
+      - 0x2
+      - *packets
+      - 0x3
+    
+      First byte is always 1, the second is a number of packets, then checksum, then 2, packets themselves, and finally 3.
+       */
+        return [1, data.length, this.checksum(data), 2, ...data, 3];
+    }
+    /**
+     * Encodes a position into a byte array.
+     * The lowest 8 bits of the position get put in the first byte of the group.
+     * The highest 8 bits of the position get put in the second byte of the group.
+     * @param position - The position to encode.
+     * @returns {number[]} The encoded byte array representing the position.
+     */
+    encodePosition(position) {
+        const position1 = position & 255;
+        const position2 = (position & 65280) >> 8;
+        return [position1, position2];
+    }
+    /**
+     * Encodes a color string into a numeric representation.
+     * The rgb color, 3 bits for the R and G components, 2 bits for the B component, with the 3 R bits occupying the high end of the byte and the 2 B bits in the low end (hence 3 G bits in the middle).
+     * @param color - The color string in hexadecimal format (e.g., 'FFFFFF').
+     * @returns The encoded /compressed color value.
+     */
+    encodeColor(color) {
+        const substring = color.substring(0, 2);
+        const substring2 = color.substring(2, 4);
+        const parsedSubstring = parseInt(substring, 16) / 32;
+        const parsedSubstring2 = parseInt(substring2, 16) / 32;
+        const parsedResult = (parsedSubstring << 5) | (parsedSubstring2 << 2);
+        const substring3 = color.substring(4, 6);
+        const parsedSubstring3 = parseInt(substring3, 16) / 64;
+        const finalParsedResult = parsedResult | parsedSubstring3;
+        return finalParsedResult;
+    }
+    /**
+     * Encodes a placement (requires a 16-bit position and a 24-bit rgb color. ) into a byte array.
+     * @param position - The position to encode.
+     * @param ledColor - The color of the LED in hexadecimal format (e.g., 'FFFFFF').
+     * @returns The encoded byte array representing the placement.
+     */
+    encodePlacement(position, ledColor) {
+        return [...this.encodePosition(position), this.encodeColor(ledColor)];
+    }
+    /**
+     * Prepares byte arrays for transmission based on a list of climb placements.
+     * @param {{ position: number; role_id: number }[]} climbPlacementList - The list of climb placements containing position and role ID.
+     * @returns {number[]} The final byte array ready for transmission.
+     */
+    prepBytesV3(climbPlacementList) {
+        const resultArray = [];
+        let tempArray = [KilterBoardPacket.V3_MIDDLE];
+        for (const climbPlacement of climbPlacementList) {
+            if (tempArray.length + 3 > KilterBoard.messageBodyMaxLength) {
+                resultArray.push(tempArray);
+                tempArray = [KilterBoardPacket.V3_MIDDLE];
+            }
+            const role = exports.KilterBoardPlacementRoles.find((placement) => placement.id === climbPlacement.role_id);
+            if (!role) {
+                throw new Error(`Role with id ${climbPlacement.role_id} not found in placement_roles`);
+            }
+            const encodedPlacement = this.encodePlacement(climbPlacement.position, role.led_color);
+            tempArray.push(...encodedPlacement);
+        }
+        resultArray.push(tempArray);
+        if (resultArray.length === 1) {
+            resultArray[0][0] = KilterBoardPacket.V3_ONLY;
+        }
+        else if (resultArray.length > 1) {
+            resultArray[0][0] = KilterBoardPacket.V3_FIRST;
+            resultArray[resultArray.length - 1][0] = KilterBoardPacket.V3_LAST;
+        }
+        const finalResultArray = [];
+        for (const currentArray of resultArray) {
+            finalResultArray.push(...this.wrapBytes(currentArray));
+        }
+        return finalResultArray;
+    }
+    /**
+     * Splits a collection into slices of the specified length.
+     * https://github.com/ramda/ramda/blob/master/source/splitEvery
+     * @param {Number} n
+     * @param {Array} list
+     * @return {Array<number[]>}
+     */
+    splitEvery(n, list) {
+        if (n <= 0) {
+            throw new Error("First argument to splitEvery must be a positive integer");
+        }
+        const result = [];
+        let idx = 0;
+        while (idx < list.length) {
+            result.push(list.slice(idx, (idx += n)));
+        }
+        return result;
+    }
+    /**
+     * Sends a series of messages to a device.
+     */
+    async writeMessageSeries(messages) {
+        for (const message of messages) {
+            await this.write("uart", "tx", message);
+        }
+    }
+}
+exports.KilterBoard = KilterBoard;
+/**
+ * UUID for the Aurora Climbing Advertising service.
+ * This constant is used to identify the specific Bluetooth service for Kilter Boards.
+ * @type {string}
+ * @static
+ * @readonly
+ * @constant
+ */
+KilterBoard.AuroraUUID = "4488b571-7806-4df6-bcff-a2897e4953ff";
+/**
+ * Maximum length of the message body for byte wrapping.
+ * This value defines the limit for the size of messages that can be sent or received
+ * to ensure proper byte wrapping in communication.
+ * @type {number}
+ * @private
+ * @readonly
+ * @constant
+ */
+KilterBoard.messageBodyMaxLength = 255;
+/**
+ * Maximum length of the Bluetooth message chunk.
+ * This value sets the upper limit for the size of individual Bluetooth messages
+ * sent to and from the device to comply with Bluetooth protocol constraints.
+ * @type {number}
+ * @private
+ * @readonly
+ * @constant
+ */
+KilterBoard.maxBluetoothMessageSize = 20;
+//# sourceMappingURL=kilterboard.model.js.map

package/dist/cjs/models/device/kilterboard.model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"kilterboard.model.js","sourceRoot":"","sources":["../../../../src/models/device/kilterboard.model.ts"],"names":[],"mappings":";;;AAAA,wDAA2C;AAG3C;;;;GAIG;AACH,IAAY,iBAiBX;AAjBD,WAAY,iBAAiB;IAC3B,oEAAoE;IACpE,oEAAc,CAAA;IACd,4FAA4F;IAC5F,kEAAQ,CAAA;IACR,+EAA+E;IAC/E,gEAAO,CAAA;IACP,8IAA8I;IAC9I,gEAAO,CAAA;IACP,oEAAoE;IACpE,oEAAS,CAAA;IACT,4FAA4F;IAC5F,kEAAQ,CAAA;IACR,+EAA+E;IAC/E,gEAAO,CAAA;IACP,8IAA8I;IAC9I,gEAAO,CAAA;AACT,CAAC,EAjBW,iBAAiB,iCAAjB,iBAAiB,QAiB5B;AACD;;GAEG;AACU,QAAA,yBAAyB,GAAG;IACvC;QACE,EAAE,EAAE,EAAE;QACN,UAAU,EAAE,CAAC;QACb,QAAQ,EAAE,CAAC;QACX,IAAI,EAAE,OAAO;QACb,SAAS,EAAE,OAAO;QAClB,SAAS,EAAE,QAAQ;QACnB,YAAY,EAAE,QAAQ;KACvB;IACD;QACE,EAAE,EAAE,EAAE;QACN,UAAU,EAAE,CAAC;QACb,QAAQ,EAAE,CAAC;QACX,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,QAAQ;QACnB,SAAS,EAAE,QAAQ;QACnB,YAAY,EAAE,QAAQ;KACvB;IACD;QACE,EAAE,EAAE,EAAE;QACN,UAAU,EAAE,CAAC;QACb,QAAQ,EAAE,CAAC;QACX,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,QAAQ;QACnB,SAAS,EAAE,QAAQ;QACnB,YAAY,EAAE,QAAQ;KACvB;IACD;QACE,EAAE,EAAE,EAAE;QACN,UAAU,EAAE,CAAC;QACb,QAAQ,EAAE,CAAC;QACX,IAAI,EAAE,MAAM;QACZ,SAAS,EAAE,WAAW;QACtB,SAAS,EAAE,QAAQ;QACnB,YAAY,EAAE,QAAQ;KACvB;CACF,CAAA;AAED;;;;GAIG;AACH,MAAa,WAAY,SAAQ,wBAAM;IAiCrC;QACE,KAAK,CAAC;YACJ,OAAO,EAAE;gBACP;oBACE,QAAQ,EAAE,CAAC,WAAW,CAAC,UAAU,CAAC;iBACnC;aACF;YACD,QAAQ,EAAE;gBACR;oBACE,IAAI,EAAE,qBAAqB;oBAC3B,EAAE,EAAE,MAAM;oBACV,IAAI,EAAE,sCAAsC;oBAC5C,eAAe,EAAE;wBACf;4BACE,IAAI,EAAE,IAAI;4BACV,EAAE,EAAE,IAAI;4BACR,IAAI,EAAE,sCAAsC;yBAC7C;wBACD,IAAI;wBACJ,gBAAgB;wBAChB,cAAc;wBACd,kDAAkD;wBAClD,KAAK;qBACN;iBACF;aACF;SACF,CAAC,CAAA;QA6IJ;;;;;;WAMG;QACK,kBAAa,GAAG,CAAC,MAAgB,EAAE,EAAE,CAC3C,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC,CAAA;QAWhG;;;;WAIG;QACH,QAAG,GAAG,KAAK,EAAE,MAA+C,EAAiC,EAAE;YAC7F,6EAA6E;YAC7E,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC1B,6EAA6E;gBAC7E,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;gBACxC,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;oBACvB,MAAM,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAA;gBAC5D,CAAC;gBACD,OAAO,OAAO,CAAA;YAChB,CAAC;YACD,OAAO,SAAS,CAAA;QAClB,CAAC,CAAA;IA/KD,CAAC;IAED;;;;OAIG;IACK,QAAQ,CAAC,IAAc;QAC7B,IAAI,CAAC,GAAG,CAAC,CAAA;QACT,KAAK,MAAM,KAAK,IAAI,IAAI,EAAE,CAAC;YACzB,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,GAAG,GAAG,CAAA;QACvB,CAAC;QACD,OAAO,CAAC,CAAC,GAAG,GAAG,CAAA;IACjB,CAAC;IAED;;;;OAIG;IACK,SAAS,CAAC,IAAc;QAC9B,IAAI,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,oBAAoB,EAAE,CAAC;YACnD,OAAO,EAAE,CAAA;QACX,CAAC;QACD;;;;;;;;;SASC;QACD,OAAO,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC,CAAA;IAC7D,CAAC;IAED;;;;;;OAMG;IACK,cAAc,CAAC,QAAgB;QACrC,MAAM,SAAS,GAAG,QAAQ,GAAG,GAAG,CAAA;QAChC,MAAM,SAAS,GAAG,CAAC,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,CAAA;QAEzC,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,CAAA;IAC/B,CAAC;IAED;;;;;OAKG;IACK,WAAW,CAAC,KAAa;QAC/B,MAAM,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QACvC,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QAExC,MAAM,eAAe,GAAG,QAAQ,CAAC,SAAS,EAAE,EAAE,CAAC,GAAG,EAAE,CAAA;QACpD,MAAM,gBAAgB,GAAG,QAAQ,CAAC,UAAU,EAAE,EAAE,CAAC,GAAG,EAAE,CAAA;QACtD,MAAM,YAAY,GAAG,CAAC,eAAe,IAAI,CAAC,CAAC,GAAG,CAAC,gBAAgB,IAAI,CAAC,CAAC,CAAA;QAErE,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QACxC,MAAM,gBAAgB,GAAG,QAAQ,CAAC,UAAU,EAAE,EAAE,CAAC,GAAG,EAAE,CAAA;QACtD,MAAM,iBAAiB,GAAG,YAAY,GAAG,gBAAgB,CAAA;QAEzD,OAAO,iBAAiB,CAAA;IAC1B,CAAC;IAED;;;;;OAKG;IACK,eAAe,CAAC,QAAgB,EAAE,QAAgB;QACxD,OAAO,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAA;IACvE,CAAC;IAED;;;;OAIG;IACK,WAAW,CAAC,kBAA2D;QAC7E,MAAM,WAAW,GAAe,EAAE,CAAA;QAClC,IAAI,SAAS,GAAa,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAA;QAEvD,KAAK,MAAM,cAAc,IAAI,kBAAkB,EAAE,CAAC;YAChD,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,GAAG,WAAW,CAAC,oBAAoB,EAAE,CAAC;gBAC5D,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;gBAC3B,SAAS,GAAG,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAA;YAC3C,CAAC;YACD,MAAM,IAAI,GAAG,iCAAyB,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,KAAK,cAAc,CAAC,OAAO,CAAC,CAAA;YACnG,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,MAAM,IAAI,KAAK,CAAC,gBAAgB,cAAc,CAAC,OAAO,+BAA+B,CAAC,CAAA;YACxF,CAAC;YACD,MAAM,gBAAgB,GAAG,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,CAAA;YACtF,SAAS,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC,CAAA;QACrC,CAAC;QAED,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QAE3B,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7B,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,iBAAiB,CAAC,OAAO,CAAA;QAC/C,CAAC;aAAM,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAClC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,iBAAiB,CAAC,QAAQ,CAAA;YAC9C,WAAW,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,iBAAiB,CAAC,OAAO,CAAA;QACpE,CAAC;QAED,MAAM,gBAAgB,GAAa,EAAE,CAAA;QACrC,KAAK,MAAM,YAAY,IAAI,WAAW,EAAE,CAAC;YACvC,gBAAgB,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAA;QACxD,CAAC;QAED,OAAO,gBAAgB,CAAA;IACzB,CAAC;IAED;;;;;;OAMG;IACK,UAAU,CAAC,CAAS,EAAE,IAAc;QAC1C,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAA;QAC5E,CAAC;QACD,MAAM,MAAM,GAAG,EAAE,CAAA;QACjB,IAAI,GAAG,GAAG,CAAC,CAAA;QACX,OAAO,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;YACzB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;QAC1C,CAAC;QACD,OAAO,MAAM,CAAA;IACf,CAAC;IAYD;;OAEG;IACK,KAAK,CAAC,kBAAkB,CAAC,QAAsB;QACrD,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC/B,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;QACzC,CAAC;IACH,CAAC;;AAzNH,kCA4OC;AA3OC;;;;;;;GAOG;AACa,sBAAU,GAAW,sCAAsC,AAAjD,CAAiD;AAE3E;;;;;;;;GAQG;AACqB,gCAAoB,GAAW,GAAG,AAAd,CAAc;AAE1D;;;;;;;;GAQG;AACqB,mCAAuB,GAAW,EAAE,AAAb,CAAa"}

package/dist/cjs/models/device/motherboard.model.d.ts

@@ -0,0 +1,110 @@
+import { Device } from "../device.model.js";
+import type { IMotherboard } from "../../interfaces/device/motherboard.interface.js";
+/**
+ * Represents a Griptonite Motherboard device.
+ * {@link https://griptonite.io}
+ */
+export declare class Motherboard extends Device implements IMotherboard {
+    /**
+     * Length of the packet received from the device.
+     * @type {number}
+     * @static
+     * @readonly
+     * @constant
+     */
+    private static readonly packetLength;
+    /**
+     * Number of samples contained in the data packet.
+     * @type {number}
+     * @static
+     * @readonly
+     * @constant
+     */
+    private static readonly samplesNumber;
+    /**
+     * Buffer to store received data from the device.
+     * @type {number[]}
+     * @private
+     */
+    private receiveBuffer;
+    /**
+     * Calibration data for each sensor of the device.
+     * @type {number[][][]}
+     * @private
+     */
+    private calibrationData;
+    constructor();
+    /**
+     * Applies calibration to a sample value.
+     * @param {number} sample - The sample value to calibrate.
+     * @param {number[][]} calibration - The calibration data.
+     * @returns {number} The calibrated sample value.
+     */
+    private applyCalibration;
+    /**
+     * Retrieves battery or voltage information from the device.
+     * @returns {Promise<string | undefined>} A Promise that resolves with the battery or voltage information,
+     */
+    battery: () => Promise<string | undefined>;
+    /**
+     * Writes a command to get calibration data from the device.
+     * @returns {Promise<void>} A Promise that resolves when the command is successfully sent.
+     */
+    calibration: () => Promise<void>;
+    /**
+     * Retrieves firmware version from the device.
+     * @returns {Promise<string>} A Promise that resolves with the firmware version,
+     */
+    firmware: () => Promise<string | undefined>;
+    /**
+     * Handles data received from the Motherboard device. Processes hex-encoded streaming packets
+     * to extract samples, calibrate masses, and update running averages of mass data.
+     * If the received data is not a valid hex packet, it returns the unprocessed data.
+     *
+     * @param {DataView} value - The notification event.
+     */
+    handleNotifications: (value: DataView) => void;
+    /**
+     * Retrieves hardware version from the device.
+     * @returns {Promise<string>} A Promise that resolves with the hardware version,
+     */
+    hardware: () => Promise<string | undefined>;
+    /**
+     * Sets the LED color based on a single color option. Defaults to turning the LEDs off if no configuration is provided.
+     * @param {"green" | "red" | "orange"} [config] - Optional color or array of climb placements for the LEDs. Ignored if placements are provided.
+     * @returns {Promise<number[] | undefined>} A promise that resolves with the payload array for the Kilter Board if LED settings were applied, or `undefined` if no action was taken or for the Motherboard.
+     */
+    led: (config?: "green" | "red" | "orange") => Promise<number[] | undefined>;
+    /**
+     * Retrieves manufacturer information from the device.
+     * @returns {Promise<string>} A Promise that resolves with the manufacturer information,
+     */
+    manufacturer: () => Promise<string | undefined>;
+    /**
+     * Retrieves serial number from the device.
+     * @returns {Promise<string>} A Promise that resolves with the serial number,
+     */
+    serial: () => Promise<string | undefined>;
+    /**
+     * Stops the data stream on the specified device.
+     * @returns {Promise<void>} A promise that resolves when the stream is stopped.
+     */
+    stop: () => Promise<void>;
+    /**
+     * Starts streaming data from the specified device.
+     * @param {number} [duration=0] - The duration of the stream in milliseconds. If set to 0, stream will continue indefinitely.
+     * @returns {Promise<void>} A promise that resolves when the streaming operation is completed.
+     */
+    stream: (duration?: number) => Promise<void>;
+    /**
+     * Retrieves the entire 320 bytes of non-volatile memory from the device.
+     *
+     * The memory consists of 10 segments, each 32 bytes long. If any segment was previously written,
+     * the corresponding data will appear in the response. Unused portions of the memory are
+     * padded with whitespace.
+     *
+     * @returns {Promise<string>} A Promise that resolves with the 320-byte memory content as a string,
+     */
+    text: () => Promise<string | undefined>;
+}
+//# sourceMappingURL=motherboard.model.d.ts.map

package/dist/cjs/models/device/motherboard.model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"motherboard.model.d.ts","sourceRoot":"","sources":["../../../../src/models/device/motherboard.model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAC3C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kDAAkD,CAAA;AAGpF;;;GAGG;AACH,qBAAa,WAAY,SAAQ,MAAO,YAAW,YAAY;IAC7D;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAa;IAEjD;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAY;IAEjD;;;;OAIG;IACH,OAAO,CAAC,aAAa,CAAe;IAEpC;;;;OAIG;IACH,OAAO,CAAC,eAAe,CAAiC;;IA4FxD;;;;;OAKG;IACH,OAAO,CAAC,gBAAgB,CAkCvB;IAED;;;OAGG;IACH,OAAO,QAAa,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAE9C;IAED;;;OAGG;IACH,WAAW,QAAa,OAAO,CAAC,IAAI,CAAC,CAIpC;IAED;;;OAGG;IACH,QAAQ,QAAa,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAE/C;IAED;;;;;;OAMG;IACM,mBAAmB,GAAI,OAAO,QAAQ,KAAG,IAAI,CAiHrD;IAED;;;OAGG;IACH,QAAQ,QAAa,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAE/C;IAED;;;;OAIG;IACH,GAAG,GAAU,SAAS,OAAO,GAAG,KAAK,GAAG,QAAQ,KAAG,OAAO,CAAC,MAAM,EAAE,GAAG,SAAS,CAAC,CAe/E;IAED;;;OAGG;IACH,YAAY,QAAa,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAEnD;IAED;;;OAGG;IACH,MAAM,QAAa,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAM7C;IAED;;;OAGG;IACH,IAAI,QAAa,OAAO,CAAC,IAAI,CAAC,CAE7B;IAED;;;;OAIG;IACH,MAAM,GAAU,iBAAY,KAAG,OAAO,CAAC,IAAI,CAAC,CAa3C;IAED;;;;;;;;OAQG;IACH,IAAI,QAAa,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAM3C;CACF"}