Exemple

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

Sommaire

É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, OT_CHANGED_ACTIVE_DATASET = 1 << 28, OT_CHANGED_PENDING_DATASET = 1 << 29 }	énumération Cette énumération définit les indicateurs 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,
 OT_CHANGED_ACTIVE_DATASET = 1 << 28,
 OT_CHANGED_PENDING_DATASET = 1 << 29
 }

énumération

Cette énumération définit les indicateurs 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 / la configuration spécifique qui a changé.
`otInstance`	typedef `struct otInstance` Cette structure représente la structure d'instance d'OpenThread.
`otStateChangedCallback )(otChangedFlags aFlags, void *aContext)`	typedef `void(*` Ce pointeur de fonction est appelé pour notifier certaines modifications de configuration ou d'état dans 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 d'OpenThread.
`otInstanceErasePersistentInfo ( otInstance *aInstance)`	`otError` Cette fonction efface toutes les informations persistantes d'OpenThread (paramètres réseau) stockées 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, puis déclenche la réinitialisation 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 initialise l'instance unique statique de la bibliothèque OpenThread.
`otInstanceIsInitialized ( otInstance *aInstance)`	`bool` Cette fonction indique si l'instance est valide / initialisée ou non.
`otInstanceReset ( otInstance *aInstance)`	`void` Cette méthode déclenche une réinitialisation de la plateforme.
`otRemoveStateChangeCallback ( otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`void` Cette fonction supprime un rappel pour indiquer quand certaines configurations ou états changent dans OpenThread.
`otSetStateChangedCallback ( otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`otError` Cette fonction enregistre un rappel pour indiquer quand certaines configurations ou états changent dans OpenThread.

Énumérations

énumération anonyme

 anonymous enum

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

Propriétés
`OT_CHANGED_ACTIVE_DATASET`	Le jeu de données opérationnel actif a été modifié.
`OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL`	Le nouveau canal de discussion en attente de Channel Manager a été modifié.
`OT_CHANGED_COMMISSIONER_STATE`	L'état du commissaire a changé.
`OT_CHANGED_IP6_ADDRESS_ADDED`	L'adresse IPv6 a été ajoutée.
`OT_CHANGED_IP6_ADDRESS_REMOVED`	L'adresse IPv6 a été supprimée.
`OT_CHANGED_IP6_MULTICAST_SUBSCRIBED`	Abonné à une adresse multicast IPv6.
`OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED`	Désabonné d'une adresse multicast IPv6.
`OT_CHANGED_JOINER_STATE`	L'état du menuisier a changé.
`OT_CHANGED_MASTER_KEY`	La clé principale a été modifiée.
`OT_CHANGED_PENDING_DATASET`	Ensemble de données opérationnelles en attente modifié.
`OT_CHANGED_PSKC`	PSKc a changé.
`OT_CHANGED_SECURITY_POLICY`	La politique de sécurité a changé.
`OT_CHANGED_SUPPORTED_CHANNEL_MASK`	Le masque de canal pris en charge a été modifié.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL`	La configuration du routeur de dorsale local a été modifiée.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE`	L'état du routeur de base a changé.
`OT_CHANGED_THREAD_CHANNEL`	Le canal réseau du fil de discussion a été modifié.
`OT_CHANGED_THREAD_CHILD_ADDED`	L'enfant a été ajouté.
`OT_CHANGED_THREAD_CHILD_REMOVED`	L'enfant a été enlevé.
`OT_CHANGED_THREAD_EXT_PANID`	L'ID PAN étendu du réseau de threads a été modifié.
`OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER`	La séquence de touches de thread a été modifiée.
`OT_CHANGED_THREAD_LL_ADDR`	L'adresse lien-local a changé.
`OT_CHANGED_THREAD_ML_ADDR`	L'adresse locale du maillage a changé.
`OT_CHANGED_THREAD_NETDATA`	Les données du réseau de thread ont été modifiées.
`OT_CHANGED_THREAD_NETIF_STATE`	L'état de l'interface réseau du thread a changé.
`OT_CHANGED_THREAD_NETWORK_NAME`	Le nom du réseau de thread a changé.
`OT_CHANGED_THREAD_PANID`	L'identifiant PAN du réseau de threads a été modifié.
`OT_CHANGED_THREAD_PARTITION_ID`	L'ID de partition a été modifié.
`OT_CHANGED_THREAD_RLOC_ADDED`	RLOC a été ajouté.
`OT_CHANGED_THREAD_RLOC_REMOVED`	RLOC a été supprimé.
`OT_CHANGED_THREAD_ROLE`	Le rôle (désactivé, détaché, enfant, routeur, chef) a changé.

Typedefs

otChangedFlags

uint32_t otChangedFlags

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

Voir les définitions OT_CHANGED_* .

otInstance

struct otInstance otInstance

Cette structure représente la structure d'instance d'OpenThread.

otStateChangedCallback

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

Ce pointeur de fonction est appelé pour notifier certaines modifications de configuration ou d'état dans OpenThread.

Détails

Paramètres

`[in] aFlags`	Un champ de bits indiquant un état spécifique qui a changé. Voir les définitions `OT_CHANGED_*` .
`[in] aContext`	Un pointeur vers un 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 d'OpenThread.

Retour

Un pointeur vers la version radio OpenThread.

otGetVersionString

const char * otGetVersionString(
  void
)

Cette fonction obtient la chaîne de version d'OpenThread.

Détails
Retour	Un pointeur vers la version d'OpenThread.

otInstanceErasePersistentInfo

otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

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

L'effacement réussit uniquement si le périphérique est dans l'état / le rôle disabled .

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance d'OpenThread.

Valeurs de retour

`OT_ERROR_NONE`	Toutes les informations / états persistants ont été effacés avec succès.
`OT_ERROR_INVALID_STATE`	L'appareil n'est pas dans l'état / le rôle `disabled` .

otInstanceFactoryReset

void otInstanceFactoryReset(
  otInstance *aInstance
)

Cette méthode supprime tous les paramètres stockés sur la mémoire non volatile, puis déclenche la réinitialisation de la plate-forme.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance d'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 d'OpenThread.

otInstanceInit

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

Cette fonction initialise la bibliothèque OpenThread.

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

Cette fonction est disponible et ne peut être utilisée que lorsque la prise en charge de plusieurs instances OpenThread est activée.

Détails

Paramètres

`[in] aInstanceBuffer`	Le tampon pour OpenThread à utiliser pour allouer la structure otInstance.
`[in,out] aInstanceBufferSize`	En entrée, la taille de aInstanceBuffer. En sortie, s'il n'y a pas assez d'espace pour otInstance, le nombre d'octets requis pour otInstance.

Retour

Un pointeur vers la nouvelle instance d'OpenThread.

Voir également:
otInstanceFinalize

otInstanceInitSingle

otInstance * otInstanceInitSingle(
  void
)

Cette fonction initialise l'instance unique statique de la bibliothèque OpenThread.

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

Cette fonction est disponible et ne peut être utilisée que lorsque la prise en charge de plusieurs instances OpenThread est désactivée.

Détails
Retour	Un pointeur vers la seule instance d'OpenThread.

otInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

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

L'instance est considérée comme valide si elle est acquise et initialisée à l'aide de otInstanceInitSingle() (dans le cas d'une seule instance) ou de otInstanceInit() (dans le cas de plusieurs instances). Un appel ultérieur à otInstanceFinalize() fait que l'instance est considérée comme non initialisée.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance d'OpenThread.

Retour

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

otInstanceReset

void otInstanceReset(
  otInstance *aInstance
)

Cette méthode déclenche une réinitialisation de la plateforme.

Le processus de réinitialisation garantit que tous les états / informations d'OpenThread (stockés dans la mémoire volatile) sont effacés. Notez que otPlatformReset n'efface aucun état / info persistant enregistré dans la mémoire non volatile.

Détails

Paramètres

[in] aInstance

Un pointeur vers une instance d'OpenThread.

otRemoveStateChangeCallback

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

Cette fonction supprime un rappel pour indiquer quand certaines configurations ou états changent dans OpenThread.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance d'OpenThread.
`[in] aCallback`	Pointeur vers une fonction appelée avec certaines modifications de configuration ou d'état.
`[in] aContext`	Un pointeur vers le 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 certains états changent dans OpenThread.

Détails

Paramètres

`[in] aInstance`	Un pointeur vers une instance d'OpenThread.
`[in] aCallback`	Pointeur vers une fonction appelée avec certaines modifications de configuration ou d'état.
`[in] aContext`	Un pointeur vers un contexte spécifique à l'application.

Valeurs de retour

`OT_ERROR_NONE`	Ajout du rappel à la liste des rappels.
`OT_ERROR_ALREADY`	Le rappel était déjà enregistré.
`OT_ERROR_NO_BUFS`	Impossible d'ajouter le rappel en raison de contraintes de ressources.