HomeSwitchGet()

bool HomeSwitchGet

(

)

Description:

HomeSwitchGet returns the current state of the Home switch input.

Returns

(bool) State of the input.

Remarks

This function is also available in RapidSequencer.

Part of the Dedicated I/O method group.

Warning

Will return true when the dedicated IO is HIGH regardles of trigger value.

Sample Code:

if (axis.HomeSwitchGet() == true) {
  Console.WriteLine("Home Switch input is High");
}

RapidSetup:

Go to axis screen->Dedicated I/O tab. The High/Low state next to Home is the result of the HomeSwitchGet function.

See also

PositiveLimitGet, NegativeLimitGet

Note

If a custom home input is configured, the return value is the state of the custom input.