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
}
enum
Cette énumération représente l'état de synchronisation temporelle OpenThread.

Définitions

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

Functions

otNetworkTimeGet(otInstance *aInstance, uint64_t *aNetworkTime)
Obtenez la durée du réseau Thread.
otNetworkTimeGetSyncPeriod(otInstance *aInstance)
uint16_t
Obtenez la période de synchronisation des données.
otNetworkTimeGetXtalThreshold(otInstance *aInstance)
uint16_t
Obtenez le seuil de précision XTAL de synchronisation pour le routeur.
otNetworkTimeSetSyncPeriod(otInstance *aInstance, uint16_t aTimeSyncPeriod)
Définissez la période de synchronisation.
otNetworkTimeSetXtalThreshold(otInstance *aInstance, uint16_t aXTALThreshold)
Définissez le seuil de précision XTAL de synchronisation 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 modification de l'état.

Énumérations

OTNetworkTimeStatus

 otNetworkTimeStatus

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

Properties
OT_NETWORK_TIME_RESYNC_NEEDED

L'appareil n'a pas reçu de synchronisation de temps 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.

Définitions

OTNetworkTimeStatus

enum otNetworkTimeStatus otNetworkTimeStatus

Cette énumération représente l'état de synchronisation temporelle 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.

Functions

OTNetworkTimeGet

otNetworkTimeStatus otNetworkTimeGet(
  otInstance *aInstance,
  uint64_t *aNetworkTime
)

Obtenez la durée 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 temporelle.

OTNetworkTimeGetSyncPeriod

uint16_t otNetworkTimeGetSyncPeriod(
  otInstance *aInstance
)

Obtenez la période de synchronisation des données.

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

otNetworkTimeGetXtalThreshold

uint16_t otNetworkTimeGetXtalThreshold(
  otInstance *aInstance
)

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

Détails
Paramètres
[in] aInstance
Structure de l'instance OpenThread.
Renvoie
Seuil de précision XTAL du routeur, en PPM.

otNetworkTimeSetSyncPeriod

otError otNetworkTimeSetSyncPeriod(
  otInstance *aInstance,
  uint16_t aTimeSyncPeriod
)

Définissez la période de synchronisation.

Cette fonction ne peut être appelée 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 de l'heure, en secondes.
Valeurs renvoyées
OT_ERROR_NONE
La période de synchronisation a bien été définie.
OT_ERROR_INVALID_STATE
Les protocoles Thread sont activés.

otNetworkTimeSetXtalThreshold

otError otNetworkTimeSetXtalThreshold(
  otInstance *aInstance,
  uint16_t aXTALThreshold
)

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

Cette fonction ne peut être appelée 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 du routeur, en PPM.
Valeurs renvoyées
OT_ERROR_NONE
La période de synchronisation 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 modification de l'état.

Ce rappel n'est appelé que lorsque le décalage horaire du réseau saute par OPENSELECTED_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

La valeur zéro est considérée comme une séquence de synchronisation temporelle non valide.

Resources

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