MotionController Axis MultiAxis IO IOPoint NetworkNode RsiError
Sample Apps Changelog

RapidCode API

◆ MotorFaultMaskSet()

void MotorFaultMaskSet ( int32  mask)
pure virtual

Set the Motor Fault Mask.

Description:
MotorFaultMaskSet will set the motor fault mask. A mask of motor fault bits. The masked motor fault bits will be monitored by the controller's motor object. If any masked motor fault bit is active (TRUE), the motor's dedicated amp fault input (MPIMotorDedicatedInAMP_FAULT) is set active (TRUE). The support for motor fault bits is node/drive specific. During SynqNet network initialization, the SqNodeLib automatically configures the faultMask based on the node type. See the node/drive manufacturer's documentation for details.
Parameters
maskA mask of motor fault bits.
Sample Code:
// -- C++ -- //
axis->MotorFaultMaskSet(motorFaultMaskValue);
// -- C# -- //
axis.MotorFaultMaskSet(motorFaultMaskValue);
See also
MotorFaultMaskGet