Read Home Input Status

NI-Motion VI

previous page next page

Read Home Input Status

Reads the instantaneous status of the home inputs.

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

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.

Ret Vect indicates the destination for the return data generated by this VI. Available return vectors include return data to the host (0xFF), return data to a variable (0x01 through 0x78), return data to an indirect variable (0x81 through 0xF8), and do not return data (0). 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.

Home Status is the bitmap of the logical state of the home inputs:

	Axis 1—True (On)/False (Off).
	Axis 2—True (On)/False (Off).
	Axis 3—True (On)/False (Off).
	Axis 4—True (On)/False (Off).
	Axis 5—True (On)/False (Off).
	Axis 6—True (On)/False (Off).
	Axis 7—True (On)/False (Off).
	Axis 8—True (On)/False (Off).

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

The Read Home Input Status VI returns the logical state of the home inputs. You can execute this VI at anytime to monitor the home inputs, whether they are enabled or not. A home input enabled with the Enable Home Inputs VI causes a halt stop on an axis when its home input becomes active (True). You also can use a home input as a general-purpose input and read its status with this VI. The home input status during a Find Reference move is undefined.

To determine the home found status, use Read Reference Status and set the reference type to "home".

Note This VI returns undefined values for axes that are currently performing find reference moves.

Note This VI reads the logical state (On or Off, True or False) of the home inputs. The polarity of the home inputs determines whether an On state is active high or active low. Refer to the Set Home Input Polarity VI for more information.

previous page start next page