Load Target Position

NI-Motion VI

Load Target Position

Loads the target position for the next axis move.

Details

Device Compatibility

DeviceCompatibility
7330
Y
7340
Y
7344
Y
7350
Y
7390
Y
NI SoftMotion Controller for CANopen—Accelnet
Y
NI SoftMotion Controller for CANopen—Xenus
Y
Target Position (0) is the target position for the next axis move in counts (servo axes) or steps (stepper axes). Target positions can be anywhere within the 32-bit position range, –(231) to +((231)–1). The default value for target position is zero (0).
Caution  Any single move is limited to ±(231–1) counts or steps. An error is generated if you exceed this limit by loading a target position too far from the current Axis position.
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.
Axis is the axis to control.
Inp Vect indicates the source of the data for this VI. Available input vectors include immediate (0xFF), variable (0x01 through 0x78), or indirect variable (0x81 through 0xF8). Refer to Input and Return Vectors for more detailed information.
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 Output 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 Load Target Position VI loads a target position to the specified axis. Target positions can be for single axis moves, multi-axis coordinated moves, or vector space moves. Position values indicate the end location and direction of motion (target position).

Note  Refer to the Load Vector Space Position VI for an easy way to load up to three target positions for a vector space in one call.

Target position is double-buffered so you can load it on the fly without affecting the move in process, and it takes effect on the next Start or Blend Motion VI. When the target position is loaded, it is interpreted as either an absolute target position, a relative target position, a target position relative to the last captured position or with the effect of a position modulus, depending on the mode set with the Set Operation Mode VI.

This means that if you set the operation mode to "relative to capture," you must load the target position after the capture has occurred because the position is evaluated on load.

After you execute the start or blend, the axis or axes follow the programmed trajectory and end up at the absolute, relative, or modulo target position.

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