IAxisHoming

Namespace

ZEquipment

INTERFACE IAxisHoming

Most drives offer various homing methods to reference the coordinate system of its axis. However, some drives, like a variable-frequency drive, do not need this functionality. While the former axes implementations implement this interface, the latter do not.

Methods

HomingAsync

METHOD HomingAsync (
 [input] startToken : ZCore.IStartToken)

Use this method to start the homing prodedure of the axis.

Executing this method while the drive is still Busy with another Async command will cause this method to fail. This can be checked by submitting an StartToken as a startToken. Simply pass such an object and Assert it or check for startToken.Error after calling this method.

Note

Although (servo) drives usually offer a comparable method for homing, it is hard to abstract all methods, which might be possible to use for specific drive manufactures. Therefore, the actual selection of a homing method can usually be found in specific implementations with a SetHomingMethod method (i.e. AxisStepperEL7031.SetHomingMethod.

Inputs

startToken IStartToken

(optional) object to check if the method was executed successfully - may be 0