flex_read_home_input_status_rtn |
Read Home Input Status Return
Usage
status = flex_read_home_input_status_rtn(u8 boardID, u16* homeStatus);
Purpose
Reads the instantaneous status of the home inputs.
 |
Tip Refer to the Remarks section for information about how the behavior of this function differs between controllers. |
Parameters
| Name | Type | Description |
|---|---|---|
| boardID | u8 | assigned by Measurement & Automation Explorer (MAX) |
| homeStatus | u16* | bitmap of the logical state of the home inputs |
Parameter Discussion
homeStatus is the bitmap of the logical state of the home inputs:
| D15 | ... | D10 | D9 | D8 | D7 | D6 | D5 | D4 | D3 | D2 | D1 | D0 |
| Home 15 | ... | Home 10 | Home 9 | Home 8 | Home 7 | Home 6 | Home 5 | Home 4 | Home 3 | Home 2 | Home 1 | XXX |
For D1 through D15:
1 = Home input True (On)
0 = Home input False (Off)
Using This Function
This function returns the logical state of the home inputs. You can execute this function at anytime to monitor the home inputs, regardless of if they are enabled. A home input enabled with the Enable Home Inputs function 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 function. The home input status during a Find Reference move is undefined.
 |
Note This function returns undefined values for axes that are currently performing find reference moves. |
To determine the home found status, use Read Reference Status and set the reference type to NIMC_HOME_FOUND.
|
Note This function reads the logical state (On or Off, True or False) of the home inputs. The polarity of the home inputs determines if an On state is active high or active low. Refer to the Set Home Input Polarity function for more information. |
Remarks
This section includes information about how the behavior of this function differs among the controllers that support it.
NI SoftMotion Controller Considerations
The following list includes considerations you must make when you are using this function with the NI SoftMotion Controller:
To read the home input status on axes sixteen through thirty, use the Read Motion I/O Data function.