UserLimitCountSet()

void UserLimitCountSet

(

int32_t

userLimitCount

)

Description:

UserLimitCountSet will configure the number of UserLimits processed by the controller firmware.

Parameters

userLimitCount

The User Limit count.

Part of the User Limit method group.

Sample Code:

IO: User Limits

/*  This sample demonstrates how to configure a user limit triggered by a single digital input.
    When the input matches the specified value, the configured output is activated.
    Uses simulated IO with user buffer memory for demonstration purposes.
*/
 
using RSI.RapidCode; // RSI.RapidCode.dotNET;
 
Console.WriteLine("📜 User Limit: Digital Input One Condition");
 
// get rmp objects
MotionController controller = MotionController.Get();
 
try
{
    Helpers.CheckErrors(controller);
 
    // configure user limits
    controller.UserLimitCountSet(1);     // set the amount of user limits to use
    controller.InterruptEnableSet(true); // enable user limit interrupts
 
    // create simulated io using user buffer memory
    ulong userBufferAddress = controller.AddressGet(RSIControllerAddressType.RSIControllerAddressTypeUSER_BUFFER, 0);
    IOPoint input0  = IOPoint.CreateDigitalInput(controller, userBufferAddress,  bitNumber: 0);
    IOPoint output0 = IOPoint.CreateDigitalOutput(controller, userBufferAddress, bitNumber: 1);
 
    Helpers.CheckErrors(input0);
    Helpers.CheckErrors(output0);
 
    // configure user limit condition
    controller.UserLimitConditionSet(
        number:           0,
        conditionNumber:  0,
        logic:            RSIUserLimitLogic.RSIUserLimitLogicEQ,
        addressOfUInt32:  input0.AddressGet(),
        userLimitMask:    (uint)input0.MaskGet(),
        limitValueUInt32: (uint)input0.MaskGet());
 
    // configure user limit settings
    controller.UserLimitConfigSet(
        number:      0,
        triggerType: RSIUserLimitTriggerType.RSIUserLimitTriggerTypeSINGLE_CONDITION,
        action:      RSIAction.RSIActionNONE,
        actionAxis:  0,
        duration:    0);
 
    // configure user limit output
    controller.UserLimitOutputSet(
        number:    0,
        andMask:   (uint)output0.MaskGet(),
        orMask:    (uint)output0.MaskGet(),
        outputPtr: output0.AddressGet(),
        enabled:   true);
 
    Console.WriteLine("Waiting for input trigger...");
 
    // verify output is initially off
    if (output0.Get())
        throw new Exception("ERROR: Output should not be triggered yet");
 
    // set input high (bit 0) - condition met
    controller.MemorySet(input0.AddressGet(), 0b0001);  // bit 0 is high
 
    // wait for user limit interrupt to confirm trigger
    if (controller.InterruptWait(1000) != RSIEventType.RSIEventTypeUSER_LIMIT)
        throw new Exception("ERROR: User limit did not trigger when input was high");
 
    // verify output was activated
    if (!output0.Get())
        throw new Exception("ERROR: Output should be high after user limit triggered");
 
    Console.WriteLine("✓ User limit triggered successfully - input high, output activated");
 
    // cleanup
    output0.Set(false);
    controller.UserLimitDisable(0);
    controller.UserLimitCountSet(0);
 
    Console.WriteLine("\nUser limit digital input one condition complete.");
}
// handle errors as needed
finally
{
    controller.Delete();  // dispose
}

Note

The maximum number of UserLimits available can be checked with UserLimitCountMax(). UserLimitCountSet should be done after either setting AxisCountSet and/or starting the network (both of those can modify the AxisCount). Internally, RapidCode Axis objects will use UserLimits so it is important to only call UserLimitCountSet after all Axis object counts have been set, but before creating any Axis objects.

See also

UserLimitCountGet, UserLimitCountMax, AxisCountSet