Moves the given axis to its home position.
Namespace: RAYLASE.SPICE3.ClientLibAssembly: RAYLASE.SPICE3.ClientLib (in RAYLASE.SPICE3.ClientLib.dll) Version: 2.3.4
Syntaxpublic 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 MotorAxisVariablesHomingMethod is CurrentPosition. - async Boolean (Optional)
-
Whether homing should be performed asynchronously (default is synchronous homing).
- 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
DoubleThe discovered home position in
UnitsPerStep before setting the origin, or
NaN if asynchronous homing was specified.
See Also