Load Breakpoint Position

NI-Motion VI

Load Breakpoint Position

Loads the breakpoint position for an axis or encoder in counts.

Details

Device Compatibility

DeviceCompatibility
7330
Y
7340
Y
7344
Y
7350
Y
7390
Y
NI SoftMotion Controller for CANopen—Accelnet
N
NI SoftMotion Controller for CANopen—Xenus
N
Breakpoint Position (0) is the breakpoint position in quadrature counts. Breakpoint positions can be anywhere within the 32-bit position range, –(231) to +(231)–1. The default value is zero (0).
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.
Axis or Encoder is the axis or encoder to control. You can load Breakpoint Position on encoders mapped to axes 1 through 8 or directly on encoders 0x21 through 0x28.
Inp Vect indicates the source of the data for this VI. Available input vectors include immediate (0xFF), variable (0x01 through 0x78), or indirect variable (0x81 through 0xF8). 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.
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.
Resource Output is the Axis, Vector Space, ADC, or Encoder you wired into the VI. Use Resource Output to pass the resource to another VI and/or to display information about the device.
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 Load Breakpoint Position VI loads the breakpoint position value for the axis or encoder specified. The breakpoint position is interpreted differently depending on the breakpoint mode and the encoder position when the breakpoint is enabled. You can specify position breakpoints as either absolute, relative, or with respect to a modulus range when the breakpoint is enabled. Breakpoint position is double-buffered and not actually used until you execute the Enable Breakpoint Output VI.

Note  For modulo breakpoints, the magnitude of the breakpoint value must be less than the breakpoint modulus. If this range is exceeded, a modal error is generated when you execute the Enable Breakpoint Output VI.
Note  To load breakpoint positions for buffered breakpoints, refer to the Write Buffer VI. The Load Breakpoint Position VI does not have any affect on buffered breakpoints.

When the breakpoint position is reached, a breakpoint event is generated and the associated high-speed breakpoint output immediately transitions.

High-speed breakpoint functionality is performed by the encoder resources themselves. When this VI is sent to an axis, it is actually being sent to the mapped encoder resource.

When the same breakpoint position is used on a repetitive basis, it is not necessary to reload the position each time. It is necessary, however, to re-enable the breakpoint after each use.

Note  For closed-loop stepper systems in which the encoder counts-per-revolution differs from the steps-per-revolution, the captured position is in encoder counts.