Time Sync Service

This module includes configuration variables for the Time Sync service.

Summary

Macros
OPENTHREAD_CONFIG_TIME_SYNC_ENABLE 0	Define as 1 to enable the time synchronization service feature.
OPENTHREAD_CONFIG_TIME_SYNC_JUMP_NOTIF_MIN_US 10000	This setting sets the minimum amount of time (in microseconds) that the network time must jump due to a time sync event for listeners to be notified of the new network time.
OPENTHREAD_CONFIG_TIME_SYNC_PERIOD 30	Specifies the default period of time synchronization, in seconds.
OPENTHREAD_CONFIG_TIME_SYNC_REQUIRED 0	Define as 1 to require time synchronization when attaching to a network.
OPENTHREAD_CONFIG_TIME_SYNC_XTAL_THRESHOLD 300	Specifies the default XTAL threshold for a device to become Router in time synchronization enabled network, in PPM.

Macros

OPENTHREAD_CONFIG_TIME_SYNC_ENABLE

 OPENTHREAD_CONFIG_TIME_SYNC_ENABLE 0

Define as 1 to enable the time synchronization service feature.

OPENTHREAD_CONFIG_TIME_SYNC_JUMP_NOTIF_MIN_US

 OPENTHREAD_CONFIG_TIME_SYNC_JUMP_NOTIF_MIN_US 10000

This setting sets the minimum amount of time (in microseconds) that the network time must jump due to a time sync event for listeners to be notified of the new network time.

OPENTHREAD_CONFIG_TIME_SYNC_PERIOD

 OPENTHREAD_CONFIG_TIME_SYNC_PERIOD 30

Specifies the default period of time synchronization, in seconds.

Applicable only if time synchronization service feature is enabled (i.e., OPENTHREAD_CONFIG_TIME_SYNC_ENABLE is set).

OPENTHREAD_CONFIG_TIME_SYNC_REQUIRED

 OPENTHREAD_CONFIG_TIME_SYNC_REQUIRED 0

Define as 1 to require time synchronization when attaching to a network.

If the device is router capable and cannot find a neighboring router supporting time synchronization, the device will form a new partition. If the device is not router capable, the device will remain an orphan.

Applicable only if time synchronization service feature is enabled (i.e., OPENTHREAD_CONFIG_TIME_SYNC_ENABLE is set)

OPENTHREAD_CONFIG_TIME_SYNC_XTAL_THRESHOLD

 OPENTHREAD_CONFIG_TIME_SYNC_XTAL_THRESHOLD 300

Specifies the default XTAL threshold for a device to become Router in time synchronization enabled network, in PPM.

Applicable only if time synchronization service feature is enabled (i.e., OPENTHREAD_CONFIG_TIME_SYNC_ENABLE is set)

Resources

OpenThread API Reference topics originate from the source code, available on GitHub. For more information, or to contribute to our documentation, refer to Resources.