@zaber/motion 2.15.4 → 3.0.0

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

@@ -4,6 +4,7 @@ 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.
+ * Requires at least Firmware 7.00.
  */
 export declare class Oscilloscope {
     /**
@@ -24,57 +25,57 @@ export declare class Oscilloscope {
     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.
+     * @param [unit=Units.NATIVE] Unit of measure to represent the timebase in.
+     * @returns 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.
+     * @param [unit=Units.NATIVE] 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.
+     * @param [unit=Units.NATIVE] Unit of measure to represent the delay in.
+     * @returns 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.
+     * @param [unit=Units.NATIVE] Unit of measure the delay is represented in.
      */
     setDelay(interval: number, unit?: Time | Native): Promise<void>;
     /**
      * Get the maximum number of channels that can be recorded.
-     * @return The maximum number of channels that can be added to an Oscilloscope recording.
+     * @returns The maximum number of channels that can be added to an Oscilloscope recording.
      */
     getMaxChannels(): Promise<number>;
     /**
      * Get the maximum number of samples that can be recorded per Oscilloscope channel.
-     * @return The maximum number of samples that can be recorded per Oscilloscope channel.
+     * @returns The maximum number of samples that can be recorded per Oscilloscope channel.
      */
     getMaxBufferSize(): Promise<number>;
     /**
      * Get the number of samples that can be recorded per channel given the current number of channels added.
-     * @return Number of samples that will be recorded per channel with the current channels. Zero if none have been added.
+     * @returns Number of samples that will be recorded per channel with the current channels. Zero if none have been added.
      */
     getBufferSize(): Promise<number>;
     /**
      * Trigger data recording.
-     * @param captureLength Optional number of samples to record per channel.
+     * @param [captureLength=0] Optional number of samples to record per channel.
      * If left empty, the device records samples until the buffer fills.
-     * Requires Firmware 7.29 or higher.
+     * Requires at least Firmware 7.29.
      */
     start(captureLength?: number): Promise<void>;
     /**
-     * End data recording if currentlyin progress.
+     * 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.
+     * @returns Array of recorded channel data arrays, in the order added.
      */
     read(): Promise<OscilloscopeData[]>;
 }

package/dist/lib/ascii/oscilloscope.js

@@ -32,6 +32,7 @@ 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.
+ * Requires at least Firmware 7.00.
  */
 class Oscilloscope {
     /**
@@ -67,8 +68,8 @@ class Oscilloscope {
     }
     /**
      * 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.
+     * @param [unit=Units.NATIVE] Unit of measure to represent the timebase in.
+     * @returns The current sampling interval in the selected time units.
      */
     async getTimebase(unit = units_1.Units.NATIVE) {
         const request = new gateway.DeviceGetSettingRequest();
@@ -82,7 +83,7 @@ class Oscilloscope {
     /**
      * 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.
+     * @param [unit=Units.NATIVE] Unit of measure the timebase is represented in.
      */
     async setTimebase(interval, unit = units_1.Units.NATIVE) {
         const request = new gateway.DeviceSetSettingRequest();
@@ -95,8 +96,8 @@ class Oscilloscope {
     }
     /**
      * 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.
+     * @param [unit=Units.NATIVE] Unit of measure to represent the delay in.
+     * @returns The current start delay in the selected time units.
      */
     async getDelay(unit = units_1.Units.NATIVE) {
         const request = new gateway.DeviceGetSettingRequest();
@@ -110,7 +111,7 @@ class Oscilloscope {
     /**
      * 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.
+     * @param [unit=Units.NATIVE] Unit of measure the delay is represented in.
      */
     async setDelay(interval, unit = units_1.Units.NATIVE) {
         const request = new gateway.DeviceSetSettingRequest();
@@ -123,7 +124,7 @@ class Oscilloscope {
     }
     /**
      * Get the maximum number of channels that can be recorded.
-     * @return The maximum number of channels that can be added to an Oscilloscope recording.
+     * @returns The maximum number of channels that can be added to an Oscilloscope recording.
      */
     async getMaxChannels() {
         const request = new gateway.DeviceGetSettingRequest();
@@ -135,7 +136,7 @@ class Oscilloscope {
     }
     /**
      * Get the maximum number of samples that can be recorded per Oscilloscope channel.
-     * @return The maximum number of samples that can be recorded per Oscilloscope channel.
+     * @returns The maximum number of samples that can be recorded per Oscilloscope channel.
      */
     async getMaxBufferSize() {
         const request = new gateway.DeviceGetSettingRequest();
@@ -147,7 +148,7 @@ class Oscilloscope {
     }
     /**
      * Get the number of samples that can be recorded per channel given the current number of channels added.
-     * @return Number of samples that will be recorded per channel with the current channels. Zero if none have been added.
+     * @returns Number of samples that will be recorded per channel with the current channels. Zero if none have been added.
      */
     async getBufferSize() {
         const request = new gateway.DeviceGetSettingRequest();
@@ -159,9 +160,9 @@ class Oscilloscope {
     }
     /**
      * Trigger data recording.
-     * @param captureLength Optional number of samples to record per channel.
+     * @param [captureLength=0] Optional number of samples to record per channel.
      * If left empty, the device records samples until the buffer fills.
-     * Requires Firmware 7.29 or higher.
+     * Requires at least Firmware 7.29.
      */
     async start(captureLength = 0) {
         const request = new gateway.OscilloscopeStartStopRequest();
@@ -172,7 +173,7 @@ class Oscilloscope {
         await gateway.callAsync('oscilloscope/start_or_stop', request);
     }
     /**
-     * End data recording if currentlyin progress.
+     * End data recording if currently in progress.
      */
     async stop() {
         const request = new gateway.OscilloscopeStartStopRequest();
@@ -183,7 +184,7 @@ class Oscilloscope {
     }
     /**
      * 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.
+     * @returns Array of recorded channel data arrays, in the order added.
      */
     async read() {
         const request = new gateway.DeviceEmptyRequest();

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

@@ -1 +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;IACvB;;OAEG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAGD,YAAY,MAAc;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED;;;;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,kBAAkB,EAAE,CAAC;QACjD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAE7C,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,cAAc,CAAC,CAAC;QAC1B,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,cAAc,CAAC,CAAC;QAC1B,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;;;OAGG;IACI,KAAK,CAAC,cAAc;QACzB,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,mBAAmB,CAAC,CAAC;QAExC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,0BAA0B,EAC1B,OAAO,EACP,OAAO,CAAC,WAAW,CAAC,CAAC;QACvB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,gBAAgB;QAC3B,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,wBAAwB,CAAC,CAAC;QAE7C,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,0BAA0B,EAC1B,OAAO,EACP,OAAO,CAAC,WAAW,CAAC,CAAC;QACvB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,aAAa;QACxB,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,oBAAoB,CAAC,CAAC;QAEzC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,0BAA0B,EAC1B,OAAO,EACP,OAAO,CAAC,WAAW,CAAC,CAAC;QACvB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,KAAK,CAChB,gBAAwB,CAAC;QAEzB,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;QACvB,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAExC,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,kBAAkB,EAAE,CAAC;QACjD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAE7C,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,EAAE,CAAC,CAAC,CAAC;IACxE,CAAC;CACF;AA1ND,oCA0NC","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.DeviceEmptyRequest();\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.DoubleResponse>(\n      'device/get_setting',\n      request,\n      gateway.DoubleResponse);\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.DoubleResponse>(\n      'device/get_setting',\n      request,\n      gateway.DoubleResponse);\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   * Get the maximum number of channels that can be recorded.\n   * @return The maximum number of channels that can be added to an Oscilloscope recording.\n   */\n  public async getMaxChannels(): 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.numchannels');\n\n    const response = await gateway.callAsync<gateway.IntResponse>(\n      'oscilloscope/get_setting',\n      request,\n      gateway.IntResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Get the maximum number of samples that can be recorded per Oscilloscope channel.\n   * @return The maximum number of samples that can be recorded per Oscilloscope channel.\n   */\n  public async getMaxBufferSize(): 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.channel.size.max');\n\n    const response = await gateway.callAsync<gateway.IntResponse>(\n      'oscilloscope/get_setting',\n      request,\n      gateway.IntResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Get the number of samples that can be recorded per channel given the current number of channels added.\n   * @return Number of samples that will be recorded per channel with the current channels. Zero if none have been added.\n   */\n  public async getBufferSize(): 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.channel.size');\n\n    const response = await gateway.callAsync<gateway.IntResponse>(\n      'oscilloscope/get_setting',\n      request,\n      gateway.IntResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Trigger data recording.\n   * @param captureLength Optional number of samples to record per channel.\n   * If left empty, the device records samples until the buffer fills.\n   * Requires Firmware 7.29 or higher.\n   */\n  public async start(\n    captureLength: number = 0\n  ): 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    request.setCaptureLength(captureLength);\n\n    await gateway.callAsync('oscilloscope/start_or_stop', request);\n  }\n\n  /**\n   * End data recording if currentlyin 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.DeviceEmptyRequest();\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(id));\n  }\n}\n"]}
+{"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;;;;GAIG;AACH,MAAa,YAAY;IACvB;;OAEG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAGD,YAAY,MAAc;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED;;;;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,kBAAkB,EAAE,CAAC;QACjD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAE7C,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,cAAc,CAAC,CAAC;QAC1B,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,cAAc,CAAC,CAAC;QAC1B,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;;;OAGG;IACI,KAAK,CAAC,cAAc;QACzB,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,mBAAmB,CAAC,CAAC;QAExC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,0BAA0B,EAC1B,OAAO,EACP,OAAO,CAAC,WAAW,CAAC,CAAC;QACvB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,gBAAgB;QAC3B,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,wBAAwB,CAAC,CAAC;QAE7C,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,0BAA0B,EAC1B,OAAO,EACP,OAAO,CAAC,WAAW,CAAC,CAAC;QACvB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,aAAa;QACxB,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,oBAAoB,CAAC,CAAC;QAEzC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,0BAA0B,EAC1B,OAAO,EACP,OAAO,CAAC,WAAW,CAAC,CAAC;QACvB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,KAAK,CAChB,gBAAwB,CAAC;QAEzB,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;QACvB,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAExC,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,kBAAkB,EAAE,CAAC;QACjD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAE7C,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,EAAE,CAAC,CAAC,CAAC;IACxE,CAAC;CACF;AA1ND,oCA0NC","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 * Requires at least Firmware 7.00.\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.DeviceEmptyRequest();\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=Units.NATIVE] Unit of measure to represent the timebase in.\n   * @returns 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.DoubleResponse>(\n      'device/get_setting',\n      request,\n      gateway.DoubleResponse);\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=Units.NATIVE] 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=Units.NATIVE] Unit of measure to represent the delay in.\n   * @returns 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.DoubleResponse>(\n      'device/get_setting',\n      request,\n      gateway.DoubleResponse);\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=Units.NATIVE] 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   * Get the maximum number of channels that can be recorded.\n   * @returns The maximum number of channels that can be added to an Oscilloscope recording.\n   */\n  public async getMaxChannels(): 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.numchannels');\n\n    const response = await gateway.callAsync<gateway.IntResponse>(\n      'oscilloscope/get_setting',\n      request,\n      gateway.IntResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Get the maximum number of samples that can be recorded per Oscilloscope channel.\n   * @returns The maximum number of samples that can be recorded per Oscilloscope channel.\n   */\n  public async getMaxBufferSize(): 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.channel.size.max');\n\n    const response = await gateway.callAsync<gateway.IntResponse>(\n      'oscilloscope/get_setting',\n      request,\n      gateway.IntResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Get the number of samples that can be recorded per channel given the current number of channels added.\n   * @returns Number of samples that will be recorded per channel with the current channels. Zero if none have been added.\n   */\n  public async getBufferSize(): 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.channel.size');\n\n    const response = await gateway.callAsync<gateway.IntResponse>(\n      'oscilloscope/get_setting',\n      request,\n      gateway.IntResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Trigger data recording.\n   * @param [captureLength=0] Optional number of samples to record per channel.\n   * If left empty, the device records samples until the buffer fills.\n   * Requires at least Firmware 7.29.\n   */\n  public async start(\n    captureLength: number = 0\n  ): 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    request.setCaptureLength(captureLength);\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   * @returns Array of recorded channel data arrays, in the order added.\n   */\n  public async read(): Promise<OscilloscopeData[]> {\n    const request = new gateway.DeviceEmptyRequest();\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(id));\n  }\n}\n"]}

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

@@ -19,28 +19,28 @@ export declare class OscilloscopeData {
     constructor(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.
+     * @param [unit=Units.NATIVE] Unit of measure to represent the timebase in.
+     * @returns The timebase setting at the time the data was recorded.
      */
     getTimebase(unit?: Time | Native): number;
     /**
      * Get the user-specified time period between receipt of the start command and the first data point.
      * Under some circumstances, the actual delay may be different - call GetSampleTime(0) to get the effective delay.
-     * @param unit Unit of measure to represent the delay in.
-     * @return The delay setting at the time the data was recorded.
+     * @param [unit=Units.NATIVE] Unit of measure to represent the delay in.
+     * @returns 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.
+     * @param [unit=Units.NATIVE] Unit of measure to represent the calculated time in.
+     * @returns 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.
+     * @param [unit=Units.NATIVE] Unit of measure to convert the data to.
+     * @returns The recorded data for one oscilloscope channel, converted to the units specified.
      */
     getData(unit?: Units): number[];
     /**
@@ -50,7 +50,7 @@ export declare class OscilloscopeData {
     private static _free;
     /**
      * Returns recording properties.
-     * @return Capture properties.
+     * @returns Capture properties.
      */
     private _retrieveProperties;
     /**

package/dist/lib/ascii/oscilloscope_data.js

@@ -58,8 +58,8 @@ class OscilloscopeData {
     }
     /**
      * 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.
+     * @param [unit=Units.NATIVE] Unit of measure to represent the timebase in.
+     * @returns The timebase setting at the time the data was recorded.
      */
     getTimebase(unit = units_1.Units.NATIVE) {
         const request = new gateway.OscilloscopeDataGetRequest();
@@ -71,8 +71,8 @@ class OscilloscopeData {
     /**
      * Get the user-specified time period between receipt of the start command and the first data point.
      * Under some circumstances, the actual delay may be different - call GetSampleTime(0) to get the effective delay.
-     * @param unit Unit of measure to represent the delay in.
-     * @return The delay setting at the time the data was recorded.
+     * @param [unit=Units.NATIVE] Unit of measure to represent the delay in.
+     * @returns The delay setting at the time the data was recorded.
      */
     getDelay(unit = units_1.Units.NATIVE) {
         const request = new gateway.OscilloscopeDataGetRequest();
@@ -84,8 +84,8 @@ class OscilloscopeData {
     /**
      * 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.
+     * @param [unit=Units.NATIVE] Unit of measure to represent the calculated time in.
+     * @returns The calculated time offset of the data sample at the given index.
      */
     getSampleTime(index, unit = units_1.Units.NATIVE) {
         const request = new gateway.OscilloscopeDataGetSampleTimeRequest();
@@ -97,8 +97,8 @@ class OscilloscopeData {
     }
     /**
      * 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.
+     * @param [unit=Units.NATIVE] Unit of measure to convert the data to.
+     * @returns The recorded data for one oscilloscope channel, converted to the units specified.
      */
     getData(unit = units_1.Units.NATIVE) {
         const request = new gateway.OscilloscopeDataGetRequest();
@@ -118,7 +118,7 @@ class OscilloscopeData {
     }
     /**
      * Returns recording properties.
-     * @return Capture properties.
+     * @returns Capture properties.
      */
     _retrieveProperties() {
         const request = new gateway.OscilloscopeDataIdentifier();

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

@@ -1 +1 @@
-{"version":3,"file":"oscilloscope_data.js","sourceRoot":"","sources":["../../../src/ascii/oscilloscope_data.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtD,oCAA+C;AAC/C,oDAAsC;AACtC,4CAAuD;AAEvD,uFAAkF;AAElF;;GAEG;AACH,MAAa,gBAAgB;IAC3B;;OAEG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAGD;;OAEG;IACH,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,mBAAmB,EAAE,CAAC,OAAO,CAAC;IAC5C,CAAC;IAED;;OAEG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,mBAAmB,EAAE,CAAC,UAAU,CAAC;IAC/C,CAAC;IAED,YAAY,MAAc;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAA,mCAAuB,EAAC,IAAI,EAAE,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;IAC3E,CAAC;IAED;;;;OAIG;IACI,WAAW,CAChB,OAAsB,aAAK,CAAC,MAAM;QAElC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,0BAA0B,EAAE,CAAC;QACzD,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC/B,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,+BAA+B,EAC/B,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACI,QAAQ,CACb,OAAsB,aAAK,CAAC,MAAM;QAElC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,0BAA0B,EAAE,CAAC;QACzD,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC/B,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,4BAA4B,EAC5B,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACI,aAAa,CAClB,KAAa,EACb,OAAsB,aAAK,CAAC,MAAM;QAElC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,oCAAoC,EAAE,CAAC;QACnE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC/B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,kCAAkC,EAClC,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,OAAO,CACZ,OAAc,aAAK,CAAC,MAAM;QAE1B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,0BAA0B,EAAE,CAAC;QACzD,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC/B,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,8BAA8B,EAC9B,OAAO,EACP,OAAO,CAAC,kCAAkC,CAAC,CAAC;QAC9C,OAAO,QAAQ,CAAC,WAAW,EAAE,CAAC;IAChC,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,KAAK,CAClB,MAAc;QAEd,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,0BAA0B,EAAE,CAAC;QACzD,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAE1B,OAAO,CAAC,QAAQ,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACK,mBAAmB;QACzB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,0BAA0B,EAAE,CAAC;QACzD,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAE/B,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,iCAAiC,EACjC,OAAO,EACP,OAAO,CAAC,6BAA6B,CAAC,CAAC;QACzC,OAAO,+DAA6B,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;OAIG;IACI,IAAI;QACT,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACtC,CAAC;CACF;AAhJD,4CAgJC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport { Native, Time, Units } from '../units';\nimport * as gateway from '../gateway';\nimport { registerForFinalization } from '../finalizer';\n\nimport { OscilloscopeCaptureProperties } from './oscilloscope_capture_properties';\n\n/**\n * Contains a block of contiguous recorded data for one channel of the device's oscilloscope.\n */\nexport class OscilloscopeData {\n  /**\n   * Unique ID for this block of recorded data.\n   */\n  public get dataId(): number {\n    return this._dataId;\n  }\n  private _dataId: number;\n\n  /**\n   * The name of the recorded setting.\n   */\n  public get setting(): string {\n    return this._retrieveProperties().setting;\n  }\n\n  /**\n   * The number of the axis the data was recorded from, or 0 for the controller.\n   */\n  public get axisNumber(): number {\n    return this._retrieveProperties().axisNumber;\n  }\n\n  constructor(dataId: number) {\n    this._dataId = dataId;\n    registerForFinalization(this, OscilloscopeData._free.bind(null, dataId));\n  }\n\n  /**\n   * Get the sample interval that this data was recorded with.\n   * @param unit Unit of measure to represent the timebase in.\n   * @return The timebase setting at the time the data was recorded.\n   */\n  public getTimebase(\n    unit: Time | Native = Units.NATIVE\n  ): number {\n    const request = new gateway.OscilloscopeDataGetRequest();\n    request.setDataId(this.dataId);\n    request.setUnit(unit);\n\n    const response = gateway.callSync<gateway.DoubleResponse>(\n      'oscilloscopedata/get_timebase',\n      request,\n      gateway.DoubleResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Get the user-specified time period between receipt of the start command and the first data point.\n   * Under some circumstances, the actual delay may be different - call GetSampleTime(0) to get the effective delay.\n   * @param unit Unit of measure to represent the delay in.\n   * @return The delay setting at the time the data was recorded.\n   */\n  public getDelay(\n    unit: Time | Native = Units.NATIVE\n  ): number {\n    const request = new gateway.OscilloscopeDataGetRequest();\n    request.setDataId(this.dataId);\n    request.setUnit(unit);\n\n    const response = gateway.callSync<gateway.DoubleResponse>(\n      'oscilloscopedata/get_delay',\n      request,\n      gateway.DoubleResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Calculate the time a sample was recorded, relative to when the recording was triggered.\n   * @param index 0-based index of the sample to calculate the time of.\n   * @param unit Unit of measure to represent the calculated time in.\n   * @return The calculated time offset of the data sample at the given index.\n   */\n  public getSampleTime(\n    index: number,\n    unit: Time | Native = Units.NATIVE\n  ): number {\n    const request = new gateway.OscilloscopeDataGetSampleTimeRequest();\n    request.setDataId(this.dataId);\n    request.setIndex(index);\n    request.setUnit(unit);\n\n    const response = gateway.callSync<gateway.DoubleResponse>(\n      'oscilloscopedata/get_sample_time',\n      request,\n      gateway.DoubleResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Get the recorded data as an array of doubles.\n   * @param unit Unit of measure to convert the data to.\n   * @return The recorded data for one oscilloscope channel, converted to the units specified.\n   */\n  public getData(\n    unit: Units = Units.NATIVE\n  ): number[] {\n    const request = new gateway.OscilloscopeDataGetRequest();\n    request.setDataId(this.dataId);\n    request.setUnit(unit);\n\n    const response = gateway.callSync<gateway.OscilloscopeDataGetSamplesResponse>(\n      'oscilloscopedata/get_samples',\n      request,\n      gateway.OscilloscopeDataGetSamplesResponse);\n    return response.getDataList();\n  }\n\n  /**\n   * Releases native resources of an oscilloscope data buffer.\n   * @param dataId The ID of the data buffer to delete.\n   */\n  private static _free(\n    dataId: number\n  ): void {\n    const request = new gateway.OscilloscopeDataIdentifier();\n    request.setDataId(dataId);\n\n    gateway.callSync('oscilloscopedata/free', request);\n  }\n\n  /**\n   * Returns recording properties.\n   * @return Capture properties.\n   */\n  private _retrieveProperties(): OscilloscopeCaptureProperties {\n    const request = new gateway.OscilloscopeDataIdentifier();\n    request.setDataId(this.dataId);\n\n    const response = gateway.callSync<gateway.OscilloscopeCaptureProperties>(\n      'oscilloscopedata/get_properties',\n      request,\n      gateway.OscilloscopeCaptureProperties);\n    return OscilloscopeCaptureProperties.fromProtobuf(response.toObject());\n  }\n\n  /**\n   * Releases the native resources of the oscilloscope data.\n   * Should only be called if your environment does not support FinalizationRegistry.\n   * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/FinalizationRegistry\n   */\n  public free(): void {\n    OscilloscopeData._free(this.dataId);\n  }\n}\n"]}
+{"version":3,"file":"oscilloscope_data.js","sourceRoot":"","sources":["../../../src/ascii/oscilloscope_data.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtD,oCAA+C;AAC/C,oDAAsC;AACtC,4CAAuD;AAEvD,uFAAkF;AAElF;;GAEG;AACH,MAAa,gBAAgB;IAC3B;;OAEG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAGD;;OAEG;IACH,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,mBAAmB,EAAE,CAAC,OAAO,CAAC;IAC5C,CAAC;IAED;;OAEG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,mBAAmB,EAAE,CAAC,UAAU,CAAC;IAC/C,CAAC;IAED,YAAY,MAAc;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAA,mCAAuB,EAAC,IAAI,EAAE,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;IAC3E,CAAC;IAED;;;;OAIG;IACI,WAAW,CAChB,OAAsB,aAAK,CAAC,MAAM;QAElC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,0BAA0B,EAAE,CAAC;QACzD,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC/B,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,+BAA+B,EAC/B,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACI,QAAQ,CACb,OAAsB,aAAK,CAAC,MAAM;QAElC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,0BAA0B,EAAE,CAAC;QACzD,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC/B,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,4BAA4B,EAC5B,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACI,aAAa,CAClB,KAAa,EACb,OAAsB,aAAK,CAAC,MAAM;QAElC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,oCAAoC,EAAE,CAAC;QACnE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC/B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,kCAAkC,EAClC,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,OAAO,CACZ,OAAc,aAAK,CAAC,MAAM;QAE1B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,0BAA0B,EAAE,CAAC;QACzD,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC/B,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,8BAA8B,EAC9B,OAAO,EACP,OAAO,CAAC,kCAAkC,CAAC,CAAC;QAC9C,OAAO,QAAQ,CAAC,WAAW,EAAE,CAAC;IAChC,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,KAAK,CAClB,MAAc;QAEd,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,0BAA0B,EAAE,CAAC;QACzD,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAE1B,OAAO,CAAC,QAAQ,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACK,mBAAmB;QACzB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,0BAA0B,EAAE,CAAC;QACzD,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAE/B,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,iCAAiC,EACjC,OAAO,EACP,OAAO,CAAC,6BAA6B,CAAC,CAAC;QACzC,OAAO,+DAA6B,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;OAIG;IACI,IAAI;QACT,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACtC,CAAC;CACF;AAhJD,4CAgJC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport { Native, Time, Units } from '../units';\nimport * as gateway from '../gateway';\nimport { registerForFinalization } from '../finalizer';\n\nimport { OscilloscopeCaptureProperties } from './oscilloscope_capture_properties';\n\n/**\n * Contains a block of contiguous recorded data for one channel of the device's oscilloscope.\n */\nexport class OscilloscopeData {\n  /**\n   * Unique ID for this block of recorded data.\n   */\n  public get dataId(): number {\n    return this._dataId;\n  }\n  private _dataId: number;\n\n  /**\n   * The name of the recorded setting.\n   */\n  public get setting(): string {\n    return this._retrieveProperties().setting;\n  }\n\n  /**\n   * The number of the axis the data was recorded from, or 0 for the controller.\n   */\n  public get axisNumber(): number {\n    return this._retrieveProperties().axisNumber;\n  }\n\n  constructor(dataId: number) {\n    this._dataId = dataId;\n    registerForFinalization(this, OscilloscopeData._free.bind(null, dataId));\n  }\n\n  /**\n   * Get the sample interval that this data was recorded with.\n   * @param [unit=Units.NATIVE] Unit of measure to represent the timebase in.\n   * @returns The timebase setting at the time the data was recorded.\n   */\n  public getTimebase(\n    unit: Time | Native = Units.NATIVE\n  ): number {\n    const request = new gateway.OscilloscopeDataGetRequest();\n    request.setDataId(this.dataId);\n    request.setUnit(unit);\n\n    const response = gateway.callSync<gateway.DoubleResponse>(\n      'oscilloscopedata/get_timebase',\n      request,\n      gateway.DoubleResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Get the user-specified time period between receipt of the start command and the first data point.\n   * Under some circumstances, the actual delay may be different - call GetSampleTime(0) to get the effective delay.\n   * @param [unit=Units.NATIVE] Unit of measure to represent the delay in.\n   * @returns The delay setting at the time the data was recorded.\n   */\n  public getDelay(\n    unit: Time | Native = Units.NATIVE\n  ): number {\n    const request = new gateway.OscilloscopeDataGetRequest();\n    request.setDataId(this.dataId);\n    request.setUnit(unit);\n\n    const response = gateway.callSync<gateway.DoubleResponse>(\n      'oscilloscopedata/get_delay',\n      request,\n      gateway.DoubleResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Calculate the time a sample was recorded, relative to when the recording was triggered.\n   * @param index 0-based index of the sample to calculate the time of.\n   * @param [unit=Units.NATIVE] Unit of measure to represent the calculated time in.\n   * @returns The calculated time offset of the data sample at the given index.\n   */\n  public getSampleTime(\n    index: number,\n    unit: Time | Native = Units.NATIVE\n  ): number {\n    const request = new gateway.OscilloscopeDataGetSampleTimeRequest();\n    request.setDataId(this.dataId);\n    request.setIndex(index);\n    request.setUnit(unit);\n\n    const response = gateway.callSync<gateway.DoubleResponse>(\n      'oscilloscopedata/get_sample_time',\n      request,\n      gateway.DoubleResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Get the recorded data as an array of doubles.\n   * @param [unit=Units.NATIVE] Unit of measure to convert the data to.\n   * @returns The recorded data for one oscilloscope channel, converted to the units specified.\n   */\n  public getData(\n    unit: Units = Units.NATIVE\n  ): number[] {\n    const request = new gateway.OscilloscopeDataGetRequest();\n    request.setDataId(this.dataId);\n    request.setUnit(unit);\n\n    const response = gateway.callSync<gateway.OscilloscopeDataGetSamplesResponse>(\n      'oscilloscopedata/get_samples',\n      request,\n      gateway.OscilloscopeDataGetSamplesResponse);\n    return response.getDataList();\n  }\n\n  /**\n   * Releases native resources of an oscilloscope data buffer.\n   * @param dataId The ID of the data buffer to delete.\n   */\n  private static _free(\n    dataId: number\n  ): void {\n    const request = new gateway.OscilloscopeDataIdentifier();\n    request.setDataId(dataId);\n\n    gateway.callSync('oscilloscopedata/free', request);\n  }\n\n  /**\n   * Returns recording properties.\n   * @returns Capture properties.\n   */\n  private _retrieveProperties(): OscilloscopeCaptureProperties {\n    const request = new gateway.OscilloscopeDataIdentifier();\n    request.setDataId(this.dataId);\n\n    const response = gateway.callSync<gateway.OscilloscopeCaptureProperties>(\n      'oscilloscopedata/get_properties',\n      request,\n      gateway.OscilloscopeCaptureProperties);\n    return OscilloscopeCaptureProperties.fromProtobuf(response.toObject());\n  }\n\n  /**\n   * Releases the native resources of the oscilloscope data.\n   * Should only be called if your environment does not support FinalizationRegistry.\n   * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/FinalizationRegistry\n   */\n  public free(): void {\n    OscilloscopeData._free(this.dataId);\n  }\n}\n"]}

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

@@ -6,6 +6,7 @@ import { PidTuning } from './pid_tuning';
 import { SimpleTuningParamDefinition } from './simple_tuning_param_definition';
 /**
  * Exposes the capabilities to inspect and edit an axis' servo tuning.
+ * Requires at least Firmware 6.25 or 7.00.
  */
 export declare class ServoTuner {
     /**
@@ -16,7 +17,7 @@ export declare class ServoTuner {
     constructor(axis: Axis);
     /**
      * Get the paramset that this device uses by default when it starts up.
-     * @return The paramset used at when the device restarts.
+     * @returns The paramset used at when the device restarts.
      */
     getStartupParamset(): Promise<ServoTuningParamset>;
     /**
@@ -33,7 +34,7 @@ export declare class ServoTuner {
     /**
      * Get the full set of tuning parameters used by the firmware driving this axis.
      * @param paramset The paramset to get tuning for.
-     * @return The raw representation of the current tuning.
+     * @returns The raw representation of the current tuning.
      */
     getTuning(paramset: ServoTuningParamset): Promise<ParamsetInfo>;
     /**
@@ -50,18 +51,18 @@ export declare class ServoTuner {
      * @param i The integral gain. Must be in units of N/m⋅s.
      * @param d The derivative gain. Must be in units of N⋅s/m.
      * @param fc The cutoff frequency. Must be in units of Hz.
-     * @return The PID representation of the current tuning after your changes have been applied.
+     * @returns The PID representation of the current tuning after your changes have been applied.
      */
     setPidTuning(paramset: ServoTuningParamset, p: number, i: number, d: number, fc: number): Promise<PidTuning>;
     /**
      * Gets the PID representation of this paramset's servo tuning.
      * @param paramset The paramset to get tuning for.
-     * @return The PID representation of the current tuning.
+     * @returns The PID representation of the current tuning.
      */
     getPidTuning(paramset: ServoTuningParamset): Promise<PidTuning>;
     /**
      * Gets the parameters that are required to tune this device.
-     * @return The tuning parameters.
+     * @returns The tuning parameters.
      */
     getSimpleTuningParamDefinitions(): Promise<SimpleTuningParamDefinition[]>;
     /**
@@ -71,9 +72,9 @@ export declare class ServoTuner {
      * To get what parameters are expected, call GetSimpleTuningParamList.
      * All values must be between 0 and 1.
      * @param loadMass The mass loaded on the stage (excluding the mass of the carriage itself) in kg.
-     * @param carriageMass The mass of the carriage in kg. If this value is not set the default carriage mass is used.
+     * @param [options.carriageMass=-1.0] The mass of the carriage in kg. If this value is not set the default carriage mass is used.
      */
-    setSimpleTuning(paramset: ServoTuningParamset, tuningParams: ServoTuningParam[], loadMass: number, carriageMass?: number): Promise<void>;
+    setSimpleTuning(paramset: ServoTuningParamset, tuningParams: ServoTuningParam[], loadMass: number, options?: ServoTuner.SetSimpleTuningOptions): Promise<void>;
     /**
      * Checks if the provided simple tuning is being stored by this paramset.
      * @param paramset The paramset to set tuning for.
@@ -81,8 +82,17 @@ export declare class ServoTuner {
      * To get what parameters are expected, call GetSimpleTuningParamList.
      * All values must be between 0 and 1.
      * @param loadMass The mass loaded on the stage (excluding the mass of the carriage itself) in kg.
-     * @param carriageMass The mass of the carriage in kg. If this value is not set the default carriage mass is used.
-     * @return True if the provided simple tuning is currently stored in this paramset.
+     * @param [options.carriageMass=-1.0] The mass of the carriage in kg. If this value is not set the default carriage mass is used.
+     * @returns True if the provided simple tuning is currently stored in this paramset.
      */
-    isUsingSimpleTuning(paramset: ServoTuningParamset, tuningParams: ServoTuningParam[], loadMass: number, carriageMass?: number): Promise<boolean>;
+    isUsingSimpleTuning(paramset: ServoTuningParamset, tuningParams: ServoTuningParam[], loadMass: number, options?: ServoTuner.IsUsingSimpleTuningOptions): Promise<boolean>;
 }
+declare namespace ServoTuner {
+    interface SetSimpleTuningOptions {
+        carriageMass?: number;
+    }
+    interface IsUsingSimpleTuningOptions {
+        carriageMass?: number;
+    }
+}
+export {};

package/dist/lib/ascii/servo_tuner.js

@@ -33,6 +33,7 @@ const pid_tuning_1 = require("./pid_tuning");
 const simple_tuning_param_definition_1 = require("./simple_tuning_param_definition");
 /**
  * Exposes the capabilities to inspect and edit an axis' servo tuning.
+ * Requires at least Firmware 6.25 or 7.00.
  */
 class ServoTuner {
     /**
@@ -46,7 +47,7 @@ class ServoTuner {
     }
     /**
      * Get the paramset that this device uses by default when it starts up.
-     * @return The paramset used at when the device restarts.
+     * @returns The paramset used at when the device restarts.
      */
     async getStartupParamset() {
         const request = new gateway.AxisEmptyRequest();
@@ -85,7 +86,7 @@ class ServoTuner {
     /**
      * Get the full set of tuning parameters used by the firmware driving this axis.
      * @param paramset The paramset to get tuning for.
-     * @return The raw representation of the current tuning.
+     * @returns The raw representation of the current tuning.
      */
     async getTuning(paramset) {
         const request = new gateway.ServoTuningRequest();
@@ -118,7 +119,7 @@ class ServoTuner {
      * @param i The integral gain. Must be in units of N/m⋅s.
      * @param d The derivative gain. Must be in units of N⋅s/m.
      * @param fc The cutoff frequency. Must be in units of Hz.
-     * @return The PID representation of the current tuning after your changes have been applied.
+     * @returns The PID representation of the current tuning after your changes have been applied.
      */
     async setPidTuning(paramset, p, i, d, fc) {
         const request = new gateway.SetServoTuningPIDRequest();
@@ -136,7 +137,7 @@ class ServoTuner {
     /**
      * Gets the PID representation of this paramset's servo tuning.
      * @param paramset The paramset to get tuning for.
-     * @return The PID representation of the current tuning.
+     * @returns The PID representation of the current tuning.
      */
     async getPidTuning(paramset) {
         const request = new gateway.ServoTuningRequest();
@@ -149,7 +150,7 @@ class ServoTuner {
     }
     /**
      * Gets the parameters that are required to tune this device.
-     * @return The tuning parameters.
+     * @returns The tuning parameters.
      */
     async getSimpleTuningParamDefinitions() {
         const request = new gateway.AxisEmptyRequest();
@@ -166,9 +167,10 @@ class ServoTuner {
      * To get what parameters are expected, call GetSimpleTuningParamList.
      * All values must be between 0 and 1.
      * @param loadMass The mass loaded on the stage (excluding the mass of the carriage itself) in kg.
-     * @param carriageMass The mass of the carriage in kg. If this value is not set the default carriage mass is used.
+     * @param [options.carriageMass=-1.0] The mass of the carriage in kg. If this value is not set the default carriage mass is used.
      */
-    async setSimpleTuning(paramset, tuningParams, loadMass, carriageMass = -1.0) {
+    async setSimpleTuning(paramset, tuningParams, loadMass, options = {}) {
+        const { carriageMass = -1.0, } = options;
         const request = new gateway.SetSimpleTuning();
         request.setInterfaceId(this.axis.device.connection.interfaceId);
         request.setDevice(this.axis.device.deviceAddress);
@@ -186,10 +188,11 @@ class ServoTuner {
      * To get what parameters are expected, call GetSimpleTuningParamList.
      * All values must be between 0 and 1.
      * @param loadMass The mass loaded on the stage (excluding the mass of the carriage itself) in kg.
-     * @param carriageMass The mass of the carriage in kg. If this value is not set the default carriage mass is used.
-     * @return True if the provided simple tuning is currently stored in this paramset.
+     * @param [options.carriageMass=-1.0] The mass of the carriage in kg. If this value is not set the default carriage mass is used.
+     * @returns True if the provided simple tuning is currently stored in this paramset.
      */
-    async isUsingSimpleTuning(paramset, tuningParams, loadMass, carriageMass = -1.0) {
+    async isUsingSimpleTuning(paramset, tuningParams, loadMass, options = {}) {
+        const { carriageMass = -1.0, } = options;
         const request = new gateway.SetSimpleTuning();
         request.setInterfaceId(this.axis.device.connection.interfaceId);
         request.setDevice(this.axis.device.deviceAddress);

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

@@ -1 +1 @@
-{"version":3,"file":"servo_tuner.js","sourceRoot":"","sources":["../../../src/ascii/servo_tuner.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;;;;;AAGtD,oDAAsC;AAEtC,mDAA+C;AAC/C,6DAAwD;AACxD,6CAAyC;AACzC,qFAA+E;AAE/E;;GAEG;AACH,MAAa,UAAU;IACrB;;OAEG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAGD,YAAY,IAAU;QACpB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,kBAAkB;QAC7B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;QAC/C,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAChE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAClD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEtC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,6BAA6B,EAC7B,OAAO,EACP,OAAO,CAAC,WAAW,CAAC,CAAC;QACvB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,kBAAkB,CAC7B,QAA6B;QAE7B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;QACjD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAChE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAClD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACtC,OAAO,CAAC,WAAW,CAAC,QAAe,CAAC,CAAC;QAErC,MAAM,OAAO,CAAC,SAAS,CAAC,6BAA6B,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,YAAY,CACvB,UAA+B,EAC/B,YAAiC;QAEjC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;QAC3C,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAChE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAClD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACtC,OAAO,CAAC,aAAa,CAAC,UAAiB,CAAC,CAAC;QACzC,OAAO,CAAC,eAAe,CAAC,YAAmB,CAAC,CAAC;QAE7C,MAAM,OAAO,CAAC,SAAS,CAAC,2BAA2B,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CACpB,QAA6B;QAE7B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;QACjD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAChE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAClD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACtC,OAAO,CAAC,WAAW,CAAC,QAAe,CAAC,CAAC;QAErC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,qBAAqB,EACrB,OAAO,EACP,OAAO,CAAC,YAAY,CAAC,CAAC;QACxB,OAAO,4BAAY,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;IACxD,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,SAAS,CACpB,QAA6B,EAC7B,YAAgC;QAEhC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC;QACpD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAChE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAClD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACtC,OAAO,CAAC,WAAW,CAAC,QAAe,CAAC,CAAC;QACrC,OAAO,CAAC,mBAAmB,CAAC,YAAY,CAAC,GAAG,CAAC,qCAAgB,CAAC,UAAU,CAAC,CAAC,CAAC;QAE3E,MAAM,OAAO,CAAC,SAAS,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,YAAY,CACvB,QAA6B,EAC7B,CAAS,EACT,CAAS,EACT,CAAS,EACT,EAAU;QAEV,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,wBAAwB,EAAE,CAAC;QACvD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAChE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAClD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACtC,OAAO,CAAC,WAAW,CAAC,QAAe,CAAC,CAAC;QACrC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAChB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAChB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAChB,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAElB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,qBAAqB,EACrB,OAAO,EACP,OAAO,CAAC,SAAS,CAAC,CAAC;QACrB,OAAO,sBAAS,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;IACrD,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,YAAY,CACvB,QAA6B;QAE7B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;QACjD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAChE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAClD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACtC,OAAO,CAAC,WAAW,CAAC,QAAe,CAAC,CAAC;QAErC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,qBAAqB,EACrB,OAAO,EACP,OAAO,CAAC,SAAS,CAAC,CAAC;QACrB,OAAO,sBAAS,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,+BAA+B;QAC1C,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;QAC/C,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAChE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAClD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEtC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,0CAA0C,EAC1C,OAAO,EACP,OAAO,CAAC,sCAAsC,CAAC,CAAC;QAClD,OAAO,QAAQ,CAAC,aAAa,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,4DAA2B,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,eAAe,CAC1B,QAA6B,EAC7B,YAAgC,EAChC,QAAgB,EAChB,eAAuB,CAAC,GAAG;QAE3B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;QAC9C,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAChE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAClD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACtC,OAAO,CAAC,WAAW,CAAC,QAAe,CAAC,CAAC;QACrC,OAAO,CAAC,mBAAmB,CAAC,YAAY,CAAC,GAAG,CAAC,qCAAgB,CAAC,UAAU,CAAC,CAAC,CAAC;QAC3E,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAC9B,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;QAEtC,MAAM,OAAO,CAAC,SAAS,CAAC,+BAA+B,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,mBAAmB,CAC9B,QAA6B,EAC7B,YAAgC,EAChC,QAAgB,EAChB,eAAuB,CAAC,GAAG;QAE3B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;QAC9C,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAChE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAClD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACtC,OAAO,CAAC,WAAW,CAAC,QAAe,CAAC,CAAC;QACrC,OAAO,CAAC,mBAAmB,CAAC,YAAY,CAAC,GAAG,CAAC,qCAAgB,CAAC,UAAU,CAAC,CAAC,CAAC;QAC3E,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAC9B,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;QAEtC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,oCAAoC,EACpC,OAAO,EACP,OAAO,CAAC,YAAY,CAAC,CAAC;QACxB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;CACF;AA3OD,gCA2OC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport { Axis } from './axis';\nimport * as gateway from '../gateway';\nimport { ServoTuningParamset } from './servo_tuning_paramset';\nimport { ParamsetInfo } from './paramset_info';\nimport { ServoTuningParam } from './servo_tuning_param';\nimport { PidTuning } from './pid_tuning';\nimport { SimpleTuningParamDefinition } from './simple_tuning_param_definition';\n\n/**\n * Exposes the capabilities to inspect and edit an axis' servo tuning.\n */\nexport class ServoTuner {\n  /**\n   * The axis that will be tuned.\n   */\n  public get axis(): Axis {\n    return this._axis;\n  }\n  private _axis: Axis;\n\n  constructor(axis: Axis) {\n    this._axis = axis;\n  }\n\n  /**\n   * Get the paramset that this device uses by default when it starts up.\n   * @return The paramset used at when the device restarts.\n   */\n  public async getStartupParamset(): Promise<ServoTuningParamset> {\n    const request = new gateway.AxisEmptyRequest();\n    request.setInterfaceId(this.axis.device.connection.interfaceId);\n    request.setDevice(this.axis.device.deviceAddress);\n    request.setAxis(this.axis.axisNumber);\n\n    const response = await gateway.callAsync<gateway.IntResponse>(\n      'servotuning/get_startup_set',\n      request,\n      gateway.IntResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Set the paramset that this device uses by default when it starts up.\n   * @param paramset The paramset to use at startup.\n   */\n  public async setStartupParamset(\n    paramset: ServoTuningParamset\n  ): Promise<void> {\n    const request = new gateway.ServoTuningRequest();\n    request.setInterfaceId(this.axis.device.connection.interfaceId);\n    request.setDevice(this.axis.device.deviceAddress);\n    request.setAxis(this.axis.axisNumber);\n    request.setParamset(paramset as any);\n\n    await gateway.callAsync('servotuning/set_startup_set', request);\n  }\n\n  /**\n   * Load the values from one paramset into another.\n   * @param toParamset The paramset to load into.\n   * @param fromParamset The paramset to load from.\n   */\n  public async loadParamset(\n    toParamset: ServoTuningParamset,\n    fromParamset: ServoTuningParamset\n  ): Promise<void> {\n    const request = new gateway.LoadParamset();\n    request.setInterfaceId(this.axis.device.connection.interfaceId);\n    request.setDevice(this.axis.device.deviceAddress);\n    request.setAxis(this.axis.axisNumber);\n    request.setToParamset(toParamset as any);\n    request.setFromParamset(fromParamset as any);\n\n    await gateway.callAsync('servotuning/load_paramset', request);\n  }\n\n  /**\n   * Get the full set of tuning parameters used by the firmware driving this axis.\n   * @param paramset The paramset to get tuning for.\n   * @return The raw representation of the current tuning.\n   */\n  public async getTuning(\n    paramset: ServoTuningParamset\n  ): Promise<ParamsetInfo> {\n    const request = new gateway.ServoTuningRequest();\n    request.setInterfaceId(this.axis.device.connection.interfaceId);\n    request.setDevice(this.axis.device.deviceAddress);\n    request.setAxis(this.axis.axisNumber);\n    request.setParamset(paramset as any);\n\n    const response = await gateway.callAsync<gateway.ParamsetInfo>(\n      'servotuning/get_raw',\n      request,\n      gateway.ParamsetInfo);\n    return ParamsetInfo.fromProtobuf(response.toObject());\n  }\n\n  /**\n   * Set individual tuning parameters.\n   * Only use this method if you have a strong understanding of Zaber specific tuning parameters.\n   * @param paramset The paramset to set tuning of.\n   * @param tuningParams The params to set.\n   */\n  public async setTuning(\n    paramset: ServoTuningParamset,\n    tuningParams: ServoTuningParam[]\n  ): Promise<void> {\n    const request = new gateway.SetServoTuningRequest();\n    request.setInterfaceId(this.axis.device.connection.interfaceId);\n    request.setDevice(this.axis.device.deviceAddress);\n    request.setAxis(this.axis.axisNumber);\n    request.setParamset(paramset as any);\n    request.setTuningParamsList(tuningParams.map(ServoTuningParam.toProtobuf));\n\n    await gateway.callAsync('servotuning/set_raw', request);\n  }\n\n  /**\n   * Sets the tuning of a paramset using the PID method.\n   * @param paramset The paramset to get tuning for.\n   * @param p The proportional gain. Must be in units of N/m.\n   * @param i The integral gain. Must be in units of N/m⋅s.\n   * @param d The derivative gain. Must be in units of N⋅s/m.\n   * @param fc The cutoff frequency. Must be in units of Hz.\n   * @return The PID representation of the current tuning after your changes have been applied.\n   */\n  public async setPidTuning(\n    paramset: ServoTuningParamset,\n    p: number,\n    i: number,\n    d: number,\n    fc: number\n  ): Promise<PidTuning> {\n    const request = new gateway.SetServoTuningPIDRequest();\n    request.setInterfaceId(this.axis.device.connection.interfaceId);\n    request.setDevice(this.axis.device.deviceAddress);\n    request.setAxis(this.axis.axisNumber);\n    request.setParamset(paramset as any);\n    request.setP(p);\n    request.setI(i);\n    request.setD(d);\n    request.setFc(fc);\n\n    const response = await gateway.callAsync<gateway.PidTuning>(\n      'servotuning/set_pid',\n      request,\n      gateway.PidTuning);\n    return PidTuning.fromProtobuf(response.toObject());\n  }\n\n  /**\n   * Gets the PID representation of this paramset's servo tuning.\n   * @param paramset The paramset to get tuning for.\n   * @return The PID representation of the current tuning.\n   */\n  public async getPidTuning(\n    paramset: ServoTuningParamset\n  ): Promise<PidTuning> {\n    const request = new gateway.ServoTuningRequest();\n    request.setInterfaceId(this.axis.device.connection.interfaceId);\n    request.setDevice(this.axis.device.deviceAddress);\n    request.setAxis(this.axis.axisNumber);\n    request.setParamset(paramset as any);\n\n    const response = await gateway.callAsync<gateway.PidTuning>(\n      'servotuning/get_pid',\n      request,\n      gateway.PidTuning);\n    return PidTuning.fromProtobuf(response.toObject());\n  }\n\n  /**\n   * Gets the parameters that are required to tune this device.\n   * @return The tuning parameters.\n   */\n  public async getSimpleTuningParamDefinitions(): Promise<SimpleTuningParamDefinition[]> {\n    const request = new gateway.AxisEmptyRequest();\n    request.setInterfaceId(this.axis.device.connection.interfaceId);\n    request.setDevice(this.axis.device.deviceAddress);\n    request.setAxis(this.axis.axisNumber);\n\n    const response = await gateway.callAsync<gateway.GetSimpleTuningParamDefinitionResponse>(\n      'servotuning/get_simple_params_definition',\n      request,\n      gateway.GetSimpleTuningParamDefinitionResponse);\n    return response.getParamsList().map(a => SimpleTuningParamDefinition.fromProtobuf(a.toObject()));\n  }\n\n  /**\n   * Set the tuning of this device using the simple input method.\n   * @param paramset The paramset to set tuning for.\n   * @param tuningParams The params used to tune this device.\n   * To get what parameters are expected, call GetSimpleTuningParamList.\n   * All values must be between 0 and 1.\n   * @param loadMass The mass loaded on the stage (excluding the mass of the carriage itself) in kg.\n   * @param carriageMass The mass of the carriage in kg. If this value is not set the default carriage mass is used.\n   */\n  public async setSimpleTuning(\n    paramset: ServoTuningParamset,\n    tuningParams: ServoTuningParam[],\n    loadMass: number,\n    carriageMass: number = -1.0\n  ): Promise<void> {\n    const request = new gateway.SetSimpleTuning();\n    request.setInterfaceId(this.axis.device.connection.interfaceId);\n    request.setDevice(this.axis.device.deviceAddress);\n    request.setAxis(this.axis.axisNumber);\n    request.setParamset(paramset as any);\n    request.setTuningParamsList(tuningParams.map(ServoTuningParam.toProtobuf));\n    request.setLoadMass(loadMass);\n    request.setCarriageMass(carriageMass);\n\n    await gateway.callAsync('servotuning/set_simple_tuning', request);\n  }\n\n  /**\n   * Checks if the provided simple tuning is being stored by this paramset.\n   * @param paramset The paramset to set tuning for.\n   * @param tuningParams The params used to tune this device.\n   * To get what parameters are expected, call GetSimpleTuningParamList.\n   * All values must be between 0 and 1.\n   * @param loadMass The mass loaded on the stage (excluding the mass of the carriage itself) in kg.\n   * @param carriageMass The mass of the carriage in kg. If this value is not set the default carriage mass is used.\n   * @return True if the provided simple tuning is currently stored in this paramset.\n   */\n  public async isUsingSimpleTuning(\n    paramset: ServoTuningParamset,\n    tuningParams: ServoTuningParam[],\n    loadMass: number,\n    carriageMass: number = -1.0\n  ): Promise<boolean> {\n    const request = new gateway.SetSimpleTuning();\n    request.setInterfaceId(this.axis.device.connection.interfaceId);\n    request.setDevice(this.axis.device.deviceAddress);\n    request.setAxis(this.axis.axisNumber);\n    request.setParamset(paramset as any);\n    request.setTuningParamsList(tuningParams.map(ServoTuningParam.toProtobuf));\n    request.setLoadMass(loadMass);\n    request.setCarriageMass(carriageMass);\n\n    const response = await gateway.callAsync<gateway.BoolResponse>(\n      'servotuning/is_using_simple_tuning',\n      request,\n      gateway.BoolResponse);\n    return response.getValue();\n  }\n}\n"]}
+{"version":3,"file":"servo_tuner.js","sourceRoot":"","sources":["../../../src/ascii/servo_tuner.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;;;;;AAGtD,oDAAsC;AAEtC,mDAA+C;AAC/C,6DAAwD;AACxD,6CAAyC;AACzC,qFAA+E;AAE/E;;;GAGG;AACH,MAAa,UAAU;IACrB;;OAEG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAGD,YAAY,IAAU;QACpB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,kBAAkB;QAC7B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;QAC/C,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAChE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAClD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEtC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,6BAA6B,EAC7B,OAAO,EACP,OAAO,CAAC,WAAW,CAAC,CAAC;QACvB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,kBAAkB,CAC7B,QAA6B;QAE7B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;QACjD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAChE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAClD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACtC,OAAO,CAAC,WAAW,CAAC,QAAe,CAAC,CAAC;QAErC,MAAM,OAAO,CAAC,SAAS,CAAC,6BAA6B,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,YAAY,CACvB,UAA+B,EAC/B,YAAiC;QAEjC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;QAC3C,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAChE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAClD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACtC,OAAO,CAAC,aAAa,CAAC,UAAiB,CAAC,CAAC;QACzC,OAAO,CAAC,eAAe,CAAC,YAAmB,CAAC,CAAC;QAE7C,MAAM,OAAO,CAAC,SAAS,CAAC,2BAA2B,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CACpB,QAA6B;QAE7B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;QACjD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAChE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAClD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACtC,OAAO,CAAC,WAAW,CAAC,QAAe,CAAC,CAAC;QAErC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,qBAAqB,EACrB,OAAO,EACP,OAAO,CAAC,YAAY,CAAC,CAAC;QACxB,OAAO,4BAAY,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;IACxD,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,SAAS,CACpB,QAA6B,EAC7B,YAAgC;QAEhC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC;QACpD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAChE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAClD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACtC,OAAO,CAAC,WAAW,CAAC,QAAe,CAAC,CAAC;QACrC,OAAO,CAAC,mBAAmB,CAAC,YAAY,CAAC,GAAG,CAAC,qCAAgB,CAAC,UAAU,CAAC,CAAC,CAAC;QAE3E,MAAM,OAAO,CAAC,SAAS,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,YAAY,CACvB,QAA6B,EAC7B,CAAS,EACT,CAAS,EACT,CAAS,EACT,EAAU;QAEV,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,wBAAwB,EAAE,CAAC;QACvD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAChE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAClD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACtC,OAAO,CAAC,WAAW,CAAC,QAAe,CAAC,CAAC;QACrC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAChB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAChB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAChB,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAElB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,qBAAqB,EACrB,OAAO,EACP,OAAO,CAAC,SAAS,CAAC,CAAC;QACrB,OAAO,sBAAS,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;IACrD,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,YAAY,CACvB,QAA6B;QAE7B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;QACjD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAChE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAClD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACtC,OAAO,CAAC,WAAW,CAAC,QAAe,CAAC,CAAC;QAErC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,qBAAqB,EACrB,OAAO,EACP,OAAO,CAAC,SAAS,CAAC,CAAC;QACrB,OAAO,sBAAS,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,+BAA+B;QAC1C,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;QAC/C,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAChE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAClD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEtC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,0CAA0C,EAC1C,OAAO,EACP,OAAO,CAAC,sCAAsC,CAAC,CAAC;QAClD,OAAO,QAAQ,CAAC,aAAa,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,4DAA2B,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,eAAe,CAC1B,QAA6B,EAC7B,YAAgC,EAChC,QAAgB,EAChB,UAA6C,EAAE;QAE/C,MAAM,EACJ,YAAY,GAAG,CAAC,GAAG,GACpB,GAAG,OAAO,CAAC;QACZ,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;QAC9C,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAChE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAClD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACtC,OAAO,CAAC,WAAW,CAAC,QAAe,CAAC,CAAC;QACrC,OAAO,CAAC,mBAAmB,CAAC,YAAY,CAAC,GAAG,CAAC,qCAAgB,CAAC,UAAU,CAAC,CAAC,CAAC;QAC3E,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAC9B,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;QAEtC,MAAM,OAAO,CAAC,SAAS,CAAC,+BAA+B,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,mBAAmB,CAC9B,QAA6B,EAC7B,YAAgC,EAChC,QAAgB,EAChB,UAAiD,EAAE;QAEnD,MAAM,EACJ,YAAY,GAAG,CAAC,GAAG,GACpB,GAAG,OAAO,CAAC;QACZ,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;QAC9C,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAChE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAClD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACtC,OAAO,CAAC,WAAW,CAAC,QAAe,CAAC,CAAC;QACrC,OAAO,CAAC,mBAAmB,CAAC,YAAY,CAAC,GAAG,CAAC,qCAAgB,CAAC,UAAU,CAAC,CAAC,CAAC;QAC3E,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAC9B,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;QAEtC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,oCAAoC,EACpC,OAAO,EACP,OAAO,CAAC,YAAY,CAAC,CAAC;QACxB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;CACF;AAjPD,gCAiPC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport { Axis } from './axis';\nimport * as gateway from '../gateway';\nimport { ServoTuningParamset } from './servo_tuning_paramset';\nimport { ParamsetInfo } from './paramset_info';\nimport { ServoTuningParam } from './servo_tuning_param';\nimport { PidTuning } from './pid_tuning';\nimport { SimpleTuningParamDefinition } from './simple_tuning_param_definition';\n\n/**\n * Exposes the capabilities to inspect and edit an axis' servo tuning.\n * Requires at least Firmware 6.25 or 7.00.\n */\nexport class ServoTuner {\n  /**\n   * The axis that will be tuned.\n   */\n  public get axis(): Axis {\n    return this._axis;\n  }\n  private _axis: Axis;\n\n  constructor(axis: Axis) {\n    this._axis = axis;\n  }\n\n  /**\n   * Get the paramset that this device uses by default when it starts up.\n   * @returns The paramset used at when the device restarts.\n   */\n  public async getStartupParamset(): Promise<ServoTuningParamset> {\n    const request = new gateway.AxisEmptyRequest();\n    request.setInterfaceId(this.axis.device.connection.interfaceId);\n    request.setDevice(this.axis.device.deviceAddress);\n    request.setAxis(this.axis.axisNumber);\n\n    const response = await gateway.callAsync<gateway.IntResponse>(\n      'servotuning/get_startup_set',\n      request,\n      gateway.IntResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Set the paramset that this device uses by default when it starts up.\n   * @param paramset The paramset to use at startup.\n   */\n  public async setStartupParamset(\n    paramset: ServoTuningParamset\n  ): Promise<void> {\n    const request = new gateway.ServoTuningRequest();\n    request.setInterfaceId(this.axis.device.connection.interfaceId);\n    request.setDevice(this.axis.device.deviceAddress);\n    request.setAxis(this.axis.axisNumber);\n    request.setParamset(paramset as any);\n\n    await gateway.callAsync('servotuning/set_startup_set', request);\n  }\n\n  /**\n   * Load the values from one paramset into another.\n   * @param toParamset The paramset to load into.\n   * @param fromParamset The paramset to load from.\n   */\n  public async loadParamset(\n    toParamset: ServoTuningParamset,\n    fromParamset: ServoTuningParamset\n  ): Promise<void> {\n    const request = new gateway.LoadParamset();\n    request.setInterfaceId(this.axis.device.connection.interfaceId);\n    request.setDevice(this.axis.device.deviceAddress);\n    request.setAxis(this.axis.axisNumber);\n    request.setToParamset(toParamset as any);\n    request.setFromParamset(fromParamset as any);\n\n    await gateway.callAsync('servotuning/load_paramset', request);\n  }\n\n  /**\n   * Get the full set of tuning parameters used by the firmware driving this axis.\n   * @param paramset The paramset to get tuning for.\n   * @returns The raw representation of the current tuning.\n   */\n  public async getTuning(\n    paramset: ServoTuningParamset\n  ): Promise<ParamsetInfo> {\n    const request = new gateway.ServoTuningRequest();\n    request.setInterfaceId(this.axis.device.connection.interfaceId);\n    request.setDevice(this.axis.device.deviceAddress);\n    request.setAxis(this.axis.axisNumber);\n    request.setParamset(paramset as any);\n\n    const response = await gateway.callAsync<gateway.ParamsetInfo>(\n      'servotuning/get_raw',\n      request,\n      gateway.ParamsetInfo);\n    return ParamsetInfo.fromProtobuf(response.toObject());\n  }\n\n  /**\n   * Set individual tuning parameters.\n   * Only use this method if you have a strong understanding of Zaber specific tuning parameters.\n   * @param paramset The paramset to set tuning of.\n   * @param tuningParams The params to set.\n   */\n  public async setTuning(\n    paramset: ServoTuningParamset,\n    tuningParams: ServoTuningParam[]\n  ): Promise<void> {\n    const request = new gateway.SetServoTuningRequest();\n    request.setInterfaceId(this.axis.device.connection.interfaceId);\n    request.setDevice(this.axis.device.deviceAddress);\n    request.setAxis(this.axis.axisNumber);\n    request.setParamset(paramset as any);\n    request.setTuningParamsList(tuningParams.map(ServoTuningParam.toProtobuf));\n\n    await gateway.callAsync('servotuning/set_raw', request);\n  }\n\n  /**\n   * Sets the tuning of a paramset using the PID method.\n   * @param paramset The paramset to get tuning for.\n   * @param p The proportional gain. Must be in units of N/m.\n   * @param i The integral gain. Must be in units of N/m⋅s.\n   * @param d The derivative gain. Must be in units of N⋅s/m.\n   * @param fc The cutoff frequency. Must be in units of Hz.\n   * @returns The PID representation of the current tuning after your changes have been applied.\n   */\n  public async setPidTuning(\n    paramset: ServoTuningParamset,\n    p: number,\n    i: number,\n    d: number,\n    fc: number\n  ): Promise<PidTuning> {\n    const request = new gateway.SetServoTuningPIDRequest();\n    request.setInterfaceId(this.axis.device.connection.interfaceId);\n    request.setDevice(this.axis.device.deviceAddress);\n    request.setAxis(this.axis.axisNumber);\n    request.setParamset(paramset as any);\n    request.setP(p);\n    request.setI(i);\n    request.setD(d);\n    request.setFc(fc);\n\n    const response = await gateway.callAsync<gateway.PidTuning>(\n      'servotuning/set_pid',\n      request,\n      gateway.PidTuning);\n    return PidTuning.fromProtobuf(response.toObject());\n  }\n\n  /**\n   * Gets the PID representation of this paramset's servo tuning.\n   * @param paramset The paramset to get tuning for.\n   * @returns The PID representation of the current tuning.\n   */\n  public async getPidTuning(\n    paramset: ServoTuningParamset\n  ): Promise<PidTuning> {\n    const request = new gateway.ServoTuningRequest();\n    request.setInterfaceId(this.axis.device.connection.interfaceId);\n    request.setDevice(this.axis.device.deviceAddress);\n    request.setAxis(this.axis.axisNumber);\n    request.setParamset(paramset as any);\n\n    const response = await gateway.callAsync<gateway.PidTuning>(\n      'servotuning/get_pid',\n      request,\n      gateway.PidTuning);\n    return PidTuning.fromProtobuf(response.toObject());\n  }\n\n  /**\n   * Gets the parameters that are required to tune this device.\n   * @returns The tuning parameters.\n   */\n  public async getSimpleTuningParamDefinitions(): Promise<SimpleTuningParamDefinition[]> {\n    const request = new gateway.AxisEmptyRequest();\n    request.setInterfaceId(this.axis.device.connection.interfaceId);\n    request.setDevice(this.axis.device.deviceAddress);\n    request.setAxis(this.axis.axisNumber);\n\n    const response = await gateway.callAsync<gateway.GetSimpleTuningParamDefinitionResponse>(\n      'servotuning/get_simple_params_definition',\n      request,\n      gateway.GetSimpleTuningParamDefinitionResponse);\n    return response.getParamsList().map(a => SimpleTuningParamDefinition.fromProtobuf(a.toObject()));\n  }\n\n  /**\n   * Set the tuning of this device using the simple input method.\n   * @param paramset The paramset to set tuning for.\n   * @param tuningParams The params used to tune this device.\n   * To get what parameters are expected, call GetSimpleTuningParamList.\n   * All values must be between 0 and 1.\n   * @param loadMass The mass loaded on the stage (excluding the mass of the carriage itself) in kg.\n   * @param [options.carriageMass=-1.0] The mass of the carriage in kg. If this value is not set the default carriage mass is used.\n   */\n  public async setSimpleTuning(\n    paramset: ServoTuningParamset,\n    tuningParams: ServoTuningParam[],\n    loadMass: number,\n    options: ServoTuner.SetSimpleTuningOptions = {}\n  ): Promise<void> {\n    const {\n      carriageMass = -1.0,\n    } = options;\n    const request = new gateway.SetSimpleTuning();\n    request.setInterfaceId(this.axis.device.connection.interfaceId);\n    request.setDevice(this.axis.device.deviceAddress);\n    request.setAxis(this.axis.axisNumber);\n    request.setParamset(paramset as any);\n    request.setTuningParamsList(tuningParams.map(ServoTuningParam.toProtobuf));\n    request.setLoadMass(loadMass);\n    request.setCarriageMass(carriageMass);\n\n    await gateway.callAsync('servotuning/set_simple_tuning', request);\n  }\n\n  /**\n   * Checks if the provided simple tuning is being stored by this paramset.\n   * @param paramset The paramset to set tuning for.\n   * @param tuningParams The params used to tune this device.\n   * To get what parameters are expected, call GetSimpleTuningParamList.\n   * All values must be between 0 and 1.\n   * @param loadMass The mass loaded on the stage (excluding the mass of the carriage itself) in kg.\n   * @param [options.carriageMass=-1.0] The mass of the carriage in kg. If this value is not set the default carriage mass is used.\n   * @returns True if the provided simple tuning is currently stored in this paramset.\n   */\n  public async isUsingSimpleTuning(\n    paramset: ServoTuningParamset,\n    tuningParams: ServoTuningParam[],\n    loadMass: number,\n    options: ServoTuner.IsUsingSimpleTuningOptions = {}\n  ): Promise<boolean> {\n    const {\n      carriageMass = -1.0,\n    } = options;\n    const request = new gateway.SetSimpleTuning();\n    request.setInterfaceId(this.axis.device.connection.interfaceId);\n    request.setDevice(this.axis.device.deviceAddress);\n    request.setAxis(this.axis.axisNumber);\n    request.setParamset(paramset as any);\n    request.setTuningParamsList(tuningParams.map(ServoTuningParam.toProtobuf));\n    request.setLoadMass(loadMass);\n    request.setCarriageMass(carriageMass);\n\n    const response = await gateway.callAsync<gateway.BoolResponse>(\n      'servotuning/is_using_simple_tuning',\n      request,\n      gateway.BoolResponse);\n    return response.getValue();\n  }\n}\n\nnamespace ServoTuner {\n  export interface SetSimpleTuningOptions {\n      carriageMass?: number;\n  }\n  export interface IsUsingSimpleTuningOptions {\n      carriageMass?: number;\n  }\n}\n"]}