NI-Sync API Reference Help
NI-Sync API Reference Help
Related Documentation
Target Support for Timing Properties and VIs
Hardware Compatibility with NI-Sync Features
Synchronization Methods
Comparing Signal-Based and Time-Based Synchronization
Using Signal-Based Synchronization in NI-Sync
Using Time-Based Synchronization in NI-Sync
Clocks and Triggers
Triggers in NI-Sync
Routing Trigger Signals Between Devices
Connecting and Synchronizing Triggers
Defining NI-Sync Trigger Terminals
Trigger Terminal Connections
Clocks in NI-Sync
Routing Clock Signals Between Devices
Clock Terminal Connections
Defining NI-Sync Clock Terminals
Phase Locking to an External Clock Using a PLL Circuit
Enabling and Configuring a Phase-Locked Loop
Routing and Locking the PLL Reference Clock
Using Synchronization Clocks in NI-Sync
Setting and Dividing a Synchronization Clock
Routing a Synchronization Clock Along a Trigger Line
Firing Triggers with a Synchronization Clock
Time References and Protocols
Time References
Selecting a Time Reference
Locking to an External Time Reference
Creating and Reading Timestamps
Time Protocols
IEEE 1588-2008
IEEE 802.1AS
GPS
IRIG-B
Testing the Stability of an External IRIG Source
PPS
Troubleshooting
Converting Error Codes to a Readable String
Displaying the State of a Trigger Line as an Array
Manually Correcting a Time Reference
Troubleshooting Clock Terminals
Troubleshooting Time References
Troubleshooting GPS
Troubleshooting Trigger Terminals
NI-Sync VIs
niSync Close
niSync Connect Clock Terminals
niSync Connect Software Trigger
niSync Connect Trigger Terminals
niSync Disconnect Clock Terminals
niSync Disconnect Software Trigger
niSync Disconnect Trigger Terminals
niSync Initialize
niSync Property Node
niSync Send Software Trigger
Advanced
niSync Configure FPGA
niSync Measure Frequency
Calibration
niSync Adjust Clk10 Phase Voltage
niSync Adjust DDS Start Pulse Phase Voltage
niSync Adjust Oscillator Voltage
niSync Close External Calibration
niSync Initialize External Calibration
Calibration Utility
niSync Change External Calibration Password VI
niSync Get Clk10 Phase Voltage VI
niSync Get DDS Start Pulse Phase Voltage VI
niSync Get External Calibration Last Date and Time VI
niSync Get External Calibration Last Temperature VI
niSync Get External Calibration Recommended Interval VI
niSync Get Oscillator Voltage VI
niSync Read Current Temperature VI
Timing
niSync Clear Clock
niSync Clear Future Time Events
niSync Create Clock
niSync Create Future Time Event
niSync Disable Time Stamp Trigger
niSync Enable Time Stamp Trigger
niSync Get Time
niSync Read Trigger Time Stamp
GPS
niSync Disable GPS or IRIG Timestamping
niSync Enable GPS or IRIG Timestamping
niSync Get Location
niSync Get Velocity
niSync Read Last GPS or IRIG Timestamp
Time Reference
niSync Get Time References
niSync Reset Frequency
niSync Set Time
niSync Set Time Reference
1588
niSync Start 1588
niSync Stop 1588
Utility
niSync Convert 1588 Time to Time Stamp
niSync Convert Time Stamp To 1588 Time
niSync Error Message
niSync Persist Configuration
niSync Reset
niSync Revision Query
niSync Self-Test
niSync Wait Until Time
NI-Sync Properties
Active Item
Calibration Properties
PFI0 Threshold
PFI1 Threshold
PFI2 Threshold
PFI3 Threshold
PFI4 Threshold
PFI5 Threshold
Oscillator Voltage
Clk10 Phase Adjust
DDS VCXO Voltage
DDS Phase Adjust Voltage
PFI0 1kOhm Termination Enable
PFI1 1kOhm Termination Enable
PFI2 1kOhm Termination Enable
PFI3 1kOhm Termination Enable
PFI4 1kOhm Termination Enable
PFI5 1kOhm Termination Enable
PFI0 10kOhm Termination Enable
PFI1 10kOhm Termination Enable
PFI2 10kOhm Termination Enable
PFI3 10kOhm Termination Enable
PFI4 10kOhm Termination Enable
PFI5 10kOhm Termination Enable
Clk Properties
ClkOut Gain Enable
Disable ClkIn Attenuation
PLL Frequency
PLL Locked?
PXI_Clk10 Present?
Use PLL?
DDS Properties
DDS Frequency
DDS Initial Delay
DDS Update Signal Source
Interface Properties
Interface Number
Serial Number
Synchronization Clock Properties
Clock Divisor 1
Clock Divisor 2
PFI0 Frequency Reference
Reset DDS Counters on PXI_Trig
Reset PFI0 Counters on PXI_Trig
Reset PXI_Clk10 Counters on PXI_Trig
Reset Synchronization Clock PXI_Trig Line
Synchronization Clock Source (PFI, PFI_LVDS)
Synchronization Clock Source (PXI_Trig, PXI_Star, PXIe_DStarB)
Timing Properties
Selected Time Reference Type
Selected Time Reference Name
Is Time Reference Present
Offset from Time Reference (s)
Offset from Time Reference (ns)
Time Reference Correction
UTC Offset
UTC Offset Valid
Clock Resolution
Last Synchronization ID
Time Reference
Time Reference Type
Time Reference Enabled
Is Time Reference Selected
1588
IP Address
Clock State
Clock ID
Clock Class
Clock Accuracy
Frequency Traceable
Leap59
Leap61
Offset Scaled Log Variance
Priority1
Priority2
Grandmaster IP Address
Grandmaster Clock ID
Grandmaster Clock Class
Grandmaster Clock Accuracy
Grandmaster Priority1
Grandmaster Priority2
Steps to Grandmaster
Log Sync Interval
Mean Path Delay
BMCA Mode
Interface Name
Time Source
Time Traceable
802.1AS
Port State
Clock ID
Clock Class
Clock Accuracy
Priority1
Priority2
Grandmaster Clock ID
Grandmaster Clock Class
Grandmaster Clock Accuracy
Grandmaster Priority1
Grandmaster Priority2
Log Sync Interval
Log Announce Interval
Neighbor Propagation Delay Threshold (ns)
AS Capable
Interface Name
GPS
Is Antenna Connected
Mobile Mode
Percent Complete of Self Survey
Recalculate Position on Reboot
Satellites Available
Status
Time Stamps
Available Time Stamps
Time Stamp Buffer Size
Trigger State Properties
PFI Line State
PFI_LVDS Line State
PXI_Star Line State
PXI_Star Peripheral Line State
PXI_Trig Line State
PXIe_DStarB Peripheral Line State
PXIe_DStarC Line State
User LED Control
User LED State
Glossary