Homes (Disabled) is the bitmap of home inputs to enable: Axis 1—If true, home input is enabled. If false, home input is disabled (default). Axis 2—If true, home input is enabled. If false, home input is disabled (default). Axis 3—If true, home input is enabled. If false, home input is disabled (default). Axis 4—If true, home input is enabled. If false, home input is disabled (default). Axis 5—If true, home input is enabled. If false, home input is disabled (default). Axis 6—If true, home input is enabled. If false, home input is disabled (default). Axis 7—If true, home input is enabled. If false, home input is disabled (default). Axis 8—If true, home input is enabled. If false, home input is disabled (default).
	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.
	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 Enable Home Inputs VI enables/disables any combination of axis home inputs. An enabled home input causes a halt stop on the axis when the input becomes active. You can configure each home input as active low or active high with the Set Home Input Polarity VI. You also can use a home input as a general-purpose input and read its status with the Read Home Input Status VI.

Home inputs are an enhancement on the NI motion controller and are not required for basic motion control. You can operate all motion control VIs without enabling or using the home inputs except the Find Reference VI, which requires enabled limit and home inputs for operation when the Find Reference type is "home."

To configure the property of Find Reference Home, such as Initial search direction and Home edge to stop on, use the Load Reference Parameter VI.

Note  An active and enabled home input transition on an axis that is part of a vector space move causes that axis to halt stop and the other axes in the vector space to decelerate to a stop.

Example

To enable the home inputs for axes 2 and 4, call the Enable Home Inputs VI with Homes, as follows.