HomeSwitchGet()

bool HomeSwitchGet ( )

pure virtual

Get the current state of the Home switch input.

Description:

HomeSwitchGet returns the current state of the Home switch input.

Returns

(bool) State of the input.

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

Dedicated I/O

Note

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

Examples

DedicatedIO.cpp, and DedicatedIO.cs.