@hangtime/grip-connect 0.6.1 → 0.7.0

package/src/models/device/forceboard.model.ts

@@ -1,5 +1,5 @@
-import { Device } from "../device.model.js"
-import type { IForceBoard } from "../../interfaces/device/forceboard.interface.js"
+import { Device } from "../device.model"
+import type { IForceBoard } from "../../interfaces/device/forceboard.interface"
 
 /**
  * Represents a PitchSix Force Board device.
@@ -108,13 +108,13 @@ export class ForceBoard extends Device implements IForceBoard {
               uuid: "9a88d681-8df2-4afe-9e0d-c2bbbe773dd0",
             },
             {
-              name: "Read + Notify",
+              name: "Force Data",
               id: "rx",
               uuid: "9a88d682-8df2-4afe-9e0d-c2bbbe773dd0",
             },
             {
-              name: "Write",
-              id: "",
+              name: "Tare",
+              id: "tare",
               uuid: "9a88d683-8df2-4afe-9e0d-c2bbbe773dd0",
             },
             {
@@ -123,8 +123,8 @@ export class ForceBoard extends Device implements IForceBoard {
               uuid: "9a88d685-8df2-4afe-9e0d-c2bbbe773dd0",
             },
             {
-              name: "Write",
-              id: "",
+              name: "Threshold",
+              id: "threshold",
               uuid: "9a88d686-8df2-4afe-9e0d-c2bbbe773dd0",
             },
             {
@@ -145,12 +145,12 @@ export class ForceBoard extends Device implements IForceBoard {
           ],
         },
         {
-          name: "Weight Serivce",
+          name: "Weight Service",
           id: "weight",
           uuid: "467a8516-6e39-11eb-9439-0242ac130002",
           characteristics: [
             {
-              name: "Read + Write",
+              name: "Device Mode",
               id: "tx",
               uuid: "467a8517-6e39-11eb-9439-0242ac130002",
             },
@@ -163,7 +163,10 @@ export class ForceBoard extends Device implements IForceBoard {
         },
       ],
       commands: {
-        STOP_WEIGHT_MEAS: "",
+        START_WEIGHT_MEAS: String.fromCharCode(0x04), // Streaming Data Mode: continuously streams force data.
+        TARE_SCALE: String.fromCharCode(0x05), // Tare function: zeroes out the current load value
+        START_QUICK_MEAS: String.fromCharCode(0x06), // Quick Start Mode: Starts data transmission when a force value exceeds the Threshold and stops data transmission when the force data drops below the Threshold.
+        STOP_WEIGHT_MEAS: String.fromCharCode(0x07), // Idle Mode: Force Board is idle.
       },
     })
   }
@@ -191,43 +194,51 @@ export class ForceBoard extends Device implements IForceBoard {
       if (value.buffer) {
         const receivedTime: number = Date.now()
         const dataArray = new Uint8Array(value.buffer)
-        // Skip the first 2 bytes, which are the command and length
-        // The data is sent in groups of 3 bytes
-        for (let i = 2; i < dataArray.length; i += 3) {
-          const receivedData = (dataArray[i] << 16) | (dataArray[i + 1] << 8) | dataArray[i + 2]
-          // Convert from LBS to KG
-          const convertedReceivedData = receivedData * 0.453592
-          // Tare correction
-          const numericData = convertedReceivedData - this.applyTare(convertedReceivedData)
-          // Add data to downloadable Array
-          this.downloadPackets.push({
-            received: receivedTime,
-            sampleNum: this.dataPointCount,
-            battRaw: 0,
-            samples: [convertedReceivedData],
-            masses: [numericData],
-          })
 
-          // Update massMax
-          this.massMax = Math.max(Number(this.massMax), numericData).toFixed(1)
+        // First two bytes contain the number of samples in the packet
+        const numSamples = (dataArray[0] << 8) | dataArray[1]
+
+        // Process each sample (3 bytes per sample)
+        for (let i = 0; i < numSamples; i++) {
+          const offset = 2 + i * 3 // Skip the first 2 bytes which indicate number of samples
+          if (offset + 2 < dataArray.length) {
+            // Sample = byte1*32768 + byte2*256 + byte3
+            const receivedData = dataArray[offset] * 32768 + dataArray[offset + 1] * 256 + dataArray[offset + 2]
+
+            // Convert from LBS to KG
+            const convertedReceivedData = receivedData * 0.453592
+            // Tare correction
+            const numericData = convertedReceivedData - this.applyTare(convertedReceivedData)
+            // Add data to downloadable Array
+            this.downloadPackets.push({
+              received: receivedTime,
+              sampleNum: this.dataPointCount,
+              battRaw: 0,
+              samples: [convertedReceivedData],
+              masses: [numericData],
+            })
 
-          // Update running sum and count
-          const currentMassTotal = Math.max(-1000, numericData)
-          this.massTotalSum += currentMassTotal
-          this.dataPointCount++
+            // Update massMax
+            this.massMax = Math.max(Number(this.massMax), numericData).toFixed(1)
 
-          // Calculate the average dynamically
-          this.massAverage = (this.massTotalSum / this.dataPointCount).toFixed(1)
+            // Update running sum and count
+            const currentMassTotal = Math.max(-1000, numericData)
+            this.massTotalSum += currentMassTotal
+            this.dataPointCount++
 
-          // Check if device is being used
-          this.activityCheck(numericData)
+            // Calculate the average dynamically
+            this.massAverage = (this.massTotalSum / this.dataPointCount).toFixed(1)
 
-          // Notify with weight data
-          this.notifyCallback({
-            massMax: this.massMax,
-            massAverage: this.massAverage,
-            massTotal: Math.max(-1000, numericData).toFixed(1),
-          })
+            // Check if device is being used
+            this.activityCheck(numericData)
+
+            // Notify with weight data
+            this.notifyCallback({
+              massMax: this.massMax,
+              massAverage: this.massAverage,
+              massTotal: Math.max(-1000, numericData).toFixed(1),
+            })
+          }
         }
       }
     }
@@ -250,7 +261,7 @@ export class ForceBoard extends Device implements IForceBoard {
   }
 
   /**
-   * Stops the data stream on the specified device.
+   * Stops the data stream on the specified device by setting it to Idle mode.
    * @returns {Promise<void>} A promise that resolves when the stream is stopped.
    */
   stop = async (): Promise<void> => {
@@ -258,26 +269,66 @@ export class ForceBoard extends Device implements IForceBoard {
   }
 
   /**
-   * Starts streaming data from the specified device.
+   * Starts streaming data from the specified device in Streaming Data Mode.
    * @param {number} [duration=0] - The duration of the stream in milliseconds. If set to 0, stream will continue indefinitely.
    * @returns {Promise<void>} A promise that resolves when the streaming operation is completed.
    */
   stream = async (duration = 0): Promise<void> => {
-    // Reset download packets
-    this.downloadPackets.length = 0
-    // Start streaming data
-    await this.write("weight", "tx", new Uint8Array([0x04]), duration) // ASCII control character EOT (End of Transmission)
-    // Stop streaming if duration is set
-    if (duration !== 0) {
-      await this.stop()
-    }
+    // Start streaming data - Streaming Data Mode
+    await this.write("weight", "tx", this.commands.START_WEIGHT_MEAS, duration)
+  }
+
+  /**
+   * Sets the threshold in Lbs for the Quick Start mode.
+   * @param {number} thresholdLbs - The threshold value in pounds.
+   * @returns {Promise<void>} A promise that resolves when the threshold is set.
+   */
+  threshold = async (thresholdLbs: number): Promise<void> => {
+    const thresholdHex = thresholdLbs.toString(16).padStart(6, "0")
+    // 3-byte array from the hex string
+    const bytes = new Uint8Array(3)
+    bytes[0] = parseInt(thresholdHex.substring(0, 2), 16)
+    bytes[1] = parseInt(thresholdHex.substring(2, 4), 16)
+    bytes[2] = parseInt(thresholdHex.substring(4, 6), 16)
+
+    await this.write("forceboard", "threshold", String.fromCharCode(...bytes), 0)
+  }
+
+  /**
+   * Tares the Force Board device using a characteristic to zero out the current load value.
+   * @returns {Promise<void>} A promise that resolves when the tare operation is completed.
+   */
+  tareByCharacteristic = async (): Promise<void> => {
+    // Send tare command (0x01) to the tare characteristic
+    const tareValue = String.fromCharCode(0x01)
+    await this.write("forceboard", "tare", tareValue, 0)
+  }
+
+  /**
+   * Initiates a tare routine via the Device Mode characteristic.
+   * Writes 0x05 to the Device Mode characteristic to zero out the current load value.
+   * @returns {Promise<void>} A promise that resolves when the tare operation is completed.
+   */
+  tareByMode = async (): Promise<void> => {
+    await this.write("weight", "tx", this.commands.TARE_SCALE, 0)
   }
 
   /**
    * Retrieves temperature information from the device.
-   * @returns {Promise<string>} A Promise that resolves with the manufacturer information,
+   * @returns {Promise<string>} A Promise that resolves with the temperature information,
    */
   temperature = async (): Promise<string | undefined> => {
     return await this.read("temperature", "level", 250)
   }
+
+  /**
+   * Starts the Force Board in Quick Start mode.
+   * Writes 0x06 to the Device Mode characteristic.
+   * @param {number} [duration=0] - The duration in milliseconds. If set to 0, mode will continue indefinitely.
+   * @returns {Promise<void>} A promise that resolves when the operation is completed.
+   */
+  quick = async (duration = 0): Promise<void> => {
+    // Start in Quick Start mode
+    await this.write("weight", "tx", this.commands.START_QUICK_MEAS, duration)
+  }
 }

package/src/models/device/kilterboard.model.ts

@@ -1,5 +1,5 @@
-import { Device } from "../device.model.js"
-import type { IKilterBoard } from "../../interfaces/device/kilterboard.interface.js"
+import { Device } from "../device.model"
+import type { IKilterBoard } from "../../interfaces/device/kilterboard.interface"
 
 /**
  * For API level 2 and API level 3.
@@ -254,7 +254,7 @@ export class KilterBoard extends Device implements IKilterBoard {
 
   /**
    * Splits a collection into slices of the specified length.
-   * https://github.com/ramda/ramda/blob/master/source/splitEvery.js
+   * https://github.com/ramda/ramda/blob/master/source/splitEvery
    * @param {Number} n
    * @param {Array} list
    * @return {Array<number[]>}

package/src/models/device/motherboard.model.ts

@@ -1,6 +1,6 @@
-import { Device } from "../device.model.js"
-import type { IMotherboard } from "../../interfaces/device/motherboard.interface.js"
-import type { DownloadPacket } from "../../interfaces/download.interface.js"
+import { Device } from "../device.model"
+import type { IMotherboard } from "../../interfaces/device/motherboard.interface"
+import type { DownloadPacket } from "../../interfaces/download.interface"
 
 /**
  * Represents a Griptonite Motherboard device.

package/src/models/device/mysmartboard.model.ts

@@ -1,5 +1,5 @@
-import { Device } from "../device.model.js"
-import type { ImySmartBoard } from "../../interfaces/device/mysmartboard.interface.js"
+import { Device } from "../device.model"
+import type { ImySmartBoard } from "../../interfaces/device/mysmartboard.interface"
 
 /**
  * Represents a Smartboard Climbing mySmartBoard device.

package/src/models/device/progressor.model.ts

@@ -1,5 +1,5 @@
-import { Device } from "../device.model.js"
-import type { IProgressor } from "../../interfaces/device/progressor.interface.js"
+import { Device } from "../device.model"
+import type { IProgressor } from "../../interfaces/device/progressor.interface"
 
 /**
  * Progressor responses

package/src/models/device/wh-c06.model.ts

@@ -1,5 +1,5 @@
-import { Device } from "../device.model.js"
-import type { IWHC06 } from "../../interfaces/device/wh-c06.interface.js"
+import { Device } from "../device.model"
+import type { IWHC06 } from "../../interfaces/device/wh-c06.interface"
 
 /**
  * Represents a Weiheng - WH-C06 (or MAT Muscle Meter) device.

package/src/models/device.model.ts

@@ -1,8 +1,8 @@
-import { BaseModel } from "./../models/base.model.js"
-import type { IDevice, Service } from "../interfaces/device.interface.js"
-import type { ActiveCallback, massObject, NotifyCallback, WriteCallback } from "../interfaces/callback.interface.js"
-import type { DownloadPacket } from "../interfaces/download.interface.js"
-import type { Commands } from "../interfaces/command.interface.js"
+import { BaseModel } from "./../models/base.model"
+import type { IDevice, Service } from "../interfaces/device.interface"
+import type { ActiveCallback, massObject, NotifyCallback, WriteCallback } from "../interfaces/callback.interface"
+import type { DownloadPacket } from "../interfaces/download.interface"
+import type { Commands } from "../interfaces/command.interface"
 
 export abstract class Device extends BaseModel implements IDevice {
   /**
@@ -29,7 +29,7 @@ export abstract class Device extends BaseModel implements IDevice {
    * @type {BluetoothDevice | undefined}
    * @public
    */
-  bluetooth?: BluetoothDevice | undefined
+  bluetooth?: BluetoothDevice
 
   /**
    * Object representing the set of commands available for this device.
@@ -240,22 +240,16 @@ export abstract class Device extends BaseModel implements IDevice {
    * @example
    * await device.activityCheck(5.0);
    */
-  protected activityCheck = (input: number): Promise<void> => {
-    return new Promise((resolve) => {
-      const startValue = input
-      const { threshold, duration } = this.activeConfig
-      setTimeout(() => {
-        // After waiting for `duration`, check if still active (for a real scenario, you might store a last known input)
-        const activeNow = startValue > threshold
-        if (this.isActive !== activeNow) {
-          this.isActive = activeNow
-          if (this.activeCallback) {
-            this.activeCallback(activeNow)
-          }
-        }
-        resolve()
-      }, duration)
-    })
+  protected activityCheck = async (input: number): Promise<void> => {
+    const startValue = input
+    const { threshold, duration } = this.activeConfig
+    // After waiting for `duration`, check if still active.
+    await new Promise((resolve) => setTimeout(resolve, duration))
+    const activeNow = startValue > threshold
+    if (this.isActive !== activeNow) {
+      this.isActive = activeNow
+      this.activeCallback?.(activeNow)
+    }
   }
 
   /**
@@ -319,7 +313,7 @@ export abstract class Device extends BaseModel implements IDevice {
       // Remove all notification listeners
       this.services.forEach((service) => {
         service.characteristics.forEach((char) => {
-          // TODO: remove device-specific logic
+          // Look for the "rx" characteristic that accepts notifications
           if (char.characteristic && char.id === "rx") {
             char.characteristic.stopNotifications()
             const listener = this.notificationListeners.get(char.uuid)
@@ -494,53 +488,30 @@ export abstract class Device extends BaseModel implements IDevice {
   }
 
   /**
-   * Attempt to use ES module import rather than require.
-   * This approach uses an async dynamic import for `webbluetooth`,
-   * so we can fallback if `navigator.bluetooth` is unavailable.
+   * Returns the Bluetooth instance available for the current environment.
+   * In browsers, it returns the native Web Bluetooth API (i.e. `navigator.bluetooth`).
+   * In a Node, Bun, or Deno environment, it dynamically imports the `webbluetooth` package.
+   * {@link https://github.com/thegecko/webbluetooth}
+   *
+   * @returns {Promise<Bluetooth>} A promise that resolves to the Bluetooth instance.
+   * @throws {Error} If Web Bluetooth is not available in the current environment.
    */
-  protected async getBluetooth() {
-    // If we're in a browser with real Web Bluetooth available:
-    if (typeof navigator !== "undefined" && "bluetooth" in navigator) {
+  protected async getBluetooth(): Promise<Bluetooth> {
+    // If running in a browser with native Web Bluetooth support:
+    if (typeof navigator !== "undefined" && navigator.bluetooth) {
       return navigator.bluetooth
     }
 
-    // Otherwise, we're likely in Node or an environment without `navigator.bluetooth`.
-    // Use a dynamic import for the ESM version:
-    const { bluetooth } = await import("webbluetooth")
-    return bluetooth
-  }
+    const process = await import("node:process")
 
-  /**
-   * Retrieves the characteristic from the device's service.
-   * @param {string} serviceId - The UUID of the service.
-   * @param {string} characteristicId - The UUID of the characteristic.
-   * @returns {BluetoothRemoteGATTCharacteristic | undefined} The characteristic, if found.
-   * @protected
-   *
-   * @example
-   * const characteristic = device.getCharacteristic('battery', 'level');
-   * if (characteristic) {
-   *   console.log('Characteristic found');
-   * }
-   */
-  protected getCharacteristic = (
-    serviceId: string,
-    characteristicId: string,
-  ): BluetoothRemoteGATTCharacteristic | undefined => {
-    // Find the service with the specified serviceId
-    const boardService = this.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
-      }
+    // If running in Node, Bun, or Deno environment
+    if (typeof process !== "undefined" && process.versions?.node) {
+      const { bluetooth } = await import("webbluetooth")
+      return bluetooth
     }
-    // Return undefined if the service or characteristic is not found
-    return undefined
+
+    // If none of the above conditions are met, throw an error.
+    throw new Error("Bluetooth not available.")
   }
 
   /**
@@ -573,7 +544,7 @@ export abstract class Device extends BaseModel implements IDevice {
    */
   isConnected = (): boolean => {
     // Check if the device is defined and available
-    if (!this?.bluetooth) {
+    if (!this.bluetooth) {
       return false
     }
     // Check if the device is connected
@@ -612,7 +583,7 @@ export abstract class Device extends BaseModel implements IDevice {
       throw new Error("GATT server is not available")
     }
     // Connect to GATT server and set up characteristics
-    const services: BluetoothRemoteGATTService[] | undefined = await this.server.getPrimaryServices()
+    const services: BluetoothRemoteGATTService[] = await this.server.getPrimaryServices()
 
     if (!services || services.length === 0) {
       throw new Error("No services found")
@@ -622,7 +593,7 @@ export abstract class Device extends BaseModel implements IDevice {
       const matchingService = this.services.find((boardService) => boardService.uuid === service.uuid)
 
       if (matchingService) {
-        // Android bug: Introduce a delay before getting characteristics
+        // Android bug: Add a small delay before getting characteristics
         await new Promise((resolve) => setTimeout(resolve, 100))
 
         const characteristics = await service.getCharacteristics()
@@ -631,21 +602,28 @@ export abstract class Device extends BaseModel implements IDevice {
           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
-
-              // TODO: remove device-specific logic
-              if (element.id === "rx") {
+            // Find the corresponding characteristic descriptor in the service's characteristics array
+            const descriptor = matchingService.characteristics.find((char) => char.uuid === matchingCharacteristic.uuid)
+            if (descriptor) {
+              // Assign the actual Bluetooth characteristic object to the descriptor so it can be used later
+              descriptor.characteristic = matchingCharacteristic
+              // Look for the "rx" characteristic id that accepts notifications
+              if (descriptor.id === "rx") {
+                // Start receiving notifications for changes on this characteristic
                 matchingCharacteristic.startNotifications()
+                // Triggered when the characteristic's value changes
                 const listener = (event: Event) => {
+                  // Cast the event's target to a BluetoothRemoteGATTCharacteristic to access its properties
                   const target = event.target as BluetoothRemoteGATTCharacteristic
                   if (target && target.value) {
+                    // Delegate the data to handleNotifications method
                     this.handleNotifications(target)
                   }
                 }
+                // Attach the event listener to listen for changes in the characteristic's value
                 matchingCharacteristic.addEventListener("characteristicvaluechanged", listener)
-                this.notificationListeners.set(element.uuid, listener)
+                // Store the listener so it can be referenced (for later removal)
+                this.notificationListeners.set(descriptor.uuid, listener)
               }
             }
           } else {
@@ -654,7 +632,6 @@ export abstract class Device extends BaseModel implements IDevice {
         }
       }
     }
-
     // Call the onSuccess callback after successful connection and setup
     onSuccess()
   }
@@ -689,7 +666,10 @@ export abstract class Device extends BaseModel implements IDevice {
       return undefined
     }
     // Get the characteristic from the service
-    const characteristic = this.getCharacteristic(serviceId, characteristicId)
+    const characteristic = this.services
+      .find((service) => service.id === serviceId)
+      ?.characteristics.find((char) => char.id === characteristicId)?.characteristic
+
     if (!characteristic) {
       throw new Error(`Characteristic "${characteristicId}" not found in service "${serviceId}"`)
     }
@@ -815,7 +795,10 @@ export abstract class Device extends BaseModel implements IDevice {
       return Promise.resolve()
     }
     // Get the characteristic from the service
-    const characteristic = this.getCharacteristic(serviceId, characteristicId)
+    const characteristic = this.services
+      .find((service) => service.id === serviceId)
+      ?.characteristics.find((char) => char.id === characteristicId)?.characteristic
+
     if (!characteristic) {
       throw new Error(`Characteristic "${characteristicId}" not found in service "${serviceId}"`)
     }

package/src/models/index.ts

@@ -1,15 +1,15 @@
-export { Climbro } from "./device/climbro.model.js"
+export { Climbro } from "./device/climbro.model"
 
-export { Entralpi } from "./device/entralpi.model.js"
+export { Entralpi } from "./device/entralpi.model"
 
-export { ForceBoard } from "./device/forceboard.model.js"
+export { ForceBoard } from "./device/forceboard.model"
 
-export { KilterBoard } from "./device/kilterboard.model.js"
+export { KilterBoard } from "./device/kilterboard.model"
 
-export { Motherboard } from "./device/motherboard.model.js"
+export { Motherboard } from "./device/motherboard.model"
 
-export { mySmartBoard } from "./device/mysmartboard.model.js"
+export { mySmartBoard } from "./device/mysmartboard.model"
 
-export { Progressor } from "./device/progressor.model.js"
+export { Progressor } from "./device/progressor.model"
 
-export { WHC06 } from "./device/wh-c06.model.js"
+export { WHC06 } from "./device/wh-c06.model"