NI-Sync C API Reference

Target Support for Timing Attributes and Functions

  • Updated2023-02-21
  • 3 minute(s) read

Many timing attributes and functions are supported only on certain targets. Refer to the tables below to determine whether or not a given attribute or function is supported on your chosen target.

Target Support for Timing Attributes

Property6683(H)
Windows
6683(H)
Linux RT and DT
cRIO, Vision
Industrial Controller
Linux RT
Ethernet cDAQ
Linux RT
Timing attributes
NISYNC_ATTR_TIMEREF_SELECTED_TYPEYesYesYesYes
NISYNC_ATTR_TIMEREF_SELECTED_NAMEYesYesYesYes
NISYNC_ATTR_TIMEREF_PRESENT Yes Yes No No
NISYNC_ATTR_TIMEREF_OFFSET_NS Yes Yes Yes Yes
NISYNC_ATTR_TIMEREF_OFFSET Yes Yes Yes Yes
NISYNC_ATTR_TIMEREF_CORRECTION Yes Yes No No
NISYNC_ATTR_TIMEREF_UTC_OFFSET Yes No No No
NISYNC_ATTR_TIMEREF_UTC_OFFSET_VALID Yes No No No
NISYNC_ATTR_1588_CLK_RESOLUTION Yes Yes No No
NISYNC_ATTR_TIMEREF_LAST_SYNC_ID Yes Yes Yes No
Timing:Time Reference
NISYNC_ATTR_TIMEREF_TYPE No Yes Yes Yes
NISYNC_ATTR_TIMEREF_ENABLED No Yes Yes Yes
NISYNC_ATTR_TIMEREF_IS_SELECTED No Yes Yes Yes
Timing:Time Reference:1588
NISYNC_ATTR_1588_BMCA_MODE No Yes Yes No
NISYNC_ATTR_1588_CLOCK_ACCURACY Yes Yes Yes Yes
NISYNC_ATTR_1588_CLOCK_CLASS Yes Yes Yes Yes
NISYNC_ATTR_1588_CLOCK_ID Yes Yes Yes Yes
NISYNC_ATTR_1588_CLOCK_STATE Yes Yes Yes No
NISYNC_ATTR_1588_FREQUENCY_TRACEABLE Yes* Yes* Yes* No
NISYNC_ATTR_1588_GRANDMASTER_CLOCK_ACCURACY Yes Yes Yes Yes
NISYNC_ATTR_1588_GRANDMASTER_CLOCK_CLASS Yes Yes Yes Yes
NISYNC_ATTR_1588_GRANDMASTER_CLOCK_ID Yes Yes Yes Yes
NISYNC_ATTR_1588_GRANDMASTER_IP_ADDRESS No Yes Yes No
NISYNC_ATTR_1588_GRANDMASTER_PRIORITY1 Yes Yes Yes Yes
NISYNC_ATTR_1588_GRANDMASTER_PRIORITY2 Yes Yes Yes Yes
NISYNC_ATTR_1588_INTERFACE_NAME No Yes Yes No
NISYNC_ATTR_1588_IP_ADDRESS Yes Yes No No
NISYNC_ATTR_1588_LEAP59 Yes* Yes* Yes* No
NISYNC_ATTR_1588_LEAP61 Yes* Yes* Yes* No
NISYNC_ATTR_1588_LOG_SYNC_INTERVAL Yes Yes Yes No
NISYNC_ATTR_1588_MEAN_PATH_DELAY Yes Yes Yes No
NISYNC_ATTR_1588_OFFSET_SCALED_LOG_VARIANCE Yes* Yes* Yes* No
NISYNC_ATTR_1588_PRIORITY1 Yes Yes Yes Yes
NISYNC_ATTR_1588_PRIORITY2 Yes Yes Yes Yes
NISYNC_ATTR_1588_STEPS_TO_GRANDMASTER Yes Yes Yes No
NISYNC_ATTR_1588_TIME_SOURCE Yes* Yes* Yes* No
NISYNC_ATTR_1588_TIME_TRACEABLE Yes* Yes* Yes* No
Timing:Time Reference:802.1AS
NISYNC_ATTR_8021AS_PORT_STATE No Yes Yes No
NISYNC_ATTR_8021AS_CLOCK_ID No Yes Yes Yes
NISYNC_ATTR_8021AS_CLOCK_CLASS No Yes Yes Yes
NISYNC_ATTR_8021AS_CLOCK_ACCURACY No Yes Yes Yes
NISYNC_ATTR_8021AS_PRIORITY1 No Yes Yes Yes
NISYNC_ATTR_8021AS_PRIORITY2 No Yes Yes Yes
NISYNC_ATTR_8021AS_GRANDMASTER_CLOCK_ID No Yes Yes Yes
NISYNC_ATTR_8021AS_GRANDMASTER_CLOCK_CLASS No Yes Yes Yes
NISYNC_ATTR_8021AS_GRANDMASTER_CLOCK_ACCURACY No Yes Yes Yes
NISYNC_ATTR_8021AS_GRANDMASTER_PRIORITY1 No Yes Yes Yes
NISYNC_ATTR_8021AS_GRANDMASTER_PRIORITY2 No Yes Yes Yes
NISYNC_ATTR_8021AS_LOG_SYNC_INTERVAL No Yes Yes No
NISYNC_ATTR_8021AS_LOG_ANNOUNCE_INTERVAL No Yes Yes No
NISYNC_ATTR_8021AS_INTERFACE_NAME No Yes Yes No
NISYNC_ATTR_8021AS_NEIGHBOR_PROP_DELAY_THRESH No Yes Yes No
NISYNC_ATTR_8021AS_AS_CAPABLE No Yes Yes No
Timing:Time Reference:GPS
NISYNC_ATTR_GPS_ANTENNA_CONNECTED Yes Yes No No
NISYNC_ATTR_GPS_MOBILE_MODE Yes Yes No No
NISYNC_ATTR_GPS_SELF_SURVEY Yes Yes No No
NISYNC_ATTR_GPS_RECALCULATE_POSITION Yes Yes No No
NISYNC_ATTR_GPS_SATELLITES_AVAILABLE Yes Yes No No
NISYNC_ATTR_GPS_STATUS Yes Yes No No
Timing:Time Stamps
NISYNC_ATTR_1588_AVAIL_TIMESTAMPS Yes Yes No No
NISYNC_ATTR_1588_TIMESTAMP_BUF_SIZE Yes Yes No No
* Support was added in NI-Sync 2022 Q4.

Target Support for Timing Functions

Function 6683(H)
Windows
6683(H)
Linux RT and DT*
cRIO, Ethernet cDAQ,
Industrial Controller
Linux RT
niSync_ClearClock Yes Yes No
niSync_ClearFutureTimeEvents Yes Yes No
niSync_CreateClock Yes Yes No
niSync_CreateFutureTimeEvent Yes Yes No
niSync_DisableTimeStampTrigger Yes Yes No
niSync_EnableTimeStampTrigger Yes Yes No
niSync_GetTime Yes Yes Yes
niSync_DisableGPSTimestamping Yes Yes No
niSync_DisableIRIGTimestamping Yes Yes No
niSync_EnableGPSTimestamping Yes Yes No
niSync_EnableIRIGTimestamping Yes Yes No
niSync_GetLocation Yes Yes No
niSync_GetVelocity Yes Yes No
niSync_ReadLastGPSTimestamp Yes Yes No
niSync_ReadLastIRIGTimestamp Yes Yes No
niSync_GetTimeReferences Yes Yes Yes
niSync_ResetFrequency Yes Yes No
niSync_SetTime Yes Yes No
niSync_SetTimeReference1588OrdinaryClock Yes Yes No
niSync_SetTimeReference8021AS No Yes No
niSync_SetTimeReferenceFreeRunning Yes Yes No
niSync_SetTimeReferenceGPS Yes Yes No
niSync_SetTimeReferenceIRIG Yes Yes No
niSync_SetTimeReferencePPS Yes Yes No
niSync_Start1588 Yes Yes No
niSync_Start8021AS No Yes No
niSync_Stop1588 Yes Yes No
niSync_Stop8021AS No Yes No
* Partial Linux RT support for 6683(H) modules was first added in NI-Sync 19.0, with full support completed in NI-Sync 21.3.
† Linux RT support for cRIO and Industrial Controller modules was first added in NI-Sync 18.0.
‡ Linux RT support for cDAQ was first added in NI-Sync 18.1.

Log in to get a better experience