Exemple
Ce module comprend des fonctions qui contrôlent l'instance OpenThread.
Sommaire
Typedefs | |
---|---|
otChangedFlags | typedefuint32_t Ce type représente un champ de bits indiquant l'état / la configuration spécifique qui a changé. |
otInstance | typedefstruct otInstance Cette structure représente la structure d'instance d'OpenThread. |
otStateChangedCallback )(otChangedFlags aFlags, void *aContext) | typedefvoid(* 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) | 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) | Cette fonction initialise la bibliothèque OpenThread. |
otInstanceInitSingle (void) | 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) | 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
.
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 |
|
Les fonctions
otGetRadioVersionString
const char * otGetRadioVersionString( otInstance *aInstance )
Cette fonction obtient la chaîne de version radio OpenThread.
Détails | |||
---|---|---|---|
Paramètres |
| ||
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 |
| ||||
Valeurs de retour |
|
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 |
|
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 |
|
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 |
| ||||
Retour | Un pointeur vers la nouvelle instance d'OpenThread. |
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 |
| ||
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 |
|
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 |
|
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 |
| ||||||
Valeurs de retour |
|