home_axis

Description

Starts the homing procedure for a given axis. The specifics of the homing method depend on the axis' configuration file on the controller. Axes must be homed before moving after power on, but should not need to be re-homed until the next power cycle.

Signature

home_axis(self, axis: int, wait: bool = True) -> CmdToken

Parameters

axis: int

The axis of the open-loop stepper to home, [0, 7].


wait: bool, optional

If True, this command blocks until the axis is homed.

Returns

CmdToken

A CmdToken object that can be used to follow uo on the status of the command or wait for it to finish if wait = False.