@zaber/motion 2.10.1 → 2.11.2

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

@@ -27,3 +27,9 @@ export { StreamMode } from './stream_mode';
 export { StreamAxisType } from './stream_axis_type';
 export { StreamAxisDefinition } from './stream_axis_definition';
 export { Transport } from './transport';
+export { ServoTuner } from './servo_tuner';
+export { ServoTuningParamset } from './servo_tuning_paramset';
+export { ParamsetInfo } from './paramset_info';
+export { PidTuning } from './pid_tuning';
+export { ServoTuningParam } from './servo_tuning_param';
+export { SimpleTuningParam } from './simple_tuning_param';

package/dist/lib/ascii/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Transport = exports.StreamAxisDefinition = exports.StreamAxisType = exports.StreamMode = exports.StreamBuffer = exports.Stream = exports.OscilloscopeCaptureProperties = exports.OscilloscopeData = exports.Oscilloscope = exports.LockstepAxes = exports.Lockstep = exports.Warnings = exports.WarningFlags = exports.UnknownResponseEvent = exports.SettingConstants = exports.Response = exports.MessageType = exports.DeviceIOInfo = exports.DeviceIO = exports.Device = exports.DeviceSettings = exports.DeviceIdentity = exports.Connection = exports.Axis = exports.AxisType = exports.AxisSettings = exports.AxisIdentity = exports.AllAxes = exports.AlertEvent = void 0;
+exports.SimpleTuningParam = exports.ServoTuningParam = exports.PidTuning = exports.ParamsetInfo = exports.ServoTuningParamset = exports.ServoTuner = exports.Transport = exports.StreamAxisDefinition = exports.StreamAxisType = exports.StreamMode = exports.StreamBuffer = exports.Stream = exports.OscilloscopeCaptureProperties = exports.OscilloscopeData = exports.Oscilloscope = exports.LockstepAxes = exports.Lockstep = exports.Warnings = exports.WarningFlags = exports.UnknownResponseEvent = exports.SettingConstants = exports.Response = exports.MessageType = exports.DeviceIOInfo = exports.DeviceIO = exports.Device = exports.DeviceSettings = exports.DeviceIdentity = exports.Connection = exports.Axis = exports.AxisType = exports.AxisSettings = exports.AxisIdentity = exports.AllAxes = exports.AlertEvent = void 0;
 var alert_event_1 = require("./alert_event");
 Object.defineProperty(exports, "AlertEvent", { enumerable: true, get: function () { return alert_event_1.AlertEvent; } });
 var all_axes_1 = require("./all_axes");
@@ -59,4 +59,16 @@ var stream_axis_definition_1 = require("./stream_axis_definition");
 Object.defineProperty(exports, "StreamAxisDefinition", { enumerable: true, get: function () { return stream_axis_definition_1.StreamAxisDefinition; } });
 var transport_1 = require("./transport");
 Object.defineProperty(exports, "Transport", { enumerable: true, get: function () { return transport_1.Transport; } });
+var servo_tuner_1 = require("./servo_tuner");
+Object.defineProperty(exports, "ServoTuner", { enumerable: true, get: function () { return servo_tuner_1.ServoTuner; } });
+var servo_tuning_paramset_1 = require("./servo_tuning_paramset");
+Object.defineProperty(exports, "ServoTuningParamset", { enumerable: true, get: function () { return servo_tuning_paramset_1.ServoTuningParamset; } });
+var paramset_info_1 = require("./paramset_info");
+Object.defineProperty(exports, "ParamsetInfo", { enumerable: true, get: function () { return paramset_info_1.ParamsetInfo; } });
+var pid_tuning_1 = require("./pid_tuning");
+Object.defineProperty(exports, "PidTuning", { enumerable: true, get: function () { return pid_tuning_1.PidTuning; } });
+var servo_tuning_param_1 = require("./servo_tuning_param");
+Object.defineProperty(exports, "ServoTuningParam", { enumerable: true, get: function () { return servo_tuning_param_1.ServoTuningParam; } });
+var simple_tuning_param_1 = require("./simple_tuning_param");
+Object.defineProperty(exports, "SimpleTuningParam", { enumerable: true, get: function () { return simple_tuning_param_1.SimpleTuningParam; } });
 //# sourceMappingURL=index.js.map

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

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

package/dist/lib/ascii/servo_tuner.js

@@ -0,0 +1,180 @@
+"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.ServoTuner = void 0;
+const gateway = __importStar(require("../gateway"));
+const paramset_info_1 = require("./paramset_info");
+const servo_tuning_param_1 = require("./servo_tuning_param");
+const pid_tuning_1 = require("./pid_tuning");
+const simple_tuning_param_1 = require("./simple_tuning_param");
+/**
+ * Exposes the capabilities to inspect and edit an axis' servo tuning.
+ */
+class ServoTuner {
+    constructor(axis) {
+        this._axis = axis;
+    }
+    /**
+     * The axis that will be tuned.
+     */
+    get axis() {
+        return this._axis;
+    }
+    /**
+     * Get the paramset that this device uses by default when it starts up.
+     * @return The paramset used at when the device restarts.
+     */
+    async getStartupParamset() {
+        const request = new gateway.GetStartupParamset();
+        request.setInterfaceId(this.axis.device.connection.interfaceId);
+        request.setDevice(this.axis.device.deviceAddress);
+        request.setAxis(this.axis.axisNumber);
+        const response = await gateway.callAsync('servotuning/get_startup_set', request, gateway.StartupParamset);
+        return response.getParamset();
+    }
+    /**
+     * Set the paramset that this device uses by default when it starts up.
+     * @param paramset The paramset to use at startup.
+     */
+    async setStartupParamset(paramset) {
+        const request = new gateway.ServoTuningRequest();
+        request.setInterfaceId(this.axis.device.connection.interfaceId);
+        request.setDevice(this.axis.device.deviceAddress);
+        request.setAxis(this.axis.axisNumber);
+        request.setParamset(paramset);
+        await gateway.callAsync('servotuning/set_startup_set', request);
+    }
+    /**
+     * Load the values from one paramset into another.
+     * @param toParamset The paramset to load into.
+     * @param fromParamset The paramset to load from.
+     */
+    async loadParamset(toParamset, fromParamset) {
+        const request = new gateway.LoadParamset();
+        request.setInterfaceId(this.axis.device.connection.interfaceId);
+        request.setDevice(this.axis.device.deviceAddress);
+        request.setAxis(this.axis.axisNumber);
+        request.setToParamset(toParamset);
+        request.setFromParamset(fromParamset);
+        await gateway.callAsync('servotuning/load_paramset', request);
+    }
+    /**
+     * 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.
+     */
+    async getTuning(paramset) {
+        const request = new gateway.ServoTuningRequest();
+        request.setInterfaceId(this.axis.device.connection.interfaceId);
+        request.setDevice(this.axis.device.deviceAddress);
+        request.setAxis(this.axis.axisNumber);
+        request.setParamset(paramset);
+        const response = await gateway.callAsync('servotuning/get_raw', request, gateway.ParamsetInfo);
+        return paramset_info_1.ParamsetInfo.fromProtobuf(response.toObject());
+    }
+    /**
+     * 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.
+     */
+    async setTuning(paramset, tuningParams) {
+        const request = new gateway.SetServoTuningRequest();
+        request.setInterfaceId(this.axis.device.connection.interfaceId);
+        request.setDevice(this.axis.device.deviceAddress);
+        request.setAxis(this.axis.axisNumber);
+        request.setParamset(paramset);
+        request.setTuningParamsList(tuningParams.map(servo_tuning_param_1.ServoTuningParam.toProtobuf));
+        await gateway.callAsync('servotuning/set_raw', request);
+    }
+    /**
+     * 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.
+     */
+    async setPidTuning(paramset, p, i, d, fc) {
+        const request = new gateway.SetServoTuningPIDRequest();
+        request.setInterfaceId(this.axis.device.connection.interfaceId);
+        request.setDevice(this.axis.device.deviceAddress);
+        request.setAxis(this.axis.axisNumber);
+        request.setParamset(paramset);
+        request.setP(p);
+        request.setI(i);
+        request.setD(d);
+        request.setFc(fc);
+        const response = await gateway.callAsync('servotuning/set_pid', request, gateway.PidTuning);
+        return pid_tuning_1.PidTuning.fromProtobuf(response.toObject());
+    }
+    /**
+     * 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.
+     */
+    async getPidTuning(paramset) {
+        const request = new gateway.ServoTuningRequest();
+        request.setInterfaceId(this.axis.device.connection.interfaceId);
+        request.setDevice(this.axis.device.deviceAddress);
+        request.setAxis(this.axis.axisNumber);
+        request.setParamset(paramset);
+        const response = await gateway.callAsync('servotuning/get_pid', request, gateway.PidTuning);
+        return pid_tuning_1.PidTuning.fromProtobuf(response.toObject());
+    }
+    /**
+     * Gets the parameters that are required to tune this device.
+     * @return The tuning parameters.
+     */
+    async getSimpleTuningParamList() {
+        const request = new gateway.GetSimpleTuningParamListRequest();
+        request.setInterfaceId(this.axis.device.connection.interfaceId);
+        request.setDevice(this.axis.device.deviceAddress);
+        request.setAxis(this.axis.axisNumber);
+        const response = await gateway.callAsync('servotuning/get_simple_params', request, gateway.SimpleTuningParamList);
+        return response.toObject().paramsList.map(simple_tuning_param_1.SimpleTuningParam.fromProtobuf);
+    }
+    /**
+     * 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.
+     */
+    async setSimpleTuning(paramset, tuningParams, loadMass, carriageMass = -1.0) {
+        const request = new gateway.SetSimpleTuning();
+        request.setInterfaceId(this.axis.device.connection.interfaceId);
+        request.setDevice(this.axis.device.deviceAddress);
+        request.setAxis(this.axis.axisNumber);
+        request.setParamset(paramset);
+        request.setTuningParamsList(tuningParams.map(servo_tuning_param_1.ServoTuningParam.toProtobuf));
+        request.setLoadMass(loadMass);
+        request.setCarriageMass(carriageMass);
+        await gateway.callAsync('servotuning/set_simple_tuning', request);
+    }
+}
+exports.ServoTuner = ServoTuner;
+//# sourceMappingURL=servo_tuner.js.map

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

@@ -0,0 +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,+DAA0D;AAE1D;;GAEG;AACH,MAAa,UAAU;IASrB,YAAY,IAAU;QACpB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAVD;;OAEG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAOD;;;OAGG;IACI,KAAK,CAAC,kBAAkB;QAC7B,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;QAEtC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,6BAA6B,EAC7B,OAAO,EACP,OAAO,CAAC,eAAe,CAAC,CAAC;QAC3B,OAAO,QAAQ,CAAC,WAAW,EAAE,CAAC;IAChC,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,wBAAwB;QACnC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,+BAA+B,EAAE,CAAC;QAC9D,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,+BAA+B,EAC/B,OAAO,EACP,OAAO,CAAC,qBAAqB,CAAC,CAAC;QACjC,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,uCAAiB,CAAC,YAAY,CAAC,CAAC;IAC5E,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;CACF;AA3MD,gCA2MC","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 { SimpleTuningParam } from './simple_tuning_param';\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.GetStartupParamset();\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.StartupParamset>(\n      'servotuning/get_startup_set',\n      request,\n      gateway.StartupParamset);\n    return response.getParamset();\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 getSimpleTuningParamList(): Promise<SimpleTuningParam[]> {\n    const request = new gateway.GetSimpleTuningParamListRequest();\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.SimpleTuningParamList>(\n      'servotuning/get_simple_params',\n      request,\n      gateway.SimpleTuningParamList);\n    return response.toObject().paramsList.map(SimpleTuningParam.fromProtobuf);\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"]}

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

@@ -0,0 +1,16 @@
+/**
+ * A parameter used to establish the servo tuning of an axis.
+ */
+export interface ServoTuningParam {
+    /**
+     * The name of the parameter to set.
+     */
+    name: string;
+    /**
+     * The value to use for this parameter.
+     */
+    value: number;
+}
+export declare namespace ServoTuningParam {
+    const __type = "ServoTuningParam";
+}

package/dist/lib/ascii/servo_tuning_param.js

@@ -0,0 +1,49 @@
+"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.ServoTuningParam = void 0;
+const gateway = __importStar(require("../gateway"));
+var ServoTuningParam;
+(function (ServoTuningParam) {
+    ServoTuningParam.__type = 'ServoTuningParam';
+    /** @internal */
+    function fromProtobuf(pbData) {
+        return {
+            name: pbData.name,
+            value: pbData.value,
+        };
+    }
+    ServoTuningParam.fromProtobuf = fromProtobuf;
+    /** @internal */
+    function toProtobuf(source) {
+        const pbData = new gateway.ServoTuningParam();
+        if (source == null) {
+            return pbData;
+        }
+        pbData.setName(source.name);
+        pbData.setValue(source.value);
+        return pbData;
+    }
+    ServoTuningParam.toProtobuf = toProtobuf;
+})(ServoTuningParam = exports.ServoTuningParam || (exports.ServoTuningParam = {}));
+//# sourceMappingURL=servo_tuning_param.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"servo_tuning_param.js","sourceRoot":"","sources":["../../../src/ascii/servo_tuning_param.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;AAEtD,oDAAsC;AAkBtC,IAAiB,gBAAgB,CAqBhC;AArBD,WAAiB,gBAAgB;IAClB,uBAAM,GAAG,kBAAkB,CAAC;IAEzC,gBAAgB;IAChB,SAAgB,YAAY,CAAC,MAAyC;QACpE,OAAO;YACL,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,KAAK,EAAE,MAAM,CAAC,KAAK;SACpB,CAAC;IACJ,CAAC;IALe,6BAAY,eAK3B,CAAA;IACD,gBAAgB;IAChB,SAAgB,UAAU,CAAC,MAA2C;QACpE,MAAM,MAAM,GAAG,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;QAC9C,IAAI,MAAM,IAAI,IAAI,EAAE;YAClB,OAAO,MAAM,CAAC;SACf;QAED,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC5B,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC9B,OAAO,MAAM,CAAC;IAChB,CAAC;IATe,2BAAU,aASzB,CAAA;AACH,CAAC,EArBgB,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAqBhC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport * as gateway from '../gateway';\n\n/**\n * A parameter used to establish the servo tuning of an axis.\n */\nexport interface ServoTuningParam {\n  /**\n   * The name of the parameter to set.\n   */\n  name: string;\n\n  /**\n   * The value to use for this parameter.\n   */\n  value: number;\n\n}\n\nexport namespace ServoTuningParam {\n  export const __type = 'ServoTuningParam';\n\n  /** @internal */\n  export function fromProtobuf(pbData: gateway.ServoTuningParam.AsObject): ServoTuningParam {\n    return {\n      name: pbData.name,\n      value: pbData.value,\n    };\n  }\n  /** @internal */\n  export function toProtobuf(source: ServoTuningParam | null | undefined): gateway.ServoTuningParam {\n    const pbData = new gateway.ServoTuningParam();\n    if (source == null) {\n      return pbData;\n    }\n\n    pbData.setName(source.name);\n    pbData.setValue(source.value);\n    return pbData;\n  }\n}\n"]}

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

@@ -0,0 +1,17 @@
+/**
+ * Servo Tuning Parameter Set to target.
+ */
+export declare enum ServoTuningParamset {
+    LIVE = 0,
+    P_1 = 1,
+    P_2 = 2,
+    P_3 = 3,
+    P_4 = 4,
+    P_5 = 5,
+    P_6 = 6,
+    P_7 = 7,
+    P_8 = 8,
+    P_9 = 9,
+    STAGING = 10,
+    DEFAULT = 11
+}

package/dist/lib/ascii/servo_tuning_paramset.js

@@ -0,0 +1,24 @@
+"use strict";
+// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //
+// ============= DO NOT EDIT DIRECTLY ============= //
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServoTuningParamset = void 0;
+/**
+ * Servo Tuning Parameter Set to target.
+ */
+var ServoTuningParamset;
+(function (ServoTuningParamset) {
+    ServoTuningParamset[ServoTuningParamset["LIVE"] = 0] = "LIVE";
+    ServoTuningParamset[ServoTuningParamset["P_1"] = 1] = "P_1";
+    ServoTuningParamset[ServoTuningParamset["P_2"] = 2] = "P_2";
+    ServoTuningParamset[ServoTuningParamset["P_3"] = 3] = "P_3";
+    ServoTuningParamset[ServoTuningParamset["P_4"] = 4] = "P_4";
+    ServoTuningParamset[ServoTuningParamset["P_5"] = 5] = "P_5";
+    ServoTuningParamset[ServoTuningParamset["P_6"] = 6] = "P_6";
+    ServoTuningParamset[ServoTuningParamset["P_7"] = 7] = "P_7";
+    ServoTuningParamset[ServoTuningParamset["P_8"] = 8] = "P_8";
+    ServoTuningParamset[ServoTuningParamset["P_9"] = 9] = "P_9";
+    ServoTuningParamset[ServoTuningParamset["STAGING"] = 10] = "STAGING";
+    ServoTuningParamset[ServoTuningParamset["DEFAULT"] = 11] = "DEFAULT";
+})(ServoTuningParamset = exports.ServoTuningParamset || (exports.ServoTuningParamset = {}));
+//# sourceMappingURL=servo_tuning_paramset.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"servo_tuning_paramset.js","sourceRoot":"","sources":["../../../src/ascii/servo_tuning_paramset.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;AAEtD;;GAEG;AACH,IAAY,mBAaX;AAbD,WAAY,mBAAmB;IAC7B,6DAAQ,CAAA;IACR,2DAAO,CAAA;IACP,2DAAO,CAAA;IACP,2DAAO,CAAA;IACP,2DAAO,CAAA;IACP,2DAAO,CAAA;IACP,2DAAO,CAAA;IACP,2DAAO,CAAA;IACP,2DAAO,CAAA;IACP,2DAAO,CAAA;IACP,oEAAY,CAAA;IACZ,oEAAY,CAAA;AACd,CAAC,EAbW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAa9B","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\n/**\n * Servo Tuning Parameter Set to target.\n */\nexport enum ServoTuningParamset {\n  LIVE = 0,\n  P_1 = 1,\n  P_2 = 2,\n  P_3 = 3,\n  P_4 = 4,\n  P_5 = 5,\n  P_6 = 6,\n  P_7 = 7,\n  P_8 = 8,\n  P_9 = 9,\n  STAGING = 10,\n  DEFAULT = 11,\n}\n"]}

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

@@ -0,0 +1,24 @@
+/**
+ * Information about a parameter used for the simple tuning method.
+ */
+export interface SimpleTuningParam {
+    /**
+     * The name of the parameter.
+     */
+    name: string;
+    /**
+     * The human readable description of the effect of a lower value on this setting.
+     */
+    minLabel: string;
+    /**
+     * The human readable description of the effect of a higher value on this setting.
+     */
+    maxLabel: string;
+    /**
+     * How this parameter will be parsed by the tuner.
+     */
+    dataType: string;
+}
+export declare namespace SimpleTuningParam {
+    const __type = "SimpleTuningParam";
+}

package/dist/lib/ascii/simple_tuning_param.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"simple_tuning_param.js","sourceRoot":"","sources":["../../../src/ascii/simple_tuning_param.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;AA8BtD,IAAiB,iBAAiB,CAYjC;AAZD,WAAiB,iBAAiB;IACnB,wBAAM,GAAG,mBAAmB,CAAC;IAE1C,gBAAgB;IAChB,SAAgB,YAAY,CAAC,MAA0C;QACrE,OAAO;YACL,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ;SAC1B,CAAC;IACJ,CAAC;IAPe,8BAAY,eAO3B,CAAA;AACH,CAAC,EAZgB,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAYjC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport * as gateway from '../gateway';\n\n/**\n * Information about a parameter used for the simple tuning method.\n */\nexport interface SimpleTuningParam {\n  /**\n   * The name of the parameter.\n   */\n  name: string;\n\n  /**\n   * The human readable description of the effect of a lower value on this setting.\n   */\n  minLabel: string;\n\n  /**\n   * The human readable description of the effect of a higher value on this setting.\n   */\n  maxLabel: string;\n\n  /**\n   * How this parameter will be parsed by the tuner.\n   */\n  dataType: string;\n\n}\n\nexport namespace SimpleTuningParam {\n  export const __type = 'SimpleTuningParam';\n\n  /** @internal */\n  export function fromProtobuf(pbData: gateway.SimpleTuningParam.AsObject): SimpleTuningParam {\n    return {\n      name: pbData.name,\n      minLabel: pbData.minLabel,\n      maxLabel: pbData.maxLabel,\n      dataType: pbData.dataType,\n    };\n  }\n}\n"]}