Synchronisation de l'heure du réseau

Ce module inclut des fonctions de contrôle du 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
} 		enum
Représente l'état de la synchronisation temporelle OpenThread.

Typedefs
otNetworkTimeStatus typedef
Représente l'état de la synchronisation temporelle OpenThread.
otNetworkTimeSyncCallbackFn)(void *aCallbackContext) typedef
void(*
Le pointeur est appelé en cas de synchronisation de l'heure du réseau ou de changement d'état.

distantes
otNetworkTimeGet(otInstance *aInstance, uint64_t *aNetworkTime)
Obtenez l'heure du réseau Thread.
otNetworkTimeGetSyncPeriod(otInstance *aInstance)
uint16_t
Permet d'obtenir la période de synchronisation temporelle.
otNetworkTimeGetXtalThreshold(otInstance *aInstance)
uint16_t
Permet d'obtenir le seuil de précision XTAL de la synchronisation de l'heure pour le routeur.
otNetworkTimeSetSyncPeriod(otInstance *aInstance, uint16_t aTimeSyncPeriod)
Définissez la période de synchronisation temporelle.
otNetworkTimeSetXtalThreshold(otInstance *aInstance, uint16_t aXTALThreshold)
Définit le seuil de précision XTAL de la synchronisation de l'heure pour l'appareil compatible avec le routeur.
otNetworkTimeSyncSetCallback(otInstance *aInstance, otNetworkTimeSyncCallbackFn aCallbackFn, void *aCallbackContext)
void
Définissez un rappel à appeler en cas de synchronisation de l'heure du réseau ou de changement d'état.

Énumérations

otNetworkTimeStatus

 otNetworkTimeStatus

Représente l'état de la synchronisation temporelle OpenThread.

Propriétés
OT_NETWORK_TIME_RESYNC_NEEDED

L’appareil n’a pas reçu de synchronisation temporelle depuis plus de deux périodes.

OT_NETWORK_TIME_SYNCHRONIZED

L'heure du réseau de l'appareil est synchronisée.

OT_NETWORK_TIME_UNSYNCHRONIZED

L'appareil n'est connecté à aucun réseau.

Typedefs

otNetworkTimeStatus

enum otNetworkTimeStatus otNetworkTimeStatus

Représente l'état de la synchronisation temporelle OpenThread.

otNetworkTimeSyncCallbackFn

void(* otNetworkTimeSyncCallbackFn)(void *aCallbackContext)

Le pointeur est appelé en cas de synchronisation de l'heure du réseau ou de changement d'état.

distantes

otNetworkTimeGet

otNetworkTimeStatus otNetworkTimeGet(
  otInstance *aInstance,
  uint64_t *aNetworkTime
)

Obtenez l'heure du réseau Thread.

Détails
Paramètres
[in] aInstance
Structure de l'instance OpenThread.
[in,out] aNetworkTime
Durée du réseau Thread en microsecondes.
Renvoie
État de la synchronisation de l'heure.

otNetworkTimeGetSyncPeriod

uint16_t otNetworkTimeGetSyncPeriod(
  otInstance *aInstance
)

Permet d'obtenir la période de synchronisation temporelle.

Détails
Paramètres
[in] aInstance
Structure de l'instance OpenThread.
Renvoie
Période de synchronisation temporelle

otNetworkTimeGetXtalThreshold

uint16_t otNetworkTimeGetXtalThreshold(
  otInstance *aInstance
)

Permet d'obtenir le seuil de précision XTAL de la synchronisation de l'heure pour le routeur.

Détails
Paramètres
[in] aInstance
Structure de l'instance OpenThread.
Renvoie
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 temporelle.

Ne peut être appelé que lorsque les protocoles Thread sont désactivés.

Détails
Paramètres
[in] aInstance
Structure de l'instance OpenThread.
[in] aTimeSyncPeriod
Période de synchronisation temporelle, en secondes.
Valeurs de retour
OT_ERROR_NONE
La période de synchronisation temporelle a bien été définie.
OT_ERROR_INVALID_STATE
Les protocoles Thread sont activés.

otNetworkTimeSetXtalThreshold

otError otNetworkTimeSetXtalThreshold(
  otInstance *aInstance,
  uint16_t aXTALThreshold
)

Définit le seuil de précision XTAL de la synchronisation de l'heure pour l'appareil compatible avec le routeur.

Ne peut être appelé que lorsque les protocoles Thread sont désactivés.

Détails
Paramètres
[in] aInstance
Structure de l'instance OpenThread.
[in] aXTALThreshold
Seuil de précision XTAL pour le routeur, en PPM.
Valeurs de retour
OT_ERROR_NONE
La période de synchronisation temporelle a bien été définie.
OT_ERROR_INVALID_STATE
Les protocoles Thread sont activés.

otNetworkTimeSyncSetCallback

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

Définissez un rappel à appeler en cas de synchronisation de l'heure du réseau ou de changement d'état.

Ce rappel n'est appelé que lorsque le décalage horaire du réseau dépasse de OPENTHREAD_CONFIG_TIME_SYNC_JUMP_NOTIF_MIN_US ou lorsque l'état change.

Détails
Paramètres
[in] aInstance
Structure de l'instance OpenThread.
[in] aCallbackFn
Fonction de rappel à appeler
[in] aCallbackContext
Contexte à transmettre à 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 temporelle non valide.

Ressources

Les sujets de référence de l'API OpenThread proviennent du code source, disponible sur GitHub. Pour en savoir plus ou pour contribuer à notre documentation, consultez la section Ressources.