@zaber/motion 3.2.1 → 3.4.0

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

@@ -0,0 +1,17 @@
+import { PvtAxisType } from './pvt_axis_type';
+/**
+ * Defines an axis of the PVT sequence.
+ */
+export interface PvtAxisDefinition {
+    /**
+     * Number of a physical axis or a lockstep group.
+     */
+    axisNumber: number;
+    /**
+     * Defines the type of the axis.
+     */
+    axisType?: PvtAxisType;
+}
+export declare namespace PvtAxisDefinition {
+    const __type = "PvtAxisDefinition";
+}

package/dist/lib/ascii/pvt_axis_definition.js

@@ -0,0 +1,53 @@
+"use strict";
+// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //
+// ============= DO NOT EDIT DIRECTLY ============= //
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PvtAxisDefinition = void 0;
+const gateway = __importStar(require("../gateway"));
+var PvtAxisDefinition;
+(function (PvtAxisDefinition) {
+    PvtAxisDefinition.__type = 'PvtAxisDefinition';
+    /** @internal */
+    function fromProtobuf(pbData) {
+        return {
+            axisNumber: pbData.axisNumber,
+            axisType: pbData.axisType,
+        };
+    }
+    PvtAxisDefinition.fromProtobuf = fromProtobuf;
+    /** @internal */
+    function toProtobuf(source) {
+        const pbData = new gateway.StreamAxisDefinition();
+        if (source == null) {
+            return pbData;
+        }
+        pbData.setAxisNumber(source.axisNumber);
+        pbData.setAxisType(source.axisType);
+        return pbData;
+    }
+    PvtAxisDefinition.toProtobuf = toProtobuf;
+})(PvtAxisDefinition = exports.PvtAxisDefinition || (exports.PvtAxisDefinition = {}));
+//# sourceMappingURL=pvt_axis_definition.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pvt_axis_definition.js","sourceRoot":"","sources":["../../../src/ascii/pvt_axis_definition.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtD,oDAAsC;AAmBtC,IAAiB,iBAAiB,CAqBjC;AArBD,WAAiB,iBAAiB;IACnB,wBAAM,GAAG,mBAAmB,CAAC;IAE1C,gBAAgB;IAChB,SAAgB,YAAY,CAAC,MAA6C;QACxE,OAAO;YACL,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,QAAQ,EAAE,MAAM,CAAC,QAAe;SACjC,CAAC;IACJ,CAAC;IALe,8BAAY,eAK3B,CAAA;IACD,gBAAgB;IAChB,SAAgB,UAAU,CAAC,MAA4C;QACrE,MAAM,MAAM,GAAG,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC;QAClD,IAAI,MAAM,IAAI,IAAI,EAAE;YAClB,OAAO,MAAM,CAAC;SACf;QAED,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACxC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,QAAS,CAAC,CAAC;QACrC,OAAO,MAAM,CAAC;IAChB,CAAC;IATe,4BAAU,aASzB,CAAA;AACH,CAAC,EArBgB,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAqBjC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport * as gateway from '../gateway';\nimport { PvtAxisType } from './pvt_axis_type';\n\n/**\n * Defines an axis of the PVT sequence.\n */\nexport interface PvtAxisDefinition {\n  /**\n   * Number of a physical axis or a lockstep group.\n   */\n  axisNumber: number;\n\n  /**\n   * Defines the type of the axis.\n   */\n  axisType?: PvtAxisType;\n\n}\n\nexport namespace PvtAxisDefinition {\n  export const __type = 'PvtAxisDefinition';\n\n  /** @internal */\n  export function fromProtobuf(pbData: gateway.StreamAxisDefinition.AsObject): PvtAxisDefinition {\n    return {\n      axisNumber: pbData.axisNumber,\n      axisType: pbData.axisType as any,\n    };\n  }\n  /** @internal */\n  export function toProtobuf(source: PvtAxisDefinition | null | undefined): gateway.StreamAxisDefinition {\n    const pbData = new gateway.StreamAxisDefinition();\n    if (source == null) {\n      return pbData;\n    }\n\n    pbData.setAxisNumber(source.axisNumber);\n    pbData.setAxisType(source.axisType!);\n    return pbData;\n  }\n}\n"]}

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

@@ -0,0 +1,7 @@
+/**
+ * Denotes type of the PVT sequence axis.
+ */
+export declare enum PvtAxisType {
+    PHYSICAL = 0,
+    LOCKSTEP = 1
+}

package/dist/lib/ascii/pvt_axis_type.js

@@ -0,0 +1,14 @@
+"use strict";
+// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //
+// ============= DO NOT EDIT DIRECTLY ============= //
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PvtAxisType = void 0;
+/**
+ * Denotes type of the PVT sequence axis.
+ */
+var PvtAxisType;
+(function (PvtAxisType) {
+    PvtAxisType[PvtAxisType["PHYSICAL"] = 0] = "PHYSICAL";
+    PvtAxisType[PvtAxisType["LOCKSTEP"] = 1] = "LOCKSTEP";
+})(PvtAxisType = exports.PvtAxisType || (exports.PvtAxisType = {}));
+//# sourceMappingURL=pvt_axis_type.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pvt_axis_type.js","sourceRoot":"","sources":["../../../src/ascii/pvt_axis_type.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;AAEtD;;GAEG;AACH,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,qDAAY,CAAA;IACZ,qDAAY,CAAA;AACd,CAAC,EAHW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAGtB","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\n/**\n * Denotes type of the PVT sequence axis.\n */\nexport enum PvtAxisType {\n  PHYSICAL = 0,\n  LOCKSTEP = 1,\n}\n"]}

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

@@ -0,0 +1,28 @@
+import { Device } from './device';
+/**
+ * Represents a PVT buffer with this number on a device.
+ * A PVT buffer is a place to store a queue of PVT actions.
+ */
+export declare class PvtBuffer {
+    /**
+     * The Device this buffer exists on.
+     */
+    get device(): Device;
+    private _device;
+    /**
+     * The number identifying the buffer on the device.
+     */
+    get bufferId(): number;
+    private _bufferId;
+    constructor(device: Device, bufferId: number);
+    /**
+     * Gets the buffer contents as an array of strings.
+     * @returns A string array containing all the PVT commands stored in the buffer.
+     */
+    getContent(): Promise<string[]>;
+    /**
+     * Erases the contents of the buffer.
+     * This method fails if there is a PVT sequence writing to the buffer.
+     */
+    erase(): Promise<void>;
+}

package/dist/lib/ascii/pvt_buffer.js

@@ -0,0 +1,78 @@
+"use strict";
+// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //
+// ============= DO NOT EDIT DIRECTLY ============= //
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PvtBuffer = void 0;
+const gateway = __importStar(require("../gateway"));
+/**
+ * Represents a PVT buffer with this number on a device.
+ * A PVT buffer is a place to store a queue of PVT actions.
+ */
+class PvtBuffer {
+    /**
+     * The Device this buffer exists on.
+     */
+    get device() {
+        return this._device;
+    }
+    /**
+     * The number identifying the buffer on the device.
+     */
+    get bufferId() {
+        return this._bufferId;
+    }
+    constructor(device, bufferId) {
+        this._device = device;
+        this._bufferId = bufferId;
+    }
+    /**
+     * Gets the buffer contents as an array of strings.
+     * @returns A string array containing all the PVT commands stored in the buffer.
+     */
+    async getContent() {
+        const request = new gateway.StreamBufferGetContentRequest();
+        request.setInterfaceId(this.device.connection.interfaceId);
+        request.setDevice(this.device.deviceAddress);
+        request.setBufferId(this.bufferId);
+        request.setPvt(true);
+        const response = await gateway.callAsync('device/stream_buffer_get_content', request, gateway.StreamBufferGetContentResponse);
+        return response.getBufferLinesList();
+    }
+    /**
+     * Erases the contents of the buffer.
+     * This method fails if there is a PVT sequence writing to the buffer.
+     */
+    async erase() {
+        const request = new gateway.StreamBufferEraseRequest();
+        request.setInterfaceId(this.device.connection.interfaceId);
+        request.setDevice(this.device.deviceAddress);
+        request.setBufferId(this.bufferId);
+        request.setPvt(true);
+        await gateway.callAsync('device/stream_buffer_erase', request);
+    }
+}
+exports.PvtBuffer = PvtBuffer;
+//# sourceMappingURL=pvt_buffer.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pvt_buffer.js","sourceRoot":"","sources":["../../../src/ascii/pvt_buffer.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;;;;;AAGtD,oDAAsC;AAEtC;;;GAGG;AACH,MAAa,SAAS;IACpB;;OAEG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAGD;;OAEG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAGD,YAAY,MAAc,EAAE,QAAgB;QAC1C,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,UAAU;QACrB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,6BAA6B,EAAE,CAAC;QAC5D,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC7C,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACnC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAErB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,kCAAkC,EAClC,OAAO,EACP,OAAO,CAAC,8BAA8B,CAAC,CAAC;QAC1C,OAAO,QAAQ,CAAC,kBAAkB,EAAE,CAAC;IACvC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,KAAK;QAChB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,wBAAwB,EAAE,CAAC;QACvD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC7C,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACnC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAErB,MAAM,OAAO,CAAC,SAAS,CAAC,4BAA4B,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;CACF;AArDD,8BAqDC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport { Device } from './device';\nimport * as gateway from '../gateway';\n\n/**\n * Represents a PVT buffer with this number on a device.\n * A PVT buffer is a place to store a queue of PVT actions.\n */\nexport class PvtBuffer {\n  /**\n   * The Device this buffer exists on.\n   */\n  public get device(): Device {\n    return this._device;\n  }\n  private _device: Device;\n\n  /**\n   * The number identifying the buffer on the device.\n   */\n  public get bufferId(): number {\n    return this._bufferId;\n  }\n  private _bufferId: number;\n\n  constructor(device: Device, bufferId: number) {\n    this._device = device;\n    this._bufferId = bufferId;\n  }\n\n  /**\n   * Gets the buffer contents as an array of strings.\n   * @returns A string array containing all the PVT commands stored in the buffer.\n   */\n  public async getContent(): Promise<string[]> {\n    const request = new gateway.StreamBufferGetContentRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setBufferId(this.bufferId);\n    request.setPvt(true);\n\n    const response = await gateway.callAsync<gateway.StreamBufferGetContentResponse>(\n      'device/stream_buffer_get_content',\n      request,\n      gateway.StreamBufferGetContentResponse);\n    return response.getBufferLinesList();\n  }\n\n  /**\n   * Erases the contents of the buffer.\n   * This method fails if there is a PVT sequence writing to the buffer.\n   */\n  public async erase(): Promise<void> {\n    const request = new gateway.StreamBufferEraseRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setBufferId(this.bufferId);\n    request.setPvt(true);\n\n    await gateway.callAsync('device/stream_buffer_erase', request);\n  }\n}\n"]}

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

@@ -0,0 +1,8 @@
+/**
+ * Mode of a PVT sequence.
+ */
+export declare enum PvtMode {
+    DISABLED = 0,
+    STORE = 1,
+    LIVE = 2
+}

package/dist/lib/ascii/pvt_mode.js

@@ -0,0 +1,15 @@
+"use strict";
+// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //
+// ============= DO NOT EDIT DIRECTLY ============= //
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PvtMode = void 0;
+/**
+ * Mode of a PVT sequence.
+ */
+var PvtMode;
+(function (PvtMode) {
+    PvtMode[PvtMode["DISABLED"] = 0] = "DISABLED";
+    PvtMode[PvtMode["STORE"] = 1] = "STORE";
+    PvtMode[PvtMode["LIVE"] = 2] = "LIVE";
+})(PvtMode = exports.PvtMode || (exports.PvtMode = {}));
+//# sourceMappingURL=pvt_mode.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pvt_mode.js","sourceRoot":"","sources":["../../../src/ascii/pvt_mode.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;AAEtD;;GAEG;AACH,IAAY,OAIX;AAJD,WAAY,OAAO;IACjB,6CAAY,CAAA;IACZ,uCAAS,CAAA;IACT,qCAAQ,CAAA;AACV,CAAC,EAJW,OAAO,GAAP,eAAO,KAAP,eAAO,QAIlB","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\n/**\n * Mode of a PVT sequence.\n */\nexport enum PvtMode {\n  DISABLED = 0,\n  STORE = 1,\n  LIVE = 2,\n}\n"]}

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

@@ -0,0 +1,178 @@
+import { Device } from './device';
+import { Measurement } from '../measurement';
+import { PvtBuffer } from './pvt_buffer';
+import { PvtMode } from './pvt_mode';
+import { PvtAxisDefinition } from './pvt_axis_definition';
+/**
+ * A handle for a PVT sequence with this number on the device.
+ * PVT sequences provide a way execute or store trajectory
+ * consisting of points with defined position, velocity, and time.
+ * PVT sequence methods append actions to a queue which executes
+ * or stores actions in a first in, first out order.
+ */
+export declare class PvtSequence {
+    /**
+     * Device that controls this PVT sequence.
+     */
+    get device(): Device;
+    private _device;
+    /**
+     * The number that identifies the PVT sequence on the device.
+     */
+    get pvtId(): number;
+    private _pvtId;
+    /**
+     * Current mode of the PVT sequence.
+     */
+    get mode(): PvtMode;
+    /**
+     * An array of axes definitions the PVT sequence is set up to control.
+     */
+    get axes(): PvtAxisDefinition[];
+    constructor(device: Device, pvtId: number);
+    /**
+     * Setup the PVT sequence to control the specified axes and to queue actions on the device.
+     * Allows use of lockstep axes in a PVT sequence.
+     * @param axes Definition of the PVT sequence axes.
+     */
+    setupLiveComposite(...axes: PvtAxisDefinition[]): Promise<void>;
+    /**
+     * Setup the PVT sequence to control the specified axes and to queue actions on the device.
+     * @param axes Numbers of physical axes to setup the PVT sequence on.
+     */
+    setupLive(...axes: number[]): Promise<void>;
+    /**
+     * Setup the PVT sequence to use the specified axes and queue actions into a PVT buffer.
+     * Allows use of lockstep axes in a PVT sequence.
+     * @param pvtBuffer The PVT buffer to queue actions in.
+     * @param axes Definition of the PVT sequence axes.
+     */
+    setupStoreComposite(pvtBuffer: PvtBuffer, ...axes: PvtAxisDefinition[]): Promise<void>;
+    /**
+     * Setup the PVT sequence to use the specified axes and queue actions into a PVT buffer.
+     * @param pvtBuffer The PVT buffer to queue actions in.
+     * @param axes Numbers of physical axes to setup the PVT sequence on.
+     */
+    setupStore(pvtBuffer: PvtBuffer, ...axes: number[]): Promise<void>;
+    /**
+     * Append the actions in a PVT buffer to the sequence's queue.
+     * @param pvtBuffer The PVT buffer to call.
+     */
+    call(pvtBuffer: PvtBuffer): Promise<void>;
+    /**
+     * Queues a point with absolute coordinates in the PVT sequence.
+     * @param positions Positions for the axes to move through, relative to their home positions.
+     * @param velocities The axes velocities at the given point.
+     * @param time The duration between the previous point in the sequence and this one.
+     */
+    point(positions: Measurement[], velocities: Measurement[], time: Measurement): Promise<void>;
+    /**
+     * Queues a point with coordinates relative to the previous point in the PVT sequence.
+     * @param positions Positions for the axes to move through, relative to the previous point.
+     * @param velocities The axes velocities at the given point.
+     * @param time The duration between the previous point in the sequence and this one.
+     */
+    pointRelative(positions: Measurement[], velocities: Measurement[], time: Measurement): Promise<void>;
+    /**
+     * Set the value of a digital output channel.
+     * @param channelNumber The number of the digital output channel.
+     * Channel numbers are numbered from one.
+     * @param value The value to set the channel to.
+     */
+    setDigitalOutput(channelNumber: number, value: boolean): Promise<void>;
+    /**
+     * Set the value of an analog output channel.
+     * @param channelNumber The number of the analog output channel.
+     * Channel numbers are numbered from one.
+     * @param value The value to set the channel to, in Volts.
+     */
+    setAnalogOutput(channelNumber: number, value: number): Promise<void>;
+    /**
+     * Sets values for all digital output channels.
+     * @param values True to set the output channel to conducting and false to turn it off.
+     */
+    setAllDigitalOutputs(values: boolean[]): Promise<void>;
+    /**
+     * Sets values for all analog output channels.
+     * @param values The values to set the output channels to, in Volts.
+     */
+    setAllAnalogOutputs(values: number[]): Promise<void>;
+    /**
+     * Waits until the live PVT sequence executes all queued actions.
+     * @param [options.throwErrorOnFault=true] Determines whether to throw error when fault is observed.
+     */
+    waitUntilIdle(options?: PvtSequence.WaitUntilIdleOptions): Promise<void>;
+    /**
+     * Cork the front of the PVT sequences's action queue, blocking execution.
+     * Execution resumes upon uncorking the queue, or when the number of queued actions reaches its limit.
+     * Corking eliminates discontinuities in motion due to subsequent PVT commands reaching the device late.
+     * You can only cork an idle live PVT sequence.
+     */
+    cork(): Promise<void>;
+    /**
+     * Uncork the front of the queue, unblocking command execution.
+     * You can only uncork an idle live PVT sequence that is corked.
+     */
+    uncork(): Promise<void>;
+    /**
+     * Returns a boolean value indicating whether the live PVT sequence is executing a queued action.
+     * @returns True if the PVT sequence is executing a queued action.
+     */
+    isBusy(): Promise<boolean>;
+    /**
+     * Returns a string which represents the PVT sequence.
+     * @returns String which represents the PVT sequence.
+     */
+    toString(): string;
+    /**
+     * Disables the PVT sequence.
+     * If the PVT sequence is not setup, this command does nothing.
+     * Once disabled, the PVT sequence will no longer accept PVT commands.
+     * The PVT sequence will process the rest of the commands in the queue until it is empty.
+     */
+    disable(): Promise<void>;
+    /**
+     * Sends a generic ASCII command to the PVT sequence.
+     * Keeps resending the command while the device rejects with AGAIN reason.
+     * @param command Command and its parameters.
+     */
+    genericCommand(command: string): Promise<void>;
+    /**
+     * Sends a batch of generic ASCII commands to the PVT sequence.
+     * Keeps resending command while the device rejects with AGAIN reason.
+     * The batch is atomic in terms of thread safety.
+     * @param batch Array of commands.
+     */
+    genericCommandBatch(batch: string[]): Promise<void>;
+    /**
+     * Queries the PVT sequence status from the device
+     * and returns boolean indicating whether the PVT sequence is disabled.
+     * Useful to determine if execution was interrupted by other movements.
+     * @returns True if the PVT sequence is disabled.
+     */
+    checkDisabled(): Promise<boolean>;
+    /**
+     * Makes the PVT sequence throw PvtDiscontinuityException when it encounters discontinuities (ND warning flag).
+     */
+    treatDiscontinuitiesAsError(): void;
+    /**
+     * Prevents PvtDiscontinuityException as a result of expected discontinuity when resuming the sequence.
+     */
+    ignoreCurrentDiscontinuity(): void;
+    /**
+     * Gets the axes of the PVT sequence.
+     * @returns An array of axis numbers of the axes the PVT sequence is set up to control.
+     */
+    private _retrieveAxes;
+    /**
+     * Get the mode of the PVT sequence.
+     * @returns Mode of the PVT sequence.
+     */
+    private _retrieveMode;
+}
+declare namespace PvtSequence {
+    interface WaitUntilIdleOptions {
+        throwErrorOnFault?: boolean;
+    }
+}
+export {};