@hangtime/grip-connect 0.5.2 → 0.5.4

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

@@ -1,27 +1,42 @@
 import { Device } from "../device.model"
 import type { IMotherboard } from "../../interfaces/device/motherboard.interface"
-import { applyTare } from "../../tare"
-import { MotherboardCommands } from "../../commands"
-import { checkActivity } from "../../is-active"
-import { DownloadPackets, emptyDownloadPackets } from "../../download"
-import type { DownloadPacket } from "../../types/download"
-
-// Constants
-const PACKET_LENGTH = 32
-const NUM_SAMPLES = 3
-let MASS_MAX = "0"
-let MASS_AVERAGE = "0"
-let MASS_TOTAL_SUM = 0
-let DATAPOINT_COUNT = 0
-
-const receiveBuffer: number[] = []
-
-export const CALIBRATION = [[], [], [], []]
+import { applyTare } from "../../helpers/tare"
+import { checkActivity } from "../../helpers/is-active"
+import { DownloadPackets, emptyDownloadPackets } from "../../helpers/download"
+import type { DownloadPacket } from "../../interfaces/download.interface"
 
 /**
  * Represents a Griptonite Motherboard device
  */
 export class Motherboard extends Device implements IMotherboard {
+  /**
+   * Length of the packet received from the device.
+   * @private
+   * @type {number}
+   */
+  private PACKET_LENGTH = 32
+
+  /**
+   * Number of samples contained in the data packet.
+   * @private
+   * @type {number}
+   */
+  private NUM_SAMPLES = 3
+
+  /**
+   * Buffer to store received data from the device.
+   * @private
+   * @type {number[]}
+   */
+  private receiveBuffer: number[] = []
+
+  /**
+   * Calibration data for each sensor of the device.
+   * @private
+   * @type {number[][][]}
+   */
+  private CALIBRATION: number[][][] = [[], [], [], []]
+
   constructor() {
     super({
       filters: [{ name: "Motherboard" }],
@@ -100,6 +115,15 @@ export class Motherboard extends Device implements IMotherboard {
           ],
         },
       ],
+      commands: {
+        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",
+      },
     })
   }
 
@@ -150,11 +174,7 @@ export class Motherboard extends Device implements IMotherboard {
    * @returns {Promise<string | undefined>} A Promise that resolves with the battery or voltage information,
    */
   battery = async (): Promise<string | undefined> => {
-    if (this.isConnected()) {
-      return await this.read("battery", "level", 250)
-    }
-    // If device is not found, return undefined
-    return undefined
+    return await this.read("battery", "level", 250)
   }
 
   /**
@@ -162,13 +182,9 @@ export class Motherboard extends Device implements IMotherboard {
    * @returns {Promise<void>} A Promise that resolves when the command is successfully sent.
    */
   calibration = async (): Promise<void> => {
-    // Check if the device is connected
-    if (this.isConnected()) {
-      // Write the command to get calibration data to the device
-      await this.write("uart", "tx", MotherboardCommands.GET_CALIBRATION, 2500, (data) => {
-        console.log(data)
-      })
-    }
+    await this.write("uart", "tx", this.commands.GET_CALIBRATION, 2500, (data) => {
+      console.log(data)
+    })
   }
 
   /**
@@ -176,13 +192,7 @@ export class Motherboard extends Device implements IMotherboard {
    * @returns {Promise<string>} A Promise that resolves with the firmware version,
    */
   firmware = async (): Promise<string | undefined> => {
-    // Check if the device is connected
-    if (this.isConnected()) {
-      // Read firmware version from the Motherboard
-      return await this.read("device", "firmware", 250)
-    }
-    // If device is not found, return undefined
-    return undefined
+    return await this.read("device", "firmware", 250)
   }
 
   /**
@@ -199,12 +209,12 @@ export class Motherboard extends Device implements IMotherboard {
     if (value) {
       if (value.buffer) {
         for (let i = 0; i < value.byteLength; i++) {
-          receiveBuffer.push(value.getUint8(i))
+          this.receiveBuffer.push(value.getUint8(i))
         }
 
         let idx: number
-        while ((idx = receiveBuffer.indexOf(10)) >= 0) {
-          const line: number[] = receiveBuffer.splice(0, idx + 1).slice(0, -1) // Combine and remove LF
+        while ((idx = this.receiveBuffer.indexOf(10)) >= 0) {
+          const line: number[] = this.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: TextDecoder = new TextDecoder("utf-8")
           const receivedData: string = decoder.decode(new Uint8Array(line))
@@ -215,7 +225,7 @@ export class Motherboard extends Device implements IMotherboard {
           const isAllHex: boolean = /^[0-9A-Fa-f]+$/g.test(receivedData)
 
           // Handle streaming packet
-          if (isAllHex && receivedData.length === PACKET_LENGTH) {
+          if (isAllHex && receivedData.length === this.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)}`),
@@ -232,7 +242,7 @@ export class Motherboard extends Device implements IMotherboard {
 
             const dataView = new DataView(new Uint8Array(bytes).buffer)
 
-            for (let i = 0; i < NUM_SAMPLES; i++) {
+            for (let i = 0; i < this.NUM_SAMPLES; i++) {
               const sampleStart: number = 4 + 3 * i
               // Use DataView to read the 24-bit unsigned integer
               const rawValue =
@@ -246,7 +256,7 @@ export class Motherboard extends Device implements IMotherboard {
               if (packet.samples[i] >= 0x7fffff) {
                 packet.samples[i] -= 0x1000000
               }
-              packet.masses[i] = this.applyCalibration(packet.samples[i], CALIBRATION[i])
+              packet.masses[i] = this.applyCalibration(packet.samples[i], this.CALIBRATION[i])
             }
             // invert center and right values
             packet.masses[1] *= -1
@@ -270,15 +280,15 @@ export class Motherboard extends Device implements IMotherboard {
             center -= applyTare(center)
             right -= applyTare(right)
 
-            MASS_MAX = Math.max(Number(MASS_MAX), Math.max(-1000, left + center + right)).toFixed(1)
+            this.massMax = Math.max(Number(this.massMax), Math.max(-1000, left + center + right)).toFixed(1)
 
             // Update running sum and count
             const currentMassTotal = Math.max(-1000, left + center + right)
-            MASS_TOTAL_SUM += currentMassTotal
-            DATAPOINT_COUNT++
+            this.massTotalSum += currentMassTotal
+            this.dataPointCount++
 
             // Calculate the average dynamically
-            MASS_AVERAGE = (MASS_TOTAL_SUM / DATAPOINT_COUNT).toFixed(1)
+            this.massAverage = (this.massTotalSum / this.dataPointCount).toFixed(1)
 
             // Check if device is being used
             checkActivity(center)
@@ -286,18 +296,18 @@ export class Motherboard extends Device implements IMotherboard {
             // Notify with weight data
             this.notifyCallback({
               massTotal: Math.max(-1000, left + center + right).toFixed(1),
-              massMax: MASS_MAX,
-              massAverage: MASS_AVERAGE,
+              massMax: this.massMax,
+              massAverage: this.massAverage,
               massLeft: Math.max(-1000, packet.masses[0]).toFixed(1),
               massCenter: Math.max(-1000, packet.masses[1]).toFixed(1),
               massRight: Math.max(-1000, packet.masses[2]).toFixed(1),
             })
-          } else if (this.writeLast === MotherboardCommands.GET_CALIBRATION) {
+          } else if (this.writeLast === this.commands.GET_CALIBRATION) {
             // check data integrity
             if ((receivedData.match(/,/g) || []).length === 3) {
               const parts: string[] = receivedData.split(",")
               const numericParts: number[] = parts.map((x) => parseFloat(x))
-              ;(CALIBRATION[numericParts[0]] as number[][]).push(numericParts.slice(1))
+              ;(this.CALIBRATION[numericParts[0]] as number[][]).push(numericParts.slice(1))
             }
           } else {
             // unhandled data
@@ -313,13 +323,7 @@ export class Motherboard extends Device implements IMotherboard {
    * @returns {Promise<string>} A Promise that resolves with the hardware version,
    */
   hardware = async (): Promise<string | undefined> => {
-    // Check if the device is connected
-    if (this.isConnected()) {
-      // Read hardware version from the device
-      return await this.read("device", "hardware", 250)
-    }
-    // If device is not found, return undefined
-    return undefined
+    return await this.read("device", "hardware", 250)
   }
 
   /**
@@ -349,13 +353,7 @@ export class Motherboard extends Device implements IMotherboard {
    * @returns {Promise<string>} A Promise that resolves with the manufacturer information,
    */
   manufacturer = async (): Promise<string | undefined> => {
-    // Check if the device is connected
-    if (this.isConnected()) {
-      // Read manufacturer information from the device
-      return await this.read("device", "manufacturer", 250)
-    }
-    // If device is not found, return undefined
-    return undefined
+    return await this.read("device", "manufacturer", 250)
   }
 
   /**
@@ -363,17 +361,11 @@ export class Motherboard extends Device implements IMotherboard {
    * @returns {Promise<string>} A Promise that resolves with the serial number,
    */
   serial = async (): Promise<string | undefined> => {
-    // Check if the device is connected
-    if (this.isConnected()) {
-      // Write serial number command to the Motherboard and read output
-      let response: string | undefined = undefined
-      await this.write("uart", "tx", MotherboardCommands.GET_SERIAL, 250, (data) => {
-        response = data
-      })
-      return response
-    }
-    // If device is not found, return undefined
-    return undefined
+    let response: string | undefined = undefined
+    await this.write("uart", "tx", this.commands.GET_SERIAL, 250, (data) => {
+      response = data
+    })
+    return response
   }
 
   /**
@@ -381,10 +373,7 @@ export class Motherboard extends Device implements IMotherboard {
    * @returns {Promise<void>} A promise that resolves when the stream is stopped.
    */
   stop = async (): Promise<void> => {
-    if (this.isConnected()) {
-      // Stop stream of device
-      await this.write("uart", "tx", MotherboardCommands.STOP_WEIGHT_MEAS, 0)
-    }
+    await this.write("uart", "tx", this.commands.STOP_WEIGHT_MEAS, 0)
   }
 
   /**
@@ -393,21 +382,17 @@ export class Motherboard extends Device implements IMotherboard {
    * @returns {Promise<void>} A promise that resolves when the streaming operation is completed.
    */
   stream = async (duration = 0): Promise<void> => {
-    if (this.isConnected()) {
-      // Reset download packets
-      emptyDownloadPackets()
-      // Device specific logic
-
-      // Read calibration data if not already available
-      if (!CALIBRATION[0].length) {
-        await this.calibration()
-      }
-      // Start streaming data
-      await this.write("uart", "tx", MotherboardCommands.START_WEIGHT_MEAS, duration)
-      // Stop streaming if duration is set
-      if (duration !== 0) {
-        await this.stop()
-      }
+    // Reset download packets
+    emptyDownloadPackets()
+    // Read calibration data if not already available
+    if (!this.CALIBRATION[0].length) {
+      await this.calibration()
+    }
+    // Start streaming data
+    await this.write("uart", "tx", this.commands.START_WEIGHT_MEAS, duration)
+    // Stop streaming if duration is set
+    if (duration !== 0) {
+      await this.stop()
     }
   }
 
@@ -421,16 +406,10 @@ export class Motherboard extends Device implements IMotherboard {
    * @returns {Promise<string>} A Promise that resolves with the 320-byte memory content as a string,
    */
   text = async (): Promise<string | undefined> => {
-    // Check if the device is connected
-    if (this.isConnected()) {
-      // Write text information command to the Motherboard and read output
-      let response: string | undefined = undefined
-      await this.write("uart", "tx", MotherboardCommands.GET_TEXT, 250, (data) => {
-        response = data
-      })
-      return response
-    }
-    // If device is not found, return undefined
-    return undefined
+    let response: string | undefined = undefined
+    await this.write("uart", "tx", this.commands.GET_TEXT, 250, (data) => {
+      response = data
+    })
+    return response
   }
 }

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

@@ -1,16 +1,44 @@
 import { Device } from "../device.model"
 import type { IProgressor } from "../../interfaces/device/progressor.interface"
-import { ProgressorCommands, ProgressorResponses } from "../../commands/progressor"
 import struct from "../../helpers/struct"
-import { checkActivity } from "../../is-active"
-import { DownloadPackets, emptyDownloadPackets } from "../../download"
-import { applyTare } from "../../tare"
+import { checkActivity } from "../../helpers/is-active"
+import { DownloadPackets, emptyDownloadPackets } from "../../helpers/download"
+import { applyTare } from "../../helpers/tare"
 
-// Constants
-let MASS_MAX = "0"
-let MASS_AVERAGE = "0"
-let MASS_TOTAL_SUM = 0
-let DATAPOINT_COUNT = 0
+/**
+ * Represents the possible responses of a Tindeq Progressor device.
+ */
+enum ProgressorResponses {
+  /**
+   * Response received after sending a command to the device.
+   * This could include acknowledgment or specific data related to the command sent.
+   */
+  COMMAND_RESPONSE,
+
+  /**
+   * Data representing a weight measurement from the device.
+   * Typically used for tracking load or force applied.
+   */
+  WEIGHT_MEASURE,
+
+  /**
+   * Peak rate of force development (RFD) measurement.
+   * This measures how quickly the force is applied over time.
+   */
+  PEAK_RFD_MEAS,
+
+  /**
+   * Series of peak rate of force development (RFD) measurements.
+   * This could be used for analyzing force trends over multiple data points.
+   */
+  PEAK_RFD_MEAS_SERIES,
+
+  /**
+   * Low battery warning from the device.
+   * Indicates that the battery level is below a critical threshold.
+   */
+  LOW_BATTERY_WARNING,
+}
 
 /**
  * Represents a Tindeq Progressor device
@@ -50,6 +78,20 @@ export class Progressor extends Device implements IProgressor {
           ],
         },
       ],
+      commands: {
+        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
+      },
     })
   }
 
@@ -58,15 +100,11 @@ export class Progressor extends Device implements IProgressor {
    * @returns {Promise<string | undefined>} A Promise that resolves with the battery or voltage information,
    */
   battery = async (): Promise<string | undefined> => {
-    if (this.isConnected()) {
-      let response: string | undefined = undefined
-      await this.write("progressor", "tx", ProgressorCommands.GET_BATT_VLTG, 250, (data) => {
-        response = data
-      })
-      return response
-    }
-    // If device is not found, return undefined
-    return undefined
+    let response: string | undefined = undefined
+    await this.write("progressor", "tx", this.commands.GET_BATT_VLTG, 250, (data) => {
+      response = data
+    })
+    return response
   }
 
   /**
@@ -74,21 +112,15 @@ export class Progressor extends Device implements IProgressor {
    * @returns {Promise<string>} A Promise that resolves with the firmware version,
    */
   firmware = async (): Promise<string | undefined> => {
-    // Check if the device is connected
-    if (this.isConnected()) {
-      // Read firmware version from the device
-      let response: string | undefined = undefined
-      await this.write("progressor", "tx", ProgressorCommands.GET_FW_VERSION, 250, (data) => {
-        response = data
-      })
-      return response
-    }
-    // If device is not found, return undefined
-    return undefined
+    let response: string | undefined = undefined
+    await this.write("progressor", "tx", this.commands.GET_FW_VERSION, 250, (data) => {
+      response = data
+    })
+    return response
   }
 
   /**
-   * Handles data received from the Progressor device, processes weight measurements,
+   * Handles data received from the device, processes weight measurements,
    * and updates mass data including maximum and average values.
    * It also handles command responses for retrieving device information.
    *
@@ -120,21 +152,21 @@ export class Progressor extends Device implements IProgressor {
               // Tare correction
               weight -= applyTare(weight)
               // Check for max weight
-              MASS_MAX = Math.max(Number(MASS_MAX), Number(weight)).toFixed(1)
+              this.massMax = Math.max(Number(this.massMax), Number(weight)).toFixed(1)
               // Update running sum and count
               const currentMassTotal = Math.max(-1000, Number(weight))
-              MASS_TOTAL_SUM += currentMassTotal
-              DATAPOINT_COUNT++
+              this.massTotalSum += currentMassTotal
+              this.dataPointCount++
 
               // Calculate the average dynamically
-              MASS_AVERAGE = (MASS_TOTAL_SUM / DATAPOINT_COUNT).toFixed(1)
+              this.massAverage = (this.massTotalSum / this.dataPointCount).toFixed(1)
 
               // Check if device is being used
               checkActivity(weight)
 
               this.notifyCallback({
-                massMax: MASS_MAX,
-                massAverage: MASS_AVERAGE,
+                massMax: this.massMax,
+                massAverage: this.massAverage,
                 massTotal: Math.max(-1000, weight).toFixed(1),
               })
             }
@@ -144,11 +176,11 @@ export class Progressor extends Device implements IProgressor {
 
           let value = ""
 
-          if (this.writeLast === ProgressorCommands.GET_BATT_VLTG) {
+          if (this.writeLast === this.commands.GET_BATT_VLTG) {
             value = new DataView(data.buffer, 2).getUint32(0, true).toString()
-          } else if (this.writeLast === ProgressorCommands.GET_FW_VERSION) {
+          } else if (this.writeLast === this.commands.GET_FW_VERSION) {
             value = new TextDecoder().decode(data.buffer.slice(2))
-          } else if (this.writeLast === ProgressorCommands.GET_ERR_INFO) {
+          } else if (this.writeLast === this.commands.GET_ERR_INFO) {
             value = new TextDecoder().decode(data.buffer.slice(2))
           }
           this.writeCallback(value)
@@ -166,10 +198,7 @@ export class Progressor extends Device implements IProgressor {
    * @returns {Promise<void>} A promise that resolves when the stream is stopped.
    */
   stop = async (): Promise<void> => {
-    if (this.isConnected()) {
-      // Stop stream of device
-      await this.write("progressor", "tx", ProgressorCommands.STOP_WEIGHT_MEAS, 0)
-    }
+    await this.write("progressor", "tx", this.commands.STOP_WEIGHT_MEAS, 0)
   }
 
   /**
@@ -178,15 +207,13 @@ export class Progressor extends Device implements IProgressor {
    * @returns {Promise<void>} A promise that resolves when the streaming operation is completed.
    */
   stream = async (duration = 0): Promise<void> => {
-    if (this.isConnected()) {
-      // Reset download packets
-      emptyDownloadPackets()
-      // Start streaming data
-      await this.write("progressor", "tx", ProgressorCommands.START_WEIGHT_MEAS, duration)
-      // Stop streaming if duration is set
-      if (duration !== 0) {
-        await this.stop()
-      }
+    // Reset download packets
+    emptyDownloadPackets()
+    // Start streaming data
+    await this.write("progressor", "tx", this.commands.START_WEIGHT_MEAS, duration)
+    // Stop streaming if duration is set
+    if (duration !== 0) {
+      await this.stop()
     }
   }
 }

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

@@ -1,21 +1,23 @@
 import { Device } from "../device.model"
-import { applyTare } from "../../tare"
-import { checkActivity } from "../../is-active"
+import { applyTare } from "../../helpers/tare"
+import { checkActivity } from "../../helpers/is-active"
 import type { IWHC06 } from "../../interfaces/device/wh-c06.interface"
 
-// Constants
-let MASS_MAX = "0"
-let MASS_AVERAGE = "0"
-let MASS_TOTAL_SUM = 0
-let DATAPOINT_COUNT = 0
-const WEIGHT_OFFSET = 10
-// const STABLE_OFFSET = 14
-
 /**
  * Represents a  Weiheng - WH-C06 (or MAT Muscle Meter) device
  * Enable 'Experimental Web Platform features' Chrome Flags.
  */
 export class WHC06 extends Device implements IWHC06 {
+  /**
+   * Offset for the byte location in the manufacturer data to extract the weight.
+   * This value is constant across all instances of the class.
+   * @type {number}
+   * @constant
+   */
+  private static readonly WEIGHT_OFFSET = 10
+
+  // private static readonly  STABLE_OFFSET = 14
+
   constructor() {
     super({
       filters: [
@@ -66,7 +68,7 @@ export class WHC06 extends Device implements IWHC06 {
         const data = event.manufacturerData.get(MANUFACTURER_ID)
         if (data) {
           // Handle recieved data
-          const weight = (data.getUint8(WEIGHT_OFFSET) << 8) | data.getUint8(WEIGHT_OFFSET + 1)
+          const weight = (data.getUint8(WHC06.WEIGHT_OFFSET) << 8) | data.getUint8(WHC06.WEIGHT_OFFSET + 1)
           // const stable = (data.getUint8(STABLE_OFFSET) & 0xf0) >> 4
           // const unit = data.getUint8(STABLE_OFFSET) & 0x0f
 
@@ -75,24 +77,24 @@ export class WHC06 extends Device implements IWHC06 {
           // Tare correction
           numericData -= applyTare(numericData)
 
-          // Update MASS_MAX
-          MASS_MAX = Math.max(Number(MASS_MAX), numericData).toFixed(1)
+          // Update massMax
+          this.massMax = Math.max(Number(this.massMax), numericData).toFixed(1)
 
           // Update running sum and count
           const currentMassTotal = Math.max(-1000, numericData)
-          MASS_TOTAL_SUM += currentMassTotal
-          DATAPOINT_COUNT++
+          this.massTotalSum += currentMassTotal
+          this.dataPointCount++
 
           // Calculate the average dynamically
-          MASS_AVERAGE = (MASS_TOTAL_SUM / DATAPOINT_COUNT).toFixed(1)
+          this.massAverage = (this.massTotalSum / this.dataPointCount).toFixed(1)
 
           // Check if device is being used
           checkActivity(numericData)
 
           // Notify with weight data
           this.notifyCallback({
-            massMax: MASS_MAX,
-            massAverage: MASS_AVERAGE,
+            massMax: this.massMax,
+            massAverage: this.massAverage,
             massTotal: Math.max(-1000, numericData).toFixed(1),
           })
         }