Positionerbacklashenable - Newport XPS Programmer's Manual

XPS Unified
7.2.1.144

PositionerBacklashEnable

Name
PositionerBacklashEnable – Enables the backlash compensation.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Group status must be "NOTINIT": (-22)
- Checks the positioner type (must not be a secondary positioner): (-8)
Description
This function enables the backlash compensation defined in the "stages.ini" file or by
"PositionerBacklashSet" function. If the backlash compensation value is null then this
function will have no effect, and backlash compensation will remain disabled..
The group state must be NOTINIT to enable the backlash compensation. If it is not the
case error (-22) is returned.
The parameter "Backlash in the "stages.ini" file" allows the user to enable or disable the
backlash compensation.
Backlash = 0 —> Disable backlash
Backlash >0 —> Enable backlash
The backlash must be disabled to execute a trajectory use the jog mode or analog
tracking mode.
It is not possible to use backlash compensation with positioners that
have one of the following:
1)"HomeSearchSequenceType" defined as
"CurrentPositionAsHome"
2)"PositionerMappingFileName" defined in the stages.ini file.
Prototype
int PositionerBacklashEnable(
int SocketID,
char * FullPositionerName
)
Input parameters
SocketID
FullPositionerName
Output parameters
None.
NOTE
CAUTION
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Positioner name.
221
Programmer's Manual
EDH0373En1023 — 01/18