@hangtime/grip-connect 0.5.2 → 0.5.3

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

@@ -1,10 +1,33 @@
 import { Device } from "../device.model";
 import type { IMotherboard } from "../../interfaces/device/motherboard.interface";
-export declare const CALIBRATION: never[][];
 /**
  * Represents a Griptonite Motherboard device
  */
 export declare class Motherboard extends Device implements IMotherboard {
+    /**
+     * Length of the packet received from the device.
+     * @private
+     * @type {number}
+     */
+    private PACKET_LENGTH;
+    /**
+     * Number of samples contained in the data packet.
+     * @private
+     * @type {number}
+     */
+    private NUM_SAMPLES;
+    /**
+     * Buffer to store received data from the device.
+     * @private
+     * @type {number[]}
+     */
+    private receiveBuffer;
+    /**
+     * Calibration data for each sensor of the device.
+     * @private
+     * @type {number[][][]}
+     */
+    private CALIBRATION;
     constructor();
     /**
      * Applies calibration to a sample value.

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

@@ -1,21 +1,35 @@
 import { Device } from "../device.model";
-import { applyTare } from "../../tare";
-import { MotherboardCommands } from "../../commands";
-import { checkActivity } from "../../is-active";
-import { DownloadPackets, emptyDownloadPackets } from "../../download";
-// Constants
-const PACKET_LENGTH = 32;
-const NUM_SAMPLES = 3;
-let MASS_MAX = "0";
-let MASS_AVERAGE = "0";
-let MASS_TOTAL_SUM = 0;
-let DATAPOINT_COUNT = 0;
-const receiveBuffer = [];
-export const CALIBRATION = [[], [], [], []];
+import { applyTare } from "../../helpers/tare";
+import { checkActivity } from "../../helpers/is-active";
+import { DownloadPackets, emptyDownloadPackets } from "../../helpers/download";
 /**
  * Represents a Griptonite Motherboard device
  */
 export class Motherboard extends Device {
+    /**
+     * Length of the packet received from the device.
+     * @private
+     * @type {number}
+     */
+    PACKET_LENGTH = 32;
+    /**
+     * Number of samples contained in the data packet.
+     * @private
+     * @type {number}
+     */
+    NUM_SAMPLES = 3;
+    /**
+     * Buffer to store received data from the device.
+     * @private
+     * @type {number[]}
+     */
+    receiveBuffer = [];
+    /**
+     * Calibration data for each sensor of the device.
+     * @private
+     * @type {number[][][]}
+     */
+    CALIBRATION = [[], [], [], []];
     constructor() {
         super({
             filters: [{ name: "Motherboard" }],
@@ -94,6 +108,15 @@ export class Motherboard extends Device {
                     ],
                 },
             ],
+            commands: {
+                GET_SERIAL: "#",
+                START_WEIGHT_MEAS: "S30",
+                STOP_WEIGHT_MEAS: "", // All commands will stop the data stream.
+                GET_CALIBRATION: "C",
+                SLEEP: 0,
+                GET_TEXT: "T",
+                DEBUG_STREAM: "D",
+            },
         });
     }
     /**
@@ -153,7 +176,7 @@ export class Motherboard extends Device {
         // Check if the device is connected
         if (this.isConnected()) {
             // Write the command to get calibration data to the device
-            await this.write("uart", "tx", MotherboardCommands.GET_CALIBRATION, 2500, (data) => {
+            await this.write("uart", "tx", this.commands.GET_CALIBRATION, 2500, (data) => {
                 console.log(data);
             });
         }
@@ -184,11 +207,11 @@ export class Motherboard extends Device {
         if (value) {
             if (value.buffer) {
                 for (let i = 0; i < value.byteLength; i++) {
-                    receiveBuffer.push(value.getUint8(i));
+                    this.receiveBuffer.push(value.getUint8(i));
                 }
                 let idx;
-                while ((idx = receiveBuffer.indexOf(10)) >= 0) {
-                    const line = receiveBuffer.splice(0, idx + 1).slice(0, -1); // Combine and remove LF
+                while ((idx = this.receiveBuffer.indexOf(10)) >= 0) {
+                    const line = this.receiveBuffer.splice(0, idx + 1).slice(0, -1); // Combine and remove LF
                     if (line.length > 0 && line[line.length - 1] === 13)
                         line.pop(); // Remove CR
                     const decoder = new TextDecoder("utf-8");
@@ -197,7 +220,7 @@ export class Motherboard extends Device {
                     // Check if the line is entirely hex characters
                     const isAllHex = /^[0-9A-Fa-f]+$/g.test(receivedData);
                     // Handle streaming packet
-                    if (isAllHex && receivedData.length === PACKET_LENGTH) {
+                    if (isAllHex && receivedData.length === this.PACKET_LENGTH) {
                         // Base-16 decode the string: convert hex pairs to byte values
                         const bytes = Array.from({ length: receivedData.length / 2 }, (_, i) => Number(`0x${receivedData.substring(i * 2, i * 2 + 2)}`));
                         // Translate header into packet, number of samples from the packet length
@@ -209,7 +232,7 @@ export class Motherboard extends Device {
                             masses: [],
                         };
                         const dataView = new DataView(new Uint8Array(bytes).buffer);
-                        for (let i = 0; i < NUM_SAMPLES; i++) {
+                        for (let i = 0; i < this.NUM_SAMPLES; i++) {
                             const sampleStart = 4 + 3 * i;
                             // Use DataView to read the 24-bit unsigned integer
                             const rawValue = dataView.getUint8(sampleStart) |
@@ -220,7 +243,7 @@ export class Motherboard extends Device {
                             if (packet.samples[i] >= 0x7fffff) {
                                 packet.samples[i] -= 0x1000000;
                             }
-                            packet.masses[i] = this.applyCalibration(packet.samples[i], CALIBRATION[i]);
+                            packet.masses[i] = this.applyCalibration(packet.samples[i], this.CALIBRATION[i]);
                         }
                         // invert center and right values
                         packet.masses[1] *= -1;
@@ -240,31 +263,31 @@ export class Motherboard extends Device {
                         left -= applyTare(left);
                         center -= applyTare(center);
                         right -= applyTare(right);
-                        MASS_MAX = Math.max(Number(MASS_MAX), Math.max(-1000, left + center + right)).toFixed(1);
+                        this.massMax = Math.max(Number(this.massMax), Math.max(-1000, left + center + right)).toFixed(1);
                         // Update running sum and count
                         const currentMassTotal = Math.max(-1000, left + center + right);
-                        MASS_TOTAL_SUM += currentMassTotal;
-                        DATAPOINT_COUNT++;
+                        this.massTotalSum += currentMassTotal;
+                        this.dataPointCount++;
                         // Calculate the average dynamically
-                        MASS_AVERAGE = (MASS_TOTAL_SUM / DATAPOINT_COUNT).toFixed(1);
+                        this.massAverage = (this.massTotalSum / this.dataPointCount).toFixed(1);
                         // Check if device is being used
                         checkActivity(center);
                         // Notify with weight data
                         this.notifyCallback({
                             massTotal: Math.max(-1000, left + center + right).toFixed(1),
-                            massMax: MASS_MAX,
-                            massAverage: MASS_AVERAGE,
+                            massMax: this.massMax,
+                            massAverage: this.massAverage,
                             massLeft: Math.max(-1000, packet.masses[0]).toFixed(1),
                             massCenter: Math.max(-1000, packet.masses[1]).toFixed(1),
                             massRight: Math.max(-1000, packet.masses[2]).toFixed(1),
                         });
                     }
-                    else if (this.writeLast === MotherboardCommands.GET_CALIBRATION) {
+                    else if (this.writeLast === this.commands.GET_CALIBRATION) {
                         // check data integrity
                         if ((receivedData.match(/,/g) || []).length === 3) {
                             const parts = receivedData.split(",");
                             const numericParts = parts.map((x) => parseFloat(x));
-                            CALIBRATION[numericParts[0]].push(numericParts.slice(1));
+                            this.CALIBRATION[numericParts[0]].push(numericParts.slice(1));
                         }
                     }
                     else {
@@ -331,7 +354,7 @@ export class Motherboard extends Device {
         if (this.isConnected()) {
             // Write serial number command to the Motherboard and read output
             let response = undefined;
-            await this.write("uart", "tx", MotherboardCommands.GET_SERIAL, 250, (data) => {
+            await this.write("uart", "tx", this.commands.GET_SERIAL, 250, (data) => {
                 response = data;
             });
             return response;
@@ -346,7 +369,7 @@ export class Motherboard extends Device {
     stop = async () => {
         if (this.isConnected()) {
             // Stop stream of device
-            await this.write("uart", "tx", MotherboardCommands.STOP_WEIGHT_MEAS, 0);
+            await this.write("uart", "tx", this.commands.STOP_WEIGHT_MEAS, 0);
         }
     };
     /**
@@ -360,11 +383,11 @@ export class Motherboard extends Device {
             emptyDownloadPackets();
             // Device specific logic
             // Read calibration data if not already available
-            if (!CALIBRATION[0].length) {
+            if (!this.CALIBRATION[0].length) {
                 await this.calibration();
             }
             // Start streaming data
-            await this.write("uart", "tx", MotherboardCommands.START_WEIGHT_MEAS, duration);
+            await this.write("uart", "tx", this.commands.START_WEIGHT_MEAS, duration);
             // Stop streaming if duration is set
             if (duration !== 0) {
                 await this.stop();
@@ -385,7 +408,7 @@ export class Motherboard extends Device {
         if (this.isConnected()) {
             // Write text information command to the Motherboard and read output
             let response = undefined;
-            await this.write("uart", "tx", MotherboardCommands.GET_TEXT, 250, (data) => {
+            await this.write("uart", "tx", this.commands.GET_TEXT, 250, (data) => {
                 response = data;
             });
             return response;

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

@@ -1,14 +1,39 @@
 import { Device } from "../device.model";
-import { ProgressorCommands, ProgressorResponses } from "../../commands/progressor";
 import struct from "../../helpers/struct";
-import { checkActivity } from "../../is-active";
-import { DownloadPackets, emptyDownloadPackets } from "../../download";
-import { applyTare } from "../../tare";
-// Constants
-let MASS_MAX = "0";
-let MASS_AVERAGE = "0";
-let MASS_TOTAL_SUM = 0;
-let DATAPOINT_COUNT = 0;
+import { checkActivity } from "../../helpers/is-active";
+import { DownloadPackets, emptyDownloadPackets } from "../../helpers/download";
+import { applyTare } from "../../helpers/tare";
+/**
+ * Represents the possible responses of a Tindeq Progressor device.
+ */
+var ProgressorResponses;
+(function (ProgressorResponses) {
+    /**
+     * Response received after sending a command to the device.
+     * This could include acknowledgment or specific data related to the command sent.
+     */
+    ProgressorResponses[ProgressorResponses["COMMAND_RESPONSE"] = 0] = "COMMAND_RESPONSE";
+    /**
+     * Data representing a weight measurement from the device.
+     * Typically used for tracking load or force applied.
+     */
+    ProgressorResponses[ProgressorResponses["WEIGHT_MEASURE"] = 1] = "WEIGHT_MEASURE";
+    /**
+     * Peak rate of force development (RFD) measurement.
+     * This measures how quickly the force is applied over time.
+     */
+    ProgressorResponses[ProgressorResponses["PEAK_RFD_MEAS"] = 2] = "PEAK_RFD_MEAS";
+    /**
+     * Series of peak rate of force development (RFD) measurements.
+     * This could be used for analyzing force trends over multiple data points.
+     */
+    ProgressorResponses[ProgressorResponses["PEAK_RFD_MEAS_SERIES"] = 3] = "PEAK_RFD_MEAS_SERIES";
+    /**
+     * Low battery warning from the device.
+     * Indicates that the battery level is below a critical threshold.
+     */
+    ProgressorResponses[ProgressorResponses["LOW_BATTERY_WARNING"] = 4] = "LOW_BATTERY_WARNING";
+})(ProgressorResponses || (ProgressorResponses = {}));
 /**
  * Represents a Tindeq Progressor device
  */
@@ -47,6 +72,20 @@ export class Progressor extends Device {
                     ],
                 },
             ],
+            commands: {
+                TARE_SCALE: "d", // 0x64
+                START_WEIGHT_MEAS: "e", // 0x65
+                STOP_WEIGHT_MEAS: "f", // 0x66
+                START_PEAK_RFD_MEAS: "g", //  0x67
+                START_PEAK_RFD_MEAS_SERIES: "h", //  0x68
+                ADD_CALIB_POINT: "i", //  0x69
+                SAVE_CALIB: "j", //  0x6a
+                GET_FW_VERSION: "k", //  0x6b
+                GET_ERR_INFO: "l", //  0x6c
+                CLR_ERR_INFO: "m", //  0x6d
+                SLEEP: "n", // 0x6e
+                GET_BATT_VLTG: "o", //  0x6f
+            },
         });
     }
     /**
@@ -56,7 +95,7 @@ export class Progressor extends Device {
     battery = async () => {
         if (this.isConnected()) {
             let response = undefined;
-            await this.write("progressor", "tx", ProgressorCommands.GET_BATT_VLTG, 250, (data) => {
+            await this.write("progressor", "tx", this.commands.GET_BATT_VLTG, 250, (data) => {
                 response = data;
             });
             return response;
@@ -73,7 +112,7 @@ export class Progressor extends Device {
         if (this.isConnected()) {
             // Read firmware version from the device
             let response = undefined;
-            await this.write("progressor", "tx", ProgressorCommands.GET_FW_VERSION, 250, (data) => {
+            await this.write("progressor", "tx", this.commands.GET_FW_VERSION, 250, (data) => {
                 response = data;
             });
             return response;
@@ -113,18 +152,18 @@ export class Progressor extends Device {
                             // Tare correction
                             weight -= applyTare(weight);
                             // Check for max weight
-                            MASS_MAX = Math.max(Number(MASS_MAX), Number(weight)).toFixed(1);
+                            this.massMax = Math.max(Number(this.massMax), Number(weight)).toFixed(1);
                             // Update running sum and count
                             const currentMassTotal = Math.max(-1000, Number(weight));
-                            MASS_TOTAL_SUM += currentMassTotal;
-                            DATAPOINT_COUNT++;
+                            this.massTotalSum += currentMassTotal;
+                            this.dataPointCount++;
                             // Calculate the average dynamically
-                            MASS_AVERAGE = (MASS_TOTAL_SUM / DATAPOINT_COUNT).toFixed(1);
+                            this.massAverage = (this.massTotalSum / this.dataPointCount).toFixed(1);
                             // Check if device is being used
                             checkActivity(weight);
                             this.notifyCallback({
-                                massMax: MASS_MAX,
-                                massAverage: MASS_AVERAGE,
+                                massMax: this.massMax,
+                                massAverage: this.massAverage,
                                 massTotal: Math.max(-1000, weight).toFixed(1),
                             });
                         }
@@ -134,13 +173,13 @@ export class Progressor extends Device {
                     if (!this.writeLast)
                         return;
                     let value = "";
-                    if (this.writeLast === ProgressorCommands.GET_BATT_VLTG) {
+                    if (this.writeLast === this.commands.GET_BATT_VLTG) {
                         value = new DataView(data.buffer, 2).getUint32(0, true).toString();
                     }
-                    else if (this.writeLast === ProgressorCommands.GET_FW_VERSION) {
+                    else if (this.writeLast === this.commands.GET_FW_VERSION) {
                         value = new TextDecoder().decode(data.buffer.slice(2));
                     }
-                    else if (this.writeLast === ProgressorCommands.GET_ERR_INFO) {
+                    else if (this.writeLast === this.commands.GET_ERR_INFO) {
                         value = new TextDecoder().decode(data.buffer.slice(2));
                     }
                     this.writeCallback(value);
@@ -161,7 +200,7 @@ export class Progressor extends Device {
     stop = async () => {
         if (this.isConnected()) {
             // Stop stream of device
-            await this.write("progressor", "tx", ProgressorCommands.STOP_WEIGHT_MEAS, 0);
+            await this.write("progressor", "tx", this.commands.STOP_WEIGHT_MEAS, 0);
         }
     };
     /**
@@ -174,7 +213,7 @@ export class Progressor extends Device {
             // Reset download packets
             emptyDownloadPackets();
             // Start streaming data
-            await this.write("progressor", "tx", ProgressorCommands.START_WEIGHT_MEAS, duration);
+            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/wh-c06.model.d.ts

@@ -5,6 +5,13 @@ import type { IWHC06 } from "../../interfaces/device/wh-c06.interface";
  * Enable 'Experimental Web Platform features' Chrome Flags.
  */
 export declare class WHC06 extends Device implements IWHC06 {
+    /**
+     * Offset for the byte location in the manufacturer data to extract the weight.
+     * This value is constant across all instances of the class.
+     * @type {number}
+     * @constant
+     */
+    private static readonly WEIGHT_OFFSET;
     constructor();
     /**
      * Connects to a Bluetooth device.

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

@@ -1,18 +1,19 @@
 import { Device } from "../device.model";
-import { applyTare } from "../../tare";
-import { checkActivity } from "../../is-active";
-// Constants
-let MASS_MAX = "0";
-let MASS_AVERAGE = "0";
-let MASS_TOTAL_SUM = 0;
-let DATAPOINT_COUNT = 0;
-const WEIGHT_OFFSET = 10;
-// const STABLE_OFFSET = 14
+import { applyTare } from "../../helpers/tare";
+import { checkActivity } from "../../helpers/is-active";
 /**
  * Represents a  Weiheng - WH-C06 (or MAT Muscle Meter) device
  * Enable 'Experimental Web Platform features' Chrome Flags.
  */
 export class WHC06 extends Device {
+    /**
+     * Offset for the byte location in the manufacturer data to extract the weight.
+     * This value is constant across all instances of the class.
+     * @type {number}
+     * @constant
+     */
+    static WEIGHT_OFFSET = 10;
+    // private static readonly  STABLE_OFFSET = 14
     constructor() {
         super({
             filters: [
@@ -52,26 +53,26 @@ export class WHC06 extends Device {
                 const data = event.manufacturerData.get(MANUFACTURER_ID);
                 if (data) {
                     // Handle recieved data
-                    const weight = (data.getUint8(WEIGHT_OFFSET) << 8) | data.getUint8(WEIGHT_OFFSET + 1);
+                    const weight = (data.getUint8(WHC06.WEIGHT_OFFSET) << 8) | data.getUint8(WHC06.WEIGHT_OFFSET + 1);
                     // const stable = (data.getUint8(STABLE_OFFSET) & 0xf0) >> 4
                     // const unit = data.getUint8(STABLE_OFFSET) & 0x0f
                     let numericData = weight / 100;
                     // Tare correction
                     numericData -= applyTare(numericData);
-                    // Update MASS_MAX
-                    MASS_MAX = Math.max(Number(MASS_MAX), numericData).toFixed(1);
+                    // Update massMax
+                    this.massMax = Math.max(Number(this.massMax), numericData).toFixed(1);
                     // Update running sum and count
                     const currentMassTotal = Math.max(-1000, numericData);
-                    MASS_TOTAL_SUM += currentMassTotal;
-                    DATAPOINT_COUNT++;
+                    this.massTotalSum += currentMassTotal;
+                    this.dataPointCount++;
                     // Calculate the average dynamically
-                    MASS_AVERAGE = (MASS_TOTAL_SUM / DATAPOINT_COUNT).toFixed(1);
+                    this.massAverage = (this.massTotalSum / this.dataPointCount).toFixed(1);
                     // Check if device is being used
                     checkActivity(numericData);
                     // Notify with weight data
                     this.notifyCallback({
-                        massMax: MASS_MAX,
-                        massAverage: MASS_AVERAGE,
+                        massMax: this.massMax,
+                        massAverage: this.massAverage,
                         massTotal: Math.max(-1000, numericData).toFixed(1),
                     });
                 }

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

@@ -1,14 +1,79 @@
 import { BaseModel } from "./../models/base.model";
 import type { IDevice, Service } from "../interfaces/device.interface";
-import type { massObject } from "./../types/notify";
-/** Define the type for the callback function */
-type NotifyCallback = (data: massObject) => void;
-/** Define the type for the callback function */
-type WriteCallback = (data: string) => void;
-export declare class Device extends BaseModel implements IDevice {
+import type { NotifyCallback, WriteCallback } from "../interfaces/callback.interface";
+import type { Commands } from "../interfaces/command.interface";
+export declare abstract class Device extends BaseModel implements IDevice {
+    /**
+     * Filters to identify the device during Bluetooth scanning.
+     * Used to match devices that meet specific criteria such as name, service UUIDs, etc.
+     */
     filters: BluetoothLEScanFilter[];
+    /**
+     * Array of services provided by the device.
+     * Services represent functionalities that the device supports, such as weight measurement, battery information, or custom services.
+     */
     services: Service[];
+    /**
+     * Reference to the `BluetoothDevice` object representing this device.
+     * This is the actual device object obtained from the Web Bluetooth API after a successful connection.
+     */
     bluetooth?: BluetoothDevice | undefined;
+    /**
+     * Object representing the set of commands available for this device.
+     * These commands allow communication with the device to perform various operations such as starting measurements, retrieving data, or calibrating the device.
+     */
+    commands: Commands;
+    /**
+     * The BluetoothRemoteGATTServer interface of the Web Bluetooth API represents a GATT Server on a remote device.
+     */
+    private server;
+    /**
+     * Maximum mass recorded from the device, initialized to "0".
+     * @type {string}
+     * @protected
+     */
+    protected massMax: string;
+    /**
+     * Average mass calculated from the device data, initialized to "0".
+     * @type {string}
+     * @protected
+     */
+    protected massAverage: string;
+    /**
+     * Total sum of all mass data points recorded from the device.
+     * Used to calculate the average mass.
+     * @type {number}
+     * @protected
+     */
+    protected massTotalSum: number;
+    /**
+     * Number of data points received from the device.
+     * Used to calculate the average mass.
+     * @type {number}
+     * @protected
+     */
+    protected dataPointCount: number;
+    /**
+     * Optional callback for handling write operations.
+     * @callback NotifyCallback
+     * @param {massObject} data - The data passed to the callback.
+     * @type {NotifyCallback | undefined}
+     * @protected
+     */
+    protected notifyCallback: NotifyCallback;
+    /**
+     * Optional callback for handling write operations.
+     * @callback WriteCallback
+     * @param {string} data - The data passed to the callback.
+     * @type {WriteCallback | undefined}
+     * @protected
+     */
+    protected writeCallback: WriteCallback;
+    /**
+     * The last message written to the device.
+     * @type {string | Uint8Array | null}
+     */
+    protected writeLast: string | Uint8Array | null;
     constructor(device: Partial<IDevice>);
     /**
      * Connects to a Bluetooth device.
@@ -50,12 +115,6 @@ export declare class Device extends BaseModel implements IDevice {
      * @returns {void}
      */
     notify: (callback: NotifyCallback) => void;
-    /**
-     * Defines the type for the callback function.
-     * @callback NotifyCallback
-     * @param {massObject} data - The data passed to the callback.
-     */
-    notifyCallback: NotifyCallback;
     /**
      * Handles the 'connected' event.
      * @param {Function} onSuccess - Callback function to execute on successful connection.
@@ -93,14 +152,4 @@ export declare class Device extends BaseModel implements IDevice {
      * });
      */
     write: (serviceId: string, characteristicId: string, message: string | Uint8Array | undefined, duration?: number, callback?: WriteCallback) => Promise<void>;
-    /**
-     * A default write callback that logs the response
-     */
-    writeCallback: WriteCallback;
-    /**
-     * The last message written to the device.
-     * @type {string | Uint8Array | null}
-     */
-    writeLast: string | Uint8Array | null;
 }
-export {};