@zaber/motion 2.6.1 → 2.7.0-load-state-checks

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

@@ -1 +1 @@
-{"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"]}
+{"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,oFAA6E;AAC7E,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;IACI,KAAK,CAAC,QAAQ;QACnB,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,MAAM,OAAO,CAAC,SAAS,CACtC,kBAAkB,EAClB,OAAO,EACP,OAAO,CAAC,gBAAgB,CAAC,CAAC;QAC5B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,QAAQ,CACnB,KAAa,EACb,aAAsB,KAAK;QAE3B,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;QACtC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAElC,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,UAAU,CAAC,WAAW,CAAC,CAAC;QACpD,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACtC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAExB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,sBAAsB,EACtB,OAAO,EACP,OAAO,CAAC,yBAAyB,CAAC,CAAC;QACrC,OAAO,yDAAyB,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;IACrE,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;AA1YD,wBA0YC","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 { CanSetStateDeviceResponse } from '../can_set_state_device_response';\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 a serialization of the current device state that can be saved and reapplied.\n   * @return A serialization of the current state of the device.\n   */\n  public async getState(): Promise<string> {\n    const request = new gateway.GetStateRequest();\n    request.setInterfaceId(this.connection.interfaceId);\n    request.setDevice(this.deviceAddress);\n\n    const response = await gateway.callAsync<gateway.GetStateResponse>(\n      'device/get_state',\n      request,\n      gateway.GetStateResponse);\n    return response.getState();\n  }\n\n  /**\n   * Applies a saved state to an axis.\n   * @param state The state object to apply to this axis.\n   * @param deviceOnly If true, only device scope settings and features will be set.\n   */\n  public async setState(\n    state: string,\n    deviceOnly: boolean = false\n  ): Promise<void> {\n    const request = new gateway.SetStateRequest();\n    request.setInterfaceId(this.connection.interfaceId);\n    request.setDevice(this.deviceAddress);\n    request.setState(state);\n    request.setDeviceOnly(deviceOnly);\n\n    await gateway.callAsync('device/set_state', request);\n  }\n\n  /**\n   * Checks if a state can be applied to a device and its peripherals.\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   * @return An object listing errors that come up when trying to set the state.\n   */\n  public async canSetState(\n    state: string\n  ): Promise<CanSetStateDeviceResponse> {\n    const request = new gateway.CanSetStateRequest();\n    request.setInterfaceId(this.connection.interfaceId);\n    request.setDevice(this.deviceAddress);\n    request.setState(state);\n\n    const response = await gateway.callAsync<gateway.CanSetStateDeviceResponse>(\n      'device/can_set_state',\n      request,\n      gateway.CanSetStateDeviceResponse);\n    return CanSetStateDeviceResponse.fromProtobuf(response.toObject());\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/lib/ascii/device_settings.d.ts

@@ -22,6 +22,20 @@ export declare class DeviceSettings {
      * @param unit Units of setting.
      */
     set(setting: string, value: number, unit?: Units): Promise<void>;
+    /**
+     * Returns any device setting or property as a string.
+     * For more information refer to the [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_settings).
+     * @param setting Name of the setting.
+     * @return Setting value.
+     */
+    getString(setting: string): Promise<string>;
+    /**
+     * Sets any device setting as a string.
+     * 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.
+     */
+    setString(setting: string, value: string): Promise<void>;
     /**
      * Convert arbitrary setting value to Zaber native units.
      * @param setting Name of the setting.

package/dist/lib/ascii/device_settings.js

@@ -63,6 +63,34 @@ class DeviceSettings {
         request.setUnit(unit);
         await gateway.callAsync('device/set_setting', request);
     }
+    /**
+     * Returns any device setting or property as a string.
+     * For more information refer to the [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_settings).
+     * @param setting Name of the setting.
+     * @return Setting value.
+     */
+    async getString(setting) {
+        const request = new gateway.DeviceGetSettingRequest();
+        request.setInterfaceId(this._device.connection.interfaceId);
+        request.setDevice(this._device.deviceAddress);
+        request.setSetting(setting);
+        const response = await gateway.callAsync('device/get_setting_str', request, gateway.DeviceGetSettingStrResponse);
+        return response.getValue();
+    }
+    /**
+     * Sets any device setting as a string.
+     * 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.
+     */
+    async setString(setting, value) {
+        const request = new gateway.DeviceSetSettingStrRequest();
+        request.setInterfaceId(this._device.connection.interfaceId);
+        request.setDevice(this._device.deviceAddress);
+        request.setSetting(setting);
+        request.setValue(value);
+        await gateway.callAsync('device/set_setting_str', request);
+    }
     /**
      * Convert arbitrary setting value to Zaber native units.
      * @param setting Name of the setting.

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

@@ -1 +1 @@
-{"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"]}
+{"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;;;;;OAKG;IACI,KAAK,CAAC,SAAS,CACpB,OAAe;QAEf,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;QAE5B,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,wBAAwB,EACxB,OAAO,EACP,OAAO,CAAC,2BAA2B,CAAC,CAAC;QACvC,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,SAAS,CACpB,OAAe,EACf,KAAa;QAEb,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,0BAA0B,EAAE,CAAC;QACzD,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;QAExB,MAAM,OAAO,CAAC,SAAS,CAAC,wBAAwB,EAAE,OAAO,CAAC,CAAC;IAC7D,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;AAjJD,wCAiJC","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   * Returns any device setting or property as a string.\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   * @return Setting value.\n   */\n  public async getString(\n    setting: string\n  ): Promise<string> {\n    const request = new gateway.DeviceGetSettingRequest();\n    request.setInterfaceId(this._device.connection.interfaceId);\n    request.setDevice(this._device.deviceAddress);\n    request.setSetting(setting);\n\n    const response = await gateway.callAsync<gateway.DeviceGetSettingStrResponse>(\n      'device/get_setting_str',\n      request,\n      gateway.DeviceGetSettingStrResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Sets any device setting as a string.\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   */\n  public async setString(\n    setting: string,\n    value: string\n  ): Promise<void> {\n    const request = new gateway.DeviceSetSettingStrRequest();\n    request.setInterfaceId(this._device.connection.interfaceId);\n    request.setDevice(this._device.deviceAddress);\n    request.setSetting(setting);\n    request.setValue(value);\n\n    await gateway.callAsync('device/set_setting_str', 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"]}

package/dist/lib/ascii/setting_constants.d.ts

@@ -40,6 +40,10 @@ export declare enum SettingConstants {
      * Cloop Recovery Enable.
      */
     CLOOP_RECOVERY_ENABLE = "cloop.recovery.enable",
+    /**
+     * Cloop Servo Enable.
+     */
+    CLOOP_SERVO_ENABLE = "cloop.servo.enable",
     /**
      * Cloop Settle Period.
      */
@@ -72,6 +76,26 @@ export declare enum SettingConstants {
      * Comm Checksum.
      */
     COMM_CHECKSUM = "comm.checksum",
+    /**
+     * Comm En Ipv 4 Address.
+     */
+    COMM_EN_IPV_4_ADDRESS = "comm.en.ipv4.address",
+    /**
+     * Comm En Ipv 4 Dhcp Enabled.
+     */
+    COMM_EN_IPV_4_DHCP_ENABLED = "comm.en.ipv4.dhcp.enabled",
+    /**
+     * Comm En Ipv 4 Gateway.
+     */
+    COMM_EN_IPV_4_GATEWAY = "comm.en.ipv4.gateway",
+    /**
+     * Comm En Ipv 4 Netmask.
+     */
+    COMM_EN_IPV_4_NETMASK = "comm.en.ipv4.netmask",
+    /**
+     * Comm En Mdns Enable.
+     */
+    COMM_EN_MDNS_ENABLE = "comm.en.mdns.enable",
     /**
      * Comm Protocol.
      */
@@ -100,6 +124,10 @@ export declare enum SettingConstants {
      * Comm Usb Protocol.
      */
     COMM_USB_PROTOCOL = "comm.usb.protocol",
+    /**
+     * Device Hw Modified.
+     */
+    DEVICE_HW_MODIFIED = "device.hw.modified",
     /**
      * Deviceid.
      */
@@ -132,6 +160,154 @@ export declare enum SettingConstants {
      * Driver Temperature.
      */
     DRIVER_TEMPERATURE = "driver.temperature",
+    /**
+     * Encoder 1 Count.
+     */
+    ENCODER_1_COUNT = "encoder.1.count",
+    /**
+     * Encoder 1 Count Cal.
+     */
+    ENCODER_1_COUNT_CAL = "encoder.1.count.cal",
+    /**
+     * Encoder 1 Dir.
+     */
+    ENCODER_1_DIR = "encoder.1.dir",
+    /**
+     * Encoder 1 Fault Type.
+     */
+    ENCODER_1_FAULT_TYPE = "encoder.1.fault.type",
+    /**
+     * Encoder 1 Filter.
+     */
+    ENCODER_1_FILTER = "encoder.1.filter",
+    /**
+     * Encoder 1 Index Mode.
+     */
+    ENCODER_1_INDEX_MODE = "encoder.1.index.mode",
+    /**
+     * Encoder 1 Mode.
+     */
+    ENCODER_1_MODE = "encoder.1.mode",
+    /**
+     * Encoder 1 Pos.
+     */
+    ENCODER_1_POS = "encoder.1.pos",
+    /**
+     * Encoder 1 Pos Error.
+     */
+    ENCODER_1_POS_ERROR = "encoder.1.pos.error",
+    /**
+     * Encoder 1 Ratio Div.
+     */
+    ENCODER_1_RATIO_DIV = "encoder.1.ratio.div",
+    /**
+     * Encoder 1 Ratio Mult.
+     */
+    ENCODER_1_RATIO_MULT = "encoder.1.ratio.mult",
+    /**
+     * Encoder 1 Ref Phase.
+     */
+    ENCODER_1_REF_PHASE = "encoder.1.ref.phase",
+    /**
+     * Encoder 1 Type.
+     */
+    ENCODER_1_TYPE = "encoder.1.type",
+    /**
+     * Encoder 2 Cos.
+     */
+    ENCODER_2_COS = "encoder.2.cos",
+    /**
+     * Encoder 2 Cos Dc.
+     */
+    ENCODER_2_COS_DC = "encoder.2.cos.dc",
+    /**
+     * Encoder 2 Cos Dc Tune.
+     */
+    ENCODER_2_COS_DC_TUNE = "encoder.2.cos.dc.tune",
+    /**
+     * Encoder 2 Cos Gain.
+     */
+    ENCODER_2_COS_GAIN = "encoder.2.cos.gain",
+    /**
+     * Encoder 2 Cos Gain Tune.
+     */
+    ENCODER_2_COS_GAIN_TUNE = "encoder.2.cos.gain.tune",
+    /**
+     * Encoder 2 Count.
+     */
+    ENCODER_2_COUNT = "encoder.2.count",
+    /**
+     * Encoder 2 Count Cal.
+     */
+    ENCODER_2_COUNT_CAL = "encoder.2.count.cal",
+    /**
+     * Encoder 2 Dir.
+     */
+    ENCODER_2_DIR = "encoder.2.dir",
+    /**
+     * Encoder 2 Fault Type.
+     */
+    ENCODER_2_FAULT_TYPE = "encoder.2.fault.type",
+    /**
+     * Encoder 2 Filter.
+     */
+    ENCODER_2_FILTER = "encoder.2.filter",
+    /**
+     * Encoder 2 Index Mode.
+     */
+    ENCODER_2_INDEX_MODE = "encoder.2.index.mode",
+    /**
+     * Encoder 2 Interpolation.
+     */
+    ENCODER_2_INTERPOLATION = "encoder.2.interpolation",
+    /**
+     * Encoder 2 Mode.
+     */
+    ENCODER_2_MODE = "encoder.2.mode",
+    /**
+     * Encoder 2 Pos.
+     */
+    ENCODER_2_POS = "encoder.2.pos",
+    /**
+     * Encoder 2 Pos Error.
+     */
+    ENCODER_2_POS_ERROR = "encoder.2.pos.error",
+    /**
+     * Encoder 2 Ratio Div.
+     */
+    ENCODER_2_RATIO_DIV = "encoder.2.ratio.div",
+    /**
+     * Encoder 2 Ratio Mult.
+     */
+    ENCODER_2_RATIO_MULT = "encoder.2.ratio.mult",
+    /**
+     * Encoder 2 Signal Min.
+     */
+    ENCODER_2_SIGNAL_MIN = "encoder.2.signal.min",
+    /**
+     * Encoder 2 Sin.
+     */
+    ENCODER_2_SIN = "encoder.2.sin",
+    /**
+     * Encoder 2 Sin Dc.
+     */
+    ENCODER_2_SIN_DC = "encoder.2.sin.dc",
+    /**
+     * Encoder 2 Sin Dc Tune.
+     */
+    ENCODER_2_SIN_DC_TUNE = "encoder.2.sin.dc.tune",
+    /**
+     * Encoder 2 Sin Gain.
+     */
+    ENCODER_2_SIN_GAIN = "encoder.2.sin.gain",
+    /**
+     * Encoder 2 Sin Gain Tune.
+     */
+    ENCODER_2_SIN_GAIN_TUNE = "encoder.2.sin.gain.tune",
+    /**
+     * Encoder 2 Type.
+     */
+    ENCODER_2_TYPE = "encoder.2.type",
     /**
      * Encoder Count.
      */
@@ -176,6 +352,10 @@ export declare enum SettingConstants {
      * Encoder Mode.
      */
     ENCODER_MODE = "encoder.mode",
+    /**
+     * Encoder Port Default.
+     */
+    ENCODER_PORT_DEFAULT = "encoder.port.default",
     /**
      * Encoder Pos.
      */
@@ -184,6 +364,14 @@ export declare enum SettingConstants {
      * Encoder Pos Error.
      */
     ENCODER_POS_ERROR = "encoder.pos.error",
+    /**
+     * Encoder Ratio Div.
+     */
+    ENCODER_RATIO_DIV = "encoder.ratio.div",
+    /**
+     * Encoder Ratio Mult.
+     */
+    ENCODER_RATIO_MULT = "encoder.ratio.mult",
     /**
      * Filter Holderid.
      */
@@ -192,6 +380,14 @@ export declare enum SettingConstants {
      * Force Average.
      */
     FORCE_AVERAGE = "force.average",
+    /**
+     * Io Di Port.
+     */
+    IO_DI_PORT = "io.di.port",
+    /**
+     * Io Do Port.
+     */
+    IO_DO_PORT = "io.do.port",
     /**
      * Joy Debug.
      */
@@ -288,6 +484,10 @@ export declare enum SettingConstants {
      * Limit Away Preset.
      */
     LIMIT_AWAY_PRESET = "limit.away.preset",
+    /**
+     * Limit Away Source.
+     */
+    LIMIT_AWAY_SOURCE = "limit.away.source",
     /**
      * Limit Away State.
      */
@@ -296,10 +496,18 @@ export declare enum SettingConstants {
      * Limit Away Triggered.
      */
     LIMIT_AWAY_TRIGGERED = "limit.away.triggered",
+    /**
+     * Limit Away Tune.
+     */
+    LIMIT_AWAY_TUNE = "limit.away.tune",
     /**
      * Limit Away Type.
      */
     LIMIT_AWAY_TYPE = "limit.away.type",
+    /**
+     * Limit Away Width.
+     */
+    LIMIT_AWAY_WIDTH = "limit.away.width",
     /**
      * Limit C Action.
      */
@@ -320,6 +528,10 @@ export declare enum SettingConstants {
      * Limit C Preset.
      */
     LIMIT_C_PRESET = "limit.c.preset",
+    /**
+     * Limit C Source.
+     */
+    LIMIT_C_SOURCE = "limit.c.source",
     /**
      * Limit C State.
      */
@@ -328,10 +540,18 @@ export declare enum SettingConstants {
      * Limit C Triggered.
      */
     LIMIT_C_TRIGGERED = "limit.c.triggered",
+    /**
+     * Limit C Tune.
+     */
+    LIMIT_C_TUNE = "limit.c.tune",
     /**
      * Limit C Type.
      */
     LIMIT_C_TYPE = "limit.c.type",
+    /**
+     * Limit C Width.
+     */
+    LIMIT_C_WIDTH = "limit.c.width",
     /**
      * Limit Cycle Dist.
      */
@@ -380,6 +600,10 @@ export declare enum SettingConstants {
      * Limit Home Action.
      */
     LIMIT_HOME_ACTION = "limit.home.action",
+    /**
+     * Limit Home Bidirectional.
+     */
+    LIMIT_HOME_BIDIRECTIONAL = "limit.home.bidirectional",
     /**
      * Limit Home Edge.
      */
@@ -396,6 +620,10 @@ export declare enum SettingConstants {
      * Limit Home Preset.
      */
     LIMIT_HOME_PRESET = "limit.home.preset",
+    /**
+     * Limit Home Source.
+     */
+    LIMIT_HOME_SOURCE = "limit.home.source",
     /**
      * Limit Home State.
      */
@@ -404,10 +632,18 @@ export declare enum SettingConstants {
      * Limit Home Triggered.
      */
     LIMIT_HOME_TRIGGERED = "limit.home.triggered",
+    /**
+     * Limit Home Tune.
+     */
+    LIMIT_HOME_TUNE = "limit.home.tune",
     /**
      * Limit Home Type.
      */
     LIMIT_HOME_TYPE = "limit.home.type",
+    /**
+     * Limit Home Width.
+     */
+    LIMIT_HOME_WIDTH = "limit.home.width",
     /**
      * Limit Max.
      */
@@ -416,6 +652,18 @@ export declare enum SettingConstants {
      * Limit Min.
      */
     LIMIT_MIN = "limit.min",
+    /**
+     * Limit Range Mode.
+     */
+    LIMIT_RANGE_MODE = "limit.range.mode",
+    /**
+     * Limit Ref Phase.
+     */
+    LIMIT_REF_PHASE = "limit.ref.phase",
+    /**
+     * Limit Ref Phase Measured.
+     */
+    LIMIT_REF_PHASE_MEASURED = "limit.ref.phase.measured",
     /**
      * Limit Start Pos.
      */
@@ -436,6 +684,10 @@ export declare enum SettingConstants {
      * Maxspeed.
      */
     MAXSPEED = "maxspeed",
+    /**
+     * Motion Accel Ramptime.
+     */
+    MOTION_ACCEL_RAMPTIME = "motion.accel.ramptime",
     /**
      * Motion Accelonly.
      */
@@ -460,10 +712,38 @@ export declare enum SettingConstants {
      * Motor Current Max.
      */
     MOTOR_CURRENT_MAX = "motor.current.max",
+    /**
+     * Motor Inductance.
+     */
+    MOTOR_INDUCTANCE = "motor.inductance",
+    /**
+     * Motor Phase.
+     */
+    MOTOR_PHASE = "motor.phase",
+    /**
+     * Motor Phase Ratio Div 1.
+     */
+    MOTOR_PHASE_RATIO_DIV_1 = "motor.phase.ratio.div1",
+    /**
+     * Motor Phase Ratio Div 2.
+     */
+    MOTOR_PHASE_RATIO_DIV_2 = "motor.phase.ratio.div2",
+    /**
+     * Motor Phase Ratio Mult.
+     */
+    MOTOR_PHASE_RATIO_MULT = "motor.phase.ratio.mult",
+    /**
+     * Motor Resistance.
+     */
+    MOTOR_RESISTANCE = "motor.resistance",
     /**
      * Parking State.
      */
     PARKING_STATE = "parking.state",
+    /**
+     * Peripheral Hw Modified.
+     */
+    PERIPHERAL_HW_MODIFIED = "peripheral.hw.modified",
     /**
      * Peripheral ID (Firmware 7 and higher).
      */
@@ -544,6 +824,86 @@ export declare enum SettingConstants {
      * Trigger Numtriggers.
      */
     TRIGGER_NUMTRIGGERS = "trigger.numtriggers",
+    /**
+     * User Data 0.
+     */
+    USER_DATA_0 = "user.data.0",
+    /**
+     * User Data 1.
+     */
+    USER_DATA_1 = "user.data.1",
+    /**
+     * User Data 10.
+     */
+    USER_DATA_10 = "user.data.10",
+    /**
+     * User Data 11.
+     */
+    USER_DATA_11 = "user.data.11",
+    /**
+     * User Data 12.
+     */
+    USER_DATA_12 = "user.data.12",
+    /**
+     * User Data 13.
+     */
+    USER_DATA_13 = "user.data.13",
+    /**
+     * User Data 14.
+     */
+    USER_DATA_14 = "user.data.14",
+    /**
+     * User Data 15.
+     */
+    USER_DATA_15 = "user.data.15",
+    /**
+     * User Data 2.
+     */
+    USER_DATA_2 = "user.data.2",
+    /**
+     * User Data 3.
+     */
+    USER_DATA_3 = "user.data.3",
+    /**
+     * User Data 4.
+     */
+    USER_DATA_4 = "user.data.4",
+    /**
+     * User Data 5.
+     */
+    USER_DATA_5 = "user.data.5",
+    /**
+     * User Data 6.
+     */
+    USER_DATA_6 = "user.data.6",
+    /**
+     * User Data 7.
+     */
+    USER_DATA_7 = "user.data.7",
+    /**
+     * User Data 8.
+     */
+    USER_DATA_8 = "user.data.8",
+    /**
+     * User Data 9.
+     */
+    USER_DATA_9 = "user.data.9",
+    /**
+     * User Vdata 0.
+     */
+    USER_VDATA_0 = "user.vdata.0",
+    /**
+     * User Vdata 1.
+     */
+    USER_VDATA_1 = "user.vdata.1",
+    /**
+     * User Vdata 2.
+     */
+    USER_VDATA_2 = "user.vdata.2",
+    /**
+     * User Vdata 3.
+     */
+    USER_VDATA_3 = "user.vdata.3",
     /**
      * Vel.
      */