@hangtime/grip-connect 0.2.6 → 0.3.0

package/README.md

@@ -5,18 +5,21 @@
 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
 [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/)
+[mySmartBoard](https://www.smartboard-climbing.com/), [Entralpi](https://entralpi.com/),
+[Tindeq Progressor](https://tindeq.com/) or [MAT Muscle Meter](https://www.matassessment.com/musclemeter)
 
 Learn more: [Docs](https://stevie-ray.github.io/hangtime-grip-connect/) -
 [Browser Support](https://caniuse.com/web-bluetooth)
 
 ## Try it out
 
-[Chart](https://grip-connect.vercel.app/) - [Flappy Bird](https://grip-connect-flappy-bird.vercel.app/)
+[Chart](https://grip-connect.vercel.app/) - [Flappy Bird](https://grip-connect-flappy-bird.vercel.app/) -
+[Pong](https://grip-connect-pong.vercel.app/)
 
 ## Install
 
+This project can be found in the [NPM package registry](https://www.npmjs.com/package/@hangtime/grip-connect).
+
 ```sh [npm]
 $ npm install @hangtime/grip-connect
 ```
@@ -38,7 +41,7 @@ motherboardButton.addEventListener("click", () => {
   connect(Motherboard, async () => {
     // Listen for stream notifications
     notify((data) => {
-      // data: { massTotal: 0, massLeft: 0, massRight: 0, massCenter: 0 }
+      // { massTotal: "0", massMax: "0", massAverage: "0", massLeft: "0", massCenter: "0", massRight: "0" }
       console.log(data)
     })
 
@@ -49,9 +52,15 @@ motherboardButton.addEventListener("click", () => {
     // 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 to CSV: format => timestamp, frame, battery, samples, masses
+    // download()
+
     // Disconnect from device after we are done
     disconnect(Motherboard)
   })
@@ -68,24 +77,24 @@ available services with us.
 
 - ✅ Griptonite Motherboard
 - ✅ Tindeq Progressor
-- ✅ Entralpi
+- ☑️ Entralpi (not verified)
 - ➡️ Climbro
-- ➡️ SmartBoard
+- ➡️ mySmartBoard
+- ➡️ MAT Muscle Meter
 
 ### Features
 
-- ✅ Connect
-- ✅ Disconnect
-- ✅ Start data stream (live data)
-- ✅ Stop data stream
+- ✅ Connect / Disconnect
+- ✅ Start / Stop data stream
 - ✅ Battery status
 - ✅ Read calibration
-- ✅ Device info (firmware / serial etc.)
+- ✅ Device info: firmware / serial etc.
 - ✅ Check if device is connected
-- ➡️ Peak load
+- ✅ Peak / Average load
+- ✅️ Tare / unladen weight
+- ✅️ Download data to CVS
 - ➡️ Endurance
-- ➡️ Rate of Force Development (RFD)
-- ➡️ Repeaters
+- ➡️ Rate of Force Development: RFD
 - ➡️ Critical Force
 
 ## Development
@@ -104,6 +113,7 @@ A special thank you to:
 - [@donaldharvey](https://github.com/donaldharvey) for a valuable example on connecting to the Motherboard.
 - [@ecstrema](https://github.com/ecstrema) for providing [examples](https://github.com/ecstrema/entralpi-games) on how
   to play games with the Entralpi.
+- [Tindeq](https://tindeq.com/) for providing an open [Progressor API](https://tindeq.com/progressor_api/)
 - [@StuartLittlefair](https://github.com/StuartLittlefair) for his
   [PyTindeq](https://github.com/StuartLittlefair/PyTindeq) implementation.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hangtime/grip-connect",
-  "version": "0.2.6",
+  "version": "0.3.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 Griptonite Motherboard, Climbro, SmartBoard, Entralpi or Tindeq Progressor",
   "main": "src/index.ts",
   "scripts": {

package/src/battery.d.ts

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

package/src/battery.js

@@ -4,15 +4,21 @@ import { isConnected } from "./is-connected";
 import { Motherboard, Progressor } from "./devices";
 import { ProgressorCommands } from "./commands";
 /**
- * Get Battery / Voltage information
- * @param board
+ * 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.
  */
 export const battery = async (board) => {
+    // Check if the device is connected
     if (isConnected(board)) {
+        // If the device is connected and it is a Motherboard device
         if (board.name === "Motherboard") {
+            // Read battery level information from the Motherboard
             await read(Motherboard, "battery", "level", 250);
         }
+        // If the device is connected and its name starts with "Progressor"
         if (board.name && board.name.startsWith("Progressor")) {
+            // Write command to get battery voltage information to the Progressor
             await write(Progressor, "progressor", "tx", ProgressorCommands.GET_BATT_VLTG, 250);
         }
     }

package/src/battery.ts

@@ -6,15 +6,21 @@ import { Motherboard, Progressor } from "./devices"
 import { ProgressorCommands } from "./commands"
 
 /**
- * Get Battery / Voltage information
- * @param board
+ * 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.
  */
 export const battery = async (board: Device): Promise<void> => {
+  // Check if the device is connected
   if (isConnected(board)) {
+    // If the device is connected and it is a Motherboard device
     if (board.name === "Motherboard") {
+      // Read battery level information from the Motherboard
       await read(Motherboard, "battery", "level", 250)
     }
+    // If the device is connected and its name starts with "Progressor"
     if (board.name && board.name.startsWith("Progressor")) {
+      // Write command to get battery voltage information to the Progressor
       await write(Progressor, "progressor", "tx", ProgressorCommands.GET_BATT_VLTG, 250)
     }
   }

package/src/calibration.d.ts

@@ -1,6 +1,7 @@
 import { Device } from "./devices/types";
 /**
- * write command to get calibration
- * @param board
+ * Writes a command to get calibration data from the device.
+ * @param {Device} board - The device.
+ * @returns {Promise<void>} A Promise that resolves when the command is successfully sent.
  */
 export declare const calibration: (board: Device) => Promise<void>;

package/src/calibration.js

@@ -3,12 +3,16 @@ import { write } from "./write";
 import { Motherboard } from "./devices";
 import { MotherboardCommands } from "./commands";
 /**
- * write command to get calibration
- * @param board
+ * Writes a command to get calibration data from the device.
+ * @param {Device} board - The device.
+ * @returns {Promise<void>} A Promise that resolves when the command is successfully sent.
  */
 export const calibration = async (board) => {
+    // Check if the device is connected
     if (isConnected(board)) {
+        // If the device is connected, and it is a Motherboard device
         if (board.name === "Motherboard") {
+            // Write the command to get calibration data to the device
             await write(Motherboard, "uart", "tx", MotherboardCommands.GET_CALIBRATION, 2500);
         }
     }

package/src/calibration.ts

@@ -5,12 +5,16 @@ import { Motherboard } from "./devices"
 import { MotherboardCommands } from "./commands"
 
 /**
- * write command to get calibration
- * @param board
+ * Writes a command to get calibration data from the device.
+ * @param {Device} board - The device.
+ * @returns {Promise<void>} A Promise that resolves when the command is successfully sent.
  */
 export const calibration = async (board: Device): Promise<void> => {
+  // Check if the device is connected
   if (isConnected(board)) {
+    // If the device is connected, and it is a Motherboard device
     if (board.name === "Motherboard") {
+      // Write the command to get calibration data to the device
       await write(Motherboard, "uart", "tx", MotherboardCommands.GET_CALIBRATION, 2500)
     }
   }

package/src/characteristic.d.ts

@@ -1,9 +1,10 @@
 /// <reference types="web-bluetooth" />
 import { Device } from "./devices/types";
 /**
- * getCharacteristic
- * @param board
- * @param serviceId
- * @param characteristicId
+ * Retrieves the characteristic from the device's service.
+ * @param {Device} board - The device.
+ * @param {string} serviceId - The UUID of the service.
+ * @param {string} characteristicId - The UUID of the characteristic.
+ * @returns {BluetoothRemoteGATTCharacteristic | undefined} The characteristic, if found.
  */
 export declare const getCharacteristic: (board: Device, serviceId: string, characteristicId: string) => BluetoothRemoteGATTCharacteristic | undefined;

package/src/characteristic.js

@@ -1,15 +1,20 @@
 /**
- * getCharacteristic
- * @param board
- * @param serviceId
- * @param characteristicId
+ * Retrieves the characteristic from the device's service.
+ * @param {Device} board - The device.
+ * @param {string} serviceId - The UUID of the service.
+ * @param {string} characteristicId - The UUID of the characteristic.
+ * @returns {BluetoothRemoteGATTCharacteristic | undefined} The characteristic, if found.
  */
 export const getCharacteristic = (board, serviceId, characteristicId) => {
+    // Find the service with the specified serviceId
     const boardService = board.services.find((service) => service.id === serviceId);
     if (boardService) {
+        // If the service is found, find the characteristic with the specified characteristicId
         const boardCharacteristic = boardService.characteristics.find((characteristic) => characteristic.id === characteristicId);
         if (boardCharacteristic) {
+            // If the characteristic is found, return it
             return boardCharacteristic.characteristic;
         }
     }
+    // Return undefined if the service or characteristic is not found
 };

package/src/characteristic.ts

@@ -1,19 +1,28 @@
 import { Device } from "./devices/types"
 
 /**
- * getCharacteristic
- * @param board
- * @param serviceId
- * @param characteristicId
+ * Retrieves the characteristic from the device's service.
+ * @param {Device} board - The device.
+ * @param {string} serviceId - The UUID of the service.
+ * @param {string} characteristicId - The UUID of the characteristic.
+ * @returns {BluetoothRemoteGATTCharacteristic | undefined} The characteristic, if found.
  */
-export const getCharacteristic = (board: Device, serviceId: string, characteristicId: string) => {
+export const getCharacteristic = (
+  board: Device,
+  serviceId: string,
+  characteristicId: string,
+): BluetoothRemoteGATTCharacteristic | undefined => {
+  // Find the service with the specified serviceId
   const boardService = board.services.find((service) => service.id === serviceId)
   if (boardService) {
+    // If the service is found, find the characteristic with the specified characteristicId
     const boardCharacteristic = boardService.characteristics.find(
       (characteristic) => characteristic.id === characteristicId,
     )
     if (boardCharacteristic) {
+      // If the characteristic is found, return it
       return boardCharacteristic.characteristic
     }
   }
+  // Return undefined if the service or characteristic is not found
 }

package/src/commands/index.d.ts

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

package/src/commands/index.js

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

package/src/commands/index.ts

@@ -4,6 +4,8 @@ export { EntralpiCommands } from "./entralpi"
 
 export { MotherboardCommands } from "./motherboard"
 
+export { MuscleMeterCommands } from "./musclemeter"
+
 export { ProgressorCommands } from "./progressor"
 
-export { SmartBoardCommands } from "./smartboard"
+export { mySmartBoardCommands } from "./mysmartboard"

package/src/commands/{smartboard.d.ts → musclemeter.d.ts}

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

package/src/commands/{smartboard.js → musclemeter.js}

@@ -2,4 +2,4 @@
  * Warning:
  * Using other commands can seriously harm your device
  */
-export const SmartBoardCommands = {};
+export const MuscleMeterCommands = {};

package/src/commands/{smartboard.ts → musclemeter.ts}

@@ -3,4 +3,4 @@ import { Commands } from "../commands/types"
  * Warning:
  * Using other commands can seriously harm your device
  */
-export const SmartBoardCommands: Commands = {}
+export const MuscleMeterCommands: Commands = {}

package/src/commands/mysmartboard.d.ts

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

package/src/commands/mysmartboard.js

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

package/src/commands/mysmartboard.ts

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

package/src/commands/progressor.d.ts

@@ -11,5 +11,7 @@ export declare const ProgressorCommands: Commands;
 export declare const ProgressorResponses: {
     COMMAND_RESPONSE: number;
     WEIGHT_MEASURE: number;
+    PEAK_RFD_MEAS: number;
+    PEAK_RFD_MEAS_SERIES: number;
     LOW_BATTERY_WARNING: number;
 };

package/src/commands/progressor.js

@@ -23,5 +23,7 @@ export const ProgressorCommands = {
 export const ProgressorResponses = {
     COMMAND_RESPONSE: 0,
     WEIGHT_MEASURE: 1,
-    LOW_BATTERY_WARNING: 2,
+    PEAK_RFD_MEAS: 2,
+    PEAK_RFD_MEAS_SERIES: 3,
+    LOW_BATTERY_WARNING: 4,
 };

package/src/commands/progressor.ts

@@ -25,5 +25,7 @@ export const ProgressorCommands: Commands = {
 export const ProgressorResponses = {
   COMMAND_RESPONSE: 0,
   WEIGHT_MEASURE: 1,
-  LOW_BATTERY_WARNING: 2,
+  PEAK_RFD_MEAS: 2,
+  PEAK_RFD_MEAS_SERIES: 3,
+  LOW_BATTERY_WARNING: 4,
 }

package/src/connect.d.ts

@@ -1,7 +1,7 @@
 import { Device } from "./devices/types";
 /**
- * Connect to the BluetoothDevice
- * @param device
- * @param onSuccess
+ * Connects to a Bluetooth device.
+ * @param {Device} board - The device to connect to.
+ * @param {Function} onSuccess - Callback function to execute on successful connection.
  */
 export declare const connect: (board: Device, onSuccess: () => void) => Promise<void>;

package/src/connect.js

@@ -1,11 +1,10 @@
-import { notifyCallback } from "./notify";
-import { handleMotherboardData, handleProgressorData } from "./data";
+import { handleEntralpiData, handleMotherboardData, handleProgressorData } from "./data";
 let server;
 const receiveBuffer = [];
 /**
- * onDisconnected
- * @param board
- * @param event
+ * Handles the 'disconnected' event.
+ * @param {Event} event - The 'disconnected' event.
+ * @param {Device} board - The device that is disconnected.
  */
 const onDisconnected = (event, board) => {
     board.device = undefined;
@@ -13,9 +12,9 @@ const onDisconnected = (event, board) => {
     console.log(`Device ${device.name} is disconnected.`);
 };
 /**
- * handleNotifications
- * @param event
- * @param onNotify
+ * Handles notifications received from a characteristic.
+ * @param {Event} event - The notification event.
+ * @param {Device} board - The device associated with the characteristic.
  */
 const handleNotifications = (event, board) => {
     const characteristic = event.target;
@@ -32,45 +31,37 @@ const handleNotifications = (event, board) => {
                     line.pop(); // Remove CR
                 const decoder = new TextDecoder("utf-8");
                 const receivedData = decoder.decode(new Uint8Array(line));
-                handleMotherboardData(characteristic.uuid, receivedData);
+                handleMotherboardData(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,
-                        },
-                    });
-                }
+                const receivedData = (rawData.getUint16(0) / 100).toFixed(1);
+                handleEntralpiData(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);
+                handleProgressorData(rawData);
             }
         }
         else {
-            if (notifyCallback) {
-                notifyCallback({ uuid: characteristic.uuid, value: value });
-            }
+            console.log(value);
         }
     }
 };
 /**
- * onConnected
- * @param event
- * @param board
+ * Handles the 'connected' event.
+ * @param {Device} board - The connected device.
+ * @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");
@@ -109,19 +100,21 @@ const onConnected = async (board, onSuccess) => {
     }
 };
 /**
- * Return all service UUIDs
- * @param device
+ * Returns UUIDs of all services associated with the device.
+ * @param {Device} device - The device.
+ * @returns {string[]} Array of service UUIDs.
  */
 const getAllServiceUUIDs = (device) => {
     return device.services.map((service) => service.uuid);
 };
 /**
- * Connect to the BluetoothDevice
- * @param device
- * @param onSuccess
+ * Connects to a Bluetooth device.
+ * @param {Device} board - The device to connect to.
+ * @param {Function} onSuccess - Callback function to execute on successful connection.
  */
 export const connect = async (board, onSuccess) => {
     try {
+        // Request device and set up connection
         const deviceServices = getAllServiceUUIDs(board);
         // setup filter list
         const filters = [];

package/src/connect.ts

@@ -1,14 +1,13 @@
 import { Device } from "./devices/types"
-import { notifyCallback } from "./notify"
-import { handleMotherboardData, handleProgressorData } from "./data"
+import { handleEntralpiData, handleMotherboardData, handleProgressorData } from "./data"
 
 let server: BluetoothRemoteGATTServer
 const receiveBuffer: number[] = []
 
 /**
- * onDisconnected
- * @param board
- * @param event
+ * Handles the 'disconnected' event.
+ * @param {Event} event - The 'disconnected' event.
+ * @param {Device} board - The device that is disconnected.
  */
 const onDisconnected = (event: Event, board: Device): void => {
   board.device = undefined
@@ -16,9 +15,9 @@ const onDisconnected = (event: Event, board: Device): void => {
   console.log(`Device ${device.name} is disconnected.`)
 }
 /**
- * handleNotifications
- * @param event
- * @param onNotify
+ * Handles notifications received from a characteristic.
+ * @param {Event} event - The notification event.
+ * @param {Device} board - The device associated with the characteristic.
  */
 const handleNotifications = (event: Event, board: Device): void => {
   const characteristic: BluetoothRemoteGATTCharacteristic = event.target as BluetoothRemoteGATTCharacteristic
@@ -36,42 +35,34 @@ const handleNotifications = (event: Event, board: Device): void => {
         if (line.length > 0 && line[line.length - 1] === 13) line.pop() // Remove CR
         const decoder: TextDecoder = new TextDecoder("utf-8")
         const receivedData: string = decoder.decode(new Uint8Array(line))
-        handleMotherboardData(characteristic.uuid, receivedData)
+        handleMotherboardData(receivedData)
       }
     } else if (board.name === "ENTRALPI") {
       if (value.buffer) {
         const buffer: ArrayBuffer = value.buffer
         const rawData: DataView = new DataView(buffer)
-        const receivedData: number = rawData.getUint16(0) / 100
-        if (notifyCallback) {
-          notifyCallback({
-            uuid: characteristic.uuid,
-            value: {
-              massTotal: receivedData,
-            },
-          })
-        }
+        const receivedData: string = (rawData.getUint16(0) / 100).toFixed(1)
+        handleEntralpiData(receivedData)
       }
     } else if (board.name && board.name.startsWith("Progressor")) {
       if (value.buffer) {
         const buffer: ArrayBuffer = value.buffer
         const rawData: DataView = new DataView(buffer)
-        handleProgressorData(characteristic.uuid, rawData)
+        handleProgressorData(rawData)
       }
     } else {
-      if (notifyCallback) {
-        notifyCallback({ uuid: characteristic.uuid, value: value })
-      }
+      console.log(value)
     }
   }
 }
 /**
- * onConnected
- * @param event
- * @param board
+ * Handles the 'connected' event.
+ * @param {Device} board - The connected device.
+ * @param {Function} onSuccess - Callback function to execute on successful connection.
  */
 const onConnected = async (board: Device, onSuccess: () => void): Promise<void> => {
   try {
+    // Connect to GATT server and set up characteristics
     const services: BluetoothRemoteGATTService[] = await server?.getPrimaryServices()
 
     if (!services || services.length === 0) {
@@ -118,19 +109,21 @@ const onConnected = async (board: Device, onSuccess: () => void): Promise<void>
   }
 }
 /**
- * Return all service UUIDs
- * @param device
+ * Returns UUIDs of all services associated with the device.
+ * @param {Device} device - The device.
+ * @returns {string[]} Array of service UUIDs.
  */
 const getAllServiceUUIDs = (device: Device) => {
   return device.services.map((service) => service.uuid)
 }
 /**
- * Connect to the BluetoothDevice
- * @param device
- * @param onSuccess
+ * Connects to a Bluetooth device.
+ * @param {Device} board - The device to connect to.
+ * @param {Function} onSuccess - Callback function to execute on successful connection.
  */
 export const connect = async (board: Device, onSuccess: () => void): Promise<void> => {
   try {
+    // Request device and set up connection
     const deviceServices = getAllServiceUUIDs(board)
 
     // setup filter list

package/src/data.d.ts

@@ -1,9 +1,16 @@
 export declare const CALIBRATION: never[][];
 /**
- * handleMotherboardData
- *
- * @param uuid - Unique identifier
- * @param receivedData - Received data string
+ * Handles data received from the Motherboard device.
+ * @param {string} receivedData - The received data string.
  */
-export declare const handleMotherboardData: (uuid: string, receivedData: string) => void;
-export declare const handleProgressorData: (uuid: string, data: DataView) => void;
+export declare const handleMotherboardData: (receivedData: string) => void;
+/**
+ * Handles data received from the Progressor device.
+ * @param {DataView} data - The received data.
+ */
+export declare const handleProgressorData: (data: DataView) => void;
+/**
+ * Handles data received from the Entralpi device.
+ * @param {string} receivedData - The received data string.
+ */
+export declare const handleEntralpiData: (receivedData: string) => void;