@hangtime/grip-connect 0.5.1 → 0.5.3

package/src/interfaces/command.interface.ts

@@ -0,0 +1,106 @@
+/**
+ * Represents the available commands for various devices such as the Motherboard and Tindeq Progressor.
+ */
+export interface Commands {
+  // Motherboard, Progressor
+
+  /**
+   * Starts a weight measurement on the device.
+   * Used to begin collecting weight or force data.
+   */
+  START_WEIGHT_MEAS?: string
+
+  /**
+   * Stops the current weight measurement on the device.
+   * Used to end the data collection.
+   */
+  STOP_WEIGHT_MEAS?: string
+
+  /**
+   * Puts the device to sleep or in a low-power mode.
+   * The format can be a string or a number depending on the device.
+   */
+  SLEEP?: number | string
+
+  /**
+   * Retrieves the serial number of the device.
+   * This command fetches the unique identifier assigned by the manufacturer.
+   */
+  GET_SERIAL?: string
+
+  // Griptonite Motherboard
+
+  /**
+   * Retrieves textual information from the device.
+   * May include readable data.
+   */
+  GET_TEXT?: string
+
+  /**
+   * Starts or stops a debug data stream from the device.
+   * Used for diagnostic purposes or to monitor real-time data.
+   */
+  DEBUG_STREAM?: string
+
+  /**
+   * Retrieves calibration data from the device.
+   * Used to ensure accurate measurements by applying calibration points.
+   */
+  GET_CALIBRATION?: string
+
+  // Tindeq Progressor
+
+  /**
+   * Tares the scale, zeroing the current weight measurement.
+   * Used to reset the baseline for weight data.
+   */
+  TARE_SCALE?: string
+
+  /**
+   * Starts measuring the peak rate of force development (RFD).
+   * Captures how quickly force is applied over time.
+   */
+  START_PEAK_RFD_MEAS?: string
+
+  /**
+   * Starts measuring a series of peak RFD measurements.
+   * This captures multiple RFD data points over a period of time.
+   */
+  START_PEAK_RFD_MEAS_SERIES?: string
+
+  /**
+   * Adds a calibration point to the device.
+   * Used to improve the accuracy of future measurements.
+   */
+  ADD_CALIB_POINT?: string
+
+  /**
+   * Saves the current calibration settings to the device.
+   * Ensures the device remembers the calibration for future sessions.
+   */
+  SAVE_CALIB?: string
+
+  /**
+   * Retrieves the firmware version of the device.
+   * Useful for ensuring compatibility and tracking updates.
+   */
+  GET_FW_VERSION?: string
+
+  /**
+   * Retrieves error information from the device.
+   * Provides details on any faults or issues that occurred during operation.
+   */
+  GET_ERR_INFO?: string
+
+  /**
+   * Clears the error information on the device.
+   * Used to reset error logs after troubleshooting or repair.
+   */
+  CLR_ERR_INFO?: string
+
+  /**
+   * Retrieves the battery voltage level of the device.
+   * Provides insight into the device's remaining battery power.
+   */
+  GET_BATT_VLTG?: string
+}

package/src/interfaces/device.interface.ts

@@ -1,7 +1,7 @@
 import type { IBase } from "./base.interface"
-import type { massObject } from "../types/notify"
+import type { massObject } from "./callback.interface"
+import type { Commands } from "./command.interface"
 
-type NotifyCallback = (data: massObject) => void
 /**
  * Represents a characteristic of a Bluetooth service.
  */
@@ -34,13 +34,30 @@ export interface Service {
  * Represents a Bluetooth device.
  */
 export interface IDevice extends IBase {
-  /** Filters to indentify the device */
+  /**
+   * Filters to identify the device during Bluetooth scanning.
+   * Used to match devices that meet specific criteria such as name, service UUIDs, etc.
+   */
   filters: BluetoothLEScanFilter[]
-  /** Array of services provided by the device */
+
+  /**
+   * Array of services provided by the device.
+   * Services represent functionalities that the device supports, such as weight measurement, battery information, or custom services.
+   */
   services: Service[]
-  /** Reference to the BluetoothDevice object representing this device */
+
+  /**
+   * Reference to the `BluetoothDevice` object representing this device.
+   * This is the actual device object obtained from the Web Bluetooth API after a successful connection.
+   */
   bluetooth?: BluetoothDevice
 
+  /**
+   * Object representing the set of commands available for this device.
+   * These commands allow communication with the device to perform various operations such as starting measurements, retrieving data, or calibrating the device.
+   */
+  commands: Commands
+
   /**
    * Connects to a Bluetooth device.
    * @param {Function} [onSuccess] - Optional callback function to execute on successful connection. Default logs success.
@@ -61,6 +78,14 @@ export interface IDevice extends IBase {
    */
   getAllServiceUUIDs(): string[]
 
+  /**
+   * 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.
+   */
+  getCharacteristic(serviceId: string, characteristicId: string): BluetoothRemoteGATTCharacteristic | undefined
+
   /**
    * Handles notifications received from a characteristic.
    * @param {Event} event - The notification event.
@@ -78,14 +103,7 @@ export interface IDevice extends IBase {
    * @param {NotifyCallback} callback - The callback function to be set.
    * @returns {void}
    */
-  notify(callback: NotifyCallback): void
-
-  /**
-   * Defines the type for the callback function.
-   * @callback NotifyCallback
-   * @param {massObject} data - The data passed to the callback.
-   */
-  notifyCallback: NotifyCallback
+  notify(callback: (data: massObject) => void): void
 
   /**
    * Handles the 'connected' event.
@@ -98,4 +116,39 @@ export interface IDevice extends IBase {
    * @param {Event} event - The 'disconnected' event.
    */
   onDisconnected(event: Event): void
+
+  /**
+   * Reads the value of the specified characteristic from the device.
+   * @param {string} serviceId - The service ID where the characteristic belongs.
+   * @param {string} characteristicId - The characteristic ID to read from.
+   * @param {number} [duration=0] - The duration to wait before resolving the promise, in milliseconds.
+   * @returns {Promise<string>} A promise that resolves when the read operation is completed.
+   */
+  read(serviceId: string, characteristicId: string, duration?: number): Promise<string>
+
+  /**
+   * Writes a message to the specified characteristic of a Bluetooth device and optionally provides a callback to handle responses.
+   * @param {string} serviceId - The service UUID of the Bluetooth device containing the target characteristic.
+   * @param {string} characteristicId - The characteristic UUID where the message will be written.
+   * @param {string | Uint8Array | undefined} message - The message to be written to the characteristic. It can be a string or a Uint8Array.
+   * @param {number} [duration=0] - Optional. The time in milliseconds to wait before resolving the promise. Defaults to 0 for immediate resolution.
+   * @param {WriteCallback} [callback=writeCallback] - Optional. A custom callback to handle the response after the write operation is successful.
+   *
+   * @returns {Promise<void>} A promise that resolves once the write operation is complete.
+   *
+   * @throws {Error} Throws an error if the characteristic is undefined.
+   *
+   * @example
+   * // Example usage of the write function with a custom callback
+   * await Progressor.write("progressor", "tx", ProgressorCommands.GET_BATT_VLTG, 250, (data) => {
+   *   console.log(`Battery voltage: ${data}`);
+   * });
+   */
+  write(
+    serviceId: string,
+    characteristicId: string,
+    message: string | Uint8Array | undefined,
+    duration?: number,
+    callback?: (data: string) => void,
+  ): Promise<void>
 }

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

@@ -1,14 +1,7 @@
 import { Device } from "../device.model"
 import type { IEntralpi } from "../../interfaces/device/entralpi.interface"
-import { applyTare } from "../../tare"
-import { checkActivity } from "../../is-active"
-import { read } from "../../read"
-
-// Constants
-let MASS_MAX = "0"
-let MASS_AVERAGE = "0"
-let MASS_TOTAL_SUM = 0
-let DATAPOINT_COUNT = 0
+import { applyTare } from "../../helpers/tare"
+import { checkActivity } from "../../helpers/is-active"
 
 export class Entralpi extends Device implements IEntralpi {
   constructor() {
@@ -139,7 +132,7 @@ export class Entralpi extends Device implements IEntralpi {
    */
   battery = async (): Promise<string | undefined> => {
     if (this.isConnected()) {
-      return await read(this, "battery", "level", 250)
+      return await this.read("battery", "level", 250)
     }
     // If device is not found, return undefined
     return undefined
@@ -153,7 +146,7 @@ export class Entralpi extends Device implements IEntralpi {
     // Check if the device is connected
     if (this.isConnected()) {
       // Read certification from the device
-      return await read(this, "device", "certification", 250)
+      return await this.read("device", "certification", 250)
     }
     // If device is not found, return undefined
     return undefined
@@ -167,7 +160,7 @@ export class Entralpi extends Device implements IEntralpi {
     // Check if the device is connected
     if (this.isConnected()) {
       // Read firmware version from the Motherboard
-      return await read(this, "device", "firmware", 250)
+      return await this.read("device", "firmware", 250)
     }
     // If device is not found, return undefined
     return undefined
@@ -195,24 +188,24 @@ export class Entralpi extends Device implements IEntralpi {
         // 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),
         })
       }
@@ -227,7 +220,7 @@ export class Entralpi extends Device implements IEntralpi {
     // Check if the device is connected
     if (this.isConnected()) {
       // Read hardware version from the device
-      return await read(this, "device", "hardware", 250)
+      return await this.read("device", "hardware", 250)
     }
     // If device is not found, return undefined
     return undefined
@@ -241,7 +234,7 @@ export class Entralpi extends Device implements IEntralpi {
     // Check if the device is connected
     if (this.isConnected()) {
       // Read manufacturer information from the device
-      return await read(this, "device", "manufacturer", 250)
+      return await this.read("device", "manufacturer", 250)
     }
     // If device is not found, return undefined
     return undefined
@@ -255,7 +248,7 @@ export class Entralpi extends Device implements IEntralpi {
     // Check if the device is connected
     if (this.isConnected()) {
       // Read model number from the Entralpi
-      return await read(this, "device", "model", 250)
+      return await this.read("device", "model", 250)
     }
     // If device is not found, return undefined
     return undefined
@@ -270,7 +263,7 @@ export class Entralpi extends Device implements IEntralpi {
     // Check if the device is connected
     if (this.isConnected()) {
       // Read software version from the Entralpi
-      return await read(this, "device", "pnp", 250)
+      return await this.read("device", "pnp", 250)
     }
     // If device is not found, return undefined
     return undefined
@@ -284,7 +277,7 @@ export class Entralpi extends Device implements IEntralpi {
     // Check if the device is connected
     if (this.isConnected()) {
       // Read software version from the Entralpi
-      return await read(this, "device", "software", 250)
+      return await this.read("device", "software", 250)
     }
     // If device is not found, return undefined
     return undefined
@@ -298,7 +291,7 @@ export class Entralpi extends Device implements IEntralpi {
     // Check if the device is connected
     if (this.isConnected()) {
       // Read system id from the device
-      return await read(this, "device", "system", 250)
+      return await this.read("device", "system", 250)
     }
     // If device is not found, return undefined
     return undefined

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

@@ -1,6 +1,5 @@
 import { Device } from "../device.model"
 import type { IForceBoard } from "../../interfaces/device/forceboard.interface"
-import { read } from "../../read"
 
 /**
  * Represents a PitchSix Force Board device
@@ -81,19 +80,19 @@ export class ForceBoard extends Device implements IForceBoard {
           ],
         },
         {
-          name: "",
-          id: "",
+          name: "Temperature Serivce",
+          id: "temperature",
           uuid: "3a90328c-c266-4c76-b05a-6af6104a0b13",
           characteristics: [
             {
               name: "Read",
-              id: "",
+              id: "level",
               uuid: "3a90328d-c266-4c76-b05a-6af6104a0b13",
             },
           ],
         },
         {
-          name: "",
+          name: "Forceboard Service",
           id: "forceboard",
           uuid: "9a88d67f-8df2-4afe-9e0d-c2bbbe773dd0",
           characteristics: [
@@ -171,7 +170,7 @@ export class ForceBoard extends Device implements IForceBoard {
    */
   battery = async (): Promise<string | undefined> => {
     if (this.isConnected()) {
-      return await read(this, "battery", "level", 250)
+      return await this.read("battery", "level", 250)
     }
     // If device is not found, return undefined
     return undefined
@@ -184,7 +183,7 @@ export class ForceBoard extends Device implements IForceBoard {
   humidity = async (): Promise<string | undefined> => {
     // Check if the device is connected
     if (this.isConnected()) {
-      return await read(this, "humidity", "level", 250)
+      return await this.read("humidity", "level", 250)
     }
     // If device is not found, return undefined
     return undefined
@@ -198,7 +197,7 @@ export class ForceBoard extends Device implements IForceBoard {
     // Check if the device is connected
     if (this.isConnected()) {
       // Read manufacturer information from the device
-      return await read(this, "device", "manufacturer", 250)
+      return await this.read("device", "manufacturer", 250)
     }
     // If device is not found, return undefined
     return undefined

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

@@ -1,22 +1,74 @@
 import { Device } from "../device.model"
 import type { IKilterBoard } from "../../interfaces/device/kilterboard.interface"
-import { KilterBoardPacket, KilterBoardPlacementRoles } from "../../commands/kilterboard"
-import { write } from "../../write"
 
 /**
- * Aurora Climbing Advertising service
+ * For API level 2 and API level 3.
+ * The first byte in the data is dependent on where the packet is in the message as a whole.
+ * More details: https://github.com/1-max-1/fake_kilter_board
  */
-export const AuroraUUID = "4488b571-7806-4df6-bcff-a2897e4953ff"
-
+export enum KilterBoardPacket {
+  /** If this packet is in the middle, the byte gets set to 77 (M). */
+  V2_MIDDLE = 77,
+  /** If this packet is the first packet in the message, then this byte gets set to 78 (N). */
+  V2_FIRST,
+  /** If this is the last packet in the message, this byte gets set to 79 (0). */
+  V2_LAST,
+  /** If this packet is the only packet in the message, the byte gets set to 80 (P). Note that this takes priority over the other conditions. */
+  V2_ONLY,
+  /** If this packet is in the middle, the byte gets set to 81 (Q). */
+  V3_MIDDLE,
+  /** If this packet is the first packet in the message, then this byte gets set to 82 (R). */
+  V3_FIRST,
+  /** If this is the last packet in the message, this byte gets set to 83 (S). */
+  V3_LAST,
+  /** If this packet is the only packet in the message, the byte gets set to 84 (T). Note that this takes priority over the other conditions. */
+  V3_ONLY,
+}
 /**
- * Maximum length of the message body for byte wrapping.
+ * Extracted from placement_roles database table.
  */
-const MESSAGE_BODY_MAX_LENGTH = 255
+export const KilterBoardPlacementRoles = [
+  {
+    id: 12,
+    product_id: 1,
+    position: 1,
+    name: "start",
+    full_name: "Start",
+    led_color: "00FF00",
+    screen_color: "00DD00",
+  },
+  {
+    id: 13,
+    product_id: 1,
+    position: 2,
+    name: "middle",
+    full_name: "Middle",
+    led_color: "00FFFF",
+    screen_color: "00FFFF",
+  },
+  {
+    id: 14,
+    product_id: 1,
+    position: 3,
+    name: "finish",
+    full_name: "Finish",
+    led_color: "FF00FF",
+    screen_color: "FF00FF",
+  },
+  {
+    id: 15,
+    product_id: 1,
+    position: 4,
+    name: "foot",
+    full_name: "Foot Only",
+    led_color: "FFB600",
+    screen_color: "FFA500",
+  },
+]
+
 /**
- * Maximum length of the the bluetooth chunk.
+ * Represents climbs_placements from the Kilter Board application
  */
-const MAX_BLUETOOTH_MESSAGE_SIZE = 20
-
 class ClimbPlacement {
   position: number
   role_id: number
@@ -32,11 +84,38 @@ class ClimbPlacement {
  * Kilter Board, Tension Board, Decoy Board, Touchstone Board, Grasshopper Board, Aurora Board, So iLL Board
  */
 export class KilterBoard extends Device implements IKilterBoard {
+  /**
+   * UUID for the Aurora Climbing Advertising service.
+   * This constant is used to identify the specific Bluetooth service for Kilter Boards.
+   *
+   * @type {string}
+   */
+  public static AuroraUUID = "4488b571-7806-4df6-bcff-a2897e4953ff"
+
+  /**
+   * Maximum length of the message body for byte wrapping.
+   * This value defines the limit for the size of messages that can be sent or received
+   * to ensure proper byte wrapping in communication.
+   *
+   * @type {number}
+   * @private
+   */
+  private MESSAGE_BODY_MAX_LENGTH = 255
+  /**
+   * Maximum length of the Bluetooth message chunk.
+   * This value sets the upper limit for the size of individual Bluetooth messages
+   * sent to and from the device to comply with Bluetooth protocol constraints.
+   *
+   * @type {number}
+   * @private
+   */
+  private MAX_BLUETOOTH_MESSAGE_SIZE = 20
+
   constructor() {
     super({
       filters: [
         {
-          services: [AuroraUUID],
+          services: [KilterBoard.AuroraUUID],
         },
       ],
       services: [
@@ -79,7 +158,7 @@ export class KilterBoard extends Device implements IKilterBoard {
    * @returns The wrapped byte array.
    */
   wrapBytes(data: number[]) {
-    if (data.length > MESSAGE_BODY_MAX_LENGTH) {
+    if (data.length > this.MESSAGE_BODY_MAX_LENGTH) {
       return []
     }
     /**
@@ -146,7 +225,7 @@ export class KilterBoard extends Device implements IKilterBoard {
     let tempArray: number[] = [KilterBoardPacket.V3_MIDDLE]
 
     for (const climbPlacement of climbPlacementList) {
-      if (tempArray.length + 3 > MESSAGE_BODY_MAX_LENGTH) {
+      if (tempArray.length + 3 > this.MESSAGE_BODY_MAX_LENGTH) {
         resultArray.push(tempArray)
         tempArray = [KilterBoardPacket.V3_MIDDLE]
       }
@@ -200,13 +279,13 @@ export class KilterBoard extends Device implements IKilterBoard {
    * @param buffer
    */
   splitMessages = (buffer: number[]) =>
-    this.splitEvery(MAX_BLUETOOTH_MESSAGE_SIZE, buffer).map((arr) => new Uint8Array(arr))
+    this.splitEvery(this.MAX_BLUETOOTH_MESSAGE_SIZE, buffer).map((arr) => new Uint8Array(arr))
   /**
    * Sends a series of messages to a device.
    */
   async writeMessageSeries(messages: Uint8Array[]) {
     for (const message of messages) {
-      await write(this, "uart", "tx", message)
+      await this.write("uart", "tx", message)
     }
   }
   /**