Positionertimeflasherset - Newport XPS Programmer's Manual

XPS Unified
7.2.1.294

PositionerTimeFlasherSet

Name
PositionerTimeFlasherSet – Sets the time flasher parameters.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks the positioner type (must not be a secondary positioner): (-8)
- Checks input parameter values: (-17)
• MinimumPosition <MaximumPosition.
• MinimumPosition ≥MinimumTravelLimit.
• MaximumPosition ≤MaximumTravelLimit.
• 0.0000004 ≤TimePeriod ≤50.0 (Max 2.5 MHz and Min 0.02 Hz)
- Checks the time flasher state (must be disabled): (-22)
- Checks the position encoder (must be used): (-24)
- Checks if the CIE board supports this function: (-115)
Description
This function configures the time flasher parameters. The time flasher output trigger
uses the PCO connector on the XPS controller cards. The time flasher mode is defined
by:
• a position window defined by a minimum position and a maximum position.
• a time period to set the time spaced pulses.
This function is not available without a position encoder.
These parameters are used only when the time flasher mode is enabled. To enable
the time flasher mode, use the "PositionerPositionCompareEnable" function.
For a more thorough description of the position compare output, please refer to
the XPS Motion Tutorial section Triggers/Position Compare Output.
Prototype
int PositionerTimeFlasherSet(
int SocketID,
char * FullPositionerName,
double MinimumPosition,
double MaximumPosition,
double TimePeriod,
bool EnableState
)
NOTES
437
Programmer's Manual
EDH0373En1023 — 01/18