@zaber/motion 2.5.1 → 2.7.0-save-load

package/dist/node/ascii/stream.d.ts

@@ -1,307 +0,0 @@
-import { Device } from './device';
-import { Time, Native, Acceleration, AngularVelocity, Velocity } from '../units';
-import { RotationDirection } from '../rotation_direction';
-import { Measurement } from '../measurement';
-import { StreamBuffer } from './stream_buffer';
-import { StreamMode } from './stream_mode';
-import { StreamAxisDefinition } from './stream_axis_definition';
-/**
- * A handle for a stream with this ID on the device.
- * Streams provide a way to execute or store a sequence of actions.
- * Stream methods append actions to a queue which executes or stores actions in a first in, first out order.
- */
-export declare class Stream {
-    /**
-     * Device that controls this stream.
-     */
-    get device(): Device;
-    private _device;
-    /**
-     * The number that identifies the stream on the device.
-     */
-    get streamId(): number;
-    private _streamId;
-    /**
-     * Current mode of the stream.
-     */
-    get mode(): StreamMode;
-    /**
-     * An array of axes definitions the stream is set up to control.
-     */
-    get axes(): StreamAxisDefinition[];
-    constructor(device: Device, streamId: number);
-    /**
-     * Setup the stream to control the specified axes and to queue actions on the device.
-     * Allows use of lockstep axes in a stream.
-     * @param axes Definition of the stream axes.
-     */
-    setupLiveComposite(...axes: StreamAxisDefinition[]): Promise<void>;
-    /**
-     * Setup the stream to control the specified axes and to queue actions on the device.
-     * @param axes Numbers of physical axes to setup the stream on.
-     */
-    setupLive(...axes: number[]): Promise<void>;
-    /**
-     * Setup the stream to control the specified axes and queue actions into a stream buffer.
-     * Allows use of lockstep axes in a stream.
-     * @param streamBuffer The stream buffer to queue actions in.
-     * @param axes Definition of the stream axes.
-     */
-    setupStoreComposite(streamBuffer: StreamBuffer, ...axes: StreamAxisDefinition[]): Promise<void>;
-    /**
-     * Setup the stream to control the specified axes and queue actions into a stream buffer.
-     * @param streamBuffer The stream buffer to queue actions in.
-     * @param axes Numbers of physical axes to setup the stream on.
-     */
-    setupStore(streamBuffer: StreamBuffer, ...axes: number[]): Promise<void>;
-    /**
-     * Setup the stream to use a specified number of axes, and to queue actions in a stream buffer.
-     * Afterwards, you may call the resulting stream buffer on arbitrary axes.
-     * This mode does not allow for unit conversions.
-     * @param streamBuffer The stream buffer to queue actions in.
-     * @param axesCount The number of axes in the stream.
-     */
-    setupStoreArbitraryAxes(streamBuffer: StreamBuffer, axesCount: number): Promise<void>;
-    /**
-     * Append the actions in a stream buffer to the queue.
-     * @param streamBuffer The stream buffer to call.
-     */
-    call(streamBuffer: StreamBuffer): Promise<void>;
-    /**
-     * Queue an absolute line movement in the stream.
-     * @param endpoint Positions for the axes to move to, relative to their home positions.
-     */
-    lineAbsolute(...endpoint: Measurement[]): Promise<void>;
-    /**
-     * Queue a relative line movement in the stream.
-     * @param endpoint Positions for the axes to move to, relative to their positions before movement.
-     */
-    lineRelative(...endpoint: Measurement[]): Promise<void>;
-    /**
-     * Queue an absolute line movement in the stream, targeting a subset of the stream axes.
-     * @param targetAxesIndices Indices of the axes in the stream the movement targets.
-     * Refers to the axes provided during the stream setup or further execution.
-     * Indices are zero-based.
-     * @param endpoint Positions for the axes to move to, relative to their home positions.
-     */
-    lineAbsoluteOn(targetAxesIndices: number[], endpoint: Measurement[]): Promise<void>;
-    /**
-     * Queue a relative line movement in the stream, targeting a subset of the stream axes.
-     * @param targetAxesIndices Indices of the axes in the stream the movement targets.
-     * Refers to the axes provided during the stream setup or further execution.
-     * Indices are zero-based.
-     * @param endpoint Positions for the axes to move to, relative to their positions before movement.
-     */
-    lineRelativeOn(targetAxesIndices: number[], endpoint: Measurement[]): Promise<void>;
-    /**
-     * Queue an absolute arc movement on the first two axes of the stream.
-     * Absolute meaning that the home positions of the axes is treated as the origin.
-     * @param rotationDirection The direction of the rotation.
-     * @param centerX The first dimensions of the position of the center of the circle on which the arc exists.
-     * @param centerY The second dimensions of the position of the center of the circle on which the arc exists.
-     * @param endX The first dimensions of the end position of the arc.
-     * @param endY The second dimensions of the end position of the arc.
-     */
-    arcAbsolute(rotationDirection: RotationDirection, centerX: Measurement, centerY: Measurement, endX: Measurement, endY: Measurement): Promise<void>;
-    /**
-     * Queue a relative arc movement on the first two axes of the stream.
-     * Relative meaning that the current position of the axes is treated as the origin.
-     * @param rotationDirection The direction of the rotation.
-     * @param centerX The first dimensions of the position of the center of the circle on which the arc exists.
-     * @param centerY The second dimensions of the position of the center of the circle on which the arc exists.
-     * @param endX The first dimensions of the end position of the arc.
-     * @param endY The second dimensions of the end position of the arc.
-     */
-    arcRelative(rotationDirection: RotationDirection, centerX: Measurement, centerY: Measurement, endX: Measurement, endY: Measurement): Promise<void>;
-    /**
-     * Queue an absolute arc movement in the stream.
-     * The movement will only target the specified subset of axes in the stream.
-     * @param targetAxesIndices Indices of the axes in the stream the movement targets.
-     * Refers to the axes provided during the stream setup or further execution.
-     * Indices are zero-based.
-     * @param rotationDirection The direction of the rotation.
-     * @param centerX The first dimensions of the position of the center of the circle on which the arc exists.
-     * @param centerY The second dimensions of the position of the center of the circle on which the arc exists.
-     * @param endX The first dimensions of the end position of the arc.
-     * @param endY The second dimensions of the end position of the arc.
-     */
-    arcAbsoluteOn(targetAxesIndices: number[], rotationDirection: RotationDirection, centerX: Measurement, centerY: Measurement, endX: Measurement, endY: Measurement): Promise<void>;
-    /**
-     * Queue a relative arc movement in the stream.
-     * The movement will only target the specified subset of axes in the stream.
-     * @param targetAxesIndices Indices of the axes in the stream the movement targets.
-     * Refers to the axes provided during the stream setup or further execution.
-     * Indices are zero-based.
-     * @param rotationDirection The direction of the rotation.
-     * @param centerX The first dimensions of the position of the center of the circle on which the arc exists.
-     * @param centerY The second dimensions of the position of the center of the circle on which the arc exists.
-     * @param endX The first dimensions of the end position of the arc.
-     * @param endY The second dimensions of the end position of the arc.
-     */
-    arcRelativeOn(targetAxesIndices: number[], rotationDirection: RotationDirection, centerX: Measurement, centerY: Measurement, endX: Measurement, endY: Measurement): Promise<void>;
-    /**
-     * Queue an absolute circle movement on the first two axes of the stream.
-     * Absolute meaning that the home positions of the axes are treated as the origin.
-     * @param rotationDirection The direction of the rotation.
-     * @param centerX The first dimension of the position of the center of the circle.
-     * @param centerY The second dimension of the position of the center of the circle.
-     */
-    circleAbsolute(rotationDirection: RotationDirection, centerX: Measurement, centerY: Measurement): Promise<void>;
-    /**
-     * Queue a relative circle movement on the first two axes of the stream.
-     * Relative meaning that the current position of the axes is treated as the origin.
-     * @param rotationDirection The direction of the rotation.
-     * @param centerX The first dimension of the position of the center of the circle.
-     * @param centerY The second dimension of the position of the center of the circle.
-     */
-    circleRelative(rotationDirection: RotationDirection, centerX: Measurement, centerY: Measurement): Promise<void>;
-    /**
-     * Queue an absolute circle movement in the stream.
-     * The movement will only target the specified subset of axes in the stream.
-     * @param targetAxesIndices Indices of the axes in the stream the movement targets.
-     * Refers to the axes provided during the stream setup or further execution.
-     * Indices are zero-based.
-     * @param rotationDirection The direction of the rotation.
-     * @param centerX The first dimension of the position of the center of the circle.
-     * @param centerY The second dimension of the position of the center of the circle.
-     */
-    circleAbsoluteOn(targetAxesIndices: number[], rotationDirection: RotationDirection, centerX: Measurement, centerY: Measurement): Promise<void>;
-    /**
-     * Queue a relative circle movement in the stream.
-     * The movement will only target the specified subset of axes in the stream.
-     * @param targetAxesIndices Indices of the axes in the stream the movement targets.
-     * Refers to the axes provided during the stream setup or further execution.
-     * Indices are zero-based.
-     * @param rotationDirection The direction of the rotation.
-     * @param centerX The first dimension of the position of the center of the circle.
-     * @param centerY The second dimension of the position of the center of the circle.
-     */
-    circleRelativeOn(targetAxesIndices: number[], rotationDirection: RotationDirection, centerX: Measurement, centerY: Measurement): Promise<void>;
-    /**
-     * Wait for a digital input channel to reach a given value.
-     * @param channelNumber The number of the digital input channel.
-     * Channel numbers are numbered from one.
-     * @param value The value that the stream should wait for.
-     */
-    waitDigitalInput(channelNumber: number, value: boolean): Promise<void>;
-    /**
-     * Wait for the value of a analog input channel to reach a condition concerning a given value.
-     * @param channelNumber The number of the analog input channel.
-     * Channel numbers are numbered from one.
-     * @param condition A condition (e.g. <, <=, ==, !=).
-     * @param value The value that the condition concerns, in volts.
-     */
-    waitAnalogInput(channelNumber: number, condition: string, value: number): 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>;
-    /**
-     * Toggle the value of a digital output channel.
-     * @param channelNumber The number of the digital output channel.
-     * Channel numbers are numbered from one.
-     */
-    toggleDigitalOutput(channelNumber: number): Promise<void>;
-    /**
-     * Wait a specified time.
-     * @param time Amount of time to wait.
-     * @param unit Units of time.
-     */
-    wait(time: number, unit?: Time | Native): Promise<void>;
-    /**
-     * Waits until the live stream executes all queued actions.
-     * @param throwErrorOnFault Determines whether to throw error when fault is observed.
-     */
-    waitUntilIdle(throwErrorOnFault?: boolean): Promise<void>;
-    /**
-     * Cork the front of the stream'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 stream commands reaching the device late.
-     * You can only cork an idle live stream.
-     */
-    cork(): Promise<void>;
-    /**
-     * Uncork the front of the queue, unblocking command execution.
-     * You can only uncork an idle live stream that is corked.
-     */
-    uncork(): Promise<void>;
-    /**
-     * Returns a boolean value indicating whether the live stream is executing a queued action.
-     * @return True if the stream is executing a queued action.
-     */
-    isBusy(): Promise<boolean>;
-    /**
-     * Gets the maximum speed of the live stream.
-     * Converts the units using the first axis of the stream.
-     * @param unit Units of velocity.
-     * @return The maximum speed of the stream.
-     */
-    getMaxSpeed(unit?: Velocity | AngularVelocity | Native): Promise<number>;
-    /**
-     * Sets the maximum speed of the live stream.
-     * Converts the units using the first axis of the stream.
-     * @param maxSpeed Maximum speed at which any stream action is executed.
-     * @param unit Units of velocity.
-     */
-    setMaxSpeed(maxSpeed: number, unit?: Velocity | AngularVelocity | Native): Promise<void>;
-    /**
-     * Gets the maximum tangential acceleration of the live stream.
-     * Converts the units using the first axis of the stream.
-     * @param unit Units of acceleration.
-     * @return The maximum tangential acceleration of the live stream.
-     */
-    getMaxTangentialAcceleration(unit?: Acceleration | Native): Promise<number>;
-    /**
-     * Sets the maximum tangential acceleration of the live stream.
-     * Converts the units using the first axis of the stream.
-     * @param maxTangentialAcceleration Maximum tangential acceleration at which any stream action is executed.
-     * @param unit Units of acceleration.
-     */
-    setMaxTangentialAcceleration(maxTangentialAcceleration: number, unit?: Acceleration | Native): Promise<void>;
-    /**
-     * Gets the maximum centripetal acceleration of the live stream.
-     * Converts the units using the first axis of the stream.
-     * @param unit Units of acceleration.
-     * @return The maximum centripetal acceleration of the live stream.
-     */
-    getMaxCentripetalAcceleration(unit?: Acceleration | Native): Promise<number>;
-    /**
-     * Sets the maximum centripetal acceleration of the live stream.
-     * Converts the units using the first axis of the stream.
-     * @param maxCentripetalAcceleration Maximum centripetal acceleration at which any stream action is executed.
-     * @param unit Units of acceleration.
-     */
-    setMaxCentripetalAcceleration(maxCentripetalAcceleration: number, unit?: Acceleration | Native): Promise<void>;
-    /**
-     * Returns a string which represents the stream.
-     * @return String which represents the stream.
-     */
-    toString(): string;
-    /**
-     * Disable the stream.
-     * If the stream is not setup, this command does nothing.
-     * Once disabled, the stream will no longer accept stream commands.
-     * The stream will process the rest of the commands in the queue until it is empty.
-     */
-    disable(): Promise<void>;
-    /**
-     * Gets the axes of the stream.
-     * @return An array of axis numbers of the axes the stream is set up to control.
-     */
-    private _retrieveAxes;
-    /**
-     * Get the mode of the stream.
-     * @return Mode of the stream.
-     */
-    private _retrieveMode;
-}