MotorAPI.Home Method

public double Home(
	MotorAxis axis,
	HomeInput input,
	double maxDistance,
	bool async = false,
	bool setOrigin = true
)

Parameters

axis  MotorAxis

The axis.

input  HomeInput

Which sensor input should be used.

maxDistance  Double

The maximum distance that may be traveled while searching for the sensor.
Note that this parameter is ignored when MotorAxisVariables.HomingMethod is CurrentPosition.

async  Boolean  (Optional)

Whether homing should be performed asynchronously (default is synchronous homing).

• For asynchronous homing, this function returns NaN immediately.
• To wait for asynchronous homing to finish, use WaitForHomeDone(Nullable<MotorAxis>, Nullable<Int32>).

setOrigin  Boolean  (Optional)

true: use the discovered home position to define the origin of the axis.
false: simply search for the home position sensor, without affecting the axis origin.

Return Value

Reference