@zaber/motion 2.8.1-alpha-2 → 2.10.0

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

@@ -7,6 +7,7 @@ import { DeviceIdentity } from './device_identity';
 import { DeviceIO } from './device_io';
 import { Response } from './response';
 import { Lockstep } from './lockstep';
+import { Oscilloscope } from './oscilloscope';
 import { Stream } from './stream';
 import { StreamBuffer } from './stream_buffer';
 import { Measurement } from '../measurement';
@@ -55,6 +56,11 @@ export declare class Device {
      * Indicates whether or not the device has been identified.
      */
     get isIdentified(): boolean;
+    /**
+     * Oscilloscope recording helper for this device.
+     */
+    get oscilloscope(): Oscilloscope;
+    private _oscilloscope;
     /**
      * Unique ID of the device hardware.
      */
@@ -75,6 +81,10 @@ export declare class Device {
      * Version of the firmware.
      */
     get firmwareVersion(): FirmwareVersion;
+    /**
+     * The device is an integrated product.
+     */
+    get isIntegrated(): boolean;
     constructor(connection: Connection, deviceAddress: number);
     /**
      * Queries the device and the database, gathering information about the product.

package/dist/lib/ascii/device.js

@@ -30,6 +30,7 @@ const device_identity_1 = require("./device_identity");
 const device_io_1 = require("./device_io");
 const response_1 = require("./response");
 const lockstep_1 = require("./lockstep");
+const oscilloscope_1 = require("./oscilloscope");
 const stream_1 = require("./stream");
 const stream_buffer_1 = require("./stream_buffer");
 const measurement_1 = require("../measurement");
@@ -46,6 +47,7 @@ class Device {
         this._io = new device_io_1.DeviceIO(this);
         this._allAxes = new all_axes_1.AllAxes(this);
         this._warnings = new warnings_1.Warnings(this, 0);
+        this._oscilloscope = new oscilloscope_1.Oscilloscope(this);
     }
     /**
      * Connection of this device.
@@ -96,6 +98,12 @@ class Device {
     get isIdentified() {
         return this._retrieveIsIdentified();
     }
+    /**
+     * Oscilloscope recording helper for this device.
+     */
+    get oscilloscope() {
+        return this._oscilloscope;
+    }
     /**
      * Unique ID of the device hardware.
      */
@@ -126,6 +134,12 @@ class Device {
     get firmwareVersion() {
         return this.identity.firmwareVersion;
     }
+    /**
+     * The device is an integrated product.
+     */
+    get isIntegrated() {
+        return this.identity.isIntegrated;
+    }
     /**
      * Queries the device and the database, gathering information about the product.
      * Without this information features such as unit conversions will not work.

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,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"]}
+{"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,iDAA8C;AAC9C,qCAAkC;AAClC,mDAA+C;AAC/C,gDAA6C;AAE7C,oFAA6E;AAC7E,oDAAsC;AAEtC;;GAEG;AACH,MAAa,MAAM;IAkHjB,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;QACvC,IAAI,CAAC,aAAa,GAAG,IAAI,2BAAY,CAAC,IAAI,CAAC,CAAC;IAC9C,CAAC;IAzHD;;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,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAGD;;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;IAED;;OAEG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;IACpC,CAAC;IAYD;;;;;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;AA1ZD,wBA0ZC","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 { Oscilloscope } from './oscilloscope';\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   * Oscilloscope recording helper for this device.\n   */\n  public get oscilloscope(): Oscilloscope {\n    return this._oscilloscope;\n  }\n  private _oscilloscope: Oscilloscope;\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  /**\n   * The device is an integrated product.\n   */\n  public get isIntegrated(): boolean {\n    return this.identity.isIntegrated;\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    this._oscilloscope = new Oscilloscope(this);\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_identity.d.ts

@@ -27,6 +27,10 @@ export interface DeviceIdentity {
      * The device has hardware modifications.
      */
     isModified: boolean;
+    /**
+     * The device is an integrated product.
+     */
+    isIntegrated: boolean;
 }
 export declare namespace DeviceIdentity {
     const __type = "DeviceIdentity";

package/dist/lib/ascii/device_identity.js

@@ -16,6 +16,7 @@ var DeviceIdentity;
             axisCount: pbData.axisCount,
             firmwareVersion: firmware_version_1.FirmwareVersion.fromProtobuf(pbData.firmwareVersion),
             isModified: pbData.isModified,
+            isIntegrated: pbData.isIntegrated,
         };
     }
     DeviceIdentity.fromProtobuf = fromProtobuf;

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

@@ -1 +1 @@
-{"version":3,"file":"device_identity.js","sourceRoot":"","sources":["../../../src/ascii/device_identity.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;AAGtD,0DAAsD;AAsCtD,IAAiB,cAAc,CAc9B;AAdD,WAAiB,cAAc;IAChB,qBAAM,GAAG,gBAAgB,CAAC;IAEvC,gBAAgB;IAChB,SAAgB,YAAY,CAAC,MAAuC;QAClE,OAAO;YACL,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,eAAe,EAAE,kCAAe,CAAC,YAAY,CAAC,MAAM,CAAC,eAAgB,CAAC;YACtE,UAAU,EAAE,MAAM,CAAC,UAAU;SAC9B,CAAC;IACJ,CAAC;IATe,2BAAY,eAS3B,CAAA;AACH,CAAC,EAdgB,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAc9B","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport * as gateway from '../gateway';\nimport { FirmwareVersion } from '../firmware_version';\n\n/**\n * Representation of data gathered during device identification.\n */\nexport interface DeviceIdentity {\n  /**\n   * Unique ID of the device hardware.\n   */\n  deviceId: number;\n\n  /**\n   * Serial number of the device.\n   */\n  serialNumber: number;\n\n  /**\n   * Name of the product.\n   */\n  name: string;\n\n  /**\n   * Number of axes this device has.\n   */\n  axisCount: number;\n\n  /**\n   * Version of the firmware.\n   */\n  firmwareVersion: FirmwareVersion;\n\n  /**\n   * The device has hardware modifications.\n   */\n  isModified: boolean;\n\n}\n\nexport namespace DeviceIdentity {\n  export const __type = 'DeviceIdentity';\n\n  /** @internal */\n  export function fromProtobuf(pbData: gateway.DeviceIdentity.AsObject): DeviceIdentity {\n    return {\n      deviceId: pbData.deviceId,\n      serialNumber: pbData.serialNumber,\n      name: pbData.name,\n      axisCount: pbData.axisCount,\n      firmwareVersion: FirmwareVersion.fromProtobuf(pbData.firmwareVersion!),\n      isModified: pbData.isModified,\n    };\n  }\n}\n"]}
+{"version":3,"file":"device_identity.js","sourceRoot":"","sources":["../../../src/ascii/device_identity.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;AAGtD,0DAAsD;AA2CtD,IAAiB,cAAc,CAe9B;AAfD,WAAiB,cAAc;IAChB,qBAAM,GAAG,gBAAgB,CAAC;IAEvC,gBAAgB;IAChB,SAAgB,YAAY,CAAC,MAAuC;QAClE,OAAO;YACL,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,eAAe,EAAE,kCAAe,CAAC,YAAY,CAAC,MAAM,CAAC,eAAgB,CAAC;YACtE,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,YAAY,EAAE,MAAM,CAAC,YAAY;SAClC,CAAC;IACJ,CAAC;IAVe,2BAAY,eAU3B,CAAA;AACH,CAAC,EAfgB,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAe9B","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport * as gateway from '../gateway';\nimport { FirmwareVersion } from '../firmware_version';\n\n/**\n * Representation of data gathered during device identification.\n */\nexport interface DeviceIdentity {\n  /**\n   * Unique ID of the device hardware.\n   */\n  deviceId: number;\n\n  /**\n   * Serial number of the device.\n   */\n  serialNumber: number;\n\n  /**\n   * Name of the product.\n   */\n  name: string;\n\n  /**\n   * Number of axes this device has.\n   */\n  axisCount: number;\n\n  /**\n   * Version of the firmware.\n   */\n  firmwareVersion: FirmwareVersion;\n\n  /**\n   * The device has hardware modifications.\n   */\n  isModified: boolean;\n\n  /**\n   * The device is an integrated product.\n   */\n  isIntegrated: boolean;\n\n}\n\nexport namespace DeviceIdentity {\n  export const __type = 'DeviceIdentity';\n\n  /** @internal */\n  export function fromProtobuf(pbData: gateway.DeviceIdentity.AsObject): DeviceIdentity {\n    return {\n      deviceId: pbData.deviceId,\n      serialNumber: pbData.serialNumber,\n      name: pbData.name,\n      axisCount: pbData.axisCount,\n      firmwareVersion: FirmwareVersion.fromProtobuf(pbData.firmwareVersion!),\n      isModified: pbData.isModified,\n      isIntegrated: pbData.isIntegrated,\n    };\n  }\n}\n"]}

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

@@ -18,6 +18,9 @@ export { WarningFlags } from './warning_flags';
 export { Warnings } from './warnings';
 export { Lockstep } from './lockstep';
 export { LockstepAxes } from './lockstep_axes';
+export { Oscilloscope } from './oscilloscope';
+export { OscilloscopeData } from './oscilloscope_data';
+export { OscilloscopeCaptureProperties } from './oscilloscope_capture_properties';
 export { Stream } from './stream';
 export { StreamBuffer } from './stream_buffer';
 export { StreamMode } from './stream_mode';

package/dist/lib/ascii/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Transport = exports.StreamAxisDefinition = exports.StreamAxisType = exports.StreamMode = exports.StreamBuffer = exports.Stream = exports.LockstepAxes = exports.Lockstep = exports.Warnings = exports.WarningFlags = exports.UnknownResponseEvent = exports.SettingConstants = exports.Response = exports.MessageType = exports.DeviceIOInfo = exports.DeviceIO = exports.Device = exports.DeviceSettings = exports.DeviceIdentity = exports.Connection = exports.Axis = exports.AxisType = exports.AxisSettings = exports.AxisIdentity = exports.AllAxes = exports.AlertEvent = void 0;
+exports.Transport = exports.StreamAxisDefinition = exports.StreamAxisType = exports.StreamMode = exports.StreamBuffer = exports.Stream = exports.OscilloscopeCaptureProperties = exports.OscilloscopeData = exports.Oscilloscope = exports.LockstepAxes = exports.Lockstep = exports.Warnings = exports.WarningFlags = exports.UnknownResponseEvent = exports.SettingConstants = exports.Response = exports.MessageType = exports.DeviceIOInfo = exports.DeviceIO = exports.Device = exports.DeviceSettings = exports.DeviceIdentity = exports.Connection = exports.Axis = exports.AxisType = exports.AxisSettings = exports.AxisIdentity = exports.AllAxes = exports.AlertEvent = void 0;
 var alert_event_1 = require("./alert_event");
 Object.defineProperty(exports, "AlertEvent", { enumerable: true, get: function () { return alert_event_1.AlertEvent; } });
 var all_axes_1 = require("./all_axes");
@@ -41,6 +41,12 @@ var lockstep_1 = require("./lockstep");
 Object.defineProperty(exports, "Lockstep", { enumerable: true, get: function () { return lockstep_1.Lockstep; } });
 var lockstep_axes_1 = require("./lockstep_axes");
 Object.defineProperty(exports, "LockstepAxes", { enumerable: true, get: function () { return lockstep_axes_1.LockstepAxes; } });
+var oscilloscope_1 = require("./oscilloscope");
+Object.defineProperty(exports, "Oscilloscope", { enumerable: true, get: function () { return oscilloscope_1.Oscilloscope; } });
+var oscilloscope_data_1 = require("./oscilloscope_data");
+Object.defineProperty(exports, "OscilloscopeData", { enumerable: true, get: function () { return oscilloscope_data_1.OscilloscopeData; } });
+var oscilloscope_capture_properties_1 = require("./oscilloscope_capture_properties");
+Object.defineProperty(exports, "OscilloscopeCaptureProperties", { enumerable: true, get: function () { return oscilloscope_capture_properties_1.OscilloscopeCaptureProperties; } });
 var stream_1 = require("./stream");
 Object.defineProperty(exports, "Stream", { enumerable: true, get: function () { return stream_1.Stream; } });
 var stream_buffer_1 = require("./stream_buffer");

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/ascii/index.ts"],"names":[],"mappings":";;;AAAA,6CAA2C;AAAlC,yGAAA,UAAU,OAAA;AACnB,uCAAqC;AAA5B,mGAAA,OAAO,OAAA;AAChB,iDAA+C;AAAtC,6GAAA,YAAY,OAAA;AACrB,iDAA+C;AAAtC,6GAAA,YAAY,OAAA;AACrB,yCAAuC;AAA9B,qGAAA,QAAQ,OAAA;AACjB,+BAA8B;AAArB,4FAAA,IAAI,OAAA;AACb,2CAA0C;AAAjC,wGAAA,UAAU,OAAA;AACnB,qDAAmD;AAA1C,iHAAA,cAAc,OAAA;AACvB,qDAAmD;AAA1C,iHAAA,cAAc,OAAA;AACvB,mCAAkC;AAAzB,gGAAA,MAAM,OAAA;AACf,yCAAuC;AAA9B,qGAAA,QAAQ,OAAA;AACjB,mDAAgD;AAAvC,8GAAA,YAAY,OAAA;AACrB,+CAA6C;AAApC,2GAAA,WAAW,OAAA;AACpB,uCAAsC;AAA7B,oGAAA,QAAQ,OAAA;AACjB,yDAAuD;AAA9C,qHAAA,gBAAgB,OAAA;AACzB,mEAAgE;AAAvD,8HAAA,oBAAoB,OAAA;AAC7B,iDAA+C;AAAtC,6GAAA,YAAY,OAAA;AACrB,uCAAsC;AAA7B,oGAAA,QAAQ,OAAA;AACjB,uCAAsC;AAA7B,oGAAA,QAAQ,OAAA;AACjB,iDAA+C;AAAtC,6GAAA,YAAY,OAAA;AACrB,mCAAkC;AAAzB,gGAAA,MAAM,OAAA;AACf,iDAA+C;AAAtC,6GAAA,YAAY,OAAA;AACrB,6CAA2C;AAAlC,yGAAA,UAAU,OAAA;AACnB,uDAAoD;AAA3C,kHAAA,cAAc,OAAA;AACvB,mEAAgE;AAAvD,8HAAA,oBAAoB,OAAA;AAC7B,yCAAwC;AAA/B,sGAAA,SAAS,OAAA","sourcesContent":["export { AlertEvent } from './alert_event';\nexport { AllAxes } from './all_axes';\nexport { AxisIdentity } from './axis_identity';\nexport { AxisSettings } from './axis_settings';\nexport { AxisType } from './axis_type';\nexport { Axis } from './axis';\nexport { Connection } from './connection';\nexport { DeviceIdentity } from './device_identity';\nexport { DeviceSettings } from './device_settings';\nexport { Device } from './device';\nexport { DeviceIO } from './device_io';\nexport { DeviceIOInfo } from './device_io_info';\nexport { MessageType } from './message_type';\nexport { Response } from './response';\nexport { SettingConstants } from './setting_constants';\nexport { UnknownResponseEvent } from './unknown_response_event';\nexport { WarningFlags } from './warning_flags';\nexport { Warnings } from './warnings';\nexport { Lockstep } from './lockstep';\nexport { LockstepAxes } from './lockstep_axes';\nexport { Stream } from './stream';\nexport { StreamBuffer } from './stream_buffer';\nexport { StreamMode } from './stream_mode';\nexport { StreamAxisType } from './stream_axis_type';\nexport { StreamAxisDefinition } from './stream_axis_definition';\nexport { Transport } from './transport';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/ascii/index.ts"],"names":[],"mappings":";;;AAAA,6CAA2C;AAAlC,yGAAA,UAAU,OAAA;AACnB,uCAAqC;AAA5B,mGAAA,OAAO,OAAA;AAChB,iDAA+C;AAAtC,6GAAA,YAAY,OAAA;AACrB,iDAA+C;AAAtC,6GAAA,YAAY,OAAA;AACrB,yCAAuC;AAA9B,qGAAA,QAAQ,OAAA;AACjB,+BAA8B;AAArB,4FAAA,IAAI,OAAA;AACb,2CAA0C;AAAjC,wGAAA,UAAU,OAAA;AACnB,qDAAmD;AAA1C,iHAAA,cAAc,OAAA;AACvB,qDAAmD;AAA1C,iHAAA,cAAc,OAAA;AACvB,mCAAkC;AAAzB,gGAAA,MAAM,OAAA;AACf,yCAAuC;AAA9B,qGAAA,QAAQ,OAAA;AACjB,mDAAgD;AAAvC,8GAAA,YAAY,OAAA;AACrB,+CAA6C;AAApC,2GAAA,WAAW,OAAA;AACpB,uCAAsC;AAA7B,oGAAA,QAAQ,OAAA;AACjB,yDAAuD;AAA9C,qHAAA,gBAAgB,OAAA;AACzB,mEAAgE;AAAvD,8HAAA,oBAAoB,OAAA;AAC7B,iDAA+C;AAAtC,6GAAA,YAAY,OAAA;AACrB,uCAAsC;AAA7B,oGAAA,QAAQ,OAAA;AACjB,uCAAsC;AAA7B,oGAAA,QAAQ,OAAA;AACjB,iDAA+C;AAAtC,6GAAA,YAAY,OAAA;AACrB,+CAA8C;AAArC,4GAAA,YAAY,OAAA;AACrB,yDAAuD;AAA9C,qHAAA,gBAAgB,OAAA;AACzB,qFAAkF;AAAzE,gJAAA,6BAA6B,OAAA;AACtC,mCAAkC;AAAzB,gGAAA,MAAM,OAAA;AACf,iDAA+C;AAAtC,6GAAA,YAAY,OAAA;AACrB,6CAA2C;AAAlC,yGAAA,UAAU,OAAA;AACnB,uDAAoD;AAA3C,kHAAA,cAAc,OAAA;AACvB,mEAAgE;AAAvD,8HAAA,oBAAoB,OAAA;AAC7B,yCAAwC;AAA/B,sGAAA,SAAS,OAAA","sourcesContent":["export { AlertEvent } from './alert_event';\nexport { AllAxes } from './all_axes';\nexport { AxisIdentity } from './axis_identity';\nexport { AxisSettings } from './axis_settings';\nexport { AxisType } from './axis_type';\nexport { Axis } from './axis';\nexport { Connection } from './connection';\nexport { DeviceIdentity } from './device_identity';\nexport { DeviceSettings } from './device_settings';\nexport { Device } from './device';\nexport { DeviceIO } from './device_io';\nexport { DeviceIOInfo } from './device_io_info';\nexport { MessageType } from './message_type';\nexport { Response } from './response';\nexport { SettingConstants } from './setting_constants';\nexport { UnknownResponseEvent } from './unknown_response_event';\nexport { WarningFlags } from './warning_flags';\nexport { Warnings } from './warnings';\nexport { Lockstep } from './lockstep';\nexport { LockstepAxes } from './lockstep_axes';\nexport { Oscilloscope } from './oscilloscope';\nexport { OscilloscopeData } from './oscilloscope_data';\nexport { OscilloscopeCaptureProperties } from './oscilloscope_capture_properties';\nexport { Stream } from './stream';\nexport { StreamBuffer } from './stream_buffer';\nexport { StreamMode } from './stream_mode';\nexport { StreamAxisType } from './stream_axis_type';\nexport { StreamAxisDefinition } from './stream_axis_definition';\nexport { Transport } from './transport';\n"]}

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

@@ -0,0 +1,62 @@
+import { Device } from './device';
+import { OscilloscopeData } from './oscilloscope_data';
+import { Native, Time } from '../units';
+/**
+ * Provides a convenient way to control the oscilloscope data recording feature of some devices.
+ * The oscilloscope can record the values of some settings over time at high resolution.
+ */
+export declare class Oscilloscope {
+    /**
+     * Device that this Oscilloscope measures.
+     */
+    get device(): Device;
+    private _device;
+    constructor(device: Device);
+    /**
+     * Select a setting to be recorded.
+     * @param axis The 1-based index of the axis to record the value from.
+     * @param setting The name of a setting to record.
+     */
+    addChannel(axis: number, setting: string): Promise<void>;
+    /**
+     * Clear the list of channels to record.
+     */
+    clear(): Promise<void>;
+    /**
+     * Get the current sampling interval.
+     * @param unit Unit of measure to represent the timebase in.
+     * @return The current sampling interval in the selected time units.
+     */
+    getTimebase(unit?: Time | Native): Promise<number>;
+    /**
+     * Set the sampling interval.
+     * @param interval Sample interval for the next oscilloscope recording. Minimum value is 100µs.
+     * @param unit Unit of measure the timebase is represented in.
+     */
+    setTimebase(interval: number, unit?: Time | Native): Promise<void>;
+    /**
+     * Get the delay before oscilloscope recording starts.
+     * @param unit Unit of measure to represent the delay in.
+     * @return The current start delay in the selected time units.
+     */
+    getDelay(unit?: Time | Native): Promise<number>;
+    /**
+     * Set the sampling start delay.
+     * @param interval Delay time between triggering a recording and the first data point being recorded.
+     * @param unit Unit of measure the delay is represented in.
+     */
+    setDelay(interval: number, unit?: Time | Native): Promise<void>;
+    /**
+     * Trigger data recording.
+     */
+    start(): Promise<void>;
+    /**
+     * End data recording if currently in progress.
+     */
+    stop(): Promise<void>;
+    /**
+     * Reads the last-recorded data from the oscilloscope. Will block until any in-progress recording completes.
+     * @return Array of recorded channel data arrays, in the order added.
+     */
+    read(): Promise<OscilloscopeData[]>;
+}

package/dist/lib/ascii/oscilloscope.js

@@ -0,0 +1,153 @@
+"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.Oscilloscope = void 0;
+const oscilloscope_data_1 = require("./oscilloscope_data");
+const units_1 = require("../units");
+const gateway = __importStar(require("../gateway"));
+/**
+ * Provides a convenient way to control the oscilloscope data recording feature of some devices.
+ * The oscilloscope can record the values of some settings over time at high resolution.
+ */
+class Oscilloscope {
+    constructor(device) {
+        this._device = device;
+    }
+    /**
+     * Device that this Oscilloscope measures.
+     */
+    get device() {
+        return this._device;
+    }
+    /**
+     * Select a setting to be recorded.
+     * @param axis The 1-based index of the axis to record the value from.
+     * @param setting The name of a setting to record.
+     */
+    async addChannel(axis, setting) {
+        const request = new gateway.OscilloscopeAddChannelRequest();
+        request.setInterfaceId(this.device.connection.interfaceId);
+        request.setDevice(this.device.deviceAddress);
+        request.setAxis(axis);
+        request.setSetting(setting);
+        await gateway.callAsync('oscilloscope/add_channel', request);
+    }
+    /**
+     * Clear the list of channels to record.
+     */
+    async clear() {
+        const request = new gateway.OscilloscopeClearChannelsRequest();
+        request.setInterfaceId(this.device.connection.interfaceId);
+        request.setDevice(this.device.deviceAddress);
+        await gateway.callAsync('oscilloscope/clear_channels', request);
+    }
+    /**
+     * Get the current sampling interval.
+     * @param unit Unit of measure to represent the timebase in.
+     * @return The current sampling interval in the selected time units.
+     */
+    async getTimebase(unit = units_1.Units.NATIVE) {
+        const request = new gateway.DeviceGetSettingRequest();
+        request.setInterfaceId(this.device.connection.interfaceId);
+        request.setDevice(this.device.deviceAddress);
+        request.setSetting('scope.timebase');
+        request.setUnit(unit);
+        const response = await gateway.callAsync('device/get_setting', request, gateway.DeviceGetSettingResponse);
+        return response.getValue();
+    }
+    /**
+     * Set the sampling interval.
+     * @param interval Sample interval for the next oscilloscope recording. Minimum value is 100µs.
+     * @param unit Unit of measure the timebase is represented in.
+     */
+    async setTimebase(interval, unit = units_1.Units.NATIVE) {
+        const request = new gateway.DeviceSetSettingRequest();
+        request.setInterfaceId(this.device.connection.interfaceId);
+        request.setDevice(this.device.deviceAddress);
+        request.setSetting('scope.timebase');
+        request.setValue(interval);
+        request.setUnit(unit);
+        await gateway.callAsync('device/set_setting', request);
+    }
+    /**
+     * Get the delay before oscilloscope recording starts.
+     * @param unit Unit of measure to represent the delay in.
+     * @return The current start delay in the selected time units.
+     */
+    async getDelay(unit = units_1.Units.NATIVE) {
+        const request = new gateway.DeviceGetSettingRequest();
+        request.setInterfaceId(this.device.connection.interfaceId);
+        request.setDevice(this.device.deviceAddress);
+        request.setSetting('scope.delay');
+        request.setUnit(unit);
+        const response = await gateway.callAsync('device/get_setting', request, gateway.DeviceGetSettingResponse);
+        return response.getValue();
+    }
+    /**
+     * Set the sampling start delay.
+     * @param interval Delay time between triggering a recording and the first data point being recorded.
+     * @param unit Unit of measure the delay is represented in.
+     */
+    async setDelay(interval, unit = units_1.Units.NATIVE) {
+        const request = new gateway.DeviceSetSettingRequest();
+        request.setInterfaceId(this.device.connection.interfaceId);
+        request.setDevice(this.device.deviceAddress);
+        request.setSetting('scope.delay');
+        request.setValue(interval);
+        request.setUnit(unit);
+        await gateway.callAsync('device/set_setting', request);
+    }
+    /**
+     * Trigger data recording.
+     */
+    async start() {
+        const request = new gateway.OscilloscopeStartStopRequest();
+        request.setInterfaceId(this.device.connection.interfaceId);
+        request.setDevice(this.device.deviceAddress);
+        request.setStart(true);
+        await gateway.callAsync('oscilloscope/start_or_stop', request);
+    }
+    /**
+     * End data recording if currently in progress.
+     */
+    async stop() {
+        const request = new gateway.OscilloscopeStartStopRequest();
+        request.setInterfaceId(this.device.connection.interfaceId);
+        request.setDevice(this.device.deviceAddress);
+        request.setStart(false);
+        await gateway.callAsync('oscilloscope/start_or_stop', request);
+    }
+    /**
+     * Reads the last-recorded data from the oscilloscope. Will block until any in-progress recording completes.
+     * @return Array of recorded channel data arrays, in the order added.
+     */
+    async read() {
+        const request = new gateway.OscilloscopeReadRequest();
+        request.setInterfaceId(this.device.connection.interfaceId);
+        request.setDevice(this.device.deviceAddress);
+        const response = await gateway.callAsync('oscilloscope/read', request, gateway.OscilloscopeReadResponse);
+        return response.getDataIdsList().map(id => new oscilloscope_data_1.OscilloscopeData(this.device, id));
+    }
+}
+exports.Oscilloscope = Oscilloscope;
+//# sourceMappingURL=oscilloscope.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"oscilloscope.js","sourceRoot":"","sources":["../../../src/ascii/oscilloscope.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;AAGtD,2DAAuD;AACvD,oCAA+C;AAC/C,oDAAsC;AAEtC;;;GAGG;AACH,MAAa,YAAY;IASvB,YAAY,MAAc;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAVD;;OAEG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAOD;;;;OAIG;IACI,KAAK,CAAC,UAAU,CACrB,IAAY,EACZ,OAAe;QAEf,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,6BAA6B,EAAE,CAAC;QAC5D,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC7C,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACtB,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAE5B,MAAM,OAAO,CAAC,SAAS,CAAC,0BAA0B,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,KAAK;QAChB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,gCAAgC,EAAE,CAAC;QAC/D,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAE7C,MAAM,OAAO,CAAC,SAAS,CAAC,6BAA6B,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,WAAW,CACtB,OAAsB,aAAK,CAAC,MAAM;QAElC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC7C,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;QACrC,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;;;;OAIG;IACI,KAAK,CAAC,WAAW,CACtB,QAAgB,EAChB,OAAsB,aAAK,CAAC,MAAM;QAElC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC7C,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;QACrC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC3B,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,MAAM,OAAO,CAAC,SAAS,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,QAAQ,CACnB,OAAsB,aAAK,CAAC,MAAM;QAElC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC7C,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;QAClC,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;;;;OAIG;IACI,KAAK,CAAC,QAAQ,CACnB,QAAgB,EAChB,OAAsB,aAAK,CAAC,MAAM;QAElC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC7C,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;QAClC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC3B,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,MAAM,OAAO,CAAC,SAAS,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,KAAK;QAChB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,4BAA4B,EAAE,CAAC;QAC3D,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC7C,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAEvB,MAAM,OAAO,CAAC,SAAS,CAAC,4BAA4B,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,IAAI;QACf,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,4BAA4B,EAAE,CAAC;QAC3D,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC7C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAExB,MAAM,OAAO,CAAC,SAAS,CAAC,4BAA4B,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,IAAI;QACf,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAE7C,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,mBAAmB,EACnB,OAAO,EACP,OAAO,CAAC,wBAAwB,CAAC,CAAC;QACpC,OAAO,QAAQ,CAAC,cAAc,EAAG,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,oCAAgB,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC;IACrF,CAAC;CACF;AAjKD,oCAiKC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport { Device } from './device';\nimport { OscilloscopeData } from './oscilloscope_data';\nimport { Native, Time, Units } from '../units';\nimport * as gateway from '../gateway';\n\n/**\n * Provides a convenient way to control the oscilloscope data recording feature of some devices.\n * The oscilloscope can record the values of some settings over time at high resolution.\n */\nexport class Oscilloscope {\n  /**\n   * Device that this Oscilloscope measures.\n   */\n  public get device(): Device {\n    return this._device;\n  }\n  private _device: Device;\n\n  constructor(device: Device) {\n    this._device = device;\n  }\n\n  /**\n   * Select a setting to be recorded.\n   * @param axis The 1-based index of the axis to record the value from.\n   * @param setting The name of a setting to record.\n   */\n  public async addChannel(\n    axis: number,\n    setting: string\n  ): Promise<void> {\n    const request = new gateway.OscilloscopeAddChannelRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setAxis(axis);\n    request.setSetting(setting);\n\n    await gateway.callAsync('oscilloscope/add_channel', request);\n  }\n\n  /**\n   * Clear the list of channels to record.\n   */\n  public async clear(): Promise<void> {\n    const request = new gateway.OscilloscopeClearChannelsRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n\n    await gateway.callAsync('oscilloscope/clear_channels', request);\n  }\n\n  /**\n   * Get the current sampling interval.\n   * @param unit Unit of measure to represent the timebase in.\n   * @return The current sampling interval in the selected time units.\n   */\n  public async getTimebase(\n    unit: Time | Native = 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('scope.timebase');\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   * Set the sampling interval.\n   * @param interval Sample interval for the next oscilloscope recording. Minimum value is 100µs.\n   * @param unit Unit of measure the timebase is represented in.\n   */\n  public async setTimebase(\n    interval: number,\n    unit: Time | Native = 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('scope.timebase');\n    request.setValue(interval);\n    request.setUnit(unit);\n\n    await gateway.callAsync('device/set_setting', request);\n  }\n\n  /**\n   * Get the delay before oscilloscope recording starts.\n   * @param unit Unit of measure to represent the delay in.\n   * @return The current start delay in the selected time units.\n   */\n  public async getDelay(\n    unit: Time | Native = 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('scope.delay');\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   * Set the sampling start delay.\n   * @param interval Delay time between triggering a recording and the first data point being recorded.\n   * @param unit Unit of measure the delay is represented in.\n   */\n  public async setDelay(\n    interval: number,\n    unit: Time | Native = 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('scope.delay');\n    request.setValue(interval);\n    request.setUnit(unit);\n\n    await gateway.callAsync('device/set_setting', request);\n  }\n\n  /**\n   * Trigger data recording.\n   */\n  public async start(): Promise<void> {\n    const request = new gateway.OscilloscopeStartStopRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setStart(true);\n\n    await gateway.callAsync('oscilloscope/start_or_stop', request);\n  }\n\n  /**\n   * End data recording if currently in progress.\n   */\n  public async stop(): Promise<void> {\n    const request = new gateway.OscilloscopeStartStopRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setStart(false);\n\n    await gateway.callAsync('oscilloscope/start_or_stop', request);\n  }\n\n  /**\n   * Reads the last-recorded data from the oscilloscope. Will block until any in-progress recording completes.\n   * @return Array of recorded channel data arrays, in the order added.\n   */\n  public async read(): Promise<OscilloscopeData[]> {\n    const request = new gateway.OscilloscopeReadRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n\n    const response = await gateway.callAsync<gateway.OscilloscopeReadResponse>(\n      'oscilloscope/read',\n      request,\n      gateway.OscilloscopeReadResponse);\n    return response.getDataIdsList()!.map(id => new OscilloscopeData(this.device, id));\n  }\n}\n"]}

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

@@ -0,0 +1,16 @@
+/**
+ * The public properties of one channel of recorded oscilloscope data.
+ */
+export interface OscilloscopeCaptureProperties {
+    /**
+     * The name of the recorded setting.
+     */
+    setting: string;
+    /**
+     * The number of the axis the data was recorded from, or 0 for the controller.
+     */
+    axisNumber: number;
+}
+export declare namespace OscilloscopeCaptureProperties {
+    const __type = "OscilloscopeCaptureProperties";
+}

package/dist/lib/ascii/oscilloscope_capture_properties.js

@@ -0,0 +1,18 @@
+"use strict";
+// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //
+// ============= DO NOT EDIT DIRECTLY ============= //
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OscilloscopeCaptureProperties = void 0;
+var OscilloscopeCaptureProperties;
+(function (OscilloscopeCaptureProperties) {
+    OscilloscopeCaptureProperties.__type = 'OscilloscopeCaptureProperties';
+    /** @internal */
+    function fromProtobuf(pbData) {
+        return {
+            setting: pbData.setting,
+            axisNumber: pbData.axisNumber,
+        };
+    }
+    OscilloscopeCaptureProperties.fromProtobuf = fromProtobuf;
+})(OscilloscopeCaptureProperties = exports.OscilloscopeCaptureProperties || (exports.OscilloscopeCaptureProperties = {}));
+//# sourceMappingURL=oscilloscope_capture_properties.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"oscilloscope_capture_properties.js","sourceRoot":"","sources":["../../../src/ascii/oscilloscope_capture_properties.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;AAoBtD,IAAiB,6BAA6B,CAU7C;AAVD,WAAiB,6BAA6B;IAC/B,oCAAM,GAAG,+BAA+B,CAAC;IAEtD,gBAAgB;IAChB,SAAgB,YAAY,CAAC,MAAsD;QACjF,OAAO;YACL,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,UAAU,EAAE,MAAM,CAAC,UAAU;SAC9B,CAAC;IACJ,CAAC;IALe,0CAAY,eAK3B,CAAA;AACH,CAAC,EAVgB,6BAA6B,GAA7B,qCAA6B,KAA7B,qCAA6B,QAU7C","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport * as gateway from '../gateway';\n\n/**\n * The public properties of one channel of recorded oscilloscope data.\n */\nexport interface OscilloscopeCaptureProperties {\n  /**\n   * The name of the recorded setting.\n   */\n  setting: string;\n\n  /**\n   * The number of the axis the data was recorded from, or 0 for the controller.\n   */\n  axisNumber: number;\n\n}\n\nexport namespace OscilloscopeCaptureProperties {\n  export const __type = 'OscilloscopeCaptureProperties';\n\n  /** @internal */\n  export function fromProtobuf(pbData: gateway.OscilloscopeCaptureProperties.AsObject): OscilloscopeCaptureProperties {\n    return {\n      setting: pbData.setting,\n      axisNumber: pbData.axisNumber,\n    };\n  }\n}\n"]}

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

@@ -0,0 +1,67 @@
+import { Device } from './device';
+import { Native, Time, Units } from '../units';
+/**
+ * Contains a block of contiguous recorded data for one channel of the device's oscilloscope.
+ */
+export declare class OscilloscopeData {
+    /**
+     * Device that this Oscilloscope measures.
+     */
+    get device(): Device;
+    private _device;
+    /**
+     * Unique ID for this block of recorded data.
+     */
+    get dataId(): number;
+    private _dataId;
+    /**
+     * The name of the recorded setting.
+     */
+    get setting(): string;
+    /**
+     * The number of the axis the data was recorded from, or 0 for the controller.
+     */
+    get axisNumber(): number;
+    constructor(device: Device, dataId: number);
+    /**
+     * Get the sample interval that this data was recorded with.
+     * @param unit Unit of measure to represent the timebase in.
+     * @return The timebase setting at the time the data was recorded.
+     */
+    getTimebase(unit?: Time | Native): number;
+    /**
+     * Get the sample interval that this data was recorded with.
+     * @param unit Unit of measure to represent the delay in.
+     * @return The delay setting at the time the data was recorded.
+     */
+    getDelay(unit?: Time | Native): number;
+    /**
+     * Calculate the time a sample was recorded, relative to when the recording was triggered.
+     * @param index 0-based index of the sample to calculate the time of.
+     * @param unit Unit of measure to represent the calculated time in.
+     * @return The calculated time offset of the data sample at the given index.
+     */
+    getSampleTime(index: number, unit?: Time | Native): number;
+    /**
+     * Get the recorded data as an array of doubles.
+     * @param unit Unit of measure to convert the data to.
+     * @return The recorded data for one oscilloscope channel, converted to the units specified.
+     */
+    getData(unit?: Units): number[];
+    /**
+     * Releases native resources of an oscilloscope data buffer.
+     * @param dataId The ID of the data buffer to delete.
+     */
+    private static _free;
+    /**
+     * Returns recording properties.
+     * @return Capture properties.
+     */
+    private _retrieveProperties;
+    /**
+     * Releases the native resources of the oscilloscope data.
+     * Should only be called if your environment does not support FinalizationRegistry.
+     * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/FinalizationRegistry
+     */
+    free(): void;
+}