@hangtime/grip-connect 0.5.0 → 0.5.1

package/src/interfaces/device/forceboard.interface.ts

@@ -1,4 +1,24 @@
 import type { IDevice } from "../device.interface"
 
-// eslint-disable-next-line @typescript-eslint/no-empty-object-type
-export interface IForceBoard extends IDevice {}
+/**
+ * Interface representing the PitchSix ForceBoard device, extending the base Device interface.
+ */
+export interface IForceBoard extends IDevice {
+  /**
+   * Retrieves battery or voltage information from the device.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the battery or voltage information.
+   */
+  battery(): Promise<string | undefined>
+
+  /**
+   * Retrieves humidity level from the device.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the humidity level.
+   */
+  humidity(): Promise<string | undefined>
+
+  /**
+   * Retrieves manufacturer information from the device.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the manufacturer information.
+   */
+  manufacturer(): Promise<string | undefined>
+}

package/src/interfaces/device/kilterboard.interface.ts

@@ -1,4 +1,85 @@
 import type { IDevice } from "../device.interface"
+/**
+ * Represents a climbing placement with a position and role identifier.
+ */
+export interface ClimbPlacement {
+  /** The position of the hold placement. */
+  position: number
+  /** The role ID associated with the climb placement. */
+  role_id: number
+}
+/**
+ * Interface representing the KilterBoard device, extending the base Device interface.
+ */
+export interface IKilterBoard extends IDevice {
+  /**
+   * Calculates the checksum for a byte array.
+   * @param data - The array of bytes to calculate the checksum for.
+   * @returns The calculated checksum value.
+   */
+  checksum(data: number[]): number
 
-// eslint-disable-next-line @typescript-eslint/no-empty-object-type
-export interface IKilterBoard extends IDevice {}
+  /**
+   * Wraps a byte array with header and footer bytes for transmission.
+   * @param data - The array of bytes to wrap.
+   * @returns The wrapped byte array.
+   */
+  wrapBytes(data: number[]): number[]
+
+  /**
+   * Encodes a position into a byte array.
+   * @param position - The position to encode.
+   * @returns The encoded byte array representing the position.
+   */
+  encodePosition(position: number): number[]
+
+  /**
+   * Encodes a color string into a numeric representation.
+   * @param color - The color string in hexadecimal format.
+   * @returns The encoded/compressed color value.
+   */
+  encodeColor(color: string): number
+
+  /**
+   * Encodes a placement into a byte array.
+   * @param position - The position to encode.
+   * @param ledColor - The color of the LED in hexadecimal format.
+   * @returns The encoded byte array representing the placement.
+   */
+  encodePlacement(position: number, ledColor: string): number[]
+
+  /**
+   * Prepares byte arrays for transmission based on a list of climb placements.
+   * @param climbPlacementList - The list of climb placements.
+   * @returns The final byte array ready for transmission.
+   */
+  prepBytesV3(climbPlacementList: ClimbPlacement[]): number[]
+
+  /**
+   * Splits a collection into slices of the specified length.
+   * @param n - Number of elements per slice.
+   * @param list - Array to be sliced.
+   * @returns The sliced array.
+   */
+  splitEvery(n: number, list: number[]): number[][]
+
+  /**
+   * Splits a message into 20-byte chunks for Bluetooth transmission.
+   * @param buffer - The message to split.
+   * @returns The array of Uint8Arrays.
+   */
+  splitMessages(buffer: number[]): Uint8Array[]
+
+  /**
+   * Sends a series of messages to the device.
+   * @param messages - Array of Uint8Arrays to send.
+   */
+  writeMessageSeries(messages: Uint8Array[]): Promise<void>
+
+  /**
+   * Configures the LEDs based on an array of climb placements.
+   * @param config - Optional color or array of climb placements.
+   * @returns The prepared payload or undefined.
+   */
+  led(config?: ClimbPlacement[]): Promise<number[] | undefined>
+}

package/src/interfaces/device/motherboard.interface.ts

@@ -1,11 +1,70 @@
 import type { IDevice } from "../device.interface"
 
+/**
+ * Interface representing the Griptonite Motherboard device.
+ */
 export interface IMotherboard extends IDevice {
   /**
    * Applies calibration to a sample value.
-   * @param sample - The sample value to calibrate.
-   * @param calibration - The calibration data.
-   * @returns The calibrated sample value.
+   * @param {number} sample - The sample value to calibrate.
+   * @param {number[][]} calibration - The calibration data.
+   * @returns {number} The calibrated sample value.
    */
   applyCalibration(sample: number, calibration: number[][]): number
+
+  /**
+   * Retrieves battery or voltage information from the device.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the battery or voltage information.
+   */
+  battery(): Promise<string | undefined>
+
+  /**
+   * Writes a command to get calibration data from the device.
+   * @returns {Promise<void>} A Promise that resolves when the command is successfully sent.
+   */
+  calibration(): Promise<void>
+
+  /**
+   * Retrieves firmware version from the device.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the firmware version.
+   */
+  firmware(): Promise<string | undefined>
+
+  /**
+   * Retrieves hardware version from the device.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the hardware version.
+   */
+  hardware(): Promise<string | undefined>
+
+  /**
+   * Sets the LED color based on a single color option.
+   * @param {"green" | "red" | "orange"} [config] - Optional color for the LEDs.
+   * @returns {Promise<number[] | undefined>} A promise that resolves with the payload array for the Kilter Board if LED settings were applied.
+   */
+  led(config?: "green" | "red" | "orange"): Promise<number[] | undefined>
+
+  /**
+   * Retrieves manufacturer information from the device.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the manufacturer information.
+   */
+  manufacturer(): Promise<string | undefined>
+
+  /**
+   * Retrieves serial number from the device.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the serial number.
+   */
+  serial(): Promise<string | undefined>
+
+  /**
+   * Stops the data stream on the specified device.
+   * @returns {Promise<void>} A promise that resolves when the stream is stopped.
+   */
+  stop(): Promise<void>
+
+  /**
+   * Starts streaming data from the specified device.
+   * @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(duration?: number): Promise<void>
 }

package/src/interfaces/device/mysmartboard.interface.ts

@@ -1,4 +1,6 @@
 import type { IDevice } from "../device.interface"
-
+/**
+ * Interface representing the mySmartBoard device, extending the base Device interface.
+ */
 // eslint-disable-next-line @typescript-eslint/no-empty-object-type
 export interface ImySmartBoard extends IDevice {}

package/src/interfaces/device/progressor.interface.ts

@@ -1,4 +1,31 @@
 import type { IDevice } from "../device.interface"
 
-// eslint-disable-next-line @typescript-eslint/no-empty-object-type
-export interface IProgressor extends IDevice {}
+/**
+ * Interface representing the Tindeq Progressor device.
+ */
+export interface IProgressor extends IDevice {
+  /**
+   * Retrieves battery or voltage information from the device.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the battery or voltage information.
+   */
+  battery(): Promise<string | undefined>
+
+  /**
+   * Retrieves firmware version from the device.
+   * @returns {Promise<string>} A Promise that resolves with the firmware version.
+   */
+  firmware(): Promise<string | undefined>
+
+  /**
+   * Stops the data stream on the specified device.
+   * @returns {Promise<void>} A promise that resolves when the stream is stopped.
+   */
+  stop(): Promise<void>
+
+  /**
+   * Starts streaming data from the specified device.
+   * @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(duration?: number): Promise<void>
+}

package/src/interfaces/device/wh-c06.interface.ts

@@ -1,4 +1,6 @@
 import type { IDevice } from "../device.interface"
-
+/**
+ * Interface representing the Weiheng WH-C06 device.
+ */
 // eslint-disable-next-line @typescript-eslint/no-empty-object-type
 export interface IWHC06 extends IDevice {}

package/src/interfaces/device.interface.ts

@@ -1,5 +1,7 @@
 import type { IBase } from "./base.interface"
+import type { massObject } from "../types/notify"
 
+type NotifyCallback = (data: massObject) => void
 /**
  * Represents a characteristic of a Bluetooth service.
  */
@@ -40,22 +42,18 @@ export interface IDevice extends IBase {
   bluetooth?: BluetoothDevice
 
   /**
-   * Handles the 'disconnected' event.
-   * @param {Event} event - The 'disconnected' event.
-   */
-  onDisconnected(event: Event): void
-
-  /**
-   * Handles notifications received from a characteristic.
-   * @param {Event} event - The notification event.
+   * Connects to a Bluetooth device.
+   * @param {Function} [onSuccess] - Optional callback function to execute on successful connection. Default logs success.
+   * @param {Function} [onError] - Optional callback function to execute on error. Default logs the error.
    */
-  handleNotifications(event: Event): void
+  connect(onSuccess?: () => void, onError?: (error: Error) => void): Promise<void>
 
   /**
-   * Handles the 'connected' event.
-   * @param {Function} onSuccess - Callback function to execute on successful connection.
+   * Disconnects the device if it is currently connected.
+   * - Checks if the device is connected via it's GATT server.
+   * - If the device is connected, it attempts to gracefully disconnect.
    */
-  onConnected(onSuccess: () => void): Promise<void>
+  disconnect(): void
 
   /**
    * Returns UUIDs of all services associated with the device.
@@ -64,11 +62,10 @@ export interface IDevice extends IBase {
   getAllServiceUUIDs(): string[]
 
   /**
-   * Connects to a Bluetooth device.
-   * @param {Function} [onSuccess] - Optional callback function to execute on successful connection. Default logs success.
-   * @param {Function} [onError] - Optional callback function to execute on error. Default logs the error.
+   * Handles notifications received from a characteristic.
+   * @param {Event} event - The notification event.
    */
-  connect(onSuccess?: () => void, onError?: (error: Error) => void): Promise<void>
+  handleNotifications(event: Event): void
 
   /**
    * Checks if a Bluetooth device is connected.
@@ -77,9 +74,28 @@ export interface IDevice extends IBase {
   isConnected(): boolean
 
   /**
-   * Disconnects the device if it is currently connected.
-   * - Checks if the device is connected via it's GATT server.
-   * - If the device is connected, it attempts to gracefully disconnect.
+   * Sets the callback function to be called when notifications are received.
+   * @param {NotifyCallback} callback - The callback function to be set.
+   * @returns {void}
    */
-  disconnect(): 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
+
+  /**
+   * Handles the 'connected' event.
+   * @param {Function} onSuccess - Callback function to execute on successful connection.
+   */
+  onConnected(onSuccess: () => void): Promise<void>
+
+  /**
+   * Handles the 'disconnected' event.
+   * @param {Event} event - The 'disconnected' event.
+   */
+  onDisconnected(event: Event): void
 }

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

@@ -1,6 +1,5 @@
 import { Device } from "../device.model"
 import type { IEntralpi } from "../../interfaces/device/entralpi.interface"
-import { notifyCallback } from "../../notify"
 import { applyTare } from "../../tare"
 import { checkActivity } from "../../is-active"
 import { read } from "../../read"
@@ -27,7 +26,7 @@ export class Entralpi extends Device implements IEntralpi {
           characteristics: [
             {
               name: "System ID",
-              id: "id",
+              id: "system",
               uuid: "00002a23-0000-1000-8000-00805f9b34fb",
             },
             {
@@ -136,7 +135,7 @@ export class Entralpi extends Device implements IEntralpi {
 
   /**
    * Retrieves battery or voltage information from the device.
-   * @returns {Promise<string | undefined>} A Promise that resolves with the battery or voltage information,
+   * @returns {Promise<string | undefined>} A Promise that resolves with the battery or voltage information.
    */
   battery = async (): Promise<string | undefined> => {
     if (this.isConnected()) {
@@ -146,9 +145,23 @@ export class Entralpi extends Device implements IEntralpi {
     return undefined
   }
 
+  /**
+   * Retrieves IEEE 11073-20601 Regulatory Certification from the device.
+   * @returns {Promise<string>} A Promise that resolves with the certification.
+   */
+  certification = async (): Promise<string | undefined> => {
+    // Check if the device is connected
+    if (this.isConnected()) {
+      // Read certification from the device
+      return await read(this, "device", "certification", 250)
+    }
+    // If device is not found, return undefined
+    return undefined
+  }
+
   /**
    * Retrieves firmware version from the device.
-   * @returns {Promise<string>} A Promise that resolves with the firmware version,
+   * @returns {Promise<string>} A Promise that resolves with the firmware version.
    */
   firmware = async (): Promise<string | undefined> => {
     // Check if the device is connected
@@ -197,7 +210,7 @@ export class Entralpi extends Device implements IEntralpi {
         checkActivity(numericData)
 
         // Notify with weight data
-        notifyCallback({
+        this.notifyCallback({
           massMax: MASS_MAX,
           massAverage: MASS_AVERAGE,
           massTotal: Math.max(-1000, numericData).toFixed(1),
@@ -208,7 +221,7 @@ export class Entralpi extends Device implements IEntralpi {
 
   /**
    * Retrieves hardware version from the device.
-   * @returns {Promise<string>} A Promise that resolves with the hardware version,
+   * @returns {Promise<string>} A Promise that resolves with the hardware version.
    */
   hardware = async (): Promise<string | undefined> => {
     // Check if the device is connected
@@ -222,7 +235,7 @@ export class Entralpi extends Device implements IEntralpi {
 
   /**
    * Retrieves manufacturer information from the device.
-   * @returns {Promise<string>} A Promise that resolves with the manufacturer information,
+   * @returns {Promise<string>} A Promise that resolves with the manufacturer information.
    */
   manufacturer = async (): Promise<string | undefined> => {
     // Check if the device is connected
@@ -236,7 +249,7 @@ export class Entralpi extends Device implements IEntralpi {
 
   /**
    * Retrieves model number from the device.
-   * @returns {Promise<string>} A Promise that resolves with the model number,
+   * @returns {Promise<string>} A Promise that resolves with the model number.
    */
   model = async (): Promise<string | undefined> => {
     // Check if the device is connected
@@ -248,9 +261,24 @@ export class Entralpi extends Device implements IEntralpi {
     return undefined
   }
 
+  /**
+   * Retrieves PnP ID from the device, a set of values that used to create a device ID value that is unique for this device.
+   * Included in the characteristic is a Vendor ID Source field, a Vendor ID field, a Product ID field and a Product Version field
+   * @returns {Promise<string>} A Promise that resolves with the PnP ID.
+   */
+  pnp = async (): Promise<string | undefined> => {
+    // Check if the device is connected
+    if (this.isConnected()) {
+      // Read software version from the Entralpi
+      return await read(this, "device", "pnp", 250)
+    }
+    // If device is not found, return undefined
+    return undefined
+  }
+
   /**
    * Retrieves software version from the device.
-   * @returns {Promise<string>} A Promise that resolves with the software version,
+   * @returns {Promise<string>} A Promise that resolves with the software version.
    */
   software = async (): Promise<string | undefined> => {
     // Check if the device is connected
@@ -261,4 +289,18 @@ export class Entralpi extends Device implements IEntralpi {
     // If device is not found, return undefined
     return undefined
   }
+
+  /**
+   * Retrieves system id from the device.
+   * @returns {Promise<string>} A Promise that resolves with the system id.
+   */
+  system = async (): Promise<string | undefined> => {
+    // Check if the device is connected
+    if (this.isConnected()) {
+      // Read system id from the device
+      return await read(this, "device", "system", 250)
+    }
+    // If device is not found, return undefined
+    return undefined
+  }
 }

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

@@ -214,7 +214,7 @@ export class KilterBoard extends Device implements IKilterBoard {
    * @param {ClimbPlacement[]} [config] - Optional color or array of climb placements for the LEDs. Ignored if placements are provided.
    * @returns {Promise<number[] | undefined>} A promise that resolves with the payload array for the Kilter Board if LED settings were applied, or `undefined` if no action was taken or for the Motherboard.
    */
-  led = async (config?: "green" | "red" | "orange" | ClimbPlacement[]): Promise<number[] | undefined> => {
+  led = async (config?: ClimbPlacement[]): Promise<number[] | undefined> => {
     // Handle Kilterboard logic: process placements and send payload if connected
     if (Array.isArray(config)) {
       // Prepares byte arrays for transmission based on a list of climb placements.

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

@@ -1,6 +1,5 @@
 import { Device } from "../device.model"
 import type { IMotherboard } from "../../interfaces/device/motherboard.interface"
-import { notifyCallback } from "../../notify"
 import { write, writeCallback } from "../../write"
 import { applyTare } from "../../tare"
 import { MotherboardCommands } from "../../commands"
@@ -9,7 +8,6 @@ import { lastWrite } from "../../write"
 import { DownloadPackets, emptyDownloadPackets } from "../../download"
 import type { DownloadPacket } from "../../types/download"
 import { read } from "../../read"
-import { stop } from "../../stop"
 
 // Constants
 const PACKET_LENGTH = 32
@@ -289,7 +287,7 @@ export class Motherboard extends Device implements IMotherboard {
             checkActivity(center)
 
             // Notify with weight data
-            notifyCallback({
+            this.notifyCallback({
               massTotal: Math.max(-1000, left + center + right).toFixed(1),
               massMax: MASS_MAX,
               massAverage: MASS_AVERAGE,
@@ -381,6 +379,17 @@ export class Motherboard extends Device implements IMotherboard {
     return undefined
   }
 
+  /**
+   * Stops the data stream on the specified device.
+   * @returns {Promise<void>} A promise that resolves when the stream is stopped.
+   */
+  stop = async (): Promise<void> => {
+    if (this.isConnected()) {
+      // Stop stream of device
+      await write(this, "uart", "tx", MotherboardCommands.STOP_WEIGHT_MEAS, 0)
+    }
+  }
+
   /**
    * Starts streaming data from the specified device.
    * @param {number} [duration=0] - The duration of the stream in milliseconds. If set to 0, stream will continue indefinitely.
@@ -400,7 +409,7 @@ export class Motherboard extends Device implements IMotherboard {
       await write(this, "uart", "tx", MotherboardCommands.START_WEIGHT_MEAS, duration)
       // Stop streaming if duration is set
       if (duration !== 0) {
-        await stop(this)
+        await this.stop()
       }
     }
   }

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

@@ -1,13 +1,11 @@
 import { Device } from "../device.model"
 import type { IProgressor } from "../../interfaces/device/progressor.interface"
-import { notifyCallback } from "../../notify"
 import { applyTare } from "../../tare"
 import { checkActivity } from "../../is-active"
 import { ProgressorCommands, ProgressorResponses } from "../../commands/progressor"
 import struct from "../../struct"
 import { DownloadPackets, emptyDownloadPackets } from "../../download"
 import { lastWrite, write, writeCallback } from "../../write"
-import { stop } from "../../stop"
 
 // Constants
 let MASS_MAX = "0"
@@ -135,7 +133,7 @@ export class Progressor extends Device implements IProgressor {
               // Check if device is being used
               checkActivity(weight)
 
-              notifyCallback({
+              this.notifyCallback({
                 massMax: MASS_MAX,
                 massAverage: MASS_AVERAGE,
                 massTotal: Math.max(-1000, weight).toFixed(1),
@@ -164,6 +162,17 @@ export class Progressor extends Device implements IProgressor {
     }
   }
 
+  /**
+   * Stops the data stream on the specified device.
+   * @returns {Promise<void>} A promise that resolves when the stream is stopped.
+   */
+  stop = async (): Promise<void> => {
+    if (this.isConnected()) {
+      // Stop stream of device
+      await write(this, "progressor", "tx", ProgressorCommands.STOP_WEIGHT_MEAS, 0)
+    }
+  }
+
   /**
    * Starts streaming data from the specified device.
    * @param {number} [duration=0] - The duration of the stream in milliseconds. If set to 0, stream will continue indefinitely.
@@ -177,7 +186,7 @@ export class Progressor extends Device implements IProgressor {
       await write(this, "progressor", "tx", ProgressorCommands.START_WEIGHT_MEAS, duration)
       // Stop streaming if duration is set
       if (duration !== 0) {
-        await stop(this)
+        await this.stop()
       }
     }
   }

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

@@ -1,7 +1,6 @@
 import { Device } from "../device.model"
 import { applyTare } from "../../tare"
 import { checkActivity } from "../../is-active"
-import { notifyCallback } from "../../notify"
 import type { IWHC06 } from "../../interfaces/device/wh-c06.interface"
 
 // Constants
@@ -57,14 +56,15 @@ export class WHC06 extends Device implements IWHC06 {
         throw new Error("GATT is not available on this device")
       }
 
+      // Device has no services / characteristics
+      onSuccess()
+
       // WH-C06
       const MANUFACTURER_ID = 256 // 0x0100
 
       this.bluetooth.addEventListener("advertisementreceived", (event) => {
         const data = event.manufacturerData.get(MANUFACTURER_ID)
         if (data) {
-          // Device has no services / characteristics
-          onSuccess()
           // Handle recieved data
           const weight = (data.getUint8(WEIGHT_OFFSET) << 8) | data.getUint8(WEIGHT_OFFSET + 1)
           // const stable = (data.getUint8(STABLE_OFFSET) & 0xf0) >> 4
@@ -90,7 +90,7 @@ export class WHC06 extends Device implements IWHC06 {
           checkActivity(numericData)
 
           // Notify with weight data
-          notifyCallback({
+          this.notifyCallback({
             massMax: MASS_MAX,
             massAverage: MASS_AVERAGE,
             massTotal: Math.max(-1000, numericData).toFixed(1),