flex_read_drive_signal_status |
Read Drive Signal Status
Usage
status = flex_read_drive_signal_status(u8 boardID, u8 axis, u8 returnVector);
Purpose
Reads the status of the drive signal when an active signal is detected.
Parameters
Name | Type | Description |
boardID | u8 | assigned by Measurement & Automation Explorer (MAX) |
axis | u8 | axis to configure |
returnVector | u8 | destination for the return data |
Parameter Discussion
axis is the axis to configure. Valid values are NIMC_AXIS1 through NIMC_AXIS30. On motion controllers that support fewer than thirty axes, configuring non-existent axes returns error 70006 (NIMC_badResourceIDOrAxisError). Refer to Axes for axis resource IDs.
returnVector indicates the desired destination for the return data generated by this function. Available return vectors include return data to the host (0xFF), to a variable (0x01 through 0x78), to an indirect variable (0x81 through 0xF8), and do not return data (0). Refer to Input and Return Vectors for more detailed information.
Note The suffix _rtn on the function indicates that the data must be returned to the host. When this calling convention is used, no returnVector is required. |
Using This Function
Use this function to read the status of the drive signal when an active drive signal is detected. If In-Position is active, bit0 = 1. If Drive Fault is active, bit1 = 1.
Tip Use Read Motion I/O Data instead of this function for more options. |