@hangtime/grip-connect 0.3.10 → 0.4.1

package/README.md

@@ -46,7 +46,7 @@ Simply importing the utilities you need from `@hangtime/grip-connect`.
 ```
 
 ```js
-import { Motherboard, active, battery, connect, disconnect, info, notify, stream } from "@hangtime/grip-connect"
+import { Motherboard, active, battery, connect, disconnect, firmware, notify, stream } from "@hangtime/grip-connect"
 
 const motherboardButton = document.querySelector("#motherboard")
 
@@ -65,12 +65,16 @@ motherboardButton.addEventListener("click", () => {
         console.log(value)
       })
 
-      // Read battery + device info
-      await battery(Motherboard)
-      await info(Motherboard)
+      // Read info: battery + firmware
+      const batteryLevel = await battery(Motherboard)
+      console.log(batteryLevel)
 
-      // trigger LEDs
-      // await led(device)
+      const firmwareVersion = await firmware(Motherboard)
+      console.log(firmwareVersion)
+
+      // LEDs: "green", "red", "orange", or no argument to turn off
+      // await led(Motherboard, "red")
+      // await led(Motherboard)
 
       // Start weight streaming (for a minute) remove parameter for a continues stream
       await stream(Motherboard, 60000)
@@ -113,23 +117,28 @@ motherboardButton.addEventListener("click", () => {
 `chrome://bluetooth-internals/#devices` and press `Start Scan` to look for your device, click on `Inspect` and share all
 available services with us.
 
-|                                                                                         | Motherboard | Progressor | WH-C06 | Entralpi | Kilter Board | Climbro | mySmartBoard |
-| --------------------------------------------------------------------------------------- | ----------- | ---------- | ------ | -------- | ------------ | ------- | ------------ |
-| [Battery](https://stevie-ray.github.io/hangtime-grip-connect/api/battery.html)          | ✅          | ✅         |        |          |              |         |              |
-| [Calibration](https://stevie-ray.github.io/hangtime-grip-connect/api/calibration.html)  | ✅          |            |        |          |              |         |              |
-| [Connect](https://stevie-ray.github.io/hangtime-grip-connect/api/connect.html)          | ✅          | ✅         | ✅     | ✅       | ✅           |         |              |
-| [Disconnect](https://stevie-ray.github.io/hangtime-grip-connect/api/disconnect.html)    | ✅          | ✅         | ✅     | ✅       | ✅           |         |              |
-| [Download](https://stevie-ray.github.io/hangtime-grip-connect/api/download.html)        | ✅          | ✅         |        |          |              |         |              |
-| [Info](https://stevie-ray.github.io/hangtime-grip-connect/api/info.html)                | ✅          | ✅         |        |          |              |         |              |
-| [isActive](https://stevie-ray.github.io/hangtime-grip-connect/api/is-active.html)       | ✅          | ✅         | ✅     | ✅       |              |         |              |
-| [isConnected](https://stevie-ray.github.io/hangtime-grip-connect/api/is-connected.html) | ✅          | ✅         | ✅     | ✅       | ✅           |         |              |
-| [Led](https://stevie-ray.github.io/hangtime-grip-connect/api/led.html)                  | ✅          |            |        |          | ✅           |         |              |
-| [Notify](https://stevie-ray.github.io/hangtime-grip-connect/api/notify.html)            | ✅          | ✅         | ✅     | ✅       |              |         |              |
-| [Read](https://stevie-ray.github.io/hangtime-grip-connect/api/read.html)                | ✅          |            |        |          |              |         |              |
-| [Stop](https://stevie-ray.github.io/hangtime-grip-connect/api/stop.html)                | ✅          | ✅         |        |          |              |         |              |
-| [Stream](https://stevie-ray.github.io/hangtime-grip-connect/api/stream.html)            | ✅          | ✅         |        |          |              |         |              |
-| [Tare](https://stevie-ray.github.io/hangtime-grip-connect/api/tare.html)                | ✅          | ✅         | ✅     | ✅       |              |         |              |
-| [Write](https://stevie-ray.github.io/hangtime-grip-connect/api/write.html)              | ✅          | ✅         |        |          |              |         |              |
+|                                                                                          | Motherboard | Progressor | WH-C06 | Entralpi | Kilter Board | Climbro | mySmartBoard |
+| ---------------------------------------------------------------------------------------- | ----------- | ---------- | ------ | -------- | ------------ | ------- | ------------ |
+| [Battery](https://stevie-ray.github.io/hangtime-grip-connect/api/battery.html)           | ✅          | ✅         |        |          |              |         |              |
+| [Calibration](https://stevie-ray.github.io/hangtime-grip-connect/api/calibration.html)   | ✅          |            |        |          |              |         |              |
+| [Connect](https://stevie-ray.github.io/hangtime-grip-connect/api/connect.html)           | ✅          | ✅         | ✅     | ✅       | ✅           |         |              |
+| [Disconnect](https://stevie-ray.github.io/hangtime-grip-connect/api/disconnect.html)     | ✅          | ✅         | ✅     | ✅       | ✅           |         |              |
+| [Download](https://stevie-ray.github.io/hangtime-grip-connect/api/download.html)         | ✅          | ✅         |        |          |              |         |              |
+| [Firmware](https://stevie-ray.github.io/hangtime-grip-connect/api/firmware.html)         | ✅          | ✅         |        |          |              |         |              |
+| [Hardware](https://stevie-ray.github.io/hangtime-grip-connect/api/hardware.html)         | ✅          |            |        |          |              |         |              |
+| [isActive](https://stevie-ray.github.io/hangtime-grip-connect/api/is-active.html)        | ✅          | ✅         | ✅     | ✅       |              |         |              |
+| [isConnected](https://stevie-ray.github.io/hangtime-grip-connect/api/is-connected.html)  | ✅          | ✅         | ✅     | ✅       | ✅           |         |              |
+| [isDevice](https://stevie-ray.github.io/hangtime-grip-connect/api/is-device.html)        | ✅          | ✅         | ✅     | ✅       | ✅           |         |              |
+| [Led](https://stevie-ray.github.io/hangtime-grip-connect/api/led.html)                   | ✅          |            |        |          | ✅           |         |              |
+| [Manufacturer](https://stevie-ray.github.io/hangtime-grip-connect/api/manufacturer.html) | ✅          |            |        |          |              |         |              |
+| [Notify](https://stevie-ray.github.io/hangtime-grip-connect/api/notify.html)             | ✅          | ✅         | ✅     | ✅       |              |         |              |
+| [Read](https://stevie-ray.github.io/hangtime-grip-connect/api/read.html)                 | ✅          |            |        |          |              |         |              |
+| [Serial](https://stevie-ray.github.io/hangtime-grip-connect/api/serial.html)             | ✅          |            |        |          |              |         |              |
+| [Stop](https://stevie-ray.github.io/hangtime-grip-connect/api/stop.html)                 | ✅          | ✅         |        |          |              |         |              |
+| [Stream](https://stevie-ray.github.io/hangtime-grip-connect/api/stream.html)             | ✅          | ✅         |        |          |              |         |              |
+| [Tare](https://stevie-ray.github.io/hangtime-grip-connect/api/tare.html)                 | ✅          | ✅         | ✅     | ✅       |              |         |              |
+| [Text](https://stevie-ray.github.io/hangtime-grip-connect/api/text.html)                 | ✅          |            |        |          |              |         |              |
+| [Write](https://stevie-ray.github.io/hangtime-grip-connect/api/write.html)               | ✅          | ✅         |        |          |              |         |              |
 
 ## Development
 

package/dist/battery.d.ts

@@ -1,7 +1,12 @@
 import type { Device } from "./types/devices";
 /**
  * Retrieves battery or voltage information from the device.
- * @param {Device} board - The device.
- * @returns {Promise<void>} A Promise that resolves when the information is successfully retrieved.
+ * - For Motherboard devices, it reads the battery level.
+ * - For Progressor devices, it sends a command to retrieve battery voltage information.
+ *
+ * @param {Device} board - The device from which to retrieve battery information.
+ * @returns {Promise<string | undefined>} A Promise that resolves with the battery or voltage information,
+ *                            or rejects with an error if the device is not connected.
+ * @throws {Error} Throws an error if the device is not connected.
  */
-export declare const battery: (board: Device) => Promise<void>;
+export declare const battery: (board: Device) => Promise<string | undefined>;

package/dist/battery.js

@@ -1,25 +1,37 @@
 import { write } from "./write";
 import { read } from "./read";
 import { isConnected } from "./is-connected";
-import { Motherboard, Progressor } from "./devices";
+import { isMotherboard, isProgressor } from "./is-device";
 import { ProgressorCommands } from "./commands";
 /**
  * Retrieves battery or voltage information from the device.
- * @param {Device} board - The device.
- * @returns {Promise<void>} A Promise that resolves when the information is successfully retrieved.
+ * - For Motherboard devices, it reads the battery level.
+ * - For Progressor devices, it sends a command to retrieve battery voltage information.
+ *
+ * @param {Device} board - The device from which to retrieve battery information.
+ * @returns {Promise<string | undefined>} A Promise that resolves with the battery or voltage information,
+ *                            or rejects with an error if the device is not connected.
+ * @throws {Error} Throws an error if the device is not connected.
  */
 export const battery = async (board) => {
     // Check if the device is connected
     if (isConnected(board)) {
         // If the device is connected and it is a Motherboard device
-        if (board.filters.some((filter) => filter.name === "Motherboard")) {
+        if (isMotherboard(board)) {
             // Read battery level information from the Motherboard
-            await read(Motherboard, "battery", "level", 250);
+            return await read(board, "battery", "level", 250);
         }
         // If the device is connected and its name starts with "Progressor"
-        if (board.filters.some((filter) => filter.namePrefix === "Progressor")) {
+        if (isProgressor(board)) {
             // Write command to get battery voltage information to the Progressor
-            await write(Progressor, "progressor", "tx", ProgressorCommands.GET_BATT_VLTG, 250);
+            let response = undefined;
+            await write(board, "progressor", "tx", ProgressorCommands.GET_BATT_VLTG, 250, (data) => {
+                response = data;
+            });
+            return response;
         }
+        // If device is not found, return undefined
+        return;
     }
+    throw new Error("Not connected.");
 };

package/dist/calibration.js

@@ -1,6 +1,6 @@
 import { isConnected } from "./is-connected";
 import { write } from "./write";
-import { Motherboard } from "./devices";
+import { isMotherboard } from "./is-device";
 import { MotherboardCommands } from "./commands";
 /**
  * Writes a command to get calibration data from the device.
@@ -11,9 +11,11 @@ export const calibration = async (board) => {
     // Check if the device is connected
     if (isConnected(board)) {
         // If the device is connected, and it is a Motherboard device
-        if (board.filters.some((filter) => filter.name === "Motherboard")) {
+        if (isMotherboard(board)) {
             // Write the command to get calibration data to the device
-            await write(Motherboard, "uart", "tx", MotherboardCommands.GET_CALIBRATION, 2500);
+            await write(board, "uart", "tx", MotherboardCommands.GET_CALIBRATION, 2500, (data) => {
+                console.log(data);
+            });
         }
     }
 };

package/dist/commands/kilterboard.js

@@ -59,7 +59,7 @@ export const KilterBoardPlacementRoles = [
         position: 4,
         name: "foot",
         full_name: "Foot Only",
-        led_color: "FFA500",
+        led_color: "FFB600",
         screen_color: "FFA500",
     },
 ];

package/dist/connect.js

@@ -1,4 +1,5 @@
 import { handleEntralpiData, handleMotherboardData, handleProgressorData, handleWHC06Data } from "./data";
+import { isEntralpi, isMotherboard, isProgressor } from "./is-device";
 let server;
 const receiveBuffer = [];
 /**
@@ -21,7 +22,7 @@ const handleNotifications = (event, board) => {
     const value = characteristic.value;
     if (value) {
         // If the device is connected and it is a Motherboard device
-        if (board.filters.some((filter) => filter.name === "Motherboard")) {
+        if (isMotherboard(board)) {
             for (let i = 0; i < value.byteLength; i++) {
                 receiveBuffer.push(value.getUint8(i));
             }
@@ -35,7 +36,7 @@ const handleNotifications = (event, board) => {
                 handleMotherboardData(receivedData);
             }
         }
-        else if (board.filters.some((filter) => filter.name === "ENTRALPI")) {
+        else if (isEntralpi(board)) {
             if (value.buffer) {
                 const buffer = value.buffer;
                 const rawData = new DataView(buffer);
@@ -43,7 +44,7 @@ const handleNotifications = (event, board) => {
                 handleEntralpiData(receivedData);
             }
         }
-        else if (board.filters.some((filter) => filter.namePrefix === "Progressor")) {
+        else if (isProgressor(board)) {
             if (value.buffer) {
                 const buffer = value.buffer;
                 const rawData = new DataView(buffer);

package/dist/data/motherboard.d.ts

@@ -1,6 +1,10 @@
 export declare const CALIBRATION: never[][];
 /**
- * Handles data received from the Motherboard device.
- * @param {string} receivedData - The received data string.
+ * 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 {string} receivedData - The raw data received from the Motherboard device.
+ * @returns {void}
  */
 export declare const handleMotherboardData: (receivedData: string) => void;

package/dist/data/motherboard.js

@@ -1,4 +1,5 @@
 import { notifyCallback } from "./../notify";
+import { writeCallback } from "./../write";
 import { applyTare } from "./../tare";
 import { MotherboardCommands } from "./../commands";
 import { checkActivity } from "./../is-active";
@@ -51,8 +52,12 @@ const applyCalibration = (sample, calibration) => {
     return sign * final;
 };
 /**
- * Handles data received from the Motherboard device.
- * @param {string} receivedData - The received data string.
+ * 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 {string} receivedData - The raw data received from the Motherboard device.
+ * @returns {void}
  */
 export const handleMotherboardData = (receivedData) => {
     const receivedTime = Date.now();
@@ -131,6 +136,6 @@ export const handleMotherboardData = (receivedData) => {
     }
     else {
         // unhandled data
-        console.log(receivedData);
+        writeCallback(receivedData);
     }
 };

package/dist/data/progressor.d.ts

@@ -1,5 +1,9 @@
 /**
- * Handles data received from the Progressor device.
- * @param {DataView} data - The received data.
+ * Handles data received from the Progressor device, processes weight measurements,
+ * and updates mass data including maximum and average values.
+ * It also handles command responses for retrieving device information.
+ *
+ * @param {DataView} data - The raw binary data received from the Progressor device.
+ * @returns {void}
  */
 export declare const handleProgressorData: (data: DataView) => void;

package/dist/data/progressor.js

@@ -2,7 +2,7 @@ import { notifyCallback } from "./../notify";
 import { applyTare } from "./../tare";
 import { checkActivity } from "./../is-active";
 import { ProgressorCommands, ProgressorResponses } from "./../commands/progressor";
-import { lastWrite } from "./../write";
+import { lastWrite, writeCallback } from "./../write";
 import struct from "./../struct";
 import { DownloadPackets } from "./../download";
 // Constants
@@ -11,8 +11,12 @@ let MASS_AVERAGE = "0";
 let MASS_TOTAL_SUM = 0;
 let DATAPOINT_COUNT = 0;
 /**
- * Handles data received from the Progressor device.
- * @param {DataView} data - The received data.
+ * Handles data received from the Progressor device, processes weight measurements,
+ * and updates mass data including maximum and average values.
+ * It also handles command responses for retrieving device information.
+ *
+ * @param {DataView} data - The raw binary data received from the Progressor device.
+ * @returns {void}
  */
 export const handleProgressorData = (data) => {
     const receivedTime = Date.now();
@@ -55,8 +59,7 @@ export const handleProgressorData = (data) => {
             return;
         let value = "";
         if (lastWrite === ProgressorCommands.GET_BATT_VLTG) {
-            const vdd = new DataView(data.buffer, 2).getUint32(0, true);
-            value = `ℹ️ Battery level: ${vdd} mV`;
+            value = new DataView(data.buffer, 2).getUint32(0, true).toString();
         }
         else if (lastWrite === ProgressorCommands.GET_FW_VERSION) {
             value = new TextDecoder().decode(data.buffer.slice(2));
@@ -64,12 +67,12 @@ export const handleProgressorData = (data) => {
         else if (lastWrite === ProgressorCommands.GET_ERR_INFO) {
             value = new TextDecoder().decode(data.buffer.slice(2));
         }
-        console.log(value);
+        writeCallback(value);
     }
     else if (kind === ProgressorResponses.LOW_BATTERY_WARNING) {
         console.warn("⚠️ Low power detected. Please consider connecting to a power source.");
     }
     else {
-        console.error(`❌ Error: Unknown message kind detected: ${kind}`);
+        throw new Error(`Unknown message kind detected: ${kind}`);
     }
 };

package/dist/devices/kilterboard.d.ts

@@ -1,4 +1,8 @@
 import type { Device } from "../types/devices";
+/**
+ * Aurora Climbing Advertising service
+ */
+export declare const AuroraUUID = "4488b571-7806-4df6-bcff-a2897e4953ff";
 /**
  * Represents a Aurora Climbing device
  * Kilter Board, Tension Board, Decoy Board, Touchstone Board, Grasshopper Board, Aurora Board, So iLL Board

package/dist/devices/kilterboard.js

@@ -1,3 +1,7 @@
+/**
+ * Aurora Climbing Advertising service
+ */
+export const AuroraUUID = "4488b571-7806-4df6-bcff-a2897e4953ff";
 /**
  * Represents a Aurora Climbing device
  * Kilter Board, Tension Board, Decoy Board, Touchstone Board, Grasshopper Board, Aurora Board, So iLL Board
@@ -5,7 +9,7 @@
 export const KilterBoard = {
     filters: [
         {
-            services: ["4488b571-7806-4df6-bcff-a2897e4953ff"], // Aurora Climbing Advertising service
+            services: [AuroraUUID],
         },
     ],
     services: [

package/dist/firmware.d.ts

@@ -0,0 +1,12 @@
+import type { Device } from "./types/devices";
+/**
+ * Retrieves firmware version from the device.
+ * - For Motherboard devices, it reads the firmare version.
+ * - For Progressor devices, it sends a command to retrieve firware version.
+ *
+ * @param {Device} board - The device from which to retrieve firmware version.
+ * @returns {Promise<string>} A Promise that resolves with the firmware version,
+ *                            or rejects with an error if the device is not connected.
+ * @throws {Error} Throws an error if the device is not connected.
+ */
+export declare const firmware: (board: Device) => Promise<string | undefined>;

package/dist/firmware.js

@@ -0,0 +1,37 @@
+import { write } from "./write";
+import { read } from "./read";
+import { isConnected } from "./is-connected";
+import { ProgressorCommands } from "./commands";
+import { isMotherboard, isProgressor } from "./is-device";
+/**
+ * Retrieves firmware version from the device.
+ * - For Motherboard devices, it reads the firmare version.
+ * - For Progressor devices, it sends a command to retrieve firware version.
+ *
+ * @param {Device} board - The device from which to retrieve firmware version.
+ * @returns {Promise<string>} A Promise that resolves with the firmware version,
+ *                            or rejects with an error if the device is not connected.
+ * @throws {Error} Throws an error if the device is not connected.
+ */
+export const firmware = async (board) => {
+    // Check if the device is connected
+    if (isConnected(board)) {
+        // If the device is connected and it is a Motherboard device
+        if (isMotherboard(board)) {
+            // Read firmware version from the Motherboard
+            return await read(board, "device", "firmware", 250);
+        }
+        // If the device is connected and its name starts with "Progressor"
+        if (isProgressor(board)) {
+            // Write command to get firmware version information to the Progressor
+            let response = undefined;
+            await write(board, "progressor", "tx", ProgressorCommands.GET_FW_VERSION, 250, (data) => {
+                response = data;
+            });
+            return response;
+        }
+        // If device is not found, return undefined
+        return;
+    }
+    throw new Error("Not connected.");
+};

package/dist/hardware.d.ts

@@ -0,0 +1,11 @@
+import type { Device } from "./types/devices";
+/**
+ * Retrieves hardware version from the device.
+ * - For Motherboard devices, it reads the hardware version.
+ *
+ * @param {Device} board - The device from which to retrieve hardware version.
+ * @returns {Promise<string>} A Promise that resolves with the hardware version,
+ *                            or rejects with an error if the device is not connected.
+ * @throws {Error} Throws an error if the device is not connected.
+ */
+export declare const hardware: (board: Device) => Promise<string | undefined>;

package/dist/hardware.js

@@ -0,0 +1,25 @@
+import { read } from "./read";
+import { isConnected } from "./is-connected";
+import { isMotherboard } from "./is-device";
+/**
+ * Retrieves hardware version from the device.
+ * - For Motherboard devices, it reads the hardware version.
+ *
+ * @param {Device} board - The device from which to retrieve hardware version.
+ * @returns {Promise<string>} A Promise that resolves with the hardware version,
+ *                            or rejects with an error if the device is not connected.
+ * @throws {Error} Throws an error if the device is not connected.
+ */
+export const hardware = async (board) => {
+    // Check if the device is connected
+    if (isConnected(board)) {
+        // If the device is connected and it is a Motherboard device
+        if (isMotherboard(board)) {
+            // Read hardware version from the Motherboard
+            return await read(board, "device", "hardware", 250);
+        }
+        // If device is not found, return undefined
+        return;
+    }
+    throw new Error("Not connected.");
+};

package/dist/index.d.ts

@@ -1,12 +1,17 @@
 export { Climbro, Entralpi, KilterBoard, Motherboard, mySmartBoard, WHC06, Progressor } from "./devices/index";
-export { battery } from "./battery";
+export { isEntralpi, isKilterboard, isMotherboard, isWHC06, isProgressor } from "./is-device";
 export { calibration } from "./calibration";
 export { download } from "./download";
 export { connect } from "./connect";
 export { disconnect } from "./disconnect";
 export { active, isActive } from "./is-active";
 export { isConnected } from "./is-connected";
-export { info } from "./info";
+export { battery } from "./battery";
+export { firmware } from "./firmware";
+export { hardware } from "./hardware";
+export { manufacturer } from "./manufacturer";
+export { text } from "./text";
+export { serial } from "./serial";
 export { led } from "./led";
 export { notify } from "./notify";
 export { stop } from "./stop";

package/dist/index.js

@@ -1,7 +1,7 @@
 // Export device types
 export { Climbro, Entralpi, KilterBoard, Motherboard, mySmartBoard, WHC06, Progressor } from "./devices/index";
-// Export battery related functions
-export { battery } from "./battery";
+// Export isDevice functions
+export { isEntralpi, isKilterboard, isMotherboard, isWHC06, isProgressor } from "./is-device";
 // Export calibration function
 export { calibration } from "./calibration";
 // Export download function
@@ -11,8 +11,14 @@ export { connect } from "./connect";
 export { disconnect } from "./disconnect";
 export { active, isActive } from "./is-active";
 export { isConnected } from "./is-connected";
-// Export information retrieval function
-export { info } from "./info";
+// Export information retrieval functions
+export { battery } from "./battery";
+export { firmware } from "./firmware";
+// Export "Motherboard exclusive" functions
+export { hardware } from "./hardware";
+export { manufacturer } from "./manufacturer";
+export { text } from "./text";
+export { serial } from "./serial";
 // Export led retrieval function
 export { led } from "./led";
 // Export notification related function

package/dist/is-device.d.ts

@@ -0,0 +1,31 @@
+import type { Device } from "./types/devices";
+/**
+ * Checks if the given device is a Motherboard.
+ * @param {Device} [board] - The device to check.
+ * @returns {boolean} `true` if the device has a filter with the name "Motherboard", otherwise `false`.
+ */
+export declare const isMotherboard: (board?: Device) => boolean;
+/**
+ * Checks if the given device is a Progressor.
+ * @param {Device} [board] - The device to check.
+ * @returns {boolean} `true` if the device has a filter with a namePrefix of "Progressor", otherwise `false`.
+ */
+export declare const isProgressor: (board?: Device) => boolean;
+/**
+ * Checks if the given device is an Entralpi device.
+ * @param {Device} [board] - The device to check.
+ * @returns {boolean} `true` if the device has a filter with the name "ENTRALPI", otherwise `false`.
+ */
+export declare const isEntralpi: (board?: Device) => boolean;
+/**
+ * Checks if the given device is a Kilterboard.
+ * @param {Device} [board] - The device to check.
+ * @returns {boolean} `true` if the device has a service UUID matching the Kilterboard Aurora UUID, otherwise `false`.
+ */
+export declare const isKilterboard: (board?: Device) => boolean;
+/**
+ * Checks if the given device is a WH-C06.
+ * @param {Device} [board] - The device to check.
+ * @returns {boolean} `true` if the device has a filter with the company identifier 0x0100, otherwise `false`.
+ */
+export declare const isWHC06: (board?: Device) => boolean;

package/dist/is-device.js

@@ -0,0 +1,33 @@
+import { AuroraUUID } from "./devices/kilterboard";
+/**
+ * Checks if the given device is a Motherboard.
+ * @param {Device} [board] - The device to check.
+ * @returns {boolean} `true` if the device has a filter with the name "Motherboard", otherwise `false`.
+ */
+export const isMotherboard = (board) => board?.filters.some((filter) => filter.name === "Motherboard") ?? false;
+/**
+ * Checks if the given device is a Progressor.
+ * @param {Device} [board] - The device to check.
+ * @returns {boolean} `true` if the device has a filter with a namePrefix of "Progressor", otherwise `false`.
+ */
+export const isProgressor = (board) => board?.filters.some((filter) => filter.namePrefix === "Progressor") ?? false;
+/**
+ * Checks if the given device is an Entralpi device.
+ * @param {Device} [board] - The device to check.
+ * @returns {boolean} `true` if the device has a filter with the name "ENTRALPI", otherwise `false`.
+ */
+export const isEntralpi = (board) => board?.filters.some((filter) => filter.name === "ENTRALPI") ?? false;
+/**
+ * Checks if the given device is a Kilterboard.
+ * @param {Device} [board] - The device to check.
+ * @returns {boolean} `true` if the device has a service UUID matching the Kilterboard Aurora UUID, otherwise `false`.
+ */
+export const isKilterboard = (board) => {
+    return board?.filters.some((filter) => filter.services?.includes(AuroraUUID)) ?? false;
+};
+/**
+ * Checks if the given device is a WH-C06.
+ * @param {Device} [board] - The device to check.
+ * @returns {boolean} `true` if the device has a filter with the company identifier 0x0100, otherwise `false`.
+ */
+export const isWHC06 = (board) => board?.filters.some((filter) => filter.manufacturerData?.some((data) => data.companyIdentifier === 0x0100)) ?? false;

package/dist/led.d.ts

@@ -12,9 +12,13 @@ declare class ClimbPlacement {
 export declare function prepBytesV3(climbPlacementList: ClimbPlacement[]): number[];
 /**
  * Sets the LEDs on the specified device.
+ *
+ * - For Kilter Board: Configures the LEDs based on an array of climb placements. If a configuration is provided, it prepares and sends a payload to the device.
+ * - For Motherboard: Sets the LED color based on a single color option. Defaults to turning the LEDs off if no configuration is provided.
+ *
  * @param {Device} board - The device on which to set the LEDs.
- * @param {ClimbPlacement[]} [placement] - An optional array of climb placements for LED positioning.
- * @returns {Promise<number[] | undefined>} A promise that resolves with the payload array if LED settings were applied, or `undefined` if no action was taken.
+ * @param {"green" | "red" | "orange" | ClimbPlacement[]} [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.
  */
-export declare const led: (board: Device, placement?: ClimbPlacement[]) => Promise<number[] | undefined>;
+export declare const led: (board: Device, config?: "green" | "red" | "orange" | ClimbPlacement[]) => Promise<number[] | undefined>;
 export {};