@hangtime/grip-connect 0.12.0 → 0.13.1

package/src/index.ts

@@ -1,10 +1,13 @@
 export type {
+  AuroraLedPlacement,
+  IAurora,
   IClimbro,
+  ICTS500,
   IEntralpi,
   IForceBoard,
-  IKilterBoard,
   IMotherboard,
   ImySmartBoard,
+  IPB700BT,
   IProgressor,
   ISmartBoardPro,
   IWHC06,
@@ -19,11 +22,11 @@ export type {
 } from "./interfaces/callback.interface.js"
 
 export {
+  AuroraBoard,
   Climbro,
+  CTS500,
   Entralpi,
   ForceBoard,
-  KilterBoard,
-  KilterBoardPlacementRoles,
   Motherboard,
   mySmartBoard,
   PB700BT,

package/src/interfaces/command.interface.ts

@@ -8,25 +8,25 @@ export interface Commands {
    * Starts a weight measurement on the device.
    * Used to begin collecting weight or force data.
    */
-  START_WEIGHT_MEAS?: string
+  START_WEIGHT_MEAS?: string | Uint8Array
 
   /**
    * Stops the current weight measurement on the device.
    * Used to end the data collection.
    */
-  STOP_WEIGHT_MEAS?: string
+  STOP_WEIGHT_MEAS?: string | Uint8Array
 
   /**
    * Puts the device to sleep or in a low-power mode.
    * The format can be a string or a number depending on the device.
    */
-  SLEEP?: number | string
+  SLEEP?: number | string | Uint8Array
 
   /**
    * Retrieves the serial number of the device.
    * This command fetches the unique identifier assigned by the manufacturer.
    */
-  GET_SERIAL?: string
+  GET_SERIAL?: string | Uint8Array
 
   // Griptonite Motherboard
 
@@ -34,19 +34,19 @@ export interface Commands {
    * Retrieves textual information from the device.
    * May include readable data.
    */
-  GET_TEXT?: string
+  GET_TEXT?: string | Uint8Array
 
   /**
    * Starts or stops a debug data stream from the device.
    * Used for diagnostic purposes or to monitor real-time data.
    */
-  DEBUG_STREAM?: string
+  DEBUG_STREAM?: string | Uint8Array
 
   /**
    * Retrieves calibration data from the device.
    * Used to ensure accurate measurements by applying calibration points.
    */
-  GET_CALIBRATION?: string
+  GET_CALIBRATION?: string | Uint8Array
 
   // Force Board Portable
 
@@ -55,7 +55,7 @@ export interface Commands {
    * In this mode, data transmission starts when force exceeds the threshold
    * and stops when force drops below the threshold.
    */
-  START_QUICK_MEAS?: string
+  START_QUICK_MEAS?: string | Uint8Array
 
   // Tindeq Progressor
 
@@ -63,76 +63,186 @@ export interface Commands {
    * Tares the scale, zeroing the current weight measurement.
    * Used to reset the baseline for weight data.
    */
-  TARE_SCALE?: string
+  TARE_SCALE?: string | Uint8Array
 
   /**
    * Starts measuring the peak rate of force development (RFD).
    * Captures how quickly force is applied over time.
    */
-  START_PEAK_RFD_MEAS?: string
+  START_PEAK_RFD_MEAS?: string | Uint8Array
 
   /**
    * Starts measuring a series of peak RFD measurements.
    * This captures multiple RFD data points over a period of time.
    */
-  START_PEAK_RFD_MEAS_SERIES?: string
+  START_PEAK_RFD_MEAS_SERIES?: string | Uint8Array
 
   /**
    * Adds a calibration point to the device.
    * Used to improve the accuracy of future measurements.
    */
-  ADD_CALIBRATION_POINT?: string
+  ADD_CALIBRATION_POINT?: string | Uint8Array
 
   /**
    * Saves the current calibration settings to the device.
    * Ensures the device remembers the calibration for future sessions.
    */
-  SAVE_CALIBRATION?: string
+  SAVE_CALIBRATION?: string | Uint8Array
 
   /**
    * Retrieves the firmware version of the device.
    * Useful for ensuring compatibility and tracking updates.
    */
-  GET_FIRMWARE_VERSION?: string
+  GET_FIRMWARE_VERSION?: string | Uint8Array
 
   /**
    * Retrieves error information from the device.
    * Provides details on any faults or issues that occurred during operation.
    */
-  GET_ERROR_INFORMATION?: string
+  GET_ERROR_INFORMATION?: string | Uint8Array
 
   /**
    * Clears the error information on the device.
    * Used to reset error logs after troubleshooting or repair.
    */
-  CLR_ERROR_INFORMATION?: string
+  CLR_ERROR_INFORMATION?: string | Uint8Array
 
   /**
    * Retrieves the battery voltage level of the device.
    * Provides insight into the device's remaining battery power.
    */
-  GET_BATTERY_VOLTAGE?: string
+  GET_BATTERY_VOLTAGE?: string | Uint8Array
+
+  /**
+   * Retrieves a temperature reading from the device.
+   */
+  GET_TEMPERATURE?: string | Uint8Array
+
+  /**
+   * Retrieves the current weight from the device.
+   */
+  GET_WEIGHT?: string | Uint8Array
+
+  /**
+   * Sets the device capacity/range.
+   * Payload selects the target range.
+   */
+  SET_RANGE?: string | number | Uint8Array
+
+  /**
+   * Sets the display division value.
+   * Payload selects the target division.
+   */
+  SET_DIVISION?: string | number | Uint8Array
+
+  /**
+   * Sets the first calibration reference weight.
+   * Payload selects the target calibration mass.
+   */
+  SET_FIRST_CALIBRATION_WEIGHT?: string | number | Uint8Array
+
+  /**
+   * Sets the second calibration reference weight.
+   * Payload selects the target calibration mass.
+   */
+  SET_SECOND_CALIBRATION_WEIGHT?: string | number | Uint8Array
+
+  /**
+   * Runs the no-load calibration routine.
+   */
+  NO_LOAD_CALIBRATION?: string | Uint8Array
+
+  /**
+   * Runs the first calibration step after the reference mass is applied.
+   */
+  RUN_FIRST_CALIBRATION?: string | Uint8Array
+
+  /**
+   * Runs the second calibration step after the reference mass is applied.
+   */
+  RUN_SECOND_CALIBRATION?: string | Uint8Array
+
+  /**
+   * Configures the automatic shutdown timer.
+   * Payload selects the timeout or disables it.
+   */
+  SET_SHUTDOWN_TIME?: string | number | Uint8Array
+
+  /**
+   * Configures the upper temperature limit threshold.
+   */
+  SET_UPPER_TEMPERATURE_LIMIT?: string | number | Uint8Array
+
+  /**
+   * Configures the lower temperature limit threshold.
+   */
+  SET_LOWER_TEMPERATURE_LIMIT?: string | number | Uint8Array
+
+  /**
+   * Configures the upper/max weight limit threshold.
+   */
+  SET_MAX_WEIGHT_LIMIT?: string | number | Uint8Array
+
+  /**
+   * Configures the lower/min weight limit threshold.
+   */
+  SET_MIN_WEIGHT_LIMIT?: string | number | Uint8Array
+
+  /**
+   * Configures the weight-alarm behavior for the configured upper/lower thresholds.
+   */
+  SET_WEIGHT_ALARM_MODE?: string | number | Uint8Array
+
+  /**
+   * Enables or disables alarm-frame output over the serial/BLE transport.
+   */
+  SET_ALARM_OUTPUT?: string | number | Uint8Array
 
   /**
    * Get the Progressor ID.
    */
-  GET_PROGRESSOR_ID?: string
+  GET_PROGRESSOR_ID?: string | Uint8Array
 
   /**
    * Set calibration block. Payload at offsets +2,+6,+10.
    * The 12-byte block is interpreted as 3× float32 LE: slope, intercept, trim.
    */
-  SET_CALIBRATION?: string
+  SET_CALIBRATION?: string | Uint8Array
 
   /**
    * Retrieves the advanced calibration table from the device.
    * Used to inspect the hidden piecewise interpolation table exported by v2 firmware.
    */
-  GET_CALIBRATION_TABLE?: string
+  GET_CALIBRATION_TABLE?: string | Uint8Array
+
+  /**
+   * Controls whether the device resets to zero on power-up.
+   */
+  POWER_ON_RESET?: string | number | Uint8Array
+
+  /**
+   * Updates the device's hardware zero point.
+   */
+  ZERO_SCALE?: string | number | Uint8Array
+
+  /**
+   * Toggles the device's peak mode.
+   */
+  PEAK_MODE?: string | number | Uint8Array
+
+  /**
+   * Configures the device UART baud rate.
+   */
+  SET_BAUD_RATE?: string | number | Uint8Array
+
+  /**
+   * Configures the device sampling rate.
+   */
+  SET_SAMPLING_RATE?: string | number | Uint8Array
 
   /**
    * Reboots the device immediately.
    * Intended for diagnostic flows.
    */
-  REBOOT?: string
+  REBOOT?: string | Uint8Array
 }

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

@@ -0,0 +1,18 @@
+import type { IDevice } from "../device.interface.js"
+
+export interface AuroraLedPlacement {
+  position: number
+  color: string
+}
+
+/**
+ * Interface representing an Aurora LED board device.
+ */
+export interface IAurora extends IDevice {
+  /**
+   * Configures the LEDs based on an array of climb placements.
+   * @param config - Array of climb placements for the LEDs. Each placement must include an LED position and color hex string.
+   * @returns A promise that resolves with the payload array if LED settings were applied, or `undefined` if no action was taken.
+   */
+  led(config?: AuroraLedPlacement[]): Promise<number[] | undefined>
+}

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/motherboard.interface.ts

@@ -31,7 +31,7 @@ export interface IMotherboard extends IDevice {
   /**
    * Sets the LED color based on a single color option.
    * @param {"green" | "red" | "orange"} [config] - Optional color for the LEDs.
-   * @returns {Promise<number[] | undefined>} A promise that resolves with the payload array for the Kilter Board if LED settings were applied.
+   * @returns {Promise<number[] | undefined>} A promise that resolves with the payload array for Aurora-compatible LED settings if LEDs were applied.
    */
   led(config?: "green" | "red" | "orange"): Promise<number[] | undefined>
 

package/src/interfaces/device/pb-700bt.interface.ts

@@ -0,0 +1,61 @@
+import type { IDevice } from "../device.interface.js"
+
+/**
+ * Interface representing the NSD PB-700BT device, extending the base Device interface.
+ */
+export interface IPB700BT extends IDevice {
+  /**
+   * Retrieves battery or voltage information from the device.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the battery or voltage information.
+   */
+  battery(): Promise<string | undefined>
+
+  /**
+   * Retrieves IEEE 11073-20601 Regulatory Certification from the device.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the firmware version.
+   */
+  certification(): 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 PnP ID from the device, a set of values that used to create a device ID value that is unique for this device.
+   * Included in the characteristic is a Vendor ID Source field, a Vendor ID field, a Product ID field and a Product Version field
+   * @returns {Promise<string | undefined>} A Promise that resolves with the PnP ID.
+   */
+  pnp(): 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>
+
+  /**
+   * Retrieves system id from the device.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the system id.
+   */
+  system(): Promise<string | undefined>
+}

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.

package/src/interfaces/index.ts

@@ -1,15 +1,21 @@
 export type { IClimbro } from "./device/climbro.interface.js"
 
+export type { AuroraLedPlacement, IAurora } from "./device/aurora.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"
 
-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 { INordicDfuDevice } from "./nordic.interface.js"
+
+export type { IPB700BT } from "./device/pb-700bt.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>
+}