@hangtime/grip-connect 0.5.3 → 0.5.4

package/README.md

@@ -117,7 +117,7 @@ motherboardButton.addEventListener("click", () => {
     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 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/dist/interfaces/device/forceboard.interface.d.ts

@@ -18,4 +18,20 @@ export interface IForceBoard extends IDevice {
      * @returns {Promise<string | undefined>} A Promise that resolves with the manufacturer information.
      */
     manufacturer(): 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>;
+    /**
+     * Retrieves temperature information from the device.
+     * @returns {Promise<string | undefined>} A Promise that resolves with the humidity level.
+     */
+    temperature(): Promise<string | undefined>;
 }

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

@@ -106,9 +106,9 @@ export interface IDevice extends IBase {
      * @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.
+     * @returns {Promise<string | undefined>} A promise that resolves when the read operation is completed.
      */
-    read(serviceId: string, characteristicId: string, duration?: number): Promise<string>;
+    read(serviceId: string, characteristicId: string, duration?: number): Promise<string | undefined>;
     /**
      * 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.

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

@@ -18,7 +18,7 @@ export declare class Entralpi extends Device implements IEntralpi {
      */
     firmware: () => Promise<string | undefined>;
     /**
-     * Handles data received from the Progressor device, processes weight measurements,
+     * Handles data received from the device, processes weight measurements,
      * and updates mass data including maximum and average values.
      * It also handles command responses for retrieving device information.
      *

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

@@ -128,40 +128,24 @@ export class Entralpi extends Device {
      * @returns {Promise<string | undefined>} A Promise that resolves with the battery or voltage information.
      */
     battery = async () => {
-        if (this.isConnected()) {
-            return await this.read("battery", "level", 250);
-        }
-        // If device is not found, return undefined
-        return undefined;
+        return await this.read("battery", "level", 250);
     };
     /**
      * Retrieves IEEE 11073-20601 Regulatory Certification from the device.
      * @returns {Promise<string>} A Promise that resolves with the certification.
      */
     certification = async () => {
-        // Check if the device is connected
-        if (this.isConnected()) {
-            // Read certification from the device
-            return await this.read("device", "certification", 250);
-        }
-        // If device is not found, return undefined
-        return undefined;
+        return await this.read("device", "certification", 250);
     };
     /**
      * Retrieves firmware version from the device.
      * @returns {Promise<string>} A Promise that resolves with the firmware version.
      */
     firmware = async () => {
-        // Check if the device is connected
-        if (this.isConnected()) {
-            // Read firmware version from the Motherboard
-            return await this.read("device", "firmware", 250);
-        }
-        // If device is not found, return undefined
-        return undefined;
+        return await this.read("device", "firmware", 250);
     };
     /**
-     * Handles data received from the Progressor device, processes weight measurements,
+     * Handles data received from the device, processes weight measurements,
      * and updates mass data including maximum and average values.
      * It also handles command responses for retrieving device information.
      *
@@ -202,39 +186,21 @@ export class Entralpi extends Device {
      * @returns {Promise<string>} A Promise that resolves with the hardware version.
      */
     hardware = async () => {
-        // Check if the device is connected
-        if (this.isConnected()) {
-            // Read hardware version from the device
-            return await this.read("device", "hardware", 250);
-        }
-        // If device is not found, return undefined
-        return undefined;
+        return await this.read("device", "hardware", 250);
     };
     /**
      * Retrieves manufacturer information from the device.
      * @returns {Promise<string>} A Promise that resolves with the manufacturer information.
      */
     manufacturer = async () => {
-        // Check if the device is connected
-        if (this.isConnected()) {
-            // Read manufacturer information from the device
-            return await this.read("device", "manufacturer", 250);
-        }
-        // If device is not found, return undefined
-        return undefined;
+        return await this.read("device", "manufacturer", 250);
     };
     /**
      * Retrieves model number from the device.
      * @returns {Promise<string>} A Promise that resolves with the model number.
      */
     model = async () => {
-        // Check if the device is connected
-        if (this.isConnected()) {
-            // Read model number from the Entralpi
-            return await this.read("device", "model", 250);
-        }
-        // If device is not found, return undefined
-        return undefined;
+        return await this.read("device", "model", 250);
     };
     /**
      * Retrieves PnP ID from the device, a set of values that used to create a device ID value that is unique for this device.
@@ -242,38 +208,20 @@ export class Entralpi extends Device {
      * @returns {Promise<string>} A Promise that resolves with the PnP ID.
      */
     pnp = async () => {
-        // Check if the device is connected
-        if (this.isConnected()) {
-            // Read software version from the Entralpi
-            return await this.read("device", "pnp", 250);
-        }
-        // If device is not found, return undefined
-        return undefined;
+        return await this.read("device", "pnp", 250);
     };
     /**
      * Retrieves software version from the device.
      * @returns {Promise<string>} A Promise that resolves with the software version.
      */
     software = async () => {
-        // Check if the device is connected
-        if (this.isConnected()) {
-            // Read software version from the Entralpi
-            return await this.read("device", "software", 250);
-        }
-        // If device is not found, return undefined
-        return undefined;
+        return await this.read("device", "software", 250);
     };
     /**
      * Retrieves system id from the device.
      * @returns {Promise<string>} A Promise that resolves with the system id.
      */
     system = async () => {
-        // Check if the device is connected
-        if (this.isConnected()) {
-            // Read system id from the device
-            return await this.read("device", "system", 250);
-        }
-        // If device is not found, return undefined
-        return undefined;
+        return await this.read("device", "system", 250);
     };
 }

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

@@ -10,6 +10,14 @@ export declare class ForceBoard extends Device implements IForceBoard {
      * @returns {Promise<string | undefined>} A Promise that resolves with the battery or voltage information,
      */
     battery: () => Promise<string | undefined>;
+    /**
+     * Handles data received from the device, processes weight measurements,
+     * and updates mass data including maximum and average values.
+     * It also handles command responses for retrieving device information.
+     *
+     * @param {Event} event - The notification event.
+     */
+    handleNotifications: (event: Event) => void;
     /**
      * Retrieves humidity level from the device.
      * @returns {Promise<string>} A Promise that resolves with the humidity level,
@@ -20,4 +28,20 @@ export declare class ForceBoard extends Device implements IForceBoard {
      * @returns {Promise<string>} A Promise that resolves with the manufacturer information,
      */
     manufacturer: () => 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>;
+    /**
+     * Retrieves temperature information from the device.
+     * @returns {Promise<string>} A Promise that resolves with the manufacturer information,
+     */
+    temperature: () => Promise<string | undefined>;
 }

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

@@ -1,4 +1,7 @@
 import { Device } from "../device.model";
+import { emptyDownloadPackets } from "../../helpers/download";
+import { checkActivity } from "../../helpers/is-active";
+import { applyTare } from "../../helpers/tare";
 /**
  * Represents a PitchSix Force Board device
  */
@@ -142,13 +145,13 @@ export class ForceBoard extends Device {
                     ],
                 },
                 {
-                    name: "",
-                    id: "",
+                    name: "Weight Serivce",
+                    id: "weight",
                     uuid: "467a8516-6e39-11eb-9439-0242ac130002",
                     characteristics: [
                         {
                             name: "Read + Write",
-                            id: "",
+                            id: "tx",
                             uuid: "467a8517-6e39-11eb-9439-0242ac130002",
                         },
                         {
@@ -159,6 +162,9 @@ export class ForceBoard extends Device {
                     ],
                 },
             ],
+            commands: {
+                STOP_WEIGHT_MEAS: "",
+            },
         });
     }
     /**
@@ -166,35 +172,87 @@ export class ForceBoard extends Device {
      * @returns {Promise<string | undefined>} A Promise that resolves with the battery or voltage information,
      */
     battery = async () => {
-        if (this.isConnected()) {
-            return await this.read("battery", "level", 250);
+        return await this.read("battery", "level", 250);
+    };
+    /**
+     * Handles data received from the device, processes weight measurements,
+     * and updates mass data including maximum and average values.
+     * It also handles command responses for retrieving device information.
+     *
+     * @param {Event} event - The notification event.
+     */
+    handleNotifications = (event) => {
+        const characteristic = event.target;
+        const value = characteristic.value;
+        if (value) {
+            if (value.buffer) {
+                const buffer = value.buffer;
+                const rawData = new DataView(buffer);
+                const receivedData = rawData.getUint8(4); // Read the value at index 4
+                // Convert from LBS to KG
+                let numericData = receivedData * 0.453592;
+                // Tare correction
+                numericData -= applyTare(numericData);
+                // Update massMax
+                this.massMax = Math.max(Number(this.massMax), numericData).toFixed(1);
+                // Update running sum and count
+                const currentMassTotal = Math.max(-1000, numericData);
+                this.massTotalSum += currentMassTotal;
+                this.dataPointCount++;
+                // Calculate the average dynamically
+                this.massAverage = (this.massTotalSum / this.dataPointCount).toFixed(1);
+                // Check if device is being used
+                checkActivity(numericData);
+                // Notify with weight data
+                this.notifyCallback({
+                    massMax: this.massMax,
+                    massAverage: this.massAverage,
+                    massTotal: Math.max(-1000, numericData).toFixed(1),
+                });
+            }
         }
-        // If device is not found, return undefined
-        return undefined;
     };
     /**
      * Retrieves humidity level from the device.
      * @returns {Promise<string>} A Promise that resolves with the humidity level,
      */
     humidity = async () => {
-        // Check if the device is connected
-        if (this.isConnected()) {
-            return await this.read("humidity", "level", 250);
-        }
-        // If device is not found, return undefined
-        return undefined;
+        return await this.read("humidity", "level", 250);
     };
     /**
      * Retrieves manufacturer information from the device.
      * @returns {Promise<string>} A Promise that resolves with the manufacturer information,
      */
     manufacturer = async () => {
-        // Check if the device is connected
-        if (this.isConnected()) {
-            // Read manufacturer information from the device
-            return await this.read("device", "manufacturer", 250);
+        return await this.read("device", "manufacturer", 250);
+    };
+    /**
+     * Stops the data stream on the specified device.
+     * @returns {Promise<void>} A promise that resolves when the stream is stopped.
+     */
+    stop = async () => {
+        await this.write("weight", "tx", this.commands.STOP_WEIGHT_MEAS, 0);
+    };
+    /**
+     * Starts streaming data from the specified device.
+     * @param {number} [duration=0] - The duration of the stream in milliseconds. If set to 0, stream will continue indefinitely.
+     * @returns {Promise<void>} A promise that resolves when the streaming operation is completed.
+     */
+    stream = async (duration = 0) => {
+        // Reset download packets
+        emptyDownloadPackets();
+        // Start streaming data
+        await this.write("weight", "tx", new Uint8Array([0x04]), duration); // ASCII control character EOT (End of Transmission)
+        // Stop streaming if duration is set
+        if (duration !== 0) {
+            await this.stop();
         }
-        // If device is not found, return undefined
-        return undefined;
+    };
+    /**
+     * Retrieves temperature information from the device.
+     * @returns {Promise<string>} A Promise that resolves with the manufacturer information,
+     */
+    temperature = async () => {
+        return await this.read("temperature", "level", 250);
     };
 }

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

@@ -162,37 +162,23 @@ export class Motherboard extends Device {
      * @returns {Promise<string | undefined>} A Promise that resolves with the battery or voltage information,
      */
     battery = async () => {
-        if (this.isConnected()) {
-            return await this.read("battery", "level", 250);
-        }
-        // If device is not found, return undefined
-        return undefined;
+        return await this.read("battery", "level", 250);
     };
     /**
      * Writes a command to get calibration data from the device.
      * @returns {Promise<void>} A Promise that resolves when the command is successfully sent.
      */
     calibration = async () => {
-        // Check if the device is connected
-        if (this.isConnected()) {
-            // Write the command to get calibration data to the device
-            await this.write("uart", "tx", this.commands.GET_CALIBRATION, 2500, (data) => {
-                console.log(data);
-            });
-        }
+        await this.write("uart", "tx", this.commands.GET_CALIBRATION, 2500, (data) => {
+            console.log(data);
+        });
     };
     /**
      * Retrieves firmware version from the device.
      * @returns {Promise<string>} A Promise that resolves with the firmware version,
      */
     firmware = async () => {
-        // Check if the device is connected
-        if (this.isConnected()) {
-            // Read firmware version from the Motherboard
-            return await this.read("device", "firmware", 250);
-        }
-        // If device is not found, return undefined
-        return undefined;
+        return await this.read("device", "firmware", 250);
     };
     /**
      * Handles data received from the Motherboard device. Processes hex-encoded streaming packets
@@ -303,13 +289,7 @@ export class Motherboard extends Device {
      * @returns {Promise<string>} A Promise that resolves with the hardware version,
      */
     hardware = async () => {
-        // Check if the device is connected
-        if (this.isConnected()) {
-            // Read hardware version from the device
-            return await this.read("device", "hardware", 250);
-        }
-        // If device is not found, return undefined
-        return undefined;
+        return await this.read("device", "hardware", 250);
     };
     /**
      * Sets the LED color based on a single color option. Defaults to turning the LEDs off if no configuration is provided.
@@ -337,40 +317,25 @@ export class Motherboard extends Device {
      * @returns {Promise<string>} A Promise that resolves with the manufacturer information,
      */
     manufacturer = async () => {
-        // Check if the device is connected
-        if (this.isConnected()) {
-            // Read manufacturer information from the device
-            return await this.read("device", "manufacturer", 250);
-        }
-        // If device is not found, return undefined
-        return undefined;
+        return await this.read("device", "manufacturer", 250);
     };
     /**
      * Retrieves serial number from the device.
      * @returns {Promise<string>} A Promise that resolves with the serial number,
      */
     serial = async () => {
-        // Check if the device is connected
-        if (this.isConnected()) {
-            // Write serial number command to the Motherboard and read output
-            let response = undefined;
-            await this.write("uart", "tx", this.commands.GET_SERIAL, 250, (data) => {
-                response = data;
-            });
-            return response;
-        }
-        // If device is not found, return undefined
-        return undefined;
+        let response = undefined;
+        await this.write("uart", "tx", this.commands.GET_SERIAL, 250, (data) => {
+            response = data;
+        });
+        return response;
     };
     /**
      * Stops the data stream on the specified device.
      * @returns {Promise<void>} A promise that resolves when the stream is stopped.
      */
     stop = async () => {
-        if (this.isConnected()) {
-            // Stop stream of device
-            await this.write("uart", "tx", this.commands.STOP_WEIGHT_MEAS, 0);
-        }
+        await this.write("uart", "tx", this.commands.STOP_WEIGHT_MEAS, 0);
     };
     /**
      * Starts streaming data from the specified device.
@@ -378,20 +343,17 @@ export class Motherboard extends Device {
      * @returns {Promise<void>} A promise that resolves when the streaming operation is completed.
      */
     stream = async (duration = 0) => {
-        if (this.isConnected()) {
-            // Reset download packets
-            emptyDownloadPackets();
-            // Device specific logic
-            // Read calibration data if not already available
-            if (!this.CALIBRATION[0].length) {
-                await this.calibration();
-            }
-            // Start streaming data
-            await this.write("uart", "tx", this.commands.START_WEIGHT_MEAS, duration);
-            // Stop streaming if duration is set
-            if (duration !== 0) {
-                await this.stop();
-            }
+        // Reset download packets
+        emptyDownloadPackets();
+        // Read calibration data if not already available
+        if (!this.CALIBRATION[0].length) {
+            await this.calibration();
+        }
+        // Start streaming data
+        await this.write("uart", "tx", this.commands.START_WEIGHT_MEAS, duration);
+        // Stop streaming if duration is set
+        if (duration !== 0) {
+            await this.stop();
         }
     };
     /**
@@ -404,16 +366,10 @@ export class Motherboard extends Device {
      * @returns {Promise<string>} A Promise that resolves with the 320-byte memory content as a string,
      */
     text = async () => {
-        // Check if the device is connected
-        if (this.isConnected()) {
-            // Write text information command to the Motherboard and read output
-            let response = undefined;
-            await this.write("uart", "tx", this.commands.GET_TEXT, 250, (data) => {
-                response = data;
-            });
-            return response;
-        }
-        // If device is not found, return undefined
-        return undefined;
+        let response = undefined;
+        await this.write("uart", "tx", this.commands.GET_TEXT, 250, (data) => {
+            response = data;
+        });
+        return response;
     };
 }

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

@@ -16,7 +16,7 @@ export declare class Progressor extends Device implements IProgressor {
      */
     firmware: () => Promise<string | undefined>;
     /**
-     * Handles data received from the Progressor device, processes weight measurements,
+     * Handles data received from the device, processes weight measurements,
      * and updates mass data including maximum and average values.
      * It also handles command responses for retrieving device information.
      *

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

@@ -93,35 +93,25 @@ export class Progressor extends Device {
      * @returns {Promise<string | undefined>} A Promise that resolves with the battery or voltage information,
      */
     battery = async () => {
-        if (this.isConnected()) {
-            let response = undefined;
-            await this.write("progressor", "tx", this.commands.GET_BATT_VLTG, 250, (data) => {
-                response = data;
-            });
-            return response;
-        }
-        // If device is not found, return undefined
-        return undefined;
+        let response = undefined;
+        await this.write("progressor", "tx", this.commands.GET_BATT_VLTG, 250, (data) => {
+            response = data;
+        });
+        return response;
     };
     /**
      * Retrieves firmware version from the device.
      * @returns {Promise<string>} A Promise that resolves with the firmware version,
      */
     firmware = async () => {
-        // Check if the device is connected
-        if (this.isConnected()) {
-            // Read firmware version from the device
-            let response = undefined;
-            await this.write("progressor", "tx", this.commands.GET_FW_VERSION, 250, (data) => {
-                response = data;
-            });
-            return response;
-        }
-        // If device is not found, return undefined
-        return undefined;
+        let response = undefined;
+        await this.write("progressor", "tx", this.commands.GET_FW_VERSION, 250, (data) => {
+            response = data;
+        });
+        return response;
     };
     /**
-     * Handles data received from the Progressor device, processes weight measurements,
+     * Handles data received from the device, processes weight measurements,
      * and updates mass data including maximum and average values.
      * It also handles command responses for retrieving device information.
      *
@@ -198,10 +188,7 @@ export class Progressor extends Device {
      * @returns {Promise<void>} A promise that resolves when the stream is stopped.
      */
     stop = async () => {
-        if (this.isConnected()) {
-            // Stop stream of device
-            await this.write("progressor", "tx", this.commands.STOP_WEIGHT_MEAS, 0);
-        }
+        await this.write("progressor", "tx", this.commands.STOP_WEIGHT_MEAS, 0);
     };
     /**
      * Starts streaming data from the specified device.
@@ -209,15 +196,13 @@ export class Progressor extends Device {
      * @returns {Promise<void>} A promise that resolves when the streaming operation is completed.
      */
     stream = async (duration = 0) => {
-        if (this.isConnected()) {
-            // Reset download packets
-            emptyDownloadPackets();
-            // Start streaming data
-            await this.write("progressor", "tx", this.commands.START_WEIGHT_MEAS, duration);
-            // Stop streaming if duration is set
-            if (duration !== 0) {
-                await this.stop();
-            }
+        // Reset download packets
+        emptyDownloadPackets();
+        // Start streaming data
+        await this.write("progressor", "tx", this.commands.START_WEIGHT_MEAS, duration);
+        // Stop streaming if duration is set
+        if (duration !== 0) {
+            await this.stop();
         }
     };
 }

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

@@ -130,9 +130,9 @@ export declare abstract class Device extends BaseModel implements IDevice {
      * @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.
+     * @returns {Promise<string | undefined>} A promise that resolves when the read operation is completed.
      */
-    read: (serviceId: string, characteristicId: string, duration?: number) => Promise<string>;
+    read: (serviceId: string, characteristicId: string, duration?: number) => Promise<string | undefined>;
     /**
      * 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.