@zaber/motion 2.5.1 → 2.7.0-save-load

package/dist/node/ascii/device.d.ts

@@ -1,165 +0,0 @@
-import { Connection } from './connection';
-import { DeviceSettings } from './device_settings';
-import { Axis } from './axis';
-import { AllAxes } from './all_axes';
-import { Warnings } from './warnings';
-import { DeviceIdentity } from './device_identity';
-import { DeviceIO } from './device_io';
-import { Response } from './response';
-import { Lockstep } from './lockstep';
-import { Stream } from './stream';
-import { StreamBuffer } from './stream_buffer';
-import { Measurement } from '../measurement';
-import { FirmwareVersion } from '../firmware_version';
-/**
- * Represents the controller part of one device - may be either a standalone controller or an integrated controller.
- */
-export declare class Device {
-    /**
-     * Connection of this device.
-     */
-    get connection(): Connection;
-    private _connection;
-    /**
-     * The device address uniquely identifies the device on the connection.
-     * It can be configured or automatically assigned by the renumber command.
-     */
-    get deviceAddress(): number;
-    private _deviceAddress;
-    /**
-     * Settings and properties of this device.
-     */
-    get settings(): DeviceSettings;
-    private _settings;
-    /**
-     * I/O channels of this device.
-     */
-    get io(): DeviceIO;
-    private _io;
-    /**
-     * Virtual axis which allows you to target all axes of this device.
-     */
-    get allAxes(): AllAxes;
-    private _allAxes;
-    /**
-     * Warnings and faults of this device and all its axes.
-     */
-    get warnings(): Warnings;
-    private _warnings;
-    /**
-     * Identity of the device.
-     */
-    get identity(): DeviceIdentity;
-    /**
-     * Indicates whether or not the device has been identified.
-     */
-    get isIdentified(): boolean;
-    /**
-     * Unique ID of the device hardware.
-     */
-    get deviceId(): number;
-    /**
-     * Serial number of the device.
-     */
-    get serialNumber(): number;
-    /**
-     * Name of the product.
-     */
-    get name(): string;
-    /**
-     * Number of axes this device has.
-     */
-    get axisCount(): number;
-    /**
-     * Version of the firmware.
-     */
-    get firmwareVersion(): FirmwareVersion;
-    constructor(connection: Connection, deviceAddress: number);
-    /**
-     * Queries the device and the database, gathering information about the product.
-     * Without this information features such as unit conversions will not work.
-     * Usually, called automatically by detect devices method.
-     * @return Device identification data.
-     */
-    identify(): Promise<DeviceIdentity>;
-    /**
-     * Sends a generic ASCII command to this device.
-     * For more information refer to: [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).
-     * @param command Command and its parameters.
-     * @param axis Optional axis number to send the command to.
-     * @param checkErrors Controls whether to throw an exception when the device rejects the command.
-     * @param timeout The timeout, in milliseconds, for a device to respond to the command.
-     * Overrides the connection default request timeout.
-     * @return A response to the command.
-     */
-    genericCommand(command: string, axis?: number, checkErrors?: boolean, timeout?: number): Promise<Response>;
-    /**
-     * Sends a generic ASCII command to this device and expect 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 axis Optional axis number to send the command to.
-     * @param checkErrors Controls whether to throw an exception when a device rejects the command.
-     * @param timeout The timeout, in milliseconds, for a device to respond to the command.
-     * Overrides the connection default request timeout.
-     * @return All responses to the command.
-     */
-    genericCommandMultiResponse(command: string, axis?: number, checkErrors?: boolean, timeout?: number): Promise<Response[]>;
-    /**
-     * Sends a generic ASCII command to this device 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.
-     * @param axis Optional axis number to send the command to.
-     */
-    genericCommandNoResponse(command: string, axis?: number): Promise<void>;
-    /**
-     * Gets an Axis class instance which allows you to control a particular axis on this device.
-     * Axes are numbered from 1.
-     * @param axisNumber Number of axis intended to control.
-     * @return Axis instance.
-     */
-    getAxis(axisNumber: number): Axis;
-    /**
-     * Gets a Lockstep class instance which allows you to control a particular lockstep group on the device.
-     * @param lockstepGroupId The ID of the lockstep group to control. Lockstep group IDs start at one.
-     * @return Lockstep instance.
-     */
-    getLockstep(lockstepGroupId: number): Lockstep;
-    /**
-     * Formats parameters into a command and performs unit conversions.
-     * Parameters in the command template are denoted by a question mark.
-     * Command returned is only valid for this device.
-     * For more information refer to: [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).
-     * @param commandTemplate Template of a command to prepare. Parameters are denoted by question marks.
-     * @param parameters Variable number of command parameters.
-     * @return Command with converted parameters.
-     */
-    prepareCommand(commandTemplate: string, ...parameters: Measurement[]): string;
-    /**
-     * Returns a string that represents the device.
-     * @return A string that represents the device.
-     */
-    toString(): string;
-    /**
-     * Gets a Stream class instance which allows you to control a particular stream on the device.
-     * @param streamId The ID of the stream to control. Stream IDs start at one.
-     * @return Stream instance.
-     */
-    getStream(streamId: number): Stream;
-    /**
-     * Gets a StreamBuffer class instance which is a handle for a stream buffer on the device.
-     * @param streamBufferId The ID of the stream buffer to control. Stream buffer IDs start at one.
-     * @return StreamBuffer instance.
-     */
-    getStreamBuffer(streamBufferId: number): StreamBuffer;
-    /**
-     * Returns identity.
-     * @return Device identity.
-     */
-    private _retrieveIdentity;
-    /**
-     * Returns whether or not the device have been identified.
-     * @return True if the device has already been identified. False otherwise.
-     */
-    private _retrieveIsIdentified;
-}

package/dist/node/ascii/device.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"device.js","sourceRoot":"","sources":["../../../src/ascii/device.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;AAGtD,uDAAmD;AACnD,iCAA8B;AAC9B,yCAAqC;AACrC,yCAAsC;AACtC,uDAAmD;AACnD,2CAAuC;AACvC,yCAAsC;AACtC,yCAAsC;AACtC,qCAAkC;AAClC,mDAA+C;AAC/C,gDAA6C;AAE7C,oDAAsC;AAEtC;;GAEG;AACH,MAAa,MAAM;IAmGjB,YAAY,UAAsB,EAAE,aAAqB;QACvD,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;QACpC,IAAI,CAAC,SAAS,GAAG,IAAI,gCAAc,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,CAAC,GAAG,GAAG,IAAI,oBAAQ,CAAC,IAAI,CAAC,CAAC;QAC9B,IAAI,CAAC,QAAQ,GAAG,IAAI,kBAAO,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,CAAC,SAAS,GAAG,IAAI,mBAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IACzC,CAAC;IAzGD;;OAEG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAGD;;;OAGG;IACH,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAGD;;OAEG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAGD;;OAEG;IACH,IAAW,EAAE;QACX,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,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;;OAEG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,qBAAqB,EAAE,CAAC;IACtC,CAAC;IAED;;OAEG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;IAChC,CAAC;IAED;;OAEG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;IACpC,CAAC;IAED;;OAEG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,IAAW,eAAe;QACxB,OAAO,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC;IACvC,CAAC;IAWD;;;;;OAKG;IACI,KAAK,CAAC,QAAQ;QACnB,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,IAAI,CAAC,aAAa,CAAC,CAAC;QAEtC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,iBAAiB,EACjB,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,gCAAc,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,cAAc,CACzB,OAAe,EACf,OAAe,CAAC,EAChB,cAAuB,IAAI,EAC3B,UAAkB,CAAC;QAEnB,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,IAAI,CAAC,aAAa,CAAC,CAAC;QACtC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC5B,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACtB,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;;;;;;;;;;OAUG;IACI,KAAK,CAAC,2BAA2B,CACtC,OAAe,EACf,OAAe,CAAC,EAChB,cAAuB,IAAI,EAC3B,UAAkB,CAAC;QAEnB,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,IAAI,CAAC,aAAa,CAAC,CAAC;QACtC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC5B,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACtB,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,QAAQ,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,mBAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC;IACpF,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,wBAAwB,CACnC,OAAe,EACf,OAAe,CAAC;QAEhB,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,IAAI,CAAC,aAAa,CAAC,CAAC;QACtC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC5B,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,MAAM,OAAO,CAAC,SAAS,CAAC,uCAAuC,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;OAKG;IACI,OAAO,CACZ,UAAkB;QAElB,IAAI,UAAU,IAAI,CAAC,EAAE;YACnB,MAAM,IAAI,SAAS,CAAC,mDAAmD,CAAC,CAAC;SAC1E;QACD,OAAO,IAAI,WAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACI,WAAW,CAChB,eAAuB;QAEvB,IAAI,eAAe,IAAI,CAAC,EAAE;YACxB,MAAM,IAAI,SAAS,CAAC,qDAAqD,CAAC,CAAC;SAC5E;QACD,OAAO,IAAI,mBAAQ,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;;OAQG;IACI,cAAc,CACnB,eAAuB,EACvB,GAAG,UAAyB;QAE5B,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,IAAI,CAAC,aAAa,CAAC,CAAC;QACtC,OAAO,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;QAC5C,OAAO,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC,yBAAW,CAAC,UAAU,CAAC,CAAC,CAAC;QAElE,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,wBAAwB,EACxB,OAAO,EACP,OAAO,CAAC,sBAAsB,CAAC,CAAC;QAClC,OAAO,QAAQ,CAAC,UAAU,EAAE,CAAC;IAC/B,CAAC;IAED;;;OAGG;IACI,QAAQ;QACb,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;QAC9C,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACpD,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAEtC,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,yBAAyB,EACzB,OAAO,EACP,OAAO,CAAC,gBAAgB,CAAC,CAAC;QAC5B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,SAAS,CACd,QAAgB;QAEhB,IAAI,QAAQ,IAAI,CAAC,EAAE;YACjB,MAAM,IAAI,SAAS,CAAC,6CAA6C,CAAC,CAAC;SACpE;QACD,OAAO,IAAI,eAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACI,eAAe,CACpB,cAAsB;QAEtB,IAAI,cAAc,IAAI,CAAC,EAAE;YACvB,MAAM,IAAI,SAAS,CAAC,oDAAoD,CAAC,CAAC;SAC3E;QACD,OAAO,IAAI,4BAAY,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;IAChD,CAAC;IAED;;;OAGG;IACK,iBAAiB;QACvB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,wBAAwB,EAAE,CAAC;QACvD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACpD,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAEtC,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,qBAAqB,EACrB,OAAO,EACP,OAAO,CAAC,yBAAyB,CAAC,CAAC;QACrC,OAAO,gCAAc,CAAC,YAAY,CAAC,QAAQ,CAAC,WAAW,EAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;OAGG;IACK,qBAAqB;QAC3B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,4BAA4B,EAAE,CAAC;QAC3D,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACpD,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAEtC,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,0BAA0B,EAC1B,OAAO,EACP,OAAO,CAAC,6BAA6B,CAAC,CAAC;QACzC,OAAO,QAAQ,CAAC,eAAe,EAAE,CAAC;IACpC,CAAC;CACF;AAlVD,wBAkVC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport { Connection } from './connection';\nimport { DeviceSettings } from './device_settings';\nimport { Axis } from './axis';\nimport { AllAxes } from './all_axes';\nimport { Warnings } from './warnings';\nimport { DeviceIdentity } from './device_identity';\nimport { DeviceIO } from './device_io';\nimport { Response } from './response';\nimport { Lockstep } from './lockstep';\nimport { Stream } from './stream';\nimport { StreamBuffer } from './stream_buffer';\nimport { Measurement } from '../measurement';\nimport { FirmwareVersion } from '../firmware_version';\nimport * as gateway from '../gateway';\n\n/**\n * Represents the controller part of one device - may be either a standalone controller or an integrated controller.\n */\nexport class Device {\n  /**\n   * Connection of this device.\n   */\n  public get connection(): Connection {\n    return this._connection;\n  }\n  private _connection: Connection;\n\n  /**\n   * The device address uniquely identifies the device on the connection.\n   * It can be configured or automatically assigned by the renumber command.\n   */\n  public get deviceAddress(): number {\n    return this._deviceAddress;\n  }\n  private _deviceAddress: number;\n\n  /**\n   * Settings and properties of this device.\n   */\n  public get settings(): DeviceSettings {\n    return this._settings;\n  }\n  private _settings: DeviceSettings;\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   * Virtual axis which allows you to target all axes of this device.\n   */\n  public get allAxes(): AllAxes {\n    return this._allAxes;\n  }\n  private _allAxes: AllAxes;\n\n  /**\n   * Warnings and faults of this device and all its axes.\n   */\n  public get warnings(): Warnings {\n    return this._warnings;\n  }\n  private _warnings: Warnings;\n\n  /**\n   * Identity of the device.\n   */\n  public get identity(): DeviceIdentity {\n    return this._retrieveIdentity();\n  }\n\n  /**\n   * Indicates whether or not the device has been identified.\n   */\n  public get isIdentified(): boolean {\n    return this._retrieveIsIdentified();\n  }\n\n  /**\n   * Unique ID of the device hardware.\n   */\n  public get deviceId(): number {\n    return this.identity.deviceId;\n  }\n\n  /**\n   * Serial number of the device.\n   */\n  public get serialNumber(): number {\n    return this.identity.serialNumber;\n  }\n\n  /**\n   * Name of the product.\n   */\n  public get name(): string {\n    return this.identity.name;\n  }\n\n  /**\n   * Number of axes this device has.\n   */\n  public get axisCount(): number {\n    return this.identity.axisCount;\n  }\n\n  /**\n   * Version of the firmware.\n   */\n  public get firmwareVersion(): FirmwareVersion {\n    return this.identity.firmwareVersion;\n  }\n\n  constructor(connection: Connection, deviceAddress: number) {\n    this._connection = connection;\n    this._deviceAddress = deviceAddress;\n    this._settings = new DeviceSettings(this);\n    this._io = new DeviceIO(this);\n    this._allAxes = new AllAxes(this);\n    this._warnings = new Warnings(this, 0);\n  }\n\n  /**\n   * Queries the device and the database, gathering information about the product.\n   * Without this information features such as unit conversions will not work.\n   * Usually, called automatically by detect devices method.\n   * @return Device identification data.\n   */\n  public async identify(): Promise<DeviceIdentity> {\n    const request = new gateway.DeviceIdentifyRequest();\n    request.setInterfaceId(this.connection.interfaceId);\n    request.setDevice(this.deviceAddress);\n\n    const response = await gateway.callAsync<gateway.DeviceIdentity>(\n      'device/identify',\n      request,\n      gateway.DeviceIdentity);\n    return DeviceIdentity.fromProtobuf(response.toObject());\n  }\n\n  /**\n   * Sends a generic ASCII command to this device.\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 axis Optional axis number to send the command to.\n   * @param checkErrors Controls whether to throw an exception when the device rejects the command.\n   * @param timeout The timeout, in milliseconds, for a device to respond to the command.\n   * Overrides the connection default request timeout.\n   * @return A response to the command.\n   */\n  public async genericCommand(\n    command: string,\n    axis: number = 0,\n    checkErrors: boolean = true,\n    timeout: number = 0\n  ): Promise<Response> {\n    const request = new gateway.GenericCommandRequest();\n    request.setInterfaceId(this.connection.interfaceId);\n    request.setDevice(this.deviceAddress);\n    request.setCommand(command);\n    request.setAxis(axis);\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 device and expect 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 axis Optional axis number to send the command to.\n   * @param checkErrors Controls whether to throw an exception when a device rejects the command.\n   * @param timeout The timeout, in milliseconds, for a device to respond to the command.\n   * Overrides the connection default request timeout.\n   * @return All responses to the command.\n   */\n  public async genericCommandMultiResponse(\n    command: string,\n    axis: number = 0,\n    checkErrors: boolean = true,\n    timeout: number = 0\n  ): Promise<Response[]> {\n    const request = new gateway.GenericCommandRequest();\n    request.setInterfaceId(this.connection.interfaceId);\n    request.setDevice(this.deviceAddress);\n    request.setCommand(command);\n    request.setAxis(axis);\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.toObject().responsesList.map(resp => Response.fromProtobuf(resp));\n  }\n\n  /**\n   * Sends a generic ASCII command to this device 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   * @param axis Optional axis number to send the command to.\n   */\n  public async genericCommandNoResponse(\n    command: string,\n    axis: number = 0\n  ): Promise<void> {\n    const request = new gateway.GenericCommandRequest();\n    request.setInterfaceId(this.connection.interfaceId);\n    request.setDevice(this.deviceAddress);\n    request.setCommand(command);\n    request.setAxis(axis);\n\n    await gateway.callAsync('interface/generic_command_no_response', request);\n  }\n\n  /**\n   * Gets an Axis class instance which allows you to control a particular axis on this device.\n   * Axes are numbered from 1.\n   * @param axisNumber Number of axis intended to control.\n   * @return Axis instance.\n   */\n  public getAxis(\n    axisNumber: number\n  ): Axis {\n    if (axisNumber <= 0) {\n      throw new TypeError('Invalid value; physical axes are numbered from 1.');\n    }\n    return new Axis(this, axisNumber);\n  }\n\n  /**\n   * Gets a Lockstep class instance which allows you to control a particular lockstep group on the device.\n   * @param lockstepGroupId The ID of the lockstep group to control. Lockstep group IDs start at one.\n   * @return Lockstep instance.\n   */\n  public getLockstep(\n    lockstepGroupId: number\n  ): Lockstep {\n    if (lockstepGroupId <= 0) {\n      throw new TypeError('Invalid value; lockstep groups are numbered from 1.');\n    }\n    return new Lockstep(this, lockstepGroupId);\n  }\n\n  /**\n   * Formats parameters into a command and performs unit conversions.\n   * Parameters in the command template are denoted by a question mark.\n   * Command returned is only valid for this device.\n   * For more information refer to: [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).\n   * @param commandTemplate Template of a command to prepare. Parameters are denoted by question marks.\n   * @param parameters Variable number of command parameters.\n   * @return Command with converted parameters.\n   */\n  public prepareCommand(\n    commandTemplate: string,\n    ...parameters: Measurement[]\n  ): string {\n    const request = new gateway.PrepareCommandRequest();\n    request.setInterfaceId(this.connection.interfaceId);\n    request.setDevice(this.deviceAddress);\n    request.setCommandTemplate(commandTemplate);\n    request.setParametersList(parameters.map(Measurement.toProtobuf));\n\n    const response = gateway.callSync<gateway.PrepareCommandResponse>(\n      'device/prepare_command',\n      request,\n      gateway.PrepareCommandResponse);\n    return response.getCommand();\n  }\n\n  /**\n   * Returns a string that represents the device.\n   * @return A string that represents the device.\n   */\n  public toString(): string {\n    const request = new gateway.ToStringRequest();\n    request.setInterfaceId(this.connection.interfaceId);\n    request.setDevice(this.deviceAddress);\n\n    const response = gateway.callSync<gateway.ToStringResponse>(\n      'device/device_to_string',\n      request,\n      gateway.ToStringResponse);\n    return response.getToStr();\n  }\n\n  /**\n   * Gets a Stream class instance which allows you to control a particular stream on the device.\n   * @param streamId The ID of the stream to control. Stream IDs start at one.\n   * @return Stream instance.\n   */\n  public getStream(\n    streamId: number\n  ): Stream {\n    if (streamId <= 0) {\n      throw new TypeError('Invalid value; streams are numbered from 1.');\n    }\n    return new Stream(this, streamId);\n  }\n\n  /**\n   * Gets a StreamBuffer class instance which is a handle for a stream buffer on the device.\n   * @param streamBufferId The ID of the stream buffer to control. Stream buffer IDs start at one.\n   * @return StreamBuffer instance.\n   */\n  public getStreamBuffer(\n    streamBufferId: number\n  ): StreamBuffer {\n    if (streamBufferId <= 0) {\n      throw new TypeError('Invalid value; stream buffers are numbered from 1.');\n    }\n    return new StreamBuffer(this, streamBufferId);\n  }\n\n  /**\n   * Returns identity.\n   * @return Device identity.\n   */\n  private _retrieveIdentity(): DeviceIdentity {\n    const request = new gateway.DeviceGetIdentityRequest();\n    request.setInterfaceId(this.connection.interfaceId);\n    request.setDevice(this.deviceAddress);\n\n    const response = gateway.callSync<gateway.DeviceGetIdentityResponse>(\n      'device/get_identity',\n      request,\n      gateway.DeviceGetIdentityResponse);\n    return DeviceIdentity.fromProtobuf(response.getIdentity()!.toObject());\n  }\n\n  /**\n   * Returns whether or not the device have been identified.\n   * @return True if the device has already been identified. False otherwise.\n   */\n  private _retrieveIsIdentified(): boolean {\n    const request = new gateway.DeviceGetIsIdentifiedRequest();\n    request.setInterfaceId(this.connection.interfaceId);\n    request.setDevice(this.deviceAddress);\n\n    const response = gateway.callSync<gateway.DeviceGetIsIdentifiedResponse>(\n      'device/get_is_identified',\n      request,\n      gateway.DeviceGetIsIdentifiedResponse);\n    return response.getIsIdentified();\n  }\n}\n"]}

package/dist/node/ascii/device_settings.d.ts

@@ -1,41 +0,0 @@
-import { Device } from './device';
-import { Units } from '../units';
-/**
- * Class providing access to various device settings and properties.
- */
-export declare class DeviceSettings {
-    private _device;
-    constructor(device: Device);
-    /**
-     * Returns any device setting or property.
-     * For more information refer to the [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_settings).
-     * @param setting Name of the setting.
-     * @param unit Units of setting.
-     * @return Setting value.
-     */
-    get(setting: string, unit?: Units): Promise<number>;
-    /**
-     * Sets any device setting.
-     * For more information refer to the [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_settings).
-     * @param setting Name of the setting.
-     * @param value Value of the setting.
-     * @param unit Units of setting.
-     */
-    set(setting: string, value: number, unit?: Units): Promise<void>;
-    /**
-     * Convert arbitrary setting value to Zaber native units.
-     * @param setting Name of the setting.
-     * @param value Value of the setting in units specified by following argument.
-     * @param unit Units of the value.
-     * @return Setting value.
-     */
-    convertToNativeUnits(setting: string, value: number, unit: Units): number;
-    /**
-     * Convert arbitrary setting value from Zaber native units.
-     * @param setting Name of the setting.
-     * @param value Value of the setting in Zaber native units.
-     * @param unit Units to convert value to.
-     * @return Setting value.
-     */
-    convertFromNativeUnits(setting: string, value: number, unit: Units): number;
-}

package/dist/node/ascii/device_settings.js

@@ -1,103 +0,0 @@
-"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;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (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.DeviceSettings = void 0;
-const units_1 = require("../units");
-const gateway = __importStar(require("../gateway"));
-/**
- * Class providing access to various device settings and properties.
- */
-class DeviceSettings {
-    constructor(device) {
-        this._device = device;
-    }
-    /**
-     * Returns any device setting or property.
-     * For more information refer to the [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_settings).
-     * @param setting Name of the setting.
-     * @param unit Units of setting.
-     * @return Setting value.
-     */
-    async get(setting, unit = units_1.Units.NATIVE) {
-        const request = new gateway.DeviceGetSettingRequest();
-        request.setInterfaceId(this._device.connection.interfaceId);
-        request.setDevice(this._device.deviceAddress);
-        request.setSetting(setting);
-        request.setUnit(unit);
-        const response = await gateway.callAsync('device/get_setting', request, gateway.DeviceGetSettingResponse);
-        return response.getValue();
-    }
-    /**
-     * Sets any device setting.
-     * For more information refer to the [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_settings).
-     * @param setting Name of the setting.
-     * @param value Value of the setting.
-     * @param unit Units of setting.
-     */
-    async set(setting, value, unit = units_1.Units.NATIVE) {
-        const request = new gateway.DeviceSetSettingRequest();
-        request.setInterfaceId(this._device.connection.interfaceId);
-        request.setDevice(this._device.deviceAddress);
-        request.setSetting(setting);
-        request.setValue(value);
-        request.setUnit(unit);
-        await gateway.callAsync('device/set_setting', request);
-    }
-    /**
-     * Convert arbitrary setting value to Zaber native units.
-     * @param setting Name of the setting.
-     * @param value Value of the setting in units specified by following argument.
-     * @param unit Units of the value.
-     * @return Setting value.
-     */
-    convertToNativeUnits(setting, value, unit) {
-        const request = new gateway.DeviceConvertSettingRequest();
-        request.setInterfaceId(this._device.connection.interfaceId);
-        request.setDevice(this._device.deviceAddress);
-        request.setSetting(setting);
-        request.setValue(value);
-        request.setUnit(unit);
-        const response = gateway.callSync('device/convert_setting', request, gateway.DeviceConvertSettingResponse);
-        return response.getValue();
-    }
-    /**
-     * Convert arbitrary setting value from Zaber native units.
-     * @param setting Name of the setting.
-     * @param value Value of the setting in Zaber native units.
-     * @param unit Units to convert value to.
-     * @return Setting value.
-     */
-    convertFromNativeUnits(setting, value, unit) {
-        const request = new gateway.DeviceConvertSettingRequest();
-        request.setInterfaceId(this._device.connection.interfaceId);
-        request.setDevice(this._device.deviceAddress);
-        request.setFromNative(true);
-        request.setSetting(setting);
-        request.setValue(value);
-        request.setUnit(unit);
-        const response = gateway.callSync('device/convert_setting', request, gateway.DeviceConvertSettingResponse);
-        return response.getValue();
-    }
-}
-exports.DeviceSettings = DeviceSettings;
-//# sourceMappingURL=device_settings.js.map

package/dist/node/ascii/device_settings.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"device_settings.js","sourceRoot":"","sources":["../../../src/ascii/device_settings.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;AAGtD,oCAAiC;AACjC,oDAAsC;AAEtC;;GAEG;AACH,MAAa,cAAc;IAGzB,YAAY,MAAc;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,GAAG,CACd,OAAe,EACf,OAAc,aAAK,CAAC,MAAM;QAE1B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC5D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC9C,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC5B,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,oBAAoB,EACpB,OAAO,EACP,OAAO,CAAC,wBAAwB,CAAC,CAAC;QACpC,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,GAAG,CACd,OAAe,EACf,KAAa,EACb,OAAc,aAAK,CAAC,MAAM;QAE1B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC5D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC9C,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC5B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,MAAM,OAAO,CAAC,SAAS,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;OAMG;IACI,oBAAoB,CACzB,OAAe,EACf,KAAa,EACb,IAAW;QAEX,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,2BAA2B,EAAE,CAAC;QAC1D,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC5D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC9C,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC5B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,wBAAwB,EACxB,OAAO,EACP,OAAO,CAAC,4BAA4B,CAAC,CAAC;QACxC,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;;OAMG;IACI,sBAAsB,CAC3B,OAAe,EACf,KAAa,EACb,IAAW;QAEX,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,2BAA2B,EAAE,CAAC;QAC1D,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC5D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC9C,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAC5B,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC5B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,wBAAwB,EACxB,OAAO,EACP,OAAO,CAAC,4BAA4B,CAAC,CAAC;QACxC,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;CACF;AAzGD,wCAyGC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport { Device } from './device';\nimport { Units } from '../units';\nimport * as gateway from '../gateway';\n\n/**\n * Class providing access to various device settings and properties.\n */\nexport class DeviceSettings {\n  private _device: Device;\n\n  constructor(device: Device) {\n    this._device = device;\n  }\n\n  /**\n   * Returns any device setting or property.\n   * For more information refer to the [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_settings).\n   * @param setting Name of the setting.\n   * @param unit Units of setting.\n   * @return Setting value.\n   */\n  public async get(\n    setting: string,\n    unit: Units = Units.NATIVE\n  ): Promise<number> {\n    const request = new gateway.DeviceGetSettingRequest();\n    request.setInterfaceId(this._device.connection.interfaceId);\n    request.setDevice(this._device.deviceAddress);\n    request.setSetting(setting);\n    request.setUnit(unit);\n\n    const response = await gateway.callAsync<gateway.DeviceGetSettingResponse>(\n      'device/get_setting',\n      request,\n      gateway.DeviceGetSettingResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Sets any device setting.\n   * For more information refer to the [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_settings).\n   * @param setting Name of the setting.\n   * @param value Value of the setting.\n   * @param unit Units of setting.\n   */\n  public async set(\n    setting: string,\n    value: number,\n    unit: Units = Units.NATIVE\n  ): Promise<void> {\n    const request = new gateway.DeviceSetSettingRequest();\n    request.setInterfaceId(this._device.connection.interfaceId);\n    request.setDevice(this._device.deviceAddress);\n    request.setSetting(setting);\n    request.setValue(value);\n    request.setUnit(unit);\n\n    await gateway.callAsync('device/set_setting', request);\n  }\n\n  /**\n   * Convert arbitrary setting value to Zaber native units.\n   * @param setting Name of the setting.\n   * @param value Value of the setting in units specified by following argument.\n   * @param unit Units of the value.\n   * @return Setting value.\n   */\n  public convertToNativeUnits(\n    setting: string,\n    value: number,\n    unit: Units\n  ): number {\n    const request = new gateway.DeviceConvertSettingRequest();\n    request.setInterfaceId(this._device.connection.interfaceId);\n    request.setDevice(this._device.deviceAddress);\n    request.setSetting(setting);\n    request.setValue(value);\n    request.setUnit(unit);\n\n    const response = gateway.callSync<gateway.DeviceConvertSettingResponse>(\n      'device/convert_setting',\n      request,\n      gateway.DeviceConvertSettingResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Convert arbitrary setting value from Zaber native units.\n   * @param setting Name of the setting.\n   * @param value Value of the setting in Zaber native units.\n   * @param unit Units to convert value to.\n   * @return Setting value.\n   */\n  public convertFromNativeUnits(\n    setting: string,\n    value: number,\n    unit: Units\n  ): number {\n    const request = new gateway.DeviceConvertSettingRequest();\n    request.setInterfaceId(this._device.connection.interfaceId);\n    request.setDevice(this._device.deviceAddress);\n    request.setFromNative(true);\n    request.setSetting(setting);\n    request.setValue(value);\n    request.setUnit(unit);\n\n    const response = gateway.callSync<gateway.DeviceConvertSettingResponse>(\n      'device/convert_setting',\n      request,\n      gateway.DeviceConvertSettingResponse);\n    return response.getValue();\n  }\n}\n"]}