Exemple

Ce module comprend les fonctions qui contrôlent l'instance OpenThread.

Résumé

énumérations
anonymous enum { OT_CHANGED_IP6_ADDRESS_ADDED = 1 << 0, OT_CHANGED_IP6_ADDRESS_REMOVED = 1 << 1, OT_CHANGED_THREAD_ROLE = 1 << 2, OT_CHANGED_THREAD_LL_ADDR = 1 << 3, OT_CHANGED_THREAD_ML_ADDR = 1 << 4, OT_CHANGED_THREAD_RLOC_ADDED = 1 << 5, OT_CHANGED_THREAD_RLOC_REMOVED = 1 << 6, OT_CHANGED_THREAD_PARTITION_ID = 1 << 7, OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER = 1 << 8, OT_CHANGED_THREAD_NETDATA = 1 << 9, OT_CHANGED_THREAD_CHILD_ADDED = 1 << 10, OT_CHANGED_THREAD_CHILD_REMOVED = 1 << 11, OT_CHANGED_IP6_MULTICAST_SUBSCRIBED = 1 << 12, OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED = 1 << 13, OT_CHANGED_THREAD_CHANNEL = 1 << 14, OT_CHANGED_THREAD_PANID = 1 << 15, OT_CHANGED_THREAD_NETWORK_NAME = 1 << 16, OT_CHANGED_THREAD_EXT_PANID = 1 << 17, OT_CHANGED_MASTER_KEY = 1 << 18, OT_CHANGED_PSKC = 1 << 19, OT_CHANGED_SECURITY_POLICY = 1 << 20, OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL = 1 << 21, OT_CHANGED_SUPPORTED_CHANNEL_MASK = 1 << 22, OT_CHANGED_COMMISSIONER_STATE = 1 << 23, OT_CHANGED_THREAD_NETIF_STATE = 1 << 24, OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE = 1 << 25, OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL = 1 << 26, OT_CHANGED_JOINER_STATE = 1 << 27 }	ENUM Cette énumération définit des drapeaux qui sont passés dans le cadre de `otStateChangedCallback` .

énumérations

anonymous enum { 
 OT_CHANGED_IP6_ADDRESS_ADDED = 1 << 0, 
 OT_CHANGED_IP6_ADDRESS_REMOVED = 1 << 1, 
 OT_CHANGED_THREAD_ROLE = 1 << 2, 
 OT_CHANGED_THREAD_LL_ADDR = 1 << 3, 
 OT_CHANGED_THREAD_ML_ADDR = 1 << 4, 
 OT_CHANGED_THREAD_RLOC_ADDED = 1 << 5, 
 OT_CHANGED_THREAD_RLOC_REMOVED = 1 << 6, 
 OT_CHANGED_THREAD_PARTITION_ID = 1 << 7, 
 OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER = 1 << 8, 
 OT_CHANGED_THREAD_NETDATA = 1 << 9, 
 OT_CHANGED_THREAD_CHILD_ADDED = 1 << 10, 
 OT_CHANGED_THREAD_CHILD_REMOVED = 1 << 11, 
 OT_CHANGED_IP6_MULTICAST_SUBSCRIBED = 1 << 12, 
 OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED = 1 << 13, 
 OT_CHANGED_THREAD_CHANNEL = 1 << 14, 
 OT_CHANGED_THREAD_PANID = 1 << 15, 
 OT_CHANGED_THREAD_NETWORK_NAME = 1 << 16, 
 OT_CHANGED_THREAD_EXT_PANID = 1 << 17, 
 OT_CHANGED_MASTER_KEY = 1 << 18, 
 OT_CHANGED_PSKC = 1 << 19, 
 OT_CHANGED_SECURITY_POLICY = 1 << 20, 
 OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL = 1 << 21, 
 OT_CHANGED_SUPPORTED_CHANNEL_MASK = 1 << 22, 
 OT_CHANGED_COMMISSIONER_STATE = 1 << 23, 
 OT_CHANGED_THREAD_NETIF_STATE = 1 << 24, 
 OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE = 1 << 25, 
 OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL = 1 << 26, 
 OT_CHANGED_JOINER_STATE = 1 << 27 
 }

ENUM

Cette énumération définit des drapeaux qui sont passés dans le cadre de otStateChangedCallback .

typedefs
`otChangedFlags`	typedef `uint32_t` Ce type représente un champ de bits indiquant l'état spécifique / configuration qui a changé.
`otInstance`	typedef `struct otInstance` Cette structure représente la structure de l'instance OpenThread.
`otStateChangedCallback )(otChangedFlags aFlags, void *aContext)`	typedef `void(*` Ce pointeur de fonction est appelée à notifier certaines configurations ou des changements dans l'état OpenThread.

Les fonctions
`otGetRadioVersionString ( otInstance *aInstance)`	`const char *` Cette fonction obtient la chaîne de version radio OpenThread.
`otGetVersionString (void)`	`const char *` Cette fonction obtient la chaîne de version OpenThread.
`otInstanceErasePersistentInfo ( otInstance *aInstance)`	`otError` Cette fonction permet d'effacer toutes les informations persistantes OpenThread (paramètres réseau) stockés sur la mémoire non volatile.
`otInstanceFactoryReset ( otInstance *aInstance)`	`void` Cette méthode supprime tous les paramètres stockés dans la mémoire non volatile, et déclenche alors remise à zéro de la plate-forme.
`otInstanceFinalize ( otInstance *aInstance)`	`void` Cette fonction désactive la bibliothèque OpenThread.
`otInstanceInit (void aInstanceBuffer, size_t aInstanceBufferSize)`	`otInstance *` Cette fonction initialise la bibliothèque OpenThread.
`otInstanceInitSingle (void)`	`otInstance *` Cette fonction permet d'initialiser l'instance statique unique de la bibliothèque OpenThread.
`otInstanceIsInitialized ( otInstance *aInstance)`	`bool` Cette fonction indique si l'instance est valide / initialisé ou non.
`otInstanceReset ( otInstance *aInstance)`	`void` Cette méthode déclenche une remise à zéro de la plate-forme.
`otRemoveStateChangeCallback ( otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`void` Cette fonction supprime un rappel pour indiquer lorsque certaines configurations ou des changements dans l'état OpenThread.
`otSetStateChangedCallback ( otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`otError` Cette fonction enregistre un rappel pour indiquer lorsque certaines configurations ou des changements dans l'état OpenThread.

énumérations

ENUM anonyme

 anonymous enum

Cette énumération définit des drapeaux qui sont passés dans le cadre de otStateChangedCallback .

Propriétés
`OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL`	Channel Manager nouvelle dans l'attente canal de fil a changé.
`OT_CHANGED_COMMISSIONER_STATE`	État commissaire a changé.
`OT_CHANGED_IP6_ADDRESS_ADDED`	adresse IPv6 a été ajouté.
`OT_CHANGED_IP6_ADDRESS_REMOVED`	adresse IPv6 a été supprimée.
`OT_CHANGED_IP6_MULTICAST_SUBSCRIBED`	Souscrit à une adresse de multidiffusion IPv6.
`OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED`	Désabonné à partir d'une adresse de multidiffusion IPv6.
`OT_CHANGED_JOINER_STATE`	état Joiner a changé.
`OT_CHANGED_MASTER_KEY`	clé principale a changé.
`OT_CHANGED_PSKC`	changé PSKc.
`OT_CHANGED_SECURITY_POLICY`	a changé la politique de sécurité.
`OT_CHANGED_SUPPORTED_CHANNEL_MASK`	Pris en charge masque de canal changé.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL`	Configuration du routeur Backbone local a changé.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE`	état du routeur de réseau fédérateur a changé.
`OT_CHANGED_THREAD_CHANNEL`	Fil canal de réseau a changé.
`OT_CHANGED_THREAD_CHILD_ADDED`	Enfant a été ajouté.
`OT_CHANGED_THREAD_CHILD_REMOVED`	a été enlevé l'enfant.
`OT_CHANGED_THREAD_EXT_PANID`	réseau de fil étendu PAN ID modifié.
`OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER`	Enfiler séquence de touches a changé.
`OT_CHANGED_THREAD_LL_ADDR`	L'adresse de liaison locale a changé.
`OT_CHANGED_THREAD_ML_ADDR`	L'adresse de maillage local a changé.
`OT_CHANGED_THREAD_NETDATA`	Fil de données réseau a changé.
`OT_CHANGED_THREAD_NETIF_STATE`	Etat d'interface réseau de fil a changé.
`OT_CHANGED_THREAD_NETWORK_NAME`	Discussion nom du réseau a changé.
`OT_CHANGED_THREAD_PANID`	réseau de fil PAN Id changé.
`OT_CHANGED_THREAD_PARTITION_ID`	ID de partition modifiée.
`OT_CHANGED_THREAD_RLOC_ADDED`	RLOC a été ajouté.
`OT_CHANGED_THREAD_RLOC_REMOVED`	RLOC a été supprimé.
`OT_CHANGED_THREAD_ROLE`	Rôle (personnes handicapées, détaché, enfant, routeur, chef de file) changé.

typedefs

otChangedFlags

uint32_t otChangedFlags

Ce type représente un champ de bits indiquant l'état spécifique / configuration qui a changé.

Voir OT_CHANGED_* définitions.

otInstance

struct otInstance otInstance

Cette structure représente la structure de l'instance OpenThread.

otStateChangedCallback

void(* otStateChangedCallback)(otChangedFlags aFlags, void *aContext)

Ce pointeur de fonction est appelée à notifier certaines configurations ou des changements dans l'état OpenThread.

Détails

Paramètres

`[in] aFlags`	Un état spécifique indiquant champ binaire qui a changé. Voir `OT_CHANGED_*` définitions.
`[in] aContext`	Un pointeur au contexte spécifique à l'application.

Les fonctions

otGetRadioVersionString

const char * otGetRadioVersionString(
  otInstance *aInstance
)

Cette fonction obtient la chaîne de version radio OpenThread.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

Retour

Un pointeur sur la version radio OpenThread.

otGetVersionString

const char * otGetVersionString(
  void
)

Cette fonction obtient la chaîne de version OpenThread.

Détails
Retour	Un pointeur vers la version OpenThread.

otInstanceErasePersistentInfo

 otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

Cette fonction permet d'effacer toutes les informations persistantes OpenThread (paramètres réseau) stockés sur la mémoire non volatile.

Effacer réussit que si l'appareil est en disabled État / rôle.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

valeurs de retour

`OT_ERROR_NONE`	Toutes les informations persistantes / état a été effacé avec succès.
`OT_ERROR_INVALID_STATE`	L' appareil est pas `disabled` État / rôle.

otInstanceFactoryReset

void otInstanceFactoryReset(
  otInstance *aInstance
)

Cette méthode supprime tous les paramètres stockés dans la mémoire non volatile, et déclenche alors remise à zéro de la plate-forme.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

otInstanceFinalize

void otInstanceFinalize(
  otInstance *aInstance
)

Cette fonction désactive la bibliothèque OpenThread.

Appelez cette fonction lorsque OpenThread n'est plus utilisé.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

otInstanceInit

 otInstance * otInstanceInit(
  void *aInstanceBuffer,
  size_t *aInstanceBufferSize
)

Cette fonction initialise la bibliothèque OpenThread.

Cette fonction initialise OpenThread et prépare pour les appels d'API suivantes OpenThread. Cette fonction doit être appelée avant tout autre appel à OpenThread.

Cette fonction est disponible et ne peut être utilisée que lorsque le support de plusieurs instances de OpenThread est activée.

Détails

Paramètres

`[in] aInstanceBuffer`	Le tampon pour OpenThread à utiliser pour l'attribution de la structure otInstance.
`[in,out] aInstanceBufferSize`	En entrée, la taille de aInstanceBuffer. En sortie, sinon assez d'espace pour otInstance, le nombre d'octets requis pour otInstance.

Retour

Un pointeur vers la nouvelle instance de OpenThread.

Voir également:
otInstanceFinalize

otInstanceInitSingle

 otInstance * otInstanceInitSingle(
  void
)

Cette fonction permet d'initialiser l'instance statique unique de la bibliothèque OpenThread.

Cette fonction initialise OpenThread et prépare pour les appels d'API suivantes OpenThread. Cette fonction doit être appelée avant tout autre appel à OpenThread.

Cette fonction est disponible et ne peut être utilisée que lorsque le support de plusieurs instances de OpenThread est désactivé.

Détails
Retour	Un pointeur sur la seule instance de OpenThread.

otInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

Cette fonction indique si l'instance est valide / initialisé ou non.

L'instance est considérée comme valide si elle est acquise et initialisé à l' aide soit otInstanceInitSingle() (en cas de d'instance unique) ou otInstanceInit() (en cas multi exemple). Un appel ultérieur à otInstanceFinalize() provoque l'instance doit être considérée comme non initialisée.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

Retour

TRUE si l'instance donnée est valide / initialisé, sinon FALSE.

otInstanceReset

void otInstanceReset(
  otInstance *aInstance
)

Cette méthode déclenche une remise à zéro de la plate-forme.

Les processus de remise à zéro assure de ce que tout l'état OpenThread / informations (stockées dans la mémoire volatile) sont effacées. Notez que la otPlatformReset n'efface pas un état persistant / informations enregistrées dans la mémoire non volatile.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance OpenThread.

otRemoveStateChangeCallback

void otRemoveStateChangeCallback(
  otInstance *aInstance,
  otStateChangedCallback aCallback,
  void *aContext
)

Cette fonction supprime un rappel pour indiquer lorsque certaines configurations ou des changements dans l'état OpenThread.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance OpenThread.
`[in] aCallback`	Un pointeur vers une fonction qui est appelée avec certaines configurations ou du changement d'état.
`[in] aContext`	Un pointeur au contexte spécifique à l'application.

otSetStateChangedCallback

 otError otSetStateChangedCallback(
  otInstance *aInstance,
  otStateChangedCallback aCallback,
  void *aContext
)

Cette fonction enregistre un rappel pour indiquer lorsque certaines configurations ou des changements dans l'état OpenThread.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance OpenThread.
`[in] aCallback`	Un pointeur vers une fonction qui est appelée avec certaines configurations ou du changement d'état.
`[in] aContext`	Un pointeur au contexte spécifique à l'application.

valeurs de retour

`OT_ERROR_NONE`	Ajout de la fonction de rappel à la liste des callbacks.
`OT_ERROR_ALREADY`	Le rappel a été déjà enregistré.
`OT_ERROR_NO_BUFS`	Impossible d'ajouter le rappel en raison de contraintes de ressources.