@zaber/motion 2.9.1 → 2.11.0

package/dist/lib/ascii/oscilloscope.js

@@ -0,0 +1,153 @@
+"use strict";
+// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //
+// ============= DO NOT EDIT DIRECTLY ============= //
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Oscilloscope = void 0;
+const oscilloscope_data_1 = require("./oscilloscope_data");
+const units_1 = require("../units");
+const gateway = __importStar(require("../gateway"));
+/**
+ * Provides a convenient way to control the oscilloscope data recording feature of some devices.
+ * The oscilloscope can record the values of some settings over time at high resolution.
+ */
+class Oscilloscope {
+    constructor(device) {
+        this._device = device;
+    }
+    /**
+     * Device that this Oscilloscope measures.
+     */
+    get device() {
+        return this._device;
+    }
+    /**
+     * Select a setting to be recorded.
+     * @param axis The 1-based index of the axis to record the value from.
+     * @param setting The name of a setting to record.
+     */
+    async addChannel(axis, setting) {
+        const request = new gateway.OscilloscopeAddChannelRequest();
+        request.setInterfaceId(this.device.connection.interfaceId);
+        request.setDevice(this.device.deviceAddress);
+        request.setAxis(axis);
+        request.setSetting(setting);
+        await gateway.callAsync('oscilloscope/add_channel', request);
+    }
+    /**
+     * Clear the list of channels to record.
+     */
+    async clear() {
+        const request = new gateway.OscilloscopeClearChannelsRequest();
+        request.setInterfaceId(this.device.connection.interfaceId);
+        request.setDevice(this.device.deviceAddress);
+        await gateway.callAsync('oscilloscope/clear_channels', request);
+    }
+    /**
+     * Get the current sampling interval.
+     * @param unit Unit of measure to represent the timebase in.
+     * @return The current sampling interval in the selected time units.
+     */
+    async getTimebase(unit = units_1.Units.NATIVE) {
+        const request = new gateway.DeviceGetSettingRequest();
+        request.setInterfaceId(this.device.connection.interfaceId);
+        request.setDevice(this.device.deviceAddress);
+        request.setSetting('scope.timebase');
+        request.setUnit(unit);
+        const response = await gateway.callAsync('device/get_setting', request, gateway.DeviceGetSettingResponse);
+        return response.getValue();
+    }
+    /**
+     * Set the sampling interval.
+     * @param interval Sample interval for the next oscilloscope recording. Minimum value is 100µs.
+     * @param unit Unit of measure the timebase is represented in.
+     */
+    async setTimebase(interval, unit = units_1.Units.NATIVE) {
+        const request = new gateway.DeviceSetSettingRequest();
+        request.setInterfaceId(this.device.connection.interfaceId);
+        request.setDevice(this.device.deviceAddress);
+        request.setSetting('scope.timebase');
+        request.setValue(interval);
+        request.setUnit(unit);
+        await gateway.callAsync('device/set_setting', request);
+    }
+    /**
+     * Get the delay before oscilloscope recording starts.
+     * @param unit Unit of measure to represent the delay in.
+     * @return The current start delay in the selected time units.
+     */
+    async getDelay(unit = units_1.Units.NATIVE) {
+        const request = new gateway.DeviceGetSettingRequest();
+        request.setInterfaceId(this.device.connection.interfaceId);
+        request.setDevice(this.device.deviceAddress);
+        request.setSetting('scope.delay');
+        request.setUnit(unit);
+        const response = await gateway.callAsync('device/get_setting', request, gateway.DeviceGetSettingResponse);
+        return response.getValue();
+    }
+    /**
+     * Set the sampling start delay.
+     * @param interval Delay time between triggering a recording and the first data point being recorded.
+     * @param unit Unit of measure the delay is represented in.
+     */
+    async setDelay(interval, unit = units_1.Units.NATIVE) {
+        const request = new gateway.DeviceSetSettingRequest();
+        request.setInterfaceId(this.device.connection.interfaceId);
+        request.setDevice(this.device.deviceAddress);
+        request.setSetting('scope.delay');
+        request.setValue(interval);
+        request.setUnit(unit);
+        await gateway.callAsync('device/set_setting', request);
+    }
+    /**
+     * Trigger data recording.
+     */
+    async start() {
+        const request = new gateway.OscilloscopeStartStopRequest();
+        request.setInterfaceId(this.device.connection.interfaceId);
+        request.setDevice(this.device.deviceAddress);
+        request.setStart(true);
+        await gateway.callAsync('oscilloscope/start_or_stop', request);
+    }
+    /**
+     * End data recording if currently in progress.
+     */
+    async stop() {
+        const request = new gateway.OscilloscopeStartStopRequest();
+        request.setInterfaceId(this.device.connection.interfaceId);
+        request.setDevice(this.device.deviceAddress);
+        request.setStart(false);
+        await gateway.callAsync('oscilloscope/start_or_stop', request);
+    }
+    /**
+     * Reads the last-recorded data from the oscilloscope. Will block until any in-progress recording completes.
+     * @return Array of recorded channel data arrays, in the order added.
+     */
+    async read() {
+        const request = new gateway.OscilloscopeReadRequest();
+        request.setInterfaceId(this.device.connection.interfaceId);
+        request.setDevice(this.device.deviceAddress);
+        const response = await gateway.callAsync('oscilloscope/read', request, gateway.OscilloscopeReadResponse);
+        return response.getDataIdsList().map(id => new oscilloscope_data_1.OscilloscopeData(this.device, id));
+    }
+}
+exports.Oscilloscope = Oscilloscope;
+//# sourceMappingURL=oscilloscope.js.map

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

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

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

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

package/dist/lib/ascii/oscilloscope_capture_properties.js

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

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

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

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

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

package/dist/lib/ascii/oscilloscope_data.js

@@ -0,0 +1,151 @@
+"use strict";
+// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //
+// ============= DO NOT EDIT DIRECTLY ============= //
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OscilloscopeData = void 0;
+const units_1 = require("../units");
+const gateway = __importStar(require("../gateway"));
+const finalizer_1 = require("../finalizer");
+const oscilloscope_capture_properties_1 = require("./oscilloscope_capture_properties");
+/**
+ * Contains a block of contiguous recorded data for one channel of the device's oscilloscope.
+ */
+class OscilloscopeData {
+    constructor(device, dataId) {
+        this._device = device;
+        this._dataId = dataId;
+        (0, finalizer_1.registerForFinalization)(this, OscilloscopeData._free.bind(null, dataId));
+    }
+    /**
+     * Device that this Oscilloscope measures.
+     */
+    get device() {
+        return this._device;
+    }
+    /**
+     * Unique ID for this block of recorded data.
+     */
+    get dataId() {
+        return this._dataId;
+    }
+    /**
+     * The name of the recorded setting.
+     */
+    get setting() {
+        return this._retrieveProperties().setting;
+    }
+    /**
+     * The number of the axis the data was recorded from, or 0 for the controller.
+     */
+    get axisNumber() {
+        return this._retrieveProperties().axisNumber;
+    }
+    /**
+     * Get the sample interval that this data was recorded with.
+     * @param unit Unit of measure to represent the timebase in.
+     * @return The timebase setting at the time the data was recorded.
+     */
+    getTimebase(unit = units_1.Units.NATIVE) {
+        const request = new gateway.OscilloscopeDataGetSavedSettingRequest();
+        request.setInterfaceId(this.device.connection.interfaceId);
+        request.setDevice(this.device.deviceAddress);
+        request.setDataId(this.dataId);
+        request.setUnit(unit);
+        const response = gateway.callSync('oscilloscopedata/get_timebase', request, gateway.OscilloscopeDataGetSavedSettingResponse);
+        return response.getValue();
+    }
+    /**
+     * Get the sample interval that this data was recorded with.
+     * @param unit Unit of measure to represent the delay in.
+     * @return The delay setting at the time the data was recorded.
+     */
+    getDelay(unit = units_1.Units.NATIVE) {
+        const request = new gateway.OscilloscopeDataGetSavedSettingRequest();
+        request.setInterfaceId(this.device.connection.interfaceId);
+        request.setDevice(this.device.deviceAddress);
+        request.setDataId(this.dataId);
+        request.setUnit(unit);
+        const response = gateway.callSync('oscilloscopedata/get_delay', request, gateway.OscilloscopeDataGetSavedSettingResponse);
+        return response.getValue();
+    }
+    /**
+     * Calculate the time a sample was recorded, relative to when the recording was triggered.
+     * @param index 0-based index of the sample to calculate the time of.
+     * @param unit Unit of measure to represent the calculated time in.
+     * @return The calculated time offset of the data sample at the given index.
+     */
+    getSampleTime(index, unit = units_1.Units.NATIVE) {
+        const request = new gateway.OscilloscopeDataGetSampleTimeRequest();
+        request.setInterfaceId(this.device.connection.interfaceId);
+        request.setDevice(this.device.deviceAddress);
+        request.setDataId(this.dataId);
+        request.setIndex(index);
+        request.setUnit(unit);
+        const response = gateway.callSync('oscilloscopedata/get_sample_time', request, gateway.OscilloscopeDataGetSavedSettingResponse);
+        return response.getValue();
+    }
+    /**
+     * Get the recorded data as an array of doubles.
+     * @param unit Unit of measure to convert the data to.
+     * @return The recorded data for one oscilloscope channel, converted to the units specified.
+     */
+    getData(unit = units_1.Units.NATIVE) {
+        const request = new gateway.OscilloscopeDataGetSamplesRequest();
+        request.setInterfaceId(this.device.connection.interfaceId);
+        request.setDevice(this.device.deviceAddress);
+        request.setDataId(this.dataId);
+        request.setUnit(unit);
+        const response = gateway.callSync('oscilloscopedata/get_samples', request, gateway.OscilloscopeDataGetSamplesResponse);
+        return response.getDataList();
+    }
+    /**
+     * Releases native resources of an oscilloscope data buffer.
+     * @param dataId The ID of the data buffer to delete.
+     */
+    static _free(dataId) {
+        const request = new gateway.OscilloscopeDataIdentifier();
+        request.setDataId(dataId);
+        gateway.callSync('oscilloscopedata/free', request);
+    }
+    /**
+     * Returns recording properties.
+     * @return Capture properties.
+     */
+    _retrieveProperties() {
+        const request = new gateway.OscilloscopeDataIdentifier();
+        request.setInterfaceId(this.device.connection.interfaceId);
+        request.setDevice(this.device.deviceAddress);
+        request.setDataId(this.dataId);
+        const response = gateway.callSync('oscilloscopedata/get_properties', request, gateway.OscilloscopeDataGetPropertiesResponse);
+        return oscilloscope_capture_properties_1.OscilloscopeCaptureProperties.fromProtobuf(response.getProperties().toObject());
+    }
+    /**
+     * Releases the native resources of the oscilloscope data.
+     * Should only be called if your environment does not support FinalizationRegistry.
+     * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/FinalizationRegistry
+     */
+    free() {
+        OscilloscopeData._free(this.dataId);
+    }
+}
+exports.OscilloscopeData = OscilloscopeData;
+//# sourceMappingURL=oscilloscope_data.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"oscilloscope_data.js","sourceRoot":"","sources":["../../../src/ascii/oscilloscope_data.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;AAGtD,oCAA+C;AAC/C,oDAAsC;AACtC,4CAAuD;AAEvD,uFAAkF;AAElF;;GAEG;AACH,MAAa,gBAAgB;IA+B3B,YAAY,MAAc,EAAE,MAAc;QACxC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,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;IAlCD;;OAEG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAGD;;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;IAQD;;;;OAIG;IACI,WAAW,CAChB,OAAsB,aAAK,CAAC,MAAM;QAElC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,sCAAsC,EAAE,CAAC;QACrE,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,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,uCAAuC,CAAC,CAAC;QACnD,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,QAAQ,CACb,OAAsB,aAAK,CAAC,MAAM;QAElC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,sCAAsC,EAAE,CAAC;QACrE,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,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,uCAAuC,CAAC,CAAC;QACnD,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,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,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,uCAAuC,CAAC,CAAC;QACnD,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,OAAO,CACZ,OAAc,aAAK,CAAC,MAAM;QAE1B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,iCAAiC,EAAE,CAAC;QAChE,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,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,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,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAE/B,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,iCAAiC,EACjC,OAAO,EACP,OAAO,CAAC,qCAAqC,CAAC,CAAC;QACjD,OAAO,+DAA6B,CAAC,YAAY,CAAC,QAAQ,CAAC,aAAa,EAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;OAIG;IACI,IAAI;QACT,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACtC,CAAC;CACF;AAlKD,4CAkKC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport { Device } from './device';\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   * Device that this Oscilloscope measures.\n   */\n  public get device(): Device {\n    return this._device;\n  }\n  private _device: Device;\n\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(device: Device, dataId: number) {\n    this._device = device;\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.OscilloscopeDataGetSavedSettingRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setDataId(this.dataId);\n    request.setUnit(unit);\n\n    const response = gateway.callSync<gateway.OscilloscopeDataGetSavedSettingResponse>(\n      'oscilloscopedata/get_timebase',\n      request,\n      gateway.OscilloscopeDataGetSavedSettingResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Get the sample interval that this data was recorded with.\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.OscilloscopeDataGetSavedSettingRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setDataId(this.dataId);\n    request.setUnit(unit);\n\n    const response = gateway.callSync<gateway.OscilloscopeDataGetSavedSettingResponse>(\n      'oscilloscopedata/get_delay',\n      request,\n      gateway.OscilloscopeDataGetSavedSettingResponse);\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.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setDataId(this.dataId);\n    request.setIndex(index);\n    request.setUnit(unit);\n\n    const response = gateway.callSync<gateway.OscilloscopeDataGetSavedSettingResponse>(\n      'oscilloscopedata/get_sample_time',\n      request,\n      gateway.OscilloscopeDataGetSavedSettingResponse);\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.OscilloscopeDataGetSamplesRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\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.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setDataId(this.dataId);\n\n    const response = gateway.callSync<gateway.OscilloscopeDataGetPropertiesResponse>(\n      'oscilloscopedata/get_properties',\n      request,\n      gateway.OscilloscopeDataGetPropertiesResponse);\n    return OscilloscopeCaptureProperties.fromProtobuf(response.getProperties()!.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/paramset_info.d.ts

@@ -0,0 +1,17 @@
+import { ServoTuningParam } from './servo_tuning_param';
+/**
+ * The raw parameters currently saved to a given paramset.
+ */
+export interface ParamsetInfo {
+    /**
+     * The tuning algorithm used for this axis.
+     */
+    type: string;
+    /**
+     * The raw tuning parameters of this device.
+     */
+    params: ServoTuningParam[];
+}
+export declare namespace ParamsetInfo {
+    const __type = "ParamsetInfo";
+}

package/dist/lib/ascii/paramset_info.js

@@ -0,0 +1,19 @@
+"use strict";
+// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //
+// ============= DO NOT EDIT DIRECTLY ============= //
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParamsetInfo = void 0;
+const servo_tuning_param_1 = require("./servo_tuning_param");
+var ParamsetInfo;
+(function (ParamsetInfo) {
+    ParamsetInfo.__type = 'ParamsetInfo';
+    /** @internal */
+    function fromProtobuf(pbData) {
+        return {
+            type: pbData.type,
+            params: pbData.paramsList.map(item => servo_tuning_param_1.ServoTuningParam.fromProtobuf(item)),
+        };
+    }
+    ParamsetInfo.fromProtobuf = fromProtobuf;
+})(ParamsetInfo = exports.ParamsetInfo || (exports.ParamsetInfo = {}));
+//# sourceMappingURL=paramset_info.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"paramset_info.js","sourceRoot":"","sources":["../../../src/ascii/paramset_info.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;AAGtD,6DAAwD;AAkBxD,IAAiB,YAAY,CAU5B;AAVD,WAAiB,YAAY;IACd,mBAAM,GAAG,cAAc,CAAC;IAErC,gBAAgB;IAChB,SAAgB,YAAY,CAAC,MAAqC;QAChE,OAAO;YACL,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,qCAAgB,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;SAC3E,CAAC;IACJ,CAAC;IALe,yBAAY,eAK3B,CAAA;AACH,CAAC,EAVgB,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAU5B","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport * as gateway from '../gateway';\nimport { ServoTuningParam } from './servo_tuning_param';\n\n/**\n * The raw parameters currently saved to a given paramset.\n */\nexport interface ParamsetInfo {\n  /**\n   * The tuning algorithm used for this axis.\n   */\n  type: string;\n\n  /**\n   * The raw tuning parameters of this device.\n   */\n  params: ServoTuningParam[];\n\n}\n\nexport namespace ParamsetInfo {\n  export const __type = 'ParamsetInfo';\n\n  /** @internal */\n  export function fromProtobuf(pbData: gateway.ParamsetInfo.AsObject): ParamsetInfo {\n    return {\n      type: pbData.type,\n      params: pbData.paramsList.map(item => ServoTuningParam.fromProtobuf(item)),\n    };\n  }\n}\n"]}

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

@@ -0,0 +1,32 @@
+/**
+ * The tuning of this axis represented by PID parameters.
+ */
+export interface PidTuning {
+    /**
+     * The tuning algorithm used to tune this axis.
+     */
+    type: string;
+    /**
+     * The version of the tuning algorithm used to tune this axis.
+     */
+    version: number;
+    /**
+     * The positional tuning argument.
+     */
+    p: number;
+    /**
+     * The integral tuning argument.
+     */
+    i: number;
+    /**
+     * The derivative tuning argument.
+     */
+    d: number;
+    /**
+     * The frequency cutoff for the tuning.
+     */
+    fc: number;
+}
+export declare namespace PidTuning {
+    const __type = "PidTuning";
+}

package/dist/lib/ascii/pid_tuning.js

@@ -0,0 +1,22 @@
+"use strict";
+// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //
+// ============= DO NOT EDIT DIRECTLY ============= //
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PidTuning = void 0;
+var PidTuning;
+(function (PidTuning) {
+    PidTuning.__type = 'PidTuning';
+    /** @internal */
+    function fromProtobuf(pbData) {
+        return {
+            type: pbData.type,
+            version: pbData.version,
+            p: pbData.p,
+            i: pbData.i,
+            d: pbData.d,
+            fc: pbData.fc,
+        };
+    }
+    PidTuning.fromProtobuf = fromProtobuf;
+})(PidTuning = exports.PidTuning || (exports.PidTuning = {}));
+//# sourceMappingURL=pid_tuning.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pid_tuning.js","sourceRoot":"","sources":["../../../src/ascii/pid_tuning.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;AAwCtD,IAAiB,SAAS,CAczB;AAdD,WAAiB,SAAS;IACX,gBAAM,GAAG,WAAW,CAAC;IAElC,gBAAgB;IAChB,SAAgB,YAAY,CAAC,MAAkC;QAC7D,OAAO;YACL,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,CAAC,EAAE,MAAM,CAAC,CAAC;YACX,CAAC,EAAE,MAAM,CAAC,CAAC;YACX,CAAC,EAAE,MAAM,CAAC,CAAC;YACX,EAAE,EAAE,MAAM,CAAC,EAAE;SACd,CAAC;IACJ,CAAC;IATe,sBAAY,eAS3B,CAAA;AACH,CAAC,EAdgB,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAczB","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport * as gateway from '../gateway';\n\n/**\n * The tuning of this axis represented by PID parameters.\n */\nexport interface PidTuning {\n  /**\n   * The tuning algorithm used to tune this axis.\n   */\n  type: string;\n\n  /**\n   * The version of the tuning algorithm used to tune this axis.\n   */\n  version: number;\n\n  /**\n   * The positional tuning argument.\n   */\n  p: number;\n\n  /**\n   * The integral tuning argument.\n   */\n  i: number;\n\n  /**\n   * The derivative tuning argument.\n   */\n  d: number;\n\n  /**\n   * The frequency cutoff for the tuning.\n   */\n  fc: number;\n\n}\n\nexport namespace PidTuning {\n  export const __type = 'PidTuning';\n\n  /** @internal */\n  export function fromProtobuf(pbData: gateway.PidTuning.AsObject): PidTuning {\n    return {\n      type: pbData.type,\n      version: pbData.version,\n      p: pbData.p,\n      i: pbData.i,\n      d: pbData.d,\n      fc: pbData.fc,\n    };\n  }\n}\n"]}

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

@@ -0,0 +1,77 @@
+import { Axis } from './axis';
+import { ServoTuningParamset } from './servo_tuning_paramset';
+import { ParamsetInfo } from './paramset_info';
+import { ServoTuningParam } from './servo_tuning_param';
+import { PidTuning } from './pid_tuning';
+import { SimpleTuningParam } from './simple_tuning_param';
+/**
+ * Exposes the capabilities to inspect and edit an axis' servo tuning.
+ */
+export declare class ServoTuner {
+    /**
+     * The axis that will be tuned.
+     */
+    get axis(): Axis;
+    private _axis;
+    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.
+     */
+    getStartupParamset(): Promise<ServoTuningParamset>;
+    /**
+     * Set the paramset that this device uses by default when it starts up.
+     * @param paramset The paramset to use at startup.
+     */
+    setStartupParamset(paramset: ServoTuningParamset): Promise<void>;
+    /**
+     * Load the values from one paramset into another.
+     * @param toParamset The paramset to load into.
+     * @param fromParamset The paramset to load from.
+     */
+    loadParamset(toParamset: ServoTuningParamset, fromParamset: ServoTuningParamset): Promise<void>;
+    /**
+     * 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.
+     */
+    getTuning(paramset: ServoTuningParamset): Promise<ParamsetInfo>;
+    /**
+     * Set individual tuning parameters.
+     * Only use this method if you have a strong understanding of Zaber specific tuning parameters.
+     * @param paramset The paramset to set tuning of.
+     * @param tuningParams The params to set.
+     */
+    setTuning(paramset: ServoTuningParamset, tuningParams: ServoTuningParam[]): Promise<void>;
+    /**
+     * Sets the tuning of a paramset using the PID method.
+     * @param paramset The paramset to get tuning for.
+     * @param p The proportional gain. Must be in units of N/m.
+     * @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.
+     */
+    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.
+     */
+    getPidTuning(paramset: ServoTuningParamset): Promise<PidTuning>;
+    /**
+     * Gets the parameters that are required to tune this device.
+     * @return The tuning parameters.
+     */
+    getSimpleTuningParamList(): Promise<SimpleTuningParam[]>;
+    /**
+     * Set the tuning of this device using the simple input method.
+     * @param paramset The paramset to set tuning for.
+     * @param tuningParams The params used to tune this device.
+     * 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.
+     */
+    setSimpleTuning(paramset: ServoTuningParamset, tuningParams: ServoTuningParam[], loadMass: number, carriageMass?: number): Promise<void>;
+}