@hangtime/grip-connect 0.5.1 → 0.5.2

package/dist/models/device.model.js

@@ -57,6 +57,26 @@ export class Device extends BaseModel {
     getAllServiceUUIDs = () => {
         return this.services.map((service) => service.uuid);
     };
+    /**
+     * 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, characteristicId) => {
+        // 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;
+            }
+        }
+        // Return undefined if the service or characteristic is not found
+        return undefined;
+    };
     /**
      * Handles notifications received from a characteristic.
      * @param {Event} event - The notification event.
@@ -151,4 +171,100 @@ export class Device extends BaseModel {
         const device = event.target;
         throw new Error(`Device ${device.name} is disconnected.`);
     };
+    /**
+     * 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, characteristicId, duration = 0) => {
+        return new Promise((resolve, reject) => {
+            if (this.isConnected()) {
+                const characteristic = this.getCharacteristic(serviceId, characteristicId);
+                if (characteristic) {
+                    characteristic
+                        .readValue()
+                        .then((value) => {
+                        let decodedValue;
+                        const decoder = new TextDecoder("utf-8");
+                        switch (characteristicId) {
+                            case "level":
+                                // TODO: This is battery specific.
+                                decodedValue = value.getUint8(0).toString();
+                                break;
+                            default:
+                                decodedValue = decoder.decode(value);
+                                break;
+                        }
+                        // Resolve after specified duration
+                        setTimeout(() => {
+                            return resolve(decodedValue);
+                        }, duration);
+                    })
+                        .catch((error) => {
+                        reject(error);
+                    });
+                }
+                else {
+                    reject(new Error("Characteristic is undefined"));
+                }
+            }
+        });
+    };
+    /**
+     * 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 = async (serviceId, characteristicId, message, duration = 0, callback = this.writeCallback) => {
+        if (this.isConnected()) {
+            // Check if message is provided
+            if (message === undefined) {
+                // If not provided, return without performing write operation
+                return;
+            }
+            // Get the characteristic from the device using serviceId and characteristicId
+            const characteristic = this.getCharacteristic(serviceId, characteristicId);
+            if (!characteristic) {
+                throw new Error("Characteristic is undefined");
+            }
+            // Convert the message to Uint8Array if it's a string
+            const valueToWrite = typeof message === "string" ? new TextEncoder().encode(message) : message;
+            // Write the value to the characteristic
+            await characteristic.writeValue(valueToWrite);
+            // Update the last written message
+            this.writeLast = message;
+            // Assign the provided callback to `writeCallback`
+            this.writeCallback = callback;
+            // If a duration is specified, resolve the promise after the duration
+            if (duration > 0) {
+                await new Promise((resolve) => setTimeout(resolve, duration));
+            }
+        }
+    };
+    /**
+     * A default write callback that logs the response
+     */
+    writeCallback = (data) => {
+        console.log(data);
+    };
+    /**
+     * The last message written to the device.
+     * @type {string | Uint8Array | null}
+     */
+    writeLast = null;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hangtime/grip-connect",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "description": "Griptonite Motherboard, Tindeq Progressor, PitchSix Force Board, WHC-06, Entralpi, Climbro, mySmartBoard: Web Bluetooth API Force-Sensing strength analysis for climbers",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/{is-device.ts → helpers/is-device.ts}

@@ -1,5 +1,5 @@
-import type { Device } from "./models/device.model"
-import { AuroraUUID } from "./models/device/kilterboard.model"
+import type { Device } from "./../models/device.model"
+import { AuroraUUID } from "./../models/device/kilterboard.model"
 
 /**
  * Checks if the given device is an Entralpi device.

package/src/index.ts

@@ -10,9 +10,9 @@ export {
 } from "./models/index"
 
 // helpers
-export { isEntralpi, isKilterboard, isMotherboard, isWHC06, isProgressor } from "./is-device"
+export { isEntralpi, isKilterboard, isMotherboard, isWHC06, isProgressor } from "./helpers/is-device"
 
-// functions
+// TODO: Make functions device specific
 export { download } from "./download"
 
 export { active, isActive } from "./is-active"

package/src/interfaces/device.interface.ts

@@ -1,7 +1,6 @@
 import type { IBase } from "./base.interface"
 import type { massObject } from "../types/notify"
 
-type NotifyCallback = (data: massObject) => void
 /**
  * Represents a characteristic of a Bluetooth service.
  */
@@ -61,6 +60,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 +85,14 @@ export interface IDevice extends IBase {
    * @param {NotifyCallback} callback - The callback function to be set.
    * @returns {void}
    */
-  notify(callback: NotifyCallback): void
+  notify(callback: (data: massObject) => void): void
 
   /**
    * Defines the type for the callback function.
    * @callback NotifyCallback
    * @param {massObject} data - The data passed to the callback.
    */
-  notifyCallback: NotifyCallback
+  notifyCallback: (data: massObject) => void
 
   /**
    * Handles the 'connected' event.
@@ -98,4 +105,49 @@ 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>
+
+  /**
+   * A default write callback that logs the response
+   */
+  writeCallback: (data: string) => void
+  /**
+   * The last message written to the device.
+   * @type {string | Uint8Array | null}
+   */
+  writeLast: string | Uint8Array | null
 }

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

@@ -2,7 +2,6 @@ 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"
@@ -139,7 +138,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 +152,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 +166,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
@@ -227,7 +226,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 +240,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 +254,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 +269,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 +283,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 +297,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
@@ -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,7 +1,6 @@
 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
@@ -206,7 +205,7 @@ export class KilterBoard extends Device implements IKilterBoard {
    */
   async writeMessageSeries(messages: Uint8Array[]) {
     for (const message of messages) {
-      await write(this, "uart", "tx", message)
+      await this.write("uart", "tx", message)
     }
   }
   /**

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

@@ -1,13 +1,10 @@
 import { Device } from "../device.model"
 import type { IMotherboard } from "../../interfaces/device/motherboard.interface"
-import { write, writeCallback } from "../../write"
 import { applyTare } from "../../tare"
 import { MotherboardCommands } from "../../commands"
 import { checkActivity } from "../../is-active"
-import { lastWrite } from "../../write"
 import { DownloadPackets, emptyDownloadPackets } from "../../download"
 import type { DownloadPacket } from "../../types/download"
-import { read } from "../../read"
 
 // Constants
 const PACKET_LENGTH = 32
@@ -154,7 +151,7 @@ export class Motherboard extends Device implements IMotherboard {
    */
   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
@@ -168,7 +165,7 @@ export class Motherboard extends Device implements IMotherboard {
     // Check if the device is connected
     if (this.isConnected()) {
       // Write the command to get calibration data to the device
-      await write(this, "uart", "tx", MotherboardCommands.GET_CALIBRATION, 2500, (data) => {
+      await this.write("uart", "tx", MotherboardCommands.GET_CALIBRATION, 2500, (data) => {
         console.log(data)
       })
     }
@@ -182,7 +179,7 @@ export class Motherboard extends Device implements IMotherboard {
     // 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
@@ -295,7 +292,7 @@ export class Motherboard extends Device implements IMotherboard {
               massCenter: Math.max(-1000, packet.masses[1]).toFixed(1),
               massRight: Math.max(-1000, packet.masses[2]).toFixed(1),
             })
-          } else if (lastWrite === MotherboardCommands.GET_CALIBRATION) {
+          } else if (this.writeLast === MotherboardCommands.GET_CALIBRATION) {
             // check data integrity
             if ((receivedData.match(/,/g) || []).length === 3) {
               const parts: string[] = receivedData.split(",")
@@ -304,7 +301,7 @@ export class Motherboard extends Device implements IMotherboard {
             }
           } else {
             // unhandled data
-            writeCallback(receivedData)
+            this.writeCallback(receivedData)
           }
         }
       }
@@ -319,7 +316,7 @@ export class Motherboard extends Device implements IMotherboard {
     // 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
@@ -341,8 +338,8 @@ export class Motherboard extends Device implements IMotherboard {
       // Default to "off" color if config is not set or not found in colorMapping
       const color = typeof config === "string" && colorMapping[config] ? config : "off"
       const [redValue, greenValue] = colorMapping[color]
-      await write(this, "led", "red", new Uint8Array(redValue))
-      await write(this, "led", "green", new Uint8Array(greenValue), 1250)
+      await this.write("led", "red", new Uint8Array(redValue))
+      await this.write("led", "green", new Uint8Array(greenValue), 1250)
     }
     return undefined
   }
@@ -355,7 +352,7 @@ export class Motherboard extends Device implements IMotherboard {
     // 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
@@ -370,7 +367,7 @@ export class Motherboard extends Device implements IMotherboard {
     if (this.isConnected()) {
       // Write serial number command to the Motherboard and read output
       let response: string | undefined = undefined
-      await write(this, "uart", "tx", MotherboardCommands.GET_SERIAL, 250, (data) => {
+      await this.write("uart", "tx", MotherboardCommands.GET_SERIAL, 250, (data) => {
         response = data
       })
       return response
@@ -386,7 +383,7 @@ export class Motherboard extends Device implements IMotherboard {
   stop = async (): Promise<void> => {
     if (this.isConnected()) {
       // Stop stream of device
-      await write(this, "uart", "tx", MotherboardCommands.STOP_WEIGHT_MEAS, 0)
+      await this.write("uart", "tx", MotherboardCommands.STOP_WEIGHT_MEAS, 0)
     }
   }
 
@@ -406,7 +403,7 @@ export class Motherboard extends Device implements IMotherboard {
         await this.calibration()
       }
       // Start streaming data
-      await write(this, "uart", "tx", MotherboardCommands.START_WEIGHT_MEAS, duration)
+      await this.write("uart", "tx", MotherboardCommands.START_WEIGHT_MEAS, duration)
       // Stop streaming if duration is set
       if (duration !== 0) {
         await this.stop()
@@ -428,7 +425,7 @@ export class Motherboard extends Device implements IMotherboard {
     if (this.isConnected()) {
       // Write text information command to the Motherboard and read output
       let response: string | undefined = undefined
-      await write(this, "uart", "tx", MotherboardCommands.GET_TEXT, 250, (data) => {
+      await this.write("uart", "tx", MotherboardCommands.GET_TEXT, 250, (data) => {
         response = data
       })
       return response

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

@@ -1,11 +1,10 @@
 import { Device } from "../device.model"
 import type { IProgressor } from "../../interfaces/device/progressor.interface"
-import { applyTare } from "../../tare"
-import { checkActivity } from "../../is-active"
 import { ProgressorCommands, ProgressorResponses } from "../../commands/progressor"
-import struct from "../../struct"
+import struct from "../../helpers/struct"
+import { checkActivity } from "../../is-active"
 import { DownloadPackets, emptyDownloadPackets } from "../../download"
-import { lastWrite, write, writeCallback } from "../../write"
+import { applyTare } from "../../tare"
 
 // Constants
 let MASS_MAX = "0"
@@ -61,7 +60,7 @@ export class Progressor extends Device implements IProgressor {
   battery = async (): Promise<string | undefined> => {
     if (this.isConnected()) {
       let response: string | undefined = undefined
-      await write(this, "progressor", "tx", ProgressorCommands.GET_BATT_VLTG, 250, (data) => {
+      await this.write("progressor", "tx", ProgressorCommands.GET_BATT_VLTG, 250, (data) => {
         response = data
       })
       return response
@@ -79,7 +78,7 @@ export class Progressor extends Device implements IProgressor {
     if (this.isConnected()) {
       // Read firmware version from the device
       let response: string | undefined = undefined
-      await write(this, "progressor", "tx", ProgressorCommands.GET_FW_VERSION, 250, (data) => {
+      await this.write("progressor", "tx", ProgressorCommands.GET_FW_VERSION, 250, (data) => {
         response = data
       })
       return response
@@ -141,18 +140,18 @@ export class Progressor extends Device implements IProgressor {
             }
           }
         } else if (kind === ProgressorResponses.COMMAND_RESPONSE) {
-          if (!lastWrite) return
+          if (!this.writeLast) return
 
           let value = ""
 
-          if (lastWrite === ProgressorCommands.GET_BATT_VLTG) {
+          if (this.writeLast === ProgressorCommands.GET_BATT_VLTG) {
             value = new DataView(data.buffer, 2).getUint32(0, true).toString()
-          } else if (lastWrite === ProgressorCommands.GET_FW_VERSION) {
+          } else if (this.writeLast === ProgressorCommands.GET_FW_VERSION) {
             value = new TextDecoder().decode(data.buffer.slice(2))
-          } else if (lastWrite === ProgressorCommands.GET_ERR_INFO) {
+          } else if (this.writeLast === ProgressorCommands.GET_ERR_INFO) {
             value = new TextDecoder().decode(data.buffer.slice(2))
           }
-          writeCallback(value)
+          this.writeCallback(value)
         } else if (kind === ProgressorResponses.LOW_BATTERY_WARNING) {
           console.warn("⚠️ Low power detected. Please consider connecting to a power source.")
         } else {
@@ -169,7 +168,7 @@ export class Progressor extends Device implements IProgressor {
   stop = async (): Promise<void> => {
     if (this.isConnected()) {
       // Stop stream of device
-      await write(this, "progressor", "tx", ProgressorCommands.STOP_WEIGHT_MEAS, 0)
+      await this.write("progressor", "tx", ProgressorCommands.STOP_WEIGHT_MEAS, 0)
     }
   }
 
@@ -183,7 +182,7 @@ export class Progressor extends Device implements IProgressor {
       // Reset download packets
       emptyDownloadPackets()
       // Start streaming data
-      await write(this, "progressor", "tx", ProgressorCommands.START_WEIGHT_MEAS, duration)
+      await this.write("progressor", "tx", ProgressorCommands.START_WEIGHT_MEAS, duration)
       // Stop streaming if duration is set
       if (duration !== 0) {
         await this.stop()