@hangtime/grip-connect 0.5.11 → 0.6.1

package/README.md

@@ -35,13 +35,22 @@ Learn more: [Documentation](https://stevie-ray.github.io/hangtime-grip-connect/)
 
 ## Install
 
-This project can be found in the [NPM](https://www.npmjs.com/package/@hangtime/grip-connect) and
-[JSR](https://jsr.io/@hangtime/grip-connect) package registries.
+This package is compatible with both Node.js and browser environments. It can be found in the
+[NPM](https://www.npmjs.com/package/@hangtime/grip-connect) and [JSR](https://jsr.io/@hangtime/grip-connect) package
+registries.
 
 ```sh [npm]
 $ npm install @hangtime/grip-connect
 ```
 
+```sh [yarn]
+$ yarn add @hangtime/grip-connect
+```
+
+```sh [pnpm]
+$ pnpm add @hangtime/grip-connect
+```
+
 ## Example usage (with a Motherboard)
 
 Simply importing the device you need from `@hangtime/grip-connect`.
@@ -93,10 +102,10 @@ document.querySelector("#motherboard").addEventListener("click", async () => {
       // await motherboard.stop()
 
       // Download data as CSV, JSON, or XML (default: CSV) format => timestamp, frame, battery, samples, masses
-      // motherboard.download('json')
+      // await motherboard.download('json')
 
       // Optionally disconnect from device after we are done
-      motherboard.disconnect(Motherboard)
+      motherboard.disconnect()
     },
     (error) => {
       // Optinal custom error handeling
@@ -115,7 +124,7 @@ document.querySelector("#motherboard").addEventListener("click", async () => {
     enable it at `chrome://flags/#enable-experimental-web-platform-features`.
 - ✅ [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 / Unique CW275 Scale
-- ✅ [PitchSix Force Board](https://stevie-ray.github.io/hangtime-grip-connect/devices/forceboard.html)
+- ✅ [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)
 

package/deno.json

@@ -1,6 +1,6 @@
 {
   "name": "@hangtime/grip-connect",
-  "version": "0.5.11",
+  "version": "0.6.1",
   "license": "BSD-2-Clause",
   "exports": {
     ".": "./src/index.ts"

package/dist/index.d.ts

@@ -1 +1,2 @@
-export { Climbro, Entralpi, ForceBoard, KilterBoard, Motherboard, mySmartBoard, Progressor, WHC06, } from "./models/index";
+export type { IClimbro, IEntralpi, IForceBoard, IKilterBoard, IMotherboard, ImySmartBoard, IProgressor, IWHC06, } from "./interfaces/index.js";
+export { Climbro, Entralpi, ForceBoard, KilterBoard, Motherboard, mySmartBoard, Progressor, WHC06, } from "./models/index.js";

package/dist/index.js

@@ -1 +1 @@
-export { Climbro, Entralpi, ForceBoard, KilterBoard, Motherboard, mySmartBoard, Progressor, WHC06, } from "./models/index";
+export { Climbro, Entralpi, ForceBoard, KilterBoard, Motherboard, mySmartBoard, Progressor, WHC06, } from "./models/index.js";

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

@@ -1,4 +1,4 @@
-import type { IDevice } from "../device.interface";
+import type { IDevice } from "../device.interface.js";
 /**
  * Interface representing the Climbro device, extending the base Device interface.
  */

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

@@ -1,4 +1,4 @@
-import type { IDevice } from "../device.interface";
+import type { IDevice } from "../device.interface.js";
 /**
  * Interface representing the Entralpi device, extending the base Device interface.
  */

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

@@ -1,4 +1,4 @@
-import type { IDevice } from "../device.interface";
+import type { IDevice } from "../device.interface.js";
 /**
  * Interface representing the PitchSix ForceBoard device, extending the base Device interface.
  */

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

@@ -1,4 +1,4 @@
-import type { IDevice } from "../device.interface";
+import type { IDevice } from "../device.interface.js";
 /**
  * Interface representing the KilterBoard device, extending the base Device interface.
  */

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

@@ -1,6 +1,6 @@
-import type { IDevice } from "../device.interface";
+import type { IDevice } from "../device.interface.js";
 /**
- * Interface representing the Griptonite Motherboard device.
+ * Interface representing the Griptonite Motherboard device, extending the base Device interface.
  */
 export interface IMotherboard extends IDevice {
     /**

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

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

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

@@ -1,6 +1,6 @@
-import type { IDevice } from "../device.interface";
+import type { IDevice } from "../device.interface.js";
 /**
- * Interface representing the Tindeq Progressor device.
+ * Interface representing the Tindeq Progressor device, extending the base Device interface.
  */
 export interface IProgressor extends IDevice {
     /**

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

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

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

@@ -1,6 +1,6 @@
-import type { IBase } from "./base.interface";
-import type { massObject } from "./callback.interface";
-import type { Commands } from "./command.interface";
+import type { IBase } from "./base.interface.js";
+import type { massObject } from "./callback.interface.js";
+import type { Commands } from "./command.interface.js";
 /**
  * Represents a characteristic of a Bluetooth service.
  */

package/dist/interfaces/index.d.ts

@@ -0,0 +1,8 @@
+export type { IClimbro } from "./device/climbro.interface.js";
+export type { IEntralpi } from "./device/entralpi.interface.js";
+export type { IForceBoard } from "./device/forceboard.interface.js";
+export type { IKilterBoard } from "./device/kilterboard.interface.js";
+export type { IMotherboard } from "./device/motherboard.interface.js";
+export type { ImySmartBoard } from "./device/mysmartboard.interface.js";
+export type { IProgressor } from "./device/progressor.interface.js";
+export type { IWHC06 } from "./device/wh-c06.interface.js";

package/dist/interfaces/index.js

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

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

@@ -1,4 +1,4 @@
-import type { IBase } from "../interfaces/base.interface";
+import type { IBase } from "../interfaces/base.interface.js";
 export declare abstract class BaseModel {
     id?: string;
     createdAt?: Date;

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

@@ -1,8 +1,9 @@
-import { Device } from "../device.model";
-import type { IClimbro } from "../../interfaces/device/climbro.interface";
+import { Device } from "../device.model.js";
+import type { IClimbro } from "../../interfaces/device/climbro.interface.js";
 /**
- * Represents a Climbro device
+ * Represents a Climbro device.
  * TODO: Add services, do you own a Climbro? Help us!
+ * {@link https://climbro.com/}
  */
 export declare class Climbro extends Device implements IClimbro {
     constructor();

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

@@ -1,7 +1,8 @@
-import { Device } from "../device.model";
+import { Device } from "../device.model.js";
 /**
- * Represents a Climbro device
+ * Represents a Climbro device.
  * TODO: Add services, do you own a Climbro? Help us!
+ * {@link https://climbro.com/}
  */
 export class Climbro extends Device {
     constructor() {

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

@@ -1,5 +1,9 @@
-import { Device } from "../device.model";
-import type { IEntralpi } from "../../interfaces/device/entralpi.interface";
+import { Device } from "../device.model.js";
+import type { IEntralpi } from "../../interfaces/device/entralpi.interface.js";
+/**
+ * Represents a Entralpi device.
+ * {@link https://entralpi.com}
+ */
 export declare class Entralpi extends Device implements IEntralpi {
     constructor();
     /**

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

@@ -1,4 +1,8 @@
-import { Device } from "../device.model";
+import { Device } from "../device.model.js";
+/**
+ * Represents a Entralpi device.
+ * {@link https://entralpi.com}
+ */
 export class Entralpi extends Device {
     constructor() {
         super({

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

@@ -1,7 +1,8 @@
-import { Device } from "../device.model";
-import type { IForceBoard } from "../../interfaces/device/forceboard.interface";
+import { Device } from "../device.model.js";
+import type { IForceBoard } from "../../interfaces/device/forceboard.interface.js";
 /**
- * Represents a PitchSix Force Board device
+ * Represents a PitchSix Force Board device.
+ * {@link https://pitchsix.com}
  */
 export declare class ForceBoard extends Device implements IForceBoard {
     constructor();

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

@@ -1,6 +1,7 @@
-import { Device } from "../device.model";
+import { Device } from "../device.model.js";
 /**
- * Represents a PitchSix Force Board device
+ * Represents a PitchSix Force Board device.
+ * {@link https://pitchsix.com}
  */
 export class ForceBoard extends Device {
     constructor() {

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

@@ -1,5 +1,5 @@
-import { Device } from "../device.model";
-import type { IKilterBoard } from "../../interfaces/device/kilterboard.interface";
+import { Device } from "../device.model.js";
+import type { IKilterBoard } from "../../interfaces/device/kilterboard.interface.js";
 /**
  * For API level 2 and API level 3.
  * The first byte in the data is dependent on where the packet is in the message as a whole.
@@ -36,8 +36,9 @@ export declare const KilterBoardPlacementRoles: {
     screen_color: string;
 }[];
 /**
- * Represents a Aurora Climbing device
+ * Represents a Aurora Climbing device.
  * Kilter Board, Tension Board, Decoy Board, Touchstone Board, Grasshopper Board, Aurora Board, So iLL Board
+ * {@link https://auroraclimbing.com}
  */
 export declare class KilterBoard extends Device implements IKilterBoard {
     /**
@@ -73,13 +74,13 @@ export declare class KilterBoard extends Device implements IKilterBoard {
     /**
      * Calculates the checksum for a byte array by summing up all bytes ot hre packet in a single-byte variable.
      * @param data - The array of bytes to calculate the checksum for.
-     * @returns The calculated checksum value.
+     * @returns {number} The calculated checksum value.
      */
     private checksum;
     /**
      * Wraps a byte array with header and footer bytes for transmission.
      * @param data - The array of bytes to wrap.
-     * @returns The wrapped byte array.
+     * @returns {number[]} The wrapped byte array.
      */
     private wrapBytes;
     /**
@@ -87,7 +88,7 @@ export declare class KilterBoard extends Device implements IKilterBoard {
      * The lowest 8 bits of the position get put in the first byte of the group.
      * The highest 8 bits of the position get put in the second byte of the group.
      * @param position - The position to encode.
-     * @returns The encoded byte array representing the position.
+     * @returns {number[]} The encoded byte array representing the position.
      */
     private encodePosition;
     /**
@@ -115,7 +116,7 @@ export declare class KilterBoard extends Device implements IKilterBoard {
      * https://github.com/ramda/ramda/blob/master/source/splitEvery.js
      * @param {Number} n
      * @param {Array} list
-     * @return {Array}
+     * @return {Array<number[]>}
      */
     private splitEvery;
     /**

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

@@ -1,4 +1,4 @@
-import { Device } from "../device.model";
+import { Device } from "../device.model.js";
 /**
  * For API level 2 and API level 3.
  * The first byte in the data is dependent on where the packet is in the message as a whole.
@@ -65,8 +65,9 @@ export const KilterBoardPlacementRoles = [
     },
 ];
 /**
- * Represents a Aurora Climbing device
+ * Represents a Aurora Climbing device.
  * Kilter Board, Tension Board, Decoy Board, Touchstone Board, Grasshopper Board, Aurora Board, So iLL Board
+ * {@link https://auroraclimbing.com}
  */
 export class KilterBoard extends Device {
     /**
@@ -129,7 +130,7 @@ export class KilterBoard extends Device {
     /**
      * Calculates the checksum for a byte array by summing up all bytes ot hre packet in a single-byte variable.
      * @param data - The array of bytes to calculate the checksum for.
-     * @returns The calculated checksum value.
+     * @returns {number} The calculated checksum value.
      */
     checksum(data) {
         let i = 0;
@@ -141,7 +142,7 @@ export class KilterBoard extends Device {
     /**
      * Wraps a byte array with header and footer bytes for transmission.
      * @param data - The array of bytes to wrap.
-     * @returns The wrapped byte array.
+     * @returns {number[]} The wrapped byte array.
      */
     wrapBytes(data) {
         if (data.length > KilterBoard.messageBodyMaxLength) {
@@ -164,7 +165,7 @@ export class KilterBoard extends Device {
      * The lowest 8 bits of the position get put in the first byte of the group.
      * The highest 8 bits of the position get put in the second byte of the group.
      * @param position - The position to encode.
-     * @returns The encoded byte array representing the position.
+     * @returns {number[]} The encoded byte array representing the position.
      */
     encodePosition(position) {
         const position1 = position & 255;
@@ -236,7 +237,7 @@ export class KilterBoard extends Device {
      * https://github.com/ramda/ramda/blob/master/source/splitEvery.js
      * @param {Number} n
      * @param {Array} list
-     * @return {Array}
+     * @return {Array<number[]>}
      */
     splitEvery(n, list) {
         if (n <= 0) {

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

@@ -1,7 +1,8 @@
-import { Device } from "../device.model";
-import type { IMotherboard } from "../../interfaces/device/motherboard.interface";
+import { Device } from "../device.model.js";
+import type { IMotherboard } from "../../interfaces/device/motherboard.interface.js";
 /**
- * Represents a Griptonite Motherboard device
+ * Represents a Griptonite Motherboard device.
+ * {@link https://griptonite.io}
  */
 export declare class Motherboard extends Device implements IMotherboard {
     /**

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

@@ -1,6 +1,7 @@
-import { Device } from "../device.model";
+import { Device } from "../device.model.js";
 /**
- * Represents a Griptonite Motherboard device
+ * Represents a Griptonite Motherboard device.
+ * {@link https://griptonite.io}
  */
 export class Motherboard extends Device {
     /**

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

@@ -1,8 +1,9 @@
-import { Device } from "../device.model";
-import type { ImySmartBoard } from "../../interfaces/device/mysmartboard.interface";
+import { Device } from "../device.model.js";
+import type { ImySmartBoard } from "../../interfaces/device/mysmartboard.interface.js";
 /**
- * Represents a mySmartBoard device
+ * Represents a Smartboard Climbing mySmartBoard device.
  * TODO: Add services, do you own a mySmartBoard? Help us!
+ * {@link https://www.smartboard-climbing.com}
  */
 export declare class mySmartBoard extends Device implements ImySmartBoard {
     constructor();

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

@@ -1,7 +1,8 @@
-import { Device } from "../device.model";
+import { Device } from "../device.model.js";
 /**
- * Represents a mySmartBoard device
+ * Represents a Smartboard Climbing mySmartBoard device.
  * TODO: Add services, do you own a mySmartBoard? Help us!
+ * {@link https://www.smartboard-climbing.com}
  */
 export class mySmartBoard extends Device {
     constructor() {

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

@@ -1,7 +1,8 @@
-import { Device } from "../device.model";
-import type { IProgressor } from "../../interfaces/device/progressor.interface";
+import { Device } from "../device.model.js";
+import type { IProgressor } from "../../interfaces/device/progressor.interface.js";
 /**
- * Represents a Tindeq Progressor device
+ * Represents a Tindeq Progressor device.
+ * {@link https://tindeq.com}
  */
 export declare class Progressor extends Device implements IProgressor {
     constructor();

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

@@ -1,6 +1,6 @@
-import { Device } from "../device.model";
+import { Device } from "../device.model.js";
 /**
- * Represents the possible responses of a Tindeq Progressor device.
+ * Progressor responses
  */
 var ProgressorResponses;
 (function (ProgressorResponses) {
@@ -31,7 +31,8 @@ var ProgressorResponses;
     ProgressorResponses[ProgressorResponses["LOW_BATTERY_WARNING"] = 4] = "LOW_BATTERY_WARNING";
 })(ProgressorResponses || (ProgressorResponses = {}));
 /**
- * Represents a Tindeq Progressor device
+ * Represents a Tindeq Progressor device.
+ * {@link https://tindeq.com}
  */
 export class Progressor extends Device {
     constructor() {

package/dist/models/device/wh-c06.model.d.ts

@@ -1,8 +1,10 @@
-import { Device } from "../device.model";
-import type { IWHC06 } from "../../interfaces/device/wh-c06.interface";
+import { Device } from "../device.model.js";
+import type { IWHC06 } from "../../interfaces/device/wh-c06.interface.js";
 /**
- * Represents a  Weiheng - WH-C06 (or MAT Muscle Meter) device
- * Enable 'Experimental Web Platform features' Chrome Flags.
+ * Represents a Weiheng - WH-C06 (or MAT Muscle Meter) device.
+ * To use this device enable: `chrome://flags/#enable-experimental-web-platform-features`.
+ * {@link https://googlechrome.github.io/samples/web-bluetooth/scan.html| Web Bluetooth}
+ * {@link https://weihengmanufacturer.com}
  */
 export declare class WHC06 extends Device implements IWHC06 {
     /**

package/dist/models/device/wh-c06.model.js

@@ -1,7 +1,9 @@
-import { Device } from "../device.model";
+import { Device } from "../device.model.js";
 /**
- * Represents a  Weiheng - WH-C06 (or MAT Muscle Meter) device
- * Enable 'Experimental Web Platform features' Chrome Flags.
+ * Represents a Weiheng - WH-C06 (or MAT Muscle Meter) device.
+ * To use this device enable: `chrome://flags/#enable-experimental-web-platform-features`.
+ * {@link https://googlechrome.github.io/samples/web-bluetooth/scan.html| Web Bluetooth}
+ * {@link https://weihengmanufacturer.com}
  */
 export class WHC06 extends Device {
     /**
@@ -65,7 +67,8 @@ export class WHC06 extends Device {
         try {
             // Only data matching the optionalManufacturerData parameter to requestDevice is included in the advertisement event: https://github.com/WebBluetoothCG/web-bluetooth/issues/598
             const optionalManufacturerData = this.filters.flatMap((filter) => filter.manufacturerData?.map((data) => data.companyIdentifier) || []);
-            this.bluetooth = await navigator.bluetooth.requestDevice({
+            const bluetooth = await this.getBluetooth();
+            this.bluetooth = await bluetooth.requestDevice({
                 filters: this.filters,
                 optionalManufacturerData,
             });

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

@@ -1,8 +1,8 @@
-import { BaseModel } from "./../models/base.model";
-import type { IDevice, Service } from "../interfaces/device.interface";
-import type { ActiveCallback, NotifyCallback, WriteCallback } from "../interfaces/callback.interface";
-import type { DownloadPacket } from "../interfaces/download.interface";
-import type { Commands } from "../interfaces/command.interface";
+import { BaseModel } from "./../models/base.model.js";
+import type { IDevice, Service } from "../interfaces/device.interface.js";
+import type { ActiveCallback, NotifyCallback, WriteCallback } from "../interfaces/callback.interface.js";
+import type { DownloadPacket } from "../interfaces/download.interface.js";
+import type { Commands } from "../interfaces/command.interface.js";
 export declare abstract class Device extends BaseModel implements IDevice {
     /**
      * Filters to identify the device during Bluetooth scanning.
@@ -257,13 +257,13 @@ export declare abstract class Device extends BaseModel implements IDevice {
      * @param {('csv' | 'json' | 'xml')} [format='csv'] - The format in which to download the data.
      * Defaults to 'csv'. Accepted values are 'csv', 'json', and 'xml'.
      *
-     * @returns {void} Initiates a download of the data in the specified format.
-     * @private
+     * @returns {Promise<void>} Resolves when the data has been downloaded/written
+     * @public
      *
      * @example
-     * device.download('json');
+     * await device.download('json');
      */
-    download: (format?: "csv" | "json" | "xml") => void;
+    download: (format?: "csv" | "json" | "xml") => Promise<void>;
     /**
      * Returns UUIDs of all services associated with the device.
      * @returns {string[]} Array of service UUIDs.
@@ -274,6 +274,12 @@ export declare abstract class Device extends BaseModel implements IDevice {
      * console.log(serviceUUIDs);
      */
     protected getAllServiceUUIDs: () => string[];
+    /**
+     * Attempt to use ES module import rather than require.
+     * This approach uses an async dynamic import for `webbluetooth`,
+     * so we can fallback if `navigator.bluetooth` is unavailable.
+     */
+    protected getBluetooth(): Promise<Bluetooth | import("webbluetooth").Bluetooth>;
     /**
      * Retrieves the characteristic from the device's service.
      * @param {string} serviceId - The UUID of the service.