APIs, concepts, guides, and more

◆ HomeLimitGet()

bool HomeLimitGet ( )
Description:
HomeLimitGet returns the if the home limit is triggered.
Returns
(bool) State of the input.

Part of the Dedicated I/O method group.

Note
Will return true when the dedicated IO is LOW if Trigger value is low.
See also
HomeTriggerStateSet
Sample Code:
if (axis.HomeLimitGet() == true) {
Console.WriteLine("Home Limit input is High");
}
RapidSetup:
Go to axis screen->Dedicated I/O tab. The High/Low state next to Home is the result of the HomeLimitGet function.
See also
PositiveLimitGet, NegativeLimitGet
Note
If a custom home input is configured, the return value is the state of the custom input.