Positionercorrectorpipositionset - Newport XPS Programmer's Manual

XPS Unified
7.2.1.225

PositionerCorrectorPIPositionSet

Name
PositionerCorrectorPIPositionSet – Sets PIPosition corrector parameters.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks the positioner type and the corrector type: (-8)
- Checks parameter value: (-17)
- KP ≥0.
- KI ≥0.
- IntegrationTime ≥CorrectorISRPeriod.
Refer to system.ref file to get CorrectorISRPeriod value.
Description
This function configures the "PIPosition" corrector parameters.
The "CorrectorType" parameter must be defined as "PIPosition" in the stages.ini
file else ERR_WRONG_OBJECT_TYPE (-8) is returned. This servo loop type is
used when the position servo loop outputs a position value directly.
Prototype
int PositionerCorrectorPIPositionSet(
int SocketID,
char * FullPositionerName,
bool ClosedLoopStatus,
double KP,
double KI,
double IntegrationTime
)
Input parameters
SocketID
FullPositionerName
ClosedLoopStatus
KP
KI
IntegrationTime
NOTE
NOTE
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Positioner name.
bool Position servo loop status (true = closed and
false = opened).
double PI servo loop proportional gain.
double PI servo loop integral gain.
double PI integration time (seconds).
353
Programmer's Manual
EDH0373En1023 — 01/18