@hangtime/grip-connect 0.3.0 → 0.3.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hangtime/grip-connect",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "description": "A client that can establish connections with various Force-Sensing Hangboards/Plates used by climbers for strength measurement. Examples of such hangboards include the Griptonite Motherboard, Climbro, SmartBoard, Entralpi or Tindeq Progressor",
   "main": "src/index.ts",
   "scripts": {

package/src/battery.ts

@@ -1,4 +1,4 @@
-import { Device } from "./devices/types"
+import type { Device } from "./types/devices"
 import { write } from "./write"
 import { read } from "./read"
 import { isConnected } from "./is-connected"

package/src/calibration.ts

@@ -1,4 +1,4 @@
-import { Device } from "./devices/types"
+import type { Device } from "./types/devices"
 import { isConnected } from "./is-connected"
 import { write } from "./write"
 import { Motherboard } from "./devices"

package/src/characteristic.ts

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

package/src/commands/climbro.ts

@@ -1,4 +1,4 @@
-import { Commands } from "../commands/types"
+import type { Commands } from "../types/commands"
 /**
  * Warning:
  * Using other commands can seriously harm your device

package/src/commands/entralpi.ts

@@ -1,4 +1,4 @@
-import { Commands } from "../commands/types"
+import type { Commands } from "../types/commands"
 /**
  * Warning:
  * Using other commands can seriously harm your device

package/src/commands/motherboard.ts

@@ -1,4 +1,4 @@
-import { Commands } from "../commands/types"
+import type { Commands } from "../types/commands"
 /**
  * Warning:
  * Using other commands can seriously harm your device

package/src/commands/musclemeter.ts

@@ -1,4 +1,4 @@
-import { Commands } from "../commands/types"
+import type { Commands } from "../types/commands"
 /**
  * Warning:
  * Using other commands can seriously harm your device

package/src/commands/mysmartboard.ts

@@ -1,4 +1,4 @@
-import { Commands } from "../commands/types"
+import type { Commands } from "../types/commands"
 /**
  * Warning:
  * Using other commands can seriously harm your device

package/src/commands/progressor.ts

@@ -1,4 +1,4 @@
-import { Commands } from "../commands/types"
+import type { Commands } from "../types/commands"
 /**
  * Warning:
  * Using other commands can seriously harm your device
@@ -22,10 +22,10 @@ export const ProgressorCommands: Commands = {
  * The Progressor returns a Uint8Array.
  * The first item [0] is the type of response it returns
  */
-export const ProgressorResponses = {
-  COMMAND_RESPONSE: 0,
-  WEIGHT_MEASURE: 1,
-  PEAK_RFD_MEAS: 2,
-  PEAK_RFD_MEAS_SERIES: 3,
-  LOW_BATTERY_WARNING: 4,
+export enum ProgressorResponses {
+  COMMAND_RESPONSE,
+  WEIGHT_MEASURE,
+  PEAK_RFD_MEAS,
+  PEAK_RFD_MEAS_SERIES,
+  LOW_BATTERY_WARNING,
 }

package/src/connect.ts

@@ -1,4 +1,4 @@
-import { Device } from "./devices/types"
+import type { Device } from "./types/devices"
 import { handleEntralpiData, handleMotherboardData, handleProgressorData } from "./data"
 
 let server: BluetoothRemoteGATTServer
@@ -90,7 +90,7 @@ const onConnected = async (board: Device, onSuccess: () => void): Promise<void>
               // notify
               if (element.id === "rx") {
                 matchingCharacteristic.startNotifications()
-                matchingCharacteristic.addEventListener("characteristicvaluechanged", (event) =>
+                matchingCharacteristic.addEventListener("characteristicvaluechanged", (event: Event) =>
                   handleNotifications(event, board),
                 )
               }

package/src/data.ts

@@ -3,8 +3,9 @@ import { applyTare } from "./tare"
 import { ProgressorCommands, ProgressorResponses } from "./commands/progressor"
 import { MotherboardCommands } from "./commands"
 import { lastWrite } from "./write"
-import { DownloadPacket, DownloadPackets } from "./download"
 import struct from "./struct"
+import { DownloadPackets } from "./download"
+import type { DownloadPacket } from "./types/download"
 
 // Constants
 const PACKET_LENGTH: number = 32

package/src/devices/climbro.ts

@@ -1,4 +1,4 @@
-import { Device } from "./types"
+import type { Device } from "../types/devices"
 
 /**
  * Represents a Climbro device

package/src/devices/entralpi.ts

@@ -1,4 +1,4 @@
-import { Device } from "./types"
+import type { Device } from "../types/devices"
 
 /**
  * Represents a Entralpi device

package/src/devices/motherboard.ts

@@ -1,4 +1,4 @@
-import { Device } from "./types"
+import type { Device } from "../types/devices"
 
 /**
  * Represents a Griptonite Motherboard device

package/src/devices/musclemeter.ts

@@ -1,4 +1,4 @@
-import { Device } from "./types"
+import type { Device } from "../types/devices"
 
 /**
  * Represents a MAT Muscle Meter device

package/src/devices/mysmartboard.ts

@@ -1,4 +1,4 @@
-import { Device } from "./types"
+import type { Device } from "../types/devices"
 
 /**
  * Represents a mySmartBoard device

package/src/devices/progressor.ts

@@ -1,4 +1,4 @@
-import { Device } from "./types"
+import type { Device } from "../types/devices"
 /**
  * Represents a Tindeq Progressor device
  */

package/src/disconnect.ts

@@ -1,4 +1,4 @@
-import { Device } from "./devices/types"
+import type { Device } from "./types/devices"
 import { isConnected } from "./is-connected"
 
 /**

package/src/download.ts

@@ -1,14 +1,4 @@
-/**
- * Represents a single data packet.
- */
-export interface DownloadPacket {
-  received: number // Timestamp of when the packet was received
-  sampleNum: number // Sample number
-  battRaw: number // Battery raw value
-  samples: number[] // Array of sample values
-  masses: number[] // Array of mass values
-}
-
+import type { DownloadPacket } from "./types/download"
 /**
  * Array of DownloadPacket entries.
  */

package/src/info.ts

@@ -1,4 +1,4 @@
-import { Device } from "./devices/types"
+import type { Device } from "./types/devices"
 import { write } from "./write"
 import { read } from "./read"
 import { isConnected } from "./is-connected"

package/src/is-connected.ts

@@ -1,13 +1,13 @@
-import { Device } from "./devices/types"
+import type { Device } from "./types/devices"
 
 /**
  * Checks if a Bluetooth device is connected.
  * @param {Device} board - The device to check for connection.
  * @returns {boolean} A boolean indicating whether the device is connected.
  */
-export const isConnected = (board: Device): boolean => {
-  // Check if the device is available
-  if (!board.device) {
+export const isConnected = (board?: Device): boolean => {
+  // Check if the device is defined and available
+  if (!board?.device) {
     return false
   }
   // Check if the device is connected using optional chaining

package/src/notify.ts

@@ -1,13 +1,6 @@
-export interface massObject {
-  massTotal: string // The total mass.
-  massMax: string // The total maximum mass.
-  massAverage: string // The total average mass.
-  massLeft?: string // The mass on the left side (optional: Motherboard).
-  massCenter?: string // The mass at the center (optional: Motherboard).
-  massRight?: string // The mass on the right side (optional: Motherboard).
-}
-// Define the type for the callback function
-type NotifyCallback = (data: massObject) => void
+import type { massObject } from "./types/notify"
+/** Define the type for the callback function */
+export type NotifyCallback = (data: massObject) => void
 /**
  * Defines the type for the callback function.
  * @callback NotifyCallback

package/src/read.ts

@@ -1,4 +1,4 @@
-import { Device } from "./devices/types"
+import type { Device } from "./types/devices"
 import { getCharacteristic } from "./characteristic"
 import { isConnected } from "./is-connected"
 

package/src/stop.ts

@@ -1,4 +1,4 @@
-import { Device } from "./devices/types"
+import type { Device } from "./types/devices"
 import { write } from "./write"
 import { isConnected } from "./is-connected"
 import { Motherboard, Progressor } from "./devices"

package/src/stream.ts

@@ -1,4 +1,4 @@
-import { Device } from "./devices/types"
+import type { Device } from "./types/devices"
 import { isConnected } from "./is-connected"
 import { write } from "./write"
 import { stop } from "./stop"

package/src/types/devices.ts

@@ -0,0 +1,41 @@
+/**
+ * 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.
+ */
+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 Device {
+  /** Name of the device */
+  name: string
+  /** Optional company identifier of the device */
+  companyId?: number
+  /** Array of services provided by the device */
+  services: Service[]
+  /** Reference to the BluetoothDevice object representing this device */
+  device?: BluetoothDevice
+}

package/src/types/download.ts

@@ -0,0 +1,15 @@
+/**
+ * Represents a single data packet.
+ */
+export interface DownloadPacket {
+  /** Timestamp of when the packet was received */
+  received: number
+  /** Sample number */
+  sampleNum: number //
+  /** Battery raw value */
+  battRaw: number
+  /** Array of sample values */
+  samples: number[]
+  /** Array of mass values */
+  masses: number[]
+}

package/src/types/notify.ts

@@ -0,0 +1,14 @@
+export interface massObject {
+  /** The total mass. */
+  massTotal: string
+  /**  The total maximum mass. */
+  massMax: string
+  /** The total average mass. */
+  massAverage: string
+  /** The mass on the left side (optional: Motherboard). */
+  massLeft?: string
+  /** The mass at the center (optional: Motherboard). */
+  massCenter?: string
+  /** The mass on the right side (optional: Motherboard). */
+  massRight?: string
+}

package/src/write.ts

@@ -1,4 +1,4 @@
-import { Device } from "./devices/types"
+import type { Device } from "./types/devices"
 import { isConnected } from "./is-connected"
 import { getCharacteristic } from "./characteristic"
 

package/src/battery.d.ts

@@ -1,7 +0,0 @@
-import { Device } from "./devices/types";
-/**
- * Retrieves battery or voltage information from the device.
- * @param {Device} board - The device.
- * @returns {Promise<void>} A Promise that resolves when the information is successfully retrieved.
- */
-export declare const battery: (board: Device) => Promise<void>;

package/src/battery.js

@@ -1,25 +0,0 @@
-import { write } from "./write";
-import { read } from "./read";
-import { isConnected } from "./is-connected";
-import { Motherboard, Progressor } from "./devices";
-import { ProgressorCommands } from "./commands";
-/**
- * Retrieves battery or voltage information from the device.
- * @param {Device} board - The device.
- * @returns {Promise<void>} A Promise that resolves when the information is successfully retrieved.
- */
-export const battery = async (board) => {
-    // Check if the device is connected
-    if (isConnected(board)) {
-        // If the device is connected and it is a Motherboard device
-        if (board.name === "Motherboard") {
-            // Read battery level information from the Motherboard
-            await read(Motherboard, "battery", "level", 250);
-        }
-        // If the device is connected and its name starts with "Progressor"
-        if (board.name && board.name.startsWith("Progressor")) {
-            // Write command to get battery voltage information to the Progressor
-            await write(Progressor, "progressor", "tx", ProgressorCommands.GET_BATT_VLTG, 250);
-        }
-    }
-};

package/src/calibration.d.ts

@@ -1,7 +0,0 @@
-import { Device } from "./devices/types";
-/**
- * Writes a command to get calibration data from the device.
- * @param {Device} board - The device.
- * @returns {Promise<void>} A Promise that resolves when the command is successfully sent.
- */
-export declare const calibration: (board: Device) => Promise<void>;

package/src/calibration.js

@@ -1,19 +0,0 @@
-import { isConnected } from "./is-connected";
-import { write } from "./write";
-import { Motherboard } from "./devices";
-import { MotherboardCommands } from "./commands";
-/**
- * Writes a command to get calibration data from the device.
- * @param {Device} board - The device.
- * @returns {Promise<void>} A Promise that resolves when the command is successfully sent.
- */
-export const calibration = async (board) => {
-    // Check if the device is connected
-    if (isConnected(board)) {
-        // If the device is connected, and it is a Motherboard device
-        if (board.name === "Motherboard") {
-            // Write the command to get calibration data to the device
-            await write(Motherboard, "uart", "tx", MotherboardCommands.GET_CALIBRATION, 2500);
-        }
-    }
-};

package/src/characteristic.d.ts

@@ -1,10 +0,0 @@
-/// <reference types="web-bluetooth" />
-import { Device } from "./devices/types";
-/**
- * Retrieves the characteristic from the device's service.
- * @param {Device} board - The device.
- * @param {string} serviceId - The UUID of the service.
- * @param {string} characteristicId - The UUID of the characteristic.
- * @returns {BluetoothRemoteGATTCharacteristic | undefined} The characteristic, if found.
- */
-export declare const getCharacteristic: (board: Device, serviceId: string, characteristicId: string) => BluetoothRemoteGATTCharacteristic | undefined;

package/src/characteristic.js

@@ -1,20 +0,0 @@
-/**
- * Retrieves the characteristic from the device's service.
- * @param {Device} board - The device.
- * @param {string} serviceId - The UUID of the service.
- * @param {string} characteristicId - The UUID of the characteristic.
- * @returns {BluetoothRemoteGATTCharacteristic | undefined} The characteristic, if found.
- */
-export const getCharacteristic = (board, serviceId, characteristicId) => {
-    // Find the service with the specified serviceId
-    const boardService = board.services.find((service) => service.id === serviceId);
-    if (boardService) {
-        // If the service is found, find the characteristic with the specified characteristicId
-        const boardCharacteristic = boardService.characteristics.find((characteristic) => characteristic.id === characteristicId);
-        if (boardCharacteristic) {
-            // If the characteristic is found, return it
-            return boardCharacteristic.characteristic;
-        }
-    }
-    // Return undefined if the service or characteristic is not found
-};

package/src/commands/climbro.d.ts

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

package/src/commands/climbro.js

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

package/src/commands/entralpi.d.ts

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

package/src/commands/entralpi.js

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

package/src/commands/index.d.ts

@@ -1,6 +0,0 @@
-export { ClimbroCommands } from "./climbro";
-export { EntralpiCommands } from "./entralpi";
-export { MotherboardCommands } from "./motherboard";
-export { MuscleMeterCommands } from "./musclemeter";
-export { ProgressorCommands } from "./progressor";
-export { mySmartBoardCommands } from "./mysmartboard";

package/src/commands/index.js

@@ -1,6 +0,0 @@
-export { ClimbroCommands } from "./climbro";
-export { EntralpiCommands } from "./entralpi";
-export { MotherboardCommands } from "./motherboard";
-export { MuscleMeterCommands } from "./musclemeter";
-export { ProgressorCommands } from "./progressor";
-export { mySmartBoardCommands } from "./mysmartboard";

package/src/commands/motherboard.d.ts

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

package/src/commands/motherboard.js

@@ -1,13 +0,0 @@
-/**
- * Warning:
- * Using other commands can seriously harm your device
- */
-export const MotherboardCommands = {
-    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",
-};

package/src/commands/musclemeter.d.ts

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

package/src/commands/musclemeter.js

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

package/src/commands/mysmartboard.d.ts

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

package/src/commands/mysmartboard.js

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

package/src/commands/progressor.d.ts

@@ -1,17 +0,0 @@
-import { Commands } from "../commands/types";
-/**
- * Warning:
- * Using other commands can seriously harm your device
- */
-export declare const ProgressorCommands: Commands;
-/**
- * The Progressor returns a Uint8Array.
- * The first item [0] is the type of response it returns
- */
-export declare const ProgressorResponses: {
-    COMMAND_RESPONSE: number;
-    WEIGHT_MEASURE: number;
-    PEAK_RFD_MEAS: number;
-    PEAK_RFD_MEAS_SERIES: number;
-    LOW_BATTERY_WARNING: number;
-};

package/src/commands/progressor.js

@@ -1,29 +0,0 @@
-/**
- * Warning:
- * Using other commands can seriously harm your device
- */
-export const ProgressorCommands = {
-    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,
-};
-/**
- * The Progressor returns a Uint8Array.
- * The first item [0] is the type of response it returns
- */
-export const ProgressorResponses = {
-    COMMAND_RESPONSE: 0,
-    WEIGHT_MEASURE: 1,
-    PEAK_RFD_MEAS: 2,
-    PEAK_RFD_MEAS_SERIES: 3,
-    LOW_BATTERY_WARNING: 4,
-};

package/src/commands/types.d.ts

@@ -1,18 +0,0 @@
-export interface Commands {
-    START_WEIGHT_MEAS?: string;
-    STOP_WEIGHT_MEAS?: string;
-    SLEEP?: number | string;
-    GET_SERIAL?: string;
-    GET_TEXT?: string;
-    DEBUG_STREAM?: string;
-    GET_CALIBRATION?: string;
-    TARE_SCALE?: string;
-    START_PEAK_RFD_MEAS?: string;
-    START_PEAK_RFD_MEAS_SERIES?: string;
-    ADD_CALIB_POINT?: string;
-    SAVE_CALIB?: string;
-    GET_FW_VERSION?: string;
-    GET_ERR_INFO?: string;
-    CLR_ERR_INFO?: string;
-    GET_BATT_VLTG?: string;
-}

package/src/commands/types.js

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

package/src/connect.d.ts

@@ -1,7 +0,0 @@
-import { Device } from "./devices/types";
-/**
- * Connects to a Bluetooth device.
- * @param {Device} board - The device to connect to.
- * @param {Function} onSuccess - Callback function to execute on successful connection.
- */
-export declare const connect: (board: Device, onSuccess: () => void) => Promise<void>;