@zaber/motion 7.2.2 → 7.3.0

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

@@ -15,6 +15,7 @@ import { FirmwareVersion } from '../firmware_version';
 import { DeviceStorage } from './storage';
 import { Triggers } from './triggers';
 import { Streams } from './streams';
+import { SetStateDeviceResponse } from './set_state_device_response';
 /**
  * Represents the controller part of one device - may be either a standalone controller or an integrated controller.
  */
@@ -209,8 +210,9 @@ export declare class Device {
      * Applies a saved state to this device.
      * @param state The state object to apply to this device.
      * @param [options.deviceOnly=false] If true, only device scope settings and features will be set.
+     * @returns Reports of any issues that were handled, but caused the state to not be exactly restored.
      */
-    setState(state: string, options?: Device.SetStateOptions): Promise<void>;
+    setState(state: string, options?: Device.SetStateOptions): Promise<SetStateDeviceResponse>;
     /**
      * Checks if a state can be applied to this device.
      * This only covers exceptions that can be determined statically such as mismatches of ID or version,
@@ -247,22 +249,54 @@ export declare class Device {
 }
 declare namespace Device {
     interface IdentifyOptions {
+        /**
+         * The identification assumes the specified firmware version
+         * instead of the version queried from the device.
+         * Providing this argument can lead to unexpected compatibility issues.
+         */
         assumeVersion?: FirmwareVersion;
     }
     interface GenericCommandOptions {
+        /**
+         * Optional axis number to send the command to.
+         */
         axis?: number;
+        /**
+         * Controls whether to throw an exception when the device rejects the command.
+         */
         checkErrors?: boolean;
+        /**
+         * The timeout, in milliseconds, for a device to respond to the command.
+         * Overrides the connection default request timeout.
+         */
         timeout?: number;
     }
     interface GenericCommandMultiResponseOptions {
+        /**
+         * Optional axis number to send the command to.
+         */
         axis?: number;
+        /**
+         * Controls whether to throw an exception when a device rejects the command.
+         */
         checkErrors?: boolean;
+        /**
+         * The timeout, in milliseconds, for a device to respond to the command.
+         * Overrides the connection default request timeout.
+         */
         timeout?: number;
     }
     interface GenericCommandNoResponseOptions {
+        /**
+         * Optional axis number to send the command to.
+         * Specifying -1 omits the number completely.
+         */
         axis?: number;
     }
     interface SetStateOptions {
+        /**
+         * If true, only device scope settings and features will be set.
+         */
         deviceOnly?: boolean;
     }
 }

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

@@ -1 +1 @@
-{"version":3,"file":"device.d.ts","sourceRoot":"","sources":["../../../src/ascii/device.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,yBAAyB,EAAE,MAAM,iCAAiC,CAAC;AAC5E,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAC5B,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAGtD,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC;;GAEG;AACH,qBAAa,MAAM;IACjB;;OAEG;IACH,IAAW,UAAU,IAAI,UAAU,CAElC;IACD,OAAO,CAAC,WAAW,CAAa;IAEhC;;;OAGG;IACH,IAAW,aAAa,IAAI,MAAM,CAEjC;IACD,OAAO,CAAC,cAAc,CAAS;IAE/B;;OAEG;IACH,IAAW,QAAQ,IAAI,cAAc,CAEpC;IACD,OAAO,CAAC,SAAS,CAAiB;IAElC;;OAEG;IACH,IAAW,OAAO,IAAI,aAAa,CAElC;IACD,OAAO,CAAC,QAAQ,CAAgB;IAEhC;;OAEG;IACH,IAAW,EAAE,IAAI,QAAQ,CAExB;IACD,OAAO,CAAC,GAAG,CAAW;IAEtB;;OAEG;IACH,IAAW,OAAO,IAAI,OAAO,CAE5B;IACD,OAAO,CAAC,QAAQ,CAAU;IAE1B;;OAEG;IACH,IAAW,QAAQ,IAAI,QAAQ,CAE9B;IACD,OAAO,CAAC,SAAS,CAAW;IAE5B;;OAEG;IACH,IAAW,QAAQ,IAAI,cAAc,CAEpC;IAED;;OAEG;IACH,IAAW,YAAY,IAAI,OAAO,CAEjC;IAED;;;OAGG;IACH,IAAW,YAAY,IAAI,YAAY,CAEtC;IACD,OAAO,CAAC,aAAa,CAAe;IAEpC;;OAEG;IACH,IAAW,QAAQ,IAAI,MAAM,CAE5B;IAED;;OAEG;IACH,IAAW,YAAY,IAAI,MAAM,CAEhC;IAED;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;OAEG;IACH,IAAW,SAAS,IAAI,MAAM,CAE7B;IAED;;OAEG;IACH,IAAW,eAAe,IAAI,eAAe,CAE5C;IAED;;OAEG;IACH,IAAW,YAAY,IAAI,OAAO,CAEjC;IAED;;OAEG;IACH,IAAW,KAAK,IAAI,MAAM,CAEzB;IAED;;;OAGG;IACH,IAAW,QAAQ,IAAI,QAAQ,CAE9B;IACD,OAAO,CAAC,SAAS,CAAW;IAE5B;;;OAGG;IACH,IAAW,OAAO,IAAI,OAAO,CAE5B;IACD,OAAO,CAAC,QAAQ,CAAU;IAE1B;;;;;OAKG;IACH,IAAW,GAAG,IAAI,GAAG,CAEpB;IACD,OAAO,CAAC,IAAI,CAAM;gBAEN,UAAU,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM;IAczD;;;;;;;;OAQG;IACU,QAAQ,CACnB,OAAO,GAAE,MAAM,CAAC,eAAoB,GACnC,OAAO,CAAC,cAAc,CAAC;IAqB1B;;;;;;;;;OASG;IACU,cAAc,CACzB,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,MAAM,CAAC,qBAA0B,GACzC,OAAO,CAAC,QAAQ,CAAC;IA0BpB;;;;;;;;;;OAUG;IACU,2BAA2B,CACtC,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,MAAM,CAAC,kCAAuC,GACtD,OAAO,CAAC,QAAQ,EAAE,CAAC;IA0BtB;;;;;;OAMG;IACU,wBAAwB,CACnC,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,MAAM,CAAC,+BAAoC,GACnD,OAAO,CAAC,IAAI,CAAC;IAkBhB;;;;;OAKG;IACI,OAAO,CACZ,UAAU,EAAE,MAAM,GACjB,IAAI;IAOP;;;;;OAKG;IACI,WAAW,CAChB,eAAe,EAAE,MAAM,GACtB,QAAQ;IAOX;;;;;;;;;OASG;IACI,cAAc,CACnB,eAAe,EAAE,MAAM,EACvB,GAAG,UAAU,EAAE,WAAW,EAAE,GAC3B,MAAM;IAmBT;;;;OAIG;IACU,QAAQ,CACnB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,IAAI,CAAC;IAchB;;;OAGG;IACH,OAAO,CAAC,cAAc;IAiBtB;;;OAGG;IACI,QAAQ,IAAI,MAAM;IAiBzB;;;OAGG;IACU,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC;IAiBxC;;;;OAIG;IACU,QAAQ,CACnB,KAAK,EAAE,MAAM,EACb,OAAO,GAAE,MAAM,CAAC,eAAoB,GACnC,OAAO,CAAC,IAAI,CAAC;IAkBhB;;;;;;OAMG;IACU,WAAW,CACtB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,yBAAyB,CAAC;IAkBrC;;;;;OAKG;IACU,aAAa,CACxB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,IAAI,CAAC;IAchB;;;;;;OAMG;IACU,QAAQ,CACnB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,MAAM,CAAC;IAqBlB;;;OAGG;IACH,OAAO,CAAC,iBAAiB;IAiBzB;;;OAGG;IACH,OAAO,CAAC,qBAAqB;CAgB9B;AAED,kBAAU,MAAM,CAAC;IACf,UAAiB,eAAe;QAC5B,aAAa,CAAC,EAAE,eAAe,CAAC;KACnC;IACD,UAAiB,qBAAqB;QAClC,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,OAAO,CAAC;QACtB,OAAO,CAAC,EAAE,MAAM,CAAC;KACpB;IACD,UAAiB,kCAAkC;QAC/C,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,OAAO,CAAC;QACtB,OAAO,CAAC,EAAE,MAAM,CAAC;KACpB;IACD,UAAiB,+BAA+B;QAC5C,IAAI,CAAC,EAAE,MAAM,CAAC;KACjB;IACD,UAAiB,eAAe;QAC5B,UAAU,CAAC,EAAE,OAAO,CAAC;KACxB;CACF"}
+{"version":3,"file":"device.d.ts","sourceRoot":"","sources":["../../../src/ascii/device.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,yBAAyB,EAAE,MAAM,iCAAiC,CAAC;AAC5E,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAC5B,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAGtD,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAErE;;GAEG;AACH,qBAAa,MAAM;IACjB;;OAEG;IACH,IAAW,UAAU,IAAI,UAAU,CAElC;IACD,OAAO,CAAC,WAAW,CAAa;IAEhC;;;OAGG;IACH,IAAW,aAAa,IAAI,MAAM,CAEjC;IACD,OAAO,CAAC,cAAc,CAAS;IAE/B;;OAEG;IACH,IAAW,QAAQ,IAAI,cAAc,CAEpC;IACD,OAAO,CAAC,SAAS,CAAiB;IAElC;;OAEG;IACH,IAAW,OAAO,IAAI,aAAa,CAElC;IACD,OAAO,CAAC,QAAQ,CAAgB;IAEhC;;OAEG;IACH,IAAW,EAAE,IAAI,QAAQ,CAExB;IACD,OAAO,CAAC,GAAG,CAAW;IAEtB;;OAEG;IACH,IAAW,OAAO,IAAI,OAAO,CAE5B;IACD,OAAO,CAAC,QAAQ,CAAU;IAE1B;;OAEG;IACH,IAAW,QAAQ,IAAI,QAAQ,CAE9B;IACD,OAAO,CAAC,SAAS,CAAW;IAE5B;;OAEG;IACH,IAAW,QAAQ,IAAI,cAAc,CAEpC;IAED;;OAEG;IACH,IAAW,YAAY,IAAI,OAAO,CAEjC;IAED;;;OAGG;IACH,IAAW,YAAY,IAAI,YAAY,CAEtC;IACD,OAAO,CAAC,aAAa,CAAe;IAEpC;;OAEG;IACH,IAAW,QAAQ,IAAI,MAAM,CAE5B;IAED;;OAEG;IACH,IAAW,YAAY,IAAI,MAAM,CAEhC;IAED;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;OAEG;IACH,IAAW,SAAS,IAAI,MAAM,CAE7B;IAED;;OAEG;IACH,IAAW,eAAe,IAAI,eAAe,CAE5C;IAED;;OAEG;IACH,IAAW,YAAY,IAAI,OAAO,CAEjC;IAED;;OAEG;IACH,IAAW,KAAK,IAAI,MAAM,CAEzB;IAED;;;OAGG;IACH,IAAW,QAAQ,IAAI,QAAQ,CAE9B;IACD,OAAO,CAAC,SAAS,CAAW;IAE5B;;;OAGG;IACH,IAAW,OAAO,IAAI,OAAO,CAE5B;IACD,OAAO,CAAC,QAAQ,CAAU;IAE1B;;;;;OAKG;IACH,IAAW,GAAG,IAAI,GAAG,CAEpB;IACD,OAAO,CAAC,IAAI,CAAM;gBAEN,UAAU,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM;IAczD;;;;;;;;OAQG;IACU,QAAQ,CACnB,OAAO,GAAE,MAAM,CAAC,eAAoB,GACnC,OAAO,CAAC,cAAc,CAAC;IAqB1B;;;;;;;;;OASG;IACU,cAAc,CACzB,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,MAAM,CAAC,qBAA0B,GACzC,OAAO,CAAC,QAAQ,CAAC;IA0BpB;;;;;;;;;;OAUG;IACU,2BAA2B,CACtC,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,MAAM,CAAC,kCAAuC,GACtD,OAAO,CAAC,QAAQ,EAAE,CAAC;IA0BtB;;;;;;OAMG;IACU,wBAAwB,CACnC,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,MAAM,CAAC,+BAAoC,GACnD,OAAO,CAAC,IAAI,CAAC;IAkBhB;;;;;OAKG;IACI,OAAO,CACZ,UAAU,EAAE,MAAM,GACjB,IAAI;IAOP;;;;;OAKG;IACI,WAAW,CAChB,eAAe,EAAE,MAAM,GACtB,QAAQ;IAOX;;;;;;;;;OASG;IACI,cAAc,CACnB,eAAe,EAAE,MAAM,EACvB,GAAG,UAAU,EAAE,WAAW,EAAE,GAC3B,MAAM;IAmBT;;;;OAIG;IACU,QAAQ,CACnB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,IAAI,CAAC;IAchB;;;OAGG;IACH,OAAO,CAAC,cAAc;IAiBtB;;;OAGG;IACI,QAAQ,IAAI,MAAM;IAiBzB;;;OAGG;IACU,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC;IAiBxC;;;;;OAKG;IACU,QAAQ,CACnB,KAAK,EAAE,MAAM,EACb,OAAO,GAAE,MAAM,CAAC,eAAoB,GACnC,OAAO,CAAC,sBAAsB,CAAC;IAsBlC;;;;;;OAMG;IACU,WAAW,CACtB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,yBAAyB,CAAC;IAkBrC;;;;;OAKG;IACU,aAAa,CACxB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,IAAI,CAAC;IAchB;;;;;;OAMG;IACU,QAAQ,CACnB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,MAAM,CAAC;IAqBlB;;;OAGG;IACH,OAAO,CAAC,iBAAiB;IAiBzB;;;OAGG;IACH,OAAO,CAAC,qBAAqB;CAgB9B;AAED,kBAAU,MAAM,CAAC;IACf,UAAiB,eAAe;QAC5B;;;;WAIG;QACH,aAAa,CAAC,EAAE,eAAe,CAAC;KACnC;IACD,UAAiB,qBAAqB;QAClC;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QACd;;WAEG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;QACtB;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KACpB;IACD,UAAiB,kCAAkC;QAC/C;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QACd;;WAEG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;QACtB;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KACpB;IACD,UAAiB,+BAA+B;QAC5C;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACjB;IACD,UAAiB,eAAe;QAC5B;;WAEG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;KACxB;CACF"}

package/dist/lib/ascii/device.js

@@ -42,6 +42,7 @@ const requests = __importStar(require("../requests"));
 const storage_1 = require("./storage");
 const triggers_1 = require("./triggers");
 const streams_1 = require("./streams");
+const set_state_device_response_1 = require("./set_state_device_response");
 /**
  * Represents the controller part of one device - may be either a standalone controller or an integrated controller.
  */
@@ -402,6 +403,7 @@ class Device {
      * Applies a saved state to this device.
      * @param state The state object to apply to this device.
      * @param [options.deviceOnly=false] If true, only device scope settings and features will be set.
+     * @returns Reports of any issues that were handled, but caused the state to not be exactly restored.
      */
     async setState(state, options = {}) {
         const { deviceOnly = false, } = options;
@@ -415,7 +417,8 @@ class Device {
                 return requests.SetStateRequest.toBinary(this);
             },
         };
-        await gateway.callAsync('device/set_state', request);
+        const response = await gateway.callAsync('device/set_device_state', request, set_state_device_response_1.SetStateDeviceResponse.fromBinary);
+        return response;
     }
     /**
      * Checks if a state can be applied to this device.

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

@@ -1 +1 @@
-{"version":3,"file":"device.js","sourceRoot":"","sources":["../../../src/ascii/device.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;;;;;AAGtD,uDAAmD;AACnD,iCAA8B;AAC9B,yCAAqC;AACrC,yCAAsC;AACtC,uDAAmD;AACnD,2CAAuC;AACvC,yCAAsC;AACtC,yCAAsC;AACtC,iDAA8C;AAC9C,mFAA4E;AAC5E,+BAA4B;AAG5B,oDAAsC;AACtC,sDAAwC;AACxC,uCAA0C;AAC1C,yCAAsC;AACtC,uCAAoC;AAEpC;;GAEG;AACH,MAAa,MAAM;IACjB;;OAEG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAGD;;;OAGG;IACH,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAGD;;OAEG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAGD;;OAEG;IACH,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAGD;;OAEG;IACH,IAAW,EAAE;QACX,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAGD;;OAEG;IACH,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAGD;;OAEG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAGD;;OAEG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,qBAAqB,EAAE,CAAC;IACtC,CAAC;IAED;;;OAGG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAGD;;OAEG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;IAChC,CAAC;IAED;;OAEG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;IACpC,CAAC;IAED;;OAEG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,IAAW,eAAe;QACxB,OAAO,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC;IACvC,CAAC;IAED;;OAEG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;IACpC,CAAC;IAED;;OAEG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,cAAc,EAAE,CAAC;IAC/B,CAAC;IAED;;;OAGG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAGD;;;OAGG;IACH,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAGD;;;;;OAKG;IACH,IAAW,GAAG;QACZ,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAGD,YAAY,UAAsB,EAAE,aAAqB;QACvD,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;QACpC,IAAI,CAAC,SAAS,GAAG,IAAI,gCAAc,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,CAAC,QAAQ,GAAG,IAAI,uBAAa,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,CAAC,GAAG,GAAG,IAAI,oBAAQ,CAAC,IAAI,CAAC,CAAC;QAC9B,IAAI,CAAC,QAAQ,GAAG,IAAI,kBAAO,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,CAAC,SAAS,GAAG,IAAI,mBAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QACvC,IAAI,CAAC,aAAa,GAAG,IAAI,2BAAY,CAAC,IAAI,CAAC,CAAC;QAC5C,IAAI,CAAC,SAAS,GAAG,IAAI,mBAAQ,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,CAAC,QAAQ,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,CAAC,IAAI,GAAG,IAAI,SAAG,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,QAAQ,CACnB,UAAkC,EAAE;QAEpC,MAAM,EACJ,aAAa,GACd,GAAG,OAAO,CAAC;QACZ,MAAM,OAAO,GAAqD;YAChE,GAAG,QAAQ,CAAC,qBAAqB,CAAC,OAAO;YACzC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW;YACxC,MAAM,EAAE,IAAI,CAAC,aAAa;YAC1B,aAAa,EAAE,aAAa;YAC5B,QAAQ;gBACN,OAAO,QAAQ,CAAC,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACvD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,iBAAiB,EACjB,OAAO,EACP,gCAAc,CAAC,UAAU,CAAC,CAAC;QAC7B,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,cAAc,CACzB,OAAe,EACf,UAAwC,EAAE;QAE1C,MAAM,EACJ,IAAI,GAAG,CAAC,EACR,WAAW,GAAG,IAAI,EAClB,OAAO,GAAG,CAAC,GACZ,GAAG,OAAO,CAAC;QACZ,MAAM,OAAO,GAAqD;YAChE,GAAG,QAAQ,CAAC,qBAAqB,CAAC,OAAO;YACzC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW;YACxC,MAAM,EAAE,IAAI,CAAC,aAAa;YAC1B,OAAO,EAAE,OAAO;YAChB,IAAI,EAAE,IAAI;YACV,WAAW,EAAE,WAAW;YACxB,OAAO,EAAE,OAAO;YAChB,QAAQ;gBACN,OAAO,QAAQ,CAAC,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACvD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,2BAA2B,EAC3B,OAAO,EACP,mBAAQ,CAAC,UAAU,CAAC,CAAC;QACvB,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,2BAA2B,CACtC,OAAe,EACf,UAAqD,EAAE;QAEvD,MAAM,EACJ,IAAI,GAAG,CAAC,EACR,WAAW,GAAG,IAAI,EAClB,OAAO,GAAG,CAAC,GACZ,GAAG,OAAO,CAAC;QACZ,MAAM,OAAO,GAAqD;YAChE,GAAG,QAAQ,CAAC,qBAAqB,CAAC,OAAO;YACzC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW;YACxC,MAAM,EAAE,IAAI,CAAC,aAAa;YAC1B,OAAO,EAAE,OAAO;YAChB,IAAI,EAAE,IAAI;YACV,WAAW,EAAE,WAAW;YACxB,OAAO,EAAE,OAAO;YAChB,QAAQ;gBACN,OAAO,QAAQ,CAAC,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACvD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,0CAA0C,EAC1C,OAAO,EACP,QAAQ,CAAC,gCAAgC,CAAC,UAAU,CAAC,CAAC;QACxD,OAAO,QAAQ,CAAC,SAAS,CAAC;IAC5B,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,wBAAwB,CACnC,OAAe,EACf,UAAkD,EAAE;QAEpD,MAAM,EACJ,IAAI,GAAG,CAAC,GACT,GAAG,OAAO,CAAC;QACZ,MAAM,OAAO,GAAqD;YAChE,GAAG,QAAQ,CAAC,qBAAqB,CAAC,OAAO;YACzC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW;YACxC,MAAM,EAAE,IAAI,CAAC,aAAa;YAC1B,OAAO,EAAE,OAAO;YAChB,IAAI,EAAE,IAAI;YACV,QAAQ;gBACN,OAAO,QAAQ,CAAC,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACvD,CAAC;SACF,CAAC;QAEF,MAAM,OAAO,CAAC,SAAS,CAAC,uCAAuC,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;OAKG;IACI,OAAO,CACZ,UAAkB;QAElB,IAAI,UAAU,IAAI,CAAC,EAAE,CAAC;YACpB,MAAM,IAAI,SAAS,CAAC,mDAAmD,CAAC,CAAC;QAC3E,CAAC;QACD,OAAO,IAAI,WAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IACpC,CAAC;IAED;;;;;OAKG;IACI,WAAW,CAChB,eAAuB;QAEvB,IAAI,eAAe,IAAI,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,SAAS,CAAC,qDAAqD,CAAC,CAAC;QAC7E,CAAC;QACD,OAAO,IAAI,mBAAQ,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;;;OASG;IACI,cAAc,CACnB,eAAuB,EACvB,GAAG,UAAyB;QAE5B,MAAM,OAAO,GAAqD;YAChE,GAAG,QAAQ,CAAC,qBAAqB,CAAC,OAAO;YACzC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW;YACxC,MAAM,EAAE,IAAI,CAAC,aAAa;YAC1B,eAAe,EAAE,eAAe;YAChC,UAAU,EAAE,UAAU;YACtB,QAAQ;gBACN,OAAO,QAAQ,CAAC,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACvD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,wBAAwB,EACxB,OAAO,EACP,QAAQ,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QACtC,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,QAAQ,CACnB,KAAa;QAEb,MAAM,OAAO,GAAuD;YAClE,GAAG,QAAQ,CAAC,uBAAuB,CAAC,OAAO;YAC3C,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW;YACxC,MAAM,EAAE,IAAI,CAAC,aAAa;YAC1B,KAAK,EAAE,KAAK;YACZ,QAAQ;gBACN,OAAO,QAAQ,CAAC,uBAAuB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACzD,CAAC;SACF,CAAC;QAEF,MAAM,OAAO,CAAC,SAAS,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;OAGG;IACK,cAAc;QACpB,MAAM,OAAO,GAAgD;YAC3D,GAAG,QAAQ,CAAC,gBAAgB,CAAC,OAAO;YACpC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW;YACxC,MAAM,EAAE,IAAI,CAAC,aAAa;YAC1B,QAAQ;gBACN,OAAO,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAClD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,kBAAkB,EAClB,OAAO,EACP,QAAQ,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QACtC,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;IAED;;;OAGG;IACI,QAAQ;QACb,MAAM,OAAO,GAAmD;YAC9D,GAAG,QAAQ,CAAC,mBAAmB,CAAC,OAAO;YACvC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW;YACxC,MAAM,EAAE,IAAI,CAAC,aAAa;YAC1B,QAAQ;gBACN,OAAO,QAAQ,CAAC,mBAAmB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACrD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,yBAAyB,EACzB,OAAO,EACP,QAAQ,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QACtC,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,QAAQ;QACnB,MAAM,OAAO,GAAgD;YAC3D,GAAG,QAAQ,CAAC,gBAAgB,CAAC,OAAO;YACpC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW;YACxC,MAAM,EAAE,IAAI,CAAC,aAAa;YAC1B,QAAQ;gBACN,OAAO,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAClD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,kBAAkB,EAClB,OAAO,EACP,QAAQ,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QACtC,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,QAAQ,CACnB,KAAa,EACb,UAAkC,EAAE;QAEpC,MAAM,EACJ,UAAU,GAAG,KAAK,GACnB,GAAG,OAAO,CAAC;QACZ,MAAM,OAAO,GAA+C;YAC1D,GAAG,QAAQ,CAAC,eAAe,CAAC,OAAO;YACnC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW;YACxC,MAAM,EAAE,IAAI,CAAC,aAAa;YAC1B,KAAK,EAAE,KAAK;YACZ,UAAU,EAAE,UAAU;YACtB,QAAQ;gBACN,OAAO,QAAQ,CAAC,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACjD,CAAC;SACF,CAAC;QAEF,MAAM,OAAO,CAAC,SAAS,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,WAAW,CACtB,KAAa;QAEb,MAAM,OAAO,GAAkD;YAC7D,GAAG,QAAQ,CAAC,kBAAkB,CAAC,OAAO;YACtC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW;YACxC,MAAM,EAAE,IAAI,CAAC,aAAa;YAC1B,KAAK,EAAE,KAAK;YACZ,QAAQ;gBACN,OAAO,QAAQ,CAAC,kBAAkB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACpD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,sBAAsB,EACtB,OAAO,EACP,yDAAyB,CAAC,UAAU,CAAC,CAAC;QACxC,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,aAAa,CACxB,OAAe;QAEf,MAAM,OAAO,GAAoD;YAC/D,GAAG,QAAQ,CAAC,oBAAoB,CAAC,OAAO;YACxC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW;YACxC,MAAM,EAAE,IAAI,CAAC,aAAa;YAC1B,OAAO,EAAE,OAAO;YAChB,QAAQ;gBACN,OAAO,QAAQ,CAAC,oBAAoB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACtD,CAAC;SACF,CAAC;QAEF,MAAM,OAAO,CAAC,SAAS,CAAC,wBAAwB,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,QAAQ,CACnB,OAAe;QAEf,IAAI,OAAO,GAAG,CAAC,IAAI,OAAO,GAAG,EAAE,EAAE,CAAC;YAChC,MAAM,IAAI,SAAS,CAAC,4DAA4D,CAAC,CAAC;QACpF,CAAC;QACD,MAAM,OAAO,GAA+C;YAC1D,GAAG,QAAQ,CAAC,eAAe,CAAC,OAAO;YACnC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW;YACxC,MAAM,EAAE,IAAI,CAAC,aAAa;YAC1B,OAAO,EAAE,OAAO;YAChB,QAAQ;gBACN,OAAO,QAAQ,CAAC,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACjD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,iBAAiB,EACjB,OAAO,EACP,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;QACnC,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACK,iBAAiB;QACvB,MAAM,OAAO,GAAkD;YAC7D,GAAG,QAAQ,CAAC,kBAAkB,CAAC,OAAO;YACtC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW;YACxC,MAAM,EAAE,IAAI,CAAC,aAAa;YAC1B,QAAQ;gBACN,OAAO,QAAQ,CAAC,kBAAkB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACpD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,qBAAqB,EACrB,OAAO,EACP,gCAAc,CAAC,UAAU,CAAC,CAAC;QAC7B,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;OAGG;IACK,qBAAqB;QAC3B,MAAM,OAAO,GAAkD;YAC7D,GAAG,QAAQ,CAAC,kBAAkB,CAAC,OAAO;YACtC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW;YACxC,MAAM,EAAE,IAAI,CAAC,aAAa;YAC1B,QAAQ;gBACN,OAAO,QAAQ,CAAC,kBAAkB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACpD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,0BAA0B,EAC1B,OAAO,EACP,QAAQ,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QACpC,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;CACF;AA5lBD,wBA4lBC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport { Connection } from './connection';\nimport { DeviceSettings } from './device_settings';\nimport { Axis } from './axis';\nimport { AllAxes } from './all_axes';\nimport { Warnings } from './warnings';\nimport { DeviceIdentity } from './device_identity';\nimport { DeviceIO } from './device_io';\nimport { Response } from './response';\nimport { Lockstep } from './lockstep';\nimport { Oscilloscope } from './oscilloscope';\nimport { CanSetStateDeviceResponse } from './can_set_state_device_response';\nimport { Pvt } from './pvt';\nimport { Measurement } from '../measurement';\nimport { FirmwareVersion } from '../firmware_version';\nimport * as gateway from '../gateway';\nimport * as requests from '../requests';\nimport { DeviceStorage } from './storage';\nimport { Triggers } from './triggers';\nimport { Streams } from './streams';\n\n/**\n * Represents the controller part of one device - may be either a standalone controller or an integrated controller.\n */\nexport class Device {\n  /**\n   * Connection of this device.\n   */\n  public get connection(): Connection {\n    return this._connection;\n  }\n  private _connection: Connection;\n\n  /**\n   * The device address uniquely identifies the device on the connection.\n   * It can be configured or automatically assigned by the renumber command.\n   */\n  public get deviceAddress(): number {\n    return this._deviceAddress;\n  }\n  private _deviceAddress: number;\n\n  /**\n   * Settings and properties of this device.\n   */\n  public get settings(): DeviceSettings {\n    return this._settings;\n  }\n  private _settings: DeviceSettings;\n\n  /**\n   * Key-value storage of this device.\n   */\n  public get storage(): DeviceStorage {\n    return this._storage;\n  }\n  private _storage: DeviceStorage;\n\n  /**\n   * I/O channels of this device.\n   */\n  public get io(): DeviceIO {\n    return this._io;\n  }\n  private _io: DeviceIO;\n\n  /**\n   * Virtual axis which allows you to target all axes of this device.\n   */\n  public get allAxes(): AllAxes {\n    return this._allAxes;\n  }\n  private _allAxes: AllAxes;\n\n  /**\n   * Warnings and faults of this device and all its axes.\n   */\n  public get warnings(): Warnings {\n    return this._warnings;\n  }\n  private _warnings: Warnings;\n\n  /**\n   * Identity of the device.\n   */\n  public get identity(): DeviceIdentity {\n    return this._retrieveIdentity();\n  }\n\n  /**\n   * Indicates whether or not the device has been identified.\n   */\n  public get isIdentified(): boolean {\n    return this._retrieveIsIdentified();\n  }\n\n  /**\n   * Oscilloscope recording helper for this device.\n   * Requires at least Firmware 7.00.\n   */\n  public get oscilloscope(): Oscilloscope {\n    return this._oscilloscope;\n  }\n  private _oscilloscope: Oscilloscope;\n\n  /**\n   * Unique ID of the device hardware.\n   */\n  public get deviceId(): number {\n    return this.identity.deviceId;\n  }\n\n  /**\n   * Serial number of the device.\n   */\n  public get serialNumber(): number {\n    return this.identity.serialNumber;\n  }\n\n  /**\n   * Name of the product.\n   */\n  public get name(): string {\n    return this.identity.name;\n  }\n\n  /**\n   * Number of axes this device has.\n   */\n  public get axisCount(): number {\n    return this.identity.axisCount;\n  }\n\n  /**\n   * Version of the firmware.\n   */\n  public get firmwareVersion(): FirmwareVersion {\n    return this.identity.firmwareVersion;\n  }\n\n  /**\n   * The device is an integrated product.\n   */\n  public get isIntegrated(): boolean {\n    return this.identity.isIntegrated;\n  }\n\n  /**\n   * User-assigned label of the device.\n   */\n  public get label(): string {\n    return this._retrieveLabel();\n  }\n\n  /**\n   * Triggers for this device.\n   * Requires at least Firmware 7.06.\n   */\n  public get triggers(): Triggers {\n    return this._triggers;\n  }\n  private _triggers: Triggers;\n\n  /**\n   * Gets an object that provides access to Streams on this device.\n   * Requires at least Firmware 7.05.\n   */\n  public get streams(): Streams {\n    return this._streams;\n  }\n  private _streams: Streams;\n\n  /**\n   * Gets an object that provides access to PVT functions of this device.\n   * Note that as of ZML v5.0.0, this returns a Pvt object and NOT a PvtSequence object.\n   * The PvtSequence can now be obtained from the Pvt object.\n   * Requires at least Firmware 7.33.\n   */\n  public get pvt(): Pvt {\n    return this._pvt;\n  }\n  private _pvt: Pvt;\n\n  constructor(connection: Connection, deviceAddress: number) {\n    this._connection = connection;\n    this._deviceAddress = deviceAddress;\n    this._settings = new DeviceSettings(this);\n    this._storage = new DeviceStorage(this);\n    this._io = new DeviceIO(this);\n    this._allAxes = new AllAxes(this);\n    this._warnings = new Warnings(this, 0);\n    this._oscilloscope = new Oscilloscope(this);\n    this._triggers = new Triggers(this);\n    this._streams = new Streams(this);\n    this._pvt = new Pvt(this);\n  }\n\n  /**\n   * Queries the device and the database, gathering information about the product.\n   * Without this information features such as unit conversions will not work.\n   * Usually, called automatically by detect devices method.\n   * @param options.assumeVersion The identification assumes the specified firmware version\n   * instead of the version queried from the device.\n   * Providing this argument can lead to unexpected compatibility issues.\n   * @returns Device identification data.\n   */\n  public async identify(\n    options: Device.IdentifyOptions = {}\n  ): Promise<DeviceIdentity> {\n    const {\n      assumeVersion,\n    } = options;\n    const request: requests.DeviceIdentifyRequest & gateway.Message = {\n      ...requests.DeviceIdentifyRequest.DEFAULT,\n      interfaceId: this.connection.interfaceId,\n      device: this.deviceAddress,\n      assumeVersion: assumeVersion,\n      toBinary() {\n        return requests.DeviceIdentifyRequest.toBinary(this);\n      },\n    };\n\n    const response = await gateway.callAsync<DeviceIdentity>(\n      'device/identify',\n      request,\n      DeviceIdentity.fromBinary);\n    return response;\n  }\n\n  /**\n   * Sends a generic ASCII command to this device.\n   * For more information refer to: [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).\n   * @param command Command and its parameters.\n   * @param [options.axis=0] Optional axis number to send the command to.\n   * @param [options.checkErrors=true] Controls whether to throw an exception when the device rejects the command.\n   * @param [options.timeout=0] The timeout, in milliseconds, for a device to respond to the command.\n   * Overrides the connection default request timeout.\n   * @returns A response to the command.\n   */\n  public async genericCommand(\n    command: string,\n    options: Device.GenericCommandOptions = {}\n  ): Promise<Response> {\n    const {\n      axis = 0,\n      checkErrors = true,\n      timeout = 0,\n    } = options;\n    const request: requests.GenericCommandRequest & gateway.Message = {\n      ...requests.GenericCommandRequest.DEFAULT,\n      interfaceId: this.connection.interfaceId,\n      device: this.deviceAddress,\n      command: command,\n      axis: axis,\n      checkErrors: checkErrors,\n      timeout: timeout,\n      toBinary() {\n        return requests.GenericCommandRequest.toBinary(this);\n      },\n    };\n\n    const response = await gateway.callAsync<Response>(\n      'interface/generic_command',\n      request,\n      Response.fromBinary);\n    return response;\n  }\n\n  /**\n   * Sends a generic ASCII command to this device and expect multiple responses.\n   * Responses are returned in order of arrival.\n   * For more information refer to: [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).\n   * @param command Command and its parameters.\n   * @param [options.axis=0] Optional axis number to send the command to.\n   * @param [options.checkErrors=true] Controls whether to throw an exception when a device rejects the command.\n   * @param [options.timeout=0] The timeout, in milliseconds, for a device to respond to the command.\n   * Overrides the connection default request timeout.\n   * @returns All responses to the command.\n   */\n  public async genericCommandMultiResponse(\n    command: string,\n    options: Device.GenericCommandMultiResponseOptions = {}\n  ): Promise<Response[]> {\n    const {\n      axis = 0,\n      checkErrors = true,\n      timeout = 0,\n    } = options;\n    const request: requests.GenericCommandRequest & gateway.Message = {\n      ...requests.GenericCommandRequest.DEFAULT,\n      interfaceId: this.connection.interfaceId,\n      device: this.deviceAddress,\n      command: command,\n      axis: axis,\n      checkErrors: checkErrors,\n      timeout: timeout,\n      toBinary() {\n        return requests.GenericCommandRequest.toBinary(this);\n      },\n    };\n\n    const response = await gateway.callAsync<requests.GenericCommandResponseCollection>(\n      'interface/generic_command_multi_response',\n      request,\n      requests.GenericCommandResponseCollection.fromBinary);\n    return response.responses;\n  }\n\n  /**\n   * Sends a generic ASCII command to this device without expecting a response and without adding a message ID\n   * For more information refer to: [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).\n   * @param command Command and its parameters.\n   * @param [options.axis=0] Optional axis number to send the command to.\n   * Specifying -1 omits the number completely.\n   */\n  public async genericCommandNoResponse(\n    command: string,\n    options: Device.GenericCommandNoResponseOptions = {}\n  ): Promise<void> {\n    const {\n      axis = 0,\n    } = options;\n    const request: requests.GenericCommandRequest & gateway.Message = {\n      ...requests.GenericCommandRequest.DEFAULT,\n      interfaceId: this.connection.interfaceId,\n      device: this.deviceAddress,\n      command: command,\n      axis: axis,\n      toBinary() {\n        return requests.GenericCommandRequest.toBinary(this);\n      },\n    };\n\n    await gateway.callAsync('interface/generic_command_no_response', request);\n  }\n\n  /**\n   * Gets an Axis class instance which allows you to control a particular axis on this device.\n   * Axes are numbered from 1.\n   * @param axisNumber Number of axis intended to control.\n   * @returns Axis instance.\n   */\n  public getAxis(\n    axisNumber: number\n  ): Axis {\n    if (axisNumber <= 0) {\n      throw new TypeError('Invalid value; physical axes are numbered from 1.');\n    }\n    return new Axis(this, axisNumber);\n  }\n\n  /**\n   * Gets a Lockstep class instance which allows you to control a particular lockstep group on the device.\n   * Requires at least Firmware 6.15 or 7.11.\n   * @param lockstepGroupId The ID of the lockstep group to control. Lockstep group IDs start at one.\n   * @returns Lockstep instance.\n   */\n  public getLockstep(\n    lockstepGroupId: number\n  ): Lockstep {\n    if (lockstepGroupId <= 0) {\n      throw new TypeError('Invalid value; lockstep groups are numbered from 1.');\n    }\n    return new Lockstep(this, lockstepGroupId);\n  }\n\n  /**\n   * Formats parameters into a command and performs unit conversions.\n   * Parameters in the command template are denoted by a question mark.\n   * Command returned is only valid for this device.\n   * Unit conversion is not supported for commands where axes can be remapped, such as stream and PVT commands.\n   * For more information refer to: [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).\n   * @param commandTemplate Template of a command to prepare. Parameters are denoted by question marks.\n   * @param parameters Variable number of command parameters.\n   * @returns Command with converted parameters.\n   */\n  public prepareCommand(\n    commandTemplate: string,\n    ...parameters: Measurement[]\n  ): string {\n    const request: requests.PrepareCommandRequest & gateway.Message = {\n      ...requests.PrepareCommandRequest.DEFAULT,\n      interfaceId: this.connection.interfaceId,\n      device: this.deviceAddress,\n      commandTemplate: commandTemplate,\n      parameters: parameters,\n      toBinary() {\n        return requests.PrepareCommandRequest.toBinary(this);\n      },\n    };\n\n    const response = gateway.callSync<requests.StringResponse>(\n      'device/prepare_command',\n      request,\n      requests.StringResponse.fromBinary);\n    return response.value;\n  }\n\n  /**\n   * Sets the user-assigned device label.\n   * The label is stored on the controller and recognized by other software.\n   * @param label Label to set.\n   */\n  public async setLabel(\n    label: string\n  ): Promise<void> {\n    const request: requests.DeviceSetStorageRequest & gateway.Message = {\n      ...requests.DeviceSetStorageRequest.DEFAULT,\n      interfaceId: this.connection.interfaceId,\n      device: this.deviceAddress,\n      value: label,\n      toBinary() {\n        return requests.DeviceSetStorageRequest.toBinary(this);\n      },\n    };\n\n    await gateway.callAsync('device/set_label', request);\n  }\n\n  /**\n   * Gets the device name.\n   * @returns The label.\n   */\n  private _retrieveLabel(): string {\n    const request: requests.AxisEmptyRequest & gateway.Message = {\n      ...requests.AxisEmptyRequest.DEFAULT,\n      interfaceId: this.connection.interfaceId,\n      device: this.deviceAddress,\n      toBinary() {\n        return requests.AxisEmptyRequest.toBinary(this);\n      },\n    };\n\n    const response = gateway.callSync<requests.StringResponse>(\n      'device/get_label',\n      request,\n      requests.StringResponse.fromBinary);\n    return response.value;\n  }\n\n  /**\n   * Returns a string that represents the device.\n   * @returns A string that represents the device.\n   */\n  public toString(): string {\n    const request: requests.AxisToStringRequest & gateway.Message = {\n      ...requests.AxisToStringRequest.DEFAULT,\n      interfaceId: this.connection.interfaceId,\n      device: this.deviceAddress,\n      toBinary() {\n        return requests.AxisToStringRequest.toBinary(this);\n      },\n    };\n\n    const response = gateway.callSync<requests.StringResponse>(\n      'device/device_to_string',\n      request,\n      requests.StringResponse.fromBinary);\n    return response.value;\n  }\n\n  /**\n   * Returns a serialization of the current device state that can be saved and reapplied.\n   * @returns A serialization of the current state of the device.\n   */\n  public async getState(): Promise<string> {\n    const request: requests.AxisEmptyRequest & gateway.Message = {\n      ...requests.AxisEmptyRequest.DEFAULT,\n      interfaceId: this.connection.interfaceId,\n      device: this.deviceAddress,\n      toBinary() {\n        return requests.AxisEmptyRequest.toBinary(this);\n      },\n    };\n\n    const response = await gateway.callAsync<requests.StringResponse>(\n      'device/get_state',\n      request,\n      requests.StringResponse.fromBinary);\n    return response.value;\n  }\n\n  /**\n   * Applies a saved state to this device.\n   * @param state The state object to apply to this device.\n   * @param [options.deviceOnly=false] If true, only device scope settings and features will be set.\n   */\n  public async setState(\n    state: string,\n    options: Device.SetStateOptions = {}\n  ): Promise<void> {\n    const {\n      deviceOnly = false,\n    } = options;\n    const request: requests.SetStateRequest & gateway.Message = {\n      ...requests.SetStateRequest.DEFAULT,\n      interfaceId: this.connection.interfaceId,\n      device: this.deviceAddress,\n      state: state,\n      deviceOnly: deviceOnly,\n      toBinary() {\n        return requests.SetStateRequest.toBinary(this);\n      },\n    };\n\n    await gateway.callAsync('device/set_state', request);\n  }\n\n  /**\n   * Checks if a state can be applied to this device.\n   * This only covers exceptions that can be determined statically such as mismatches of ID or version,\n   * the process of applying the state can still fail when running.\n   * @param state The state object to check against.\n   * @returns An object listing errors that come up when trying to set the state.\n   */\n  public async canSetState(\n    state: string\n  ): Promise<CanSetStateDeviceResponse> {\n    const request: requests.CanSetStateRequest & gateway.Message = {\n      ...requests.CanSetStateRequest.DEFAULT,\n      interfaceId: this.connection.interfaceId,\n      device: this.deviceAddress,\n      state: state,\n      toBinary() {\n        return requests.CanSetStateRequest.toBinary(this);\n      },\n    };\n\n    const response = await gateway.callAsync<CanSetStateDeviceResponse>(\n      'device/can_set_state',\n      request,\n      CanSetStateDeviceResponse.fromBinary);\n    return response;\n  }\n\n  /**\n   * Waits for the device to start responding to messages.\n   * Useful to call after resetting the device.\n   * Throws RequestTimeoutException upon timeout.\n   * @param timeout For how long to wait in milliseconds for the device to start responding.\n   */\n  public async waitToRespond(\n    timeout: number\n  ): Promise<void> {\n    const request: requests.WaitToRespondRequest & gateway.Message = {\n      ...requests.WaitToRespondRequest.DEFAULT,\n      interfaceId: this.connection.interfaceId,\n      device: this.deviceAddress,\n      timeout: timeout,\n      toBinary() {\n        return requests.WaitToRespondRequest.toBinary(this);\n      },\n    };\n\n    await gateway.callAsync('device/wait_to_respond', request);\n  }\n\n  /**\n   * Changes the address of this device.\n   * After the address is successfully changed, the existing device class instance no longer represents the device.\n   * Instead, use the new device instance returned by this method.\n   * @param address The new address to assign to the device.\n   * @returns New device instance with the new address.\n   */\n  public async renumber(\n    address: number\n  ): Promise<Device> {\n    if (address < 1 || address > 99) {\n      throw new TypeError('Invalid value; device addresses are numbered from 1 to 99.');\n    }\n    const request: requests.RenumberRequest & gateway.Message = {\n      ...requests.RenumberRequest.DEFAULT,\n      interfaceId: this.connection.interfaceId,\n      device: this.deviceAddress,\n      address: address,\n      toBinary() {\n        return requests.RenumberRequest.toBinary(this);\n      },\n    };\n\n    const response = await gateway.callAsync<requests.IntResponse>(\n      'device/renumber',\n      request,\n      requests.IntResponse.fromBinary);\n    return new Device(this.connection, response.value);\n  }\n\n  /**\n   * Returns identity.\n   * @returns Device identity.\n   */\n  private _retrieveIdentity(): DeviceIdentity {\n    const request: requests.DeviceEmptyRequest & gateway.Message = {\n      ...requests.DeviceEmptyRequest.DEFAULT,\n      interfaceId: this.connection.interfaceId,\n      device: this.deviceAddress,\n      toBinary() {\n        return requests.DeviceEmptyRequest.toBinary(this);\n      },\n    };\n\n    const response = gateway.callSync<DeviceIdentity>(\n      'device/get_identity',\n      request,\n      DeviceIdentity.fromBinary);\n    return response;\n  }\n\n  /**\n   * Returns whether or not the device have been identified.\n   * @returns True if the device has already been identified. False otherwise.\n   */\n  private _retrieveIsIdentified(): boolean {\n    const request: requests.DeviceEmptyRequest & gateway.Message = {\n      ...requests.DeviceEmptyRequest.DEFAULT,\n      interfaceId: this.connection.interfaceId,\n      device: this.deviceAddress,\n      toBinary() {\n        return requests.DeviceEmptyRequest.toBinary(this);\n      },\n    };\n\n    const response = gateway.callSync<requests.BoolResponse>(\n      'device/get_is_identified',\n      request,\n      requests.BoolResponse.fromBinary);\n    return response.value;\n  }\n}\n\nnamespace Device {\n  export interface IdentifyOptions {\n      assumeVersion?: FirmwareVersion;\n  }\n  export interface GenericCommandOptions {\n      axis?: number;\n      checkErrors?: boolean;\n      timeout?: number;\n  }\n  export interface GenericCommandMultiResponseOptions {\n      axis?: number;\n      checkErrors?: boolean;\n      timeout?: number;\n  }\n  export interface GenericCommandNoResponseOptions {\n      axis?: number;\n  }\n  export interface SetStateOptions {\n      deviceOnly?: boolean;\n  }\n}\n"]}
+{"version":3,"file":"device.js","sourceRoot":"","sources":["../../../src/ascii/device.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;;;;;AAGtD,uDAAmD;AACnD,iCAA8B;AAC9B,yCAAqC;AACrC,yCAAsC;AACtC,uDAAmD;AACnD,2CAAuC;AACvC,yCAAsC;AACtC,yCAAsC;AACtC,iDAA8C;AAC9C,mFAA4E;AAC5E,+BAA4B;AAG5B,oDAAsC;AACtC,sDAAwC;AACxC,uCAA0C;AAC1C,yCAAsC;AACtC,uCAAoC;AACpC,2EAAqE;AAErE;;GAEG;AACH,MAAa,MAAM;IACjB;;OAEG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAGD;;;OAGG;IACH,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAGD;;OAEG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAGD;;OAEG;IACH,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAGD;;OAEG;IACH,IAAW,EAAE;QACX,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAGD;;OAEG;IACH,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAGD;;OAEG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAGD;;OAEG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,qBAAqB,EAAE,CAAC;IACtC,CAAC;IAED;;;OAGG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAGD;;OAEG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;IAChC,CAAC;IAED;;OAEG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;IACpC,CAAC;IAED;;OAEG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,IAAW,eAAe;QACxB,OAAO,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC;IACvC,CAAC;IAED;;OAEG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;IACpC,CAAC;IAED;;OAEG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,cAAc,EAAE,CAAC;IAC/B,CAAC;IAED;;;OAGG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAGD;;;OAGG;IACH,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAGD;;;;;OAKG;IACH,IAAW,GAAG;QACZ,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAGD,YAAY,UAAsB,EAAE,aAAqB;QACvD,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;QACpC,IAAI,CAAC,SAAS,GAAG,IAAI,gCAAc,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,CAAC,QAAQ,GAAG,IAAI,uBAAa,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,CAAC,GAAG,GAAG,IAAI,oBAAQ,CAAC,IAAI,CAAC,CAAC;QAC9B,IAAI,CAAC,QAAQ,GAAG,IAAI,kBAAO,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,CAAC,SAAS,GAAG,IAAI,mBAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QACvC,IAAI,CAAC,aAAa,GAAG,IAAI,2BAAY,CAAC,IAAI,CAAC,CAAC;QAC5C,IAAI,CAAC,SAAS,GAAG,IAAI,mBAAQ,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,CAAC,QAAQ,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,CAAC,IAAI,GAAG,IAAI,SAAG,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,QAAQ,CACnB,UAAkC,EAAE;QAEpC,MAAM,EACJ,aAAa,GACd,GAAG,OAAO,CAAC;QACZ,MAAM,OAAO,GAAqD;YAChE,GAAG,QAAQ,CAAC,qBAAqB,CAAC,OAAO;YACzC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW;YACxC,MAAM,EAAE,IAAI,CAAC,aAAa;YAC1B,aAAa,EAAE,aAAa;YAC5B,QAAQ;gBACN,OAAO,QAAQ,CAAC,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACvD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,iBAAiB,EACjB,OAAO,EACP,gCAAc,CAAC,UAAU,CAAC,CAAC;QAC7B,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,cAAc,CACzB,OAAe,EACf,UAAwC,EAAE;QAE1C,MAAM,EACJ,IAAI,GAAG,CAAC,EACR,WAAW,GAAG,IAAI,EAClB,OAAO,GAAG,CAAC,GACZ,GAAG,OAAO,CAAC;QACZ,MAAM,OAAO,GAAqD;YAChE,GAAG,QAAQ,CAAC,qBAAqB,CAAC,OAAO;YACzC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW;YACxC,MAAM,EAAE,IAAI,CAAC,aAAa;YAC1B,OAAO,EAAE,OAAO;YAChB,IAAI,EAAE,IAAI;YACV,WAAW,EAAE,WAAW;YACxB,OAAO,EAAE,OAAO;YAChB,QAAQ;gBACN,OAAO,QAAQ,CAAC,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACvD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,2BAA2B,EAC3B,OAAO,EACP,mBAAQ,CAAC,UAAU,CAAC,CAAC;QACvB,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,2BAA2B,CACtC,OAAe,EACf,UAAqD,EAAE;QAEvD,MAAM,EACJ,IAAI,GAAG,CAAC,EACR,WAAW,GAAG,IAAI,EAClB,OAAO,GAAG,CAAC,GACZ,GAAG,OAAO,CAAC;QACZ,MAAM,OAAO,GAAqD;YAChE,GAAG,QAAQ,CAAC,qBAAqB,CAAC,OAAO;YACzC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW;YACxC,MAAM,EAAE,IAAI,CAAC,aAAa;YAC1B,OAAO,EAAE,OAAO;YAChB,IAAI,EAAE,IAAI;YACV,WAAW,EAAE,WAAW;YACxB,OAAO,EAAE,OAAO;YAChB,QAAQ;gBACN,OAAO,QAAQ,CAAC,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACvD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,0CAA0C,EAC1C,OAAO,EACP,QAAQ,CAAC,gCAAgC,CAAC,UAAU,CAAC,CAAC;QACxD,OAAO,QAAQ,CAAC,SAAS,CAAC;IAC5B,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,wBAAwB,CACnC,OAAe,EACf,UAAkD,EAAE;QAEpD,MAAM,EACJ,IAAI,GAAG,CAAC,GACT,GAAG,OAAO,CAAC;QACZ,MAAM,OAAO,GAAqD;YAChE,GAAG,QAAQ,CAAC,qBAAqB,CAAC,OAAO;YACzC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW;YACxC,MAAM,EAAE,IAAI,CAAC,aAAa;YAC1B,OAAO,EAAE,OAAO;YAChB,IAAI,EAAE,IAAI;YACV,QAAQ;gBACN,OAAO,QAAQ,CAAC,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACvD,CAAC;SACF,CAAC;QAEF,MAAM,OAAO,CAAC,SAAS,CAAC,uCAAuC,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;OAKG;IACI,OAAO,CACZ,UAAkB;QAElB,IAAI,UAAU,IAAI,CAAC,EAAE,CAAC;YACpB,MAAM,IAAI,SAAS,CAAC,mDAAmD,CAAC,CAAC;QAC3E,CAAC;QACD,OAAO,IAAI,WAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IACpC,CAAC;IAED;;;;;OAKG;IACI,WAAW,CAChB,eAAuB;QAEvB,IAAI,eAAe,IAAI,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,SAAS,CAAC,qDAAqD,CAAC,CAAC;QAC7E,CAAC;QACD,OAAO,IAAI,mBAAQ,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;;;OASG;IACI,cAAc,CACnB,eAAuB,EACvB,GAAG,UAAyB;QAE5B,MAAM,OAAO,GAAqD;YAChE,GAAG,QAAQ,CAAC,qBAAqB,CAAC,OAAO;YACzC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW;YACxC,MAAM,EAAE,IAAI,CAAC,aAAa;YAC1B,eAAe,EAAE,eAAe;YAChC,UAAU,EAAE,UAAU;YACtB,QAAQ;gBACN,OAAO,QAAQ,CAAC,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACvD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,wBAAwB,EACxB,OAAO,EACP,QAAQ,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QACtC,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,QAAQ,CACnB,KAAa;QAEb,MAAM,OAAO,GAAuD;YAClE,GAAG,QAAQ,CAAC,uBAAuB,CAAC,OAAO;YAC3C,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW;YACxC,MAAM,EAAE,IAAI,CAAC,aAAa;YAC1B,KAAK,EAAE,KAAK;YACZ,QAAQ;gBACN,OAAO,QAAQ,CAAC,uBAAuB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACzD,CAAC;SACF,CAAC;QAEF,MAAM,OAAO,CAAC,SAAS,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;OAGG;IACK,cAAc;QACpB,MAAM,OAAO,GAAgD;YAC3D,GAAG,QAAQ,CAAC,gBAAgB,CAAC,OAAO;YACpC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW;YACxC,MAAM,EAAE,IAAI,CAAC,aAAa;YAC1B,QAAQ;gBACN,OAAO,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAClD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,kBAAkB,EAClB,OAAO,EACP,QAAQ,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QACtC,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;IAED;;;OAGG;IACI,QAAQ;QACb,MAAM,OAAO,GAAmD;YAC9D,GAAG,QAAQ,CAAC,mBAAmB,CAAC,OAAO;YACvC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW;YACxC,MAAM,EAAE,IAAI,CAAC,aAAa;YAC1B,QAAQ;gBACN,OAAO,QAAQ,CAAC,mBAAmB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACrD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,yBAAyB,EACzB,OAAO,EACP,QAAQ,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QACtC,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,QAAQ;QACnB,MAAM,OAAO,GAAgD;YAC3D,GAAG,QAAQ,CAAC,gBAAgB,CAAC,OAAO;YACpC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW;YACxC,MAAM,EAAE,IAAI,CAAC,aAAa;YAC1B,QAAQ;gBACN,OAAO,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAClD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,kBAAkB,EAClB,OAAO,EACP,QAAQ,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QACtC,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,QAAQ,CACnB,KAAa,EACb,UAAkC,EAAE;QAEpC,MAAM,EACJ,UAAU,GAAG,KAAK,GACnB,GAAG,OAAO,CAAC;QACZ,MAAM,OAAO,GAA+C;YAC1D,GAAG,QAAQ,CAAC,eAAe,CAAC,OAAO;YACnC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW;YACxC,MAAM,EAAE,IAAI,CAAC,aAAa;YAC1B,KAAK,EAAE,KAAK;YACZ,UAAU,EAAE,UAAU;YACtB,QAAQ;gBACN,OAAO,QAAQ,CAAC,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACjD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,yBAAyB,EACzB,OAAO,EACP,kDAAsB,CAAC,UAAU,CAAC,CAAC;QACrC,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,WAAW,CACtB,KAAa;QAEb,MAAM,OAAO,GAAkD;YAC7D,GAAG,QAAQ,CAAC,kBAAkB,CAAC,OAAO;YACtC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW;YACxC,MAAM,EAAE,IAAI,CAAC,aAAa;YAC1B,KAAK,EAAE,KAAK;YACZ,QAAQ;gBACN,OAAO,QAAQ,CAAC,kBAAkB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACpD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,sBAAsB,EACtB,OAAO,EACP,yDAAyB,CAAC,UAAU,CAAC,CAAC;QACxC,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,aAAa,CACxB,OAAe;QAEf,MAAM,OAAO,GAAoD;YAC/D,GAAG,QAAQ,CAAC,oBAAoB,CAAC,OAAO;YACxC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW;YACxC,MAAM,EAAE,IAAI,CAAC,aAAa;YAC1B,OAAO,EAAE,OAAO;YAChB,QAAQ;gBACN,OAAO,QAAQ,CAAC,oBAAoB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACtD,CAAC;SACF,CAAC;QAEF,MAAM,OAAO,CAAC,SAAS,CAAC,wBAAwB,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,QAAQ,CACnB,OAAe;QAEf,IAAI,OAAO,GAAG,CAAC,IAAI,OAAO,GAAG,EAAE,EAAE,CAAC;YAChC,MAAM,IAAI,SAAS,CAAC,4DAA4D,CAAC,CAAC;QACpF,CAAC;QACD,MAAM,OAAO,GAA+C;YAC1D,GAAG,QAAQ,CAAC,eAAe,CAAC,OAAO;YACnC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW;YACxC,MAAM,EAAE,IAAI,CAAC,aAAa;YAC1B,OAAO,EAAE,OAAO;YAChB,QAAQ;gBACN,OAAO,QAAQ,CAAC,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACjD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,iBAAiB,EACjB,OAAO,EACP,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;QACnC,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACK,iBAAiB;QACvB,MAAM,OAAO,GAAkD;YAC7D,GAAG,QAAQ,CAAC,kBAAkB,CAAC,OAAO;YACtC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW;YACxC,MAAM,EAAE,IAAI,CAAC,aAAa;YAC1B,QAAQ;gBACN,OAAO,QAAQ,CAAC,kBAAkB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACpD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,qBAAqB,EACrB,OAAO,EACP,gCAAc,CAAC,UAAU,CAAC,CAAC;QAC7B,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;OAGG;IACK,qBAAqB;QAC3B,MAAM,OAAO,GAAkD;YAC7D,GAAG,QAAQ,CAAC,kBAAkB,CAAC,OAAO;YACtC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW;YACxC,MAAM,EAAE,IAAI,CAAC,aAAa;YAC1B,QAAQ;gBACN,OAAO,QAAQ,CAAC,kBAAkB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACpD,CAAC;SACF,CAAC;QAEF,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,0BAA0B,EAC1B,OAAO,EACP,QAAQ,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QACpC,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;CACF;AAjmBD,wBAimBC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport { Connection } from './connection';\nimport { DeviceSettings } from './device_settings';\nimport { Axis } from './axis';\nimport { AllAxes } from './all_axes';\nimport { Warnings } from './warnings';\nimport { DeviceIdentity } from './device_identity';\nimport { DeviceIO } from './device_io';\nimport { Response } from './response';\nimport { Lockstep } from './lockstep';\nimport { Oscilloscope } from './oscilloscope';\nimport { CanSetStateDeviceResponse } from './can_set_state_device_response';\nimport { Pvt } from './pvt';\nimport { Measurement } from '../measurement';\nimport { FirmwareVersion } from '../firmware_version';\nimport * as gateway from '../gateway';\nimport * as requests from '../requests';\nimport { DeviceStorage } from './storage';\nimport { Triggers } from './triggers';\nimport { Streams } from './streams';\nimport { SetStateDeviceResponse } from './set_state_device_response';\n\n/**\n * Represents the controller part of one device - may be either a standalone controller or an integrated controller.\n */\nexport class Device {\n  /**\n   * Connection of this device.\n   */\n  public get connection(): Connection {\n    return this._connection;\n  }\n  private _connection: Connection;\n\n  /**\n   * The device address uniquely identifies the device on the connection.\n   * It can be configured or automatically assigned by the renumber command.\n   */\n  public get deviceAddress(): number {\n    return this._deviceAddress;\n  }\n  private _deviceAddress: number;\n\n  /**\n   * Settings and properties of this device.\n   */\n  public get settings(): DeviceSettings {\n    return this._settings;\n  }\n  private _settings: DeviceSettings;\n\n  /**\n   * Key-value storage of this device.\n   */\n  public get storage(): DeviceStorage {\n    return this._storage;\n  }\n  private _storage: DeviceStorage;\n\n  /**\n   * I/O channels of this device.\n   */\n  public get io(): DeviceIO {\n    return this._io;\n  }\n  private _io: DeviceIO;\n\n  /**\n   * Virtual axis which allows you to target all axes of this device.\n   */\n  public get allAxes(): AllAxes {\n    return this._allAxes;\n  }\n  private _allAxes: AllAxes;\n\n  /**\n   * Warnings and faults of this device and all its axes.\n   */\n  public get warnings(): Warnings {\n    return this._warnings;\n  }\n  private _warnings: Warnings;\n\n  /**\n   * Identity of the device.\n   */\n  public get identity(): DeviceIdentity {\n    return this._retrieveIdentity();\n  }\n\n  /**\n   * Indicates whether or not the device has been identified.\n   */\n  public get isIdentified(): boolean {\n    return this._retrieveIsIdentified();\n  }\n\n  /**\n   * Oscilloscope recording helper for this device.\n   * Requires at least Firmware 7.00.\n   */\n  public get oscilloscope(): Oscilloscope {\n    return this._oscilloscope;\n  }\n  private _oscilloscope: Oscilloscope;\n\n  /**\n   * Unique ID of the device hardware.\n   */\n  public get deviceId(): number {\n    return this.identity.deviceId;\n  }\n\n  /**\n   * Serial number of the device.\n   */\n  public get serialNumber(): number {\n    return this.identity.serialNumber;\n  }\n\n  /**\n   * Name of the product.\n   */\n  public get name(): string {\n    return this.identity.name;\n  }\n\n  /**\n   * Number of axes this device has.\n   */\n  public get axisCount(): number {\n    return this.identity.axisCount;\n  }\n\n  /**\n   * Version of the firmware.\n   */\n  public get firmwareVersion(): FirmwareVersion {\n    return this.identity.firmwareVersion;\n  }\n\n  /**\n   * The device is an integrated product.\n   */\n  public get isIntegrated(): boolean {\n    return this.identity.isIntegrated;\n  }\n\n  /**\n   * User-assigned label of the device.\n   */\n  public get label(): string {\n    return this._retrieveLabel();\n  }\n\n  /**\n   * Triggers for this device.\n   * Requires at least Firmware 7.06.\n   */\n  public get triggers(): Triggers {\n    return this._triggers;\n  }\n  private _triggers: Triggers;\n\n  /**\n   * Gets an object that provides access to Streams on this device.\n   * Requires at least Firmware 7.05.\n   */\n  public get streams(): Streams {\n    return this._streams;\n  }\n  private _streams: Streams;\n\n  /**\n   * Gets an object that provides access to PVT functions of this device.\n   * Note that as of ZML v5.0.0, this returns a Pvt object and NOT a PvtSequence object.\n   * The PvtSequence can now be obtained from the Pvt object.\n   * Requires at least Firmware 7.33.\n   */\n  public get pvt(): Pvt {\n    return this._pvt;\n  }\n  private _pvt: Pvt;\n\n  constructor(connection: Connection, deviceAddress: number) {\n    this._connection = connection;\n    this._deviceAddress = deviceAddress;\n    this._settings = new DeviceSettings(this);\n    this._storage = new DeviceStorage(this);\n    this._io = new DeviceIO(this);\n    this._allAxes = new AllAxes(this);\n    this._warnings = new Warnings(this, 0);\n    this._oscilloscope = new Oscilloscope(this);\n    this._triggers = new Triggers(this);\n    this._streams = new Streams(this);\n    this._pvt = new Pvt(this);\n  }\n\n  /**\n   * Queries the device and the database, gathering information about the product.\n   * Without this information features such as unit conversions will not work.\n   * Usually, called automatically by detect devices method.\n   * @param options.assumeVersion The identification assumes the specified firmware version\n   * instead of the version queried from the device.\n   * Providing this argument can lead to unexpected compatibility issues.\n   * @returns Device identification data.\n   */\n  public async identify(\n    options: Device.IdentifyOptions = {}\n  ): Promise<DeviceIdentity> {\n    const {\n      assumeVersion,\n    } = options;\n    const request: requests.DeviceIdentifyRequest & gateway.Message = {\n      ...requests.DeviceIdentifyRequest.DEFAULT,\n      interfaceId: this.connection.interfaceId,\n      device: this.deviceAddress,\n      assumeVersion: assumeVersion,\n      toBinary() {\n        return requests.DeviceIdentifyRequest.toBinary(this);\n      },\n    };\n\n    const response = await gateway.callAsync<DeviceIdentity>(\n      'device/identify',\n      request,\n      DeviceIdentity.fromBinary);\n    return response;\n  }\n\n  /**\n   * Sends a generic ASCII command to this device.\n   * For more information refer to: [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).\n   * @param command Command and its parameters.\n   * @param [options.axis=0] Optional axis number to send the command to.\n   * @param [options.checkErrors=true] Controls whether to throw an exception when the device rejects the command.\n   * @param [options.timeout=0] The timeout, in milliseconds, for a device to respond to the command.\n   * Overrides the connection default request timeout.\n   * @returns A response to the command.\n   */\n  public async genericCommand(\n    command: string,\n    options: Device.GenericCommandOptions = {}\n  ): Promise<Response> {\n    const {\n      axis = 0,\n      checkErrors = true,\n      timeout = 0,\n    } = options;\n    const request: requests.GenericCommandRequest & gateway.Message = {\n      ...requests.GenericCommandRequest.DEFAULT,\n      interfaceId: this.connection.interfaceId,\n      device: this.deviceAddress,\n      command: command,\n      axis: axis,\n      checkErrors: checkErrors,\n      timeout: timeout,\n      toBinary() {\n        return requests.GenericCommandRequest.toBinary(this);\n      },\n    };\n\n    const response = await gateway.callAsync<Response>(\n      'interface/generic_command',\n      request,\n      Response.fromBinary);\n    return response;\n  }\n\n  /**\n   * Sends a generic ASCII command to this device and expect multiple responses.\n   * Responses are returned in order of arrival.\n   * For more information refer to: [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).\n   * @param command Command and its parameters.\n   * @param [options.axis=0] Optional axis number to send the command to.\n   * @param [options.checkErrors=true] Controls whether to throw an exception when a device rejects the command.\n   * @param [options.timeout=0] The timeout, in milliseconds, for a device to respond to the command.\n   * Overrides the connection default request timeout.\n   * @returns All responses to the command.\n   */\n  public async genericCommandMultiResponse(\n    command: string,\n    options: Device.GenericCommandMultiResponseOptions = {}\n  ): Promise<Response[]> {\n    const {\n      axis = 0,\n      checkErrors = true,\n      timeout = 0,\n    } = options;\n    const request: requests.GenericCommandRequest & gateway.Message = {\n      ...requests.GenericCommandRequest.DEFAULT,\n      interfaceId: this.connection.interfaceId,\n      device: this.deviceAddress,\n      command: command,\n      axis: axis,\n      checkErrors: checkErrors,\n      timeout: timeout,\n      toBinary() {\n        return requests.GenericCommandRequest.toBinary(this);\n      },\n    };\n\n    const response = await gateway.callAsync<requests.GenericCommandResponseCollection>(\n      'interface/generic_command_multi_response',\n      request,\n      requests.GenericCommandResponseCollection.fromBinary);\n    return response.responses;\n  }\n\n  /**\n   * Sends a generic ASCII command to this device without expecting a response and without adding a message ID\n   * For more information refer to: [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).\n   * @param command Command and its parameters.\n   * @param [options.axis=0] Optional axis number to send the command to.\n   * Specifying -1 omits the number completely.\n   */\n  public async genericCommandNoResponse(\n    command: string,\n    options: Device.GenericCommandNoResponseOptions = {}\n  ): Promise<void> {\n    const {\n      axis = 0,\n    } = options;\n    const request: requests.GenericCommandRequest & gateway.Message = {\n      ...requests.GenericCommandRequest.DEFAULT,\n      interfaceId: this.connection.interfaceId,\n      device: this.deviceAddress,\n      command: command,\n      axis: axis,\n      toBinary() {\n        return requests.GenericCommandRequest.toBinary(this);\n      },\n    };\n\n    await gateway.callAsync('interface/generic_command_no_response', request);\n  }\n\n  /**\n   * Gets an Axis class instance which allows you to control a particular axis on this device.\n   * Axes are numbered from 1.\n   * @param axisNumber Number of axis intended to control.\n   * @returns Axis instance.\n   */\n  public getAxis(\n    axisNumber: number\n  ): Axis {\n    if (axisNumber <= 0) {\n      throw new TypeError('Invalid value; physical axes are numbered from 1.');\n    }\n    return new Axis(this, axisNumber);\n  }\n\n  /**\n   * Gets a Lockstep class instance which allows you to control a particular lockstep group on the device.\n   * Requires at least Firmware 6.15 or 7.11.\n   * @param lockstepGroupId The ID of the lockstep group to control. Lockstep group IDs start at one.\n   * @returns Lockstep instance.\n   */\n  public getLockstep(\n    lockstepGroupId: number\n  ): Lockstep {\n    if (lockstepGroupId <= 0) {\n      throw new TypeError('Invalid value; lockstep groups are numbered from 1.');\n    }\n    return new Lockstep(this, lockstepGroupId);\n  }\n\n  /**\n   * Formats parameters into a command and performs unit conversions.\n   * Parameters in the command template are denoted by a question mark.\n   * Command returned is only valid for this device.\n   * Unit conversion is not supported for commands where axes can be remapped, such as stream and PVT commands.\n   * For more information refer to: [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).\n   * @param commandTemplate Template of a command to prepare. Parameters are denoted by question marks.\n   * @param parameters Variable number of command parameters.\n   * @returns Command with converted parameters.\n   */\n  public prepareCommand(\n    commandTemplate: string,\n    ...parameters: Measurement[]\n  ): string {\n    const request: requests.PrepareCommandRequest & gateway.Message = {\n      ...requests.PrepareCommandRequest.DEFAULT,\n      interfaceId: this.connection.interfaceId,\n      device: this.deviceAddress,\n      commandTemplate: commandTemplate,\n      parameters: parameters,\n      toBinary() {\n        return requests.PrepareCommandRequest.toBinary(this);\n      },\n    };\n\n    const response = gateway.callSync<requests.StringResponse>(\n      'device/prepare_command',\n      request,\n      requests.StringResponse.fromBinary);\n    return response.value;\n  }\n\n  /**\n   * Sets the user-assigned device label.\n   * The label is stored on the controller and recognized by other software.\n   * @param label Label to set.\n   */\n  public async setLabel(\n    label: string\n  ): Promise<void> {\n    const request: requests.DeviceSetStorageRequest & gateway.Message = {\n      ...requests.DeviceSetStorageRequest.DEFAULT,\n      interfaceId: this.connection.interfaceId,\n      device: this.deviceAddress,\n      value: label,\n      toBinary() {\n        return requests.DeviceSetStorageRequest.toBinary(this);\n      },\n    };\n\n    await gateway.callAsync('device/set_label', request);\n  }\n\n  /**\n   * Gets the device name.\n   * @returns The label.\n   */\n  private _retrieveLabel(): string {\n    const request: requests.AxisEmptyRequest & gateway.Message = {\n      ...requests.AxisEmptyRequest.DEFAULT,\n      interfaceId: this.connection.interfaceId,\n      device: this.deviceAddress,\n      toBinary() {\n        return requests.AxisEmptyRequest.toBinary(this);\n      },\n    };\n\n    const response = gateway.callSync<requests.StringResponse>(\n      'device/get_label',\n      request,\n      requests.StringResponse.fromBinary);\n    return response.value;\n  }\n\n  /**\n   * Returns a string that represents the device.\n   * @returns A string that represents the device.\n   */\n  public toString(): string {\n    const request: requests.AxisToStringRequest & gateway.Message = {\n      ...requests.AxisToStringRequest.DEFAULT,\n      interfaceId: this.connection.interfaceId,\n      device: this.deviceAddress,\n      toBinary() {\n        return requests.AxisToStringRequest.toBinary(this);\n      },\n    };\n\n    const response = gateway.callSync<requests.StringResponse>(\n      'device/device_to_string',\n      request,\n      requests.StringResponse.fromBinary);\n    return response.value;\n  }\n\n  /**\n   * Returns a serialization of the current device state that can be saved and reapplied.\n   * @returns A serialization of the current state of the device.\n   */\n  public async getState(): Promise<string> {\n    const request: requests.AxisEmptyRequest & gateway.Message = {\n      ...requests.AxisEmptyRequest.DEFAULT,\n      interfaceId: this.connection.interfaceId,\n      device: this.deviceAddress,\n      toBinary() {\n        return requests.AxisEmptyRequest.toBinary(this);\n      },\n    };\n\n    const response = await gateway.callAsync<requests.StringResponse>(\n      'device/get_state',\n      request,\n      requests.StringResponse.fromBinary);\n    return response.value;\n  }\n\n  /**\n   * Applies a saved state to this device.\n   * @param state The state object to apply to this device.\n   * @param [options.deviceOnly=false] If true, only device scope settings and features will be set.\n   * @returns Reports of any issues that were handled, but caused the state to not be exactly restored.\n   */\n  public async setState(\n    state: string,\n    options: Device.SetStateOptions = {}\n  ): Promise<SetStateDeviceResponse> {\n    const {\n      deviceOnly = false,\n    } = options;\n    const request: requests.SetStateRequest & gateway.Message = {\n      ...requests.SetStateRequest.DEFAULT,\n      interfaceId: this.connection.interfaceId,\n      device: this.deviceAddress,\n      state: state,\n      deviceOnly: deviceOnly,\n      toBinary() {\n        return requests.SetStateRequest.toBinary(this);\n      },\n    };\n\n    const response = await gateway.callAsync<SetStateDeviceResponse>(\n      'device/set_device_state',\n      request,\n      SetStateDeviceResponse.fromBinary);\n    return response;\n  }\n\n  /**\n   * Checks if a state can be applied to this device.\n   * This only covers exceptions that can be determined statically such as mismatches of ID or version,\n   * the process of applying the state can still fail when running.\n   * @param state The state object to check against.\n   * @returns An object listing errors that come up when trying to set the state.\n   */\n  public async canSetState(\n    state: string\n  ): Promise<CanSetStateDeviceResponse> {\n    const request: requests.CanSetStateRequest & gateway.Message = {\n      ...requests.CanSetStateRequest.DEFAULT,\n      interfaceId: this.connection.interfaceId,\n      device: this.deviceAddress,\n      state: state,\n      toBinary() {\n        return requests.CanSetStateRequest.toBinary(this);\n      },\n    };\n\n    const response = await gateway.callAsync<CanSetStateDeviceResponse>(\n      'device/can_set_state',\n      request,\n      CanSetStateDeviceResponse.fromBinary);\n    return response;\n  }\n\n  /**\n   * Waits for the device to start responding to messages.\n   * Useful to call after resetting the device.\n   * Throws RequestTimeoutException upon timeout.\n   * @param timeout For how long to wait in milliseconds for the device to start responding.\n   */\n  public async waitToRespond(\n    timeout: number\n  ): Promise<void> {\n    const request: requests.WaitToRespondRequest & gateway.Message = {\n      ...requests.WaitToRespondRequest.DEFAULT,\n      interfaceId: this.connection.interfaceId,\n      device: this.deviceAddress,\n      timeout: timeout,\n      toBinary() {\n        return requests.WaitToRespondRequest.toBinary(this);\n      },\n    };\n\n    await gateway.callAsync('device/wait_to_respond', request);\n  }\n\n  /**\n   * Changes the address of this device.\n   * After the address is successfully changed, the existing device class instance no longer represents the device.\n   * Instead, use the new device instance returned by this method.\n   * @param address The new address to assign to the device.\n   * @returns New device instance with the new address.\n   */\n  public async renumber(\n    address: number\n  ): Promise<Device> {\n    if (address < 1 || address > 99) {\n      throw new TypeError('Invalid value; device addresses are numbered from 1 to 99.');\n    }\n    const request: requests.RenumberRequest & gateway.Message = {\n      ...requests.RenumberRequest.DEFAULT,\n      interfaceId: this.connection.interfaceId,\n      device: this.deviceAddress,\n      address: address,\n      toBinary() {\n        return requests.RenumberRequest.toBinary(this);\n      },\n    };\n\n    const response = await gateway.callAsync<requests.IntResponse>(\n      'device/renumber',\n      request,\n      requests.IntResponse.fromBinary);\n    return new Device(this.connection, response.value);\n  }\n\n  /**\n   * Returns identity.\n   * @returns Device identity.\n   */\n  private _retrieveIdentity(): DeviceIdentity {\n    const request: requests.DeviceEmptyRequest & gateway.Message = {\n      ...requests.DeviceEmptyRequest.DEFAULT,\n      interfaceId: this.connection.interfaceId,\n      device: this.deviceAddress,\n      toBinary() {\n        return requests.DeviceEmptyRequest.toBinary(this);\n      },\n    };\n\n    const response = gateway.callSync<DeviceIdentity>(\n      'device/get_identity',\n      request,\n      DeviceIdentity.fromBinary);\n    return response;\n  }\n\n  /**\n   * Returns whether or not the device have been identified.\n   * @returns True if the device has already been identified. False otherwise.\n   */\n  private _retrieveIsIdentified(): boolean {\n    const request: requests.DeviceEmptyRequest & gateway.Message = {\n      ...requests.DeviceEmptyRequest.DEFAULT,\n      interfaceId: this.connection.interfaceId,\n      device: this.deviceAddress,\n      toBinary() {\n        return requests.DeviceEmptyRequest.toBinary(this);\n      },\n    };\n\n    const response = gateway.callSync<requests.BoolResponse>(\n      'device/get_is_identified',\n      request,\n      requests.BoolResponse.fromBinary);\n    return response.value;\n  }\n}\n\nnamespace Device {\n  export interface IdentifyOptions {\n      /**\n       * The identification assumes the specified firmware version\n       * instead of the version queried from the device.\n       * Providing this argument can lead to unexpected compatibility issues.\n       */\n      assumeVersion?: FirmwareVersion;\n  }\n  export interface GenericCommandOptions {\n      /**\n       * Optional axis number to send the command to.\n       */\n      axis?: number;\n      /**\n       * Controls whether to throw an exception when the device rejects the command.\n       */\n      checkErrors?: boolean;\n      /**\n       * The timeout, in milliseconds, for a device to respond to the command.\n       * Overrides the connection default request timeout.\n       */\n      timeout?: number;\n  }\n  export interface GenericCommandMultiResponseOptions {\n      /**\n       * Optional axis number to send the command to.\n       */\n      axis?: number;\n      /**\n       * Controls whether to throw an exception when a device rejects the command.\n       */\n      checkErrors?: boolean;\n      /**\n       * The timeout, in milliseconds, for a device to respond to the command.\n       * Overrides the connection default request timeout.\n       */\n      timeout?: number;\n  }\n  export interface GenericCommandNoResponseOptions {\n      /**\n       * Optional axis number to send the command to.\n       * Specifying -1 omits the number completely.\n       */\n      axis?: number;\n  }\n  export interface SetStateOptions {\n      /**\n       * If true, only device scope settings and features will be set.\n       */\n      deviceOnly?: boolean;\n  }\n}\n"]}

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

@@ -41,6 +41,8 @@ export * from './response';
 export * from './servo_tuner';
 export * from './servo_tuning_param';
 export * from './servo_tuning_paramset';
+export * from './set_state_axis_response';
+export * from './set_state_device_response';
 export * from './setting_constants';
 export * from './simple_tuning';
 export * from './simple_tuning_param_definition';

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/ascii/index.ts"],"names":[],"mappings":"AACA,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iCAAiC,CAAC;AAChD,cAAc,cAAc,CAAC;AAC7B,cAAc,qBAAqB,CAAC;AACpC,cAAc,UAAU,CAAC;AACzB,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AACnC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mCAAmC,CAAC;AAClD,cAAc,qBAAqB,CAAC;AACpC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,OAAO,CAAC;AACtB,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kCAAkC,CAAC;AACjD,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,0BAA0B,CAAC;AACzC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,YAAY,CAAC;AAC3B,cAAc,0BAA0B,CAAC;AACzC,cAAc,iBAAiB,CAAC;AAChC,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/ascii/index.ts"],"names":[],"mappings":"AACA,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iCAAiC,CAAC;AAChD,cAAc,cAAc,CAAC;AAC7B,cAAc,qBAAqB,CAAC;AACpC,cAAc,UAAU,CAAC;AACzB,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AACnC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mCAAmC,CAAC;AAClD,cAAc,qBAAqB,CAAC;AACpC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,OAAO,CAAC;AACtB,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kCAAkC,CAAC;AACjD,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,0BAA0B,CAAC;AACzC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,YAAY,CAAC;AAC3B,cAAc,0BAA0B,CAAC;AACzC,cAAc,iBAAiB,CAAC;AAChC,cAAc,YAAY,CAAC"}

package/dist/lib/ascii/index.js

@@ -58,6 +58,8 @@ __exportStar(require("./response"), exports);
 __exportStar(require("./servo_tuner"), exports);
 __exportStar(require("./servo_tuning_param"), exports);
 __exportStar(require("./servo_tuning_paramset"), exports);
+__exportStar(require("./set_state_axis_response"), exports);
+__exportStar(require("./set_state_device_response"), exports);
 __exportStar(require("./setting_constants"), exports);
 __exportStar(require("./simple_tuning"), exports);
 __exportStar(require("./simple_tuning_param_definition"), exports);

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/ascii/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAoD;AACpD,gDAA8B;AAC9B,6CAA2B;AAC3B,yCAAuB;AACvB,+CAA6B;AAC7B,kDAAgC;AAChC,kDAAgC;AAChC,8CAA4B;AAC5B,gEAA8C;AAC9C,kEAAgD;AAChD,+CAA6B;AAC7B,sDAAoC;AACpC,2CAAyB;AACzB,oDAAkC;AAClC,8CAA4B;AAC5B,mDAAiC;AACjC,oDAAkC;AAClC,0DAAwC;AACxC,qDAAmC;AACnC,4DAA0C;AAC1C,gDAA8B;AAC9B,uDAAqC;AACrC,kDAAgC;AAChC,iDAA+B;AAC/B,6CAA2B;AAC3B,kDAAgC;AAChC,iDAA+B;AAC/B,iDAA+B;AAC/B,oEAAkD;AAClD,sDAAoC;AACpC,6DAA2C;AAC3C,kDAAgC;AAChC,+CAA6B;AAC7B,wCAAsB;AACtB,wDAAsC;AACtC,kDAAgC;AAChC,+CAA6B;AAC7B,2CAAyB;AACzB,6CAA2B;AAC3B,iDAA+B;AAC/B,6CAA2B;AAC3B,gDAA8B;AAC9B,uDAAqC;AACrC,0DAAwC;AACxC,sDAAoC;AACpC,kDAAgC;AAChC,mEAAiD;AACjD,4CAA0B;AAC1B,2CAAyB;AACzB,2DAAyC;AACzC,qDAAmC;AACnC,kDAAgC;AAChC,8CAA4B;AAC5B,gDAA8B;AAC9B,4CAA0B;AAC1B,8CAA4B;AAC5B,4CAA0B;AAC1B,mDAAiC;AACjC,sDAAoC;AACpC,0DAAwC;AACxC,sDAAoC;AACpC,kDAAgC;AAChC,6CAA2B;AAC3B,2DAAyC;AACzC,kDAAgC;AAChC,6CAA2B","sourcesContent":["/* This file is generated. Do not modify by hand. */\nexport * from './alert_event';\nexport * from './all_axes';\nexport * from './axis';\nexport * from './axis_group';\nexport * from './axis_identity';\nexport * from './axis_settings';\nexport * from './axis_type';\nexport * from './can_set_state_axis_response';\nexport * from './can_set_state_device_response';\nexport * from './connection';\nexport * from './conversion_factor';\nexport * from './device';\nexport * from './device_identity';\nexport * from './device_io';\nexport * from './device_io_info';\nexport * from './device_settings';\nexport * from './digital_output_action';\nexport * from './get_axis_setting';\nexport * from './get_axis_setting_result';\nexport * from './get_setting';\nexport * from './get_setting_result';\nexport * from './io_port_label';\nexport * from './io_port_type';\nexport * from './lockstep';\nexport * from './lockstep_axes';\nexport * from './message_type';\nexport * from './oscilloscope';\nexport * from './oscilloscope_capture_properties';\nexport * from './oscilloscope_data';\nexport * from './oscilloscope_data_source';\nexport * from './paramset_info';\nexport * from './pid_tuning';\nexport * from './pvt';\nexport * from './pvt_axis_definition';\nexport * from './pvt_axis_type';\nexport * from './pvt_buffer';\nexport * from './pvt_io';\nexport * from './pvt_mode';\nexport * from './pvt_sequence';\nexport * from './response';\nexport * from './servo_tuner';\nexport * from './servo_tuning_param';\nexport * from './servo_tuning_paramset';\nexport * from './setting_constants';\nexport * from './simple_tuning';\nexport * from './simple_tuning_param_definition';\nexport * from './storage';\nexport * from './stream';\nexport * from './stream_axis_definition';\nexport * from './stream_axis_type';\nexport * from './stream_buffer';\nexport * from './stream_io';\nexport * from './stream_mode';\nexport * from './streams';\nexport * from './transport';\nexport * from './trigger';\nexport * from './trigger_action';\nexport * from './trigger_condition';\nexport * from './trigger_enabled_state';\nexport * from './trigger_operation';\nexport * from './trigger_state';\nexport * from './triggers';\nexport * from './unknown_response_event';\nexport * from './warning_flags';\nexport * from './warnings';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/ascii/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAoD;AACpD,gDAA8B;AAC9B,6CAA2B;AAC3B,yCAAuB;AACvB,+CAA6B;AAC7B,kDAAgC;AAChC,kDAAgC;AAChC,8CAA4B;AAC5B,gEAA8C;AAC9C,kEAAgD;AAChD,+CAA6B;AAC7B,sDAAoC;AACpC,2CAAyB;AACzB,oDAAkC;AAClC,8CAA4B;AAC5B,mDAAiC;AACjC,oDAAkC;AAClC,0DAAwC;AACxC,qDAAmC;AACnC,4DAA0C;AAC1C,gDAA8B;AAC9B,uDAAqC;AACrC,kDAAgC;AAChC,iDAA+B;AAC/B,6CAA2B;AAC3B,kDAAgC;AAChC,iDAA+B;AAC/B,iDAA+B;AAC/B,oEAAkD;AAClD,sDAAoC;AACpC,6DAA2C;AAC3C,kDAAgC;AAChC,+CAA6B;AAC7B,wCAAsB;AACtB,wDAAsC;AACtC,kDAAgC;AAChC,+CAA6B;AAC7B,2CAAyB;AACzB,6CAA2B;AAC3B,iDAA+B;AAC/B,6CAA2B;AAC3B,gDAA8B;AAC9B,uDAAqC;AACrC,0DAAwC;AACxC,4DAA0C;AAC1C,8DAA4C;AAC5C,sDAAoC;AACpC,kDAAgC;AAChC,mEAAiD;AACjD,4CAA0B;AAC1B,2CAAyB;AACzB,2DAAyC;AACzC,qDAAmC;AACnC,kDAAgC;AAChC,8CAA4B;AAC5B,gDAA8B;AAC9B,4CAA0B;AAC1B,8CAA4B;AAC5B,4CAA0B;AAC1B,mDAAiC;AACjC,sDAAoC;AACpC,0DAAwC;AACxC,sDAAoC;AACpC,kDAAgC;AAChC,6CAA2B;AAC3B,2DAAyC;AACzC,kDAAgC;AAChC,6CAA2B","sourcesContent":["/* This file is generated. Do not modify by hand. */\nexport * from './alert_event';\nexport * from './all_axes';\nexport * from './axis';\nexport * from './axis_group';\nexport * from './axis_identity';\nexport * from './axis_settings';\nexport * from './axis_type';\nexport * from './can_set_state_axis_response';\nexport * from './can_set_state_device_response';\nexport * from './connection';\nexport * from './conversion_factor';\nexport * from './device';\nexport * from './device_identity';\nexport * from './device_io';\nexport * from './device_io_info';\nexport * from './device_settings';\nexport * from './digital_output_action';\nexport * from './get_axis_setting';\nexport * from './get_axis_setting_result';\nexport * from './get_setting';\nexport * from './get_setting_result';\nexport * from './io_port_label';\nexport * from './io_port_type';\nexport * from './lockstep';\nexport * from './lockstep_axes';\nexport * from './message_type';\nexport * from './oscilloscope';\nexport * from './oscilloscope_capture_properties';\nexport * from './oscilloscope_data';\nexport * from './oscilloscope_data_source';\nexport * from './paramset_info';\nexport * from './pid_tuning';\nexport * from './pvt';\nexport * from './pvt_axis_definition';\nexport * from './pvt_axis_type';\nexport * from './pvt_buffer';\nexport * from './pvt_io';\nexport * from './pvt_mode';\nexport * from './pvt_sequence';\nexport * from './response';\nexport * from './servo_tuner';\nexport * from './servo_tuning_param';\nexport * from './servo_tuning_paramset';\nexport * from './set_state_axis_response';\nexport * from './set_state_device_response';\nexport * from './setting_constants';\nexport * from './simple_tuning';\nexport * from './simple_tuning_param_definition';\nexport * from './storage';\nexport * from './stream';\nexport * from './stream_axis_definition';\nexport * from './stream_axis_type';\nexport * from './stream_buffer';\nexport * from './stream_io';\nexport * from './stream_mode';\nexport * from './streams';\nexport * from './transport';\nexport * from './trigger';\nexport * from './trigger_action';\nexport * from './trigger_condition';\nexport * from './trigger_enabled_state';\nexport * from './trigger_operation';\nexport * from './trigger_state';\nexport * from './triggers';\nexport * from './unknown_response_event';\nexport * from './warning_flags';\nexport * from './warnings';\n"]}

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

@@ -196,54 +196,162 @@ export declare class Lockstep {
 }
 declare namespace Lockstep {
     interface StopOptions {
+        /**
+         * Determines whether function should return after the movement is finished or just started.
+         */
         waitUntilIdle?: boolean;
     }
     interface HomeOptions {
+        /**
+         * Determines whether function should return after the movement is finished or just started.
+         */
         waitUntilIdle?: boolean;
     }
     interface MoveAbsoluteOptions {
+        /**
+         * Determines whether function should return after the movement is finished or just started.
+         */
         waitUntilIdle?: boolean;
+        /**
+         * Movement velocity.
+         * Default value of 0 indicates that the maxspeed setting is used instead.
+         * Requires at least Firmware 7.25.
+         */
         velocity?: number;
+        /**
+         * Units of velocity.
+         */
         velocityUnit?: Velocity | AngularVelocity | Native;
+        /**
+         * Movement acceleration.
+         * Default value of 0 indicates that the accel setting is used instead.
+         * Requires at least Firmware 7.25.
+         */
         acceleration?: number;
+        /**
+         * Units of acceleration.
+         */
         accelerationUnit?: Acceleration | AngularAcceleration | Native;
     }
     interface MoveRelativeOptions {
+        /**
+         * Determines whether function should return after the movement is finished or just started.
+         */
         waitUntilIdle?: boolean;
+        /**
+         * Movement velocity.
+         * Default value of 0 indicates that the maxspeed setting is used instead.
+         * Requires at least Firmware 7.25.
+         */
         velocity?: number;
+        /**
+         * Units of velocity.
+         */
         velocityUnit?: Velocity | AngularVelocity | Native;
+        /**
+         * Movement acceleration.
+         * Default value of 0 indicates that the accel setting is used instead.
+         * Requires at least Firmware 7.25.
+         */
         acceleration?: number;
+        /**
+         * Units of acceleration.
+         */
         accelerationUnit?: Acceleration | AngularAcceleration | Native;
     }
     interface MoveVelocityOptions {
+        /**
+         * Movement acceleration.
+         * Default value of 0 indicates that the accel setting is used instead.
+         * Requires at least Firmware 7.25.
+         */
         acceleration?: number;
+        /**
+         * Units of acceleration.
+         */
         accelerationUnit?: Acceleration | AngularAcceleration | Native;
     }
     interface MoveSinOptions {
+        /**
+         * Number of sinusoidal cycles to complete.
+         * Must be a multiple of 0.5
+         * If count is not specified or set to 0, the axis will move indefinitely.
+         */
         count?: number;
+        /**
+         * Determines whether function should return after the movement is finished or just started.
+         */
         waitUntilIdle?: boolean;
     }
     interface MoveSinStopOptions {
+        /**
+         * Determines whether function should return after the movement is finished.
+         */
         waitUntilIdle?: boolean;
     }
     interface MoveMaxOptions {
+        /**
+         * Determines whether function should return after the movement is finished or just started.
+         */
         waitUntilIdle?: boolean;
+        /**
+         * Movement velocity.
+         * Default value of 0 indicates that the maxspeed setting is used instead.
+         * Requires at least Firmware 7.25.
+         */
         velocity?: number;
+        /**
+         * Units of velocity.
+         */
         velocityUnit?: Velocity | AngularVelocity | Native;
+        /**
+         * Movement acceleration.
+         * Default value of 0 indicates that the accel setting is used instead.
+         * Requires at least Firmware 7.25.
+         */
         acceleration?: number;
+        /**
+         * Units of acceleration.
+         */
         accelerationUnit?: Acceleration | AngularAcceleration | Native;
     }
     interface MoveMinOptions {
+        /**
+         * Determines whether function should return after the movement is finished or just started.
+         */
         waitUntilIdle?: boolean;
+        /**
+         * Movement velocity.
+         * Default value of 0 indicates that the maxspeed setting is used instead.
+         * Requires at least Firmware 7.25.
+         */
         velocity?: number;
+        /**
+         * Units of velocity.
+         */
         velocityUnit?: Velocity | AngularVelocity | Native;
+        /**
+         * Movement acceleration.
+         * Default value of 0 indicates that the accel setting is used instead.
+         * Requires at least Firmware 7.25.
+         */
         acceleration?: number;
+        /**
+         * Units of acceleration.
+         */
         accelerationUnit?: Acceleration | AngularAcceleration | Native;
     }
     interface WaitUntilIdleOptions {
+        /**
+         * Determines whether to throw error when fault is observed.
+         */
         throwErrorOnFault?: boolean;
     }
     interface SetToleranceOptions {
+        /**
+         * Optional index of a secondary axis to set the tolerance for.
+         * If left empty or set to 0, the tolerance is set to all the secondary axes.
+         */
         axisIndex?: number;
     }
 }

package/dist/lib/ascii/lockstep.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"lockstep.d.ts","sourceRoot":"","sources":["../../../src/ascii/lockstep.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,QAAQ,EAAE,YAAY,EAAE,mBAAmB,EAAS,IAAI,EAAE,MAAM,UAAU,CAAC;AAG5H,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C;;;;GAIG;AACH,qBAAa,QAAQ;IACnB;;OAEG;IACH,IAAW,MAAM,IAAI,MAAM,CAE1B;IACD,OAAO,CAAC,OAAO,CAAS;IAExB;;OAEG;IACH,IAAW,eAAe,IAAI,MAAM,CAEnC;IACD,OAAO,CAAC,gBAAgB,CAAS;gBAErB,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM;IAKnD;;;OAGG;IACU,MAAM,CACjB,GAAG,IAAI,EAAE,MAAM,EAAE,GAChB,OAAO,CAAC,IAAI,CAAC;IAehB;;OAEG;IACU,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAcrC;;;OAGG;IACU,IAAI,CACf,OAAO,GAAE,QAAQ,CAAC,WAAgB,GACjC,OAAO,CAAC,IAAI,CAAC;IAkBhB;;;OAGG;IACU,IAAI,CACf,OAAO,GAAE,QAAQ,CAAC,WAAgB,GACjC,OAAO,CAAC,IAAI,CAAC;IAkBhB;;;;;;;;;;;;;;OAcG;IACU,YAAY,CACvB,QAAQ,EAAE,MAAM,EAChB,IAAI,GAAE,MAAM,GAAG,KAAK,GAAG,MAAqB,EAC5C,OAAO,GAAE,QAAQ,CAAC,mBAAwB,GACzC,OAAO,CAAC,IAAI,CAAC;IA6BhB;;;;;;;;;;;;;;OAcG;IACU,YAAY,CACvB,QAAQ,EAAE,MAAM,EAChB,IAAI,GAAE,MAAM,GAAG,KAAK,GAAG,MAAqB,EAC5C,OAAO,GAAE,QAAQ,CAAC,mBAAwB,GACzC,OAAO,CAAC,IAAI,CAAC;IA6BhB;;;;;;;;;OASG;IACU,YAAY,CACvB,QAAQ,EAAE,MAAM,EAChB,IAAI,GAAE,QAAQ,GAAG,eAAe,GAAG,MAAqB,EACxD,OAAO,GAAE,QAAQ,CAAC,mBAAwB,GACzC,OAAO,CAAC,IAAI,CAAC;IAuBhB;;;;;;;;;;;OAWG;IACU,OAAO,CAClB,SAAS,EAAE,MAAM,EACjB,cAAc,EAAE,MAAM,GAAG,KAAK,GAAG,MAAM,EACvC,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,IAAI,GAAG,MAAM,EAC1B,OAAO,GAAE,QAAQ,CAAC,cAAmB,GACpC,OAAO,CAAC,IAAI,CAAC;IAwBhB;;;;;OAKG;IACU,WAAW,CACtB,OAAO,GAAE,QAAQ,CAAC,kBAAuB,GACxC,OAAO,CAAC,IAAI,CAAC;IAkBhB;;;;;;;;;;;;;OAaG;IACU,OAAO,CAClB,OAAO,GAAE,QAAQ,CAAC,cAAmB,GACpC,OAAO,CAAC,IAAI,CAAC;IA2BhB;;;;;;;;;;;;;OAaG;IACU,OAAO,CAClB,OAAO,GAAE,QAAQ,CAAC,cAAmB,GACpC,OAAO,CAAC,IAAI,CAAC;IA2BhB;;;OAGG;IACU,aAAa,CACxB,OAAO,GAAE,QAAQ,CAAC,oBAAyB,GAC1C,OAAO,CAAC,IAAI,CAAC;IAkBhB;;;OAGG;IACU,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC;IAkBvC;;;;;OAKG;IACU,OAAO,IAAI,OAAO,CAAC,YAAY,CAAC;IAkB7C;;;OAGG;IACU,cAAc,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAkBhD;;;;;OAKG;IACU,UAAU,CACrB,IAAI,GAAE,MAAM,GAAG,KAAK,GAAG,MAAqB,GAC3C,OAAO,CAAC,MAAM,EAAE,CAAC;IAmBpB;;;;;OAKG;IACU,SAAS,CACpB,IAAI,GAAE,MAAM,GAAG,KAAK,GAAG,MAAqB,GAC3C,OAAO,CAAC,MAAM,EAAE,CAAC;IAmBpB;;;;OAIG;IACU,WAAW,CACtB,IAAI,GAAE,MAAM,GAAG,KAAK,GAAG,MAAqB,GAC3C,OAAO,CAAC,MAAM,CAAC;IAmBlB;;;;;;;;;OASG;IACU,YAAY,CACvB,SAAS,EAAE,MAAM,EACjB,IAAI,GAAE,MAAM,GAAG,KAAK,GAAG,MAAqB,EAC5C,OAAO,GAAE,QAAQ,CAAC,mBAAwB,GACzC,OAAO,CAAC,IAAI,CAAC;IAoBhB;;;OAGG;IACU,SAAS,IAAI,OAAO,CAAC,OAAO,CAAC;IAkB1C;;;OAGG;IACI,QAAQ,IAAI,MAAM;CAiB1B;AAED,kBAAU,QAAQ,CAAC;IACjB,UAAiB,WAAW;QACxB,aAAa,CAAC,EAAE,OAAO,CAAC;KAC3B;IACD,UAAiB,WAAW;QACxB,aAAa,CAAC,EAAE,OAAO,CAAC;KAC3B;IACD,UAAiB,mBAAmB;QAChC,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,YAAY,CAAC,EAAE,QAAQ,GAAG,eAAe,GAAG,MAAM,CAAC;QACnD,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,gBAAgB,CAAC,EAAE,YAAY,GAAG,mBAAmB,GAAG,MAAM,CAAC;KAClE;IACD,UAAiB,mBAAmB;QAChC,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,YAAY,CAAC,EAAE,QAAQ,GAAG,eAAe,GAAG,MAAM,CAAC;QACnD,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,gBAAgB,CAAC,EAAE,YAAY,GAAG,mBAAmB,GAAG,MAAM,CAAC;KAClE;IACD,UAAiB,mBAAmB;QAChC,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,gBAAgB,CAAC,EAAE,YAAY,GAAG,mBAAmB,GAAG,MAAM,CAAC;KAClE;IACD,UAAiB,cAAc;QAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,aAAa,CAAC,EAAE,OAAO,CAAC;KAC3B;IACD,UAAiB,kBAAkB;QAC/B,aAAa,CAAC,EAAE,OAAO,CAAC;KAC3B;IACD,UAAiB,cAAc;QAC3B,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,YAAY,CAAC,EAAE,QAAQ,GAAG,eAAe,GAAG,MAAM,CAAC;QACnD,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,gBAAgB,CAAC,EAAE,YAAY,GAAG,mBAAmB,GAAG,MAAM,CAAC;KAClE;IACD,UAAiB,cAAc;QAC3B,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,YAAY,CAAC,EAAE,QAAQ,GAAG,eAAe,GAAG,MAAM,CAAC;QACnD,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,gBAAgB,CAAC,EAAE,YAAY,GAAG,mBAAmB,GAAG,MAAM,CAAC;KAClE;IACD,UAAiB,oBAAoB;QACjC,iBAAiB,CAAC,EAAE,OAAO,CAAC;KAC/B;IACD,UAAiB,mBAAmB;QAChC,SAAS,CAAC,EAAE,MAAM,CAAC;KACtB;CACF"}
+{"version":3,"file":"lockstep.d.ts","sourceRoot":"","sources":["../../../src/ascii/lockstep.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,QAAQ,EAAE,YAAY,EAAE,mBAAmB,EAAS,IAAI,EAAE,MAAM,UAAU,CAAC;AAG5H,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C;;;;GAIG;AACH,qBAAa,QAAQ;IACnB;;OAEG;IACH,IAAW,MAAM,IAAI,MAAM,CAE1B;IACD,OAAO,CAAC,OAAO,CAAS;IAExB;;OAEG;IACH,IAAW,eAAe,IAAI,MAAM,CAEnC;IACD,OAAO,CAAC,gBAAgB,CAAS;gBAErB,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM;IAKnD;;;OAGG;IACU,MAAM,CACjB,GAAG,IAAI,EAAE,MAAM,EAAE,GAChB,OAAO,CAAC,IAAI,CAAC;IAehB;;OAEG;IACU,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAcrC;;;OAGG;IACU,IAAI,CACf,OAAO,GAAE,QAAQ,CAAC,WAAgB,GACjC,OAAO,CAAC,IAAI,CAAC;IAkBhB;;;OAGG;IACU,IAAI,CACf,OAAO,GAAE,QAAQ,CAAC,WAAgB,GACjC,OAAO,CAAC,IAAI,CAAC;IAkBhB;;;;;;;;;;;;;;OAcG;IACU,YAAY,CACvB,QAAQ,EAAE,MAAM,EAChB,IAAI,GAAE,MAAM,GAAG,KAAK,GAAG,MAAqB,EAC5C,OAAO,GAAE,QAAQ,CAAC,mBAAwB,GACzC,OAAO,CAAC,IAAI,CAAC;IA6BhB;;;;;;;;;;;;;;OAcG;IACU,YAAY,CACvB,QAAQ,EAAE,MAAM,EAChB,IAAI,GAAE,MAAM,GAAG,KAAK,GAAG,MAAqB,EAC5C,OAAO,GAAE,QAAQ,CAAC,mBAAwB,GACzC,OAAO,CAAC,IAAI,CAAC;IA6BhB;;;;;;;;;OASG;IACU,YAAY,CACvB,QAAQ,EAAE,MAAM,EAChB,IAAI,GAAE,QAAQ,GAAG,eAAe,GAAG,MAAqB,EACxD,OAAO,GAAE,QAAQ,CAAC,mBAAwB,GACzC,OAAO,CAAC,IAAI,CAAC;IAuBhB;;;;;;;;;;;OAWG;IACU,OAAO,CAClB,SAAS,EAAE,MAAM,EACjB,cAAc,EAAE,MAAM,GAAG,KAAK,GAAG,MAAM,EACvC,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,IAAI,GAAG,MAAM,EAC1B,OAAO,GAAE,QAAQ,CAAC,cAAmB,GACpC,OAAO,CAAC,IAAI,CAAC;IAwBhB;;;;;OAKG;IACU,WAAW,CACtB,OAAO,GAAE,QAAQ,CAAC,kBAAuB,GACxC,OAAO,CAAC,IAAI,CAAC;IAkBhB;;;;;;;;;;;;;OAaG;IACU,OAAO,CAClB,OAAO,GAAE,QAAQ,CAAC,cAAmB,GACpC,OAAO,CAAC,IAAI,CAAC;IA2BhB;;;;;;;;;;;;;OAaG;IACU,OAAO,CAClB,OAAO,GAAE,QAAQ,CAAC,cAAmB,GACpC,OAAO,CAAC,IAAI,CAAC;IA2BhB;;;OAGG;IACU,aAAa,CACxB,OAAO,GAAE,QAAQ,CAAC,oBAAyB,GAC1C,OAAO,CAAC,IAAI,CAAC;IAkBhB;;;OAGG;IACU,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC;IAkBvC;;;;;OAKG;IACU,OAAO,IAAI,OAAO,CAAC,YAAY,CAAC;IAkB7C;;;OAGG;IACU,cAAc,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAkBhD;;;;;OAKG;IACU,UAAU,CACrB,IAAI,GAAE,MAAM,GAAG,KAAK,GAAG,MAAqB,GAC3C,OAAO,CAAC,MAAM,EAAE,CAAC;IAmBpB;;;;;OAKG;IACU,SAAS,CACpB,IAAI,GAAE,MAAM,GAAG,KAAK,GAAG,MAAqB,GAC3C,OAAO,CAAC,MAAM,EAAE,CAAC;IAmBpB;;;;OAIG;IACU,WAAW,CACtB,IAAI,GAAE,MAAM,GAAG,KAAK,GAAG,MAAqB,GAC3C,OAAO,CAAC,MAAM,CAAC;IAmBlB;;;;;;;;;OASG;IACU,YAAY,CACvB,SAAS,EAAE,MAAM,EACjB,IAAI,GAAE,MAAM,GAAG,KAAK,GAAG,MAAqB,EAC5C,OAAO,GAAE,QAAQ,CAAC,mBAAwB,GACzC,OAAO,CAAC,IAAI,CAAC;IAoBhB;;;OAGG;IACU,SAAS,IAAI,OAAO,CAAC,OAAO,CAAC;IAkB1C;;;OAGG;IACI,QAAQ,IAAI,MAAM;CAiB1B;AAED,kBAAU,QAAQ,CAAC;IACjB,UAAiB,WAAW;QACxB;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;KAC3B;IACD,UAAiB,WAAW;QACxB;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;KAC3B;IACD,UAAiB,mBAAmB;QAChC;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB;;WAEG;QACH,YAAY,CAAC,EAAE,QAAQ,GAAG,eAAe,GAAG,MAAM,CAAC;QACnD;;;;WAIG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB;;WAEG;QACH,gBAAgB,CAAC,EAAE,YAAY,GAAG,mBAAmB,GAAG,MAAM,CAAC;KAClE;IACD,UAAiB,mBAAmB;QAChC;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB;;WAEG;QACH,YAAY,CAAC,EAAE,QAAQ,GAAG,eAAe,GAAG,MAAM,CAAC;QACnD;;;;WAIG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB;;WAEG;QACH,gBAAgB,CAAC,EAAE,YAAY,GAAG,mBAAmB,GAAG,MAAM,CAAC;KAClE;IACD,UAAiB,mBAAmB;QAChC;;;;WAIG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB;;WAEG;QACH,gBAAgB,CAAC,EAAE,YAAY,GAAG,mBAAmB,GAAG,MAAM,CAAC;KAClE;IACD,UAAiB,cAAc;QAC3B;;;;WAIG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QACf;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;KAC3B;IACD,UAAiB,kBAAkB;QAC/B;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;KAC3B;IACD,UAAiB,cAAc;QAC3B;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB;;WAEG;QACH,YAAY,CAAC,EAAE,QAAQ,GAAG,eAAe,GAAG,MAAM,CAAC;QACnD;;;;WAIG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB;;WAEG;QACH,gBAAgB,CAAC,EAAE,YAAY,GAAG,mBAAmB,GAAG,MAAM,CAAC;KAClE;IACD,UAAiB,cAAc;QAC3B;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB;;WAEG;QACH,YAAY,CAAC,EAAE,QAAQ,GAAG,eAAe,GAAG,MAAM,CAAC;QACnD;;;;WAIG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB;;WAEG;QACH,gBAAgB,CAAC,EAAE,YAAY,GAAG,mBAAmB,GAAG,MAAM,CAAC;KAClE;IACD,UAAiB,oBAAoB;QACjC;;WAEG;QACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;KAC/B;IACD,UAAiB,mBAAmB;QAChC;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACtB;CACF"}