niSync Set Time Reference (VI)

Installed With: NI-Sync

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  
  • The servo may apply a macro phase adjustment when your device's board time and the external time reference varies by more than 1 ms. A macro phase adjustment adjusts the external time reference by a significant amount, and the time no long atomically increments. This should not occur on a well-designed and stable network. A macro phase adjustment may affect future time events, clocks, and timestamps. If the external time reference is set forward, future time events and clock transitions that were missed occur immediately. If the external time reference is set backward, future time events and clock transitions are delayed.
  • NI-Sync devices use the TAI timescale.
  • This function is supported only on certain targets; refer to Target Support for Timing Properties and VIs for more information.
Note  

Use the pull-down menu to select an instance of this VI.

niSync Set Time Reference (1588 Ordinary Clock)

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).

niSync Set Time Reference (1588 Ordinary Clock)

cio.gif

instrument handle specifies the instrument handle that you obtain from niSync Initialize.

cerrcodeclst.gif

error in (no error) describes error conditions that occur before this node runs. This input provides standard error in functionality.

iio.gif

instrument handle out returns the instrument handle that you obtain from niSync Initialize.

ierrcodeclst.gif

error out returns error conditions that occur after this node runs. This output provides standard error out functionality.

niSync Set Time Reference (Free Running)

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.

niSync Set Time Reference (Free Running)

cio.gif

instrument handle specifies the instrument handle that you obtain from niSync Initialize.

cerrcodeclst.gif

error in (no error) describes error conditions that occur before this node runs. This input provides standard error in functionality.

iio.gif

instrument handle out returns the instrument handle that you obtain from niSync Initialize.

ierrcodeclst.gif

error out returns error conditions that occur after this node runs. This output provides standard error out functionality.

niSync Set Time Reference (PPS)

Use this instance to set the external time reference of the device to PPS (pulse per second).

niSync Set Time Reference (PPS)

cio.gif

instrument handle specifies the instrument handle that you obtain from niSync Initialize.

cio.gif

terminal specifies the terminal that contains the PPS signal.

cbool.gif

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:

FALSE Reads the OS system time when the module receives the first pulse. This time is used to set the board time.
TRUE Reads the value you enter in the initial time terminal when the module receives the first pulse. This time is used to set the board time.
cerrcodeclst.gif

error in (no error) describes error conditions that occur before this node runs. This input provides standard error in functionality.

ctimestamp.gif

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.

iio.gif

instrument handle out returns the instrument handle that you obtain from niSync Initialize.

ierrcodeclst.gif

error out returns error conditions that occur after this node runs. This output provides standard error out functionality.

niSync Set Time Reference (IRIG)

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.

niSync Set Time Reference (IRIG)

cio.gif

instrument handle specifies the instrument handle that you obtain from niSync Initialize.

cenum.gif

IRIG type specifies the type of IRIG output generated by the external IRIG source.

Valid values:

  • IRIGB AM
  • IRIGB DC
cio.gif

terminal specifies the terminal that contains the signal generated by the external IRIG source. The module uses this signal as the external time reference.

cerrcodeclst.gif

error in (no error) describes error conditions that occur before this node runs. This input provides standard error in functionality.

iio.gif

instrument handle out returns the instrument handle that you obtain from niSync Initialize.

ierrcodeclst.gif

error out returns error conditions that occur after this node runs. This output provides standard error out functionality.

niSync Set Time Reference (GPS)

Use this instance to set the external time reference of the device to GPS.

niSync Set Time Reference (GPS)

cio.gif

instrument handle specifies the instrument handle that you obtain from niSync Initialize.

cerrcodeclst.gif

error in (no error) describes error conditions that occur before this node runs. This input provides standard error in functionality.

iio.gif

instrument handle out returns the instrument handle that you obtain from niSync Initialize.

ierrcodeclst.gif

error out returns error conditions that occur after this node runs. This output provides standard error out functionality.

niSync Start Time Reference (802.1AS)

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.

niSync Start Time Reference (802.1AS)

cio.gif

instrument handle specifies the instrument handle that you obtain from niSync Initialize.

cerrcodeclst.gif

error in (no error) describes error conditions that occur before this node runs. This input provides standard error in functionality.

iio.gif

instrument handle out returns the instrument handle that you obtain from niSync Initialize.

ierrcodeclst.gif

error out returns error conditions that occur after this node runs. This output provides standard error out functionality.