@hangtime/grip-connect 0.0.6 → 0.0.8

package/README.md

@@ -2,23 +2,42 @@
 
 **Force-Sensing Climbing Training**
 
-The objective of this project is to create a client that can establish connections with various Force-Sensing Hangboards
-/ Plates used by climbers for strength measurement. Examples of such hangboards include the
+The objective of this project is to create a Web Bluetooth API client that can establish connections with various
+Force-Sensing Hangboards / Plates used by climbers for strength measurement. Examples of such hangboards include the
 [Motherboard](https://griptonite.io/shop/motherboard/), [Climbro](https://climbro.com/),
 [SmartBoard](https://www.smartboard-climbing.com/), [Entralpi](https://entralpi.com/) or
 [Tindeq Progressor](https://tindeq.com/)
 
+[Try it out](https://grip-connect.vercel.app/) - [Docs](https://stevie-ray.github.io/hangtime-grip-connect/) -
+[Browser Support](https://caniuse.com/web-bluetooth)
+
 ## Roadmap
 
-- ➡️ Connect with devices
-  - ✅ Griptonte Motherboard
-  - ✅ Tindeq Progressor
-  - ✅ Entralpi
-  - ➡️ Climbro
-  - ➡️ SmartBoard
-- ✅ Read / Write / Notify using Bluetooth
-- ➡️ Calibrate Devices
-- ➡️ Output weight/force stream
+- ✅ Griptonte Motherboard
+  - ✅️ Connect with devices
+  - ✅️ Read / Write / Notify using Bluetooth
+  - ➡️ Calibrate Devices
+  - ✅️ Output weight/force stream
+- ✅ Tindeq Progressor
+  - ✅️ Connect with devices
+  - ✅️ Read / Write / Notify using Bluetooth
+  - ➡️ Calibrate Devices
+  - ➡️ Output weight/force stream
+- ✅ Entralpi
+  - ✅️ Connect with devices
+  - ✅️ Read / Write / Notify using Bluetooth
+  - ➡️ Calibrate Devices
+  - ➡️ Output weight/force stream
+- ➡️ Climbro
+  - ➡️ Connect with devices
+  - ➡️ Read / Write / Notify using Bluetooth
+  - ➡️ Calibrate Devices
+  - ➡️ Output weight/force stream
+- ➡️ SmartBoard
+  - ➡️ Connect with devices
+  - ➡️ Read / Write / Notify using Bluetooth
+  - ➡️ Calibrate Devices
+  - ➡️ Output weight/force stream
 
 ## Development
 
@@ -56,30 +75,41 @@ motherboardButton.addEventListener("click", () => {
     })
 
     // read battery + device info
-    await read(Motherboard, "battery", "level")
-    await read(Motherboard, "device", "manufacturer")
-    await read(Motherboard, "device", "hardware")
-    await read(Motherboard, "device", "firmware")
+    await read(Motherboard, "battery", "level", 1000)
+    await read(Motherboard, "device", "manufacturer", 1000)
+    await read(Motherboard, "device", "hardware", 1000)
+    await read(Motherboard, "device", "firmware", 1000)
 
-    // Calibrate?
-    await write(Motherboard, "uart", "tx", "C", 5000)
+    // recalibrate
+    await write(Motherboard, "uart", "tx", "", 0)
+    await write(Motherboard, "uart", "tx", "", 0)
+    await write(Motherboard, "uart", "tx", "", 1000)
 
-    // Read stream?
-    await write(Motherboard, "unknown", "01", "1", 2500)
-    await write(Motherboard, "unknown", "02", "0", 2500)
-    await write(Motherboard, "uart", "tx", "S30", 5000)
+    await write(Motherboard, "uart", "tx", "C3,0,0,0", 5000)
 
-    // Read stream (2x)?
-    await write(Motherboard, "unknown", "01", "0", 2500)
-    await write(Motherboard, "unknown", "02", "1", 2500)
-    await write(Motherboard, "uart", "tx", "S30", 5000)
+    // start stream
+    await write(Motherboard, "uart", "tx", "S20", 15000)
 
+    // end stream
+    await write(Motherboard, "uart", "tx", "", 0)
     // disconnect from device after we are done
     disconnect(Motherboard)
   })
 })
 ```
 
+## Credits
+
+A special thank you to:
+
+- [@CassimLadha](https://github.com/CassimLadha) for sharing insights on reading the Motherboards data.
+- [@donaldharvey](https://github.com/donaldharvey) for a valuable example on connecting to the motherboard.
+
+## Disclamer
+
+THIS SOFTWARE IS NOT OFFICIALY SUPPORTED, SUPPLIED OR MAINTAINED BY THE DEVICE MANUFACTURER. BY USING THE SOFTWARE YOU
+ARE ACKNOWLEDGEING THIS AND UNDERSTAND THAT USING THIS SOFTWARE WILL INVALIDATE THE MANUFACTURERS WARRANTY.
+
 ## License
 
-MIT © [Stevie-Ray Hartog](https://github.com/Stevie-Ray)
+BSD 2-Clause © [Stevie-Ray Hartog](https://github.com/Stevie-Ray)

package/build/connect.d.ts

@@ -1,6 +1,6 @@
 import { Device } from "./devices/types";
 /**
- * connect
+ * Connect to the BluetoothDevice
  * @param device
  * @param onSuccess
  */

package/build/connect.js

@@ -1,4 +1,7 @@
 import { notifyCallback } from "./notify";
+import { handleMotherboardData } from "./devices/moterboard";
+let server;
+const receiveBuffer = [];
 /**
  * onDisconnected
  * @param board
@@ -16,63 +19,83 @@ const onDisconnected = (event, board) => {
  */
 const handleNotifications = (event, board) => {
     const characteristic = event.target;
-    const receivedData = new Uint8Array(characteristic.value.buffer);
-    // Create an array to store the parsed decimal values
-    const decimalArray = [];
-    // Iterate through each byte and convert to decimal
-    for (let i = 0; i < receivedData.length; i++) {
-        decimalArray.push(receivedData[i]);
-    }
-    // Convert the decimal array to a string representation
-    const receivedString = String.fromCharCode(...decimalArray);
-    if (board.name === "Motherboard") {
-        // Split the string into pairs of characters
-        const hexPairs = receivedString.match(/.{1,2}/g);
-        // Convert each hexadecimal pair to decimal
-        const parsedDecimalArray = hexPairs?.map((hexPair) => parseInt(hexPair, 16));
-        // Handle different types of data
-        if (characteristic.value.byteLength === 20) {
-            const elementKeys = [
-                "frames",
-                "cycle",
-                "unknown",
-                "eleven",
-                "dynamic1",
-                "pressure1",
-                "left",
-                "dynamic2",
-                "pressure2",
-                "right",
-            ];
-            const dataObject = {};
-            if (parsedDecimalArray) {
-                elementKeys.forEach((key, index) => {
-                    dataObject[key] = parsedDecimalArray[index];
-                });
+    const value = characteristic.value;
+    if (value) {
+        if (board.name === "Motherboard") {
+            if (value) {
+                for (let i = 0; i < value.byteLength; i++) {
+                    receiveBuffer.push(value.getUint8(i));
+                }
+                let idx;
+                while ((idx = receiveBuffer.indexOf(10)) >= 0) {
+                    const line = receiveBuffer.splice(0, idx + 1).slice(0, -1); // Combine and remove LF
+                    if (line.length > 0 && line[line.length - 1] === 13)
+                        line.pop(); // Remove CR
+                    const decoder = new TextDecoder("utf-8");
+                    const receivedString = decoder.decode(new Uint8Array(line));
+                    handleMotherboardData(characteristic.uuid, receivedString);
+                }
             }
+        }
+        else if (board.name === "ENTRALPI") {
+            // TODO: handle Entralpi notify
+            // characteristic.value!.getInt16(0) / 100;
             if (notifyCallback) {
-                notifyCallback({ uuid: characteristic.uuid, value: dataObject });
+                notifyCallback({ uuid: characteristic.uuid, value: value });
             }
         }
-        else if (characteristic.value.byteLength === 14) {
-            // TODO: handle 14 byte data
-            // notifyCallback({ uuid: characteristic.uuid, value: characteristic.value!.getInt8(0) / 100 })
+        else if (board.name === "Tindeq") {
+            // TODO: handle Tindeq notify
         }
-    }
-    else if (board.name === "ENTRALPI") {
-        // TODO: handle Entralpi notify
-        // characteristic.value!.getInt16(0) / 100;
-        if (notifyCallback) {
-            notifyCallback({ uuid: characteristic.uuid, value: receivedString });
+        else {
+            if (notifyCallback) {
+                notifyCallback({ uuid: characteristic.uuid, value: value });
+            }
         }
     }
-    else if (board.name === "Tindeq") {
-        // TODO: handle Tindeq notify
-    }
-    else {
-        if (notifyCallback) {
-            notifyCallback({ uuid: characteristic.uuid, value: receivedString });
+};
+/**
+ * onConnected
+ * @param event
+ * @param board
+ */
+const onConnected = async (board, onSuccess) => {
+    try {
+        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));
+                            }
+                        }
+                    }
+                    else {
+                        console.warn(`Characteristic ${characteristic.uuid} not found in service ${service.uuid}`);
+                    }
+                }
+            }
+        }
+        // Call the onSuccess callback after successful connection and setup
+        onSuccess();
+    }
+    catch (error) {
+        console.error(error);
     }
 };
 /**
@@ -83,7 +106,7 @@ function getAllServiceUUIDs(device) {
     return device.services.map((service) => service.uuid);
 }
 /**
- * connect
+ * Connect to the BluetoothDevice
  * @param device
  * @param onSuccess
  */
@@ -111,37 +134,15 @@ export const connect = async (board, onSuccess) => {
             optionalServices: deviceServices,
         });
         board.device = device;
-        device.addEventListener("gattserverdisconnected", (event) => onDisconnected(event, board));
-        const server = await device.gatt?.connect();
-        const services = await server?.getPrimaryServices();
-        if (!services || services.length === 0) {
-            console.error("No services found");
+        if (!board.device.gatt) {
+            console.error("GATT is not available on this device");
             return;
         }
-        for (const service of services) {
-            const matchingService = board.services.find((boardService) => boardService.uuid === service.uuid);
-            if (matchingService) {
-                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}`);
-                    }
-                }
-            }
+        server = await board.device?.gatt?.connect();
+        board.device.addEventListener("gattserverdisconnected", (event) => onDisconnected(event, board));
+        if (server.connected) {
+            await onConnected(board, onSuccess);
         }
-        onSuccess();
     }
     catch (error) {
         console.error(error);

package/build/devices/moterboard.d.ts

@@ -1,2 +1,7 @@
 import { Device } from "./types";
 export declare const Motherboard: Device;
+/**
+ * handleMotherboardData
+ * @param line
+ */
+export declare function handleMotherboardData(uuid: string, receivedString: string): void;

package/build/devices/moterboard.js

@@ -1,3 +1,7 @@
+import { notifyCallback } from "../notify";
+const PACKET_LENGTH = 32;
+const NUM_SAMPLES = 3;
+const CALIBRATION = [[], [], [], []];
 export const Motherboard = {
     name: "Motherboard",
     companyId: 0x2a29,
@@ -77,3 +81,83 @@ export const Motherboard = {
         },
     ],
 };
+/**
+ * applyCalibration
+ * @param sample
+ * @param calibration
+ */
+const applyCalibration = (sample, calibration) => {
+    const zeroCalib = calibration[0][2];
+    let sgn = 1;
+    let final = 0;
+    if (sample < zeroCalib) {
+        sgn = -1;
+        sample = 2 * zeroCalib - sample;
+    }
+    for (let i = 1; i < calibration.length; i++) {
+        const calibStart = calibration[i - 1][2];
+        const calibEnd = calibration[i][2];
+        if (sample < calibEnd) {
+            final =
+                calibration[i - 1][1] +
+                    ((sample - calibStart) / (calibEnd - calibStart)) * (calibration[i][1] - calibration[i - 1][1]);
+            break;
+        }
+    }
+    return sgn * final;
+};
+/**
+ * handleMotherboardData
+ * @param line
+ */
+export function handleMotherboardData(uuid, receivedString) {
+    const receivedTime = Date.now();
+    // Check if the line is entirely hex characters
+    const allHex = /^[0-9A-Fa-f]+$/g.test(receivedString);
+    // Decide if this is a streaming packet
+    if (allHex && receivedString.length === PACKET_LENGTH) {
+        // Base-16 decode the string: convert hex pairs to byte values
+        const bytes = Array.from({ length: receivedString.length / 2 }, (_, i) => Number(`0x${receivedString.substring(i * 2, i * 2 + 2)}`));
+        // Translate header into packet, number of samples from the packet length
+        const packet = {
+            received: receivedTime,
+            sampleNum: new DataView(new Uint8Array(bytes).buffer).getUint16(0, true),
+            battRaw: new DataView(new Uint8Array(bytes).buffer).getUint16(2, true),
+            samples: [],
+            masses: [],
+        };
+        for (let i = 0; i < NUM_SAMPLES; i++) {
+            const sampleStart = 4 + 3 * i;
+            packet.samples[i] = bytes[sampleStart] | (bytes[sampleStart + 1] << 8) | (bytes[sampleStart + 2] << 16);
+            if (packet.samples[i] >= 0x7fffff) {
+                packet.samples[i] -= 0x1000000;
+            }
+            // TODO: make sure device is calibrated
+            if (!CALIBRATION[0].length)
+                return;
+            packet.masses[i] = applyCalibration(packet.samples[i], CALIBRATION[i]);
+        }
+        const left = packet.masses[0];
+        const center = packet.masses[1];
+        const right = packet.masses[2];
+        notifyCallback({
+            uuid,
+            value: {
+                massTotal: Math.max(-1000, left + right + center).toFixed(3),
+                massLeft: Math.max(-1000, left).toFixed(3),
+                massRight: Math.max(-1000, right).toFixed(3),
+                massCentre: Math.max(-1000, center).toFixed(3),
+            },
+        });
+    }
+    else if ((receivedString.match(/,/g) || []).length === 3) {
+        // if the returned notification is a calibration string add them to the array
+        const parts = receivedString.split(",");
+        const numericParts = parts.map((x) => parseFloat(x));
+        CALIBRATION[numericParts[0]].push(numericParts.slice(1));
+    }
+    else {
+        // unhanded data
+        console.log(receivedString);
+    }
+}

package/build/read.d.ts

@@ -3,4 +3,4 @@ import { Device } from "./devices/types";
  * read
  * @param characteristic
  */
-export declare const read: (board: Device, serviceId: string, characteristicId: string) => Promise<void>;
+export declare const read: (board: Device, serviceId: string, characteristicId: string, duration?: number) => Promise<void>;

package/build/read.js

@@ -4,7 +4,7 @@ import { getCharacteristic } from "./characteristic";
  * read
  * @param characteristic
  */
-export const read = (board, serviceId, characteristicId) => {
+export const read = (board, serviceId, characteristicId, duration = 0) => {
     return new Promise((resolve, reject) => {
         if (board.device?.gatt?.connected) {
             const characteristic = getCharacteristic(board, serviceId, characteristicId);
@@ -22,8 +22,12 @@ export const read = (board, serviceId, characteristicId) => {
                             decodedValue = decoder.decode(value);
                             break;
                     }
-                    notifyCallback({ uuid: characteristic.uuid, value: decodedValue });
-                    resolve();
+                    if (notifyCallback) {
+                        notifyCallback({ uuid: characteristic.uuid, value: decodedValue });
+                    }
+                    setTimeout(() => {
+                        resolve();
+                    }, duration);
                 })
                     .catch((error) => {
                     reject(error);

package/build/write.js

@@ -10,8 +10,9 @@ export const write = (board, serviceId, characteristicId, message, duration = 0)
             const encoder = new TextEncoder();
             const characteristic = getCharacteristic(board, serviceId, characteristicId);
             if (characteristic) {
+                const value = message + "\n";
                 characteristic
-                    .writeValue(encoder.encode(message))
+                    .writeValue(encoder.encode(value))
                     .then(() => {
                     setTimeout(() => {
                         resolve();

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@hangtime/grip-connect",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "description": "A client that can establish connections with various Force-Sensing Hangboards/Plates used by climbers for strength measurement. Examples of such hangboards include the Motherboard, Climbro, SmartBoard, Entralpi or Tindeq Progressor",
   "main": "src/index.ts",
   "scripts": {
     "build": "tsc --build"
   },
   "author": "Stevie-Ray Hartog <mail@stevie-ray.nl>",
-  "license": "MIT",
+  "license": "BSD-2-Clause",
   "devDependencies": {},
   "repository": {
     "type": "git",

package/src/characteristic.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="web-bluetooth" />
+import { Device } from "./devices/types";
+/**
+ * getCharacteristic
+ * @param board
+ * @param serviceId
+ * @param characteristicId
+ */
+export declare const getCharacteristic: (board: Device, serviceId: string, characteristicId: string) => BluetoothRemoteGATTCharacteristic | undefined;

package/src/characteristic.js

@@ -0,0 +1,15 @@
+/**
+ * getCharacteristic
+ * @param board
+ * @param serviceId
+ * @param characteristicId
+ */
+export const getCharacteristic = (board, serviceId, characteristicId) => {
+    const boardService = board.services.find((service) => service.id === serviceId);
+    if (boardService) {
+        const boardCharacteristic = boardService.characteristics.find((characteristic) => characteristic.id === characteristicId);
+        if (boardCharacteristic) {
+            return boardCharacteristic.characteristic;
+        }
+    }
+};

package/src/connect.d.ts

@@ -1,6 +1,6 @@
 import { Device } from "./devices/types";
 /**
- * connect
+ * Connect to the BluetoothDevice
  * @param device
  * @param onSuccess
  */