Class Home::AxisHomeData

Nested Relationships

This class is a nested type of Class Home.

class AxisHomeData

This class contains homing related data for a single axis.

Public Functions

Public Members

double distHStoZPulse: The distance from the home switch position to the Z-pulse (index pulse) position. This value may be negative, in which case the home switch position is greater than the Z-pulse (index pulse) position. This value is zero unless a homing operation that uses the home switch and the Z-pulse (index pulse) has been completed. For the HSReverseZPulse home type, this value is first calculated when the rising edge of the home switch is detected, and then updated if the falling edge of the home switch is detected during reverse movement. This value has units of user units.

double distLStoZPulse: The distance from the limit switch position to the Z-pulse (index pulse) position. This value may be negative, in which case the limit switch position is greater than the Z-pulse (index pulse) position. This value is zero unless a homing operation that uses the limit switch and the Z-pulse (index pulse) has been completed. This value has units of user units.

double distMechanicalEndToZPulse: The distance from the mechanical end position to the Z-pulse (index pulse) position. This value may be negative, in which case the mechanical end position is greater than the Z-pulse (index pulse) position. This value is zero unless a homing operation that uses the mechanical end and the Z-pulse (index pulse) has been completed. This value has units of user units.

double latchedZPulseEncoder: The Z-pulse (index pulse) encoder count that was latched during homing. This is the raw encoder count at the position where the Z-pulse (index pulse) was detected. It is not affected by the home offset. This value is automatically updated while homing when using a home type that searches for the Z-pulse (index pulse).

double latchedLimitSwitchEncoder: The raw encoder count at the position where the limit switch was found during homing. Because this position is latched by software, it is typically not as precise as the Z-pulse (index pulse) or touch probe. This value is automatically updated while homing when using a home type that searches for the limit switch position.

double latchedHomeSwitchEncoder: The raw encoder count at the position where the home switch was found during homing. Because this position is latched by software, it is typically not as precise as the Z-pulse (index pulse) or touch probe. This value is automatically updated while homing when using a home type that searches for the home switch position.

double latchedFirstHomeSwitchEncoder: The raw encoder count at the position where the first home switch was found during homing. This status is identical to latchedHomeSwitchEncoder, except as follows. This status does not update when the home switch is searched for the second time when homing using the HSHS home type. This status does not update when searching for the falling edge of the home switch when the home switch is on at the beginning of homing or the limit switch is triggered during homing, with one exeception as follows. If the home type is HSHS, if the home switch is on at the beginning of homing, this status will update when the falling edge of the home switch is first found.

double latchedTouchProbeEncoder: The touch probe encoder count that was latched during homing. This is the raw encoder count at the position where the touch probe was detected. It is not affected by the home offset. This value is automatically updated when homing using a home type that searches for the touch probe.

double distZPulseToMasterZPulse: The distance between the Z-pulse (index pulse) position of the axis and the Z-pulse position of the master axis. This status will contain 0 if the axis is not a sync slave axis, or if the Z-pulse position has not been detected for the master and slave axes. This value is in user units of the slave axis. This value is automatically updated while homing a pair of gantry axes when using a home type that searches for the Z-pulse.

double distLSToMasterLS: The distance between the limit switch position of the axis and the limit switch position of the master axis. This status will contain 0 if the axis is not a sync slave axis, or if the limit switch position has not been detected for the master and slave axes. This value is in user units of the slave axis. This value is automatically updated while homing a pair of gantry axes when using a home type that searches for the limit switch position.

double distHSToMasterHS: The distance between the home switch position of the axis and the home switch position of the master axis. This status will contain 0 if the axis is not a sync slave axis, or if the home switch position has not been detected for the master and slave axes. This value is in user units of the slave axis. This value is automatically updated while homing a pair of gantry axes when using a home type that searches for the home switch position.