Set Inhibit MOMO

NI-Motion VI

Set Inhibit MOMO

Sets the inhibit outputs using the Must On/Must Off protocol.

Device Compatibility

Device	Compatibility
7330	Y
7340	Y
7344	Y
7350	Y
7390	N
NI SoftMotion Controller for CANopen—Accelnet	N
NI SoftMotion Controller for CANopen—Xenus	N

Must Off (False) is the bitmap of inhibit outputs to force off:

	Inhibit Output 1—If true, inhibit output forced off. If false, inhibit output unchanged (default).
	Inhibit Output 2—If true, inhibit output forced off. If false, inhibit output unchanged (default).
	Inhibit Output 3—If true, inhibit output forced off. If false, inhibit output unchanged (default).
	Inhibit Output 4—If true, inhibit output forced off. If false, inhibit output unchanged (default).
	Inhibit Output 5—If true, inhibit output forced off. If false, inhibit output unchanged (default).
	Inhibit Output 6—If true, inhibit output forced off. If false, inhibit output unchanged (default).
	Inhibit Output 7—If true, inhibit output forced off. If false, inhibit output unchanged (default).
	Inhibit Output 8—If true, inhibit output forced off. If false, inhibit output unchanged (default).

Must On (False) is the bitmap of inhibit outputs to force on:

	Inhibit Output 1—If true, inhibit output forced on. If false, inhibit output unchanged (default).
	Inhibit Output 2—If true, inhibit output forced on. If false, inhibit output unchanged (default).
	Inhibit Output 3—If true, inhibit output forced on. If false, inhibit output unchanged (default).
	Inhibit Output 4—If true, inhibit output forced on. If false, inhibit output unchanged (default).
	Inhibit Output 5—If true, inhibit output forced on. If false, inhibit output unchanged (default).
	Inhibit Output 6—If true, inhibit output forced on. If false, inhibit output unchanged (default).
	Inhibit Output 7—If true, inhibit output forced on. If false, inhibit output unchanged (default).
	Inhibit Output 8—If true, inhibit output forced on. If false, inhibit output unchanged (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 Set Inhibit MOMO VI controls disabled inhibit outputs being used as general-purpose outputs. You can directly set the inhibit outputs to a logical On or Off state.

Note This VI has no effect on enabled inhibit outputs. These outputs are directly controlled by their corresponding axes.

Using the Must On/Must Off protocol allows you to set or reset individual inhibit outputs without affecting the other inhibit outputs. This gives you tri-state control over each output: On, Off, or Unchanged. A True in a location of the Must On bitmap turns the inhibit On, while a True in the corresponding location of the Must Off bitmap turns the inhibit Off. A False in either bitmap has no affect, so leaving both the Must On and Must Off at False is effectively a hold, and the state of the inhibit output is unchanged. If you set both the Must On and Must Off bits to True, it is interpreted as a Must On condition and the inhibit is turned On.

Must On –> Must Off	1	0
1	On	Off
0	On	Unchanged

Note This VI sets the logical state of an inhibit output On or Off (True or False). The polarity of the inhibit outputs determine whether an On state is active high or active low. Refer to the Configure Inhibit Outputs VI for more information.

The Set Inhibit MOMO VI allows individual control of the inhibit outputs without requiring a shadow value to remember the state of other outputs not being set or reset with the VI.

Example

To turn inhibit output 1 On, output 4 off, and leave the other inhibit outputs unchanged, call the Set Inhibit MOMO VI with the following parameters:

Must On corresponds to the following:

Must On 1	Must On 2	Must On 3	Must On 4	Must On 5	Must On 6	Must On 7	Must On 8
True	False	False	False	False	False	False	False

Must Off corresponds to the following:

Must On 1	Must On 2	Must On 3	Must On 4	Must On 5	Must On 6	Must On 7	Must On 8
False	False	False	True	False	False	False	False

previous page start next page