Netzwerkzeitsynchronisierung

Dieses Modul enthält Funktionen, die den Synchronisierungsdienst für die Netzwerkzeit steuern.

Fazit

Aufzählungen

otNetworkTimeStatus{
  OT_NETWORK_TIME_UNSYNCHRONIZED = -1,
  OT_NETWORK_TIME_RESYNC_NEEDED = 0,
  OT_NETWORK_TIME_SYNCHRONIZED = 1
}
enum
Diese Aufzählung steht für den Synchronisierungsstatus der OpenThread-Zeit.

Typdef.

otNetworkTimeStatus Typdef
Diese Aufzählung steht für den Synchronisierungsstatus der OpenThread-Zeit.
otNetworkTimeSyncCallbackFn)(void *aCallbackContext) Typdef
void(*
Dieser Funktionszeiger wird bei einer Netzwerkzeit-Synchronisierung oder einer Statusänderung aufgerufen.

Funktionen

otNetworkTimeGet(otInstance *aInstance, uint64_t *aNetworkTime)
Thread-Netzwerkzeit abrufen.
otNetworkTimeGetSyncPeriod(otInstance *aInstance)
uint16_t
Den Synchronisierungszeitraum abrufen
otNetworkTimeGetXtalThreshold(otInstance *aInstance)
uint16_t
XTAL-Genauigkeitsgrenzwert für die Zeitsynchronisierung für den Router abrufen.
otNetworkTimeSetSyncPeriod(otInstance *aInstance, uint16_t aTimeSyncPeriod)
Legen Sie den Zeitraum für die Synchronisierung fest.
otNetworkTimeSetXtalThreshold(otInstance *aInstance, uint16_t aXTALThreshold)
Legen Sie den XTAL-Genauigkeitsgrenzwert für die Routersynchronisierung fest.
otNetworkTimeSyncSetCallback(otInstance *aInstance, otNetworkTimeSyncCallbackFn aCallbackFn, void *aCallbackContext)
void
Legen Sie einen Callback fest, der bei einer Netzwerkzeitsynchronisierung oder einer Statusänderung aufgerufen wird.

Aufzählungen

otNetworkTimeStatus

 otNetworkTimeStatus

Diese Aufzählung steht für den Synchronisierungsstatus der OpenThread-Zeit.

Attribute
OT_NETWORK_TIME_RESYNC_NEEDED

Das Gerät hat seit mehr als zwei Zeiträumen keine Uhrzeit synchronisiert.

OT_NETWORK_TIME_SYNCHRONIZED

Die Netzwerkzeit des Geräts wird synchronisiert.

OT_NETWORK_TIME_UNSYNCHRONIZED

Das Gerät ist nicht mit einem Netzwerk verbunden.

Typdef.

otNetworkTimeStatus

enum otNetworkTimeStatus otNetworkTimeStatus

Diese Aufzählung steht für den Synchronisierungsstatus der OpenThread-Zeit.

otNetworkTimeSyncCallbackFn

void(* otNetworkTimeSyncCallbackFn)(void *aCallbackContext)

Dieser Funktionszeiger wird bei einer Netzwerkzeit-Synchronisierung oder einer Statusänderung aufgerufen.

Funktionen

otNetworkTimeGet

otNetworkTimeStatus otNetworkTimeGet(
  otInstance *aInstance,
  uint64_t *aNetworkTime
)

Thread-Netzwerkzeit abrufen.

Details
Parameter
[in] aInstance
Die OpenThread-Instanzstruktur.
[in,out] aNetworkTime
Die Thread-Netzwerkzeit in Mikrosekunden
Rückgabe
Der Zeitsynchronisierungsstatus.

otNetworkTimeGetSyncPeriod

uint16_t otNetworkTimeGetSyncPeriod(
  otInstance *aInstance
)

Den Synchronisierungszeitraum abrufen

Details
Parameter
[in] aInstance
Die OpenThread-Instanzstruktur.
Rückgabe
Der Synchronisierungszeitraum.

otNetworkTimeGetXtalThreshold

uint16_t otNetworkTimeGetXtalThreshold(
  otInstance *aInstance
)

XTAL-Genauigkeitsgrenzwert für die Zeitsynchronisierung für den Router abrufen.

Details
Parameter
[in] aInstance
Die OpenThread-Instanzstruktur.
Rückgabe
Der XTAL-Schwellenwert für die Genauigkeit für Router in PPM.

otNetworkTimeSetSyncPeriod

otError otNetworkTimeSetSyncPeriod(
  otInstance *aInstance,
  uint16_t aTimeSyncPeriod
)

Legen Sie den Zeitraum für die Synchronisierung fest.

Diese Funktion kann nur aufgerufen werden, wenn Thread-Protokolle deaktiviert sind.

Details
Parameter
[in] aInstance
Die OpenThread-Instanzstruktur.
[in] aTimeSyncPeriod
Der Synchronisierungszeitraum in Sekunden.
Rückgabewerte
OT_ERROR_NONE
Synchronisierungszeitraum wurde festgelegt.
OT_ERROR_INVALID_STATE
Thread-Protokolle sind aktiviert.

otNetworkTimeSetXtalThreshold

otError otNetworkTimeSetXtalThreshold(
  otInstance *aInstance,
  uint16_t aXTALThreshold
)

Legen Sie den XTAL-Genauigkeitsgrenzwert für die Routersynchronisierung fest.

Diese Funktion kann nur aufgerufen werden, wenn Thread-Protokolle deaktiviert sind.

Details
Parameter
[in] aInstance
Die OpenThread-Instanzstruktur.
[in] aXTALThreshold
Der XTAL-Schwellenwert für die Genauigkeit für Router in PPM.
Rückgabewerte
OT_ERROR_NONE
Synchronisierungszeitraum wurde festgelegt.
OT_ERROR_INVALID_STATE
Thread-Protokolle sind aktiviert.

otNetworkTimeSyncSetCallback

void otNetworkTimeSyncSetCallback(
  otInstance *aInstance,
  otNetworkTimeSyncCallbackFn aCallbackFn,
  void *aCallbackContext
)

Legen Sie einen Callback fest, der bei einer Netzwerkzeitsynchronisierung oder einer Statusänderung aufgerufen wird.

Dieser Callback wird nur aufgerufen, wenn die Zeitverschiebung für das Netzwerk um OPENFORMATTED_CONFIG_TIME_SYNC_JUMP_NOTIF_MIN_US springt oder wenn sich der Status ändert.

Details
Parameter
[in] aInstance
Die OpenThread-Instanzstruktur.
[in] aCallbackFn
Die Callback-Funktion, die aufgerufen werden soll
[in] aCallbackContext
Der Kontext, der beim Aufruf an die Callback-Funktion übergeben wird

Makros

OT_TIME_SYNC_INVALID_SEQ

 OT_TIME_SYNC_INVALID_SEQ 0

null gilt als ungültige Synchronisierungssequenz.

Ressourcen

Die Themen der Referenzthread API basieren auf dem Quellcode, der auf GitHub verfügbar ist. Weitere Informationen sowie die Möglichkeit, in unserer Dokumentation mitzuwirken, finden Sie unter Ressourcen.