@zaber/motion 8.3.0 → 9.0.0

package/dist/lib/microscopy/objective_changer.js.map

@@ -1 +1 @@
-{"version":3,"file":"objective_changer.js","sourceRoot":"","sources":["../../../src/microscopy/objective_changer.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtD,oDAAsC;AAItC,sDAAwC;AACxC,oCAAwD;AAExD;;;;GAIG;AACH,MAAa,gBAAgB;IAC3B;;OAEG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAGD;;OAEG;IACH,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAGD;;;OAGG;IACH,YAAY,MAAc,EAAE,SAAe;QACzC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,gBAAgB,EAAE,CAAC;IAC1B,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CACjB,SAAiB,EACjB,UAA0C,EAAE;QAE5C,MAAM,EACJ,WAAW,GACZ,GAAG,OAAO,CAAC;QACZ,MAAM,OAAO,GAA6D;YACxE,GAAG,QAAQ,CAAC,6BAA6B,CAAC,OAAO;YACjD,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW;YAC/C,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,aAAa;YACxC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,aAAa;YACjD,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU;YACpC,SAAS,EAAE,SAAS;YACpB,WAAW,EAAE,WAAW;YACxB,QAAQ;gBACN,OAAO,QAAQ,CAAC,6BAA6B,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC/D,CAAC;SACF,CAAC;QAEF,MAAM,OAAO,CAAC,SAAS,CAAC,0BAA0B,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,OAAO;QAClB,MAAM,OAAO,GAAuD;YAClE,GAAG,QAAQ,CAAC,uBAAuB,CAAC,OAAO;YAC3C,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW;YAC/C,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,aAAa;YACxC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,aAAa;YACjD,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU;YACpC,QAAQ;gBACN,OAAO,QAAQ,CAAC,uBAAuB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACzD,CAAC;SACF,CAAC;QAEF,MAAM,OAAO,CAAC,SAAS,CAAC,2BAA2B,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,mBAAmB;QAC9B,MAAM,OAAO,GAAgD;YAC3D,GAAG,QAAQ,CAAC,gBAAgB,CAAC,OAAO;YACpC,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW;YAC/C,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,aAAa;YACjC,IAAI,EAAE,CAAC;YACP,QAAQ;gBACN,OAAO,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAClD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,2BAA2B,EAC3B,OAAO,EACP,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;QACnC,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,qBAAqB;QAChC,MAAM,OAAO,GAAgD;YAC3D,GAAG,QAAQ,CAAC,gBAAgB,CAAC,OAAO;YACpC,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW;YAC/C,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,aAAa;YACjC,IAAI,EAAE,CAAC;YACP,QAAQ;gBACN,OAAO,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAClD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,wBAAwB,EACxB,OAAO,EACP,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;QACnC,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,aAAa,CACxB,OAAgC,aAAK,CAAC,MAAM;QAE5C,MAAM,OAAO,GAA0D;YACrE,GAAG,QAAQ,CAAC,0BAA0B,CAAC,OAAO;YAC9C,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW;YAC/C,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,aAAa;YACxC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,aAAa;YACjD,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU;YACpC,IAAI,EAAE,IAAI;YACV,QAAQ;gBACN,OAAO,QAAQ,CAAC,0BAA0B,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC5D,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,6BAA6B,EAC7B,OAAO,EACP,QAAQ,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QACtC,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,aAAa,CACxB,KAAa,EACb,OAAgC,aAAK,CAAC,MAAM;QAE5C,MAAM,OAAO,GAA0D;YACrE,GAAG,QAAQ,CAAC,0BAA0B,CAAC,OAAO;YAC9C,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW;YAC/C,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,aAAa;YACxC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,aAAa;YACjD,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU;YACpC,KAAK,EAAE,KAAK;YACZ,IAAI,EAAE,IAAI;YACV,QAAQ;gBACN,OAAO,QAAQ,CAAC,0BAA0B,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC5D,CAAC;SACF,CAAC;QAEF,MAAM,OAAO,CAAC,SAAS,CAAC,6BAA6B,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;OAEG;IACK,gBAAgB;QACtB,MAAM,OAAO,GAAuD;YAClE,GAAG,QAAQ,CAAC,uBAAuB,CAAC,OAAO;YAC3C,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW;YAC/C,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,aAAa;YACxC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,aAAa;YACjD,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU;YACpC,QAAQ;gBACN,OAAO,QAAQ,CAAC,uBAAuB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACzD,CAAC;SACF,CAAC;QAEF,OAAO,CAAC,QAAQ,CAAC,0BAA0B,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAED;;;OAGG;IACI,QAAQ;QACb,MAAM,OAAO,GAAmD;YAC9D,GAAG,QAAQ,CAAC,mBAAmB,CAAC,OAAO;YACvC,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW;YAC/C,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,aAAa;YACjC,QAAQ;gBACN,OAAO,QAAQ,CAAC,mBAAmB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACrD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,yBAAyB,EACzB,OAAO,EACP,QAAQ,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QACtC,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;CACF;AAtND,4CAsNC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport * as gateway from '../gateway';\nimport { Device } from '../ascii/device';\nimport { Axis } from '../ascii/axis';\nimport { Measurement } from '../measurement';\nimport * as requests from '../requests';\nimport { Angle, Length, Native, Units } from '../units';\n\n/**\n * Represents an objective changer of a microscope.\n * Unstable. Expect breaking changes in future releases.\n * Requires at least Firmware 7.32.\n */\nexport class ObjectiveChanger {\n  /**\n   * Device address of the turret.\n   */\n  public get turret(): Device {\n    return this._turret;\n  }\n  private _turret: Device;\n\n  /**\n   * The focus axis.\n   */\n  public get focusAxis(): Axis {\n    return this._focusAxis;\n  }\n  private _focusAxis: Axis;\n\n  /**\n   * Creates instance of `ObjectiveChanger` based on the given device.\n   * If the device is identified, this constructor will ensure it is an objective changer.\n   */\n  constructor(turret: Device, focusAxis: Axis) {\n    this._turret = turret;\n    this._focusAxis = focusAxis;\n    this._verifyIsChanger();\n  }\n\n  /**\n   * Changes the objective.\n   * Runs a sequence of movements switching from the current objective to the new one.\n   * The focus stage moves to the focus datum after the objective change.\n   * @param objective Objective number starting from 1.\n   * @param options.focusOffset Optional offset from the focus datum.\n   */\n  public async change(\n    objective: number,\n    options: ObjectiveChanger.ChangeOptions = {}\n  ): Promise<void> {\n    const {\n      focusOffset,\n    } = options;\n    const request: requests.ObjectiveChangerChangeRequest & gateway.Message = {\n      ...requests.ObjectiveChangerChangeRequest.DEFAULT,\n      interfaceId: this.turret.connection.interfaceId,\n      turretAddress: this.turret.deviceAddress,\n      focusAddress: this.focusAxis.device.deviceAddress,\n      focusAxis: this.focusAxis.axisNumber,\n      objective: objective,\n      focusOffset: focusOffset,\n      toBinary() {\n        return requests.ObjectiveChangerChangeRequest.toBinary(this);\n      },\n    };\n\n    await gateway.callAsync('objective_changer/change', request);\n  }\n\n  /**\n   * Moves the focus stage out of the turret releasing the current objective.\n   */\n  public async release(): Promise<void> {\n    const request: requests.ObjectiveChangerRequest & gateway.Message = {\n      ...requests.ObjectiveChangerRequest.DEFAULT,\n      interfaceId: this.turret.connection.interfaceId,\n      turretAddress: this.turret.deviceAddress,\n      focusAddress: this.focusAxis.device.deviceAddress,\n      focusAxis: this.focusAxis.axisNumber,\n      toBinary() {\n        return requests.ObjectiveChangerRequest.toBinary(this);\n      },\n    };\n\n    await gateway.callAsync('objective_changer/release', request);\n  }\n\n  /**\n   * Returns current objective number starting from 1.\n   * The value of 0 indicates that the position is either unknown or between two objectives.\n   * @returns Current objective number starting from 1 or 0 if not applicable.\n   */\n  public async getCurrentObjective(): Promise<number> {\n    const request: requests.AxisEmptyRequest & gateway.Message = {\n      ...requests.AxisEmptyRequest.DEFAULT,\n      interfaceId: this.turret.connection.interfaceId,\n      device: this.turret.deviceAddress,\n      axis: 1,\n      toBinary() {\n        return requests.AxisEmptyRequest.toBinary(this);\n      },\n    };\n\n    const response = await gateway.callAsync<requests.IntResponse>(\n      'device/get_index_position',\n      request,\n      requests.IntResponse.fromBinary);\n    return response.value;\n  }\n\n  /**\n   * Gets number of objectives that the turret can accommodate.\n   * @returns Number of positions.\n   */\n  public async getNumberOfObjectives(): Promise<number> {\n    const request: requests.AxisEmptyRequest & gateway.Message = {\n      ...requests.AxisEmptyRequest.DEFAULT,\n      interfaceId: this.turret.connection.interfaceId,\n      device: this.turret.deviceAddress,\n      axis: 1,\n      toBinary() {\n        return requests.AxisEmptyRequest.toBinary(this);\n      },\n    };\n\n    const response = await gateway.callAsync<requests.IntResponse>(\n      'device/get_index_count',\n      request,\n      requests.IntResponse.fromBinary);\n    return response.value;\n  }\n\n  /**\n   * Gets the focus datum.\n   * The focus datum is the position that the focus stage moves to after an objective change.\n   * It is backed by the limit.home.offset setting.\n   * @param [unit=Units.NATIVE] Units of datum.\n   * @returns The datum.\n   */\n  public async getFocusDatum(\n    unit: Length | Angle | Native = Units.NATIVE\n  ): Promise<number> {\n    const request: requests.ObjectiveChangerSetRequest & gateway.Message = {\n      ...requests.ObjectiveChangerSetRequest.DEFAULT,\n      interfaceId: this.turret.connection.interfaceId,\n      turretAddress: this.turret.deviceAddress,\n      focusAddress: this.focusAxis.device.deviceAddress,\n      focusAxis: this.focusAxis.axisNumber,\n      unit: unit,\n      toBinary() {\n        return requests.ObjectiveChangerSetRequest.toBinary(this);\n      },\n    };\n\n    const response = await gateway.callAsync<requests.DoubleResponse>(\n      'objective_changer/get_datum',\n      request,\n      requests.DoubleResponse.fromBinary);\n    return response.value;\n  }\n\n  /**\n   * Sets the focus datum.\n   * The focus datum is the position that the focus stage moves to after an objective change.\n   * It is backed by the limit.home.offset setting.\n   * @param datum Value of datum.\n   * @param [unit=Units.NATIVE] Units of datum.\n   */\n  public async setFocusDatum(\n    datum: number,\n    unit: Length | Angle | Native = Units.NATIVE\n  ): Promise<void> {\n    const request: requests.ObjectiveChangerSetRequest & gateway.Message = {\n      ...requests.ObjectiveChangerSetRequest.DEFAULT,\n      interfaceId: this.turret.connection.interfaceId,\n      turretAddress: this.turret.deviceAddress,\n      focusAddress: this.focusAxis.device.deviceAddress,\n      focusAxis: this.focusAxis.axisNumber,\n      value: datum,\n      unit: unit,\n      toBinary() {\n        return requests.ObjectiveChangerSetRequest.toBinary(this);\n      },\n    };\n\n    await gateway.callAsync('objective_changer/set_datum', request);\n  }\n\n  /**\n   * Checks if this is a objective changer and throws an error if it is not.\n   */\n  private _verifyIsChanger(): void {\n    const request: requests.ObjectiveChangerRequest & gateway.Message = {\n      ...requests.ObjectiveChangerRequest.DEFAULT,\n      interfaceId: this.turret.connection.interfaceId,\n      turretAddress: this.turret.deviceAddress,\n      focusAddress: this.focusAxis.device.deviceAddress,\n      focusAxis: this.focusAxis.axisNumber,\n      toBinary() {\n        return requests.ObjectiveChangerRequest.toBinary(this);\n      },\n    };\n\n    gateway.callSync('objective_changer/verify', request);\n  }\n\n  /**\n   * Returns a string that represents the device.\n   * @returns A string that represents the device.\n   */\n  public toString(): string {\n    const request: requests.AxisToStringRequest & gateway.Message = {\n      ...requests.AxisToStringRequest.DEFAULT,\n      interfaceId: this.turret.connection.interfaceId,\n      device: this.turret.deviceAddress,\n      toBinary() {\n        return requests.AxisToStringRequest.toBinary(this);\n      },\n    };\n\n    const response = gateway.callSync<requests.StringResponse>(\n      'device/device_to_string',\n      request,\n      requests.StringResponse.fromBinary);\n    return response.value;\n  }\n}\n\nnamespace ObjectiveChanger {\n  export interface ChangeOptions {\n      /**\n       * Optional offset from the focus datum.\n       */\n      focusOffset?: Measurement;\n  }\n}\n"]}
+{"version":3,"file":"objective_changer.js","sourceRoot":"","sources":["../../../src/microscopy/objective_changer.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;;;;;AAItD,oDAAsC;AAEtC,sDAAwC;AACxC,oCAAwD;AAExD;;;;GAIG;AACH,MAAa,gBAAgB;IAC3B;;OAEG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAGD;;OAEG;IACH,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAGD;;;OAGG;IACH,YAAY,MAAc,EAAE,SAAe;QACzC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,gBAAgB,EAAE,CAAC;IAC1B,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CACjB,SAAiB,EACjB,UAA0C,EAAE;QAE5C,MAAM,EACJ,WAAW,GACZ,GAAG,OAAO,CAAC;QACZ,MAAM,OAAO,GAA6D;YACxE,GAAG,QAAQ,CAAC,6BAA6B,CAAC,OAAO;YACjD,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW;YAC/C,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,aAAa;YACxC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,aAAa;YACjD,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU;YACpC,SAAS,EAAE,SAAS;YACpB,WAAW,EAAE,WAAW;YACxB,QAAQ;gBACN,OAAO,QAAQ,CAAC,6BAA6B,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC/D,CAAC;SACF,CAAC;QAEF,MAAM,OAAO,CAAC,SAAS,CAAC,0BAA0B,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,OAAO;QAClB,MAAM,OAAO,GAAuD;YAClE,GAAG,QAAQ,CAAC,uBAAuB,CAAC,OAAO;YAC3C,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW;YAC/C,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,aAAa;YACxC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,aAAa;YACjD,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU;YACpC,QAAQ;gBACN,OAAO,QAAQ,CAAC,uBAAuB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACzD,CAAC;SACF,CAAC;QAEF,MAAM,OAAO,CAAC,SAAS,CAAC,2BAA2B,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,mBAAmB;QAC9B,MAAM,OAAO,GAAgD;YAC3D,GAAG,QAAQ,CAAC,gBAAgB,CAAC,OAAO;YACpC,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW;YAC/C,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,aAAa;YACjC,IAAI,EAAE,CAAC;YACP,QAAQ;gBACN,OAAO,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAClD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,2BAA2B,EAC3B,OAAO,EACP,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;QACnC,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,qBAAqB;QAChC,MAAM,OAAO,GAAgD;YAC3D,GAAG,QAAQ,CAAC,gBAAgB,CAAC,OAAO;YACpC,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW;YAC/C,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,aAAa;YACjC,IAAI,EAAE,CAAC;YACP,QAAQ;gBACN,OAAO,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAClD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,wBAAwB,EACxB,OAAO,EACP,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;QACnC,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,aAAa,CACxB,OAAgC,aAAK,CAAC,MAAM;QAE5C,MAAM,OAAO,GAA0D;YACrE,GAAG,QAAQ,CAAC,0BAA0B,CAAC,OAAO;YAC9C,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW;YAC/C,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,aAAa;YACxC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,aAAa;YACjD,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU;YACpC,IAAI,EAAE,IAAI;YACV,QAAQ;gBACN,OAAO,QAAQ,CAAC,0BAA0B,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC5D,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,6BAA6B,EAC7B,OAAO,EACP,QAAQ,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QACtC,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,aAAa,CACxB,KAAa,EACb,OAAgC,aAAK,CAAC,MAAM;QAE5C,MAAM,OAAO,GAA0D;YACrE,GAAG,QAAQ,CAAC,0BAA0B,CAAC,OAAO;YAC9C,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW;YAC/C,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,aAAa;YACxC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,aAAa;YACjD,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU;YACpC,KAAK,EAAE,KAAK;YACZ,IAAI,EAAE,IAAI;YACV,QAAQ;gBACN,OAAO,QAAQ,CAAC,0BAA0B,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC5D,CAAC;SACF,CAAC;QAEF,MAAM,OAAO,CAAC,SAAS,CAAC,6BAA6B,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;OAEG;IACK,gBAAgB;QACtB,MAAM,OAAO,GAAuD;YAClE,GAAG,QAAQ,CAAC,uBAAuB,CAAC,OAAO;YAC3C,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW;YAC/C,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,aAAa;YACxC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,aAAa;YACjD,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU;YACpC,QAAQ;gBACN,OAAO,QAAQ,CAAC,uBAAuB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACzD,CAAC;SACF,CAAC;QAEF,OAAO,CAAC,QAAQ,CAAC,0BAA0B,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAED;;;OAGG;IACI,QAAQ;QACb,MAAM,OAAO,GAAmD;YAC9D,GAAG,QAAQ,CAAC,mBAAmB,CAAC,OAAO;YACvC,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW;YAC/C,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,aAAa;YACjC,QAAQ;gBACN,OAAO,QAAQ,CAAC,mBAAmB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACrD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,yBAAyB,EACzB,OAAO,EACP,QAAQ,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QACtC,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;CACF;AAtND,4CAsNC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport { Axis } from '../ascii/axis';\nimport { Device } from '../ascii/device';\nimport * as gateway from '../gateway';\nimport { Measurement } from '../measurement';\nimport * as requests from '../requests';\nimport { Angle, Length, Native, Units } from '../units';\n\n/**\n * Represents an objective changer of a microscope.\n * Unstable. Expect breaking changes in future releases.\n * Requires at least Firmware 7.32.\n */\nexport class ObjectiveChanger {\n  /**\n   * Device address of the turret.\n   */\n  public get turret(): Device {\n    return this._turret;\n  }\n  private _turret: Device;\n\n  /**\n   * The focus axis.\n   */\n  public get focusAxis(): Axis {\n    return this._focusAxis;\n  }\n  private _focusAxis: Axis;\n\n  /**\n   * Creates instance of `ObjectiveChanger` based on the given device.\n   * If the device is identified, this constructor will ensure it is an objective changer.\n   */\n  constructor(turret: Device, focusAxis: Axis) {\n    this._turret = turret;\n    this._focusAxis = focusAxis;\n    this._verifyIsChanger();\n  }\n\n  /**\n   * Changes the objective.\n   * Runs a sequence of movements switching from the current objective to the new one.\n   * The focus stage moves to the focus datum after the objective change.\n   * @param objective Objective number starting from 1.\n   * @param options.focusOffset Optional offset from the focus datum.\n   */\n  public async change(\n    objective: number,\n    options: ObjectiveChanger.ChangeOptions = {}\n  ): Promise<void> {\n    const {\n      focusOffset,\n    } = options;\n    const request: requests.ObjectiveChangerChangeRequest & gateway.Message = {\n      ...requests.ObjectiveChangerChangeRequest.DEFAULT,\n      interfaceId: this.turret.connection.interfaceId,\n      turretAddress: this.turret.deviceAddress,\n      focusAddress: this.focusAxis.device.deviceAddress,\n      focusAxis: this.focusAxis.axisNumber,\n      objective: objective,\n      focusOffset: focusOffset,\n      toBinary() {\n        return requests.ObjectiveChangerChangeRequest.toBinary(this);\n      },\n    };\n\n    await gateway.callAsync('objective_changer/change', request);\n  }\n\n  /**\n   * Moves the focus stage out of the turret releasing the current objective.\n   */\n  public async release(): Promise<void> {\n    const request: requests.ObjectiveChangerRequest & gateway.Message = {\n      ...requests.ObjectiveChangerRequest.DEFAULT,\n      interfaceId: this.turret.connection.interfaceId,\n      turretAddress: this.turret.deviceAddress,\n      focusAddress: this.focusAxis.device.deviceAddress,\n      focusAxis: this.focusAxis.axisNumber,\n      toBinary() {\n        return requests.ObjectiveChangerRequest.toBinary(this);\n      },\n    };\n\n    await gateway.callAsync('objective_changer/release', request);\n  }\n\n  /**\n   * Returns current objective number starting from 1.\n   * The value of 0 indicates that the position is either unknown or between two objectives.\n   * @returns Current objective number starting from 1 or 0 if not applicable.\n   */\n  public async getCurrentObjective(): Promise<number> {\n    const request: requests.AxisEmptyRequest & gateway.Message = {\n      ...requests.AxisEmptyRequest.DEFAULT,\n      interfaceId: this.turret.connection.interfaceId,\n      device: this.turret.deviceAddress,\n      axis: 1,\n      toBinary() {\n        return requests.AxisEmptyRequest.toBinary(this);\n      },\n    };\n\n    const response = await gateway.callAsync<requests.IntResponse>(\n      'device/get_index_position',\n      request,\n      requests.IntResponse.fromBinary);\n    return response.value;\n  }\n\n  /**\n   * Gets number of objectives that the turret can accommodate.\n   * @returns Number of positions.\n   */\n  public async getNumberOfObjectives(): Promise<number> {\n    const request: requests.AxisEmptyRequest & gateway.Message = {\n      ...requests.AxisEmptyRequest.DEFAULT,\n      interfaceId: this.turret.connection.interfaceId,\n      device: this.turret.deviceAddress,\n      axis: 1,\n      toBinary() {\n        return requests.AxisEmptyRequest.toBinary(this);\n      },\n    };\n\n    const response = await gateway.callAsync<requests.IntResponse>(\n      'device/get_index_count',\n      request,\n      requests.IntResponse.fromBinary);\n    return response.value;\n  }\n\n  /**\n   * Gets the focus datum.\n   * The focus datum is the position that the focus stage moves to after an objective change.\n   * It is backed by the limit.home.offset setting.\n   * @param [unit=Units.NATIVE] Units of datum.\n   * @returns The datum.\n   */\n  public async getFocusDatum(\n    unit: Length | Angle | Native = Units.NATIVE\n  ): Promise<number> {\n    const request: requests.ObjectiveChangerSetRequest & gateway.Message = {\n      ...requests.ObjectiveChangerSetRequest.DEFAULT,\n      interfaceId: this.turret.connection.interfaceId,\n      turretAddress: this.turret.deviceAddress,\n      focusAddress: this.focusAxis.device.deviceAddress,\n      focusAxis: this.focusAxis.axisNumber,\n      unit: unit,\n      toBinary() {\n        return requests.ObjectiveChangerSetRequest.toBinary(this);\n      },\n    };\n\n    const response = await gateway.callAsync<requests.DoubleResponse>(\n      'objective_changer/get_datum',\n      request,\n      requests.DoubleResponse.fromBinary);\n    return response.value;\n  }\n\n  /**\n   * Sets the focus datum.\n   * The focus datum is the position that the focus stage moves to after an objective change.\n   * It is backed by the limit.home.offset setting.\n   * @param datum Value of datum.\n   * @param [unit=Units.NATIVE] Units of datum.\n   */\n  public async setFocusDatum(\n    datum: number,\n    unit: Length | Angle | Native = Units.NATIVE\n  ): Promise<void> {\n    const request: requests.ObjectiveChangerSetRequest & gateway.Message = {\n      ...requests.ObjectiveChangerSetRequest.DEFAULT,\n      interfaceId: this.turret.connection.interfaceId,\n      turretAddress: this.turret.deviceAddress,\n      focusAddress: this.focusAxis.device.deviceAddress,\n      focusAxis: this.focusAxis.axisNumber,\n      value: datum,\n      unit: unit,\n      toBinary() {\n        return requests.ObjectiveChangerSetRequest.toBinary(this);\n      },\n    };\n\n    await gateway.callAsync('objective_changer/set_datum', request);\n  }\n\n  /**\n   * Checks if this is a objective changer and throws an error if it is not.\n   */\n  private _verifyIsChanger(): void {\n    const request: requests.ObjectiveChangerRequest & gateway.Message = {\n      ...requests.ObjectiveChangerRequest.DEFAULT,\n      interfaceId: this.turret.connection.interfaceId,\n      turretAddress: this.turret.deviceAddress,\n      focusAddress: this.focusAxis.device.deviceAddress,\n      focusAxis: this.focusAxis.axisNumber,\n      toBinary() {\n        return requests.ObjectiveChangerRequest.toBinary(this);\n      },\n    };\n\n    gateway.callSync('objective_changer/verify', request);\n  }\n\n  /**\n   * Returns a string that represents the device.\n   * @returns A string that represents the device.\n   */\n  public toString(): string {\n    const request: requests.AxisToStringRequest & gateway.Message = {\n      ...requests.AxisToStringRequest.DEFAULT,\n      interfaceId: this.turret.connection.interfaceId,\n      device: this.turret.deviceAddress,\n      toBinary() {\n        return requests.AxisToStringRequest.toBinary(this);\n      },\n    };\n\n    const response = gateway.callSync<requests.StringResponse>(\n      'device/device_to_string',\n      request,\n      requests.StringResponse.fromBinary);\n    return response.value;\n  }\n}\n\nnamespace ObjectiveChanger {\n  export interface ChangeOptions {\n      /**\n       * Optional offset from the focus datum.\n       */\n      focusOffset?: Measurement;\n  }\n}\n"]}

package/dist/lib/microscopy/wdi_autofocus_provider.d.ts

@@ -94,10 +94,10 @@ export declare class WdiAutofocusProvider {
      */
     toString(): string;
     /**
-    * Releases the native resources of the connection.
-    * Should only be called if your environment does not support FinalizationRegistry.
-    * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/FinalizationRegistry
-    */
+     * Releases the native resources of the wdi autofocus provider.
+     * Should only be called if your environment does not support FinalizationRegistry.
+     * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/FinalizationRegistry
+     */
     free(): void;
 }
 declare namespace WdiAutofocusProvider {

package/dist/lib/microscopy/wdi_autofocus_provider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"wdi_autofocus_provider.d.ts","sourceRoot":"","sources":["../../../src/microscopy/wdi_autofocus_provider.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAC;AAE7E;;GAEG;AACH,qBAAa,oBAAoB;IAC/B;;OAEG;IACH,gBAAuB,gBAAgB,EAAE,MAAM,CAAM;IAErD;;OAEG;IACH,IAAW,UAAU,IAAI,MAAM,CAE9B;IACD,OAAO,CAAC,WAAW,CAAS;IAE5B;;OAEG;IACH,IAAW,eAAe,IAAI,eAAe,CAE5C;gBAEW,UAAU,EAAE,MAAM;IAK9B;;;;;OAKG;WACiB,OAAO,CACzB,QAAQ,EAAE,MAAM,EAChB,IAAI,GAAE,MAA8C,GACnD,OAAO,CAAC,oBAAoB,CAAC;IAkBhC;;OAEG;IACU,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAYnC;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,KAAK;IAcpB;;;OAGG;IACH,OAAO,CAAC,wBAAwB;IAgBhC;;;;;;;;OAQG;IACU,WAAW,CACtB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,oBAAoB,CAAC,kBAAuB,GACpD,OAAO,CAAC,MAAM,EAAE,CAAC;IA0BpB;;;;;;;OAOG;IACU,YAAY,CACvB,UAAU,EAAE,MAAM,EAClB,IAAI,GAAE,MAAU,EAChB,IAAI,GAAE,MAAM,EAAO,EACnB,OAAO,GAAE,oBAAoB,CAAC,mBAAwB,GACrD,OAAO,CAAC,IAAI,CAAC;IAqBhB;;;;;;;OAOG;IACU,gBAAgB,CAC3B,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE,oBAAoB,CAAC,uBAA4B,GACzD,OAAO,CAAC,MAAM,EAAE,CAAC;IAyBpB;;;;;;OAMG;IACU,iBAAiB,CAC5B,UAAU,EAAE,MAAM,EAClB,IAAI,GAAE,MAAM,EAAO,EACnB,OAAO,GAAE,oBAAoB,CAAC,wBAA6B,GAC1D,OAAO,CAAC,IAAI,CAAC;IAoBhB;;OAEG;IACU,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAazC;;OAEG;IACU,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAa1C;;;OAGG;IACU,SAAS,IAAI,OAAO,CAAC,0BAA0B,CAAC;IAgB7D;;;OAGG;IACI,QAAQ,IAAI,MAAM;IAgBzB;;;;MAIE;IACK,IAAI,IAAI,IAAI;CAGpB;AAED,kBAAU,oBAAoB,CAAC;IAC7B,UAAiB,kBAAkB;QAC/B;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QACf;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;KACzB;IACD,UAAiB,mBAAmB;QAChC;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;KACzB;IACD,UAAiB,uBAAuB;QACpC;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QACf;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;KACzB;IACD,UAAiB,wBAAwB;QACrC;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;KACzB;CACF"}
+{"version":3,"file":"wdi_autofocus_provider.d.ts","sourceRoot":"","sources":["../../../src/microscopy/wdi_autofocus_provider.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAGtD,OAAO,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAC;AAE7E;;GAEG;AACH,qBAAa,oBAAoB;IAC/B;;OAEG;IACH,gBAAuB,gBAAgB,EAAE,MAAM,CAAM;IAErD;;OAEG;IACH,IAAW,UAAU,IAAI,MAAM,CAE9B;IACD,OAAO,CAAC,WAAW,CAAS;IAE5B;;OAEG;IACH,IAAW,eAAe,IAAI,eAAe,CAE5C;gBAEW,UAAU,EAAE,MAAM;IAK9B;;;;;OAKG;WACiB,OAAO,CACzB,QAAQ,EAAE,MAAM,EAChB,IAAI,GAAE,MAA8C,GACnD,OAAO,CAAC,oBAAoB,CAAC;IAkBhC;;OAEG;IACU,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAYnC;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,KAAK;IAcpB;;;OAGG;IACH,OAAO,CAAC,wBAAwB;IAgBhC;;;;;;;;OAQG;IACU,WAAW,CACtB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,oBAAoB,CAAC,kBAAuB,GACpD,OAAO,CAAC,MAAM,EAAE,CAAC;IA0BpB;;;;;;;OAOG;IACU,YAAY,CACvB,UAAU,EAAE,MAAM,EAClB,IAAI,GAAE,MAAU,EAChB,IAAI,GAAE,MAAM,EAAO,EACnB,OAAO,GAAE,oBAAoB,CAAC,mBAAwB,GACrD,OAAO,CAAC,IAAI,CAAC;IAqBhB;;;;;;;OAOG;IACU,gBAAgB,CAC3B,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE,oBAAoB,CAAC,uBAA4B,GACzD,OAAO,CAAC,MAAM,EAAE,CAAC;IAyBpB;;;;;;OAMG;IACU,iBAAiB,CAC5B,UAAU,EAAE,MAAM,EAClB,IAAI,GAAE,MAAM,EAAO,EACnB,OAAO,GAAE,oBAAoB,CAAC,wBAA6B,GAC1D,OAAO,CAAC,IAAI,CAAC;IAoBhB;;OAEG;IACU,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAazC;;OAEG;IACU,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAa1C;;;OAGG;IACU,SAAS,IAAI,OAAO,CAAC,0BAA0B,CAAC;IAgB7D;;;OAGG;IACI,QAAQ,IAAI,MAAM;IAgBzB;;;;OAIG;IACI,IAAI,IAAI,IAAI;CAGpB;AAED,kBAAU,oBAAoB,CAAC;IAC7B,UAAiB,kBAAkB;QAC/B;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QACf;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;KACzB;IACD,UAAiB,mBAAmB;QAChC;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;KACzB;IACD,UAAiB,uBAAuB;QACpC;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QACf;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;KACzB;IACD,UAAiB,wBAAwB;QACrC;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;KACzB;CACF"}

package/dist/lib/microscopy/wdi_autofocus_provider.js

@@ -26,10 +26,10 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WdiAutofocusProvider = void 0;
-const gateway = __importStar(require("../gateway"));
-const requests = __importStar(require("../requests"));
 const finalizer_1 = require("../finalizer");
 const firmware_version_1 = require("../firmware_version");
+const gateway = __importStar(require("../gateway"));
+const requests = __importStar(require("../requests"));
 /**
  * Class representing access to WDI Autofocus connection.
  */
@@ -266,10 +266,10 @@ class WdiAutofocusProvider {
         return response.value;
     }
     /**
-    * Releases the native resources of the connection.
-    * Should only be called if your environment does not support FinalizationRegistry.
-    * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/FinalizationRegistry
-    */
+     * Releases the native resources of the wdi autofocus provider.
+     * Should only be called if your environment does not support FinalizationRegistry.
+     * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/FinalizationRegistry
+     */
     free() {
         WdiAutofocusProvider._free(this.providerId);
     }

package/dist/lib/microscopy/wdi_autofocus_provider.js.map

@@ -1 +1 @@
-{"version":3,"file":"wdi_autofocus_provider.js","sourceRoot":"","sources":["../../../src/microscopy/wdi_autofocus_provider.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtD,oDAAsC;AACtC,sDAAwC;AACxC,4CAAuD;AACvD,0DAAsD;AAGtD;;GAEG;AACH,MAAa,oBAAoB;IAM/B;;OAEG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAGD;;OAEG;IACH,IAAW,eAAe;QACxB,OAAO,IAAI,CAAC,wBAAwB,EAAE,CAAC;IACzC,CAAC;IAED,YAAY,UAAkB;QAC5B,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAA,mCAAuB,EAAC,IAAI,EAAE,oBAAoB,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC;IACnF,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,OAAO,CACzB,QAAgB,EAChB,OAAe,oBAAoB,CAAC,gBAAgB;QAEpD,MAAM,OAAO,GAAoD;YAC/D,GAAG,QAAQ,CAAC,oBAAoB,CAAC,OAAO;YACxC,aAAa,EAAE,QAAQ,CAAC,aAAa,CAAC,GAAG;YACzC,QAAQ,EAAE,QAAQ;YAClB,IAAI,EAAE,IAAI;YACV,QAAQ;gBACN,OAAO,QAAQ,CAAC,oBAAoB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACtD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,UAAU,EACV,OAAO,EACP,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;QACnC,OAAO,IAAI,oBAAoB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAClD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,KAAK;QAChB,MAAM,OAAO,GAAqD;YAChE,GAAG,QAAQ,CAAC,qBAAqB,CAAC,OAAO;YACzC,WAAW,EAAE,IAAI,CAAC,UAAU;YAC5B,QAAQ;gBACN,OAAO,QAAQ,CAAC,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACvD,CAAC;SACF,CAAC;QAEF,MAAM,OAAO,CAAC,SAAS,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,KAAK,CAClB,UAAkB;QAElB,MAAM,OAAO,GAAqD;YAChE,GAAG,QAAQ,CAAC,qBAAqB,CAAC,OAAO;YACzC,WAAW,EAAE,UAAU;YACvB,QAAQ;gBACN,OAAO,QAAQ,CAAC,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACvD,CAAC;SACF,CAAC;QAEF,OAAO,CAAC,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IACxC,CAAC;IAED;;;OAGG;IACK,wBAAwB;QAC9B,MAAM,OAAO,GAAqD;YAChE,GAAG,QAAQ,CAAC,qBAAqB,CAAC,OAAO;YACzC,WAAW,EAAE,IAAI,CAAC,UAAU;YAC5B,QAAQ;gBACN,OAAO,QAAQ,CAAC,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACvD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,0BAA0B,EAC1B,OAAO,EACP,kCAAe,CAAC,UAAU,CAAC,CAAC;QAC9B,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,WAAW,CACtB,UAAkB,EAClB,IAAY,EACZ,UAAmD,EAAE;QAErD,MAAM,EACJ,KAAK,GAAG,CAAC,EACT,MAAM,GAAG,CAAC,EACV,YAAY,GAAG,GAAG,GACnB,GAAG,OAAO,CAAC;QACZ,MAAM,OAAO,GAAiD;YAC5D,GAAG,QAAQ,CAAC,iBAAiB,CAAC,OAAO;YACrC,WAAW,EAAE,IAAI,CAAC,UAAU;YAC5B,UAAU,EAAE,UAAU;YACtB,IAAI,EAAE,IAAI;YACV,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;YACd,YAAY,EAAE,YAAY;YAC1B,QAAQ;gBACN,OAAO,QAAQ,CAAC,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACnD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,UAAU,EACV,OAAO,EACP,QAAQ,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;QACxC,OAAO,QAAQ,CAAC,MAAM,CAAC;IACzB,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,YAAY,CACvB,UAAkB,EAClB,OAAe,CAAC,EAChB,OAAiB,EAAE,EACnB,UAAoD,EAAE;QAEtD,MAAM,EACJ,MAAM,GAAG,CAAC,EACV,YAAY,GAAG,GAAG,GACnB,GAAG,OAAO,CAAC;QACZ,MAAM,OAAO,GAAiD;YAC5D,GAAG,QAAQ,CAAC,iBAAiB,CAAC,OAAO;YACrC,WAAW,EAAE,IAAI,CAAC,UAAU;YAC5B,UAAU,EAAE,UAAU;YACtB,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,MAAM;YACd,YAAY,EAAE,YAAY;YAC1B,QAAQ;gBACN,OAAO,QAAQ,CAAC,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACnD,CAAC;SACF,CAAC;QAEF,MAAM,OAAO,CAAC,SAAS,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,gBAAgB,CAC3B,UAAkB,EAClB,UAAwD,EAAE;QAE1D,MAAM,EACJ,KAAK,GAAG,CAAC,EACT,MAAM,GAAG,CAAC,EACV,YAAY,GAAG,GAAG,GACnB,GAAG,OAAO,CAAC;QACZ,MAAM,OAAO,GAAsD;YACjE,GAAG,QAAQ,CAAC,sBAAsB,CAAC,OAAO;YAC1C,WAAW,EAAE,IAAI,CAAC,UAAU;YAC5B,UAAU,EAAE,UAAU;YACtB,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;YACd,YAAY,EAAE,YAAY;YAC1B,QAAQ;gBACN,OAAO,QAAQ,CAAC,sBAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACxD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,gBAAgB,EAChB,OAAO,EACP,QAAQ,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;QAC3C,OAAO,QAAQ,CAAC,MAAM,CAAC;IACzB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,iBAAiB,CAC5B,UAAkB,EAClB,OAAiB,EAAE,EACnB,UAAyD,EAAE;QAE3D,MAAM,EACJ,MAAM,GAAG,CAAC,EACV,YAAY,GAAG,GAAG,GACnB,GAAG,OAAO,CAAC;QACZ,MAAM,OAAO,GAAsD;YACjE,GAAG,QAAQ,CAAC,sBAAsB,CAAC,OAAO;YAC1C,WAAW,EAAE,IAAI,CAAC,UAAU;YAC5B,UAAU,EAAE,UAAU;YACtB,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,MAAM;YACd,YAAY,EAAE,YAAY;YAC1B,QAAQ;gBACN,OAAO,QAAQ,CAAC,sBAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACxD,CAAC;SACF,CAAC;QAEF,MAAM,OAAO,CAAC,SAAS,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,WAAW;QACtB,MAAM,OAAO,GAAiD;YAC5D,GAAG,QAAQ,CAAC,iBAAiB,CAAC,OAAO;YACrC,WAAW,EAAE,IAAI,CAAC,UAAU;YAC5B,UAAU,EAAE,CAAC;YACb,QAAQ;gBACN,OAAO,QAAQ,CAAC,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACnD,CAAC;SACF,CAAC;QAEF,MAAM,OAAO,CAAC,SAAS,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAAY;QACvB,MAAM,OAAO,GAAiD;YAC5D,GAAG,QAAQ,CAAC,iBAAiB,CAAC,OAAO;YACrC,WAAW,EAAE,IAAI,CAAC,UAAU;YAC5B,UAAU,EAAE,CAAC;YACb,QAAQ;gBACN,OAAO,QAAQ,CAAC,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACnD,CAAC;SACF,CAAC;QAEF,MAAM,OAAO,CAAC,SAAS,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,SAAS;QACpB,MAAM,OAAO,GAAqD;YAChE,GAAG,QAAQ,CAAC,qBAAqB,CAAC,OAAO;YACzC,WAAW,EAAE,IAAI,CAAC,UAAU;YAC5B,QAAQ;gBACN,OAAO,QAAQ,CAAC,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACvD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,gBAAgB,EAChB,OAAO,EACP,QAAQ,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QAC5C,OAAO,QAAQ,CAAC,MAAM,CAAC;IACzB,CAAC;IAED;;;OAGG;IACI,QAAQ;QACb,MAAM,OAAO,GAAqD;YAChE,GAAG,QAAQ,CAAC,qBAAqB,CAAC,OAAO;YACzC,WAAW,EAAE,IAAI,CAAC,UAAU;YAC5B,QAAQ;gBACN,OAAO,QAAQ,CAAC,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACvD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,eAAe,EACf,OAAO,EACP,QAAQ,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QACtC,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;IAED;;;;MAIE;IACK,IAAI;QACT,oBAAoB,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC9C,CAAC;;AArUH,oDAsUC;AArUC;;GAEG;AACoB,qCAAgB,GAAW,EAAE,CAAC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport * as gateway from '../gateway';\nimport * as requests from '../requests';\nimport { registerForFinalization } from '../finalizer';\nimport { FirmwareVersion } from '../firmware_version';\nimport { WdiAutofocusProviderStatus } from './wdi_autofocus_provider_status';\n\n/**\n * Class representing access to WDI Autofocus connection.\n */\nexport class WdiAutofocusProvider {\n  /**\n   * Default port number for TCP connections to WDI autofocus.\n   */\n  public static readonly DEFAULT_TCP_PORT: number = 27;\n\n  /**\n   * The ID identifies the autofocus with the underlying library.\n   */\n  public get providerId(): number {\n    return this._providerId;\n  }\n  private _providerId: number;\n\n  /**\n   * The firmware version of the connected autofocus.\n   */\n  public get firmwareVersion(): FirmwareVersion {\n    return this._retrieveFirmwareVersion();\n  }\n\n  constructor(providerId: number) {\n    this._providerId = providerId;\n    registerForFinalization(this, WdiAutofocusProvider._free.bind(null, providerId));\n  }\n\n  /**\n   * Opens a TCP connection to WDI autofocus.\n   * @param hostName Hostname or IP address.\n   * @param [port=WdiAutofocusProvider.DEFAULT_TCP_PORT] Optional port number (defaults to 27).\n   * @returns An object representing the autofocus connection.\n   */\n  public static async openTcp(\n    hostName: string,\n    port: number = WdiAutofocusProvider.DEFAULT_TCP_PORT\n  ): Promise<WdiAutofocusProvider> {\n    const request: requests.OpenInterfaceRequest & gateway.Message = {\n      ...requests.OpenInterfaceRequest.DEFAULT,\n      interfaceType: requests.InterfaceType.TCP,\n      hostName: hostName,\n      port: port,\n      toBinary() {\n        return requests.OpenInterfaceRequest.toBinary(this);\n      },\n    };\n\n    const response = await gateway.callAsync<requests.IntResponse>(\n      'wdi/open',\n      request,\n      requests.IntResponse.fromBinary);\n    return new WdiAutofocusProvider(response.value);\n  }\n\n  /**\n   * Close the connection.\n   */\n  public async close(): Promise<void> {\n    const request: requests.InterfaceEmptyRequest & gateway.Message = {\n      ...requests.InterfaceEmptyRequest.DEFAULT,\n      interfaceId: this.providerId,\n      toBinary() {\n        return requests.InterfaceEmptyRequest.toBinary(this);\n      },\n    };\n\n    await gateway.callAsync('wdi/close', request);\n  }\n\n  /**\n   * Frees the connection.\n   * @param providerId The ID of the connection to free.\n   */\n  private static _free(\n    providerId: number\n  ): void {\n    const request: requests.InterfaceEmptyRequest & gateway.Message = {\n      ...requests.InterfaceEmptyRequest.DEFAULT,\n      interfaceId: providerId,\n      toBinary() {\n        return requests.InterfaceEmptyRequest.toBinary(this);\n      },\n    };\n\n    gateway.callSync('wdi/free', request);\n  }\n\n  /**\n   * Returns FW version.\n   * @returns Firmware version.\n   */\n  private _retrieveFirmwareVersion(): FirmwareVersion {\n    const request: requests.InterfaceEmptyRequest & gateway.Message = {\n      ...requests.InterfaceEmptyRequest.DEFAULT,\n      interfaceId: this.providerId,\n      toBinary() {\n        return requests.InterfaceEmptyRequest.toBinary(this);\n      },\n    };\n\n    const response = gateway.callSync<FirmwareVersion>(\n      'wdi/get_firmware_version',\n      request,\n      FirmwareVersion.fromBinary);\n    return response;\n  }\n\n  /**\n   * Generic read operation.\n   * @param registerId Register address to read from.\n   * @param size Data size to read. Valid values are (1,2,4). Determines the data type (Byte, Word, DWord).\n   * @param [options.count=1] Number of values to read (defaults to 1).\n   * @param [options.offset=0] Offset within the register (defaults to 0).\n   * @param [options.registerBank='U'] Register bank letter (defaults to U for user bank).\n   * @returns Array of integers read from the device.\n   */\n  public async genericRead(\n    registerId: number,\n    size: number,\n    options: WdiAutofocusProvider.GenericReadOptions = {}\n  ): Promise<number[]> {\n    const {\n      count = 1,\n      offset = 0,\n      registerBank = 'U',\n    } = options;\n    const request: requests.WdiGenericRequest & gateway.Message = {\n      ...requests.WdiGenericRequest.DEFAULT,\n      interfaceId: this.providerId,\n      registerId: registerId,\n      size: size,\n      count: count,\n      offset: offset,\n      registerBank: registerBank,\n      toBinary() {\n        return requests.WdiGenericRequest.toBinary(this);\n      },\n    };\n\n    const response = await gateway.callAsync<requests.IntArrayResponse>(\n      'wdi/read',\n      request,\n      requests.IntArrayResponse.fromBinary);\n    return response.values;\n  }\n\n  /**\n   * Generic write operation.\n   * @param registerId Register address to write to.\n   * @param [size=0] Data size to write. Valid values are (0,1,2,4). Determines the data type (Nil, Byte, Word, DWord).\n   * @param [data=[]] Array of values to write to the register. Empty array is allowed.\n   * @param [options.offset=0] Offset within the register (defaults to 0).\n   * @param [options.registerBank='U'] Register bank letter (defaults to U for user bank).\n   */\n  public async genericWrite(\n    registerId: number,\n    size: number = 0,\n    data: number[] = [],\n    options: WdiAutofocusProvider.GenericWriteOptions = {}\n  ): Promise<void> {\n    const {\n      offset = 0,\n      registerBank = 'U',\n    } = options;\n    const request: requests.WdiGenericRequest & gateway.Message = {\n      ...requests.WdiGenericRequest.DEFAULT,\n      interfaceId: this.providerId,\n      registerId: registerId,\n      size: size,\n      data: data,\n      offset: offset,\n      registerBank: registerBank,\n      toBinary() {\n        return requests.WdiGenericRequest.toBinary(this);\n      },\n    };\n\n    await gateway.callAsync('wdi/write', request);\n  }\n\n  /**\n   * Generic read operation.\n   * @param registerId Register address to read from.\n   * @param [options.count=1] Number of values to read (defaults to 1).\n   * @param [options.offset=0] Offset within the register (defaults to 0).\n   * @param [options.registerBank='U'] Register bank letter (defaults to U for user bank).\n   * @returns Array of floats read from the device.\n   */\n  public async genericReadFloat(\n    registerId: number,\n    options: WdiAutofocusProvider.GenericReadFloatOptions = {}\n  ): Promise<number[]> {\n    const {\n      count = 1,\n      offset = 0,\n      registerBank = 'U',\n    } = options;\n    const request: requests.WdiGenericFloatRequest & gateway.Message = {\n      ...requests.WdiGenericFloatRequest.DEFAULT,\n      interfaceId: this.providerId,\n      registerId: registerId,\n      count: count,\n      offset: offset,\n      registerBank: registerBank,\n      toBinary() {\n        return requests.WdiGenericFloatRequest.toBinary(this);\n      },\n    };\n\n    const response = await gateway.callAsync<requests.DoubleArrayResponse>(\n      'wdi/read_float',\n      request,\n      requests.DoubleArrayResponse.fromBinary);\n    return response.values;\n  }\n\n  /**\n   * Generic write operation.\n   * @param registerId Register address to write to.\n   * @param [data=[]] Array of values to write to the register. Empty array is allowed.\n   * @param [options.offset=0] Offset within the register (defaults to 0).\n   * @param [options.registerBank='U'] Register bank letter (defaults to U for user bank).\n   */\n  public async genericWriteFloat(\n    registerId: number,\n    data: number[] = [],\n    options: WdiAutofocusProvider.GenericWriteFloatOptions = {}\n  ): Promise<void> {\n    const {\n      offset = 0,\n      registerBank = 'U',\n    } = options;\n    const request: requests.WdiGenericFloatRequest & gateway.Message = {\n      ...requests.WdiGenericFloatRequest.DEFAULT,\n      interfaceId: this.providerId,\n      registerId: registerId,\n      data: data,\n      offset: offset,\n      registerBank: registerBank,\n      toBinary() {\n        return requests.WdiGenericFloatRequest.toBinary(this);\n      },\n    };\n\n    await gateway.callAsync('wdi/write_float', request);\n  }\n\n  /**\n   * Enables the laser.\n   */\n  public async enableLaser(): Promise<void> {\n    const request: requests.WdiGenericRequest & gateway.Message = {\n      ...requests.WdiGenericRequest.DEFAULT,\n      interfaceId: this.providerId,\n      registerId: 1,\n      toBinary() {\n        return requests.WdiGenericRequest.toBinary(this);\n      },\n    };\n\n    await gateway.callAsync('wdi/write', request);\n  }\n\n  /**\n   * Disables the laser.\n   */\n  public async disableLaser(): Promise<void> {\n    const request: requests.WdiGenericRequest & gateway.Message = {\n      ...requests.WdiGenericRequest.DEFAULT,\n      interfaceId: this.providerId,\n      registerId: 2,\n      toBinary() {\n        return requests.WdiGenericRequest.toBinary(this);\n      },\n    };\n\n    await gateway.callAsync('wdi/write', request);\n  }\n\n  /**\n   * Gets the status of the autofocus.\n   * @returns The status of the autofocus.\n   */\n  public async getStatus(): Promise<WdiAutofocusProviderStatus> {\n    const request: requests.InterfaceEmptyRequest & gateway.Message = {\n      ...requests.InterfaceEmptyRequest.DEFAULT,\n      interfaceId: this.providerId,\n      toBinary() {\n        return requests.InterfaceEmptyRequest.toBinary(this);\n      },\n    };\n\n    const response = await gateway.callAsync<requests.WdiGetStatusResponse>(\n      'wdi/get_status',\n      request,\n      requests.WdiGetStatusResponse.fromBinary);\n    return response.status;\n  }\n\n  /**\n   * Returns a string that represents the autofocus connection.\n   * @returns A string that represents the connection.\n   */\n  public toString(): string {\n    const request: requests.InterfaceEmptyRequest & gateway.Message = {\n      ...requests.InterfaceEmptyRequest.DEFAULT,\n      interfaceId: this.providerId,\n      toBinary() {\n        return requests.InterfaceEmptyRequest.toBinary(this);\n      },\n    };\n\n    const response = gateway.callSync<requests.StringResponse>(\n      'wdi/to_string',\n      request,\n      requests.StringResponse.fromBinary);\n    return response.value;\n  }\n\n  /**\n  * Releases the native resources of the connection.\n  * Should only be called if your environment does not support FinalizationRegistry.\n  * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/FinalizationRegistry\n  */\n  public free(): void {\n    WdiAutofocusProvider._free(this.providerId);\n  }\n}\n\nnamespace WdiAutofocusProvider {\n  export interface GenericReadOptions {\n      /**\n       * Number of values to read (defaults to 1).\n       */\n      count?: number;\n      /**\n       * Offset within the register (defaults to 0).\n       */\n      offset?: number;\n      /**\n       * Register bank letter (defaults to U for user bank).\n       */\n      registerBank?: string;\n  }\n  export interface GenericWriteOptions {\n      /**\n       * Offset within the register (defaults to 0).\n       */\n      offset?: number;\n      /**\n       * Register bank letter (defaults to U for user bank).\n       */\n      registerBank?: string;\n  }\n  export interface GenericReadFloatOptions {\n      /**\n       * Number of values to read (defaults to 1).\n       */\n      count?: number;\n      /**\n       * Offset within the register (defaults to 0).\n       */\n      offset?: number;\n      /**\n       * Register bank letter (defaults to U for user bank).\n       */\n      registerBank?: string;\n  }\n  export interface GenericWriteFloatOptions {\n      /**\n       * Offset within the register (defaults to 0).\n       */\n      offset?: number;\n      /**\n       * Register bank letter (defaults to U for user bank).\n       */\n      registerBank?: string;\n  }\n}\n"]}
+{"version":3,"file":"wdi_autofocus_provider.js","sourceRoot":"","sources":["../../../src/microscopy/wdi_autofocus_provider.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtD,4CAAuD;AACvD,0DAAsD;AACtD,oDAAsC;AACtC,sDAAwC;AAGxC;;GAEG;AACH,MAAa,oBAAoB;IAM/B;;OAEG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAGD;;OAEG;IACH,IAAW,eAAe;QACxB,OAAO,IAAI,CAAC,wBAAwB,EAAE,CAAC;IACzC,CAAC;IAED,YAAY,UAAkB;QAC5B,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAA,mCAAuB,EAAC,IAAI,EAAE,oBAAoB,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC;IACnF,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,OAAO,CACzB,QAAgB,EAChB,OAAe,oBAAoB,CAAC,gBAAgB;QAEpD,MAAM,OAAO,GAAoD;YAC/D,GAAG,QAAQ,CAAC,oBAAoB,CAAC,OAAO;YACxC,aAAa,EAAE,QAAQ,CAAC,aAAa,CAAC,GAAG;YACzC,QAAQ,EAAE,QAAQ;YAClB,IAAI,EAAE,IAAI;YACV,QAAQ;gBACN,OAAO,QAAQ,CAAC,oBAAoB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACtD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,UAAU,EACV,OAAO,EACP,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;QACnC,OAAO,IAAI,oBAAoB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAClD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,KAAK;QAChB,MAAM,OAAO,GAAqD;YAChE,GAAG,QAAQ,CAAC,qBAAqB,CAAC,OAAO;YACzC,WAAW,EAAE,IAAI,CAAC,UAAU;YAC5B,QAAQ;gBACN,OAAO,QAAQ,CAAC,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACvD,CAAC;SACF,CAAC;QAEF,MAAM,OAAO,CAAC,SAAS,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,KAAK,CAClB,UAAkB;QAElB,MAAM,OAAO,GAAqD;YAChE,GAAG,QAAQ,CAAC,qBAAqB,CAAC,OAAO;YACzC,WAAW,EAAE,UAAU;YACvB,QAAQ;gBACN,OAAO,QAAQ,CAAC,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACvD,CAAC;SACF,CAAC;QAEF,OAAO,CAAC,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IACxC,CAAC;IAED;;;OAGG;IACK,wBAAwB;QAC9B,MAAM,OAAO,GAAqD;YAChE,GAAG,QAAQ,CAAC,qBAAqB,CAAC,OAAO;YACzC,WAAW,EAAE,IAAI,CAAC,UAAU;YAC5B,QAAQ;gBACN,OAAO,QAAQ,CAAC,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACvD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,0BAA0B,EAC1B,OAAO,EACP,kCAAe,CAAC,UAAU,CAAC,CAAC;QAC9B,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,WAAW,CACtB,UAAkB,EAClB,IAAY,EACZ,UAAmD,EAAE;QAErD,MAAM,EACJ,KAAK,GAAG,CAAC,EACT,MAAM,GAAG,CAAC,EACV,YAAY,GAAG,GAAG,GACnB,GAAG,OAAO,CAAC;QACZ,MAAM,OAAO,GAAiD;YAC5D,GAAG,QAAQ,CAAC,iBAAiB,CAAC,OAAO;YACrC,WAAW,EAAE,IAAI,CAAC,UAAU;YAC5B,UAAU,EAAE,UAAU;YACtB,IAAI,EAAE,IAAI;YACV,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;YACd,YAAY,EAAE,YAAY;YAC1B,QAAQ;gBACN,OAAO,QAAQ,CAAC,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACnD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,UAAU,EACV,OAAO,EACP,QAAQ,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;QACxC,OAAO,QAAQ,CAAC,MAAM,CAAC;IACzB,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,YAAY,CACvB,UAAkB,EAClB,OAAe,CAAC,EAChB,OAAiB,EAAE,EACnB,UAAoD,EAAE;QAEtD,MAAM,EACJ,MAAM,GAAG,CAAC,EACV,YAAY,GAAG,GAAG,GACnB,GAAG,OAAO,CAAC;QACZ,MAAM,OAAO,GAAiD;YAC5D,GAAG,QAAQ,CAAC,iBAAiB,CAAC,OAAO;YACrC,WAAW,EAAE,IAAI,CAAC,UAAU;YAC5B,UAAU,EAAE,UAAU;YACtB,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,MAAM;YACd,YAAY,EAAE,YAAY;YAC1B,QAAQ;gBACN,OAAO,QAAQ,CAAC,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACnD,CAAC;SACF,CAAC;QAEF,MAAM,OAAO,CAAC,SAAS,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,gBAAgB,CAC3B,UAAkB,EAClB,UAAwD,EAAE;QAE1D,MAAM,EACJ,KAAK,GAAG,CAAC,EACT,MAAM,GAAG,CAAC,EACV,YAAY,GAAG,GAAG,GACnB,GAAG,OAAO,CAAC;QACZ,MAAM,OAAO,GAAsD;YACjE,GAAG,QAAQ,CAAC,sBAAsB,CAAC,OAAO;YAC1C,WAAW,EAAE,IAAI,CAAC,UAAU;YAC5B,UAAU,EAAE,UAAU;YACtB,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;YACd,YAAY,EAAE,YAAY;YAC1B,QAAQ;gBACN,OAAO,QAAQ,CAAC,sBAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACxD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,gBAAgB,EAChB,OAAO,EACP,QAAQ,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;QAC3C,OAAO,QAAQ,CAAC,MAAM,CAAC;IACzB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,iBAAiB,CAC5B,UAAkB,EAClB,OAAiB,EAAE,EACnB,UAAyD,EAAE;QAE3D,MAAM,EACJ,MAAM,GAAG,CAAC,EACV,YAAY,GAAG,GAAG,GACnB,GAAG,OAAO,CAAC;QACZ,MAAM,OAAO,GAAsD;YACjE,GAAG,QAAQ,CAAC,sBAAsB,CAAC,OAAO;YAC1C,WAAW,EAAE,IAAI,CAAC,UAAU;YAC5B,UAAU,EAAE,UAAU;YACtB,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,MAAM;YACd,YAAY,EAAE,YAAY;YAC1B,QAAQ;gBACN,OAAO,QAAQ,CAAC,sBAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACxD,CAAC;SACF,CAAC;QAEF,MAAM,OAAO,CAAC,SAAS,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,WAAW;QACtB,MAAM,OAAO,GAAiD;YAC5D,GAAG,QAAQ,CAAC,iBAAiB,CAAC,OAAO;YACrC,WAAW,EAAE,IAAI,CAAC,UAAU;YAC5B,UAAU,EAAE,CAAC;YACb,QAAQ;gBACN,OAAO,QAAQ,CAAC,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACnD,CAAC;SACF,CAAC;QAEF,MAAM,OAAO,CAAC,SAAS,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAAY;QACvB,MAAM,OAAO,GAAiD;YAC5D,GAAG,QAAQ,CAAC,iBAAiB,CAAC,OAAO;YACrC,WAAW,EAAE,IAAI,CAAC,UAAU;YAC5B,UAAU,EAAE,CAAC;YACb,QAAQ;gBACN,OAAO,QAAQ,CAAC,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACnD,CAAC;SACF,CAAC;QAEF,MAAM,OAAO,CAAC,SAAS,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,SAAS;QACpB,MAAM,OAAO,GAAqD;YAChE,GAAG,QAAQ,CAAC,qBAAqB,CAAC,OAAO;YACzC,WAAW,EAAE,IAAI,CAAC,UAAU;YAC5B,QAAQ;gBACN,OAAO,QAAQ,CAAC,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACvD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,gBAAgB,EAChB,OAAO,EACP,QAAQ,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QAC5C,OAAO,QAAQ,CAAC,MAAM,CAAC;IACzB,CAAC;IAED;;;OAGG;IACI,QAAQ;QACb,MAAM,OAAO,GAAqD;YAChE,GAAG,QAAQ,CAAC,qBAAqB,CAAC,OAAO;YACzC,WAAW,EAAE,IAAI,CAAC,UAAU;YAC5B,QAAQ;gBACN,OAAO,QAAQ,CAAC,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACvD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,eAAe,EACf,OAAO,EACP,QAAQ,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QACtC,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACI,IAAI;QACT,oBAAoB,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC9C,CAAC;;AArUH,oDAsUC;AArUC;;GAEG;AACoB,qCAAgB,GAAW,EAAE,CAAC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport { registerForFinalization } from '../finalizer';\nimport { FirmwareVersion } from '../firmware_version';\nimport * as gateway from '../gateway';\nimport * as requests from '../requests';\nimport { WdiAutofocusProviderStatus } from './wdi_autofocus_provider_status';\n\n/**\n * Class representing access to WDI Autofocus connection.\n */\nexport class WdiAutofocusProvider {\n  /**\n   * Default port number for TCP connections to WDI autofocus.\n   */\n  public static readonly DEFAULT_TCP_PORT: number = 27;\n\n  /**\n   * The ID identifies the autofocus with the underlying library.\n   */\n  public get providerId(): number {\n    return this._providerId;\n  }\n  private _providerId: number;\n\n  /**\n   * The firmware version of the connected autofocus.\n   */\n  public get firmwareVersion(): FirmwareVersion {\n    return this._retrieveFirmwareVersion();\n  }\n\n  constructor(providerId: number) {\n    this._providerId = providerId;\n    registerForFinalization(this, WdiAutofocusProvider._free.bind(null, providerId));\n  }\n\n  /**\n   * Opens a TCP connection to WDI autofocus.\n   * @param hostName Hostname or IP address.\n   * @param [port=WdiAutofocusProvider.DEFAULT_TCP_PORT] Optional port number (defaults to 27).\n   * @returns An object representing the autofocus connection.\n   */\n  public static async openTcp(\n    hostName: string,\n    port: number = WdiAutofocusProvider.DEFAULT_TCP_PORT\n  ): Promise<WdiAutofocusProvider> {\n    const request: requests.OpenInterfaceRequest & gateway.Message = {\n      ...requests.OpenInterfaceRequest.DEFAULT,\n      interfaceType: requests.InterfaceType.TCP,\n      hostName: hostName,\n      port: port,\n      toBinary() {\n        return requests.OpenInterfaceRequest.toBinary(this);\n      },\n    };\n\n    const response = await gateway.callAsync<requests.IntResponse>(\n      'wdi/open',\n      request,\n      requests.IntResponse.fromBinary);\n    return new WdiAutofocusProvider(response.value);\n  }\n\n  /**\n   * Close the connection.\n   */\n  public async close(): Promise<void> {\n    const request: requests.InterfaceEmptyRequest & gateway.Message = {\n      ...requests.InterfaceEmptyRequest.DEFAULT,\n      interfaceId: this.providerId,\n      toBinary() {\n        return requests.InterfaceEmptyRequest.toBinary(this);\n      },\n    };\n\n    await gateway.callAsync('wdi/close', request);\n  }\n\n  /**\n   * Frees the connection.\n   * @param providerId The ID of the connection to free.\n   */\n  private static _free(\n    providerId: number\n  ): void {\n    const request: requests.InterfaceEmptyRequest & gateway.Message = {\n      ...requests.InterfaceEmptyRequest.DEFAULT,\n      interfaceId: providerId,\n      toBinary() {\n        return requests.InterfaceEmptyRequest.toBinary(this);\n      },\n    };\n\n    gateway.callSync('wdi/free', request);\n  }\n\n  /**\n   * Returns FW version.\n   * @returns Firmware version.\n   */\n  private _retrieveFirmwareVersion(): FirmwareVersion {\n    const request: requests.InterfaceEmptyRequest & gateway.Message = {\n      ...requests.InterfaceEmptyRequest.DEFAULT,\n      interfaceId: this.providerId,\n      toBinary() {\n        return requests.InterfaceEmptyRequest.toBinary(this);\n      },\n    };\n\n    const response = gateway.callSync<FirmwareVersion>(\n      'wdi/get_firmware_version',\n      request,\n      FirmwareVersion.fromBinary);\n    return response;\n  }\n\n  /**\n   * Generic read operation.\n   * @param registerId Register address to read from.\n   * @param size Data size to read. Valid values are (1,2,4). Determines the data type (Byte, Word, DWord).\n   * @param [options.count=1] Number of values to read (defaults to 1).\n   * @param [options.offset=0] Offset within the register (defaults to 0).\n   * @param [options.registerBank='U'] Register bank letter (defaults to U for user bank).\n   * @returns Array of integers read from the device.\n   */\n  public async genericRead(\n    registerId: number,\n    size: number,\n    options: WdiAutofocusProvider.GenericReadOptions = {}\n  ): Promise<number[]> {\n    const {\n      count = 1,\n      offset = 0,\n      registerBank = 'U',\n    } = options;\n    const request: requests.WdiGenericRequest & gateway.Message = {\n      ...requests.WdiGenericRequest.DEFAULT,\n      interfaceId: this.providerId,\n      registerId: registerId,\n      size: size,\n      count: count,\n      offset: offset,\n      registerBank: registerBank,\n      toBinary() {\n        return requests.WdiGenericRequest.toBinary(this);\n      },\n    };\n\n    const response = await gateway.callAsync<requests.IntArrayResponse>(\n      'wdi/read',\n      request,\n      requests.IntArrayResponse.fromBinary);\n    return response.values;\n  }\n\n  /**\n   * Generic write operation.\n   * @param registerId Register address to write to.\n   * @param [size=0] Data size to write. Valid values are (0,1,2,4). Determines the data type (Nil, Byte, Word, DWord).\n   * @param [data=[]] Array of values to write to the register. Empty array is allowed.\n   * @param [options.offset=0] Offset within the register (defaults to 0).\n   * @param [options.registerBank='U'] Register bank letter (defaults to U for user bank).\n   */\n  public async genericWrite(\n    registerId: number,\n    size: number = 0,\n    data: number[] = [],\n    options: WdiAutofocusProvider.GenericWriteOptions = {}\n  ): Promise<void> {\n    const {\n      offset = 0,\n      registerBank = 'U',\n    } = options;\n    const request: requests.WdiGenericRequest & gateway.Message = {\n      ...requests.WdiGenericRequest.DEFAULT,\n      interfaceId: this.providerId,\n      registerId: registerId,\n      size: size,\n      data: data,\n      offset: offset,\n      registerBank: registerBank,\n      toBinary() {\n        return requests.WdiGenericRequest.toBinary(this);\n      },\n    };\n\n    await gateway.callAsync('wdi/write', request);\n  }\n\n  /**\n   * Generic read operation.\n   * @param registerId Register address to read from.\n   * @param [options.count=1] Number of values to read (defaults to 1).\n   * @param [options.offset=0] Offset within the register (defaults to 0).\n   * @param [options.registerBank='U'] Register bank letter (defaults to U for user bank).\n   * @returns Array of floats read from the device.\n   */\n  public async genericReadFloat(\n    registerId: number,\n    options: WdiAutofocusProvider.GenericReadFloatOptions = {}\n  ): Promise<number[]> {\n    const {\n      count = 1,\n      offset = 0,\n      registerBank = 'U',\n    } = options;\n    const request: requests.WdiGenericFloatRequest & gateway.Message = {\n      ...requests.WdiGenericFloatRequest.DEFAULT,\n      interfaceId: this.providerId,\n      registerId: registerId,\n      count: count,\n      offset: offset,\n      registerBank: registerBank,\n      toBinary() {\n        return requests.WdiGenericFloatRequest.toBinary(this);\n      },\n    };\n\n    const response = await gateway.callAsync<requests.DoubleArrayResponse>(\n      'wdi/read_float',\n      request,\n      requests.DoubleArrayResponse.fromBinary);\n    return response.values;\n  }\n\n  /**\n   * Generic write operation.\n   * @param registerId Register address to write to.\n   * @param [data=[]] Array of values to write to the register. Empty array is allowed.\n   * @param [options.offset=0] Offset within the register (defaults to 0).\n   * @param [options.registerBank='U'] Register bank letter (defaults to U for user bank).\n   */\n  public async genericWriteFloat(\n    registerId: number,\n    data: number[] = [],\n    options: WdiAutofocusProvider.GenericWriteFloatOptions = {}\n  ): Promise<void> {\n    const {\n      offset = 0,\n      registerBank = 'U',\n    } = options;\n    const request: requests.WdiGenericFloatRequest & gateway.Message = {\n      ...requests.WdiGenericFloatRequest.DEFAULT,\n      interfaceId: this.providerId,\n      registerId: registerId,\n      data: data,\n      offset: offset,\n      registerBank: registerBank,\n      toBinary() {\n        return requests.WdiGenericFloatRequest.toBinary(this);\n      },\n    };\n\n    await gateway.callAsync('wdi/write_float', request);\n  }\n\n  /**\n   * Enables the laser.\n   */\n  public async enableLaser(): Promise<void> {\n    const request: requests.WdiGenericRequest & gateway.Message = {\n      ...requests.WdiGenericRequest.DEFAULT,\n      interfaceId: this.providerId,\n      registerId: 1,\n      toBinary() {\n        return requests.WdiGenericRequest.toBinary(this);\n      },\n    };\n\n    await gateway.callAsync('wdi/write', request);\n  }\n\n  /**\n   * Disables the laser.\n   */\n  public async disableLaser(): Promise<void> {\n    const request: requests.WdiGenericRequest & gateway.Message = {\n      ...requests.WdiGenericRequest.DEFAULT,\n      interfaceId: this.providerId,\n      registerId: 2,\n      toBinary() {\n        return requests.WdiGenericRequest.toBinary(this);\n      },\n    };\n\n    await gateway.callAsync('wdi/write', request);\n  }\n\n  /**\n   * Gets the status of the autofocus.\n   * @returns The status of the autofocus.\n   */\n  public async getStatus(): Promise<WdiAutofocusProviderStatus> {\n    const request: requests.InterfaceEmptyRequest & gateway.Message = {\n      ...requests.InterfaceEmptyRequest.DEFAULT,\n      interfaceId: this.providerId,\n      toBinary() {\n        return requests.InterfaceEmptyRequest.toBinary(this);\n      },\n    };\n\n    const response = await gateway.callAsync<requests.WdiGetStatusResponse>(\n      'wdi/get_status',\n      request,\n      requests.WdiGetStatusResponse.fromBinary);\n    return response.status;\n  }\n\n  /**\n   * Returns a string that represents the autofocus connection.\n   * @returns A string that represents the connection.\n   */\n  public toString(): string {\n    const request: requests.InterfaceEmptyRequest & gateway.Message = {\n      ...requests.InterfaceEmptyRequest.DEFAULT,\n      interfaceId: this.providerId,\n      toBinary() {\n        return requests.InterfaceEmptyRequest.toBinary(this);\n      },\n    };\n\n    const response = gateway.callSync<requests.StringResponse>(\n      'wdi/to_string',\n      request,\n      requests.StringResponse.fromBinary);\n    return response.value;\n  }\n\n  /**\n   * Releases the native resources of the wdi autofocus provider.\n   * Should only be called if your environment does not support FinalizationRegistry.\n   * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/FinalizationRegistry\n   */\n  public free(): void {\n    WdiAutofocusProvider._free(this.providerId);\n  }\n}\n\nnamespace WdiAutofocusProvider {\n  export interface GenericReadOptions {\n      /**\n       * Number of values to read (defaults to 1).\n       */\n      count?: number;\n      /**\n       * Offset within the register (defaults to 0).\n       */\n      offset?: number;\n      /**\n       * Register bank letter (defaults to U for user bank).\n       */\n      registerBank?: string;\n  }\n  export interface GenericWriteOptions {\n      /**\n       * Offset within the register (defaults to 0).\n       */\n      offset?: number;\n      /**\n       * Register bank letter (defaults to U for user bank).\n       */\n      registerBank?: string;\n  }\n  export interface GenericReadFloatOptions {\n      /**\n       * Number of values to read (defaults to 1).\n       */\n      count?: number;\n      /**\n       * Offset within the register (defaults to 0).\n       */\n      offset?: number;\n      /**\n       * Register bank letter (defaults to U for user bank).\n       */\n      registerBank?: string;\n  }\n  export interface GenericWriteFloatOptions {\n      /**\n       * Offset within the register (defaults to 0).\n       */\n      offset?: number;\n      /**\n       * Register bank letter (defaults to U for user bank).\n       */\n      registerBank?: string;\n  }\n}\n"]}

package/dist/lib/product/ge_1_gripper.d.ts

@@ -0,0 +1,273 @@
+import { Ge1GripperState } from './ge_1_gripper_state';
+import { Ge1GripperError } from './ge_1_gripper_error';
+import { Ge1GripperDirection } from './ge_1_gripper_direction';
+/**
+ * Class representing a GE1 series gripper.
+ */
+export declare class GE1Gripper {
+    /**
+     * The default device address for GE1 series grippers.
+     */
+    static readonly DEFAULT_DEVICE_ADDRESS: number;
+    /**
+     * The identifier for the connection.
+     */
+    get connectionId(): number;
+    private _connectionId;
+    constructor(connectionId: number);
+    /**
+     * Opens a serial connection to a GE1 series gripper.
+     * @param portName The name of the serial port to connect to.
+     * @param [options.deviceAddress=GE1Gripper.DEFAULT_DEVICE_ADDRESS] The address of the gripper to connect to.
+     * @param [options.timeout=500] The timeout in milliseconds for any request sent using this connection.
+     * @returns A GE1Gripper instance representing the connection to the gripper.
+     */
+    static openConnection(portName: string, options?: GE1Gripper.OpenConnectionOptions): Promise<GE1Gripper>;
+    /**
+     * Closes the connection to the gripper.
+     */
+    close(): Promise<void>;
+    /**
+     * Reads a single register value from the gripper.
+     * @param registerAddress The address of the register to read.
+     * @returns The data at the specified register address.
+     */
+    readRegister(registerAddress: number): Promise<number>;
+    /**
+     * Writes a single register value to the gripper.
+     * @param registerAddress The address of the register to write.
+     * @param data The data to write to the specified register address.
+     */
+    writeRegister(registerAddress: number, data: number): Promise<void>;
+    /**
+     * Homes gripper by moving it to its homing position.
+     * @param [options.waitUntilIdle=true] Wait until homing has completed before returning.
+     */
+    home(options?: GE1Gripper.HomeOptions): Promise<void>;
+    /**
+     * Waits until the gripper has stopped moving.
+     */
+    waitUntilIdle(): Promise<void>;
+    /**
+     * Moves the gripper to a specified position.
+     * @param position The target position for the gripper as a percentage, where 0 is closed and 100 is open.
+     * @param [options.waitUntilIdle=true] Wait until the move has completed before returning.
+     */
+    move(position: number, options?: GE1Gripper.MoveOptions): Promise<void>;
+    /**
+     * Moves the gripper to the open position.
+     * @param [options.waitUntilIdle=true] Wait until the move has completed before returning.
+     */
+    moveOpen(options?: GE1Gripper.MoveOpenOptions): Promise<void>;
+    /**
+     * Moves the gripper to the closed position.
+     * @param [options.waitUntilIdle=true] Wait until the move has completed before returning.
+     */
+    moveClose(options?: GE1Gripper.MoveCloseOptions): Promise<void>;
+    /**
+     * Stops the gripper from moving.
+     * @param [options.waitUntilIdle=true] Wait until the gripper has stopped before returning.
+     */
+    stop(options?: GE1Gripper.StopOptions): Promise<void>;
+    /**
+     * Sets the gripping force of the gripper.
+     * @param force The gripping force as a percentage from 20 to 100.
+     */
+    setForce(force: number): Promise<void>;
+    /**
+     * Sets the maximum speed of the gripper.
+     * @param speed The maximum speed as a percentage from 1 to 100.
+     */
+    setSpeed(speed: number): Promise<void>;
+    /**
+     * Enables the gripper driver.
+     */
+    driverEnable(): Promise<void>;
+    /**
+     * Disables the gripper driver.
+     */
+    driverDisable(): Promise<void>;
+    /**
+     * Performs a calibration of the travel range by moving to the fully open and fully closed positions.
+     * @param [options.saveToFlash=true] Save the calibration results to flash memory so they are retained on power cycle.
+     */
+    calibrate(options?: GE1Gripper.CalibrateOptions): Promise<void>;
+    /**
+     * Gets the current state of the gripper.
+     * @returns The current state of the gripper.
+     */
+    getState(): Promise<Ge1GripperState>;
+    /**
+     * Gets the current error of the gripper.
+     * @returns The current error of the gripper.
+     */
+    getError(): Promise<Ge1GripperError>;
+    /**
+     * Clears the current error of the gripper.
+     */
+    clearError(): Promise<void>;
+    /**
+     * Checks if the gripper has been homed.
+     * @returns True if the gripper is homed, false otherwise.
+     */
+    isHomed(): Promise<boolean>;
+    /**
+     * Gets the current position of the gripper.
+     * @returns The current position of the gripper as a percentage, where 0 is closed and 100 is open.
+     */
+    getPosition(): Promise<number>;
+    /**
+     * Gets the current current of the gripper.
+     * @returns The current current of the gripper in milliamps.
+     */
+    getCurrent(): Promise<number>;
+    /**
+     * Sets the home direction for the gripper.
+     * @param direction The home direction to set.
+     * @param [options.saveToFlash=true] Save the home direction setting to flash memory so it is retained on power cycle.
+     */
+    setHomeDirection(direction: Ge1GripperDirection, options?: GE1Gripper.SetHomeDirectionOptions): Promise<void>;
+    /**
+     * Enables or disables automatic homing on power up.
+     * @param enabled True to enable automatic homing on power up, false to disable.
+     * @param [options.saveToFlash=true] Save the auto home setting to flash memory so it is retained on power cycle.
+     */
+    setAutoHome(enabled: boolean, options?: GE1Gripper.SetAutoHomeOptions): Promise<void>;
+    /**
+     * Enables or disables IO control for the gripper.
+     * @param enabled True to enable IO control, false to disable.
+     * @param [options.saveToFlash=true] Save the IO enabled setting to flash memory so it is retained on power cycle.
+     */
+    setIoEnabled(enabled: boolean, options?: GE1Gripper.SetIoEnabledOptions): Promise<void>;
+    /**
+     * Sets the debounce filter time for the gripper IO input to suppress noise.
+     * @param duration The IO input filter time in milliseconds.
+     * @param [options.saveToFlash=true] Save the IO input filter setting to flash memory so it is retained on power cycle.
+     */
+    setIoInputFilter(duration: number, options?: GE1Gripper.SetIoInputFilterOptions): Promise<void>;
+    /**
+     * Saves a position, force, and speed as a preset.
+     * @param presetNumber The preset number to save the preset to, from 1 to 4.
+     * @param position The target position for the preset as a percentage, where 0 is closed and 100 is open.
+     * @param [options.force=100] The gripping force for the preset as a percentage from 20 to 100.
+     * @param [options.speed=100] The maximum speed for the preset as a percentage from 1 to 100.
+     * @param [options.saveToFlash=true] Save the preset to flash memory so it is retained on power cycle.
+     */
+    setPreset(presetNumber: number, position: number, options?: GE1Gripper.SetPresetOptions): Promise<void>;
+    /**
+     * Activates a preset, causing the gripper to move to the preset position using the preset force and speed.
+     * @param presetNumber The preset number to activate, from 1 to 4.
+     * @param [options.waitUntilIdle=true] Wait until the move has completed before returning.
+     */
+    activatePreset(presetNumber: number, options?: GE1Gripper.ActivatePresetOptions): Promise<void>;
+    /**
+     * Gets the preset number currently activated by the gripper IO input.
+     * @returns The current preset number activated by the gripper IO input.
+     */
+    getIoInputPresetNumber(): Promise<number>;
+    /**
+     * Frees the connection instance.
+     * @param connectionId Connection ID to be freed.
+     */
+    private static _free;
+    /**
+     * Releases the native resources of the ge 1 gripper.
+     * Should only be called if your environment does not support FinalizationRegistry.
+     * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/FinalizationRegistry
+     */
+    free(): void;
+}
+declare namespace GE1Gripper {
+    interface OpenConnectionOptions {
+        /**
+         * The address of the gripper to connect to.
+         */
+        deviceAddress?: number;
+        /**
+         * The timeout in milliseconds for any request sent using this connection.
+         */
+        timeout?: number;
+    }
+    interface HomeOptions {
+        /**
+         * Wait until homing has completed before returning.
+         */
+        waitUntilIdle?: boolean;
+    }
+    interface MoveOptions {
+        /**
+         * Wait until the move has completed before returning.
+         */
+        waitUntilIdle?: boolean;
+    }
+    interface MoveOpenOptions {
+        /**
+         * Wait until the move has completed before returning.
+         */
+        waitUntilIdle?: boolean;
+    }
+    interface MoveCloseOptions {
+        /**
+         * Wait until the move has completed before returning.
+         */
+        waitUntilIdle?: boolean;
+    }
+    interface StopOptions {
+        /**
+         * Wait until the gripper has stopped before returning.
+         */
+        waitUntilIdle?: boolean;
+    }
+    interface CalibrateOptions {
+        /**
+         * Save the calibration results to flash memory so they are retained on power cycle.
+         */
+        saveToFlash?: boolean;
+    }
+    interface SetHomeDirectionOptions {
+        /**
+         * Save the home direction setting to flash memory so it is retained on power cycle.
+         */
+        saveToFlash?: boolean;
+    }
+    interface SetAutoHomeOptions {
+        /**
+         * Save the auto home setting to flash memory so it is retained on power cycle.
+         */
+        saveToFlash?: boolean;
+    }
+    interface SetIoEnabledOptions {
+        /**
+         * Save the IO enabled setting to flash memory so it is retained on power cycle.
+         */
+        saveToFlash?: boolean;
+    }
+    interface SetIoInputFilterOptions {
+        /**
+         * Save the IO input filter setting to flash memory so it is retained on power cycle.
+         */
+        saveToFlash?: boolean;
+    }
+    interface SetPresetOptions {
+        /**
+         * The gripping force for the preset as a percentage from 20 to 100.
+         */
+        force?: number;
+        /**
+         * The maximum speed for the preset as a percentage from 1 to 100.
+         */
+        speed?: number;
+        /**
+         * Save the preset to flash memory so it is retained on power cycle.
+         */
+        saveToFlash?: boolean;
+    }
+    interface ActivatePresetOptions {
+        /**
+         * Wait until the move has completed before returning.
+         */
+        waitUntilIdle?: boolean;
+    }
+}
+export {};
+//# sourceMappingURL=ge_1_gripper.d.ts.map

package/dist/lib/product/ge_1_gripper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ge_1_gripper.d.ts","sourceRoot":"","sources":["../../../src/product/ge_1_gripper.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAE/D;;GAEG;AACH,qBAAa,UAAU;IACrB;;OAEG;IACH,gBAAuB,sBAAsB,EAAE,MAAM,CAAK;IAE1D;;OAEG;IACH,IAAW,YAAY,IAAI,MAAM,CAEhC;IACD,OAAO,CAAC,aAAa,CAAS;gBAElB,YAAY,EAAE,MAAM;IAKhC;;;;;;OAMG;WACiB,cAAc,CAChC,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE,UAAU,CAAC,qBAA0B,GAC7C,OAAO,CAAC,UAAU,CAAC;IAsBtB;;OAEG;IACU,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAYnC;;;;OAIG;IACU,YAAY,CACvB,eAAe,EAAE,MAAM,GACtB,OAAO,CAAC,MAAM,CAAC;IAiBlB;;;;OAIG;IACU,aAAa,CACxB,eAAe,EAAE,MAAM,EACvB,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,IAAI,CAAC;IAchB;;;OAGG;IACU,IAAI,CACf,OAAO,GAAE,UAAU,CAAC,WAAgB,GACnC,OAAO,CAAC,IAAI,CAAC;IAgBhB;;OAEG;IACU,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IAY3C;;;;OAIG;IACU,IAAI,CACf,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE,UAAU,CAAC,WAAgB,GACnC,OAAO,CAAC,IAAI,CAAC;IAiBhB;;;OAGG;IACU,QAAQ,CACnB,OAAO,GAAE,UAAU,CAAC,eAAoB,GACvC,OAAO,CAAC,IAAI,CAAC;IAiBhB;;;OAGG;IACU,SAAS,CACpB,OAAO,GAAE,UAAU,CAAC,gBAAqB,GACxC,OAAO,CAAC,IAAI,CAAC;IAiBhB;;;OAGG;IACU,IAAI,CACf,OAAO,GAAE,UAAU,CAAC,WAAgB,GACnC,OAAO,CAAC,IAAI,CAAC;IAgBhB;;;OAGG;IACU,QAAQ,CACnB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,IAAI,CAAC;IAahB;;;OAGG;IACU,QAAQ,CACnB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,IAAI,CAAC;IAahB;;OAEG;IACU,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAY1C;;OAEG;IACU,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IAY3C;;;OAGG;IACU,SAAS,CACpB,OAAO,GAAE,UAAU,CAAC,gBAAqB,GACxC,OAAO,CAAC,IAAI,CAAC;IAgBhB;;;OAGG;IACU,QAAQ,IAAI,OAAO,CAAC,eAAe,CAAC;IAgBjD;;;OAGG;IACU,QAAQ,IAAI,OAAO,CAAC,eAAe,CAAC;IAgBjD;;OAEG;IACU,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAYxC;;;OAGG;IACU,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC;IAgBxC;;;OAGG;IACU,WAAW,IAAI,OAAO,CAAC,MAAM,CAAC;IAgB3C;;;OAGG;IACU,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC;IAgB1C;;;;OAIG;IACU,gBAAgB,CAC3B,SAAS,EAAE,mBAAmB,EAC9B,OAAO,GAAE,UAAU,CAAC,uBAA4B,GAC/C,OAAO,CAAC,IAAI,CAAC;IAiBhB;;;;OAIG;IACU,WAAW,CACtB,OAAO,EAAE,OAAO,EAChB,OAAO,GAAE,UAAU,CAAC,kBAAuB,GAC1C,OAAO,CAAC,IAAI,CAAC;IAiBhB;;;;OAIG;IACU,YAAY,CACvB,OAAO,EAAE,OAAO,EAChB,OAAO,GAAE,UAAU,CAAC,mBAAwB,GAC3C,OAAO,CAAC,IAAI,CAAC;IAiBhB;;;;OAIG;IACU,gBAAgB,CAC3B,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE,UAAU,CAAC,uBAA4B,GAC/C,OAAO,CAAC,IAAI,CAAC;IAiBhB;;;;;;;OAOG;IACU,SAAS,CACpB,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE,UAAU,CAAC,gBAAqB,GACxC,OAAO,CAAC,IAAI,CAAC;IAsBhB;;;;OAIG;IACU,cAAc,CACzB,YAAY,EAAE,MAAM,EACpB,OAAO,GAAE,UAAU,CAAC,qBAA0B,GAC7C,OAAO,CAAC,IAAI,CAAC;IAiBhB;;;OAGG;IACU,sBAAsB,IAAI,OAAO,CAAC,MAAM,CAAC;IAgBtD;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,KAAK;IAcpB;;;;OAIG;IACI,IAAI,IAAI,IAAI;CAGpB;AAED,kBAAU,UAAU,CAAC;IACnB,UAAiB,qBAAqB;QAClC;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KACpB;IACD,UAAiB,WAAW;QACxB;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;KAC3B;IACD,UAAiB,WAAW;QACxB;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;KAC3B;IACD,UAAiB,eAAe;QAC5B;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;KAC3B;IACD,UAAiB,gBAAgB;QAC7B;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;KAC3B;IACD,UAAiB,WAAW;QACxB;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;KAC3B;IACD,UAAiB,gBAAgB;QAC7B;;WAEG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;KACzB;IACD,UAAiB,uBAAuB;QACpC;;WAEG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;KACzB;IACD,UAAiB,kBAAkB;QAC/B;;WAEG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;KACzB;IACD,UAAiB,mBAAmB;QAChC;;WAEG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;KACzB;IACD,UAAiB,uBAAuB;QACpC;;WAEG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;KACzB;IACD,UAAiB,gBAAgB;QAC7B;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QACf;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QACf;;WAEG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;KACzB;IACD,UAAiB,qBAAqB;QAClC;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;KAC3B;CACF"}