niSync_Start1588

C Function Prototype

ViStatus _VI_FUNC niSync_Start1588 (ViSession vi);

Purpose

Begins participation in the IEEE 1588-2008 time synchronization protocol.

To synchronize clocks, future time events, and triggered timestamps to 1588 time, use this function in conjunction with niSync_SetTimeReference1588OrdinaryClock. Use niSync_Stop1588 to stop participation in a 1588 session. Alternately, you can start and stop 1588 participation in the Test Panels window of Measurement & Automation Explorer (MAX).

Note   This function returns as soon as participation begins and does not wait until the 1588 clock has reached a steady state. You do not need to invoke this function in the same session as these other operations. You can invoke it in a separate session associated with the same device. If the clock participating in 1588 enters the faulty state, and 1588 is the selected time reference, then future time events, clocks, and timestamps are no longer synchronized with other 1588 devices participating in PTP. This should not occur on a well designed and stable network. You can check for this condition by monitoring the NISYNC_ATTR_1588_CLOCK_STATE attribute. This attribute is supported only on certain targets. Refer to Target Support for Timing Attributes and Functions to determine whether or not this attribute is supported on your target.

Parameters

Return Values