@hangtime/grip-connect 0.4.1 → 0.5.0

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),
@@ -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,13 +50,15 @@ 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, connect, disconnect, notify } 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) => {
@@ -60,24 +66,28 @@ motherboardButton.addEventListener("click", () => {
         console.log(data)
       })
 
-      // Check if device is being used
-      active((value) => {
-        console.log(value)
-      })
-
-      // Read info: battery + firmware
-      const batteryLevel = await battery(Motherboard)
+      // Reactive check if device is active
+      active(
+        (isActive) => {
+          console.log(isActive)
+        },
+        // Optionally using a weight threshold and duration
+        { threshold: 2.5, duration: 1000 },
+      )
+
+      // 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)
@@ -87,15 +97,14 @@ motherboardButton.addEventListener("click", () => {
 
       // 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)
 })
 ```
 
@@ -107,7 +116,8 @@ 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
 
@@ -117,28 +127,31 @@ motherboardButton.addEventListener("click", () => {
 `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 | 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
 
@@ -164,7 +177,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/characteristic.js

@@ -17,4 +17,5 @@ export const getCharacteristic = (board, serviceId, characteristicId) => {
         }
     }
     // Return undefined if the service or characteristic is not found
+    return undefined;
 };

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,7 @@
-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,9 @@
-// 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,5 @@
+export interface IBase {
+    id?: string;
+    createdAt?: Date;
+    updatedAt?: Date;
+}

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

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

package/dist/interfaces/device/entralpi.interface.js

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

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

@@ -0,0 +1,3 @@
+import type { IDevice } from "../device.interface";
+export interface IForceBoard extends IDevice {
+}

package/dist/interfaces/device/forceboard.interface.js

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

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

@@ -0,0 +1,3 @@
+import type { IDevice } from "../device.interface";
+export interface IKilterBoard extends IDevice {
+}

package/dist/interfaces/device/kilterboard.interface.js

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

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

@@ -0,0 +1,10 @@
+import type { IDevice } from "../device.interface";
+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.
+     */
+    applyCalibration(sample: number, calibration: number[][]): number;
+}

package/dist/interfaces/device/motherboard.interface.js

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

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

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

package/dist/interfaces/device/progressor.interface.js

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

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

@@ -0,0 +1,3 @@
+import type { IDevice } from "../device.interface";
+export interface IWHC06 extends IDevice {
+}

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

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

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

@@ -0,0 +1,76 @@
+import type { IBase } from "./base.interface";
+/**
+ * Represents a characteristic of a Bluetooth service.
+ */
+interface Characteristic {
+    /** Name of the characteristic */
+    name: string;
+    /** Identifier of the characteristic */
+    id: string;
+    /** UUID of the characteristic */
+    uuid: string;
+    /** Reference to the characteristic object */
+    characteristic?: BluetoothRemoteGATTCharacteristic;
+}
+/**
+ * Represents a Bluetooth service.
+ */
+export interface Service {
+    /**  Name of the service */
+    name: string;
+    /** Identifier of the service */
+    id: string;
+    /** UUID of the service */
+    uuid: string;
+    /** Array of characteristics belonging to this service */
+    characteristics: Characteristic[];
+}
+/**
+ * Represents a Bluetooth device.
+ */
+export interface IDevice extends IBase {
+    /** Filters to indentify the device */
+    filters: BluetoothLEScanFilter[];
+    /** Array of services provided by the device */
+    services: Service[];
+    /** Reference to the BluetoothDevice object representing this device */
+    bluetooth?: BluetoothDevice;
+    /**
+     * 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.
+     */
+    handleNotifications(event: Event): 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.
+     */
+    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.
+     */
+    connect(onSuccess?: () => void, onError?: (error: Error) => void): Promise<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.
+     */
+    disconnect(): void;
+}
+export {};

package/dist/interfaces/device.interface.js

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

package/dist/is-active.d.ts

@@ -9,16 +9,24 @@ type IsActiveCallback = (value: boolean) => void;
  */
 export declare let isActive: boolean;
 /**
- * Sets the callback function to be called when the activity status changes.
+ * Sets the callback function to be called when the activity status changes,
+ * and optionally sets the configuration for threshold and duration.
  *
  * This function allows you to specify a callback that will be invoked whenever
  * the activity status changes, indicating whether the device is currently active.
+ * It also allows optionally configuring the threshold and duration used to determine activity.
  *
  * @param {IsActiveCallback} callback - The callback function to be set. This function
  *                                      receives a boolean value indicating the new activity status.
+ * @param {object} [options] - Optional configuration object containing the threshold and duration.
+ * @param {number} [options.threshold=2.5] - The threshold value for determining activity.
+ * @param {number} [options.duration=1000] - The duration (in milliseconds) to monitor the input for activity.
  * @returns {void}
  */
-export declare const active: (callback: IsActiveCallback) => void;
+export declare const active: (callback: IsActiveCallback, options?: {
+    threshold?: number;
+    duration?: number;
+}) => void;
 /**
  * Checks if a dynamic value is active based on a threshold and duration.
  *
@@ -27,11 +35,7 @@ export declare const active: (callback: IsActiveCallback) => void;
  * the previous state, the callback function is called with the updated activity status.
  *
  * @param {number} input - The dynamic value to check for activity status.
- * @param {number} [threshold=2.5] - The threshold value to determine if the input is considered active.
- *                                    Defaults to 2.5 if not provided.
- * @param {number} [duration=1000] - The duration (in milliseconds) to monitor the input for activity.
- *                                    Defaults to 1000 milliseconds if not provided.
  * @returns {Promise<void>} A promise that resolves once the activity check is complete.
  */
-export declare const checkActivity: (input: number, threshold?: number, duration?: number) => Promise<void>;
+export declare const checkActivity: (input: number) => Promise<void>;
 export {};

package/dist/is-active.js

@@ -5,17 +5,31 @@ let activeCallback;
  */
 export let isActive = false;
 /**
- * Sets the callback function to be called when the activity status changes.
+ * Configuration for threshold and duration.
+ */
+let config = { threshold: 2.5, duration: 1000 };
+/**
+ * Sets the callback function to be called when the activity status changes,
+ * and optionally sets the configuration for threshold and duration.
  *
  * This function allows you to specify a callback that will be invoked whenever
  * the activity status changes, indicating whether the device is currently active.
+ * It also allows optionally configuring the threshold and duration used to determine activity.
  *
  * @param {IsActiveCallback} callback - The callback function to be set. This function
  *                                      receives a boolean value indicating the new activity status.
+ * @param {object} [options] - Optional configuration object containing the threshold and duration.
+ * @param {number} [options.threshold=2.5] - The threshold value for determining activity.
+ * @param {number} [options.duration=1000] - The duration (in milliseconds) to monitor the input for activity.
  * @returns {void}
  */
-export const active = (callback) => {
+export const active = (callback, options) => {
     activeCallback = callback;
+    // Update the config values only if provided, otherwise use defaults
+    config = {
+        threshold: options?.threshold ?? config.threshold, // Use new threshold if provided, else use default
+        duration: options?.duration ?? config.duration, // Use new duration if provided, else use default
+    };
 };
 /**
  * Checks if a dynamic value is active based on a threshold and duration.
@@ -25,18 +39,14 @@ export const active = (callback) => {
  * the previous state, the callback function is called with the updated activity status.
  *
  * @param {number} input - The dynamic value to check for activity status.
- * @param {number} [threshold=2.5] - The threshold value to determine if the input is considered active.
- *                                    Defaults to 2.5 if not provided.
- * @param {number} [duration=1000] - The duration (in milliseconds) to monitor the input for activity.
- *                                    Defaults to 1000 milliseconds if not provided.
  * @returns {Promise<void>} A promise that resolves once the activity check is complete.
  */
-export const checkActivity = (input, threshold = 2.5, duration = 1000) => {
+export const checkActivity = (input) => {
     return new Promise((resolve) => {
         // Check the activity status after the specified duration
         setTimeout(() => {
-            // Determine the activity status based on the threshold
-            const activeNow = input > threshold;
+            // Determine the activity status based on the stored threshold in the config
+            const activeNow = input > config.threshold;
             if (isActive !== activeNow) {
                 isActive = activeNow;
                 if (activeCallback) {
@@ -44,6 +54,6 @@ export const checkActivity = (input, threshold = 2.5, duration = 1000) => {
                 }
             }
             resolve();
-        }, duration);
+        }, config.duration);
     });
 };

package/dist/is-device.d.ts

@@ -1,28 +1,34 @@
-import type { Device } from "./types/devices";
-/**
- * Checks if the given device is a Motherboard.
- * @param {Device} [board] - The device to check.
- * @returns {boolean} `true` if the device has a filter with the name "Motherboard", otherwise `false`.
- */
-export declare const isMotherboard: (board?: Device) => boolean;
-/**
- * Checks if the given device is a Progressor.
- * @param {Device} [board] - The device to check.
- * @returns {boolean} `true` if the device has a filter with a namePrefix of "Progressor", otherwise `false`.
- */
-export declare const isProgressor: (board?: Device) => boolean;
+import type { Device } from "./models/device.model";
 /**
  * Checks if the given device is an Entralpi device.
  * @param {Device} [board] - The device to check.
  * @returns {boolean} `true` if the device has a filter with the name "ENTRALPI", otherwise `false`.
  */
 export declare const isEntralpi: (board?: Device) => boolean;
+/**
+ * Checks if the given device is a Force Board.
+ * @param {Device} [board] - The device to check.
+ * @returns {boolean} `true` if the device has a filter with the name "Force Board", otherwise `false`.
+ */
+export declare const isForceBoard: (board?: Device) => boolean;
 /**
  * Checks if the given device is a Kilterboard.
  * @param {Device} [board] - The device to check.
  * @returns {boolean} `true` if the device has a service UUID matching the Kilterboard Aurora UUID, otherwise `false`.
  */
 export declare const isKilterboard: (board?: Device) => boolean;
+/**
+ * Checks if the given device is a Motherboard.
+ * @param {Device} [board] - The device to check.
+ * @returns {boolean} `true` if the device has a filter with the name "Motherboard", otherwise `false`.
+ */
+export declare const isMotherboard: (board?: Device) => boolean;
+/**
+ * Checks if the given device is a Progressor.
+ * @param {Device} [board] - The device to check.
+ * @returns {boolean} `true` if the device has a filter with a namePrefix of "Progressor", otherwise `false`.
+ */
+export declare const isProgressor: (board?: Device) => boolean;
 /**
  * Checks if the given device is a WH-C06.
  * @param {Device} [board] - The device to check.