@zaber/motion 2.15.3 → 3.0.0

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

@@ -11,19 +11,19 @@ export declare class AllAxes {
     constructor(device: Device);
     /**
      * Homes all axes. Axes return to their homing positions.
-     * @param waitUntilIdle Determines whether function should return after the movement is finished or just started.
+     * @param [options.waitUntilIdle=true] Determines whether function should return after the movement is finished or just started.
      */
-    home(waitUntilIdle?: boolean): Promise<void>;
+    home(options?: AllAxes.HomeOptions): Promise<void>;
     /**
      * Stops ongoing axes movement. Decelerates until zero speed.
-     * @param waitUntilIdle Determines whether function should return after the movement is finished or just started.
+     * @param [options.waitUntilIdle=true] Determines whether function should return after the movement is finished or just started.
      */
-    stop(waitUntilIdle?: boolean): Promise<void>;
+    stop(options?: AllAxes.StopOptions): Promise<void>;
     /**
      * Waits until all axes of device stop moving.
-     * @param throwErrorOnFault Determines whether to throw error when fault is observed.
+     * @param [options.throwErrorOnFault=true] Determines whether to throw error when fault is observed.
      */
-    waitUntilIdle(throwErrorOnFault?: boolean): Promise<void>;
+    waitUntilIdle(options?: AllAxes.WaitUntilIdleOptions): Promise<void>;
     /**
      * Parks the device in anticipation of turning the power off.
      * It can later be powered on, unparked, and moved without first having to home it.
@@ -35,17 +35,29 @@ export declare class AllAxes {
     unpark(): Promise<void>;
     /**
      * Returns bool indicating whether any axis is executing a motion command.
-     * @return True if any axis is currently executing a motion command.
+     * @returns True if any axis is currently executing a motion command.
      */
     isBusy(): Promise<boolean>;
     /**
      * Returns bool indicating whether all axes have position reference and were homed.
-     * @return True if all axes have position reference and were homed.
+     * @returns True if all axes have position reference and were homed.
      */
     isHomed(): Promise<boolean>;
     /**
      * Returns a string that represents the axes.
-     * @return A string that represents the axes.
+     * @returns A string that represents the axes.
      */
     toString(): string;
 }
+declare namespace AllAxes {
+    interface HomeOptions {
+        waitUntilIdle?: boolean;
+    }
+    interface StopOptions {
+        waitUntilIdle?: boolean;
+    }
+    interface WaitUntilIdleOptions {
+        throwErrorOnFault?: boolean;
+    }
+}
+export {};

package/dist/lib/ascii/all_axes.js

@@ -42,9 +42,10 @@ class AllAxes {
     }
     /**
      * Homes all axes. Axes return to their homing positions.
-     * @param waitUntilIdle Determines whether function should return after the movement is finished or just started.
+     * @param [options.waitUntilIdle=true] Determines whether function should return after the movement is finished or just started.
      */
-    async home(waitUntilIdle = true) {
+    async home(options = {}) {
+        const { waitUntilIdle = true, } = options;
         const request = new gateway.DeviceHomeRequest();
         request.setInterfaceId(this.device.connection.interfaceId);
         request.setDevice(this.device.deviceAddress);
@@ -54,9 +55,10 @@ class AllAxes {
     }
     /**
      * Stops ongoing axes movement. Decelerates until zero speed.
-     * @param waitUntilIdle Determines whether function should return after the movement is finished or just started.
+     * @param [options.waitUntilIdle=true] Determines whether function should return after the movement is finished or just started.
      */
-    async stop(waitUntilIdle = true) {
+    async stop(options = {}) {
+        const { waitUntilIdle = true, } = options;
         const request = new gateway.DeviceStopRequest();
         request.setInterfaceId(this.device.connection.interfaceId);
         request.setDevice(this.device.deviceAddress);
@@ -66,9 +68,10 @@ class AllAxes {
     }
     /**
      * Waits until all axes of device stop moving.
-     * @param throwErrorOnFault Determines whether to throw error when fault is observed.
+     * @param [options.throwErrorOnFault=true] Determines whether to throw error when fault is observed.
      */
-    async waitUntilIdle(throwErrorOnFault = true) {
+    async waitUntilIdle(options = {}) {
+        const { throwErrorOnFault = true, } = options;
         const request = new gateway.DeviceWaitUntilIdleRequest();
         request.setInterfaceId(this.device.connection.interfaceId);
         request.setDevice(this.device.deviceAddress);
@@ -99,7 +102,7 @@ class AllAxes {
     }
     /**
      * Returns bool indicating whether any axis is executing a motion command.
-     * @return True if any axis is currently executing a motion command.
+     * @returns True if any axis is currently executing a motion command.
      */
     async isBusy() {
         const request = new gateway.AxisEmptyRequest();
@@ -111,7 +114,7 @@ class AllAxes {
     }
     /**
      * Returns bool indicating whether all axes have position reference and were homed.
-     * @return True if all axes have position reference and were homed.
+     * @returns True if all axes have position reference and were homed.
      */
     async isHomed() {
         const request = new gateway.AxisEmptyRequest();
@@ -123,7 +126,7 @@ class AllAxes {
     }
     /**
      * Returns a string that represents the axes.
-     * @return A string that represents the axes.
+     * @returns A string that represents the axes.
      */
     toString() {
         const request = new gateway.AxisEmptyRequest();

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

@@ -1 +1 @@
-{"version":3,"file":"all_axes.js","sourceRoot":"","sources":["../../../src/ascii/all_axes.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;;;;;AAGtD,oDAAsC;AAEtC;;GAEG;AACH,MAAa,OAAO;IAClB;;OAEG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAGD,YAAY,MAAc;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,IAAI,CACf,gBAAyB,IAAI;QAE7B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,iBAAiB,EAAE,CAAC;QAChD,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,CAAC,CAAC,CAAC;QACnB,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAExC,MAAM,OAAO,CAAC,SAAS,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,IAAI,CACf,gBAAyB,IAAI;QAE7B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,iBAAiB,EAAE,CAAC;QAChD,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,CAAC,CAAC,CAAC;QACnB,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAExC,MAAM,OAAO,CAAC,SAAS,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,aAAa,CACxB,oBAA6B,IAAI;QAEjC,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,OAAO,CAAC,CAAC,CAAC,CAAC;QACnB,OAAO,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;QAEhD,MAAM,OAAO,CAAC,SAAS,CAAC,wBAAwB,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,IAAI;QACf,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;QAC/C,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,CAAC,CAAC,CAAC;QAEnB,MAAM,OAAO,CAAC,SAAS,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,MAAM;QACjB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;QAC/C,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,CAAC,CAAC,CAAC;QAEnB,MAAM,OAAO,CAAC,SAAS,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,MAAM;QACjB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;QAC/C,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,CAAC,CAAC,CAAC;QAEnB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,gBAAgB,EAChB,OAAO,EACP,OAAO,CAAC,YAAY,CAAC,CAAC;QACxB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,OAAO;QAClB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;QAC/C,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,CAAC,CAAC,CAAC;QAEnB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,iBAAiB,EACjB,OAAO,EACP,OAAO,CAAC,YAAY,CAAC,CAAC;QACxB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,QAAQ;QACb,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;QAC/C,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,CAAC,CAAC,CAAC;QAEnB,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,2BAA2B,EAC3B,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;CACF;AAxID,0BAwIC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport { Device } from './device';\nimport * as gateway from '../gateway';\n\n/**\n * Represents all axes of motion associated with a device.\n */\nexport class AllAxes {\n  /**\n   * Device that controls this axis.\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   * Homes all axes. Axes return to their homing positions.\n   * @param waitUntilIdle Determines whether function should return after the movement is finished or just started.\n   */\n  public async home(\n    waitUntilIdle: boolean = true\n  ): Promise<void> {\n    const request = new gateway.DeviceHomeRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setAxis(0);\n    request.setWaitUntilIdle(waitUntilIdle);\n\n    await gateway.callAsync('device/home', request);\n  }\n\n  /**\n   * Stops ongoing axes movement. Decelerates until zero speed.\n   * @param waitUntilIdle Determines whether function should return after the movement is finished or just started.\n   */\n  public async stop(\n    waitUntilIdle: boolean = true\n  ): Promise<void> {\n    const request = new gateway.DeviceStopRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setAxis(0);\n    request.setWaitUntilIdle(waitUntilIdle);\n\n    await gateway.callAsync('device/stop', request);\n  }\n\n  /**\n   * Waits until all axes of device stop moving.\n   * @param throwErrorOnFault Determines whether to throw error when fault is observed.\n   */\n  public async waitUntilIdle(\n    throwErrorOnFault: boolean = true\n  ): Promise<void> {\n    const request = new gateway.DeviceWaitUntilIdleRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setAxis(0);\n    request.setThrowErrorOnFault(throwErrorOnFault);\n\n    await gateway.callAsync('device/wait_until_idle', request);\n  }\n\n  /**\n   * Parks the device in anticipation of turning the power off.\n   * It can later be powered on, unparked, and moved without first having to home it.\n   */\n  public async park(): Promise<void> {\n    const request = new gateway.AxisEmptyRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setAxis(0);\n\n    await gateway.callAsync('device/park', request);\n  }\n\n  /**\n   * Unparks the device. The device will now be able to move.\n   */\n  public async unpark(): Promise<void> {\n    const request = new gateway.AxisEmptyRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setAxis(0);\n\n    await gateway.callAsync('device/unpark', request);\n  }\n\n  /**\n   * Returns bool indicating whether any axis is executing a motion command.\n   * @return True if any axis is currently executing a motion command.\n   */\n  public async isBusy(): Promise<boolean> {\n    const request = new gateway.AxisEmptyRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setAxis(0);\n\n    const response = await gateway.callAsync<gateway.BoolResponse>(\n      'device/is_busy',\n      request,\n      gateway.BoolResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Returns bool indicating whether all axes have position reference and were homed.\n   * @return True if all axes have position reference and were homed.\n   */\n  public async isHomed(): Promise<boolean> {\n    const request = new gateway.AxisEmptyRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setAxis(0);\n\n    const response = await gateway.callAsync<gateway.BoolResponse>(\n      'device/is_homed',\n      request,\n      gateway.BoolResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Returns a string that represents the axes.\n   * @return A string that represents the axes.\n   */\n  public toString(): string {\n    const request = new gateway.AxisEmptyRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setAxis(0);\n\n    const response = gateway.callSync<gateway.StringResponse>(\n      'device/all_axes_to_string',\n      request,\n      gateway.StringResponse);\n    return response.getValue();\n  }\n}\n"]}
+{"version":3,"file":"all_axes.js","sourceRoot":"","sources":["../../../src/ascii/all_axes.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;;;;;AAGtD,oDAAsC;AAEtC;;GAEG;AACH,MAAa,OAAO;IAClB;;OAEG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAGD,YAAY,MAAc;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,IAAI,CACf,UAA+B,EAAE;QAEjC,MAAM,EACJ,aAAa,GAAG,IAAI,GACrB,GAAG,OAAO,CAAC;QACZ,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,iBAAiB,EAAE,CAAC;QAChD,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,CAAC,CAAC,CAAC;QACnB,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAExC,MAAM,OAAO,CAAC,SAAS,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,IAAI,CACf,UAA+B,EAAE;QAEjC,MAAM,EACJ,aAAa,GAAG,IAAI,GACrB,GAAG,OAAO,CAAC;QACZ,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,iBAAiB,EAAE,CAAC;QAChD,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,CAAC,CAAC,CAAC;QACnB,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAExC,MAAM,OAAO,CAAC,SAAS,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,aAAa,CACxB,UAAwC,EAAE;QAE1C,MAAM,EACJ,iBAAiB,GAAG,IAAI,GACzB,GAAG,OAAO,CAAC;QACZ,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,OAAO,CAAC,CAAC,CAAC,CAAC;QACnB,OAAO,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;QAEhD,MAAM,OAAO,CAAC,SAAS,CAAC,wBAAwB,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,IAAI;QACf,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;QAC/C,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,CAAC,CAAC,CAAC;QAEnB,MAAM,OAAO,CAAC,SAAS,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,MAAM;QACjB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;QAC/C,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,CAAC,CAAC,CAAC;QAEnB,MAAM,OAAO,CAAC,SAAS,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,MAAM;QACjB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;QAC/C,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,CAAC,CAAC,CAAC;QAEnB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,gBAAgB,EAChB,OAAO,EACP,OAAO,CAAC,YAAY,CAAC,CAAC;QACxB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,OAAO;QAClB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;QAC/C,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,CAAC,CAAC,CAAC;QAEnB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,iBAAiB,EACjB,OAAO,EACP,OAAO,CAAC,YAAY,CAAC,CAAC;QACxB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,QAAQ;QACb,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;QAC/C,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,CAAC,CAAC,CAAC;QAEnB,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,2BAA2B,EAC3B,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;CACF;AAjJD,0BAiJC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport { Device } from './device';\nimport * as gateway from '../gateway';\n\n/**\n * Represents all axes of motion associated with a device.\n */\nexport class AllAxes {\n  /**\n   * Device that controls this axis.\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   * Homes all axes. Axes return to their homing positions.\n   * @param [options.waitUntilIdle=true] Determines whether function should return after the movement is finished or just started.\n   */\n  public async home(\n    options: AllAxes.HomeOptions = {}\n  ): Promise<void> {\n    const {\n      waitUntilIdle = true,\n    } = options;\n    const request = new gateway.DeviceHomeRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setAxis(0);\n    request.setWaitUntilIdle(waitUntilIdle);\n\n    await gateway.callAsync('device/home', request);\n  }\n\n  /**\n   * Stops ongoing axes movement. Decelerates until zero speed.\n   * @param [options.waitUntilIdle=true] Determines whether function should return after the movement is finished or just started.\n   */\n  public async stop(\n    options: AllAxes.StopOptions = {}\n  ): Promise<void> {\n    const {\n      waitUntilIdle = true,\n    } = options;\n    const request = new gateway.DeviceStopRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setAxis(0);\n    request.setWaitUntilIdle(waitUntilIdle);\n\n    await gateway.callAsync('device/stop', request);\n  }\n\n  /**\n   * Waits until all axes of device stop moving.\n   * @param [options.throwErrorOnFault=true] Determines whether to throw error when fault is observed.\n   */\n  public async waitUntilIdle(\n    options: AllAxes.WaitUntilIdleOptions = {}\n  ): Promise<void> {\n    const {\n      throwErrorOnFault = true,\n    } = options;\n    const request = new gateway.DeviceWaitUntilIdleRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setAxis(0);\n    request.setThrowErrorOnFault(throwErrorOnFault);\n\n    await gateway.callAsync('device/wait_until_idle', request);\n  }\n\n  /**\n   * Parks the device in anticipation of turning the power off.\n   * It can later be powered on, unparked, and moved without first having to home it.\n   */\n  public async park(): Promise<void> {\n    const request = new gateway.AxisEmptyRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setAxis(0);\n\n    await gateway.callAsync('device/park', request);\n  }\n\n  /**\n   * Unparks the device. The device will now be able to move.\n   */\n  public async unpark(): Promise<void> {\n    const request = new gateway.AxisEmptyRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setAxis(0);\n\n    await gateway.callAsync('device/unpark', request);\n  }\n\n  /**\n   * Returns bool indicating whether any axis is executing a motion command.\n   * @returns True if any axis is currently executing a motion command.\n   */\n  public async isBusy(): Promise<boolean> {\n    const request = new gateway.AxisEmptyRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setAxis(0);\n\n    const response = await gateway.callAsync<gateway.BoolResponse>(\n      'device/is_busy',\n      request,\n      gateway.BoolResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Returns bool indicating whether all axes have position reference and were homed.\n   * @returns True if all axes have position reference and were homed.\n   */\n  public async isHomed(): Promise<boolean> {\n    const request = new gateway.AxisEmptyRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setAxis(0);\n\n    const response = await gateway.callAsync<gateway.BoolResponse>(\n      'device/is_homed',\n      request,\n      gateway.BoolResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Returns a string that represents the axes.\n   * @returns A string that represents the axes.\n   */\n  public toString(): string {\n    const request = new gateway.AxisEmptyRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setAxis(0);\n\n    const response = gateway.callSync<gateway.StringResponse>(\n      'device/all_axes_to_string',\n      request,\n      gateway.StringResponse);\n    return response.getValue();\n  }\n}\n\nnamespace AllAxes {\n  export interface HomeOptions {\n      waitUntilIdle?: boolean;\n  }\n  export interface StopOptions {\n      waitUntilIdle?: boolean;\n  }\n  export interface WaitUntilIdleOptions {\n      throwErrorOnFault?: boolean;\n  }\n}\n"]}

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

@@ -29,6 +29,7 @@ export declare class Axis {
     private _settings;
     /**
      * Key-value storage of this axis.
+     * Requires at least Firmware 7.30.
      */
     get storage(): AxisStorage;
     private _storage;
@@ -60,14 +61,14 @@ export declare class Axis {
     constructor(device: Device, axisNumber: number);
     /**
      * Homes axis. Axis returns to its homing position.
-     * @param waitUntilIdle Determines whether function should return after the movement is finished or just started.
+     * @param [options.waitUntilIdle=true] Determines whether function should return after the movement is finished or just started.
      */
-    home(waitUntilIdle?: boolean): Promise<void>;
+    home(options?: Axis.HomeOptions): Promise<void>;
     /**
      * Stops ongoing axis movement. Decelerates until zero speed.
-     * @param waitUntilIdle Determines whether function should return after the movement is finished or just started.
+     * @param [options.waitUntilIdle=true] Determines whether function should return after the movement is finished or just started.
      */
-    stop(waitUntilIdle?: boolean): Promise<void>;
+    stop(options?: Axis.StopOptions): Promise<void>;
     /**
      * Parks the axis in anticipation of turning the power off.
      * It can later be powered on, unparked, and moved without first having to home it.
@@ -79,112 +80,117 @@ export declare class Axis {
     unpark(): Promise<void>;
     /**
      * Returns bool indicating whether the axis is parked or not.
-     * @return True if the axis is currently parked. False otherwise.
+     * @returns True if the axis is currently parked. False otherwise.
      */
     isParked(): Promise<boolean>;
     /**
      * Waits until axis stops moving.
-     * @param throwErrorOnFault Determines whether to throw error when fault is observed.
+     * @param [options.throwErrorOnFault=true] Determines whether to throw error when fault is observed.
      */
-    waitUntilIdle(throwErrorOnFault?: boolean): Promise<void>;
+    waitUntilIdle(options?: Axis.WaitUntilIdleOptions): Promise<void>;
     /**
      * Returns bool indicating whether the axis is executing a motion command.
-     * @return True if the axis is currently executing a motion command.
+     * @returns True if the axis is currently executing a motion command.
      */
     isBusy(): Promise<boolean>;
     /**
      * Returns bool indicating whether the axis has position reference and was homed.
-     * @return True if the axis has position reference and was homed.
+     * @returns True if the axis has position reference and was homed.
      */
     isHomed(): Promise<boolean>;
     /**
      * Move axis to absolute position.
      * @param position Absolute position.
-     * @param unit Units of position.
-     * @param waitUntilIdle Determines whether function should return after the movement is finished or just started.
-     * @param velocity Movement velocity.
+     * @param [unit=Units.NATIVE] Units of position.
+     * @param [options.waitUntilIdle=true] Determines whether function should return after the movement is finished or just started.
+     * @param [options.velocity=0] Movement velocity.
      * Default value of 0 indicates that the maxspeed setting is used instead.
-     * @param velocityUnit Units of velocity.
-     * @param acceleration Movement acceleration.
+     * Requires at least Firmware 7.25.
+     * @param [options.velocityUnit=Units.NATIVE] Units of velocity.
+     * @param [options.acceleration=0] Movement acceleration.
      * Default value of 0 indicates that the accel setting is used instead.
-     * If you provide acceleration, you must provide velocity as well.
-     * @param accelerationUnit Units of acceleration.
+     * Requires at least Firmware 7.25.
+     * @param [options.accelerationUnit=Units.NATIVE] Units of acceleration.
      */
-    moveAbsolute(position: number, unit?: Length | Angle | Native, waitUntilIdle?: boolean, velocity?: number, velocityUnit?: Velocity | AngularVelocity | Native, acceleration?: number, accelerationUnit?: Acceleration | AngularAcceleration | Native): Promise<void>;
+    moveAbsolute(position: number, unit?: Length | Angle | Native, options?: Axis.MoveAbsoluteOptions): Promise<void>;
     /**
      * Moves the axis to the maximum position as specified by limit.max.
-     * @param waitUntilIdle Determines whether function should return after the movement is finished or just started.
-     * @param velocity Movement velocity.
+     * @param [options.waitUntilIdle=true] Determines whether function should return after the movement is finished or just started.
+     * @param [options.velocity=0] Movement velocity.
      * Default value of 0 indicates that the maxspeed setting is used instead.
-     * @param velocityUnit Units of velocity.
-     * @param acceleration Movement acceleration.
+     * Requires at least Firmware 7.25.
+     * @param [options.velocityUnit=Units.NATIVE] Units of velocity.
+     * @param [options.acceleration=0] Movement acceleration.
      * Default value of 0 indicates that the accel setting is used instead.
-     * If you provide acceleration, you must provide velocity as well.
-     * @param accelerationUnit Units of acceleration.
+     * Requires at least Firmware 7.25.
+     * @param [options.accelerationUnit=Units.NATIVE] Units of acceleration.
      */
-    moveMax(waitUntilIdle?: boolean, velocity?: number, velocityUnit?: Velocity | AngularVelocity | Native, acceleration?: number, accelerationUnit?: Acceleration | AngularAcceleration | Native): Promise<void>;
+    moveMax(options?: Axis.MoveMaxOptions): Promise<void>;
     /**
      * Moves the axis to the minimum position as specified by limit.min.
-     * @param waitUntilIdle Determines whether function should return after the movement is finished or just started.
-     * @param velocity Movement velocity.
+     * @param [options.waitUntilIdle=true] Determines whether function should return after the movement is finished or just started.
+     * @param [options.velocity=0] Movement velocity.
      * Default value of 0 indicates that the maxspeed setting is used instead.
-     * @param velocityUnit Units of velocity.
-     * @param acceleration Movement acceleration.
+     * Requires at least Firmware 7.25.
+     * @param [options.velocityUnit=Units.NATIVE] Units of velocity.
+     * @param [options.acceleration=0] Movement acceleration.
      * Default value of 0 indicates that the accel setting is used instead.
-     * If you provide acceleration, you must provide velocity as well.
-     * @param accelerationUnit Units of acceleration.
+     * Requires at least Firmware 7.25.
+     * @param [options.accelerationUnit=Units.NATIVE] Units of acceleration.
      */
-    moveMin(waitUntilIdle?: boolean, velocity?: number, velocityUnit?: Velocity | AngularVelocity | Native, acceleration?: number, accelerationUnit?: Acceleration | AngularAcceleration | Native): Promise<void>;
+    moveMin(options?: Axis.MoveMinOptions): Promise<void>;
     /**
      * Move axis to position relative to current position.
      * @param position Relative position.
-     * @param unit Units of position.
-     * @param waitUntilIdle Determines whether function should return after the movement is finished or just started.
-     * @param velocity Movement velocity.
+     * @param [unit=Units.NATIVE] Units of position.
+     * @param [options.waitUntilIdle=true] Determines whether function should return after the movement is finished or just started.
+     * @param [options.velocity=0] Movement velocity.
      * Default value of 0 indicates that the maxspeed setting is used instead.
-     * @param velocityUnit Units of velocity.
-     * @param acceleration Movement acceleration.
+     * Requires at least Firmware 7.25.
+     * @param [options.velocityUnit=Units.NATIVE] Units of velocity.
+     * @param [options.acceleration=0] Movement acceleration.
      * Default value of 0 indicates that the accel setting is used instead.
-     * If you provide acceleration, you must provide velocity as well.
-     * @param accelerationUnit Units of acceleration.
+     * Requires at least Firmware 7.25.
+     * @param [options.accelerationUnit=Units.NATIVE] Units of acceleration.
      */
-    moveRelative(position: number, unit?: Length | Angle | Native, waitUntilIdle?: boolean, velocity?: number, velocityUnit?: Velocity | AngularVelocity | Native, acceleration?: number, accelerationUnit?: Acceleration | AngularAcceleration | Native): Promise<void>;
+    moveRelative(position: number, unit?: Length | Angle | Native, options?: Axis.MoveRelativeOptions): Promise<void>;
     /**
      * Begins to move axis at specified speed.
      * @param velocity Movement velocity.
-     * @param unit Units of velocity.
-     * @param acceleration Movement acceleration.
+     * @param [unit=Units.NATIVE] Units of velocity.
+     * @param [options.acceleration=0] Movement acceleration.
      * Default value of 0 indicates that the accel setting is used instead.
-     * @param accelerationUnit Units of acceleration.
+     * Requires at least Firmware 7.25.
+     * @param [options.accelerationUnit=Units.NATIVE] Units of acceleration.
      */
-    moveVelocity(velocity: number, unit?: Velocity | AngularVelocity | Native, acceleration?: number, accelerationUnit?: Acceleration | AngularAcceleration | Native): Promise<void>;
+    moveVelocity(velocity: number, unit?: Velocity | AngularVelocity | Native, options?: Axis.MoveVelocityOptions): Promise<void>;
     /**
      * Returns current axis position.
-     * @param unit Units of position.
-     * @return Axis position.
+     * @param [unit=Units.NATIVE] Units of position.
+     * @returns Axis position.
      */
     getPosition(unit?: Length | Angle | Native): Promise<number>;
     /**
      * Sends a generic ASCII command to this axis.
      * For more information refer to: [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).
      * @param command Command and its parameters.
-     * @param checkErrors Controls whether to throw an exception when the device rejects the command.
-     * @param timeout The timeout, in milliseconds, for a device to respond to the command.
+     * @param [options.checkErrors=true] Controls whether to throw an exception when the device rejects the command.
+     * @param [options.timeout=0] The timeout, in milliseconds, for a device to respond to the command.
      * Overrides the connection default request timeout.
-     * @return A response to the command.
+     * @returns A response to the command.
      */
-    genericCommand(command: string, checkErrors?: boolean, timeout?: number): Promise<Response>;
+    genericCommand(command: string, options?: Axis.GenericCommandOptions): Promise<Response>;
     /**
      * Sends a generic ASCII command to this axis and expect multiple responses.
      * Responses are returned in order of arrival.
      * For more information refer to: [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).
      * @param command Command and its parameters.
-     * @param checkErrors Controls whether to throw an exception when a device rejects the command.
-     * @param timeout The timeout, in milliseconds, for a device to respond to the command.
+     * @param [options.checkErrors=true] Controls whether to throw an exception when a device rejects the command.
+     * @param [options.timeout=0] The timeout, in milliseconds, for a device to respond to the command.
      * Overrides the connection default request timeout.
-     * @return All responses to the command.
+     * @returns All responses to the command.
      */
-    genericCommandMultiResponse(command: string, checkErrors?: boolean, timeout?: number): Promise<Response[]>;
+    genericCommandMultiResponse(command: string, options?: Axis.GenericCommandMultiResponseOptions): Promise<Response[]>;
     /**
      * Sends a generic ASCII command to this axis without expecting a response and without adding a message ID
      * For more information refer to: [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).
@@ -198,17 +204,17 @@ export declare class Axis {
      * For more information refer to: [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).
      * @param commandTemplate Template of a command to prepare. Parameters are denoted by question marks.
      * @param parameters Variable number of command parameters.
-     * @return Command with converted parameters.
+     * @returns Command with converted parameters.
      */
     prepareCommand(commandTemplate: string, ...parameters: Measurement[]): string;
     /**
      * Returns a string that represents the axis.
-     * @return A string that represents the axis.
+     * @returns A string that represents the axis.
      */
     toString(): string;
     /**
      * Returns a serialization of the current axis state that can be saved and reapplied.
-     * @return A serialization of the current state of the axis.
+     * @returns A serialization of the current state of the axis.
      */
     getState(): Promise<string>;
     /**
@@ -221,12 +227,64 @@ export declare class Axis {
      * This only covers exceptions that can be determined statically such as mismatches of ID or version,
      * the process of applying the state can still fail when running.
      * @param state The state object to check against.
-     * @return An explanation of why this state cannot be set to this axis.
+     * @returns An explanation of why this state cannot be set to this axis.
      */
     canSetState(state: string): Promise<string>;
     /**
      * Returns identity.
-     * @return Axis identity.
+     * @returns Axis identity.
      */
     private _retrieveIdentity;
 }
+declare namespace Axis {
+    interface HomeOptions {
+        waitUntilIdle?: boolean;
+    }
+    interface StopOptions {
+        waitUntilIdle?: boolean;
+    }
+    interface WaitUntilIdleOptions {
+        throwErrorOnFault?: boolean;
+    }
+    interface MoveAbsoluteOptions {
+        waitUntilIdle?: boolean;
+        velocity?: number;
+        velocityUnit?: Velocity | AngularVelocity | Native;
+        acceleration?: number;
+        accelerationUnit?: Acceleration | AngularAcceleration | Native;
+    }
+    interface MoveMaxOptions {
+        waitUntilIdle?: boolean;
+        velocity?: number;
+        velocityUnit?: Velocity | AngularVelocity | Native;
+        acceleration?: number;
+        accelerationUnit?: Acceleration | AngularAcceleration | Native;
+    }
+    interface MoveMinOptions {
+        waitUntilIdle?: boolean;
+        velocity?: number;
+        velocityUnit?: Velocity | AngularVelocity | Native;
+        acceleration?: number;
+        accelerationUnit?: Acceleration | AngularAcceleration | Native;
+    }
+    interface MoveRelativeOptions {
+        waitUntilIdle?: boolean;
+        velocity?: number;
+        velocityUnit?: Velocity | AngularVelocity | Native;
+        acceleration?: number;
+        accelerationUnit?: Acceleration | AngularAcceleration | Native;
+    }
+    interface MoveVelocityOptions {
+        acceleration?: number;
+        accelerationUnit?: Acceleration | AngularAcceleration | Native;
+    }
+    interface GenericCommandOptions {
+        checkErrors?: boolean;
+        timeout?: number;
+    }
+    interface GenericCommandMultiResponseOptions {
+        checkErrors?: boolean;
+        timeout?: number;
+    }
+}
+export {};