Synchronisation de l'heure du réseau

Ce module comprend des fonctions qui contrôlent le service de synchronisation de l'heure du réseau.

Résumé

Énumérations
`otNetworkTimeStatus { OT_NETWORK_TIME_UNSYNCHRONIZED = -1, OT_NETWORK_TIME_RESYNC_NEEDED = 0, OT_NETWORK_TIME_SYNCHRONIZED = 1 }`	énumération Cette énumération représente l'état de la synchronisation de l'heure OpenThread.

Typedefs
`otNetworkTimeStatus`	typedef `enum otNetworkTimeStatus` Cette énumération représente l'état de la synchronisation de l'heure OpenThread.
`otNetworkTimeSyncCallbackFn )(void *aCallbackContext)`	typedef `void(*` Ce pointeur de fonction est appelé lorsqu'une synchronisation de l'heure du réseau ou un changement d'état se produit.

Les fonctions
`otNetworkTimeGet ( otInstance aInstance, uint64_t aNetworkTime)`	`otNetworkTimeStatus` Obtenez l'heure du réseau Thread.
`otNetworkTimeGetSyncPeriod ( otInstance *aInstance)`	`uint16_t` Obtenez la période de synchronisation de l'heure.
`otNetworkTimeGetXtalThreshold ( otInstance *aInstance)`	`uint16_t` Obtenez le seuil de précision XTAL de synchronisation de l'heure pour le routeur.
`otNetworkTimeSetSyncPeriod ( otInstance *aInstance, uint16_t aTimeSyncPeriod)`	`otError` Définissez la période de synchronisation de l'heure.
`otNetworkTimeSetXtalThreshold ( otInstance *aInstance, uint16_t aXTALThreshold)`	`otError` Définissez le seuil de précision XTAL de synchronisation de l'heure pour le périphérique compatible avec un routeur.
`otNetworkTimeSyncSetCallback ( otInstance aInstance, otNetworkTimeSyncCallbackFn aCallbackFn, void aCallbackContext)`	`void` Définissez un rappel à appeler lorsqu'une synchronisation de l'heure du réseau ou un changement d'état se produit.

Énumérations

otNetworkTimeStatus

 otNetworkTimeStatus

Cette énumération représente l'état de la synchronisation de l'heure OpenThread.

Propriétés
`OT_NETWORK_TIME_RESYNC_NEEDED`	L'appareil n'a pas reçu de synchronisation de l'heure depuis plus de deux périodes.
`OT_NETWORK_TIME_SYNCHRONIZED`	L'heure réseau de l'appareil est synchronisée.
`OT_NETWORK_TIME_UNSYNCHRONIZED`	L'appareil n'est pas connecté à un réseau.

Typedefs

otNetworkTimeStatus

enum otNetworkTimeStatus otNetworkTimeStatus

Cette énumération représente l'état de la synchronisation de l'heure OpenThread.

otNetworkTimeSyncCallbackFn

void(* otNetworkTimeSyncCallbackFn)(void *aCallbackContext)

Ce pointeur de fonction est appelé lorsqu'une synchronisation de l'heure du réseau ou un changement d'état se produit.

Les fonctions

otNetworkTimeGet

 otNetworkTimeStatus otNetworkTimeGet(
  otInstance *aInstance,
  uint64_t *aNetworkTime
)

Obtenez l'heure du réseau Thread.

Détails

Paramètres

`[in] aInstance`	La structure de l'instance OpenThread.
`[in,out] aNetworkTime`	L'heure du réseau Thread en microsecondes.

Retour

L'état de la synchronisation de l'heure.

otNetworkTimeGetSyncPeriod

uint16_t otNetworkTimeGetSyncPeriod(
  otInstance *aInstance
)

Obtenez la période de synchronisation de l'heure.

Détails

Paramètres

[in] aInstance

La structure de l'instance OpenThread.

Retour

La période de synchronisation de l'heure.

otNetworkTimeGetXtalThreshold

uint16_t otNetworkTimeGetXtalThreshold(
  otInstance *aInstance
)

Obtenez le seuil de précision XTAL de synchronisation de l'heure pour le routeur.

Détails

Paramètres

[in] aInstance

La structure de l'instance OpenThread.

Retour

Le seuil de précision XTAL pour le routeur, en PPM.

otNetworkTimeSetSyncPeriod

 otError otNetworkTimeSetSyncPeriod(
  otInstance *aInstance,
  uint16_t aTimeSyncPeriod
)

Définissez la période de synchronisation de l'heure.

Cette fonction ne peut être appelée que lorsque les protocoles Thread sont désactivés.

Détails

Paramètres

`[in] aInstance`	La structure de l'instance OpenThread.
`[in] aTimeSyncPeriod`	La période de synchronisation de l'heure, en secondes.

Valeurs de retour

`OT_ERROR_NONE`	Définissez avec succès la période de synchronisation de l'heure.
`OT_ERROR_INVALID_STATE`	Les protocoles de thread sont activés.

otNetworkTimeSetXtalThreshold

 otError otNetworkTimeSetXtalThreshold(
  otInstance *aInstance,
  uint16_t aXTALThreshold
)

Définissez le seuil de précision XTAL de synchronisation de l'heure pour le périphérique compatible avec un routeur.

Cette fonction ne peut être appelée que lorsque les protocoles Thread sont désactivés.

Détails

Paramètres

`[in] aInstance`	La structure de l'instance OpenThread.
`[in] aXTALThreshold`	Le seuil de précision XTAL pour le routeur, en PPM.

Valeurs de retour

`OT_ERROR_NONE`	Définissez avec succès la période de synchronisation de l'heure.
`OT_ERROR_INVALID_STATE`	Les protocoles de thread sont activés.

otNetworkTimeSyncSetCallback

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

Définissez un rappel à appeler lorsqu'une synchronisation de l'heure du réseau ou un changement d'état se produit.

Ce rappel ne doit être appelé que lorsque le décalage horaire du réseau saute de OPENTHREAD_CONFIG_TIME_SYNC_JUMP_NOTIF_MIN_US ou lorsque l'état change.

Détails

Paramètres

`[in] aInstance`	La structure de l'instance OpenThread.
`[in] aCallbackFn`	La fonction de rappel à appeler
`[in] aCallbackContext`	Le contexte à passer à la fonction de rappel lors de l'appel

Macros

OT_TIME_SYNC_INVALID_SEQ

 OT_TIME_SYNC_INVALID_SEQ 0

zéro est considéré comme une séquence de synchronisation d'horloge non valide.