Positioneranalogtrackingpositionparametersset - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.140

PositionerAnalogTrackingPositionParametersSet

Name
PositionerAnalogTrackingPositionParametersSet – Sets the parameters of the
current tracking position mode.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks Positioner and GPIO type (ADC): (-8)
- Checks velocity and acceleration: (-17)
- Checks input parameter: (-18)
Description
This function modifies the analog input name, the offset and the scale used by the
analog tracking position mode. To use this function, the group state must be
READYotherwise error (-22) is returned.
The "Offset" and the "Scale" parameters are used to calculate the target tracking
position:
TrackingPosition = InitialPosition + (AnalogValue - Offset) * Scale
The "Velocity" and "Acceleration" parameters define the maximum velocity and
acceleration used in the position tracking mode.
The parameters for analog tracking position mode can be reset, if the
"GPIOName" parameter is blank.
Prototype
int PositionerAnalogTrackingPositionParametersSet(
int SocketID,
char FullPositionerName,
char * GPIOName,
double Offset,
double Scale,
double Velocity,
double Acceleration
)
Input parameters
SocketID
FullPositionerName
GPIOName
Offset
Scale
Velocity
Acceleration
NOTE
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char Positioner name FrequecyTicks.
char * Analog input name (ADC).
double Offset in volts.
double Scale (Units/Volts).
double Velocity (Units/s).
double Acceleration (Units/s²).
214
Programmer's Manual