Selects the time reference of a time-based timing and synchronization module. NI-Sync uses the selected time reference to update the value and frequency of the module's board time.
If the selected external time reference does not provide valid information, the board time goes into free running mode, starting at the last known time and running at the last frequency that was applied. To determine what the currently selected time reference is, use the Selected Time Reference Name and/or Selected Time Reference Type properties.
![]() |
Note
|
![]() |
Note |
Use the pull-down menu to select an instance of this VI.
Use this instance to set the external time reference of the device to 1588 Ordinary Clock. If the device is not a 1588 slave and you set the time reference to 1588 Ordinary Clock, the board time enters free running mode.
Calling this VI does not explicitly start the 1588 protocol. You must invoke the niSync Start Time Reference VI after setting the time reference for the device to participate in 1588. Alternately, you can start and stop 1588 in Measurement & Automation Explorer (MAX).
![]() |
instrument handle specifies the instrument handle that you obtain from niSync Initialize. |
![]() |
error in (no error) describes error conditions that occur before this node runs. This input provides standard error in functionality. |
![]() |
instrument handle out returns the instrument handle that you obtain from niSync Initialize. |
![]() |
error out returns error conditions that occur after this node runs. This output provides standard error out functionality. |
Use this instance to send the device into free running mode, where its start time and frequency are not tied to any external time reference. The board time atomically increments at the last applied frequency. Use this instance if you do not have a strong connection to a network or an external time reference. Your device will automatically enter free running mode if the external time reference you select does not provide valid time information.
![]() |
instrument handle specifies the instrument handle that you obtain from niSync Initialize. |
![]() |
error in (no error) describes error conditions that occur before this node runs. This input provides standard error in functionality. |
![]() |
instrument handle out returns the instrument handle that you obtain from niSync Initialize. |
![]() |
error out returns error conditions that occur after this node runs. This output provides standard error out functionality. |
Use this instance to set the external time reference of the device to PPS (pulse per second).
![]() |
instrument handle specifies the instrument handle that you obtain from niSync Initialize. |
||||
![]() |
terminal specifies the terminal that contains the PPS signal. |
||||
![]() |
use manual time specifies whether to use a user-supplied time or the OS system time to set the board time when the module receives the first pulse. After the first pulse sets the board time, every subsequent pulse is interpreted to be received one second later, and the VI adjusts the board time accordingly. Valid values:
|
||||
![]() |
error in (no error) describes error conditions that occur before this node runs. This input provides standard error in functionality. |
||||
![]() |
initial time specifies the value to set the board time to when the module receives the first pulse. Only use this terminal if you set the use manual time terminal to TRUE. |
||||
![]() |
instrument handle out returns the instrument handle that you obtain from niSync Initialize. |
||||
![]() |
error out returns error conditions that occur after this node runs. This output provides standard error out functionality. |
Use this instance to set the external time reference of the device to IRIG-B AM or IRIG-B DC. You must have an external IRIG source connected to the specified terminal for this instance to function.
![]() |
instrument handle specifies the instrument handle that you obtain from niSync Initialize. |
![]() |
IRIG type specifies the type of IRIG output generated by the external IRIG source. Valid values:
|
![]() |
terminal specifies the terminal that contains the signal generated by the external IRIG source. The module uses this signal as the external time reference. |
![]() |
error in (no error) describes error conditions that occur before this node runs. This input provides standard error in functionality. |
![]() |
instrument handle out returns the instrument handle that you obtain from niSync Initialize. |
![]() |
error out returns error conditions that occur after this node runs. This output provides standard error out functionality. |
Use this instance to set the external time reference of the device to GPS.
![]() |
instrument handle specifies the instrument handle that you obtain from niSync Initialize. |
![]() |
error in (no error) describes error conditions that occur before this node runs. This input provides standard error in functionality. |
![]() |
instrument handle out returns the instrument handle that you obtain from niSync Initialize. |
![]() |
error out returns error conditions that occur after this node runs. This output provides standard error out functionality. |
Sets the external time reference to the device to 802.1AS. If the device is not an 802.1AS slave and you set the time reference to 802.1AS, the board time enters free running mode.
Calling this VI does not explicitly start the 802.1AS protocol. You must invoke the niSync Start Time Reference after setting the time reference for the device to participate in 802.1AS.
![]() |
instrument handle specifies the instrument handle that you obtain from niSync Initialize. |
![]() |
error in (no error) describes error conditions that occur before this node runs. This input provides standard error in functionality. |
![]() |
instrument handle out returns the instrument handle that you obtain from niSync Initialize. |
![]() |
error out returns error conditions that occur after this node runs. This output provides standard error out functionality. |