@hangtime/grip-connect 0.4.2 → 0.5.1

package/README.md

@@ -4,10 +4,12 @@
 
 The objective of this project is to create a Web Bluetooth API client that can establish connections with various
 Force-Sensing Hangboards / Dynamometers / Plates / LED system boards used by climbers. Examples of such tools include
-the [Griptonite Motherboard](https://griptonite.io/shop/motherboard/), [Climbro](https://climbro.com/),
-[mySmartBoard](https://www.smartboard-climbing.com/), [Entralpi](https://entralpi.com/),
-[Tindeq Progressor](https://tindeq.com/) or
-[Weiheng WH-C06](https://weihengmanufacturer.com/products/wh-c06-bluetooth-300kg-hanging-scale/).
+the [Griptonite Motherboard](https://griptonite.io/shop/motherboard/),
+[Tindeq Progressor](https://tindeq.com/product/progressor/),
+[PitchSix Force Board](https://pitchsix.com/products/force-board-portable),
+[Weiheng WH-C06](https://weihengmanufacturer.com/products/wh-c06-bluetooth-300kg-hanging-scale/),
+[Entralpi](https://entralpi.com/), [Climbro](https://climbro.com/), or
+[mySmartBoard](https://www.smartboard-climbing.com/)
 
 And LED system boards from [Aurora Climbing](https://auroraclimbing.com/) like the
 [Kilter Board](https://settercloset.com/pages/the-kilter-board),
@@ -16,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
@@ -29,6 +31,8 @@ Learn more: [Docs](https://stevie-ray.github.io/hangtime-grip-connect/) -
 [Chart](https://grip-connect.vercel.app/) - [Flappy Bird](https://grip-connect-flappy-bird.vercel.app/) -
 [Kilter Board](https://grip-connect-kilter-board.vercel.app/?route=p1083r15p1117r15p1164r12p1185r12p1233r13p1282r13p1303r13p1372r13p1392r14p1505r15)
 
+![Force-Sensing Climbing Devices](https://github.com/user-attachments/assets/c1a8ef3b-8d94-47b6-84a6-f73893e948d6)
+
 ## Install
 
 This project can be found in the [NPM package registry](https://www.npmjs.com/package/@hangtime/grip-connect).
@@ -46,16 +50,18 @@ Simply importing the utilities you need from `@hangtime/grip-connect`.
 ```
 
 ```js
-import { Motherboard, active, battery, connect, disconnect, firmware, notify, stream } from "@hangtime/grip-connect"
+import { Motherboard, active } from "@hangtime/grip-connect"
 
 const motherboardButton = document.querySelector("#motherboard")
 
 motherboardButton.addEventListener("click", () => {
-  connect(
-    Motherboard,
+  // setup device
+  const motherboard = new Motherboard()
+  // connect to device
+  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)
       })
@@ -69,37 +75,36 @@ motherboardButton.addEventListener("click", () => {
         { threshold: 2.5, duration: 1000 },
       )
 
-      // Read info: battery + firmware
-      const batteryLevel = await battery(Motherboard)
+      // Read device specific data: battery + firmware
+      const batteryLevel = await motherboard.battery()
       console.log(batteryLevel)
 
-      const firmwareVersion = await firmware(Motherboard)
+      const firmwareVersion = await motherboard.firmware()
       console.log(firmwareVersion)
 
       // LEDs: "green", "red", "orange", or no argument to turn off
-      // await led(Motherboard, "red")
-      // await led(Motherboard)
+      // await motherboard.led(Motherboard, "red")
+      // await motherboard.led(Motherboard)
 
       // Start weight streaming (for a minute) remove parameter for a continues stream
-      await stream(Motherboard, 60000)
+      await motherboard.stream(60000)
 
       // Manualy tare the device when the stream is running
       // 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')
-
-      // Disconnect from device after we are done
-      disconnect(Motherboard)
     },
     (error) => {
       // Optinal custom error handeling
       console.error(error.message)
     },
   )
+  // Disconnect from device after we are done
+  motherboard.disconnect(Motherboard)
 })
 ```
 
@@ -111,38 +116,30 @@ motherboardButton.addEventListener("click", () => {
   - 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 (not verified)
+- ✅ Entralpi / Lefu Scale
+- ⏳ PitchSix Force Board
 - ➡️ Climbro
 - ➡️ Smartboard Climbing - mySmartBoard
 
 ## 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 | 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)         | ✅          |            |        |          |              |         |              |
-| [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) | ✅          |            |        |          |              |         |              |
-| [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)             | ✅          |            |        |          |              |         |              |
-| [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)               | ✅          | ✅         |        |          |              |         |              |
+|                                                                                   | [Motherboard](https://stevie-ray.github.io/hangtime-grip-connect/devices/motherboard.html) | [Progressor](https://stevie-ray.github.io/hangtime-grip-connect/devices/progressor.html) | [WH-C06](https://stevie-ray.github.io/hangtime-grip-connect/devices/wh-c06.html) | [Entralpi](https://stevie-ray.github.io/hangtime-grip-connect/devices/entralpi.html) | [Kilter Board](https://stevie-ray.github.io/hangtime-grip-connect/devices/kilterboard.html) | [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) | [mySmartBoard](https://stevie-ray.github.io/hangtime-grip-connect/devices/mysmartboard.html) |
+| --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
+| [Download](https://stevie-ray.github.io/hangtime-grip-connect/api/download.html)  | ✅                                                                                         | ✅                                                                                       |                                                                                  |                                                                                      |                                                                                             |                                                                                           |                                                                                    |                                                                                              |
+| [isActive](https://stevie-ray.github.io/hangtime-grip-connect/api/is-active.html) | ✅                                                                                         | ✅                                                                                       | ✅                                                                               | ✅                                                                                   |                                                                                             |                                                                                           |                                                                                    |                                                                                              |
+| [isDevice](https://stevie-ray.github.io/hangtime-grip-connect/api/is-device.html) | ✅                                                                                         | ✅                                                                                       | ✅                                                                               | ✅                                                                                   | ✅                                                                                          | ✅                                                                                        |                                                                                    |                                                                                              |
+| [Read](https://stevie-ray.github.io/hangtime-grip-connect/api/read.html)          | ✅                                                                                         |                                                                                          |                                                                                  | ✅                                                                                   |                                                                                             | ✅                                                                                        |                                                                                    |                                                                                              |
+| [Tare](https://stevie-ray.github.io/hangtime-grip-connect/api/tare.html)          | ✅                                                                                         | ✅                                                                                       | ✅                                                                               | ✅                                                                                   |                                                                                             |                                                                                           |                                                                                    |                                                                                              |
+| [Write](https://stevie-ray.github.io/hangtime-grip-connect/api/write.html)        | ✅                                                                                         | ✅                                                                                       |                                                                                  |                                                                                      | ✅                                                                                          |                                                                                           |                                                                                    |                                                                                              |
 
 ## Development
 
@@ -168,7 +165,7 @@ A special thank you to:
 - [@1-max-1](https://github.com/1-max-1) for the docs on his Kilter Board
   [simulator](https://github.com/1-max-1/fake_kilter_board) that I coverted to
   [hangtime-arduino-kilterboard](https://github.com/Stevie-Ray/hangtime-arduino-kilterboard).
-- [@sebws](https://github.com/sebw) for a [code sample](https://github.com/sebws/Crane) of the Weiheng WH-C06 App.
+- [@sebws](https://github.com/sebws) for a [code sample](https://github.com/sebws/Crane) of the Weiheng WH-C06 App.
 
 ## Disclaimer
 

package/dist/characteristic.d.ts

@@ -1,4 +1,4 @@
-import type { Device } from "./types/devices";
+import type { Device } from "./models/device.model";
 /**
  * Retrieves the characteristic from the device's service.
  * @param {Device} board - The device.

package/dist/commands/forceboard.d.ts

@@ -0,0 +1,6 @@
+import type { Commands } from "../types/commands";
+/**
+ * Warning:
+ * Using other commands can seriously harm your device
+ */
+export declare const ForceBoardCommands: Commands;

package/dist/commands/forceboard.js

@@ -0,0 +1,5 @@
+/**
+ * Warning:
+ * Using other commands can seriously harm your device
+ */
+export const ForceBoardCommands = {};

package/dist/commands/index.d.ts

@@ -1,6 +1,7 @@
 export { ClimbroCommands } from "./climbro";
 export { EntralpiCommands } from "./entralpi";
+export { ForceBoardCommands } from "./forceboard";
 export { MotherboardCommands } from "./motherboard";
-export { WHC06Commands } from "./wh-c06";
-export { ProgressorCommands } from "./progressor";
 export { mySmartBoardCommands } from "./mysmartboard";
+export { ProgressorCommands } from "./progressor";
+export { WHC06Commands } from "./wh-c06";

package/dist/commands/index.js

@@ -1,6 +1,7 @@
 export { ClimbroCommands } from "./climbro";
 export { EntralpiCommands } from "./entralpi";
+export { ForceBoardCommands } from "./forceboard";
 export { MotherboardCommands } from "./motherboard";
-export { WHC06Commands } from "./wh-c06";
-export { ProgressorCommands } from "./progressor";
 export { mySmartBoardCommands } from "./mysmartboard";
+export { ProgressorCommands } from "./progressor";
+export { WHC06Commands } from "./wh-c06";

package/dist/index.d.ts

@@ -1,19 +1,5 @@
-export { Climbro, Entralpi, KilterBoard, Motherboard, mySmartBoard, WHC06, Progressor } from "./devices/index";
+export { Climbro, Entralpi, ForceBoard, KilterBoard, Motherboard, mySmartBoard, WHC06, Progressor, } from "./models/index";
 export { isEntralpi, isKilterboard, isMotherboard, isWHC06, isProgressor } from "./is-device";
-export { calibration } from "./calibration";
 export { download } from "./download";
-export { connect } from "./connect";
-export { disconnect } from "./disconnect";
 export { active, isActive } from "./is-active";
-export { isConnected } from "./is-connected";
-export { battery } from "./battery";
-export { firmware } from "./firmware";
-export { hardware } from "./hardware";
-export { manufacturer } from "./manufacturer";
-export { text } from "./text";
-export { serial } from "./serial";
-export { led } from "./led";
-export { notify } from "./notify";
-export { stop } from "./stop";
-export { stream } from "./stream";
 export { tare } from "./tare";

package/dist/index.js

@@ -1,29 +1,7 @@
-// Export device types
-export { Climbro, Entralpi, KilterBoard, Motherboard, mySmartBoard, WHC06, Progressor } from "./devices/index";
-// Export isDevice functions
+export { Climbro, Entralpi, ForceBoard, KilterBoard, Motherboard, mySmartBoard, WHC06, Progressor, } from "./models/index";
+// helpers
 export { isEntralpi, isKilterboard, isMotherboard, isWHC06, isProgressor } from "./is-device";
-// Export calibration function
-export { calibration } from "./calibration";
-// Export download function
+// functions
 export { download } from "./download";
-// Export connection related functions
-export { connect } from "./connect";
-export { disconnect } from "./disconnect";
 export { active, isActive } from "./is-active";
-export { isConnected } from "./is-connected";
-// Export information retrieval functions
-export { battery } from "./battery";
-export { firmware } from "./firmware";
-// Export "Motherboard exclusive" functions
-export { hardware } from "./hardware";
-export { manufacturer } from "./manufacturer";
-export { text } from "./text";
-export { serial } from "./serial";
-// Export led retrieval function
-export { led } from "./led";
-// Export notification related function
-export { notify } from "./notify";
-// Export stream related functions
-export { stop } from "./stop";
-export { stream } from "./stream";
 export { tare } from "./tare";

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

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

@@ -0,0 +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/climbro.interface.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +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/entralpi.interface.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +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/forceboard.interface.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +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/kilterboard.interface.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +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 {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/motherboard.interface.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +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/mysmartboard.interface.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +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/progressor.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/device/wh-c06.interface.d.ts

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

package/dist/interfaces/device/wh-c06.interface.js

@@ -0,0 +1 @@
+export {};