Property Node Descriptions

Owning Palette: NI-Sync VIs

Requires: NI-Sync

You can use the following properties with the niSync Property Node:

Active Item

PropertyDescription
Active ItemSpecifies the time reference or terminal used to access all subsequent properties in this instance of the property node. You must specify an Active Item for properties that require it.

Calibration Properties

PropertyDescription
Clk10 Phase AdjustSpecifies or returns the phase voltage between an external clock and PXI_Clk10 when you are using the PLL circuit to lock PXI_CLK10 to an external reference clock. You can minimize the time between rising edges of PXI_CLK10 and the external reference clock using this parameter.
DDS Phase Adjust VoltageSpecifies or returns the DDS Phase Adjust voltage.
DDS VCXO VoltageSpecifies or returns the DDS VCXO voltage.
Oscillator VoltageSpecifies or returns the tuning voltage for the selected device's OCXO or TCXO. You can vary the oscillator frequency over a small range (between 0 and 3 volts). The tuning voltage adjusts the output frequency.
PFI0 ThresholdSpecifies or returns the voltage threshold, in volts, of the PFI0 terminal of the associated device.
PFI1 ThresholdSpecifies or returns the voltage threshold, in volts, of the PFI1 terminal of the associated device.
PFI2 ThresholdSpecifies or returns the voltage threshold, in volts, of the PFI2 terminal of the associated device.
PFI3 ThresholdSpecifies or returns the voltage threshold, in volts, of the PFI3 terminal of the associated device.
PFI4 ThresholdSpecifies or returns the voltage threshold, in volts, of the PFI4 terminal of the associated device.
PFI5 ThresholdSpecifies or returns the voltage threshold, in volts, of the PFI5 terminal of the associated device.
PFI0 1kOhm Termination EnableSpecifies whether or not the PFI0 terminal should be terminated with 1 kOhm impedance.
PFI0 10kOhm Termination EnableSpecifies whether or not the PFI0 terminal should be terminated with 10 kOhm impedance.
PFI1 1kOhm Termination EnableSpecifies whether or not the PFI1 terminal should be terminated with 1 kOhm impedance.
PFI1 10kOhm Termination EnableSpecifies whether or not the PFI1 terminal should be terminated with 10 kOhm impedance.
PFI2 1kOhm Termination EnableSpecifies whether or not the PFI2 terminal should be terminated with 1 kOhm impedance.
PFI2 10kOhm Termination EnableSpecifies whether or not the PFI2 terminal should be terminated with 10 kOhm impedance.
PFI3 1kOhm Termination EnableSpecifies whether or not the PFI3 terminal should be terminated with 1 kOhm impedance.
PFI3 10kOhm Termination EnableSpecifies whether or not the PFI3 terminal should be terminated with 10 kOhm impedance.
PFI4 1kOhm Termination EnableSpecifies whether or not the PFI4 terminal should be terminated with 1 kOhm impedance.
PFI4 10kOhm Termination EnableSpecifies whether or not the PFI4 terminal should be terminated with 10 kOhm impedance.
PFI5 1kOhm Termination EnableSpecifies whether or not the PFI5 terminal should be terminated with 1 kOhm impedance.
PFI5 10kOhm Termination EnableSpecifies whether or not the PFI5 terminal should be terminated with 10 kOhm impedance.

Clk Properties

ClkOut Gain EnableSet this parameter to TRUE to increase the amplitude of the ClkOut terminal from 1 peak-to-peak volt to 2.5 peak-to-peak volts. Enable this parameter if you are distributing a clock between chassis to give the clock enough gain to reach its destination. Set the parameter to FALSE to return the amplitude to 1 peak-to-peak volt.
Disable ClkIn AttenuationSpecifies whether or not to attenuate the signal at ClkIn. Setting this property to TRUE disables the ClkIn attenuation.
PLL FrequencySpecifies or returns the frequency of the clock the PLL circuit should lock to. Refer to your hardware manual to determine the specific frequency range the device's PLL circuit can lock to.
PLL Locked?Returns whether or not the PLL circuit is locked to the external reference clock. This property returns TRUE when the PLL is locked.
PXI_Clk10 Present?Returns whether or not the PXI_Clk10 signal is present on the backplane. This parameter returns TRUE when the PXI_Clk10 signal is present.
Use PLL?Specifies or returns if the connection between ClkIn and PXI_Clk10 should use the PLL circuit. If this parameter is set to TRUE, the PLL will be used to lock to the frequency at ClkIn when connecting to PXI_CLK10. You must set this property before connecting the clock to PXI_Clk10_In.

DDS Properties

DDS FrequencySpecifies or returns the frequency, in Hz, of the DDS signal generated by the associated device. Use this parameter to generate a DDS clock signal at a specific frequency or to read the current DDS frequency.
DDS Initial DelaySpecifies or returns the initial delay, in seconds, that the associated device should wait before it begins generating a DDS signal. You must set this attribute prior to setting the DDS frequency, and you must set it using the same NI-Sync instrument driver session that you use to set the DDS frequency.
DDS Update Signal SourceSpecifies or returns the source of the signal that will trigger DDS generation. By default, the DDS signal generates as soon as you set the frequency. Using this parameter, you can generate or update the DDS frequency with an update pulse that arrives on a specified PXI_Trig terminal.

Interface Properties

Interface NumberReturns the board number of the connected NI-Sync device. If there are multiple instances of the NI-Sync device, each will have a unique interface number.
Serial NumberReturns the serial number of the connected NI-Sync device.

Synchronization Clock Properties

Clock Divisor 1Specifies or returns the value of the first clock division. Use this number to divide the full-speed synchronization clock and produce Divided Clock 1. The value must be a power of two between 2 and 512.
Clock Divisor 2Specifies or returns the value of the second clock divisor. Use this number to divide the full-speed synchronization clock and produce Divided Clock 2. The value must be a power of two between 2 and 512.
PFI0 Frequency ReferenceSpecifies or returns the frequency reference, in MHz, for the PFI0 terminal. You must have an external reference clock connected to use this parameter.
Reset DDS Counters on PXI_TrigSpecifies or returns whether or not the DDS clock dividers should reset when the device receives an update pulse on the PXI_Trig line specified in the Reset Synchronization Clock PXI_Trig Line parameter. If TRUE, the DDS clock dividers reset on the rising edge of the update pulse.
Reset PFI0 Counters on PXI_TrigSpecifies or returns whether or not the PFI0 clock dividers should reset when the device receives an update pulse on a PXI_Trig line. You can specify which PXI_Trig line contains the update pulse using the Reset Synchronization Clock PXI_Trig Line property. If TRUE, the PFI0 dividers reset on the rising edge of the update pulse.
Reset PXI_Clk10 Counters on PXI_TrigSpecifies or returns whether or not PXI_Clk10 clock dividers should reset when the device receives an update pulse on a PXI_Trig line. You can specify which PXI_Trig line contains the update pulse using the Reset Synchronization Clock PXI_Trig Line property. If TRUE, the PXI_Clk10 dividers reset on the rising edge of the update pulse.
Reset Synchronization Clock PXI_Trig LineSpecifies or returns which PXI_Trig terminal contains the update pulse used to reset the synchronization clock dividers. The default is none. You must set this value before you can reset synchronization clock dividers using an update pulse on a PXI_Trig line.
Synchronize Clock Source (PFI, PFI_LVDS)Specifies or returns the synchronization clock source for the front zone (PFI and PFI_LVDS) terminals. Valid values:
  • PFI0
  • PXI_Clk10
  • DDS
  • PXIe_Clk100
  • Oscillator
  • ClkIn
Synchronize Clock Source (PXI_Trig, PXI_Star, PXIe_DStarB)Specifies or returns the synchronization clock source for the rear zone (PXI_Trig, PXI_Star, and PXIe_DStarB) terminals. Valid values:
  • PFI0
  • PXI_Clk10
  • DDS
  • PXIe_Clk100
  • Oscillator
  • ClkIn

User LED Control

User LED StateReturns the state of the User LED. The LED lights when this attribute is set. When queried, it returns TRUE when the LED is lit.

Timing

Many timing properties are only supported on certain targets. Refer to Target Support for Timing Properties to determine if any given timing property is supported on your target.

PropertyDescription
Selected Time Reference TypeReturns the time synchronization protocol (1588, EtherCAT, GPS, etc.) being used by the selected time reference.
Selected Time Reference NameReturns the name of the selected time reference.
Is Time Reference PresentReturns TRUE if the selected time reference is currently providing a valid time signal. You must set an external time reference for this parameter to function.
Offset from Time Reference (ns)Returns the calculated offset, in nanoseconds, from the selected time reference. Use this property to determine when the local clock is sufficiently synchronized with the selected time reference to continue operations.
Offset from Time Reference (s)Returns the calculated offset, in seconds, between your module's oscillator and its selected time reference, such as GPS or 1588. Use this parameter to determine when the local clock is sufficiently synchronized with the selected time reference to continue operations.
Time Reference CorrectionSpecifies or returns a manual correction, in seconds, to apply to the time reference. Use this property to calibrate the time reference manually to achieve better synchronization with the selected time reference.
UTC OffsetSpecifies or returns the offset, in seconds, of the UTC timescale from the current time reference.
UTC Offset ValidSpecifies or returns whether the UTC offset of the current time reference is valid.
Clock ResolutionReturns the resolution, in nanoseconds, of the device's clock. The clock resolution represents the duration of a single tick of the clock.
Last Synchronization IDIncrements when a synchronization message is received from the current time reference.

Timing:Time Reference

PropertyDescription
Time Reference TypeReturns the synchronization protocol being used by the time reference connected to the Active Item property.
Time Reference EnabledSpecifies or returns whether the time reference connected to the Active Item property is enabled.
Is Time Reference SelectedReturns whether the time reference specified in the Active Item property is the selected time reference for the device.

Timing:Time Reference:1588

BMCA Mode Specifies or returns which mode of the Best Master Clock algorithm (BMCA) to use for the time reference specified in Active Item.
Clock AccuracyReturns the accuracy of the device's 1588 clock in comparison to the currently selected time reference.
Clock ClassReturns the traceability of the time or frequency distributed by the 1588 clock on the specified time reference.
Clock IDReturns a string that represents the 64-bit Global Identifier (EUI-64) for the 1588 clock.
Clock StateReturns the state of the 1588 clock. You can query this property to determine if this clock has reached a steady state before the application continues with other operations dependent on this clock, or to determine if an error occurred during synchronization.
Grandmaster Clock AccuracyReturns the accuracy of the 1588 grandmaster clock.
Grandmaster Clock ClassReturns the traceability of the time or frequency distributed by the 1588 grandmaster clock associated with this session.
Grandmaster Clock IDReturns a string that represents the 64-bit Global Identifier (EUI-64) for the 1588 grandmaster clock.
Grandmaster IP AddressReturns the IP address of the 1588 grandmaster clock used by the time reference specified in Active Item.
Grandmaster Priority1Returns the 1st order priority assigned to the 1588 grandmaster clock. This property can range from 0 to 255. A lower value indicates a higher priority.
Grandmaster Priority2Returns the 2nd order priority assigned to the 1588 grandmaster clock. This property can range from 0 to 255. A lower value increases the priority.
Interface NameReturns the name of the network interface used by the time reference specified in Active Item.
IP AddressReturns the IP address assigned to the 1588 device associated with this session.
Log Sync IntervalSpecifies or returns the mean sync interval used by the 1588 clock. Use a smaller sync interval to make clocks respond more quickly to changes in the time reference. Use a larger sync interval to send packets less frequently and decrease network load.
Mean Path DelayReturns the mean propagation delay, in seconds, between the 1588 clock associated with this session and the master. This is the average amount of time it takes for a packet to reach a slave device from the 1588 master.
Priority1Specifies or returns the 1st order priority assigned to the 1588 clock. This property can range from 0 to 255. A lower value indicates a higher priority.
Priority2Specifies or returns the second order priority assigned to the 1588 clock. This property can range from 0 to 255. A lower value indicates a higher priority.
Steps to GrandmasterReturns the number of steps that the 1588 clock is away from the grandmaster.

Timing:Time Reference:802.1AS

Note Note  802.1AS properties are supported only on Linux RT devices.
PropertyDescription
Port StateReturns the state of the 802.1AS clock used by the time reference specified in Active Item. This property can be queried to determine if this clock has reached a steady state before the application continues with other operations dependent on this clock.
Clock IDReturns a string that represents the 64-bit Global Identifier (EUI-64) of the 802.1AS clock used by the time reference specified in Active Item.
Clock ClassReturns the traceability of the time or frequency distributed by the 802.1AS clock used by the time reference specified in Active Item.
Clock AccuracyReturns the accuracy of the 802.1AS clock used by the time reference specified in Active Item.
Priority1Specifies or returns the first order priority assigned to the 802.1AS clock used by the time reference specified in Active Item. This property can range from 0 to 254. A lower value increases the priority.
Priority2Specifies or returns the second order priority assigned to the 802.1AS clock used by the time reference specified in Active Item. This property can range from 0 to 254. A lower value increases the priority.
Grandmaster Clock IDReturns a string that represents the 64-bit Global Identifier (EUI-64) for the 802.1AS grandmaster clock used by the time reference specified by Active Item.
Grandmaster Clock ClassReturns the traceability of the time or frequency distributed by the 802.1AS grandmaster clock used by the time reference specified in Active Item.
Grandmaster Clock AccuracyReturns the accuracy of the 802.1AS grandmaster clock used by the time reference specified in Active Item.
Grandmaster Priority1Returns the 1st order priority assigned to the 802.1AS grandmaster clock used by the time reference specified in Active Item. This property can range from 0 to 255. A lower value denotes a higher priority.
Grandmaster Priority2Returns the 2nd order priority assigned to the 802.1AS grandmaster clock used by the time reference specified in Active Item. This property can range from 0 to 255. A lower value increases the priority.
Log Sync IntervalSpecifies or returns the mean sync interval used by the 802.1AS clock in the time reference specified by Active Item. This value will be used only if the Best Master Clock algorithm (BMCA) chooses the local clock to be the grandmaster.
Log Announce IntervalSpecifies or returns the mean time interval between the sending of successive announce messages. Announce messages allow time-aware systems to exchange information used by the best master clock algorithm. This value is the logarithm to the base 2.
Neighbor Propagation Delay Threshold (ns)Specifies or returns the propagation time threshold, in nanoseconds, of the time reference specified in Active Item.
AS CapableReturns whether the time reference specified in Active Item is capable of participating in the IEEE 802.1AS protocol. This value is TRUE only if this time-aware system and the time-aware system it is linked to can inter-operate with each other via the 802.1AS protocol.
Interface NameReturns the network interface used by the 802.1AS clock in the time reference specified by Active Item.

Timing:Time Reference:GPS

Is Antenna ConnectedReturns whether or not the GPS antenna is properly connected. This property returns TRUE if a GPS antenna is connected.
Mobile ModeSpecifies or returns whether or not the GPS should use Mobile Mode. If you enable Mobile Mode by setting the paramter to TRUE, the user can move the GPS antenna and continuously calculate the current position and velocity. If you disable Mobile Mode by setting the parameter to FALSE, the antenna must remain in a fixed position while the computer is on.
Percent Complete of Self SurveyReturns the percentage of the GPS self-survey that has been completed. The onboard GPS receiver requires at least four visible satellites to begin a self survey.
Recalculate Position on RebootSpecifies or returns whether or not the GPS receiver of the device should attempt to recalculate the current position every time the system reboots. If you set this value to FALSE, the GPS permanently stores the current location.
Satellites AvailableReturns the number of GPS satellites currently being tracked. A minimum of four satellites must be visible for the onboard GPS receiver to perform a self survey. If you have selected GPS as the time reference, four or more satellites must be visible throughout timing measurements for the most accurate results.
StatusReturns the status of the GPS antenna on the associated device. Query this property to determine if GPS is in a valid state before the application continues with other operations dependent on GPS. You can also use this property to troubleshoot various GPS errors.

Timing:Time Stamps

Available Time StampsReturns the number of timestamps available to read for terminal specified in Active Item.
Time Stamp Buffer SizeSpecifies or returns the software buffer size, in number of timestamps, for the terminal specified with Active Item.

Trigger State Properties

PFI Line StateIndicates the current state of a chassis' PFI terminals by returning a bitmap represented by a 32-bit integer. In binary, bit 0 corresponds to PFI0, bit 1 corresponds to PFI1, etc. Bits 6 and above are not defined.
PFI_LVDS Line StateIndicates the current state of a chassis' PFI_LVDS terminals by returning a bitmap represented by a 32-bit integer. In binary, bit 0 corresponds to PFI_LVDS0, bit 1 corresponds to PFI_LVDS1, etc.
PXI_Star Line StateIndicates the current state of a chassis' PXI_Star lines by returning a bitmap represented by a 32-bit integer. In binary, bit 0 corresponds to PXI_Star0, bit 1 corresponds to PXI_Star1, and so on.
PXI_Star Peripheral Line StateReturns the logical state of the PXI_Star peripheral terminal. This value is only valid when the board is in a peripheral slot.
PXI_Trig Line StateIndicates the current state of a chassis' PXI_Trig lines by returning a bitmap represented by a 32-bit integer. In binary, bit 0 corresponds to PXI_Trig0, bit 1 corresponds to PXI_Trig1, and so on.
PXIe_DStarB Peripheral Line StateReturns TRUE when there is a peripheral device connected to the PXIe_DStarB peripheral terminal.
PXIe_DStarC Line StateIndicates the current state of a chassis' PXIe_DStarC lines by returning a bitmap represented by a 32-bit integer. In binary, bit 0 corresponds to PXIe_DStarC0, bit 1 corresponds to PXIe_DStarC1, and so on.