Reset Encoder Position

NI-Motion VI

previous page next page

Reset Encoder Position

Resets the position of an unmapped encoder to the specified value.

Device Compatibility

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

Reset Position (0) is the reset value for the encoder resource. You can reset position to any value in the total position range of -(2³¹) 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.

Encoder is encoder to reset.

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 Reset Encoder Position VI resets the position of the selected encoder. You can reset position to zero or to any value in the 32-bit position range. Normally, this VI is only used on independent encoders that are not mapped to axes. For encoders mapped to axes, use the Reset Position VI instead.

Note Attempting to reset an encoder that is mapped to an axis generates an error.

Enabled breakpoints are also automatically disabled when you execute Reset Encoder Position on the corresponding axis.

Encoder position can be reset at any time. However, it is recommended that you reset position only while the encoder is stopped. An encoder reset while it is moving does not have a repeatable reference position.

Note Non-zero reset values are useful for defining a position reference offset.

previous page start next page