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.
	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.
	Move Complete Status is a bitmap of MCS for up to eight axes. The bitmap also includes the state of the three Status bits: Axis #1 Move Complete—If true, move is complete. If false, axis is moving. Axis #2 Move Complete—If true, move is complete. If false, axis is moving. Axis #3 Move Complete—If true, move is complete. If false, axis is moving. Axis #4 Move Complete—If true, move is complete. If false, axis is moving. Axis #5 Move Complete—If true, move is complete. If false, axis is moving. Axis #6 Move Complete—If true, move is complete. If false, axis is moving. Axis #7 Move Complete—If true, move is complete. If false, axis is moving. Axis #8 Move Complete—If true, move is complete. If false, axis is moving. Status #13—If true, user status is set. If false, user status is reset. Status #14—If true, user status is set. If false, user status is reset. Status #15—If true, user status is set. If false, user status is reset.
	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.
	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

This section includes more detailed information about using this VI.

Note  Refer to VI Execution Times for benchmark timing information about your controller.

Remarks

This section includes information about how the behavior of this VI differs among the controllers that support it.

NI 73xx Controller Considerations

The following list includes considerations you must make when you are using this VI with a 73xx motion controller:

• This VI performs a direct read of the Move Complete Status (MCS) register on the 73xx controller. Because a register read is virtually instantaneous and does not affect communication processing or other NI-Motion operations, you can call this VI repeatedly to get the most up-to-date status for the axes.
• Move Complete Status is configurable individually for each axis with the Configure Move Complete Criteria VI. The criteria for considering motion to be complete include Profile Complete, Run/Stop, In-Position, Settling time delay, and so on.

  Note  Reading the MCS register immediately after calling the Start Motion VI might not return the status you expected. The Start Motion can still be buffered in the communications FIFO when the instantaneous read of the MCS occurs.

• This VI also returns the state of the User Status bits. You can set and reset these three bits during onboard program execution as general-purpose flags to the host computer. Refer to the Set User Status MOMO VI for more information.

  Note  When the 73xx motion controller is in the Power-Up state, the MCS register contains a power-up code that describes why the controller is in the Power-Up state. For a list of these power-up codes, refer to the Clear Power Up Status VI.

NI SoftMotion Controller Considerations

The following list includes considerations you must make when you are using this VI with the NI SoftMotion Controller:

• During the power-up state on the NI SoftMotion Controller, this VI returns zero (0). It does not return a power-up code.
• The User Status bits are not supported by the NI SoftMotion Controller.