@hangtime/grip-connect 0.0.10 → 0.1.0

package/README.md

@@ -63,7 +63,7 @@ Simply importing the utilities you need from `@hangtime/grip-connect`. Devices t
 ```
 
 ```js
-import { Motherboard, connect, disconnect, read, write, notify } from "@hangtime/grip-connect"
+import { Motherboard, calibrate, connect, disconnect, notify, read, stream } from "@hangtime/grip-connect"
 
 const motherboardButton = document.querySelector("#motherboard")
 
@@ -75,19 +75,17 @@ motherboardButton.addEventListener("click", () => {
     })
 
     // read battery + device info
-    await read(Motherboard, "battery", "level", 1000)
-    await read(Motherboard, "device", "manufacturer", 1000)
-    await read(Motherboard, "device", "hardware", 1000)
-    await read(Motherboard, "device", "firmware", 1000)
+    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 write(Motherboard, "uart", "tx", "C", 5000)
+    await calibrate(Motherboard)
 
-    // start stream
-    await write(Motherboard, "uart", "tx", "S30", 15000)
+    // start streaming for a minute
+    await stream(Motherboard, 60000)
 
-    // end stream
-    await write(Motherboard, "uart", "tx", "", 0)
     // disconnect from device after we are done
     disconnect(Motherboard)
   })
@@ -100,6 +98,7 @@ 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.
+- [@ecstrema](https://github.com/ecstrema) for providing an example on how to play games with the entralpi.
 
 ## Disclamer
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hangtime/grip-connect",
-  "version": "0.0.10",
+  "version": "0.1.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/calibrate.d.ts

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

package/src/calibrate.js

@@ -0,0 +1,15 @@
+import { Motherboard } from "./devices";
+import { write } from "./write";
+/**
+ * read calibration
+ * @param board
+ */
+export const calibrate = async (board) => {
+    if (!board.device)
+        return;
+    if (board.device.gatt?.connected) {
+        if (board.name === "Motherboard") {
+            await write(Motherboard, "uart", "tx", "C", 2500);
+        }
+    }
+};

package/src/calibrate.ts

@@ -0,0 +1,16 @@
+import { Device } from "./devices/types"
+import { Motherboard } from "./devices"
+import { write } from "./write"
+
+/**
+ * read calibration
+ * @param board
+ */
+export const calibrate = async (board: Device): Promise<void> => {
+  if (!board.device) return
+  if (board.device.gatt?.connected) {
+    if (board.name === "Motherboard") {
+      await write(Motherboard, "uart", "tx", "C", 2500)
+    }
+  }
+}

package/src/connect.js

@@ -37,8 +37,12 @@ const handleNotifications = (event, board) => {
             }
         }
         else if (board.name === "ENTRALPI") {
-            const receivedData = value.getInt16(0) / 100;
-            handleEntralpiData(characteristic.uuid, receivedData);
+            if (value.buffer) {
+                const buffer = value.buffer;
+                const rawData = new DataView(buffer);
+                const receivedData = rawData.getUint16(0) / 100;
+                handleEntralpiData(characteristic.uuid, receivedData);
+            }
         }
         else if (board.name === "Tindeq") {
             // TODO: handle Tindeq notify

package/src/connect.ts

@@ -22,25 +22,29 @@ const onDisconnected = (event: Event, board: Device): void => {
  * @param onNotify
  */
 const handleNotifications = (event: Event, board: Device): void => {
-  const characteristic = event.target as BluetoothRemoteGATTCharacteristic
-  const value = characteristic.value
+  const characteristic: BluetoothRemoteGATTCharacteristic = event.target as BluetoothRemoteGATTCharacteristic
+  const value: DataView | undefined = characteristic.value
   if (value) {
     if (board.name === "Motherboard") {
-      for (let i = 0; i < value.byteLength; i++) {
+      for (let i: number = 0; i < value.byteLength; i++) {
         receiveBuffer.push(value.getUint8(i))
       }
 
       let idx: number
       while ((idx = receiveBuffer.indexOf(10)) >= 0) {
-        const line = receiveBuffer.splice(0, idx + 1).slice(0, -1) // Combine and remove LF
+        const line: number[] = 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))
+        const decoder: TextDecoder = new TextDecoder("utf-8")
+        const receivedData: string = decoder.decode(new Uint8Array(line))
         handleMotherboardData(characteristic.uuid, receivedData)
       }
     } else if (board.name === "ENTRALPI") {
-      const receivedData: number = value.getInt16(0) / 100
-      handleEntralpiData(characteristic.uuid, receivedData)
+      if (value.buffer) {
+        const buffer: ArrayBuffer = value.buffer
+        const rawData: DataView = new DataView(buffer)
+        const receivedData: number = rawData.getUint16(0) / 100
+        handleEntralpiData(characteristic.uuid, receivedData)
+      }
     } else if (board.name === "Tindeq") {
       // TODO: handle Tindeq notify
     } else {
@@ -57,7 +61,7 @@ const handleNotifications = (event: Event, board: Device): void => {
  */
 const onConnected = async (board: Device, onSuccess: () => void): Promise<void> => {
   try {
-    const services = await server?.getPrimaryServices()
+    const services: BluetoothRemoteGATTService[] = await server?.getPrimaryServices()
 
     if (!services || services.length === 0) {
       console.error("No services found")

package/src/devices/climbro.d.ts

@@ -0,0 +1,2 @@
+import { Device } from "./types";
+export declare const Climbro: Device;

package/src/devices/climbro.js

@@ -0,0 +1,4 @@
+export const Climbro = {
+    name: "Climbro",
+    services: [],
+};

package/src/devices/climbro.ts

@@ -0,0 +1,6 @@
+import { Device } from "./types"
+
+export const Climbro: Device = {
+  name: "Climbro",
+  services: [],
+}

package/src/devices/entralpi.js

@@ -57,10 +57,12 @@ export const Entralpi = {
  * @param receivedData - Received data string
  */
 export function handleEntralpiData(uuid, receivedData) {
-    notifyCallback({
-        uuid,
-        value: {
-            massTotal: receivedData,
-        },
-    });
+    if (notifyCallback) {
+        notifyCallback({
+            uuid,
+            value: {
+                massTotal: receivedData,
+            },
+        });
+    }
 }

package/src/devices/entralpi.ts

@@ -60,10 +60,12 @@ export const Entralpi: Device = {
  * @param receivedData - Received data string
  */
 export function handleEntralpiData(uuid: string, receivedData: number): void {
-  notifyCallback({
-    uuid,
-    value: {
-      massTotal: receivedData,
-    },
-  })
+  if (notifyCallback) {
+    notifyCallback({
+      uuid,
+      value: {
+        massTotal: receivedData,
+      },
+    })
+  }
 }

package/src/devices/index.d.ts

@@ -1,3 +1,5 @@
-export { Motherboard } from "./moterboard";
+export { Climbro } from "./climbro";
 export { Entralpi } from "./entralpi";
+export { Motherboard } from "./moterboard";
+export { SmartBoard } from "./smartboard";
 export { Tindeq } from "./tindeq";

package/src/devices/index.js

@@ -1,3 +1,5 @@
-export { Motherboard } from "./moterboard";
+export { Climbro } from "./climbro";
 export { Entralpi } from "./entralpi";
+export { Motherboard } from "./moterboard";
+export { SmartBoard } from "./smartboard";
 export { Tindeq } from "./tindeq";

package/src/devices/index.ts

@@ -1,5 +1,9 @@
-export { Motherboard } from "./moterboard"
+export { Climbro } from "./climbro"
 
 export { Entralpi } from "./entralpi"
 
+export { Motherboard } from "./moterboard"
+
+export { SmartBoard } from "./smartboard"
+
 export { Tindeq } from "./tindeq"

package/src/devices/moterboard.js

@@ -98,7 +98,7 @@ const applyCalibration = (sample, calibration) => {
         // Change the sign to negative
         sign = -1;
         // Reflect the sample around the zero calibration point
-        sample = 2 * zeroCalibration - sample;
+        sample = /* 2 * zeroCalibration */ -sample;
     }
     // Iterate through the calibration data
     for (let i = 1; i < calibration.length; i++) {
@@ -156,18 +156,24 @@ export function handleMotherboardData(uuid, receivedData) {
                 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];
-        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),
-                massCenter: Math.max(-1000, center).toFixed(3),
-            },
-        });
+        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);

package/src/devices/moterboard.ts

@@ -105,7 +105,7 @@ const applyCalibration = (sample: number, calibration: number[][]): number => {
     sign = -1
 
     // Reflect the sample around the zero calibration point
-    sample = 2 * zeroCalibration - sample
+    sample = /* 2 * zeroCalibration */ -sample
   }
 
   // Iterate through the calibration data
@@ -184,20 +184,24 @@ export function handleMotherboardData(uuid: string, receivedData: string): void
       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]
-
-    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),
-        massCenter: Math.max(-1000, center).toFixed(3),
-      },
-    })
+    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

package/src/devices/smartboard.d.ts

@@ -0,0 +1,2 @@
+import { Device } from "./types";
+export declare const SmartBoard: Device;

package/src/devices/smartboard.js

@@ -0,0 +1,4 @@
+export const SmartBoard = {
+    name: "SmartBoard",
+    services: [],
+};

package/src/devices/smartboard.ts

@@ -0,0 +1,6 @@
+import { Device } from "./types"
+
+export const SmartBoard: Device = {
+  name: "SmartBoard",
+  services: [],
+}

package/src/index.d.ts

@@ -1,6 +1,7 @@
-export { Motherboard, Entralpi, Tindeq } from "./devices/index";
+export { Climbro, Entralpi, Motherboard, SmartBoard, Tindeq } from "./devices/index";
+export { calibrate } from "./calibrate";
 export { connect } from "./connect";
 export { disconnect } from "./disconnect";
 export { notify } from "./notify";
 export { read } from "./read";
-export { write } from "./write";
+export { stream } from "./stream";

package/src/index.js

@@ -1,6 +1,9 @@
-export { Motherboard, Entralpi, Tindeq } from "./devices/index";
+export { Climbro, Entralpi, Motherboard, SmartBoard, Tindeq } from "./devices/index";
+export { calibrate } from "./calibrate";
 export { connect } from "./connect";
 export { disconnect } from "./disconnect";
 export { notify } from "./notify";
 export { read } from "./read";
-export { write } from "./write";
+export { stream } from "./stream";
+// WARNING: Writing to device can seriously damage the device
+// export { write } from "./write"

package/src/index.ts

@@ -1,4 +1,6 @@
-export { Motherboard, Entralpi, Tindeq } from "./devices/index"
+export { Climbro, Entralpi, Motherboard, SmartBoard, Tindeq } from "./devices/index"
+
+export { calibrate } from "./calibrate"
 
 export { connect } from "./connect"
 
@@ -8,4 +10,7 @@ export { notify } from "./notify"
 
 export { read } from "./read"
 
-export { write } from "./write"
+export { stream } from "./stream"
+
+// WARNING: Writing to device can seriously damage the device
+// export { write } from "./write"

package/src/stream.d.ts

@@ -0,0 +1,6 @@
+import { Device } from "./devices/types";
+/**
+ * stream output
+ * @param board
+ */
+export declare const stream: (board: Device, duration?: number) => Promise<void>;

package/src/stream.js

@@ -0,0 +1,25 @@
+import { Motherboard, Tindeq } from "./devices";
+import { write } from "./write";
+/**
+ * stream output
+ * @param board
+ */
+export const stream = async (board, duration = 0) => {
+    if (!board.device)
+        return;
+    if (board.device.gatt?.connected) {
+        if (board.name === "Motherboard") {
+            // TODO: add check if device is recalibrated
+            // start stream
+            await write(Motherboard, "uart", "tx", "S30", duration);
+            // end stream
+            await write(Motherboard, "uart", "tx", "", 0);
+        }
+        if (board.name === "Tindeq") {
+            // start stream
+            await write(Tindeq, "progressor", "tx", "e", duration);
+            // end stream
+            await write(Tindeq, "progressor", "tx", "f", 0);
+        }
+    }
+};

package/src/stream.ts

@@ -0,0 +1,26 @@
+import { Device } from "./devices/types"
+import { Motherboard, Tindeq } from "./devices"
+import { write } from "./write"
+
+/**
+ * stream output
+ * @param board
+ */
+export const stream = async (board: Device, duration: number = 0): Promise<void> => {
+  if (!board.device) return
+  if (board.device.gatt?.connected) {
+    if (board.name === "Motherboard") {
+      // TODO: add check if device is recalibrated
+      // start stream
+      await write(Motherboard, "uart", "tx", "S30", duration)
+      // end stream
+      await write(Motherboard, "uart", "tx", "", 0)
+    }
+    if (board.name === "Tindeq") {
+      // start stream
+      await write(Tindeq, "progressor", "tx", "e", duration)
+      // end stream
+      await write(Tindeq, "progressor", "tx", "f", 0)
+    }
+  }
+}