Load Position Modulus

NI-Motion VI

previous page next page

Load Position Modulus

Loads the position modulus for an axis.

Device Compatibility

Device	Compatibility
7330	Y
7340	Y
7344	Y
7350	Y
7390	Y
NI SoftMotion Controller for CANopen—Accelnet	N
NI SoftMotion Controller for CANopen—Xenus	N

Position Modulus (0) is the position modulus value in counts (servo axes) or steps (stepper axes). The modulus range is from 0 (default) to (2³¹) – 1.

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 Position Modulus VI sets the modulus used when the axis is operating in Modulus Position mode. It has no effect when the axis is operating in other modes. When a target position is loaded, it is interpreted within the boundaries of a modulus range.

Refer to the Set Operation Mode VI for a complete description of the Modulus Position mode.

previous page start next page