@hangtime/grip-connect 0.2.1 → 0.2.3

package/README.md

@@ -4,47 +4,16 @@
 
 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/),
+[Griptonite 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/) -
+Learn more: [Docs](https://stevie-ray.github.io/hangtime-grip-connect/) -
 [Browser Support](https://caniuse.com/web-bluetooth)
 
-## Roadmap
-
-**Help wanted:** Do you own any of these 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.
-
-- ✅ Griptonite Motherboard
-  - ✅️ Connect with devices
-  - ✅️ Read / Write / Notify using Bluetooth
-  - ✅️ Output weight/force stream
-- ✅ Tindeq Progressor
-  - ✅️ Connect with devices
-  - ✅️ Read / Write / Notify using Bluetooth
-  - ✅️ Output weight/force stream
-- ✅ Entralpi
-  - ✅️ Connect with devices
-  - ✅️ Read / Write / Notify using Bluetooth
-  - ✅️️ Output weight/force stream
-- ➡️ Climbro
-  - ➡️ Connect with devices
-  - ➡️ Read / Write / Notify using Bluetooth
-  - ➡️ Output weight/force stream
-- ➡️ SmartBoard
-  - ➡️ Connect with devices
-  - ➡️ Read / Write / Notify using Bluetooth
-  - ➡️ Output weight/force stream
-
-## Development
+## Try it out
 
-```bash
-git clone https://github.com/Stevie-Ray/hangtime-grip-connect
-cd hangtime-grip-connect
-npm install
-```
+[Chart](https://grip-connect.vercel.app/) - [Flappy Bird](https://grip-connect-flappy-bird.vercel.app/)
 
 ## Install
 
@@ -89,6 +58,44 @@ motherboardButton.addEventListener("click", () => {
 })
 ```
 
+## Roadmap
+
+**Help wanted:** Do you own any of these 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
+- ➡️ Climbro
+- ➡️ SmartBoard
+
+### Features
+
+- ✅ Connect
+- ✅ Disconnect
+- ✅ Start data stream (live data)
+- ✅ Stop data stream
+- ✅ Battery status
+- ✅ Read calibration
+- ✅ Device info (firmware / serial etc.)
+- ✅ Check if device is connected
+- ➡️ Peak load
+- ➡️ Endurance
+- ➡️ Rate of Force Development (RFD)
+- ➡️ Repeaters
+- ➡️ Critical Force
+
+## Development
+
+```bash
+git clone https://github.com/Stevie-Ray/hangtime-grip-connect
+cd hangtime-grip-connect
+npm install
+```
+
 ## Credits
 
 A special thank you to:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hangtime/grip-connect",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "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 Griptonite Motherboard, Climbro, SmartBoard, Entralpi or Tindeq Progressor",
   "main": "src/index.ts",
   "scripts": {
@@ -8,7 +8,6 @@
   },
   "author": "Stevie-Ray Hartog <mail@stevie-ray.nl>",
   "license": "BSD-2-Clause",
-  "devDependencies": {},
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Stevie-Ray/hangtime-grip-connect.git"
@@ -25,5 +24,8 @@
   "bugs": {
     "url": "https://github.com/Stevie-Ray/hangtime-grip-connect/issues"
   },
-  "homepage": "https://stevie-ray.github.io/hangtime-grip-connect/"
+  "homepage": "https://stevie-ray.github.io/hangtime-grip-connect/",
+  "dependencies": {
+    "@aksel/structjs": "^1.0.0"
+  }
 }

package/src/battery.d.ts

@@ -0,0 +1,6 @@
+import { Device } from "./devices/types";
+/**
+ * Get Battery / Voltage information
+ * @param board
+ */
+export declare const battery: (board: Device) => Promise<void>;

package/src/battery.js

@@ -0,0 +1,19 @@
+import { write } from "./write";
+import { read } from "./read";
+import { isConnected } from "./is-connected";
+import { Motherboard, Progressor } from "./devices";
+import { ProgressorCommands } from "./commands";
+/**
+ * Get Battery / Voltage information
+ * @param board
+ */
+export const battery = async (board) => {
+    if (isConnected(board)) {
+        if (board.name === "Motherboard") {
+            await read(Motherboard, "battery", "level", 250);
+        }
+        if (board.name && board.name.startsWith("Progressor")) {
+            await write(Progressor, "progressor", "tx", ProgressorCommands.GET_BATT_VLTG, 250);
+        }
+    }
+};

package/src/calibration.d.ts

@@ -0,0 +1,6 @@
+import { Device } from "./devices/types";
+/**
+ * write command to get calibration
+ * @param board
+ */
+export declare const calibration: (board: Device) => Promise<void>;

package/src/calibration.js

@@ -0,0 +1,15 @@
+import { isConnected } from "./is-connected";
+import { write } from "./write";
+import { Motherboard } from "./devices";
+import { MotherboardCommands } from "./commands";
+/**
+ * write command to get calibration
+ * @param board
+ */
+export const calibration = async (board) => {
+    if (isConnected(board)) {
+        if (board.name === "Motherboard") {
+            await write(Motherboard, "uart", "tx", MotherboardCommands.GET_CALIBRATION, 2500);
+        }
+    }
+};

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/commands/climbro.d.ts

@@ -0,0 +1,6 @@
+import { Commands } from "../commands/types";
+/**
+ * Warning:
+ * Using other commands can seriously harm your device
+ */
+export declare const ClimbroCommands: Commands;

package/src/commands/climbro.js

@@ -0,0 +1,5 @@
+/**
+ * Warning:
+ * Using other commands can seriously harm your device
+ */
+export const ClimbroCommands = {};

package/src/commands/entralpi.d.ts

@@ -0,0 +1,6 @@
+import { Commands } from "../commands/types";
+/**
+ * Warning:
+ * Using other commands can seriously harm your device
+ */
+export declare const EntralpiCommands: Commands;

package/src/commands/entralpi.js

@@ -0,0 +1,5 @@
+/**
+ * Warning:
+ * Using other commands can seriously harm your device
+ */
+export const EntralpiCommands = {};

package/src/commands/index.d.ts

@@ -0,0 +1,5 @@
+export { ClimbroCommands } from "./climbro";
+export { EntralpiCommands } from "./entralpi";
+export { MotherboardCommands } from "./motherboard";
+export { ProgressorCommands } from "./progressor";
+export { SmartBoardCommands } from "./smartboard";

package/src/commands/index.js

@@ -0,0 +1,5 @@
+export { ClimbroCommands } from "./climbro";
+export { EntralpiCommands } from "./entralpi";
+export { MotherboardCommands } from "./motherboard";
+export { ProgressorCommands } from "./progressor";
+export { SmartBoardCommands } from "./smartboard";

package/src/commands/motherboard.d.ts

@@ -0,0 +1,6 @@
+import { Commands } from "../commands/types";
+/**
+ * Warning:
+ * Using other commands can seriously harm your device
+ */
+export declare const MotherboardCommands: Commands;

package/src/commands/motherboard.js

@@ -0,0 +1,13 @@
+/**
+ * Warning:
+ * Using other commands can seriously harm your device
+ */
+export const MotherboardCommands = {
+    GET_SERIAL: "#",
+    START_WEIGHT_MEAS: "S30",
+    STOP_WEIGHT_MEAS: "", // All commands will stop the data stream.
+    GET_CALIBRATION: "C",
+    SLEEP: 0,
+    GET_TEXT: "T",
+    DEBUG_STREAM: "D",
+};

package/src/commands/progressor.d.ts

@@ -0,0 +1,15 @@
+import { Commands } from "../commands/types";
+/**
+ * Warning:
+ * Using other commands can seriously harm your device
+ */
+export declare const ProgressorCommands: Commands;
+/**
+ * The Progressor returns a Uint8Array.
+ * The first item [0] is the type of response it returns
+ */
+export declare const ProgressorResponses: {
+    COMMAND_RESPONSE: number;
+    WEIGHT_MEASURE: number;
+    LOW_BATTERY_WARNING: number;
+};

package/src/commands/progressor.js

@@ -0,0 +1,27 @@
+/**
+ * Warning:
+ * Using other commands can seriously harm your device
+ */
+export const ProgressorCommands = {
+    TARE_SCALE: "d", // 0x64,
+    START_WEIGHT_MEAS: "e", // 0x65,
+    STOP_WEIGHT_MEAS: "f", // 0x66,
+    START_PEAK_RFD_MEAS: "g", //  0x67,
+    START_PEAK_RFD_MEAS_SERIES: "h", //  0x68,
+    ADD_CALIB_POINT: "i", //  0x69,
+    SAVE_CALIB: "j", //  0x6a,
+    GET_FW_VERSION: "k", //  0x6b,
+    GET_ERR_INFO: "l", //  0x6c,
+    CLR_ERR_INFO: "m", //  0x6d,
+    SLEEP: "n", // 0x6e,
+    GET_BATT_VLTG: "o", //  0x6f,
+};
+/**
+ * The Progressor returns a Uint8Array.
+ * The first item [0] is the type of response it returns
+ */
+export const ProgressorResponses = {
+    COMMAND_RESPONSE: 0,
+    WEIGHT_MEASURE: 1,
+    LOW_BATTERY_WARNING: 2,
+};

package/src/commands/smartboard.d.ts

@@ -0,0 +1,6 @@
+import { Commands } from "../commands/types";
+/**
+ * Warning:
+ * Using other commands can seriously harm your device
+ */
+export declare const SmartBoardCommands: Commands;

package/src/commands/smartboard.js

@@ -0,0 +1,5 @@
+/**
+ * Warning:
+ * Using other commands can seriously harm your device
+ */
+export const SmartBoardCommands = {};

package/src/commands/types.d.ts

@@ -0,0 +1,18 @@
+export interface Commands {
+    START_WEIGHT_MEAS?: string;
+    STOP_WEIGHT_MEAS?: string;
+    SLEEP?: number | string;
+    GET_SERIAL?: string;
+    GET_TEXT?: string;
+    DEBUG_STREAM?: string;
+    GET_CALIBRATION?: string;
+    TARE_SCALE?: string;
+    START_PEAK_RFD_MEAS?: string;
+    START_PEAK_RFD_MEAS_SERIES?: string;
+    ADD_CALIB_POINT?: string;
+    SAVE_CALIB?: string;
+    GET_FW_VERSION?: string;
+    GET_ERR_INFO?: string;
+    CLR_ERR_INFO?: string;
+    GET_BATT_VLTG?: string;
+}

package/src/commands/types.js

@@ -0,0 +1 @@
+export {};

package/src/connect.d.ts

@@ -0,0 +1,7 @@
+import { Device } from "./devices/types";
+/**
+ * Connect to the BluetoothDevice
+ * @param device
+ * @param onSuccess
+ */
+export declare const connect: (board: Device, onSuccess: () => void) => Promise<void>;

package/src/connect.js

@@ -0,0 +1,159 @@
+import { notifyCallback } from "./notify";
+import { handleMotherboardData, handleProgressorData } from "./data";
+let server;
+const receiveBuffer = [];
+/**
+ * onDisconnected
+ * @param board
+ * @param event
+ */
+const onDisconnected = (event, board) => {
+    board.device = undefined;
+    const device = event.target;
+    console.log(`Device ${device.name} is disconnected.`);
+};
+/**
+ * handleNotifications
+ * @param event
+ * @param onNotify
+ */
+const handleNotifications = (event, board) => {
+    const characteristic = event.target;
+    const value = characteristic.value;
+    if (value) {
+        if (board.name === "Motherboard") {
+            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 receivedData = decoder.decode(new Uint8Array(line));
+                handleMotherboardData(characteristic.uuid, receivedData);
+            }
+        }
+        else if (board.name === "ENTRALPI") {
+            if (value.buffer) {
+                const buffer = value.buffer;
+                const rawData = new DataView(buffer);
+                const receivedData = rawData.getUint16(0) / 100;
+                if (notifyCallback) {
+                    notifyCallback({
+                        uuid: characteristic.uuid,
+                        value: {
+                            massTotal: receivedData,
+                        },
+                    });
+                }
+            }
+        }
+        else if (board.name && board.name.startsWith("Progressor")) {
+            if (value.buffer) {
+                const buffer = value.buffer;
+                const rawData = new DataView(buffer);
+                handleProgressorData(characteristic.uuid, rawData);
+            }
+        }
+        else {
+            if (notifyCallback) {
+                notifyCallback({ uuid: characteristic.uuid, value: value });
+            }
+        }
+    }
+};
+/**
+ * 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);
+    }
+};
+/**
+ * Return all service UUIDs
+ * @param device
+ */
+const getAllServiceUUIDs = (device) => {
+    return device.services.map((service) => service.uuid);
+};
+/**
+ * Connect to the BluetoothDevice
+ * @param device
+ * @param onSuccess
+ */
+export const connect = async (board, onSuccess) => {
+    try {
+        const deviceServices = getAllServiceUUIDs(board);
+        // setup filter list
+        const filters = [];
+        if (board.name) {
+            const filterName = board.name === "Progressor" ? { namePrefix: board.name } : { name: board.name };
+            filters.push(filterName);
+        }
+        if (board.companyId) {
+            filters.push({
+                manufacturerData: [
+                    {
+                        companyIdentifier: board.companyId,
+                    },
+                ],
+            });
+        }
+        const device = await navigator.bluetooth.requestDevice({
+            filters: filters,
+            optionalServices: deviceServices,
+        });
+        board.device = device;
+        if (!board.device.gatt) {
+            console.error("GATT is not available on this device");
+            return;
+        }
+        server = await board.device?.gatt?.connect();
+        board.device.addEventListener("gattserverdisconnected", (event) => onDisconnected(event, board));
+        if (server.connected) {
+            await onConnected(board, onSuccess);
+        }
+    }
+    catch (error) {
+        console.error(error);
+    }
+};

package/src/connect.ts

@@ -1,8 +1,6 @@
 import { Device } from "./devices/types"
-import { ProgressorCommands, ProgressorResponses } from "./commands/progressor"
 import { notifyCallback } from "./notify"
-import { handleMotherboardData } from "./data"
-import { lastWrite } from "./write"
+import { handleMotherboardData, handleProgressorData } from "./data"
 
 let server: BluetoothRemoteGATTServer
 const receiveBuffer: number[] = []
@@ -26,18 +24,6 @@ const handleNotifications = (event: Event, board: Device): void => {
   const characteristic: BluetoothRemoteGATTCharacteristic = event.target as BluetoothRemoteGATTCharacteristic
   const value: DataView | undefined = characteristic.value
 
-  function _unpackFloat(bytes: Uint8Array) {
-    const view = new DataView(new ArrayBuffer(4))
-    for (let i = 0; i < 4; i++) {
-      view.setUint8(i, bytes[i])
-    }
-    return view.getFloat32(0, true)
-  }
-
-  // function _unpackInt(bytes: Uint8Array) {
-  //   return (bytes[1] << 8) + bytes[0];
-  // }
-
   if (value) {
     if (board.name === "Motherboard") {
       for (let i: number = 0; i < value.byteLength; i++) {
@@ -69,49 +55,8 @@ const handleNotifications = (event: Event, board: Device): void => {
     } else if (board.name && board.name.startsWith("Progressor")) {
       if (value.buffer) {
         const buffer: ArrayBuffer = value.buffer
-        const rawData: Uint8Array = new Uint8Array(buffer)
-        const kind: number = rawData[0]
-        const tare: number = 0 // todo: add tare
-        if (kind === ProgressorResponses.WEIGHT_MEASURE) {
-          for (let i = 2; i < rawData.length; i += 6) {
-            const weight = _unpackFloat(rawData.slice(i, i + 4))
-            // let useconds = _unpackInt(rawData.slice(i + 4, i + 6));
-            // let now = useconds / 1.0e6;
-
-            if (notifyCallback) {
-              notifyCallback({
-                uuid: characteristic.uuid,
-                value: {
-                  massTotal: weight - tare,
-                },
-              })
-            }
-          }
-        } else if (kind === ProgressorResponses.COMMAND_RESPONSE) {
-          if (!lastWrite) return
-
-          let value: string = ""
-
-          if (lastWrite === ProgressorCommands.GET_BATT_VLTG) {
-            const vdd = new DataView(rawData.buffer, 2).getUint32(0, true)
-            value = `Battery level = ${vdd} [mV]`
-          } else if (lastWrite === ProgressorCommands.GET_FW_VERSION) {
-            value = new TextDecoder().decode(rawData.slice(2))
-          } else if (lastWrite === ProgressorCommands.GET_ERR_INFO) {
-            value = new TextDecoder().decode(rawData.slice(2))
-          }
-          if (notifyCallback) {
-            notifyCallback({ uuid: characteristic.uuid, value: value })
-          }
-        } else if (kind === ProgressorResponses.LOW_BATTERY_WARNING) {
-          if (notifyCallback) {
-            notifyCallback({ uuid: characteristic.uuid, value: "low power warning" })
-          }
-        } else {
-          if (notifyCallback) {
-            notifyCallback({ uuid: characteristic.uuid, value: `unknown message kind ${kind}` })
-          }
-        }
+        const rawData: DataView = new DataView(buffer)
+        handleProgressorData(characteristic.uuid, rawData)
       }
     } else {
       if (notifyCallback) {

package/src/data.d.ts

@@ -0,0 +1,9 @@
+export declare const CALIBRATION: never[][];
+/**
+ * handleMotherboardData
+ *
+ * @param uuid - Unique identifier
+ * @param receivedData - Received data string
+ */
+export declare const handleMotherboardData: (uuid: string, receivedData: string) => void;
+export declare const handleProgressorData: (uuid: string, data: DataView) => void;