@hangtime/grip-connect 0.12.0 → 0.13.0

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.

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>
+}