Tzpvtpulseoutputset - Newport XPS Programmer's Manual

XPS Unified
7.2.1.355

TZPVTPulseOutputSet

Name
TZPVTPulseOutputSet – Sets the configuration of pulse generation of a PVT
trajectory.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks group type (must be a TZ group): (-8)
- Checks group name: (-19)
- Checks the pulse generation must not be in progress: (-22)
- Not available in this configuration (PrecisionPlatform firmware only): (-24)
Description
This function configures and activates the pulse generation of a PVT trajectory. The
pulse generation is defined by a start element, an end element, and a time interval in
seconds. If a pulse generation is already activated on the selected PVT trajectory then
this function returns -22 ("Not allowed action") error.
Please note that the pulse output settings are automatically removed when the trajectory
is over. Hence, with the execution of every new trajectory, it is required to define the
pulse output settings again.
This capability allows output of pulses at constant time intervals on a PVT trajectory.
The pulses are generated between the first and the last trajectory element. The minimum
possible time interval is CorrectorISRPeriod value (system.ref).
The trajectory pulses are generated on the following GPIO ouputs:
GPIO ISA XPS
signals controller
Window GPIO2, pin 11
Pulses GPIO2, pin 12
To find the GPIO connector pin number from GPIOx.DOy, refer to XPS User's
Manual, Appendix / General I/O Description.
Example:
TZPVTPulseOutputSet(Group1, 3, 5, 0.01)
One pulse will be generated every 10 ms between the start of the 3rd element and the
end of the 5th element.
Prototype
int TZPVTPulseOutputSet(
int SocketID,
char GroupName[250],
int StartElement,
int EndElement,
double TimeInterval
)
PCI XPS controller (for
example XPS-RL) with
basic GPIO board
GPIO1.DO6
GPIO1.DO7
517
Programmer's Manual
PCI XPS controller (for
example XPS-RL) with
extended GPIO board
GPIO5.DO14
GPIO5.DO15
EDH0373En1023 — 01/18