@zaber/motion 5.1.4 → 5.1.5

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

@@ -66,9 +66,10 @@ export declare class Microscope {
     static find(connection: Connection): Promise<Microscope>;
     /**
      * Initializes the microscope.
-     * Homes all axes, filter changer, and objective changer.
+     * Homes all axes, filter changer, and objective changer if they require it.
+     * @param [options.force=false] Forces all devices to home even when not required.
      */
-    initialize(): Promise<void>;
+    initialize(options?: Microscope.InitializeOptions): Promise<void>;
     /**
      * Checks whether the microscope is initialized.
      * @returns True, when the microscope is initialized. False, otherwise.
@@ -80,3 +81,9 @@ export declare class Microscope {
      */
     toString(): string;
 }
+declare namespace Microscope {
+    interface InitializeOptions {
+        force?: boolean;
+    }
+}
+export {};

package/dist/lib/microscopy/microscope.js

@@ -118,12 +118,15 @@ class Microscope {
     }
     /**
      * Initializes the microscope.
-     * Homes all axes, filter changer, and objective changer.
+     * Homes all axes, filter changer, and objective changer if they require it.
+     * @param [options.force=false] Forces all devices to home even when not required.
      */
-    async initialize() {
-        const request = new gateway.MicroscopeEmptyRequest();
+    async initialize(options = {}) {
+        const { force = false, } = options;
+        const request = new gateway.MicroscopeInitRequest();
         request.setInterfaceId(this.connection.interfaceId);
         request.setConfig(microscope_config_1.MicroscopeConfig.toProtobuf(this._config));
+        request.setForce(force);
         await gateway.callAsync('microscope/initialize', request);
     }
     /**

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

@@ -1 +1 @@
-{"version":3,"file":"microscope.js","sourceRoot":"","sources":["../../../src/microscopy/microscope.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtD,oDAAsC;AACtC,wCAAqC;AACrC,oDAAgD;AAChD,4CAAyC;AAEzC,+CAA4C;AAC5C,2DAAuD;AACvD,2DAAuD;AACvD,qDAAiD;AAEjD;;;;;GAKG;AACH,MAAa,UAAU;IACrB;;OAEG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAKD;;OAEG;IACH,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAGD;;OAEG;IACH,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAGD;;OAEG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAGD;;OAEG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAGD;;OAEG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAGD;;OAEG;IACH,IAAW,gBAAgB;QACzB,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;IAGD;;OAEG;IACH,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAGD;;;OAGG;IACH,YAAY,UAAsB,EAAE,MAAwB;;QAC1D,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,OAAO,GAAG,oCAAgB,CAAC,YAAY,CAAC,oCAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC7F,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,yBAAW,CAAC,IAAI,eAAM,CAAC,UAAU,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACjH,IAAI,CAAC,UAAU,GAAG,CAAA,MAAA,MAAM,CAAC,SAAS,0CAAE,MAAM,EAAC,CAAC,CAAC,IAAI,WAAI,CAAC,IAAI,eAAM,CAAC,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1I,IAAI,CAAC,MAAM,GAAG,CAAA,MAAA,MAAM,CAAC,KAAK,0CAAE,MAAM,EAAC,CAAC,CAAC,IAAI,WAAI,CAAC,IAAI,eAAM,CAAC,UAAU,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1H,IAAI,CAAC,MAAM,GAAG,CAAA,MAAA,MAAM,CAAC,KAAK,0CAAE,MAAM,EAAC,CAAC,CAAC,IAAI,WAAI,CAAC,IAAI,eAAM,CAAC,UAAU,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1H,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,sBAAS,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACjG,IAAI,CAAC,iBAAiB,GAAG,MAAM,CAAC,gBAAgB,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,oCAAgB,CAAC,IAAI,eAAM,CAAC,UAAU,EAAE,MAAM,CAAC,gBAAgB,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACzK,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,8BAAa,CAAC,IAAI,eAAM,CAAC,UAAU,EAAE,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3H,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,IAAI,CACtB,UAAsB;QAEtB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC;QACpD,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAE/C,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,mBAAmB,EACnB,OAAO,EACP,OAAO,CAAC,gBAAgB,CAAC,CAAC;QAC5B,OAAO,IAAI,UAAU,CAAC,UAAU,EAAE,oCAAgB,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;IACxF,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,UAAU;QACrB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,sBAAsB,EAAE,CAAC;QACrD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACpD,OAAO,CAAC,SAAS,CAAC,oCAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;QAE7D,MAAM,OAAO,CAAC,SAAS,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,aAAa;QACxB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,sBAAsB,EAAE,CAAC;QACrD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACpD,OAAO,CAAC,SAAS,CAAC,oCAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;QAE7D,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,2BAA2B,EAC3B,OAAO,EACP,OAAO,CAAC,YAAY,CAAC,CAAC;QACxB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,QAAQ;QACb,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,sBAAsB,EAAE,CAAC;QACrD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACpD,OAAO,CAAC,SAAS,CAAC,oCAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;QAE7D,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,sBAAsB,EACtB,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;CACF;AAhJD,gCAgJC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport * as gateway from '../gateway';\nimport { Axis } from '../ascii/axis';\nimport { AxisGroup } from '../ascii/axis_group';\nimport { Device } from '../ascii/device';\nimport { Connection } from '../ascii/connection';\nimport { Illuminator } from './illuminator';\nimport { ObjectiveChanger } from './objective_changer';\nimport { MicroscopeConfig } from './microscope_config';\nimport { FilterChanger } from './filter_changer';\n\n/**\n * Represent a microscope.\n * It is subject to breaking changes without warning until further notice.\n * Parts of the microscope may or may not be instantiated depending on the configuration.\n * Requires at least Firmware 7.34.\n */\nexport class Microscope {\n  /**\n   * Connection of the microscope.\n   */\n  public get connection(): Connection {\n    return this._connection;\n  }\n  private _connection: Connection;\n\n  private _config: MicroscopeConfig;\n\n  /**\n   * The illuminator.\n   */\n  public get illuminator(): Illuminator | undefined {\n    return this._illuminator;\n  }\n  private _illuminator: Illuminator | undefined;\n\n  /**\n   * The focus axis.\n   */\n  public get focusAxis(): Axis | undefined {\n    return this._focusAxis;\n  }\n  private _focusAxis: Axis | undefined;\n\n  /**\n   * The X axis.\n   */\n  public get xAxis(): Axis | undefined {\n    return this._xAxis;\n  }\n  private _xAxis: Axis | undefined;\n\n  /**\n   * The Y axis.\n   */\n  public get yAxis(): Axis | undefined {\n    return this._yAxis;\n  }\n  private _yAxis: Axis | undefined;\n\n  /**\n   * Axis group consisting of X and Y axes representing the plate of the microscope.\n   */\n  public get plate(): AxisGroup | undefined {\n    return this._plate;\n  }\n  private _plate: AxisGroup | undefined;\n\n  /**\n   * The objective changer.\n   */\n  public get objectiveChanger(): ObjectiveChanger | undefined {\n    return this._objectiveChanger;\n  }\n  private _objectiveChanger: ObjectiveChanger | undefined;\n\n  /**\n   * The filter changer.\n   */\n  public get filterChanger(): FilterChanger | undefined {\n    return this._filterChanger;\n  }\n  private _filterChanger: FilterChanger | undefined;\n\n  /**\n   * Creates instance of `Microscope` from the given config.\n   * Parts are instantiated depending on device addresses in the config.\n   */\n  constructor(connection: Connection, config: MicroscopeConfig) {\n    this._connection = connection;\n    this._config = MicroscopeConfig.fromProtobuf(MicroscopeConfig.toProtobuf(config).toObject());\n    this._illuminator = config.illuminator ? new Illuminator(new Device(connection, config.illuminator)) : undefined;\n    this._focusAxis = config.focusAxis?.device ? new Axis(new Device(connection, config.focusAxis.device), config.focusAxis.axis) : undefined;\n    this._xAxis = config.xAxis?.device ? new Axis(new Device(connection, config.xAxis.device), config.xAxis.axis) : undefined;\n    this._yAxis = config.yAxis?.device ? new Axis(new Device(connection, config.yAxis.device), config.yAxis.axis) : undefined;\n    this._plate = this._xAxis && this._yAxis ? new AxisGroup([this._xAxis, this._yAxis]) : undefined;\n    this._objectiveChanger = config.objectiveChanger && this._focusAxis ? new ObjectiveChanger(new Device(connection, config.objectiveChanger), this._focusAxis) : undefined;\n    this._filterChanger = config.filterChanger ? new FilterChanger(new Device(connection, config.filterChanger)) : undefined;\n  }\n\n  /**\n   * Finds a microscope on a connection.\n   * @param connection Connection on which to detect the microscope.\n   * @returns New instance of microscope.\n   */\n  public static async find(\n    connection: Connection\n  ): Promise<Microscope> {\n    const request = new gateway.InterfaceEmptyRequest();\n    request.setInterfaceId(connection.interfaceId);\n\n    const response = await gateway.callAsync<gateway.MicroscopeConfig>(\n      'microscope/detect',\n      request,\n      gateway.MicroscopeConfig);\n    return new Microscope(connection, MicroscopeConfig.fromProtobuf(response.toObject()));\n  }\n\n  /**\n   * Initializes the microscope.\n   * Homes all axes, filter changer, and objective changer.\n   */\n  public async initialize(): Promise<void> {\n    const request = new gateway.MicroscopeEmptyRequest();\n    request.setInterfaceId(this.connection.interfaceId);\n    request.setConfig(MicroscopeConfig.toProtobuf(this._config));\n\n    await gateway.callAsync('microscope/initialize', request);\n  }\n\n  /**\n   * Checks whether the microscope is initialized.\n   * @returns True, when the microscope is initialized. False, otherwise.\n   */\n  public async isInitialized(): Promise<boolean> {\n    const request = new gateway.MicroscopeEmptyRequest();\n    request.setInterfaceId(this.connection.interfaceId);\n    request.setConfig(MicroscopeConfig.toProtobuf(this._config));\n\n    const response = await gateway.callAsync<gateway.BoolResponse>(\n      'microscope/is_initialized',\n      request,\n      gateway.BoolResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Returns a string that represents the microscope.\n   * @returns A string that represents the microscope.\n   */\n  public toString(): string {\n    const request = new gateway.MicroscopeEmptyRequest();\n    request.setInterfaceId(this.connection.interfaceId);\n    request.setConfig(MicroscopeConfig.toProtobuf(this._config));\n\n    const response = gateway.callSync<gateway.StringResponse>(\n      'microscope/to_string',\n      request,\n      gateway.StringResponse);\n    return response.getValue();\n  }\n}\n\nnamespace Microscope {\n}\n"]}
+{"version":3,"file":"microscope.js","sourceRoot":"","sources":["../../../src/microscopy/microscope.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtD,oDAAsC;AACtC,wCAAqC;AACrC,oDAAgD;AAChD,4CAAyC;AAEzC,+CAA4C;AAC5C,2DAAuD;AACvD,2DAAuD;AACvD,qDAAiD;AAEjD;;;;;GAKG;AACH,MAAa,UAAU;IACrB;;OAEG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAKD;;OAEG;IACH,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAGD;;OAEG;IACH,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAGD;;OAEG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAGD;;OAEG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAGD;;OAEG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAGD;;OAEG;IACH,IAAW,gBAAgB;QACzB,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;IAGD;;OAEG;IACH,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAGD;;;OAGG;IACH,YAAY,UAAsB,EAAE,MAAwB;;QAC1D,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,OAAO,GAAG,oCAAgB,CAAC,YAAY,CAAC,oCAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC7F,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,yBAAW,CAAC,IAAI,eAAM,CAAC,UAAU,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACjH,IAAI,CAAC,UAAU,GAAG,CAAA,MAAA,MAAM,CAAC,SAAS,0CAAE,MAAM,EAAC,CAAC,CAAC,IAAI,WAAI,CAAC,IAAI,eAAM,CAAC,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1I,IAAI,CAAC,MAAM,GAAG,CAAA,MAAA,MAAM,CAAC,KAAK,0CAAE,MAAM,EAAC,CAAC,CAAC,IAAI,WAAI,CAAC,IAAI,eAAM,CAAC,UAAU,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1H,IAAI,CAAC,MAAM,GAAG,CAAA,MAAA,MAAM,CAAC,KAAK,0CAAE,MAAM,EAAC,CAAC,CAAC,IAAI,WAAI,CAAC,IAAI,eAAM,CAAC,UAAU,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1H,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,sBAAS,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACjG,IAAI,CAAC,iBAAiB,GAAG,MAAM,CAAC,gBAAgB,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,oCAAgB,CAAC,IAAI,eAAM,CAAC,UAAU,EAAE,MAAM,CAAC,gBAAgB,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACzK,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,8BAAa,CAAC,IAAI,eAAM,CAAC,UAAU,EAAE,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3H,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,IAAI,CACtB,UAAsB;QAEtB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC;QACpD,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAE/C,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,mBAAmB,EACnB,OAAO,EACP,OAAO,CAAC,gBAAgB,CAAC,CAAC;QAC5B,OAAO,IAAI,UAAU,CAAC,UAAU,EAAE,oCAAgB,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;IACxF,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,UAAU,CACrB,UAAwC,EAAE;QAE1C,MAAM,EACJ,KAAK,GAAG,KAAK,GACd,GAAG,OAAO,CAAC;QACZ,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC;QACpD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACpD,OAAO,CAAC,SAAS,CAAC,oCAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;QAC7D,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAExB,MAAM,OAAO,CAAC,SAAS,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,aAAa;QACxB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,sBAAsB,EAAE,CAAC;QACrD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACpD,OAAO,CAAC,SAAS,CAAC,oCAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;QAE7D,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,2BAA2B,EAC3B,OAAO,EACP,OAAO,CAAC,YAAY,CAAC,CAAC;QACxB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,QAAQ;QACb,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,sBAAsB,EAAE,CAAC;QACrD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACpD,OAAO,CAAC,SAAS,CAAC,oCAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;QAE7D,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,sBAAsB,EACtB,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;CACF;AAvJD,gCAuJC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport * as gateway from '../gateway';\nimport { Axis } from '../ascii/axis';\nimport { AxisGroup } from '../ascii/axis_group';\nimport { Device } from '../ascii/device';\nimport { Connection } from '../ascii/connection';\nimport { Illuminator } from './illuminator';\nimport { ObjectiveChanger } from './objective_changer';\nimport { MicroscopeConfig } from './microscope_config';\nimport { FilterChanger } from './filter_changer';\n\n/**\n * Represent a microscope.\n * It is subject to breaking changes without warning until further notice.\n * Parts of the microscope may or may not be instantiated depending on the configuration.\n * Requires at least Firmware 7.34.\n */\nexport class Microscope {\n  /**\n   * Connection of the microscope.\n   */\n  public get connection(): Connection {\n    return this._connection;\n  }\n  private _connection: Connection;\n\n  private _config: MicroscopeConfig;\n\n  /**\n   * The illuminator.\n   */\n  public get illuminator(): Illuminator | undefined {\n    return this._illuminator;\n  }\n  private _illuminator: Illuminator | undefined;\n\n  /**\n   * The focus axis.\n   */\n  public get focusAxis(): Axis | undefined {\n    return this._focusAxis;\n  }\n  private _focusAxis: Axis | undefined;\n\n  /**\n   * The X axis.\n   */\n  public get xAxis(): Axis | undefined {\n    return this._xAxis;\n  }\n  private _xAxis: Axis | undefined;\n\n  /**\n   * The Y axis.\n   */\n  public get yAxis(): Axis | undefined {\n    return this._yAxis;\n  }\n  private _yAxis: Axis | undefined;\n\n  /**\n   * Axis group consisting of X and Y axes representing the plate of the microscope.\n   */\n  public get plate(): AxisGroup | undefined {\n    return this._plate;\n  }\n  private _plate: AxisGroup | undefined;\n\n  /**\n   * The objective changer.\n   */\n  public get objectiveChanger(): ObjectiveChanger | undefined {\n    return this._objectiveChanger;\n  }\n  private _objectiveChanger: ObjectiveChanger | undefined;\n\n  /**\n   * The filter changer.\n   */\n  public get filterChanger(): FilterChanger | undefined {\n    return this._filterChanger;\n  }\n  private _filterChanger: FilterChanger | undefined;\n\n  /**\n   * Creates instance of `Microscope` from the given config.\n   * Parts are instantiated depending on device addresses in the config.\n   */\n  constructor(connection: Connection, config: MicroscopeConfig) {\n    this._connection = connection;\n    this._config = MicroscopeConfig.fromProtobuf(MicroscopeConfig.toProtobuf(config).toObject());\n    this._illuminator = config.illuminator ? new Illuminator(new Device(connection, config.illuminator)) : undefined;\n    this._focusAxis = config.focusAxis?.device ? new Axis(new Device(connection, config.focusAxis.device), config.focusAxis.axis) : undefined;\n    this._xAxis = config.xAxis?.device ? new Axis(new Device(connection, config.xAxis.device), config.xAxis.axis) : undefined;\n    this._yAxis = config.yAxis?.device ? new Axis(new Device(connection, config.yAxis.device), config.yAxis.axis) : undefined;\n    this._plate = this._xAxis && this._yAxis ? new AxisGroup([this._xAxis, this._yAxis]) : undefined;\n    this._objectiveChanger = config.objectiveChanger && this._focusAxis ? new ObjectiveChanger(new Device(connection, config.objectiveChanger), this._focusAxis) : undefined;\n    this._filterChanger = config.filterChanger ? new FilterChanger(new Device(connection, config.filterChanger)) : undefined;\n  }\n\n  /**\n   * Finds a microscope on a connection.\n   * @param connection Connection on which to detect the microscope.\n   * @returns New instance of microscope.\n   */\n  public static async find(\n    connection: Connection\n  ): Promise<Microscope> {\n    const request = new gateway.InterfaceEmptyRequest();\n    request.setInterfaceId(connection.interfaceId);\n\n    const response = await gateway.callAsync<gateway.MicroscopeConfig>(\n      'microscope/detect',\n      request,\n      gateway.MicroscopeConfig);\n    return new Microscope(connection, MicroscopeConfig.fromProtobuf(response.toObject()));\n  }\n\n  /**\n   * Initializes the microscope.\n   * Homes all axes, filter changer, and objective changer if they require it.\n   * @param [options.force=false] Forces all devices to home even when not required.\n   */\n  public async initialize(\n    options: Microscope.InitializeOptions = {}\n  ): Promise<void> {\n    const {\n      force = false,\n    } = options;\n    const request = new gateway.MicroscopeInitRequest();\n    request.setInterfaceId(this.connection.interfaceId);\n    request.setConfig(MicroscopeConfig.toProtobuf(this._config));\n    request.setForce(force);\n\n    await gateway.callAsync('microscope/initialize', request);\n  }\n\n  /**\n   * Checks whether the microscope is initialized.\n   * @returns True, when the microscope is initialized. False, otherwise.\n   */\n  public async isInitialized(): Promise<boolean> {\n    const request = new gateway.MicroscopeEmptyRequest();\n    request.setInterfaceId(this.connection.interfaceId);\n    request.setConfig(MicroscopeConfig.toProtobuf(this._config));\n\n    const response = await gateway.callAsync<gateway.BoolResponse>(\n      'microscope/is_initialized',\n      request,\n      gateway.BoolResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Returns a string that represents the microscope.\n   * @returns A string that represents the microscope.\n   */\n  public toString(): string {\n    const request = new gateway.MicroscopeEmptyRequest();\n    request.setInterfaceId(this.connection.interfaceId);\n    request.setConfig(MicroscopeConfig.toProtobuf(this._config));\n\n    const response = gateway.callSync<gateway.StringResponse>(\n      'microscope/to_string',\n      request,\n      gateway.StringResponse);\n    return response.getValue();\n  }\n}\n\nnamespace Microscope {\n  export interface InitializeOptions {\n      force?: boolean;\n  }\n}\n"]}

package/dist/lib/protobufs/main_pb.d.ts

@@ -7846,6 +7846,36 @@ export namespace MicroscopeEmptyRequest {
   }
 }
 
+export class MicroscopeInitRequest extends jspb.Message {
+  getInterfaceId(): number;
+  setInterfaceId(value: number): void;
+
+  hasConfig(): boolean;
+  clearConfig(): void;
+  getConfig(): MicroscopeConfig | undefined;
+  setConfig(value?: MicroscopeConfig): void;
+
+  getForce(): boolean;
+  setForce(value: boolean): void;
+
+  serializeBinary(): Uint8Array;
+  toObject(includeInstance?: boolean): MicroscopeInitRequest.AsObject;
+  static toObject(includeInstance: boolean, msg: MicroscopeInitRequest): MicroscopeInitRequest.AsObject;
+  static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
+  static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
+  static serializeBinaryToWriter(message: MicroscopeInitRequest, writer: jspb.BinaryWriter): void;
+  static deserializeBinary(bytes: Uint8Array): MicroscopeInitRequest;
+  static deserializeBinaryFromReader(message: MicroscopeInitRequest, reader: jspb.BinaryReader): MicroscopeInitRequest;
+}
+
+export namespace MicroscopeInitRequest {
+  export type AsObject = {
+    interfaceId: number,
+    config?: MicroscopeConfig.AsObject,
+    force: boolean,
+  }
+}
+
 export class UnitGetSymbolRequest extends jspb.Message {
   getUnit(): string;
   setUnit(value: string): void;

package/dist/lib/protobufs/main_pb.js

@@ -141,6 +141,7 @@ goog.exportSymbol('zaber.motion.protobufs.Measurement', null, proto);
 goog.exportSymbol('zaber.motion.protobufs.MessageType', null, proto);
 goog.exportSymbol('zaber.motion.protobufs.MicroscopeConfig', null, proto);
 goog.exportSymbol('zaber.motion.protobufs.MicroscopeEmptyRequest', null, proto);
+goog.exportSymbol('zaber.motion.protobufs.MicroscopeInitRequest', null, proto);
 goog.exportSymbol('zaber.motion.protobufs.MovementFailedExceptionData', null, proto);
 goog.exportSymbol('zaber.motion.protobufs.MovementInterruptedExceptionData', null, proto);
 goog.exportSymbol('zaber.motion.protobufs.ObjectiveChangerChangeRequest', null, proto);
@@ -5404,6 +5405,27 @@ if (goog.DEBUG && !COMPILED) {
    */
   proto.zaber.motion.protobufs.MicroscopeEmptyRequest.displayName = 'proto.zaber.motion.protobufs.MicroscopeEmptyRequest';
 }
+/**
+ * Generated by JsPbCodeGenerator.
+ * @param {Array=} opt_data Optional initial data array, typically from a
+ * server response, or constructed directly in Javascript. The array is used
+ * in place and becomes part of the constructed object. It is not cloned.
+ * If no data is provided, the constructed object will be empty, but still
+ * valid.
+ * @extends {jspb.Message}
+ * @constructor
+ */
+proto.zaber.motion.protobufs.MicroscopeInitRequest = function(opt_data) {
+  jspb.Message.initialize(this, opt_data, 0, -1, null, null);
+};
+goog.inherits(proto.zaber.motion.protobufs.MicroscopeInitRequest, jspb.Message);
+if (goog.DEBUG && !COMPILED) {
+  /**
+   * @public
+   * @override
+   */
+  proto.zaber.motion.protobufs.MicroscopeInitRequest.displayName = 'proto.zaber.motion.protobufs.MicroscopeInitRequest';
+}
 /**
  * Generated by JsPbCodeGenerator.
  * @param {Array=} opt_data Optional initial data array, typically from a
@@ -60171,6 +60193,217 @@ proto.zaber.motion.protobufs.MicroscopeEmptyRequest.prototype.hasConfig = functi
 
 
 
+if (jspb.Message.GENERATE_TO_OBJECT) {
+/**
+ * Creates an object representation of this proto.
+ * Field names that are reserved in JavaScript and will be renamed to pb_name.
+ * Optional fields that are not set will be set to undefined.
+ * To access a reserved field use, foo.pb_<name>, eg, foo.pb_default.
+ * For the list of reserved names please see:
+ *     net/proto2/compiler/js/internal/generator.cc#kKeyword.
+ * @param {boolean=} opt_includeInstance Deprecated. whether to include the
+ *     JSPB instance for transitional soy proto support:
+ *     http://goto/soy-param-migration
+ * @return {!Object}
+ */
+proto.zaber.motion.protobufs.MicroscopeInitRequest.prototype.toObject = function(opt_includeInstance) {
+  return proto.zaber.motion.protobufs.MicroscopeInitRequest.toObject(opt_includeInstance, this);
+};
+
+
+/**
+ * Static version of the {@see toObject} method.
+ * @param {boolean|undefined} includeInstance Deprecated. Whether to include
+ *     the JSPB instance for transitional soy proto support:
+ *     http://goto/soy-param-migration
+ * @param {!proto.zaber.motion.protobufs.MicroscopeInitRequest} msg The msg instance to transform.
+ * @return {!Object}
+ * @suppress {unusedLocalVariables} f is only used for nested messages
+ */
+proto.zaber.motion.protobufs.MicroscopeInitRequest.toObject = function(includeInstance, msg) {
+  var f, obj = {
+    interfaceId: jspb.Message.getFieldWithDefault(msg, 1, 0),
+    config: (f = msg.getConfig()) && proto.zaber.motion.protobufs.MicroscopeConfig.toObject(includeInstance, f),
+    force: jspb.Message.getBooleanFieldWithDefault(msg, 3, false)
+  };
+
+  if (includeInstance) {
+    obj.$jspbMessageInstance = msg;
+  }
+  return obj;
+};
+}
+
+
+/**
+ * Deserializes binary data (in protobuf wire format).
+ * @param {jspb.ByteSource} bytes The bytes to deserialize.
+ * @return {!proto.zaber.motion.protobufs.MicroscopeInitRequest}
+ */
+proto.zaber.motion.protobufs.MicroscopeInitRequest.deserializeBinary = function(bytes) {
+  var reader = new jspb.BinaryReader(bytes);
+  var msg = new proto.zaber.motion.protobufs.MicroscopeInitRequest;
+  return proto.zaber.motion.protobufs.MicroscopeInitRequest.deserializeBinaryFromReader(msg, reader);
+};
+
+
+/**
+ * Deserializes binary data (in protobuf wire format) from the
+ * given reader into the given message object.
+ * @param {!proto.zaber.motion.protobufs.MicroscopeInitRequest} msg The message object to deserialize into.
+ * @param {!jspb.BinaryReader} reader The BinaryReader to use.
+ * @return {!proto.zaber.motion.protobufs.MicroscopeInitRequest}
+ */
+proto.zaber.motion.protobufs.MicroscopeInitRequest.deserializeBinaryFromReader = function(msg, reader) {
+  while (reader.nextField()) {
+    if (reader.isEndGroup()) {
+      break;
+    }
+    var field = reader.getFieldNumber();
+    switch (field) {
+    case 1:
+      var value = /** @type {number} */ (reader.readInt32());
+      msg.setInterfaceId(value);
+      break;
+    case 2:
+      var value = new proto.zaber.motion.protobufs.MicroscopeConfig;
+      reader.readMessage(value,proto.zaber.motion.protobufs.MicroscopeConfig.deserializeBinaryFromReader);
+      msg.setConfig(value);
+      break;
+    case 3:
+      var value = /** @type {boolean} */ (reader.readBool());
+      msg.setForce(value);
+      break;
+    default:
+      reader.skipField();
+      break;
+    }
+  }
+  return msg;
+};
+
+
+/**
+ * Serializes the message to binary data (in protobuf wire format).
+ * @return {!Uint8Array}
+ */
+proto.zaber.motion.protobufs.MicroscopeInitRequest.prototype.serializeBinary = function() {
+  var writer = new jspb.BinaryWriter();
+  proto.zaber.motion.protobufs.MicroscopeInitRequest.serializeBinaryToWriter(this, writer);
+  return writer.getResultBuffer();
+};
+
+
+/**
+ * Serializes the given message to binary data (in protobuf wire
+ * format), writing to the given BinaryWriter.
+ * @param {!proto.zaber.motion.protobufs.MicroscopeInitRequest} message
+ * @param {!jspb.BinaryWriter} writer
+ * @suppress {unusedLocalVariables} f is only used for nested messages
+ */
+proto.zaber.motion.protobufs.MicroscopeInitRequest.serializeBinaryToWriter = function(message, writer) {
+  var f = undefined;
+  f = message.getInterfaceId();
+  if (f !== 0) {
+    writer.writeInt32(
+      1,
+      f
+    );
+  }
+  f = message.getConfig();
+  if (f != null) {
+    writer.writeMessage(
+      2,
+      f,
+      proto.zaber.motion.protobufs.MicroscopeConfig.serializeBinaryToWriter
+    );
+  }
+  f = message.getForce();
+  if (f) {
+    writer.writeBool(
+      3,
+      f
+    );
+  }
+};
+
+
+/**
+ * optional int32 interface_id = 1;
+ * @return {number}
+ */
+proto.zaber.motion.protobufs.MicroscopeInitRequest.prototype.getInterfaceId = function() {
+  return /** @type {number} */ (jspb.Message.getFieldWithDefault(this, 1, 0));
+};
+
+
+/**
+ * @param {number} value
+ * @return {!proto.zaber.motion.protobufs.MicroscopeInitRequest} returns this
+ */
+proto.zaber.motion.protobufs.MicroscopeInitRequest.prototype.setInterfaceId = function(value) {
+  return jspb.Message.setProto3IntField(this, 1, value);
+};
+
+
+/**
+ * optional MicroscopeConfig config = 2;
+ * @return {?proto.zaber.motion.protobufs.MicroscopeConfig}
+ */
+proto.zaber.motion.protobufs.MicroscopeInitRequest.prototype.getConfig = function() {
+  return /** @type{?proto.zaber.motion.protobufs.MicroscopeConfig} */ (
+    jspb.Message.getWrapperField(this, proto.zaber.motion.protobufs.MicroscopeConfig, 2));
+};
+
+
+/**
+ * @param {?proto.zaber.motion.protobufs.MicroscopeConfig|undefined} value
+ * @return {!proto.zaber.motion.protobufs.MicroscopeInitRequest} returns this
+*/
+proto.zaber.motion.protobufs.MicroscopeInitRequest.prototype.setConfig = function(value) {
+  return jspb.Message.setWrapperField(this, 2, value);
+};
+
+
+/**
+ * Clears the message field making it undefined.
+ * @return {!proto.zaber.motion.protobufs.MicroscopeInitRequest} returns this
+ */
+proto.zaber.motion.protobufs.MicroscopeInitRequest.prototype.clearConfig = function() {
+  return this.setConfig(undefined);
+};
+
+
+/**
+ * Returns whether this field is set.
+ * @return {boolean}
+ */
+proto.zaber.motion.protobufs.MicroscopeInitRequest.prototype.hasConfig = function() {
+  return jspb.Message.getField(this, 2) != null;
+};
+
+
+/**
+ * optional bool force = 3;
+ * @return {boolean}
+ */
+proto.zaber.motion.protobufs.MicroscopeInitRequest.prototype.getForce = function() {
+  return /** @type {boolean} */ (jspb.Message.getBooleanFieldWithDefault(this, 3, false));
+};
+
+
+/**
+ * @param {boolean} value
+ * @return {!proto.zaber.motion.protobufs.MicroscopeInitRequest} returns this
+ */
+proto.zaber.motion.protobufs.MicroscopeInitRequest.prototype.setForce = function(value) {
+  return jspb.Message.setProto3BooleanField(this, 3, value);
+};
+
+
+
+
+
 if (jspb.Message.GENERATE_TO_OBJECT) {
 /**
  * Creates an object representation of this proto.