Pause/Resume Program

NI-Motion VI

Pause/Resume Program

Pauses a running program or resumes execution of a paused program.

Details

Device Compatibility

DeviceCompatibility
7330
N
7340
Y
7344
Y
7350
Y
7390
N
NI SoftMotion Controller for CANopen—Accelnet
N
NI SoftMotion Controller for CANopen—Xenus
N
Board ID is a unique number assigned by Measurement & Automation Explorer (MAX) used to send and receive commands and data to or from a specific NI motion controller.
Program (1) is the onboard program to read the status of.
error in (no error) describes error conditions that occur before this VI runs. The default input of this cluster is no error. If an error already occurred, this VI returns the value of error in in error out. The VI runs normally only if no incoming error exists. Otherwise, the VI passes the error in value to error out. The error in cluster contains the following parameters:
status is TRUE if an error occurred before this VI was called, or FALSE if not. If status is TRUE, code is a nonzero error code. If status is FALSE, code is zero or a warning code.
code is a number identifying an error or warning. If status is TRUE, code is a nonzero error code. If status is FALSE, code is zero or a warning code. Use the error handler VIs to look up the meaning of this code and display the corresponding error message.
source is a string that indicates the origin of the error, if any. Typically, source is the name of the VI in which the error occurred.
Bd ID Out is provided for flow control. You can string together NI-Motion VIs by wiring the Bd ID Out terminal of one VI to the Board ID terminal of the next VI.
Resource Out is the Axis, Vector Space, ADC, or Encoder you wired into the VI. Use Resource Output to pass the resource to another VI and/or to display information about the device.
error out contains error information. If error in indicates an error, error out contains the same error information. Otherwise, it describes the error status that this VI produces.
status is TRUE if an error occurred, or FALSE if not. If status is TRUE, code is a nonzero error code. If status is FALSE, code is zero or a warning code.
code is a number identifying an error or warning. If status is TRUE, code is a nonzero error code. If status is FALSE, code is zero or a warning code. Use the error handler VIs to look up the meaning of this code and display the corresponding error message.
source is a string that indicates the origin of the error, if any. Typically, source is the name of the VI in which the error occurred.

Using This VI

The Pause/Resume Program VI suspends execution of a running program or resumes execution of a paused program.

A program can pause or resume execution of another program, and also can pause (but not resume) itself.

Note  Pausing a program does not affect a move already started and in progress. It does not implement a Stop Motion VI.

Any run-time (modal) error in a program automatically pauses the program in addition to generating the error message. Refer to the Read Error Message VI and Errors and Error Handling for information about errors.

A program also can automatically pause if you execute a Stop Motion VI from the host computer on an axis or axes under control of the onboard program. In these cases, the program pauses when it attempts to execute a Start Motion or Blend Motion VI on the stopped axes. This automatic pause also applies when the stop is due to a limit, home, software limit, or following error condition.

You can effectively single-step through an onboard program by having the program pause after every VI, and then resuming the program from the host computer.

System time does not pause when you pause a program. Pausing merely stops the next VI from executing. This means that a delay counter from Load Program Delay keeps counting down even while the onboard program is paused. For example, if you load both a delay of five seconds and then pause the program for 10 seconds, you have a total of only 10 seconds before execution of the onboard program resumes.