Positionercorrectorpidaccelerationfilterset - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.215

PositionerCorrectorPIDAccelerationFilterSet

Name
PositionerCorrectorPIDAccelerationFilterSet – Sets PID acceleration corrector filter
parameters.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks the object type of this command is valid: (-8)
- Checks the motion status (Motion status must be disable): (-134)
- Checks PID Acceleration Filter is enabled: (-205)
Description
This function updates PID acceleration corrector filter parameters and enables/disables
the filter.
Prototype
int PositionerCorrectorPIDAccelerationFilterSet(
int SocketID,
char * PositionerName,
bool * FilterControlStatus,
double * KD,
double * DerivativeFilterCutOffFrequency
)
Input parameters
SocketID
PositionerName
FilterControlStatus
KD
DerivativeFilterCutOffFrequency double Derivative Filter Cut-off Frequency
Output parameters
None.
Return (In addition to the results of "Input Tests Common to all XPS
Functions")
• 0: No error.
• -8: Wrong object type for this command.
• -134: Changing the loop status is allowed in DISABLE state only.
• -205: Not enabled in your configuration.
int
char *
bool
double KD gain.
334
Programmer's Manual
Socket identifier gets by the
"TCP_ConnectToServer" function.
Positioner name.
Current position of X axis.
(Hz).