@hangtime/grip-connect 0.1.1 → 0.2.0

package/README.md

@@ -13,30 +13,29 @@ Force-Sensing Hangboards / Plates used by climbers for strength measurement. Exa
 
 ## 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
-  - ➡️ Calibrate Devices
   - ✅️ Output weight/force stream
 - ✅ Tindeq Progressor
   - ✅️ Connect with devices
   - ✅️ Read / Write / Notify using Bluetooth
-  - ➡️ Calibrate Devices
-  - ➡️ Output weight/force stream
+  - ✅️ Output weight/force stream
 - ✅ Entralpi
   - ✅️ Connect with devices
   - ✅️ Read / Write / Notify using Bluetooth
-  - ➡️ Calibrate Devices
-  - ➡️ Output weight/force stream
+  - ✅️️ 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
@@ -53,37 +52,32 @@ npm install
 $ npm install @hangtime/grip-connect
 ```
 
-## Example usage (Motherboard)
+## Example usage (with a Motherboard)
 
-Simply importing the utilities you need from `@hangtime/grip-connect`. Devices that are currently supported:
-`Motherboard`, `Tindeq` and `Entralpi`.
+Simply importing the utilities you need from `@hangtime/grip-connect`.
 
 ```html
 <button id="motherboard" type="button">Connect Motherboard</button>
 ```
 
 ```js
-import { Motherboard, calibration, connect, disconnect, notify, read, stream } from "@hangtime/grip-connect"
+import { Motherboard, battery, connect, disconnect, info, notify, stream } from "@hangtime/grip-connect"
 
 const motherboardButton = document.querySelector("#motherboard")
 
 motherboardButton.addEventListener("click", () => {
   connect(Motherboard, async () => {
-    // Listen for notifications
+    // Listen for stream notifications
     notify((data) => {
+      // data: { massTotal: 0, massLeft: 0, massRight: 0, massCenter: 0 }
       console.log(data)
     })
 
     // Read battery + device info
-    await read(Motherboard, "battery", "level", 250)
-    await read(Motherboard, "device", "manufacturer", 250)
-    await read(Motherboard, "device", "hardware", 250)
-    await read(Motherboard, "device", "firmware", 250)
-
-    // Read calibration (required before reading data)
-    await calibration(Motherboard)
+    await battery(Motherboard)
+    await info(Motherboard)
 
-    // Start streaming (for a minute) remove parameter for a continues stream
+    // Start weight streaming (for a minute) remove parameter for a continues stream
     await stream(Motherboard, 60000)
 
     // Manually call stop method if stream is continues

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hangtime/grip-connect",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "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": {

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, Tindeq } from "./devices";
+import { TindeqCommands } 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 === "Tindeq") {
+            await write(Tindeq, "progressor", "tx", String(TindeqCommands.GET_BATT_VLTG), 250);
+        }
+    }
+};

package/src/battery.ts

@@ -0,0 +1,21 @@
+import { Device } from "./devices/types"
+import { write } from "./write"
+import { read } from "./read"
+import { isConnected } from "./is-connected"
+import { Motherboard, Tindeq } from "./devices"
+import { TindeqCommands } from "./commands"
+
+/**
+ * Get Battery / Voltage information
+ * @param board
+ */
+export const battery = async (board: Device): Promise<void> => {
+  if (isConnected(board)) {
+    if (board.name === "Motherboard") {
+      await read(Motherboard, "battery", "level", 250)
+    }
+    if (board.name === "Tindeq") {
+      await write(Tindeq, "progressor", "tx", String(TindeqCommands.GET_BATT_VLTG), 250)
+    }
+  }
+}

package/src/calibration.js

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

package/src/calibration.ts

@@ -1,15 +1,15 @@
 import { Device } from "./devices/types"
+import { isConnected } from "./is-connected"
+import { write } from "./write"
 import { Motherboard } from "./devices"
 import { MotherboardCommands } from "./commands"
-import { write } from "./write"
 
 /**
  * write command to get calibration
  * @param board
  */
 export const calibration = async (board: Device): Promise<void> => {
-  if (!board.device) return
-  if (board.device.gatt?.connected) {
+  if (isConnected(board)) {
     if (board.name === "Motherboard") {
       await write(Motherboard, "uart", "tx", String(MotherboardCommands.GET_CALIBRATION), 2500)
     }

package/src/commands/tindeq.js

@@ -3,18 +3,18 @@
  * Using other commands can seriously harm your device
  */
 export const TindeqCommands = {
-    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_APP_VERSION: 'k', //  0x6b,
-    GET_ERR_INFO: 'l', //  0x6c,
-    CLR_ERR_INFO: 'm', //  0x6d,
-    SLEEP: 'n', // 0x6e,
-    GET_BATT_VLTG: 'o' //  0x6f,
+    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_APP_VERSION: "k", //  0x6b,
+    GET_ERR_INFO: "l", //  0x6c,
+    CLR_ERR_INFO: "m", //  0x6d,
+    SLEEP: "n", // 0x6e,
+    GET_BATT_VLTG: "o", //  0x6f,
 };
 export const NotificationTypes = {
     COMMAND_RESPONSE: 0,

package/src/connect.js

@@ -1,6 +1,5 @@
 import { notifyCallback } from "./notify";
-import { handleMotherboardData } from "./devices/motherboard";
-import { handleEntralpiData } from "./devices/entralpi";
+import { handleMotherboardData } from "./data";
 let server;
 const receiveBuffer = [];
 /**
@@ -41,7 +40,14 @@ const handleNotifications = (event, board) => {
                 const buffer = value.buffer;
                 const rawData = new DataView(buffer);
                 const receivedData = rawData.getUint16(0) / 100;
-                handleEntralpiData(characteristic.uuid, receivedData);
+                if (notifyCallback) {
+                    notifyCallback({
+                        uuid: characteristic.uuid,
+                        value: {
+                            massTotal: receivedData,
+                        },
+                    });
+                }
             }
         }
         else if (board.name === "Tindeq") {
@@ -102,9 +108,9 @@ const onConnected = async (board, onSuccess) => {
  * Return all service UUIDs
  * @param device
  */
-function getAllServiceUUIDs(device) {
+const getAllServiceUUIDs = (device) => {
     return device.services.map((service) => service.uuid);
-}
+};
 /**
  * Connect to the BluetoothDevice
  * @param device

package/src/connect.ts

@@ -1,7 +1,6 @@
 import { Device } from "./devices/types"
 import { notifyCallback } from "./notify"
-import { handleMotherboardData } from "./devices/motherboard"
-import { handleEntralpiData } from "./devices/entralpi"
+import { handleMotherboardData } from "./data"
 
 let server: BluetoothRemoteGATTServer
 const receiveBuffer: number[] = []
@@ -43,7 +42,14 @@ const handleNotifications = (event: Event, board: Device): void => {
         const buffer: ArrayBuffer = value.buffer
         const rawData: DataView = new DataView(buffer)
         const receivedData: number = rawData.getUint16(0) / 100
-        handleEntralpiData(characteristic.uuid, receivedData)
+        if (notifyCallback) {
+          notifyCallback({
+            uuid: characteristic.uuid,
+            value: {
+              massTotal: receivedData,
+            },
+          })
+        }
       }
     } else if (board.name === "Tindeq") {
       // TODO: handle Tindeq notify
@@ -110,7 +116,7 @@ const onConnected = async (board: Device, onSuccess: () => void): Promise<void>
  * Return all service UUIDs
  * @param device
  */
-function getAllServiceUUIDs(device: Device) {
+const getAllServiceUUIDs = (device: Device) => {
   return device.services.map((service) => service.uuid)
 }
 /**

package/src/data.d.ts

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

package/src/data.js

@@ -0,0 +1,109 @@
+import { notifyCallback } from "./notify";
+const PACKET_LENGTH = 32;
+const NUM_SAMPLES = 3;
+export const CALIBRATION = [[], [], [], []];
+/**
+ * applyCalibration
+ * @param sample
+ * @param calibration
+ */
+const applyCalibration = (sample, calibration) => {
+    // Extract the calibrated value for the zero point
+    const zeroCalibration = calibration[0][2];
+    // Initialize sign as positive
+    let sign = 1;
+    // Initialize the final calibrated value
+    let final = 0;
+    // If the sample value is less than the zero calibration point
+    if (sample < zeroCalibration) {
+        // Change the sign to negative
+        sign = -1;
+        // Reflect the sample around the zero calibration point
+        sample = /* 2 * zeroCalibration */ -sample;
+    }
+    // Iterate through the calibration data
+    for (let i = 1; i < calibration.length; i++) {
+        // Extract the lower and upper bounds of the current calibration range
+        const calibrationStart = calibration[i - 1][2];
+        const calibrationEnd = calibration[i][2];
+        // If the sample value is within the current calibration range
+        if (sample < calibrationEnd) {
+            // Interpolate to get the calibrated value within the range
+            final =
+                calibration[i - 1][1] +
+                    ((sample - calibrationStart) / (calibrationEnd - calibrationStart)) *
+                        (calibration[i][1] - calibration[i - 1][1]);
+            break;
+        }
+    }
+    // Return the calibrated value with the appropriate sign (positive/negative)
+    return sign * final;
+};
+/**
+ * handleMotherboardData
+ *
+ * @param uuid - Unique identifier
+ * @param receivedData - Received data string
+ */
+export const handleMotherboardData = (uuid, receivedData) => {
+    const receivedTime = Date.now();
+    // Check if the line is entirely hex characters
+    const isAllHex = /^[0-9A-Fa-f]+$/g.test(receivedData);
+    // Handle streaming packet
+    if (isAllHex && receivedData.length === PACKET_LENGTH) {
+        // Base-16 decode the string: convert hex pairs to byte values
+        const bytes = Array.from({ length: receivedData.length / 2 }, (_, i) => Number(`0x${receivedData.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: [],
+        };
+        const dataView = new DataView(new Uint8Array(bytes).buffer);
+        for (let i = 0; i < NUM_SAMPLES; i++) {
+            const sampleStart = 4 + 3 * i;
+            // Use DataView to read the 24-bit unsigned integer
+            const rawValue = dataView.getUint8(sampleStart) |
+                (dataView.getUint8(sampleStart + 1) << 8) |
+                (dataView.getUint8(sampleStart + 2) << 16);
+            // Ensure unsigned 32-bit integer
+            packet.samples[i] = rawValue >>> 0;
+            if (packet.samples[i] >= 0x7fffff) {
+                packet.samples[i] -= 0x1000000;
+            }
+            // if (!CALIBRATION[0].length) return
+            packet.masses[i] = applyCalibration(packet.samples[i], CALIBRATION[i]);
+        }
+        // invert center and right values
+        packet.masses[1] *= -1;
+        packet.masses[2] *= -1;
+        // map to variables
+        const left = packet.masses[0];
+        const center = packet.masses[1];
+        const right = packet.masses[2];
+        if (notifyCallback) {
+            notifyCallback({
+                uuid,
+                value: {
+                    massTotal: Math.max(-1000, left + right + center).toFixed(1),
+                    massLeft: Math.max(-1000, left).toFixed(1),
+                    massRight: Math.max(-1000, right).toFixed(1),
+                    massCenter: Math.max(-1000, center).toFixed(1),
+                },
+            });
+        }
+    }
+    else if ((receivedData.match(/,/g) || []).length === 3) {
+        console.log(receivedData);
+        // if the returned notification is a calibration string add them to the array
+        const parts = receivedData.split(",");
+        const numericParts = parts.map((x) => parseFloat(x));
+        CALIBRATION[numericParts[0]].push(numericParts.slice(1));
+    }
+    else {
+        // unhanded data
+        console.log(receivedData);
+    }
+};

package/src/data.ts

@@ -0,0 +1,133 @@
+import { notifyCallback } from "./notify"
+
+const PACKET_LENGTH: number = 32
+const NUM_SAMPLES: number = 3
+export const CALIBRATION = [[], [], [], []]
+/**
+ * applyCalibration
+ * @param sample
+ * @param calibration
+ */
+const applyCalibration = (sample: number, calibration: number[][]): number => {
+  // Extract the calibrated value for the zero point
+  const zeroCalibration: number = calibration[0][2]
+
+  // Initialize sign as positive
+  let sign: number = 1
+
+  // Initialize the final calibrated value
+  let final: number = 0
+
+  // If the sample value is less than the zero calibration point
+  if (sample < zeroCalibration) {
+    // Change the sign to negative
+    sign = -1
+
+    // Reflect the sample around the zero calibration point
+    sample = /* 2 * zeroCalibration */ -sample
+  }
+
+  // Iterate through the calibration data
+  for (let i = 1; i < calibration.length; i++) {
+    // Extract the lower and upper bounds of the current calibration range
+    const calibrationStart: number = calibration[i - 1][2]
+    const calibrationEnd: number = calibration[i][2]
+
+    // If the sample value is within the current calibration range
+    if (sample < calibrationEnd) {
+      // Interpolate to get the calibrated value within the range
+      final =
+        calibration[i - 1][1] +
+        ((sample - calibrationStart) / (calibrationEnd - calibrationStart)) *
+          (calibration[i][1] - calibration[i - 1][1])
+      break
+    }
+  }
+  // Return the calibrated value with the appropriate sign (positive/negative)
+  return sign * final
+}
+
+interface Packet {
+  received: number
+  sampleNum: number
+  battRaw: number
+  samples: number[]
+  masses: number[]
+}
+
+/**
+ * handleMotherboardData
+ *
+ * @param uuid - Unique identifier
+ * @param receivedData - Received data string
+ */
+export const handleMotherboardData = (uuid: string, receivedData: string): void => {
+  const receivedTime: number = Date.now()
+
+  // Check if the line is entirely hex characters
+  const isAllHex: boolean = /^[0-9A-Fa-f]+$/g.test(receivedData)
+
+  // Handle streaming packet
+  if (isAllHex && receivedData.length === PACKET_LENGTH) {
+    // Base-16 decode the string: convert hex pairs to byte values
+    const bytes: number[] = Array.from({ length: receivedData.length / 2 }, (_, i) =>
+      Number(`0x${receivedData.substring(i * 2, i * 2 + 2)}`),
+    )
+
+    // Translate header into packet, number of samples from the packet length
+    const packet: 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: [],
+    }
+
+    const dataView = new DataView(new Uint8Array(bytes).buffer)
+
+    for (let i = 0; i < NUM_SAMPLES; i++) {
+      const sampleStart: number = 4 + 3 * i
+      // Use DataView to read the 24-bit unsigned integer
+      const rawValue =
+        dataView.getUint8(sampleStart) |
+        (dataView.getUint8(sampleStart + 1) << 8) |
+        (dataView.getUint8(sampleStart + 2) << 16)
+
+      // Ensure unsigned 32-bit integer
+      packet.samples[i] = rawValue >>> 0
+
+      if (packet.samples[i] >= 0x7fffff) {
+        packet.samples[i] -= 0x1000000
+      }
+      // if (!CALIBRATION[0].length) return
+      packet.masses[i] = applyCalibration(packet.samples[i], CALIBRATION[i])
+    }
+    // invert center and right values
+    packet.masses[1] *= -1
+    packet.masses[2] *= -1
+    // map to variables
+    const left: number = packet.masses[0]
+    const center: number = packet.masses[1]
+    const right: number = packet.masses[2]
+    if (notifyCallback) {
+      notifyCallback({
+        uuid,
+        value: {
+          massTotal: Math.max(-1000, left + right + center).toFixed(1),
+          massLeft: Math.max(-1000, left).toFixed(1),
+          massRight: Math.max(-1000, right).toFixed(1),
+          massCenter: Math.max(-1000, center).toFixed(1),
+        },
+      })
+    }
+  } else if ((receivedData.match(/,/g) || []).length === 3) {
+    console.log(receivedData)
+    // if the returned notification is a calibration string add them to the array
+    const parts: string[] = receivedData.split(",")
+    const numericParts: number[] = parts.map((x) => parseFloat(x))
+    ;(CALIBRATION[numericParts[0]] as number[][]).push(numericParts.slice(1))
+  } else {
+    // unhanded data
+    console.log(receivedData)
+  }
+}

package/src/devices/entralpi.d.ts

@@ -1,8 +1,2 @@
 import { Device } from "./types";
 export declare const Entralpi: Device;
-/**
- * handleEntralpiData
- * @param uuid - Unique identifier
- * @param receivedData - Received data string
- */
-export declare function handleEntralpiData(uuid: string, receivedData: number): void;

package/src/devices/entralpi.js

@@ -1,4 +1,3 @@
-import { notifyCallback } from "../notify";
 export const Entralpi = {
     name: "ENTRALPI",
     services: [
@@ -51,18 +50,3 @@ export const Entralpi = {
         },
     ],
 };
-/**
- * handleEntralpiData
- * @param uuid - Unique identifier
- * @param receivedData - Received data string
- */
-export function handleEntralpiData(uuid, receivedData) {
-    if (notifyCallback) {
-        notifyCallback({
-            uuid,
-            value: {
-                massTotal: receivedData,
-            },
-        });
-    }
-}

package/src/devices/entralpi.ts

@@ -1,5 +1,4 @@
 import { Device } from "./types"
-import { notifyCallback } from "../notify"
 
 export const Entralpi: Device = {
   name: "ENTRALPI",
@@ -53,19 +52,3 @@ export const Entralpi: Device = {
     },
   ],
 }
-
-/**
- * handleEntralpiData
- * @param uuid - Unique identifier
- * @param receivedData - Received data string
- */
-export function handleEntralpiData(uuid: string, receivedData: number): void {
-  if (notifyCallback) {
-    notifyCallback({
-      uuid,
-      value: {
-        massTotal: receivedData,
-      },
-    })
-  }
-}

package/src/devices/motherboard.d.ts

@@ -1,8 +1,2 @@
 import { Device } from "./types";
 export declare const Motherboard: Device;
-/**
- * handleMotherboardData
- * @param uuid - Unique identifier
- * @param receivedData - Received data string
- */
-export declare function handleMotherboardData(uuid: string, receivedData: string): void;