@hangtime/grip-connect 0.10.9 → 0.13.0

package/src/interfaces/device/cts500.interface.ts

@@ -0,0 +1,113 @@
+import type { IDevice } from "../device.interface.js"
+
+export type CTS500BaudRate = 9600 | 19200 | 38400 | 57600 | 115200
+
+export type CTS500SamplingRate = 10 | 20 | 40 | 80 | 160 | 320
+
+/**
+ * Interface representing the CTS500 device, extending the base Device interface.
+ */
+export interface ICTS500 extends IDevice {
+  /**
+   * Retrieves battery voltage from the device.
+   * The returned string is the voltage in volts with two decimal places.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the battery voltage.
+   */
+  battery(): Promise<string | undefined>
+
+  /**
+   * Retrieves firmware version from the device.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the firmware version.
+   */
+  firmware(): Promise<string | undefined>
+
+  /**
+   * Retrieves hardware version from the device.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the hardware version.
+   */
+  hardware(): Promise<string | undefined>
+
+  /**
+   * Retrieves manufacturer information from the device.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the manufacturer information.
+   */
+  manufacturer(): Promise<string | undefined>
+
+  /**
+   * Retrieves model number from the device.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the model number.
+   */
+  model(): Promise<string | undefined>
+
+  /**
+   * Retrieves serial number from the device.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the serial number.
+   */
+  serial(): Promise<string | undefined>
+
+  /**
+   * Retrieves software version from the device.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the software version.
+   */
+  software(): Promise<string | undefined>
+
+  /**
+   * Sets whether the device should reset to zero on power-up.
+   * @param {boolean} enabled - Whether to reset to zero on power-up.
+   * @returns {Promise<void>} A Promise that resolves when the command has been acknowledged.
+   */
+  powerOnReset(enabled: boolean): Promise<void>
+
+  /**
+   * Enables or disables peak mode.
+   * @param {boolean} enabled - Whether peak mode should be enabled.
+   * @returns {Promise<void>} A Promise that resolves when the command has been acknowledged.
+   */
+  peakMode(enabled?: boolean): Promise<void>
+
+  /**
+   * Configures the transparent UART baud rate on the device.
+   * @param {CTS500BaudRate} baudRate - Desired baud rate.
+   * @returns {Promise<void>} A Promise that resolves when the command has been acknowledged.
+   */
+  setBaudRate(baudRate: CTS500BaudRate): Promise<void>
+
+  /**
+   * Configures the device A/D sampling rate.
+   * @param {CTS500SamplingRate} samplingRate - Desired A/D sampling rate in Hz.
+   * @returns {Promise<void>} A Promise that resolves when the command has been acknowledged.
+   */
+  setSamplingRate(samplingRate: CTS500SamplingRate): Promise<void>
+
+  /**
+   * Starts automatic weight uploads over the notify characteristic.
+   * @param {number} [duration=0] - Optional delay before the promise resolves.
+   * @returns {Promise<void>} A Promise that resolves once automatic upload has been enabled.
+   */
+  stream(duration?: number): Promise<void>
+
+  /**
+   * Stops automatic weight uploads over the notify characteristic.
+   * @returns {Promise<void>} A Promise that resolves once automatic upload has been disabled.
+   */
+  stop(): Promise<void>
+
+  /**
+   * Retrieves the current temperature reading from the device.
+   * The returned string is the temperature in Celsius.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the temperature.
+   */
+  temperature(): Promise<string | undefined>
+
+  /**
+   * Retrieves the current weight from the device in kilograms.
+   * @returns {Promise<number | undefined>} A Promise that resolves with the current weight.
+   */
+  weight(): Promise<number | undefined>
+
+  /**
+   * Updates the hardware zero point.
+   * @returns {Promise<void>} A Promise that resolves when the command has been acknowledged.
+   */
+  zero(): Promise<void>
+}

package/src/interfaces/device/forceboard.interface.ts

@@ -1,9 +1,9 @@
-import type { IDevice } from "../device.interface.js"
+import type { INordicDfuDevice } from "../nordic.interface.js"
 
 /**
  * Interface representing the PitchSix ForceBoard device, extending the base Device interface.
  */
-export interface IForceBoard extends IDevice {
+export interface IForceBoard extends INordicDfuDevice {
   /**
    * Retrieves battery or voltage information from the device.
    * @returns {Promise<string | undefined>} A Promise that resolves with the battery or voltage information.

package/src/interfaces/device/progressor.interface.ts

@@ -1,9 +1,9 @@
-import type { IDevice } from "../device.interface.js"
+import type { INordicDfuDevice } from "../nordic.interface.js"
 
 /**
  * Interface representing the Tindeq Progressor device, extending the base Device interface.
  */
-export interface IProgressor extends IDevice {
+export interface IProgressor extends INordicDfuDevice {
   /**
    * Retrieves battery or voltage information from the device.
    * @returns {Promise<string | undefined>} A Promise that resolves with the battery or voltage information.
@@ -23,12 +23,18 @@ export interface IProgressor extends IDevice {
   progressorId(): Promise<string | undefined>
 
   /**
-   * Retrieves calibration curve from the device (opcode 0x72). Payload is 12 opaque bytes;
-   * parsed for display as hex plus 3× uint32 LE.
-   * @returns {Promise<string | undefined>} A Promise that resolves with a display string (e.g. "hex — 1: X | 2: Y | 3: Z").
+   * Retrieves the linear calibration block from the device (opcode 0x72).
+   * Parsed for display as raw hex plus 3× float32 LE coefficients:
+   * slope, intercept, and trim. Firmware uses: value = raw * slope + intercept + trim.
    */
   calibration(): Promise<string | undefined>
 
+  /**
+   * Retrieves the hidden 15-entry piecewise calibration table.
+   * Returns newline-separated decoded records in export order.
+   */
+  calibrationTable(): Promise<string | undefined>
+
   /**
    * Computes calibration curve from stored points and saves to flash.
    * Call after addCalibrationPoint() for zero and reference. Normal flow: i → i → j.
@@ -42,9 +48,15 @@ export interface IProgressor extends IDevice {
   sleep(): Promise<void>
 
   /**
-   * Set a new calibration curve.
+   * Reboots the device immediately.
+   * Intended for diagnostic flows. Sends the firmware's required reboot-confirmation payload.
+   */
+  reboot(): Promise<void>
+
+  /**
+   * Set a new calibration block.
    * @warning Expert only. This will overwrite the current calibration curve.
-   * @param curve - The 12-byte calibration curve to set.
+   * @param curve - The 12-byte calibration block to set (3× float32 LE: slope, intercept, trim).
    */
   setCalibration(curve: Uint8Array): Promise<void>
 

package/src/interfaces/index.ts

@@ -1,5 +1,7 @@
 export type { IClimbro } from "./device/climbro.interface.js"
 
+export type { ICTS500 } from "./device/cts500.interface.js"
+
 export type { IEntralpi } from "./device/entralpi.interface.js"
 
 export type { IForceBoard } from "./device/forceboard.interface.js"
@@ -10,6 +12,8 @@ export type { IMotherboard } from "./device/motherboard.interface.js"
 
 export type { ImySmartBoard } from "./device/mysmartboard.interface.js"
 
+export type { INordicDfuDevice } from "./nordic.interface.js"
+
 export type { IProgressor } from "./device/progressor.interface.js"
 
 export type { ISmartBoardPro } from "./device/smartboard-pro.interface.js"

package/src/interfaces/nordic.interface.ts

@@ -0,0 +1,47 @@
+import type { IDevice } from "./device.interface.js"
+
+/**
+ * Shared Nordic Secure DFU functionality for devices that expose the FE59 DFU service.
+ */
+export interface INordicDfuDevice extends IDevice {
+  /**
+   * Switches the device from application mode into the Nordic DFU bootloader.
+   */
+  dfuSwitch(): Promise<void>
+
+  /**
+   * Sends a raw Nordic Secure DFU control operation and resolves with the response payload bytes.
+   * Call after dfuSwitch() has reconnected to the DFU bootloader.
+   */
+  dfuControl(operation: Uint8Array, payload?: ArrayBuffer): Promise<Uint8Array>
+
+  /**
+   * Sends Nordic Secure DFU SELECT for command or data objects and returns the bootloader state.
+   */
+  dfuSelect(objectType: "command" | "data"): Promise<{ maxSize: number; offset: number; crc: number }>
+
+  /**
+   * Sends Nordic Secure DFU CREATE for command or data objects.
+   */
+  dfuCreate(objectType: "command" | "data", size: number): Promise<void>
+
+  /**
+   * Writes raw bytes to the Nordic Secure DFU packet characteristic.
+   */
+  dfuWritePacket(data: Uint8Array | ArrayBuffer): Promise<void>
+
+  /**
+   * Sends Nordic Secure DFU CALCULATE_CHECKSUM and returns the bootloader state.
+   */
+  dfuChecksum(): Promise<{ offset: number; crc: number }>
+
+  /**
+   * Sends Nordic Secure DFU EXECUTE for the currently created object.
+   */
+  dfuExecute(): Promise<void>
+
+  /**
+   * Runs a complete Nordic Secure DFU upload: switch to bootloader, send init packet, then send firmware.
+   */
+  dfuUpload(initPacket: Uint8Array | ArrayBuffer, firmware: Uint8Array | ArrayBuffer): Promise<void>
+}

package/src/models/device/climbro.model.ts

@@ -57,10 +57,67 @@ export class Climbro extends Device implements IClimbro {
           uuid: "49535343-fe7d-4ae5-8fa9-9fafd205e455",
           characteristics: [
             {
-              name: "Read/Notify",
+              name: "UART Tramsmit (we set as rx)",
               id: "rx",
               uuid: "49535343-1e4d-4bd9-ba61-23c647249616",
             },
+            {
+              name: "UART Receive (we set as tx)",
+              id: "tx",
+              uuid: "49535343-8841-43f4-a8d4-ecbe34729bb3",
+            },
+            {
+              name: "Transparent Control Point",
+              id: "tcp",
+              uuid: "49535343-4c8a-39b3-2f49-511cff073b7e",
+            },
+          ],
+        },
+        {
+          name: "Device Information",
+          id: "device",
+          uuid: "0000180a-0000-1000-8000-00805f9b34fb",
+          characteristics: [
+            {
+              name: "System ID",
+              id: "system",
+              uuid: "00002a23-0000-1000-8000-00805f9b34fb",
+            },
+            {
+              name: "Model Number String",
+              id: "model", // RN487x
+              uuid: "00002a24-0000-1000-8000-00805f9b34fb",
+            },
+            // {
+            //   name: "Serial Number String (Blocked)",
+            //   id: "serial",
+            //   uuid: "00002a25-0000-1000-8000-00805f9b34fb",
+            // },
+            {
+              name: "Firmware Revision String",
+              id: "firmware",
+              uuid: "00002a26-0000-1000-8000-00805f9b34fb",
+            },
+            {
+              name: "Hardware Revision String",
+              id: "hardware", // 5505 102_BLDK3
+              uuid: "00002a27-0000-1000-8000-00805f9b34fb",
+            },
+            {
+              name: "Software Revision String",
+              id: "software", // 1.30
+              uuid: "00002a28-0000-1000-8000-00805f9b34fb",
+            },
+            {
+              name: "Manufacturer Name String",
+              id: "manufacturer", // Microchip
+              uuid: "00002a29-0000-1000-8000-00805f9b34fb",
+            },
+            {
+              name: "IEEE 11073-20601 Regulatory Certification Data List",
+              id: "certification",
+              uuid: "00002a2a-0000-1000-8000-00805f9b34fb",
+            },
           ],
         },
       ],
@@ -76,6 +133,46 @@ export class Climbro extends Device implements IClimbro {
     return this.batteryLevel.toString()
   }
 
+  /**
+   * Retrieves hardware version from the device.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the hardware version.
+   */
+  hardware = async (): Promise<string | undefined> => {
+    return await this.read("device", "hardware", 250)
+  }
+
+  /**
+   * Retrieves manufacturer information from the device.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the manufacturer information.
+   */
+  manufacturer = async (): Promise<string | undefined> => {
+    return await this.read("device", "manufacturer", 250)
+  }
+
+  /**
+   * Retrieves model number from the device.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the model number.
+   */
+  model = async (): Promise<string | undefined> => {
+    return await this.read("device", "model", 250)
+  }
+
+  /**
+   * Retrieves software version from the device.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the software version.
+   */
+  software = async (): Promise<string | undefined> => {
+    return await this.read("device", "software", 250)
+  }
+
+  /**
+   * Retrieves system id from the device.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the system id.
+   */
+  system = async (): Promise<string | undefined> => {
+    return await this.read("device", "system", 250)
+  }
+
   /**
    * Handles data received from the device, processes force measurements and battery data
    * according to the Climbro protocol.