Netzwerkzeit-Synchronisierung

Dieses Modul enthält Funktionen zur Steuerung des Netzwerkzeitsynchronisierungsdiensts.

Zusammenfassung

Aufzählungen

otNetworkTimeStatus{
  OT_NETWORK_TIME_UNSYNCHRONIZED = -1,
  OT_NETWORK_TIME_RESYNC_NEEDED = 0,
  OT_NETWORK_TIME_SYNCHRONIZED = 1
}
enum
Stellt den OpenThread-Zeitsynchronisierungsstatus dar.

Typedefs

otNetworkTimeStatus typedef
Stellt den OpenThread-Zeitsynchronisierungsstatus dar.
otNetworkTimeSyncCallbackFn)(void *aCallbackContext) typedef
void(*
Der Zeiger wird bei einer Netzwerkzeitsynchronisierung oder einer Statusänderung aufgerufen.

Funktionen

otNetworkTimeGet(otInstance *aInstance, uint64_t *aNetworkTime)
Rufen Sie die Thread-Netzwerkzeit ab.
otNetworkTimeGetSyncPeriod(otInstance *aInstance)
uint16_t
Rufen Sie den Zeitraum für die zeitliche Synchronisierung ab.
otNetworkTimeGetXtalThreshold(otInstance *aInstance)
uint16_t
Rufen Sie den XTAL-Genauigkeitsgrenzwert für die Zeitsynchronisierung des Routers ab.
otNetworkTimeSetSyncPeriod(otInstance *aInstance, uint16_t aTimeSyncPeriod)
Legen Sie den Zeitraum für die Synchronisierung fest.
otNetworkTimeSetXtalThreshold(otInstance *aInstance, uint16_t aXTALThreshold)
Legen Sie den Grenzwert für die XTAL-Genauigkeit der Zeitsynchronisierung für ein Router-fähiges Gerät fest.
otNetworkTimeSyncSetCallback(otInstance *aInstance, otNetworkTimeSyncCallbackFn aCallbackFn, void *aCallbackContext)
void
Legen Sie einen Callback fest, der aufgerufen werden soll, wenn eine Netzwerkzeitsynchronisierung oder eine Statusänderung erfolgt.

Aufzählungen

otNetworkTimeStatus

 otNetworkTimeStatus

Stellt den OpenThread-Zeitsynchronisierungsstatus dar.

Attribute
OT_NETWORK_TIME_RESYNC_NEEDED

Das Gerät hat mehr als zwei Zeiträume lang keine Zeitsynchronisierung erhalten.

OT_NETWORK_TIME_SYNCHRONIZED

Die Netzwerkzeit des Geräts wird synchronisiert.

OT_NETWORK_TIME_UNSYNCHRONIZED

Das Gerät ist mit keinem Netzwerk verbunden.

Typedefs

otNetworkTimeStatus

enum otNetworkTimeStatus otNetworkTimeStatus

Stellt den OpenThread-Zeitsynchronisierungsstatus dar.

otNetworkTimeSyncCallbackFn

void(* otNetworkTimeSyncCallbackFn)(void *aCallbackContext)

Der Zeiger wird bei einer Netzwerkzeitsynchronisierung oder einer Statusänderung aufgerufen.

Funktionen

otNetworkTimeGet

otNetworkTimeStatus otNetworkTimeGet(
  otInstance *aInstance,
  uint64_t *aNetworkTime
)

Rufen Sie die Thread-Netzwerkzeit ab.

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

otNetworkTimeGetSyncPeriod

uint16_t otNetworkTimeGetSyncPeriod(
  otInstance *aInstance
)

Rufen Sie den Zeitraum für die zeitliche Synchronisierung ab.

Details
Parameter
[in] aInstance
Die OpenThread-Instanzstruktur.
Rückgabe
Der Zeitraum der zeitlichen Synchronisierung.

otNetworkTimeGetXtalThreshold

uint16_t otNetworkTimeGetXtalThreshold(
  otInstance *aInstance
)

Rufen Sie den XTAL-Genauigkeitsgrenzwert für die Zeitsynchronisierung des Routers ab.

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

otNetworkTimeSetSyncPeriod

otError otNetworkTimeSetSyncPeriod(
  otInstance *aInstance,
  uint16_t aTimeSyncPeriod
)

Legen Sie den Zeitraum für die Synchronisierung fest.

Kann nur aufgerufen werden, während Thread-Protokolle deaktiviert sind.

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

otNetworkTimeSetXtalThreshold

otError otNetworkTimeSetXtalThreshold(
  otInstance *aInstance,
  uint16_t aXTALThreshold
)

Legen Sie den Grenzwert für die XTAL-Genauigkeit der Zeitsynchronisierung für ein Router-fähiges Gerät fest.

Kann nur aufgerufen werden, während Thread-Protokolle deaktiviert sind.

Details
Parameter
[in] aInstance
Die OpenThread-Instanzstruktur.
[in] aXTALThreshold
Der Grenzwert für die XTAL-Genauigkeit für Router in PPM.
Rückgabewerte
OT_ERROR_NONE
Der Zeitraum für die zeitliche Synchronisierung 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 aufgerufen werden soll, wenn eine Netzwerkzeitsynchronisierung oder eine Statusänderung erfolgt.

Dieser Callback darf nur aufgerufen werden, wenn der Netzwerkzeitversatz um OPENTHREAD_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 werden soll

Makros

OT_TIME_SYNC_INVALID_SEQ

 OT_TIME_SYNC_INVALID_SEQ 0

Null gilt als ungültige Zeitsynchronisierungssequenz.

Ressourcen

OpenThread API-Referenzthemen stammen aus dem Quellcode, der auf GitHub verfügbar ist. Weitere Informationen finden Sie unter Ressourcen. Dort können Sie auch einen Beitrag zu unserer Dokumentation leisten.