Read Breakpoint Status Return

Usage

status = flex_read_breakpoint_status_rtn(u8 boardID, u8 axisOrEncoder, u16 breakpointType, u16* breakpointStatus);

Purpose

Reads the breakpoint status for all axes or encoders.

Note  You cannot use this function to read the status of buffered breakpoints. Use Check Buffer to get the status of the buffer.

Parameters

Parameter Discussion

axisOrEncoder is the axis control or encoder control selector. For multi-axis status, use NIMC_AXIS_CTRL. For multi-encoder status, use NIMC_ENCODER_CTRL. Refer to Axes and Encoders for axis and encoder resource IDs.

breakpointType is a reserved input that must be set to NIMC_POSITION_BREAKPOINT (0).

breakpointStatus is the bitmap of breakpoint status for all axes or all encoders.

Note  The breakpoint status does not reflect the voltage level of the breakpoint output.

When reading breakpoint status for axes (axisOrEncoder = NIMC_AXIS_CTRL):

For D1 through D8:
   1 = Breakpoint occurred
   0 = Breakpoint pending or disabled

When reading breakpoint status for encoders (axisOrEncoder = NIMC_ENCODER_CTRL):

For D1 through D8:
   1 = Breakpoint occurred
   0 = Breakpoint pending or never enabled

Using This Function

This function allows you to see if a breakpoint has occurred or is pending. When you enable a breakpoint, the corresponding status bit is reset to indicate that the breakpoint is pending. When the breakpoint position is reached, its status bit is set to True (1).

Note  Read Breakpoints Status returns the breakpoint status for either all axes or all encoders, based on which value is passed into axisOrEncoder.

Example

Executing the Read Breakpoint Status function with axisOrEncoder = NIMC_ENCODER_CTRL and breakpointType = 0 returns breakpointStatus = 0x0012, which corresponds to the following bitmap:

On encoders 1 and 4, breakpoints have occurred, but on encoders 2 and 3, breakpoints are pending or were never enabled.