NISYNC_ATTR_1588_CLOCK_STATE

Data
Type
Access Applies to Coercion High-Level Functions
ViInt32 RO N/A None None

Description

Returns the state of the 1588 clock. You can query this attribute 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.

Note Note  
  • For Linux RT devices, you must specify the time reference by passing the activeItem parameter when querying this attribute.
  • This property is supported only on certain targets; refer to Target Support for Timing Properties and Functions for more information.

Defined Values

ValueIntegerFinal?Description
NISYNC_VAL_1588_CLK_STATE_NOT_DEFINED-1N/AThe state of 1588 clock associated with this session is not defined.
NISYNC_VAL_1588_CLK_STATE_INIT0NoThe 1588 clock associated with this session is in the Initializing state.
NISYNC_VAL_1588_CLK_STATE_FAULT1YesThe 1588 clock associated with this session is in the Faulty state, which indicates that this clock is not participating in PTP due to a problem.
NISYNC_VAL_1588_CLK_STATE_DISABLE2YesThe 1588 clock associated with this session is in the Disabled state, which indicates that this clock is not participating in PTP since it has been disabled.
NISYNC_VAL_1588_CLK_STATE_LISTENING3NoThe 1588 clock associated with this session is in the Listening state, which indicates it is waiting to receive timestamps from the Master clock.
NISYNC_VAL_1588_CLK_STATE_PREMASTER4NoThe 1588 clock associated with this session is in the Pre-Master state.
NISYNC_VAL_1588_CLK_STATE_MASTER5YesThe 1588 clock associated with this session is in the Master state, which indicates that this clock has been selected as the master clock for its subdomain.
NISYNC_VAL_1588_CLK_STATE_PASSIVE6YesThe 1588 clock associated with this session is in the Passive state, which indicates that this clock will not generate any PTP-related communications.
NISYNC_VAL_1588_CLK_STATE_UNCALIBRATED7NoThe 1588 clock associated with this session is in the Uncalibrated state.
NISYNC_VAL_1588_CLK_STATE_SLAVE8YesThe 1588 clock associated with this session is in the Slave state, which indicates that this clock has been selected as a slave clock within its subdomain.