Home Error

If an error is encountered during homing, the homing routine will be aborted. The axis will leave the Home operation state with the Home Done status not set to true.

The type of error that was encountered is stored in the Home Error status. The GetStatus function can be called to obtain this status. This error will remain until the next time that homing is started for that axis.

When executing gantry homing (see What is Gantry Homing), the home error will only be set for the master axis.

Each home error is explained in the following table.

Home Error

Description

NoError

No error was encountered. The Home Error status of the axis will be set to this value when a new homing operation is started.

LSTriggered

The Home Error status of the axis will be set to this value if a limit switch (hardware limit switch, near limit switch, or external limit switch) was triggered during homing. The limit switch must be enabled (LS Type, Near LS Type, or External LS Type parameter must be set to a value other than None) to cause this error.

Several Home Types use the limit switch in the direction of homing (see Limit Switches During Homing). For these home types, the limit switch in the direction of homing will not trigger this error.

If the All LS During Homing parameter is set to true, positive limit switches can be triggered while moving in the negative direction and negative limit switches can be triggered while moving in the positive direction. If the limit switch is triggered this way, this error is also set.

MaxLSRevDistanceTraveled

The Home Error status of the axis will be set to this value if the maximum limit switch reverse distance (set with the Max LS Reverse Distance parameter) is exceeded during homing.

This error will not occur if Max LS Reverse Distance is set to 0.

MaxHSOnAtStartRevDistanceTraveled

The Home Error status of the axis will be set to this value if the maximum home switch on at start reverse distance (set with the Max HS On At Start Reverse Distance parameter) is exceeded during homing.

This error will not occur if Max HS On At Start Reverse Distance is set to 0.

ZPulseDistanceCheckError

The Home Error status of the axis will be set to this value if consecutive Z-pulses that do not match the predefined Z-pulse distance (set with the Z-Pulse Distance Check parameter) are detected during multiple Z-pulse homing.

This error will not occur if Z-Pulse Distance Check is set to 0 or Multiple Z-Pulse is not set to 2 or more.