@hangtime/grip-connect 0.4.2 → 0.5.1

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

@@ -0,0 +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
+
+  /**
+   * 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

@@ -0,0 +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 {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

@@ -0,0 +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

@@ -0,0 +1,31 @@
+import type { IDevice } from "../device.interface"
+
+/**
+ * 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

@@ -0,0 +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

@@ -0,0 +1,101 @@
+import type { IBase } from "./base.interface"
+import type { massObject } from "../types/notify"
+
+type NotifyCallback = (data: massObject) => void
+/**
+ * Represents a characteristic of a Bluetooth service.
+ */
+interface Characteristic {
+  /** Name of the characteristic */
+  name: string
+  /** Identifier of the characteristic */
+  id: string
+  /** UUID of the characteristic */
+  uuid: string
+  /** Reference to the characteristic object */
+  characteristic?: BluetoothRemoteGATTCharacteristic
+}
+
+/**
+ * Represents a Bluetooth service.
+ */
+export interface Service {
+  /**  Name of the service */
+  name: string
+  /** Identifier of the service */
+  id: string
+  /** UUID of the service */
+  uuid: string
+  /** Array of characteristics belonging to this service */
+  characteristics: Characteristic[]
+}
+
+/**
+ * Represents a Bluetooth device.
+ */
+export interface IDevice extends IBase {
+  /** Filters to indentify the device */
+  filters: BluetoothLEScanFilter[]
+  /** Array of services provided by the device */
+  services: Service[]
+  /** Reference to the BluetoothDevice object representing this device */
+  bluetooth?: BluetoothDevice
+
+  /**
+   * 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.
+   */
+  connect(onSuccess?: () => void, onError?: (error: Error) => void): Promise<void>
+
+  /**
+   * 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.
+   */
+  disconnect(): void
+
+  /**
+   * Returns UUIDs of all services associated with the device.
+   * @returns {string[]} Array of service UUIDs.
+   */
+  getAllServiceUUIDs(): string[]
+
+  /**
+   * Handles notifications received from a characteristic.
+   * @param {Event} event - The notification event.
+   */
+  handleNotifications(event: Event): void
+
+  /**
+   * Checks if a Bluetooth device is connected.
+   * @returns {boolean} A boolean indicating whether the device is connected.
+   */
+  isConnected(): boolean
+
+  /**
+   * Sets the callback function to be called when notifications are received.
+   * @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
+
+  /**
+   * 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/is-device.ts

@@ -1,20 +1,6 @@
-import type { Device } from "./types/devices"
-import { AuroraUUID } from "./devices/kilterboard"
+import type { Device } from "./models/device.model"
+import { AuroraUUID } from "./models/device/kilterboard.model"
 
-/**
- * Checks if the given device is a Motherboard.
- * @param {Device} [board] - The device to check.
- * @returns {boolean} `true` if the device has a filter with the name "Motherboard", otherwise `false`.
- */
-export const isMotherboard = (board?: Device): boolean =>
-  board?.filters.some((filter) => filter.name === "Motherboard") ?? false
-/**
- * Checks if the given device is a Progressor.
- * @param {Device} [board] - The device to check.
- * @returns {boolean} `true` if the device has a filter with a namePrefix of "Progressor", otherwise `false`.
- */
-export const isProgressor = (board?: Device): boolean =>
-  board?.filters.some((filter) => filter.namePrefix === "Progressor") ?? false
 /**
  * Checks if the given device is an Entralpi device.
  * @param {Device} [board] - The device to check.
@@ -22,6 +8,13 @@ export const isProgressor = (board?: Device): boolean =>
  */
 export const isEntralpi = (board?: Device): boolean =>
   board?.filters.some((filter) => filter.name === "ENTRALPI") ?? false
+/**
+ * Checks if the given device is a Force Board.
+ * @param {Device} [board] - The device to check.
+ * @returns {boolean} `true` if the device has a filter with the name "Force Board", otherwise `false`.
+ */
+export const isForceBoard = (board?: Device): boolean =>
+  board?.filters.some((filter) => filter.name === "Force Board") ?? false
 /**
  * Checks if the given device is a Kilterboard.
  * @param {Device} [board] - The device to check.
@@ -30,6 +23,20 @@ export const isEntralpi = (board?: Device): boolean =>
 export const isKilterboard = (board?: Device): boolean => {
   return board?.filters.some((filter) => filter.services?.includes(AuroraUUID)) ?? false
 }
+/**
+ * Checks if the given device is a Motherboard.
+ * @param {Device} [board] - The device to check.
+ * @returns {boolean} `true` if the device has a filter with the name "Motherboard", otherwise `false`.
+ */
+export const isMotherboard = (board?: Device): boolean =>
+  board?.filters.some((filter) => filter.name === "Motherboard") ?? false
+/**
+ * Checks if the given device is a Progressor.
+ * @param {Device} [board] - The device to check.
+ * @returns {boolean} `true` if the device has a filter with a namePrefix of "Progressor", otherwise `false`.
+ */
+export const isProgressor = (board?: Device): boolean =>
+  board?.filters.some((filter) => filter.namePrefix === "Progressor") ?? false
 /**
  * Checks if the given device is a WH-C06.
  * @param {Device} [board] - The device to check.

package/src/models/base.model.ts

@@ -0,0 +1,16 @@
+import type { IBase } from "../interfaces/base.interface"
+
+export abstract class BaseModel {
+  id?: string
+
+  createdAt?: Date
+
+  updatedAt?: Date
+
+  constructor(base: IBase) {
+    this.id = base.id ? base.id : self.crypto.randomUUID()
+
+    this.createdAt = base.createdAt
+    this.updatedAt = base.updatedAt
+  }
+}

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

@@ -0,0 +1,15 @@
+import { Device } from "../device.model"
+import type { IClimbro } from "../../interfaces/device/climbro.interface"
+
+/**
+ * Represents a Climbro device
+ * TODO: Add services, do you own a Climbro? Help us!
+ */
+export class Climbro extends Device implements IClimbro {
+  constructor() {
+    super({
+      filters: [{ name: "Climbro" }],
+      services: [],
+    })
+  }
+}