@zaber/motion 4.5.1 → 4.6.0

package/dist/lib/microscopy/illuminator.js

@@ -0,0 +1,109 @@
+"use strict";
+// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //
+// ============= DO NOT EDIT DIRECTLY ============= //
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Illuminator = void 0;
+const gateway = __importStar(require("../gateway"));
+const device_1 = require("../ascii/device");
+const device_io_1 = require("../ascii/device_io");
+const illuminator_channel_1 = require("./illuminator_channel");
+/**
+ * Use to manage an LED controller.
+ * It is subject to breaking changes without warning until further notice.
+ * Requires at least Firmware 7.09.
+ */
+class Illuminator {
+    /**
+     * The base device of this illuminator.
+     */
+    get device() {
+        return this._device;
+    }
+    /**
+     * I/O channels of this device.
+     */
+    get io() {
+        return this._io;
+    }
+    /**
+     * Creates instance of `Illuminator` based on the given device.
+     * If the device is identified, this constructor will ensure it is an illuminator.
+     */
+    constructor(device) {
+        this._device = device;
+        this._io = new device_io_1.DeviceIO(device);
+        this._verifyIsIlluminator();
+    }
+    /**
+     * Gets an IlluminatorChannel class instance that allows control of a particular channel.
+     * Channels are numbered from 1.
+     * @param channelNumber Number of channel to control.
+     * @returns Illuminator channel instance.
+     */
+    getChannel(channelNumber) {
+        if (channelNumber <= 0) {
+            throw new TypeError('Invalid value; channels are numbered from 1.');
+        }
+        return new illuminator_channel_1.IlluminatorChannel(this, channelNumber);
+    }
+    /**
+     * Checks if this is an illuminator or some other type of device and throws an error if it is not.
+     */
+    _verifyIsIlluminator() {
+        const request = new gateway.DeviceEmptyRequest();
+        request.setInterfaceId(this.device.connection.interfaceId);
+        request.setDevice(this.device.deviceAddress);
+        gateway.callSync('illuminator/verify', request);
+    }
+    /**
+     * Finds an illuminator on a connection.
+     * In case of conflict, specify the optional device address.
+     * @param connection Connection on which to detect the illuminator.
+     * @param [options.deviceAddress=0] Optional device address of the illuminator.
+     * @returns New instance of illuminator.
+     */
+    static async find(connection, options = {}) {
+        const { deviceAddress = 0, } = options;
+        const request = new gateway.FindDeviceRequest();
+        request.setInterfaceId(connection.interfaceId);
+        request.setDeviceAddress(deviceAddress);
+        const response = await gateway.callAsync('illuminator/detect', request, gateway.FindDeviceResponse);
+        return new Illuminator(new device_1.Device(connection, response.getAddress()));
+    }
+    /**
+     * Returns a string that represents the device.
+     * @returns A string that represents the device.
+     */
+    toString() {
+        const request = new gateway.AxisToStringRequest();
+        request.setInterfaceId(this.device.connection.interfaceId);
+        request.setDevice(this.device.deviceAddress);
+        const response = gateway.callSync('device/device_to_string', request, gateway.StringResponse);
+        return response.getValue();
+    }
+}
+exports.Illuminator = Illuminator;
+//# sourceMappingURL=illuminator.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"illuminator.js","sourceRoot":"","sources":["../../../src/microscopy/illuminator.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtD,oDAAsC;AACtC,4CAAyC;AACzC,kDAA8C;AAE9C,+DAA2D;AAE3D;;;;GAIG;AACH,MAAa,WAAW;IACtB;;OAEG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAGD;;OAEG;IACH,IAAW,EAAE;QACX,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAGD;;;OAGG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,GAAG,GAAG,IAAI,oBAAQ,CAAC,MAAM,CAAC,CAAC;QAChC,IAAI,CAAC,oBAAoB,EAAE,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACI,UAAU,CACf,aAAqB;QAErB,IAAI,aAAa,IAAI,CAAC,EAAE;YACtB,MAAM,IAAI,SAAS,CAAC,8CAA8C,CAAC,CAAC;SACrE;QACD,OAAO,IAAI,wCAAkB,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;IACrD,CAAC;IAED;;OAEG;IACK,oBAAoB;QAC1B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;QACjD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAE7C,OAAO,CAAC,QAAQ,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,IAAI,CACtB,UAAsB,EACtB,UAAmC,EAAE;QAErC,MAAM,EACJ,aAAa,GAAG,CAAC,GAClB,GAAG,OAAO,CAAC;QACZ,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,iBAAiB,EAAE,CAAC;QAChD,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC/C,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAExC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,oBAAoB,EACpB,OAAO,EACP,OAAO,CAAC,kBAAkB,CAAC,CAAC;QAC9B,OAAO,IAAI,WAAW,CAAC,IAAI,eAAM,CAAC,UAAU,EAAE,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;IACxE,CAAC;IAED;;;OAGG;IACI,QAAQ;QACb,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,mBAAmB,EAAE,CAAC;QAClD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAE7C,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,yBAAyB,EACzB,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;CACF;AA7FD,kCA6FC","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 { DeviceIO } from '../ascii/device_io';\nimport { Connection } from '../ascii/connection';\nimport { IlluminatorChannel } from './illuminator_channel';\n\n/**\n * Use to manage an LED controller.\n * It is subject to breaking changes without warning until further notice.\n * Requires at least Firmware 7.09.\n */\nexport class Illuminator {\n  /**\n   * The base device of this illuminator.\n   */\n  public get device(): Device {\n    return this._device;\n  }\n  private _device: Device;\n\n  /**\n   * I/O channels of this device.\n   */\n  public get io(): DeviceIO {\n    return this._io;\n  }\n  private _io: DeviceIO;\n\n  /**\n   * Creates instance of `Illuminator` based on the given device.\n   * If the device is identified, this constructor will ensure it is an illuminator.\n   */\n  constructor(device: Device) {\n    this._device = device;\n    this._io = new DeviceIO(device);\n    this._verifyIsIlluminator();\n  }\n\n  /**\n   * Gets an IlluminatorChannel class instance that allows control of a particular channel.\n   * Channels are numbered from 1.\n   * @param channelNumber Number of channel to control.\n   * @returns Illuminator channel instance.\n   */\n  public getChannel(\n    channelNumber: number\n  ): IlluminatorChannel {\n    if (channelNumber <= 0) {\n      throw new TypeError('Invalid value; channels are numbered from 1.');\n    }\n    return new IlluminatorChannel(this, channelNumber);\n  }\n\n  /**\n   * Checks if this is an illuminator or some other type of device and throws an error if it is not.\n   */\n  private _verifyIsIlluminator(): void {\n    const request = new gateway.DeviceEmptyRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n\n    gateway.callSync('illuminator/verify', request);\n  }\n\n  /**\n   * Finds an illuminator on a connection.\n   * In case of conflict, specify the optional device address.\n   * @param connection Connection on which to detect the illuminator.\n   * @param [options.deviceAddress=0] Optional device address of the illuminator.\n   * @returns New instance of illuminator.\n   */\n  public static async find(\n    connection: Connection,\n    options: Illuminator.FindOptions = {}\n  ): Promise<Illuminator> {\n    const {\n      deviceAddress = 0,\n    } = options;\n    const request = new gateway.FindDeviceRequest();\n    request.setInterfaceId(connection.interfaceId);\n    request.setDeviceAddress(deviceAddress);\n\n    const response = await gateway.callAsync<gateway.FindDeviceResponse>(\n      'illuminator/detect',\n      request,\n      gateway.FindDeviceResponse);\n    return new Illuminator(new Device(connection, response.getAddress()));\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 = new gateway.AxisToStringRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n\n    const response = gateway.callSync<gateway.StringResponse>(\n      'device/device_to_string',\n      request,\n      gateway.StringResponse);\n    return response.getValue();\n  }\n}\n\nnamespace Illuminator {\n  export interface FindOptions {\n      deviceAddress?: number;\n  }\n}\n"]}

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

@@ -0,0 +1,128 @@
+import { AxisStorage } from '../ascii/storage';
+import { AxisSettings } from '../ascii/axis_settings';
+import { Warnings } from '../ascii/warnings';
+import { Response } from '../ascii/response';
+import type { Illuminator } from './illuminator';
+/**
+ * Use to control a channel (LED lamp) on an illuminator.
+ * It is subject to breaking changes without warning until further notice.
+ * Requires at least Firmware 7.09.
+ */
+export declare class IlluminatorChannel {
+    /**
+     * Illuminator of this channel.
+     */
+    get illuminator(): Illuminator;
+    private _illuminator;
+    /**
+     * The channel number identifies the channel on the illuminator.
+     */
+    get channelNumber(): number;
+    private _channelNumber;
+    private _axis;
+    /**
+     * Settings and properties of this channel.
+     */
+    get settings(): AxisSettings;
+    private _settings;
+    /**
+     * Key-value storage of this channel.
+     */
+    get storage(): AxisStorage;
+    private _storage;
+    /**
+     * Warnings and faults of this channel.
+     */
+    get warnings(): Warnings;
+    private _warnings;
+    constructor(illuminator: Illuminator, channelNumber: number);
+    /**
+     * Turns this channel on.
+     */
+    on(): Promise<void>;
+    /**
+     * Turns this channel off.
+     */
+    off(): Promise<void>;
+    /**
+     * Turns this channel on or off.
+     * @param on True to turn channel on, false to turn it off.
+     */
+    setOn(on: boolean): Promise<void>;
+    /**
+     * Checks if this channel is on.
+     * @returns True if channel is on, false otherwise.
+     */
+    isOn(): Promise<boolean>;
+    /**
+     * Sets channel intensity as a fraction of the maximum flux.
+     * @param intensity Fraction of intensity to set (between 0 and 1).
+     */
+    setIntensity(intensity: number): Promise<void>;
+    /**
+     * Gets the current intensity of this channel.
+     * @returns Current intensity as fraction of maximum flux.
+     */
+    getIntensity(): Promise<number>;
+    /**
+     * Sends a generic ASCII command to this channel.
+     * For more information refer to: [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).
+     * @param command Command and its parameters.
+     * @param [options.checkErrors=true] Controls whether to throw an exception when the device rejects the command.
+     * @param [options.timeout=0] The timeout, in milliseconds, for a device to respond to the command.
+     * Overrides the connection default request timeout.
+     * @returns A response to the command.
+     */
+    genericCommand(command: string, options?: IlluminatorChannel.GenericCommandOptions): Promise<Response>;
+    /**
+     * Sends a generic ASCII command to this channel and expects multiple responses.
+     * Responses are returned in order of arrival.
+     * For more information refer to: [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).
+     * @param command Command and its parameters.
+     * @param [options.checkErrors=true] Controls whether to throw an exception when a device rejects the command.
+     * @param [options.timeout=0] The timeout, in milliseconds, for a device to respond to the command.
+     * Overrides the connection default request timeout.
+     * @returns All responses to the command.
+     */
+    genericCommandMultiResponse(command: string, options?: IlluminatorChannel.GenericCommandMultiResponseOptions): Promise<Response[]>;
+    /**
+     * Sends a generic ASCII command to this channel without expecting a response and without adding a message ID
+     * For more information refer to: [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).
+     * @param command Command and its parameters.
+     */
+    genericCommandNoResponse(command: string): Promise<void>;
+    /**
+     * Returns a serialization of the current channel state that can be saved and reapplied.
+     * @returns A serialization of the current state of the channel.
+     */
+    getState(): Promise<string>;
+    /**
+     * Applies a saved state to this channel.
+     * @param state The state object to apply to this channel.
+     */
+    setState(state: string): Promise<void>;
+    /**
+     * Checks if a state can be applied to this channel.
+     * This only covers exceptions that can be determined statically such as mismatches of ID or version,
+     * the process of applying the state can still fail when running.
+     * @param state The state object to check against.
+     * @returns An explanation of why this state cannot be set to this channel.
+     */
+    canSetState(state: string): Promise<string>;
+    /**
+     * Returns a string that represents the channel.
+     * @returns A string that represents the channel.
+     */
+    toString(): string;
+}
+declare namespace IlluminatorChannel {
+    interface GenericCommandOptions {
+        checkErrors?: boolean;
+        timeout?: number;
+    }
+    interface GenericCommandMultiResponseOptions {
+        checkErrors?: boolean;
+        timeout?: number;
+    }
+}
+export {};

package/dist/lib/microscopy/illuminator_channel.js

@@ -0,0 +1,260 @@
+"use strict";
+// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //
+// ============= DO NOT EDIT DIRECTLY ============= //
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IlluminatorChannel = void 0;
+const gateway = __importStar(require("../gateway"));
+const axis_1 = require("../ascii/axis");
+const storage_1 = require("../ascii/storage");
+const axis_settings_1 = require("../ascii/axis_settings");
+const warnings_1 = require("../ascii/warnings");
+const response_1 = require("../ascii/response");
+/**
+ * Use to control a channel (LED lamp) on an illuminator.
+ * It is subject to breaking changes without warning until further notice.
+ * Requires at least Firmware 7.09.
+ */
+class IlluminatorChannel {
+    /**
+     * Illuminator of this channel.
+     */
+    get illuminator() {
+        return this._illuminator;
+    }
+    /**
+     * The channel number identifies the channel on the illuminator.
+     */
+    get channelNumber() {
+        return this._channelNumber;
+    }
+    /**
+     * Settings and properties of this channel.
+     */
+    get settings() {
+        return this._settings;
+    }
+    /**
+     * Key-value storage of this channel.
+     */
+    get storage() {
+        return this._storage;
+    }
+    /**
+     * Warnings and faults of this channel.
+     */
+    get warnings() {
+        return this._warnings;
+    }
+    constructor(illuminator, channelNumber) {
+        this._illuminator = illuminator;
+        this._channelNumber = channelNumber;
+        this._axis = new axis_1.Axis(illuminator.device, channelNumber);
+        this._settings = new axis_settings_1.AxisSettings(this._axis);
+        this._storage = new storage_1.AxisStorage(this._axis);
+        this._warnings = new warnings_1.Warnings(illuminator.device, channelNumber);
+    }
+    /**
+     * Turns this channel on.
+     */
+    async on() {
+        const request = new gateway.ChannelOn();
+        request.setInterfaceId(this.illuminator.device.connection.interfaceId);
+        request.setDevice(this.illuminator.device.deviceAddress);
+        request.setAxis(this.channelNumber);
+        request.setOn(true);
+        await gateway.callAsync('illuminator/on', request);
+    }
+    /**
+     * Turns this channel off.
+     */
+    async off() {
+        const request = new gateway.ChannelOn();
+        request.setInterfaceId(this.illuminator.device.connection.interfaceId);
+        request.setDevice(this.illuminator.device.deviceAddress);
+        request.setAxis(this.channelNumber);
+        request.setOn(false);
+        await gateway.callAsync('illuminator/on', request);
+    }
+    /**
+     * Turns this channel on or off.
+     * @param on True to turn channel on, false to turn it off.
+     */
+    async setOn(on) {
+        const request = new gateway.ChannelOn();
+        request.setInterfaceId(this.illuminator.device.connection.interfaceId);
+        request.setDevice(this.illuminator.device.deviceAddress);
+        request.setAxis(this.channelNumber);
+        request.setOn(on);
+        await gateway.callAsync('illuminator/on', request);
+    }
+    /**
+     * Checks if this channel is on.
+     * @returns True if channel is on, false otherwise.
+     */
+    async isOn() {
+        const request = new gateway.AxisEmptyRequest();
+        request.setInterfaceId(this.illuminator.device.connection.interfaceId);
+        request.setDevice(this.illuminator.device.deviceAddress);
+        request.setAxis(this.channelNumber);
+        const response = await gateway.callAsync('illuminator/is_on', request, gateway.BoolResponse);
+        return response.getValue();
+    }
+    /**
+     * Sets channel intensity as a fraction of the maximum flux.
+     * @param intensity Fraction of intensity to set (between 0 and 1).
+     */
+    async setIntensity(intensity) {
+        const request = new gateway.ChannelSetIntensity();
+        request.setInterfaceId(this.illuminator.device.connection.interfaceId);
+        request.setDevice(this.illuminator.device.deviceAddress);
+        request.setAxis(this.channelNumber);
+        request.setIntensity(intensity);
+        await gateway.callAsync('illuminator/set_intensity', request);
+    }
+    /**
+     * Gets the current intensity of this channel.
+     * @returns Current intensity as fraction of maximum flux.
+     */
+    async getIntensity() {
+        const request = new gateway.AxisEmptyRequest();
+        request.setInterfaceId(this.illuminator.device.connection.interfaceId);
+        request.setDevice(this.illuminator.device.deviceAddress);
+        request.setAxis(this.channelNumber);
+        const response = await gateway.callAsync('illuminator/get_intensity', request, gateway.DoubleResponse);
+        return response.getValue();
+    }
+    /**
+     * Sends a generic ASCII command to this channel.
+     * For more information refer to: [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).
+     * @param command Command and its parameters.
+     * @param [options.checkErrors=true] Controls whether to throw an exception when the device rejects the command.
+     * @param [options.timeout=0] The timeout, in milliseconds, for a device to respond to the command.
+     * Overrides the connection default request timeout.
+     * @returns A response to the command.
+     */
+    async genericCommand(command, options = {}) {
+        const { checkErrors = true, timeout = 0, } = options;
+        const request = new gateway.GenericCommandRequest();
+        request.setInterfaceId(this.illuminator.device.connection.interfaceId);
+        request.setDevice(this.illuminator.device.deviceAddress);
+        request.setAxis(this.channelNumber);
+        request.setCommand(command);
+        request.setCheckErrors(checkErrors);
+        request.setTimeout(timeout);
+        const response = await gateway.callAsync('interface/generic_command', request, gateway.GenericCommandResponse);
+        return response_1.Response.fromProtobuf(response.toObject());
+    }
+    /**
+     * Sends a generic ASCII command to this channel and expects multiple responses.
+     * Responses are returned in order of arrival.
+     * For more information refer to: [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).
+     * @param command Command and its parameters.
+     * @param [options.checkErrors=true] Controls whether to throw an exception when a device rejects the command.
+     * @param [options.timeout=0] The timeout, in milliseconds, for a device to respond to the command.
+     * Overrides the connection default request timeout.
+     * @returns All responses to the command.
+     */
+    async genericCommandMultiResponse(command, options = {}) {
+        const { checkErrors = true, timeout = 0, } = options;
+        const request = new gateway.GenericCommandRequest();
+        request.setInterfaceId(this.illuminator.device.connection.interfaceId);
+        request.setDevice(this.illuminator.device.deviceAddress);
+        request.setAxis(this.channelNumber);
+        request.setCommand(command);
+        request.setCheckErrors(checkErrors);
+        request.setTimeout(timeout);
+        const response = await gateway.callAsync('interface/generic_command_multi_response', request, gateway.GenericCommandResponseCollection);
+        return response.getResponsesList().map(a => response_1.Response.fromProtobuf(a.toObject()));
+    }
+    /**
+     * Sends a generic ASCII command to this channel without expecting a response and without adding a message ID
+     * For more information refer to: [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).
+     * @param command Command and its parameters.
+     */
+    async genericCommandNoResponse(command) {
+        const request = new gateway.GenericCommandRequest();
+        request.setInterfaceId(this.illuminator.device.connection.interfaceId);
+        request.setDevice(this.illuminator.device.deviceAddress);
+        request.setAxis(this.channelNumber);
+        request.setCommand(command);
+        await gateway.callAsync('interface/generic_command_no_response', request);
+    }
+    /**
+     * Returns a serialization of the current channel state that can be saved and reapplied.
+     * @returns A serialization of the current state of the channel.
+     */
+    async getState() {
+        const request = new gateway.AxisEmptyRequest();
+        request.setInterfaceId(this.illuminator.device.connection.interfaceId);
+        request.setDevice(this.illuminator.device.deviceAddress);
+        request.setAxis(this.channelNumber);
+        const response = await gateway.callAsync('device/get_state', request, gateway.StringResponse);
+        return response.getValue();
+    }
+    /**
+     * Applies a saved state to this channel.
+     * @param state The state object to apply to this channel.
+     */
+    async setState(state) {
+        const request = new gateway.SetStateRequest();
+        request.setInterfaceId(this.illuminator.device.connection.interfaceId);
+        request.setDevice(this.illuminator.device.deviceAddress);
+        request.setAxis(this.channelNumber);
+        request.setState(state);
+        await gateway.callAsync('device/set_state', request);
+    }
+    /**
+     * Checks if a state can be applied to this channel.
+     * This only covers exceptions that can be determined statically such as mismatches of ID or version,
+     * the process of applying the state can still fail when running.
+     * @param state The state object to check against.
+     * @returns An explanation of why this state cannot be set to this channel.
+     */
+    async canSetState(state) {
+        const request = new gateway.CanSetStateRequest();
+        request.setInterfaceId(this.illuminator.device.connection.interfaceId);
+        request.setDevice(this.illuminator.device.deviceAddress);
+        request.setAxis(this.channelNumber);
+        request.setState(state);
+        const response = await gateway.callAsync('device/can_set_axis_state', request, gateway.CanSetStateAxisResponse);
+        return response.getError();
+    }
+    /**
+     * Returns a string that represents the channel.
+     * @returns A string that represents the channel.
+     */
+    toString() {
+        const request = new gateway.AxisToStringRequest();
+        request.setInterfaceId(this.illuminator.device.connection.interfaceId);
+        request.setDevice(this.illuminator.device.deviceAddress);
+        request.setAxis(this.channelNumber);
+        request.setTypeOverride('Channel');
+        const response = gateway.callSync('device/axis_to_string', request, gateway.StringResponse);
+        return response.getValue();
+    }
+}
+exports.IlluminatorChannel = IlluminatorChannel;
+//# sourceMappingURL=illuminator_channel.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"illuminator_channel.js","sourceRoot":"","sources":["../../../src/microscopy/illuminator_channel.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtD,oDAAsC;AACtC,wCAAqC;AACrC,8CAA+C;AAC/C,0DAAsD;AACtD,gDAA6C;AAC7C,gDAA6C;AAG7C;;;;GAIG;AACH,MAAa,kBAAkB;IAC7B;;OAEG;IACH,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAGD;;OAEG;IACH,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAKD;;OAEG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAGD;;OAEG;IACH,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAGD;;OAEG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAGD,YAAY,WAAwB,EAAE,aAAqB;QACzD,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAChC,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;QACpC,IAAI,CAAC,KAAK,GAAG,IAAI,WAAI,CAAC,WAAW,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;QACzD,IAAI,CAAC,SAAS,GAAG,IAAI,4BAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC9C,IAAI,CAAC,QAAQ,GAAG,IAAI,qBAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC5C,IAAI,CAAC,SAAS,GAAG,IAAI,mBAAQ,CAAC,WAAW,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IACnE,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,EAAE;QACb,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;QACxC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACvE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACzD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAEpB,MAAM,OAAO,CAAC,SAAS,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,GAAG;QACd,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;QACxC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACvE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACzD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAErB,MAAM,OAAO,CAAC,SAAS,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,KAAK,CAChB,EAAW;QAEX,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;QACxC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACvE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACzD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAElB,MAAM,OAAO,CAAC,SAAS,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,IAAI;QACf,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;QAC/C,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACvE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACzD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAEpC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,mBAAmB,EACnB,OAAO,EACP,OAAO,CAAC,YAAY,CAAC,CAAC;QACxB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAAY,CACvB,SAAiB;QAEjB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,mBAAmB,EAAE,CAAC;QAClD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACvE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACzD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QAEhC,MAAM,OAAO,CAAC,SAAS,CAAC,2BAA2B,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAAY;QACvB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;QAC/C,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACvE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACzD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAEpC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,2BAA2B,EAC3B,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,cAAc,CACzB,OAAe,EACf,UAAoD,EAAE;QAEtD,MAAM,EACJ,WAAW,GAAG,IAAI,EAClB,OAAO,GAAG,CAAC,GACZ,GAAG,OAAO,CAAC;QACZ,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC;QACpD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACvE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACzD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC5B,OAAO,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QACpC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAE5B,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,2BAA2B,EAC3B,OAAO,EACP,OAAO,CAAC,sBAAsB,CAAC,CAAC;QAClC,OAAO,mBAAQ,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,2BAA2B,CACtC,OAAe,EACf,UAAiE,EAAE;QAEnE,MAAM,EACJ,WAAW,GAAG,IAAI,EAClB,OAAO,GAAG,CAAC,GACZ,GAAG,OAAO,CAAC;QACZ,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC;QACpD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACvE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACzD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC5B,OAAO,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QACpC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAE5B,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,0CAA0C,EAC1C,OAAO,EACP,OAAO,CAAC,gCAAgC,CAAC,CAAC;QAC5C,OAAO,QAAQ,CAAC,gBAAgB,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,mBAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;IACnF,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,wBAAwB,CACnC,OAAe;QAEf,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC;QACpD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACvE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACzD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAE5B,MAAM,OAAO,CAAC,SAAS,CAAC,uCAAuC,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,QAAQ;QACnB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;QAC/C,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACvE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACzD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAEpC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,kBAAkB,EAClB,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,QAAQ,CACnB,KAAa;QAEb,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;QAC9C,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACvE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACzD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAExB,MAAM,OAAO,CAAC,SAAS,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,WAAW,CACtB,KAAa;QAEb,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;QACjD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACvE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACzD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAExB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,2BAA2B,EAC3B,OAAO,EACP,OAAO,CAAC,uBAAuB,CAAC,CAAC;QACnC,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,QAAQ;QACb,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,mBAAmB,EAAE,CAAC;QAClD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACvE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACzD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpC,OAAO,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;QAEnC,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,uBAAuB,EACvB,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;CACF;AA3SD,gDA2SC","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 { AxisStorage } from '../ascii/storage';\nimport { AxisSettings } from '../ascii/axis_settings';\nimport { Warnings } from '../ascii/warnings';\nimport { Response } from '../ascii/response';\nimport type { Illuminator } from './illuminator';\n\n/**\n * Use to control a channel (LED lamp) on an illuminator.\n * It is subject to breaking changes without warning until further notice.\n * Requires at least Firmware 7.09.\n */\nexport class IlluminatorChannel {\n  /**\n   * Illuminator of this channel.\n   */\n  public get illuminator(): Illuminator {\n    return this._illuminator;\n  }\n  private _illuminator: Illuminator;\n\n  /**\n   * The channel number identifies the channel on the illuminator.\n   */\n  public get channelNumber(): number {\n    return this._channelNumber;\n  }\n  private _channelNumber: number;\n\n  private _axis: Axis;\n\n  /**\n   * Settings and properties of this channel.\n   */\n  public get settings(): AxisSettings {\n    return this._settings;\n  }\n  private _settings: AxisSettings;\n\n  /**\n   * Key-value storage of this channel.\n   */\n  public get storage(): AxisStorage {\n    return this._storage;\n  }\n  private _storage: AxisStorage;\n\n  /**\n   * Warnings and faults of this channel.\n   */\n  public get warnings(): Warnings {\n    return this._warnings;\n  }\n  private _warnings: Warnings;\n\n  constructor(illuminator: Illuminator, channelNumber: number) {\n    this._illuminator = illuminator;\n    this._channelNumber = channelNumber;\n    this._axis = new Axis(illuminator.device, channelNumber);\n    this._settings = new AxisSettings(this._axis);\n    this._storage = new AxisStorage(this._axis);\n    this._warnings = new Warnings(illuminator.device, channelNumber);\n  }\n\n  /**\n   * Turns this channel on.\n   */\n  public async on(): Promise<void> {\n    const request = new gateway.ChannelOn();\n    request.setInterfaceId(this.illuminator.device.connection.interfaceId);\n    request.setDevice(this.illuminator.device.deviceAddress);\n    request.setAxis(this.channelNumber);\n    request.setOn(true);\n\n    await gateway.callAsync('illuminator/on', request);\n  }\n\n  /**\n   * Turns this channel off.\n   */\n  public async off(): Promise<void> {\n    const request = new gateway.ChannelOn();\n    request.setInterfaceId(this.illuminator.device.connection.interfaceId);\n    request.setDevice(this.illuminator.device.deviceAddress);\n    request.setAxis(this.channelNumber);\n    request.setOn(false);\n\n    await gateway.callAsync('illuminator/on', request);\n  }\n\n  /**\n   * Turns this channel on or off.\n   * @param on True to turn channel on, false to turn it off.\n   */\n  public async setOn(\n    on: boolean\n  ): Promise<void> {\n    const request = new gateway.ChannelOn();\n    request.setInterfaceId(this.illuminator.device.connection.interfaceId);\n    request.setDevice(this.illuminator.device.deviceAddress);\n    request.setAxis(this.channelNumber);\n    request.setOn(on);\n\n    await gateway.callAsync('illuminator/on', request);\n  }\n\n  /**\n   * Checks if this channel is on.\n   * @returns True if channel is on, false otherwise.\n   */\n  public async isOn(): Promise<boolean> {\n    const request = new gateway.AxisEmptyRequest();\n    request.setInterfaceId(this.illuminator.device.connection.interfaceId);\n    request.setDevice(this.illuminator.device.deviceAddress);\n    request.setAxis(this.channelNumber);\n\n    const response = await gateway.callAsync<gateway.BoolResponse>(\n      'illuminator/is_on',\n      request,\n      gateway.BoolResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Sets channel intensity as a fraction of the maximum flux.\n   * @param intensity Fraction of intensity to set (between 0 and 1).\n   */\n  public async setIntensity(\n    intensity: number\n  ): Promise<void> {\n    const request = new gateway.ChannelSetIntensity();\n    request.setInterfaceId(this.illuminator.device.connection.interfaceId);\n    request.setDevice(this.illuminator.device.deviceAddress);\n    request.setAxis(this.channelNumber);\n    request.setIntensity(intensity);\n\n    await gateway.callAsync('illuminator/set_intensity', request);\n  }\n\n  /**\n   * Gets the current intensity of this channel.\n   * @returns Current intensity as fraction of maximum flux.\n   */\n  public async getIntensity(): Promise<number> {\n    const request = new gateway.AxisEmptyRequest();\n    request.setInterfaceId(this.illuminator.device.connection.interfaceId);\n    request.setDevice(this.illuminator.device.deviceAddress);\n    request.setAxis(this.channelNumber);\n\n    const response = await gateway.callAsync<gateway.DoubleResponse>(\n      'illuminator/get_intensity',\n      request,\n      gateway.DoubleResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Sends a generic ASCII command to this channel.\n   * For more information refer to: [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).\n   * @param command Command and its parameters.\n   * @param [options.checkErrors=true] Controls whether to throw an exception when the device rejects the command.\n   * @param [options.timeout=0] The timeout, in milliseconds, for a device to respond to the command.\n   * Overrides the connection default request timeout.\n   * @returns A response to the command.\n   */\n  public async genericCommand(\n    command: string,\n    options: IlluminatorChannel.GenericCommandOptions = {}\n  ): Promise<Response> {\n    const {\n      checkErrors = true,\n      timeout = 0,\n    } = options;\n    const request = new gateway.GenericCommandRequest();\n    request.setInterfaceId(this.illuminator.device.connection.interfaceId);\n    request.setDevice(this.illuminator.device.deviceAddress);\n    request.setAxis(this.channelNumber);\n    request.setCommand(command);\n    request.setCheckErrors(checkErrors);\n    request.setTimeout(timeout);\n\n    const response = await gateway.callAsync<gateway.GenericCommandResponse>(\n      'interface/generic_command',\n      request,\n      gateway.GenericCommandResponse);\n    return Response.fromProtobuf(response.toObject());\n  }\n\n  /**\n   * Sends a generic ASCII command to this channel and expects multiple responses.\n   * Responses are returned in order of arrival.\n   * For more information refer to: [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).\n   * @param command Command and its parameters.\n   * @param [options.checkErrors=true] Controls whether to throw an exception when a device rejects the command.\n   * @param [options.timeout=0] The timeout, in milliseconds, for a device to respond to the command.\n   * Overrides the connection default request timeout.\n   * @returns All responses to the command.\n   */\n  public async genericCommandMultiResponse(\n    command: string,\n    options: IlluminatorChannel.GenericCommandMultiResponseOptions = {}\n  ): Promise<Response[]> {\n    const {\n      checkErrors = true,\n      timeout = 0,\n    } = options;\n    const request = new gateway.GenericCommandRequest();\n    request.setInterfaceId(this.illuminator.device.connection.interfaceId);\n    request.setDevice(this.illuminator.device.deviceAddress);\n    request.setAxis(this.channelNumber);\n    request.setCommand(command);\n    request.setCheckErrors(checkErrors);\n    request.setTimeout(timeout);\n\n    const response = await gateway.callAsync<gateway.GenericCommandResponseCollection>(\n      'interface/generic_command_multi_response',\n      request,\n      gateway.GenericCommandResponseCollection);\n    return response.getResponsesList().map(a => Response.fromProtobuf(a.toObject()));\n  }\n\n  /**\n   * Sends a generic ASCII command to this channel without expecting a response and without adding a message ID\n   * For more information refer to: [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).\n   * @param command Command and its parameters.\n   */\n  public async genericCommandNoResponse(\n    command: string\n  ): Promise<void> {\n    const request = new gateway.GenericCommandRequest();\n    request.setInterfaceId(this.illuminator.device.connection.interfaceId);\n    request.setDevice(this.illuminator.device.deviceAddress);\n    request.setAxis(this.channelNumber);\n    request.setCommand(command);\n\n    await gateway.callAsync('interface/generic_command_no_response', request);\n  }\n\n  /**\n   * Returns a serialization of the current channel state that can be saved and reapplied.\n   * @returns A serialization of the current state of the channel.\n   */\n  public async getState(): Promise<string> {\n    const request = new gateway.AxisEmptyRequest();\n    request.setInterfaceId(this.illuminator.device.connection.interfaceId);\n    request.setDevice(this.illuminator.device.deviceAddress);\n    request.setAxis(this.channelNumber);\n\n    const response = await gateway.callAsync<gateway.StringResponse>(\n      'device/get_state',\n      request,\n      gateway.StringResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Applies a saved state to this channel.\n   * @param state The state object to apply to this channel.\n   */\n  public async setState(\n    state: string\n  ): Promise<void> {\n    const request = new gateway.SetStateRequest();\n    request.setInterfaceId(this.illuminator.device.connection.interfaceId);\n    request.setDevice(this.illuminator.device.deviceAddress);\n    request.setAxis(this.channelNumber);\n    request.setState(state);\n\n    await gateway.callAsync('device/set_state', request);\n  }\n\n  /**\n   * Checks if a state can be applied to this channel.\n   * This only covers exceptions that can be determined statically such as mismatches of ID or version,\n   * the process of applying the state can still fail when running.\n   * @param state The state object to check against.\n   * @returns An explanation of why this state cannot be set to this channel.\n   */\n  public async canSetState(\n    state: string\n  ): Promise<string> {\n    const request = new gateway.CanSetStateRequest();\n    request.setInterfaceId(this.illuminator.device.connection.interfaceId);\n    request.setDevice(this.illuminator.device.deviceAddress);\n    request.setAxis(this.channelNumber);\n    request.setState(state);\n\n    const response = await gateway.callAsync<gateway.CanSetStateAxisResponse>(\n      'device/can_set_axis_state',\n      request,\n      gateway.CanSetStateAxisResponse);\n    return response.getError();\n  }\n\n  /**\n   * Returns a string that represents the channel.\n   * @returns A string that represents the channel.\n   */\n  public toString(): string {\n    const request = new gateway.AxisToStringRequest();\n    request.setInterfaceId(this.illuminator.device.connection.interfaceId);\n    request.setDevice(this.illuminator.device.deviceAddress);\n    request.setAxis(this.channelNumber);\n    request.setTypeOverride('Channel');\n\n    const response = gateway.callSync<gateway.StringResponse>(\n      'device/axis_to_string',\n      request,\n      gateway.StringResponse);\n    return response.getValue();\n  }\n}\n\nnamespace IlluminatorChannel {\n  export interface GenericCommandOptions {\n      checkErrors?: boolean;\n      timeout?: number;\n  }\n  export interface GenericCommandMultiResponseOptions {\n      checkErrors?: boolean;\n      timeout?: number;\n  }\n}\n"]}

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

@@ -1 +1,6 @@
 export { ObjectiveChanger } from './objective_changer';
+export { Illuminator } from './illuminator';
+export { IlluminatorChannel } from './illuminator_channel';
+export { Microscope } from './microscope';
+export { MicroscopeConfig } from './microscope_config';
+export { FilterChanger } from './filter_changer';

package/dist/lib/microscopy/index.js

@@ -1,6 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ObjectiveChanger = void 0;
+exports.FilterChanger = exports.MicroscopeConfig = exports.Microscope = exports.IlluminatorChannel = exports.Illuminator = exports.ObjectiveChanger = void 0;
 var objective_changer_1 = require("./objective_changer");
 Object.defineProperty(exports, "ObjectiveChanger", { enumerable: true, get: function () { return objective_changer_1.ObjectiveChanger; } });
+var illuminator_1 = require("./illuminator");
+Object.defineProperty(exports, "Illuminator", { enumerable: true, get: function () { return illuminator_1.Illuminator; } });
+var illuminator_channel_1 = require("./illuminator_channel");
+Object.defineProperty(exports, "IlluminatorChannel", { enumerable: true, get: function () { return illuminator_channel_1.IlluminatorChannel; } });
+var microscope_1 = require("./microscope");
+Object.defineProperty(exports, "Microscope", { enumerable: true, get: function () { return microscope_1.Microscope; } });
+var microscope_config_1 = require("./microscope_config");
+Object.defineProperty(exports, "MicroscopeConfig", { enumerable: true, get: function () { return microscope_config_1.MicroscopeConfig; } });
+var filter_changer_1 = require("./filter_changer");
+Object.defineProperty(exports, "FilterChanger", { enumerable: true, get: function () { return filter_changer_1.FilterChanger; } });
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/microscopy/index.ts"],"names":[],"mappings":";;;AAAA,yDAAuD;AAA9C,qHAAA,gBAAgB,OAAA","sourcesContent":["export { ObjectiveChanger } from './objective_changer';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/microscopy/index.ts"],"names":[],"mappings":";;;AAAA,yDAAuD;AAA9C,qHAAA,gBAAgB,OAAA;AACzB,6CAA4C;AAAnC,0GAAA,WAAW,OAAA;AACpB,6DAA2D;AAAlD,yHAAA,kBAAkB,OAAA;AAC3B,2CAA0C;AAAjC,wGAAA,UAAU,OAAA;AACnB,yDAAuD;AAA9C,qHAAA,gBAAgB,OAAA;AACzB,mDAAiD;AAAxC,+GAAA,aAAa,OAAA","sourcesContent":["export { ObjectiveChanger } from './objective_changer';\nexport { Illuminator } from './illuminator';\nexport { IlluminatorChannel } from './illuminator_channel';\nexport { Microscope } from './microscope';\nexport { MicroscopeConfig } from './microscope_config';\nexport { FilterChanger } from './filter_changer';\n"]}

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

@@ -0,0 +1,77 @@
+import { Axis } from '../ascii/axis';
+import { AxisGroup } from '../ascii/axis_group';
+import { Connection } from '../ascii/connection';
+import { Illuminator } from './illuminator';
+import { ObjectiveChanger } from './objective_changer';
+import { MicroscopeConfig } from './microscope_config';
+import { FilterChanger } from './filter_changer';
+/**
+ * Represent a microscope.
+ * It is subject to breaking changes without warning until further notice.
+ * Parts of the microscope may or may not be instantiated depending on the configuration.
+ * Requires at least Firmware 7.34.
+ */
+export declare class Microscope {
+    /**
+     * Connection of the microscope.
+     */
+    get connection(): Connection;
+    private _connection;
+    private _config;
+    /**
+     * The illuminator.
+     */
+    get illuminator(): Illuminator | undefined;
+    private _illuminator;
+    /**
+     * The focus axis.
+     */
+    get focusAxis(): Axis | undefined;
+    private _focusAxis;
+    /**
+     * The X axis.
+     */
+    get xAxis(): Axis | undefined;
+    private _xAxis;
+    /**
+     * The Y axis.
+     */
+    get yAxis(): Axis | undefined;
+    private _yAxis;
+    /**
+     * Axis group consisting of X and Y axes representing the plate of the microscope.
+     */
+    get plate(): AxisGroup | undefined;
+    private _plate;
+    /**
+     * The objective changer.
+     */
+    get objectiveChanger(): ObjectiveChanger | undefined;
+    private _objectiveChanger;
+    /**
+     * The filter changer.
+     */
+    get filterChanger(): FilterChanger | undefined;
+    private _filterChanger;
+    /**
+     * Creates instance of `Microscope` from the given config.
+     * Parts are instantiated depending on device addresses in the config.
+     */
+    constructor(connection: Connection, config: MicroscopeConfig);
+    /**
+     * Finds a microscope on a connection.
+     * @param connection Connection on which to detect the microscope.
+     * @returns New instance of microscope.
+     */
+    static find(connection: Connection): Promise<Microscope>;
+    /**
+     * Initializes the microscope.
+     * Homes all axes, filter changer, and objective changer.
+     */
+    initialize(): Promise<void>;
+    /**
+     * Returns a string that represents the microscope.
+     * @returns A string that represents the microscope.
+     */
+    toString(): string;
+}