@hangtime/grip-connect 0.5.0 → 0.5.2

package/README.md

@@ -18,7 +18,7 @@ And LED system boards from [Aurora Climbing](https://auroraclimbing.com/) like t
 [Decoy Board](https://decoy-holds.com/pages/decoy-board), [Touchstone Board](https://touchstoneboardapp.com/) and
 [So iLL Board](https://apps.apple.com/us/app/so-ill-board/id1358056082).
 
-Learn more: [Docs](https://stevie-ray.github.io/hangtime-grip-connect/) -
+Learn more: [Documentation](https://stevie-ray.github.io/hangtime-grip-connect/) -
 [Browser Support](https://caniuse.com/web-bluetooth)
 
 > This project is provided "as-is" without any express or implied warranties. By using this software, you assume all
@@ -50,7 +50,7 @@ Simply importing the utilities you need from `@hangtime/grip-connect`.
 ```
 
 ```js
-import { Motherboard, active, connect, disconnect, notify } from "@hangtime/grip-connect"
+import { Motherboard, active } from "@hangtime/grip-connect"
 
 const motherboardButton = document.querySelector("#motherboard")
 
@@ -61,7 +61,7 @@ motherboardButton.addEventListener("click", () => {
   motherboard.connect(
     async () => {
       // Listen for stream notifications
-      notify((data) => {
+      motherboard.notify((data) => {
         // { massTotal: "0", massMax: "0", massAverage: "0", massLeft: "0", massCenter: "0", massRight: "0" }
         console.log(data)
       })
@@ -93,7 +93,7 @@ motherboardButton.addEventListener("click", () => {
       // await tare(5000)
 
       // Manually call stop method if stream is continues
-      // await stop(Motherboard)
+      // await motherboard.stop()
 
       // Download data as CSV, JSON, or XML (default: CSV) format => timestamp, frame, battery, samples, masses
       // download('json')
@@ -110,49 +110,28 @@ motherboardButton.addEventListener("click", () => {
 
 ## Device support
 
-- ✅ Griptonite - Motherboard
-- ✅ Tindeq - Progressor
-- ✅ Weiheng - WH-C06
+- ✅ [Griptonite - Motherboard](https://stevie-ray.github.io/hangtime-grip-connect/devices/motherboard.html)
+- ✅ [Tindeq - Progressor](https://stevie-ray.github.io/hangtime-grip-connect/devices/progressor.html)
+- ✅ [Weiheng - WH-C06](https://stevie-ray.github.io/hangtime-grip-connect/devices/wh-c06.html)
   - By default [watchAdvertisements](https://chromestatus.com/feature/5180688812736512) isn't supported . For Chrome,
     enable it at `chrome://flags/#enable-experimental-web-platform-features`.
-- ✅ Kilter Board
-- ✅ Entralpi / Lefu Scale
-- ⏳ PitchSix Force Board
-- ➡️ Climbro
-- ➡️ Smartboard Climbing - mySmartBoard
+- ✅ [Kilter Board](https://stevie-ray.github.io/hangtime-grip-connect/devices/kilterboard.html)
+- ✅ [Entralpi](https://stevie-ray.github.io/hangtime-grip-connect/devices/entralpi.html) / Lefu Scale
+- ⏳ [PitchSix Force Board](https://stevie-ray.github.io/hangtime-grip-connect/devices/forceboard.html)
+- ➡️ [Climbro](https://stevie-ray.github.io/hangtime-grip-connect/devices/climbro.html)
+- ➡️ [Smartboard Climbing - mySmartBoard](https://stevie-ray.github.io/hangtime-grip-connect/devices/mysmartboard.html)
 
 ## Features
 
+All devices provide some default features such as `connect`, `isConnected`, and `disconnect`. Additionally, each device
+offers specific features—refer to the [documentation](https://stevie-ray.github.io/hangtime-grip-connect/devices/) for
+more details on individual devices. There are also extra features that are not part of the device itself, like a
+reactive `isActive` check and a `download` feature.
+
 **Help wanted:** Do you own any of the missing devices? Use Google Chrome's Bluetooth Internals
 `chrome://bluetooth-internals/#devices` and press `Start Scan` to look for your device, click on `Inspect` and share all
 available services with us.
 
-|                                                                                          | Motherboard | Progressor | WH-C06 | Entralpi | Kilter Board | Force Board | Climbro | mySmartBoard |
-| ---------------------------------------------------------------------------------------- | ----------- | ---------- | ------ | -------- | ------------ | ----------- | ------- | ------------ |
-| [Battery](https://stevie-ray.github.io/hangtime-grip-connect/api/battery.html)           | ✅          | ✅         |        | ✅       |              | ✅          |         |              |
-| [Calibration](https://stevie-ray.github.io/hangtime-grip-connect/api/calibration.html)   | ✅          |            |        |          |              |             |         |              |
-| [Connect](https://stevie-ray.github.io/hangtime-grip-connect/api/connect.html)           | ✅          | ✅         | ✅     | ✅       | ✅           | ✅          |         |              |
-| [Disconnect](https://stevie-ray.github.io/hangtime-grip-connect/api/disconnect.html)     | ✅          | ✅         | ✅     | ✅       | ✅           |             |         |              |
-| [Download](https://stevie-ray.github.io/hangtime-grip-connect/api/download.html)         | ✅          | ✅         |        |          |              |             |         |              |
-| [Firmware](https://stevie-ray.github.io/hangtime-grip-connect/api/firmware.html)         | ✅          | ✅         |        | ✅       |              |             |         |              |
-| [Hardware](https://stevie-ray.github.io/hangtime-grip-connect/api/hardware.html)         | ✅          |            |        | ✅       |              |             |         |              |
-| [Humidity](https://stevie-ray.github.io/hangtime-grip-connect/api/humidity.html)         |             |            |        |          |              | ✅          |         |              |
-| [isActive](https://stevie-ray.github.io/hangtime-grip-connect/api/is-active.html)        | ✅          | ✅         | ✅     | ✅       |              |             |         |              |
-| [isConnected](https://stevie-ray.github.io/hangtime-grip-connect/api/is-connected.html)  | ✅          | ✅         | ✅     | ✅       | ✅           |             |         |              |
-| [isDevice](https://stevie-ray.github.io/hangtime-grip-connect/api/is-device.html)        | ✅          | ✅         | ✅     | ✅       | ✅           |             |         |              |
-| [Led](https://stevie-ray.github.io/hangtime-grip-connect/api/led.html)                   | ✅          |            |        |          | ✅           |             |         |              |
-| [Manufacturer](https://stevie-ray.github.io/hangtime-grip-connect/api/manufacturer.html) | ✅          |            |        | ✅       |              | ✅          |         |              |
-| [Model](#)                                                                               |             |            |        | ✅       |              |             |         |              |
-| [Notify](https://stevie-ray.github.io/hangtime-grip-connect/api/notify.html)             | ✅          | ✅         | ✅     | ✅       |              |             |         |              |
-| [Read](https://stevie-ray.github.io/hangtime-grip-connect/api/read.html)                 | ✅          |            |        |          |              |             |         |              |
-| [Serial](https://stevie-ray.github.io/hangtime-grip-connect/api/serial.html)             | ✅          |            |        |          |              |             |         |              |
-| [Software](#)                                                                            |             |            |        | ✅       |              |             |         |              |
-| [Stop](https://stevie-ray.github.io/hangtime-grip-connect/api/stop.html)                 | ✅          | ✅         |        |          |              |             |         |              |
-| [Stream](https://stevie-ray.github.io/hangtime-grip-connect/api/stream.html)             | ✅          | ✅         |        |          |              |             |         |              |
-| [Tare](https://stevie-ray.github.io/hangtime-grip-connect/api/tare.html)                 | ✅          | ✅         | ✅     | ✅       |              |             |         |              |
-| [Text](https://stevie-ray.github.io/hangtime-grip-connect/api/text.html)                 | ✅          |            |        |          |              |             |         |              |
-| [Write](https://stevie-ray.github.io/hangtime-grip-connect/api/write.html)               | ✅          | ✅         |        |          |              |             |         |              |
-
 ## Development
 
 ```bash

package/dist/{is-device.d.ts → helpers/is-device.d.ts}

@@ -1,4 +1,4 @@
-import type { Device } from "./models/device.model";
+import type { Device } from "./../models/device.model";
 /**
  * Checks if the given device is an Entralpi device.
  * @param {Device} [board] - The device to check.

package/dist/{is-device.js → helpers/is-device.js}

@@ -1,4 +1,4 @@
-import { AuroraUUID } from "./models/device/kilterboard.model";
+import { AuroraUUID } from "./../models/device/kilterboard.model";
 /**
  * Checks if the given device is an Entralpi device.
  * @param {Device} [board] - The device to check.

package/dist/index.d.ts

@@ -1,7 +1,5 @@
 export { Climbro, Entralpi, ForceBoard, KilterBoard, Motherboard, mySmartBoard, WHC06, Progressor, } from "./models/index";
-export { isEntralpi, isKilterboard, isMotherboard, isWHC06, isProgressor } from "./is-device";
+export { isEntralpi, isKilterboard, isMotherboard, isWHC06, isProgressor } from "./helpers/is-device";
 export { download } from "./download";
 export { active, isActive } from "./is-active";
-export { notify } from "./notify";
-export { stop } from "./stop";
 export { tare } from "./tare";

package/dist/index.js

@@ -1,9 +1,7 @@
 export { Climbro, Entralpi, ForceBoard, KilterBoard, Motherboard, mySmartBoard, WHC06, Progressor, } from "./models/index";
 // helpers
-export { isEntralpi, isKilterboard, isMotherboard, isWHC06, isProgressor } from "./is-device";
-// functions
+export { isEntralpi, isKilterboard, isMotherboard, isWHC06, isProgressor } from "./helpers/is-device";
+// TODO: Make functions device specific
 export { download } from "./download";
 export { active, isActive } from "./is-active";
-export { notify } from "./notify";
-export { stop } from "./stop";
 export { tare } from "./tare";

package/dist/interfaces/base.interface.d.ts

@@ -1,5 +1,17 @@
+/**
+ * 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/dist/interfaces/device/climbro.interface.d.ts

@@ -1,3 +1,6 @@
 import type { IDevice } from "../device.interface";
+/**
+ * Interface representing the Climbro device, extending the base Device interface.
+ */
 export interface IClimbro extends IDevice {
 }

package/dist/interfaces/device/entralpi.interface.d.ts

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

package/dist/interfaces/device/forceboard.interface.d.ts

@@ -1,3 +1,21 @@
 import type { IDevice } from "../device.interface";
+/**
+ * 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/dist/interfaces/device/kilterboard.interface.d.ts

@@ -1,3 +1,76 @@
 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/dist/interfaces/device/motherboard.interface.d.ts

@@ -1,10 +1,60 @@
 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/dist/interfaces/device/mysmartboard.interface.d.ts

@@ -1,3 +1,6 @@
 import type { IDevice } from "../device.interface";
+/**
+ * Interface representing the mySmartBoard device, extending the base Device interface.
+ */
 export interface ImySmartBoard extends IDevice {
 }

package/dist/interfaces/device/progressor.interface.d.ts

@@ -1,3 +1,27 @@
 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/dist/interfaces/device/wh-c06.interface.d.ts

@@ -1,3 +1,6 @@
 import type { IDevice } from "../device.interface";
+/**
+ * Interface representing the Weiheng WH-C06 device.
+ */
 export interface IWHC06 extends IDevice {
 }

package/dist/interfaces/device.interface.d.ts

@@ -1,4 +1,5 @@
 import type { IBase } from "./base.interface";
+import type { massObject } from "../types/notify";
 /**
  * Represents a characteristic of a Bluetooth service.
  */
@@ -36,41 +37,96 @@ export interface IDevice extends IBase {
     /** Reference to the BluetoothDevice object representing this device */
     bluetooth?: BluetoothDevice;
     /**
-     * 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: Event): void;
+    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[];
+    /**
+     * 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.
      */
     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: (data: massObject) => void): void;
+    /**
+     * Defines the type for the callback function.
+     * @callback NotifyCallback
+     * @param {massObject} data - The data passed to the callback.
+     */
+    notifyCallback: (data: massObject) => void;
     /**
      * Handles the 'connected' event.
      * @param {Function} onSuccess - Callback function to execute on successful connection.
      */
     onConnected(onSuccess: () => void): Promise<void>;
     /**
-     * Returns UUIDs of all services associated with the device.
-     * @returns {string[]} Array of service UUIDs.
+     * Handles the 'disconnected' event.
+     * @param {Event} event - The 'disconnected' event.
      */
-    getAllServiceUUIDs(): string[];
+    onDisconnected(event: Event): void;
     /**
-     * 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.
+     * 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.
      */
-    connect(onSuccess?: () => void, onError?: (error: Error) => void): Promise<void>;
+    read(serviceId: string, characteristicId: string, duration?: number): Promise<string>;
     /**
-     * Checks if a Bluetooth device is connected.
-     * @returns {boolean} A boolean indicating whether the device is connected.
+     * 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}`);
+     * });
      */
-    isConnected(): boolean;
+    write(serviceId: string, characteristicId: string, message: string | Uint8Array | undefined, duration?: number, callback?: (data: string) => 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.
+     * A default write callback that logs the response
      */
-    disconnect(): void;
+    writeCallback: (data: string) => void;
+    /**
+     * The last message written to the device.
+     * @type {string | Uint8Array | null}
+     */
+    writeLast: string | Uint8Array | null;
 }
 export {};

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

@@ -4,12 +4,17 @@ export declare class Entralpi extends Device implements IEntralpi {
     constructor();
     /**
      * 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: () => Promise<string | undefined>;
+    /**
+     * Retrieves IEEE 11073-20601 Regulatory Certification from the device.
+     * @returns {Promise<string>} A Promise that resolves with the certification.
+     */
+    certification: () => Promise<string | 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: () => Promise<string | undefined>;
     /**
@@ -22,22 +27,33 @@ export declare class Entralpi extends Device implements IEntralpi {
     handleNotifications: (event: Event) => void;
     /**
      * 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: () => Promise<string | undefined>;
     /**
      * 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: () => Promise<string | undefined>;
     /**
      * 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: () => 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>} A Promise that resolves with the PnP ID.
+     */
+    pnp: () => Promise<string | 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: () => Promise<string | undefined>;
+    /**
+     * Retrieves system id from the device.
+     * @returns {Promise<string>} A Promise that resolves with the system id.
+     */
+    system: () => Promise<string | undefined>;
 }