@hangtime/grip-connect 0.5.0 → 0.5.1

package/dist/models/device/entralpi.model.js

@@ -1,5 +1,4 @@
 import { Device } from "../device.model";
-import { notifyCallback } from "../../notify";
 import { applyTare } from "../../tare";
 import { checkActivity } from "../../is-active";
 import { read } from "../../read";
@@ -24,7 +23,7 @@ export class Entralpi extends Device {
                     characteristics: [
                         {
                             name: "System ID",
-                            id: "id",
+                            id: "system",
                             uuid: "00002a23-0000-1000-8000-00805f9b34fb",
                         },
                         {
@@ -132,7 +131,7 @@ export class Entralpi extends Device {
     }
     /**
      * 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 () => {
         if (this.isConnected()) {
@@ -141,9 +140,22 @@ export class Entralpi extends Device {
         // If device is not found, return undefined
         return undefined;
     };
+    /**
+     * Retrieves IEEE 11073-20601 Regulatory Certification from the device.
+     * @returns {Promise<string>} A Promise that resolves with the certification.
+     */
+    certification = async () => {
+        // 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 () => {
         // Check if the device is connected
@@ -183,7 +195,7 @@ export class Entralpi extends Device {
                 // Check if device is being used
                 checkActivity(numericData);
                 // Notify with weight data
-                notifyCallback({
+                this.notifyCallback({
                     massMax: MASS_MAX,
                     massAverage: MASS_AVERAGE,
                     massTotal: Math.max(-1000, numericData).toFixed(1),
@@ -193,7 +205,7 @@ export class Entralpi extends Device {
     };
     /**
      * 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 () => {
         // Check if the device is connected
@@ -206,7 +218,7 @@ export class Entralpi extends Device {
     };
     /**
      * 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 () => {
         // Check if the device is connected
@@ -219,7 +231,7 @@ export class Entralpi extends Device {
     };
     /**
      * 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 () => {
         // Check if the device is connected
@@ -230,9 +242,23 @@ export class Entralpi extends Device {
         // If device is not found, return undefined
         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 () => {
+        // 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 () => {
         // Check if the device is connected
@@ -243,4 +269,17 @@ export class Entralpi extends Device {
         // 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 () => {
+        // 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/dist/models/device/kilterboard.model.d.ts

@@ -80,6 +80,6 @@ export declare 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: (config?: "green" | "red" | "orange" | ClimbPlacement[]) => Promise<number[] | undefined>;
+    led: (config?: ClimbPlacement[]) => Promise<number[] | undefined>;
 }
 export {};

package/dist/models/device/motherboard.model.d.ts

@@ -57,6 +57,11 @@ export declare class Motherboard extends Device implements IMotherboard {
      * @returns {Promise<string>} 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.

package/dist/models/device/motherboard.model.js

@@ -1,5 +1,4 @@
 import { Device } from "../device.model";
-import { notifyCallback } from "../../notify";
 import { write, writeCallback } from "../../write";
 import { applyTare } from "../../tare";
 import { MotherboardCommands } from "../../commands";
@@ -7,7 +6,6 @@ import { checkActivity } from "../../is-active";
 import { lastWrite } from "../../write";
 import { DownloadPackets, emptyDownloadPackets } from "../../download";
 import { read } from "../../read";
-import { stop } from "../../stop";
 // Constants
 const PACKET_LENGTH = 32;
 const NUM_SAMPLES = 3;
@@ -255,7 +253,7 @@ export class Motherboard extends Device {
                         // Check if device is being used
                         checkActivity(center);
                         // Notify with weight data
-                        notifyCallback({
+                        this.notifyCallback({
                             massTotal: Math.max(-1000, left + center + right).toFixed(1),
                             massMax: MASS_MAX,
                             massAverage: MASS_AVERAGE,
@@ -344,6 +342,16 @@ export class Motherboard extends Device {
         // If device is not found, return undefined
         return undefined;
     };
+    /**
+     * Stops the data stream on the specified device.
+     * @returns {Promise<void>} A promise that resolves when the stream is stopped.
+     */
+    stop = async () => {
+        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.
@@ -362,7 +370,7 @@ export class Motherboard extends Device {
             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/dist/models/device/progressor.model.d.ts

@@ -23,6 +23,11 @@ export declare class Progressor extends Device implements IProgressor {
      * @param {Event} event - The notification event.
      */
     handleNotifications: (event: Event) => void;
+    /**
+     * 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.

package/dist/models/device/progressor.model.js

@@ -1,12 +1,10 @@
 import { Device } from "../device.model";
-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";
 let MASS_AVERAGE = "0";
@@ -125,7 +123,7 @@ export class Progressor extends Device {
                             MASS_AVERAGE = (MASS_TOTAL_SUM / DATAPOINT_COUNT).toFixed(1);
                             // Check if device is being used
                             checkActivity(weight);
-                            notifyCallback({
+                            this.notifyCallback({
                                 massMax: MASS_MAX,
                                 massAverage: MASS_AVERAGE,
                                 massTotal: Math.max(-1000, weight).toFixed(1),
@@ -157,6 +155,16 @@ export class Progressor extends Device {
             }
         }
     };
+    /**
+     * Stops the data stream on the specified device.
+     * @returns {Promise<void>} A promise that resolves when the stream is stopped.
+     */
+    stop = async () => {
+        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.
@@ -170,7 +178,7 @@ export class Progressor extends Device {
             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/dist/models/device/wh-c06.model.js

@@ -1,7 +1,6 @@
 import { Device } from "../device.model";
 import { applyTare } from "../../tare";
 import { checkActivity } from "../../is-active";
-import { notifyCallback } from "../../notify";
 // Constants
 let MASS_MAX = "0";
 let MASS_AVERAGE = "0";
@@ -45,13 +44,13 @@ export class WHC06 extends Device {
             if (!this.bluetooth.gatt) {
                 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
@@ -70,7 +69,7 @@ export class WHC06 extends Device {
                     // Check if device is being used
                     checkActivity(numericData);
                     // Notify with weight data
-                    notifyCallback({
+                    this.notifyCallback({
                         massMax: MASS_MAX,
                         massAverage: MASS_AVERAGE,
                         massTotal: Math.max(-1000, numericData).toFixed(1),

package/dist/models/device.model.d.ts

@@ -1,45 +1,61 @@
 import { BaseModel } from "./../models/base.model";
 import type { IDevice, Service } from "../interfaces/device.interface";
+import type { massObject } from "./../types/notify";
+/** Define the type for the callback function */
+type NotifyCallback = (data: massObject) => void;
 export declare class Device extends BaseModel implements IDevice {
     filters: BluetoothLEScanFilter[];
     services: Service[];
     bluetooth?: BluetoothDevice | undefined;
     constructor(device: Partial<IDevice>);
     /**
-     * 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.
      * @returns {string[]} Array of service UUIDs.
      */
     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.
      * @returns {boolean} A boolean indicating whether the device is connected.
      */
     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;
 }
+export {};

package/dist/models/device.model.js

@@ -11,13 +11,51 @@ export class Device extends BaseModel {
         this.bluetooth = device.bluetooth;
     }
     /**
-     * Handles the 'disconnected' event.
-     * @param {Event} event - The 'disconnected' 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.
      */
-    onDisconnected = (event) => {
-        this.bluetooth = undefined;
-        const device = event.target;
-        throw new Error(`Device ${device.name} is disconnected.`);
+    connect = async (onSuccess = () => console.log("Connected successfully"), onError = (error) => console.error(error)) => {
+        try {
+            // Request device and set up connection
+            const deviceServices = this.getAllServiceUUIDs();
+            this.bluetooth = await navigator.bluetooth.requestDevice({
+                filters: this.filters,
+                optionalServices: deviceServices,
+            });
+            if (!this.bluetooth.gatt) {
+                throw new Error("GATT is not available on this device");
+            }
+            this.bluetooth.addEventListener("gattserverdisconnected", (event) => {
+                this.onDisconnected(event);
+            });
+            server = await this.bluetooth.gatt.connect();
+            if (server.connected) {
+                await this.onConnected(onSuccess);
+            }
+        }
+        catch (error) {
+            onError(error);
+        }
+    };
+    /**
+     * 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 = () => {
+        // Verify that the device is connected using the provided helper function
+        if (this.isConnected()) {
+            // Safely attempt to disconnect the device's GATT server, if available
+            this.bluetooth?.gatt?.disconnect();
+        }
+    };
+    /**
+     * Returns UUIDs of all services associated with the device.
+     * @returns {string[]} Array of service UUIDs.
+     */
+    getAllServiceUUIDs = () => {
+        return this.services.map((service) => service.uuid);
     };
     /**
      * Handles notifications received from a characteristic.
@@ -38,6 +76,32 @@ export class Device extends BaseModel {
             }
         }
     };
+    /**
+     * Checks if a Bluetooth device is connected.
+     * @returns {boolean} A boolean indicating whether the device is connected.
+     */
+    isConnected = () => {
+        // Check if the device is defined and available
+        if (!this?.bluetooth) {
+            return false;
+        }
+        // Check if the device is connected
+        return !!this.bluetooth.gatt?.connected;
+    };
+    /**
+     * Sets the callback function to be called when notifications are received.
+     * @param {NotifyCallback} callback - The callback function to be set.
+     * @returns {void}
+     */
+    notify = (callback) => {
+        this.notifyCallback = callback;
+    };
+    /**
+     * Defines the type for the callback function.
+     * @callback NotifyCallback
+     * @param {massObject} data - The data passed to the callback.
+     */
+    notifyCallback = (data) => console.log(data);
     /**
      * Handles the 'connected' event.
      * @param {Function} onSuccess - Callback function to execute on successful connection.
@@ -79,62 +143,12 @@ export class Device extends BaseModel {
         onSuccess();
     };
     /**
-     * Returns UUIDs of all services associated with the device.
-     * @returns {string[]} Array of service UUIDs.
-     */
-    getAllServiceUUIDs = () => {
-        return this.services.map((service) => service.uuid);
-    };
-    /**
-     * 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 = async (onSuccess = () => console.log("Connected successfully"), onError = (error) => console.error(error)) => {
-        try {
-            // Request device and set up connection
-            const deviceServices = this.getAllServiceUUIDs();
-            this.bluetooth = await navigator.bluetooth.requestDevice({
-                filters: this.filters,
-                optionalServices: deviceServices,
-            });
-            if (!this.bluetooth.gatt) {
-                throw new Error("GATT is not available on this device");
-            }
-            this.bluetooth.addEventListener("gattserverdisconnected", (event) => {
-                this.onDisconnected(event);
-            });
-            server = await this.bluetooth.gatt.connect();
-            if (server.connected) {
-                await this.onConnected(onSuccess);
-            }
-        }
-        catch (error) {
-            onError(error);
-        }
-    };
-    /**
-     * Checks if a Bluetooth device is connected.
-     * @returns {boolean} A boolean indicating whether the device is connected.
-     */
-    isConnected = () => {
-        // Check if the device is defined and available
-        if (!this?.bluetooth) {
-            return false;
-        }
-        // Check if the device is connected
-        return !!this.bluetooth.gatt?.connected;
-    };
-    /**
-     * 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.
+     * Handles the 'disconnected' event.
+     * @param {Event} event - The 'disconnected' event.
      */
-    disconnect = () => {
-        // Verify that the device is connected using the provided helper function
-        if (this.isConnected()) {
-            // Safely attempt to disconnect the device's GATT server, if available
-            this.bluetooth?.gatt?.disconnect();
-        }
+    onDisconnected = (event) => {
+        this.bluetooth = undefined;
+        const device = event.target;
+        throw new Error(`Device ${device.name} is disconnected.`);
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hangtime/grip-connect",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "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/index.ts

@@ -17,8 +17,4 @@ export { download } from "./download"
 
 export { active, isActive } from "./is-active"
 
-export { notify } from "./notify"
-
-export { stop } from "./stop"
-
 export { tare } from "./tare"

package/src/interfaces/base.interface.ts

@@ -1,5 +1,19 @@
+/**
+ * Represents the base properties for an entity.
+ */
 export interface IBase {
+  /**
+   * Unique identifier for the entity (optional).
+   */
   id?: string
+
+  /**
+   * The date and time when the entity was created (optional).
+   */
   createdAt?: Date
+
+  /**
+   * The date and time when the entity was last updated (optional).
+   */
   updatedAt?: Date
 }

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

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

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

@@ -1,4 +1,61 @@
 import type { IDevice } from "../device.interface"
 
-// eslint-disable-next-line @typescript-eslint/no-empty-object-type
-export interface IEntralpi extends IDevice {}
+/**
+ * Interface representing the Entralpi device, extending the base Device interface.
+ */
+export interface IEntralpi 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 IEEE 11073-20601 Regulatory Certification from the device.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the firmware version.
+   */
+  certification(): Promise<string | undefined>
+
+  /**
+   * 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>
+
+  /**
+   * Retrieves manufacturer information from the device.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the manufacturer information.
+   */
+  manufacturer(): Promise<string | undefined>
+
+  /**
+   * Retrieves model number from the device.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the model number.
+   */
+  model(): Promise<string | 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 | undefined>} A Promise that resolves with the PnP ID.
+   */
+  pnp(): Promise<string | undefined>
+
+  /**
+   * Retrieves software version from the device.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the software version.
+   */
+  software(): Promise<string | undefined>
+
+  /**
+   * Retrieves system id from the device.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the system id.
+   */
+  system(): Promise<string | undefined>
+}