@hangtime/grip-connect 0.3.9 → 0.4.0

package/README.md

@@ -7,8 +7,7 @@ Force-Sensing Hangboards / Dynamometers / Plates / LED system boards used by cli
 the [Griptonite Motherboard](https://griptonite.io/shop/motherboard/), [Climbro](https://climbro.com/),
 [mySmartBoard](https://www.smartboard-climbing.com/), [Entralpi](https://entralpi.com/),
 [Tindeq Progressor](https://tindeq.com/) or
-[Weiheng WH-C06](https://weihengmanufacturer.com/products/wh-c06-bluetooth-300kg-hanging-scale/) also sold as
-[MAT Muscle Meter](https://www.matassessment.com/musclemeter).
+[Weiheng WH-C06](https://weihengmanufacturer.com/products/wh-c06-bluetooth-300kg-hanging-scale/).
 
 And LED system boards from [Aurora Climbing](https://auroraclimbing.com/) like the
 [Kilter Board](https://settercloset.com/pages/the-kilter-board),
@@ -47,80 +46,97 @@ 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")
 
 motherboardButton.addEventListener("click", () => {
-  connect(Motherboard, async () => {
-    // Listen for stream notifications
-    notify((data) => {
-      // { massTotal: "0", massMax: "0", massAverage: "0", massLeft: "0", massCenter: "0", massRight: "0" }
-      console.log(data)
-    })
-
-    // Check if device is being used
-    active((value) => {
-      console.log(value)
-    })
-
-    // Read battery + device info
-    await battery(Motherboard)
-    await info(Motherboard)
-
-    // trigger LEDs
-    // await led(device)
-
-    // Start weight streaming (for a minute) remove parameter for a continues stream
-    await stream(Motherboard, 60000)
-
-    // Manualy tare the device when the stream is running
-    // await tare(5000)
-
-    // Manually call stop method if stream is continues
-    // await stop(Motherboard)
-
-    // Download data as CSV, JSON, or XML (default: CSV) format => timestamp, frame, battery, samples, masses
-    // download('json')
-
-    // Disconnect from device after we are done
-    disconnect(Motherboard)
-  })
+  connect(
+    Motherboard,
+    async () => {
+      // Listen for stream notifications
+      notify((data) => {
+        // { massTotal: "0", massMax: "0", massAverage: "0", massLeft: "0", massCenter: "0", massRight: "0" }
+        console.log(data)
+      })
+
+      // Check if device is being used
+      active((value) => {
+        console.log(value)
+      })
+
+      // Read info: battery + firmware
+      const batteryLevel = await battery(Motherboard)
+      console.log(batteryLevel)
+
+      const firmwareVersion = await firmware(Motherboard)
+      console.log(firmwareVersion)
+
+      // trigger LEDs
+      // await led(Motherboard)
+
+      // Start weight streaming (for a minute) remove parameter for a continues stream
+      await stream(Motherboard, 60000)
+
+      // Manualy tare the device when the stream is running
+      // await tare(5000)
+
+      // Manually call stop method if stream is continues
+      // await stop(Motherboard)
+
+      // Download data as CSV, JSON, or XML (default: CSV) format => timestamp, frame, battery, samples, masses
+      // download('json')
+
+      // Disconnect from device after we are done
+      disconnect(Motherboard)
+    },
+    (error) => {
+      // Optinal custom error handeling
+      console.error(error.message)
+    },
+  )
 })
 ```
 
-## Roadmap
+## Device support
 
-**Help wanted:** Do you own any of these devices? Use Google Chrome's Bluetooth Internals
+- ✅ Griptonite - Motherboard
+- ✅ Tindeq - Progressor
+- ✅ Weiheng - WH-C06
+  - By default [watchAdvertisements](https://chromestatus.com/feature/5180688812736512) isn't supported . For Chrome,
+    enable it at `chrome://flags/#enable-experimental-web-platform-features`.
+- ✅ Kilter Board
+- ⏳ Entralpi (not verified)
+- ➡️ Climbro
+- ➡️ Smartboard Climbing - mySmartBoard
+
+## Features
+
+**Help wanted:** Do you own any of the missing devices? Use Google Chrome's Bluetooth Internals
 `chrome://bluetooth-internals/#devices` and press `Start Scan` to look for your device, click on `Inspect` and share all
 available services with us.
 
-### Device support
-
-- ✅ Griptonite Motherboard
-- ✅ Tindeq Progressor
-- ⏳ Entralpi (not verified)
-- ⏳ Kilterboard (see example)
-- ⏳ Weiheng WH-C06 / MAT Muscle Meter
-  - Enable: `chrome://flags#enable-experimental-web-platform-features`
-- ➡️ Climbro
-- ➡️ mySmartBoard
-
-### Features
-
-- ✅ Connect / Disconnect
-- ✅ Start / Stop data stream
-- ✅ Battery status
-- ✅ Read calibration
-- ✅ Device info: firmware / serial etc.
-- ✅ Check if device is connected
-- ✅ Check if device is being used
-- ✅ Peak / Average load
-- ✅️ Tare / unladen weight
-- ✅️ Download data (CSV, JSON, XML)
-- ➡️ Endurance
-- ➡️ Rate of Force Development: RFD
-- ➡️ Critical Force
+|                                                                                          | 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)  | ✅          | ✅         | ✅     | ✅       | ✅           |         |              |
+| [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

@@ -5,8 +5,13 @@ import { Motherboard, Progressor } from "./devices";
 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
@@ -14,12 +19,19 @@ export const battery = async (board) => {
         // If the device is connected and it is a Motherboard device
         if (board.filters.some((filter) => filter.name === "Motherboard")) {
             // Read battery level information from the Motherboard
-            await read(Motherboard, "battery", "level", 250);
+            return await read(Motherboard, "battery", "level", 250);
         }
         // If the device is connected and its name starts with "Progressor"
         if (board.filters.some((filter) => filter.namePrefix === "Progressor")) {
             // 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(Progressor, "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

@@ -13,7 +13,9 @@ export const calibration = async (board) => {
         // If the device is connected, and it is a Motherboard device
         if (board.filters.some((filter) => filter.name === "Motherboard")) {
             // Write the command to get calibration data to the device
-            await write(Motherboard, "uart", "tx", MotherboardCommands.GET_CALIBRATION, 2500);
+            await write(Motherboard, "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.d.ts

@@ -2,6 +2,7 @@ import type { Device } from "./types/devices";
 /**
  * Connects to a Bluetooth device.
  * @param {Device} board - The device to connect to.
- * @param {Function} onSuccess - Callback function to execute on successful connection.
+ * @param {Function} [onSuccess] - Optional callback function to execute on successful connection. Default logs success.
+ * @param {Function} [onError] - Optional callback function to execute on error. Default logs the error.
  */
-export declare const connect: (board: Device, onSuccess: () => void) => Promise<void>;
+export declare const connect: (board: Device, onSuccess?: () => void, onError?: (error: Error) => void) => Promise<void>;

package/dist/connect.js

@@ -9,7 +9,7 @@ const receiveBuffer = [];
 const onDisconnected = (event, board) => {
     board.device = undefined;
     const device = event.target;
-    console.log(`Device ${device.name} is disconnected.`);
+    throw new Error(`Device ${device.name} is disconnected.`);
 };
 /**
  * Handles notifications received from a characteristic.
@@ -61,46 +61,40 @@ const handleNotifications = (event, board) => {
  * @param {Function} onSuccess - Callback function to execute on successful connection.
  */
 const onConnected = async (board, onSuccess) => {
-    try {
-        // Connect to GATT server and set up characteristics
-        const services = await server.getPrimaryServices();
-        if (!services || services.length === 0) {
-            console.error("No services found");
-            return;
-        }
-        for (const service of services) {
-            const matchingService = board.services.find((boardService) => boardService.uuid === service.uuid);
-            if (matchingService) {
-                // Android bug: Introduce a delay before getting characteristics
-                await new Promise((resolve) => setTimeout(resolve, 100));
-                const characteristics = await service.getCharacteristics();
-                for (const characteristic of matchingService.characteristics) {
-                    const matchingCharacteristic = characteristics.find((char) => char.uuid === characteristic.uuid);
-                    if (matchingCharacteristic) {
-                        const element = matchingService.characteristics.find((char) => char.uuid === matchingCharacteristic.uuid);
-                        if (element) {
-                            element.characteristic = matchingCharacteristic;
-                            // notify
-                            if (element.id === "rx") {
-                                matchingCharacteristic.startNotifications();
-                                matchingCharacteristic.addEventListener("characteristicvaluechanged", (event) => {
-                                    handleNotifications(event, board);
-                                });
-                            }
+    // Connect to GATT server and set up characteristics
+    const services = await server.getPrimaryServices();
+    if (!services || services.length === 0) {
+        throw new Error("No services found");
+    }
+    for (const service of services) {
+        const matchingService = board.services.find((boardService) => boardService.uuid === service.uuid);
+        if (matchingService) {
+            // Android bug: Introduce a delay before getting characteristics
+            await new Promise((resolve) => setTimeout(resolve, 100));
+            const characteristics = await service.getCharacteristics();
+            for (const characteristic of matchingService.characteristics) {
+                const matchingCharacteristic = characteristics.find((char) => char.uuid === characteristic.uuid);
+                if (matchingCharacteristic) {
+                    const element = matchingService.characteristics.find((char) => char.uuid === matchingCharacteristic.uuid);
+                    if (element) {
+                        element.characteristic = matchingCharacteristic;
+                        // notify
+                        if (element.id === "rx") {
+                            matchingCharacteristic.startNotifications();
+                            matchingCharacteristic.addEventListener("characteristicvaluechanged", (event) => {
+                                handleNotifications(event, board);
+                            });
                         }
                     }
-                    else {
-                        console.warn(`Characteristic ${characteristic.uuid} not found in service ${service.uuid}`);
-                    }
+                }
+                else {
+                    throw new Error(`Characteristic ${characteristic.uuid} not found in service ${service.uuid}`);
                 }
             }
         }
-        // Call the onSuccess callback after successful connection and setup
-        onSuccess();
-    }
-    catch (error) {
-        console.error(error);
     }
+    // Call the onSuccess callback after successful connection and setup
+    onSuccess();
 };
 /**
  * Returns UUIDs of all services associated with the device.
@@ -113,9 +107,10 @@ const getAllServiceUUIDs = (device) => {
 /**
  * Connects to a Bluetooth device.
  * @param {Device} board - The device to connect to.
- * @param {Function} onSuccess - Callback function to execute on successful connection.
+ * @param {Function} [onSuccess] - Optional callback function to execute on successful connection. Default logs success.
+ * @param {Function} [onError] - Optional callback function to execute on error. Default logs the error.
  */
-export const connect = async (board, onSuccess) => {
+export const connect = async (board, onSuccess = () => console.log("Connected successfully"), onError = (error) => console.error(error)) => {
     try {
         // Request device and set up connection
         const deviceServices = getAllServiceUUIDs(board);
@@ -128,8 +123,7 @@ export const connect = async (board, onSuccess) => {
         });
         board.device = device;
         if (!board.device.gatt) {
-            console.error("GATT is not available on this device");
-            return;
+            throw new Error("GATT is not available on this device");
         }
         board.device.addEventListener("gattserverdisconnected", (event) => {
             onDisconnected(event, board);
@@ -145,8 +139,17 @@ export const connect = async (board, onSuccess) => {
                 handleWHC06Data(manufacturerData);
             }
         });
+        // When the companyIdentifier is provided we want to get manufacturerData using watchAdvertisements.
         if (optionalManufacturerData.length) {
-            await board.device.watchAdvertisements();
+            // Receive events when the system receives an advertisement packet from a watched device.
+            // To use this function in Chrome: chrome://flags/#enable-experimental-web-platform-features has to be enabled.
+            // More info: https://chromestatus.com/feature/5180688812736512
+            if (typeof board.device.watchAdvertisements === "function") {
+                await board.device.watchAdvertisements();
+            }
+            else {
+                throw new Error("watchAdvertisements isn't supported. For Chrome, enable it at chrome://flags/#enable-experimental-web-platform-features.");
+            }
         }
         server = await board.device.gatt.connect();
         if (server.connected) {
@@ -154,6 +157,6 @@ export const connect = async (board, onSuccess) => {
         }
     }
     catch (error) {
-        console.error(error);
+        onError(error);
     }
 };

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/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 { Motherboard, Progressor } from "./devices";
+import { ProgressorCommands } from "./commands";
+/**
+ * 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 (board.filters.some((filter) => filter.name === "Motherboard")) {
+            // Read firmware version from the Motherboard
+            return await read(Motherboard, "device", "firmware", 250);
+        }
+        // If the device is connected and its name starts with "Progressor"
+        if (board.filters.some((filter) => filter.namePrefix === "Progressor")) {
+            // Write command to get firmware version information to the Progressor
+            let response = undefined;
+            await write(Progressor, "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 { Motherboard } from "./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 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 (board.filters.some((filter) => filter.name === "Motherboard")) {
+            // Read hardware version from the Motherboard
+            return await read(Motherboard, "device", "hardware", 250);
+        }
+        // If device is not found, return undefined
+        return;
+    }
+    throw new Error("Not connected.");
+};

package/dist/index.d.ts

@@ -1,12 +1,16 @@
 export { Climbro, Entralpi, KilterBoard, Motherboard, mySmartBoard, WHC06, Progressor } from "./devices/index";
-export { battery } from "./battery";
 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,5 @@
 // Export device types
 export { Climbro, Entralpi, KilterBoard, Motherboard, mySmartBoard, WHC06, Progressor } from "./devices/index";
-// Export battery related functions
-export { battery } from "./battery";
 // Export calibration function
 export { calibration } from "./calibration";
 // Export download function
@@ -11,8 +9,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