Menuisier
Ce module inclut des fonctions pour le rôle de jointur de thread.
Résumé
Énumérations |
|
---|---|
otJoinerState
|
enum Cette énumération définit l'état du jointure. |
Typedefs |
|
---|---|
otJoinerCallback)(otError aError, void *aContext)
|
Typedefvoid(*
Ce pointeur de fonction est appelé pour avertir l'achèvement d'une opération de jointure. |
otJoinerDiscerner
|
Typedefstruct otJoinerDiscerner
Cette structure représente un élément jointeur. |
otJoinerState
|
Typedefenum otJoinerState
Cette énumération définit l'état du jointure. |
Functions |
|
---|---|
otJoinerGetDiscerner(otInstance *aInstance)
|
const otJoinerDiscerner *
Cette fonction obtient le jointier.
|
otJoinerGetId(otInstance *aInstance)
|
const otExtAddress *
Cette fonction obtient l'ID de jointure.
|
otJoinerGetState(otInstance *aInstance)
|
Cette fonction renvoie l'état de jointure.
|
otJoinerSetDiscerner(otInstance *aInstance, otJoinerDiscerner *aDiscerner)
|
Cette fonction définit le regroupement des jointures.
|
otJoinerStart(otInstance *aInstance, const char *aPskd, const char *aProvisioningUrl, const char *aVendorName, const char *aVendorModel, const char *aVendorSwVersion, const char *aVendorData, otJoinerCallback aCallback, void *aContext)
|
Cette fonction active le rôle "Jointeur".
|
otJoinerStateToString(otJoinerState aState)
|
const char *
Cette fonction convertit une valeur d'énumération de l'état de jointure en chaîne lisible.
|
otJoinerStop(otInstance *aInstance)
|
void
Cette fonction désactive le rôle de jointure de fil de discussion.
|
Structure |
|
---|---|
otJoinerDiscerner |
Cette structure représente un élément jointeur. |
Énumérations
otJoinerState
otJoinerState
Cette énumération définit l'état du jointure.
Typedefs
otJoinerCallback
void(* otJoinerCallback)(otError aError, void *aContext)
Ce pointeur de fonction est appelé pour avertir l'achèvement d'une opération de jointure.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
otJoinerDiscerner
struct otJoinerDiscerner otJoinerDiscerner
Cette structure représente un élément jointeur.
Functions
otJoinerGetDiscerner
const otJoinerDiscerner * otJoinerGetDiscerner( otInstance *aInstance )
Cette fonction obtient le jointier.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
Pointeur vers Joiner Discerner ou NULL si aucun n'est défini.
|
OTJoinerGetId
const otExtAddress * otJoinerGetId( otInstance *aInstance )
Cette fonction obtient l'ID de jointure.
Si aucune option de jointure n'est définie, les ID de jointure correspondent aux 64 premiers bits du résultat du calcul SHA-256 par rapport à la norme IEEE EUI-64. Sinon, l'ID de jointure est calculé à partir de la valeur de Joiner Diserner.
Cet ID est également utilisé comme adresse étendue IEEE 802.15.4 pour l'appareil lors de la mise en service.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
Un pointeur vers l'ID de jointure.
|
otJoinerGetState
otJoinerState otJoinerGetState( otInstance *aInstance )
Cette fonction renvoie l'état de jointure.
Détails | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Paramètres |
|
||||||||||||
Valeurs renvoyées |
|
otJoinerSetDiscerner
otError otJoinerSetDiscerner( otInstance *aInstance, otJoinerDiscerner *aDiscerner )
Cette fonction définit le regroupement des jointures.
L'élément jointur joint sert à calculer l'ID de jointure utilisé lors du processus de mise en service et de participation.
Par défaut (lorsqu'un disque dur n'est pas fourni ou défini sur NULL), l'ID de jointure est dérivé des 64 premiers bits du résultat du calcul SHA-256 par rapport à la norme IEEE EUI-64. Notez qu'il s'agit du comportement principal attendu par la spécification Thread.
Détails | |||||||
---|---|---|---|---|---|---|---|
Paramètres |
|
||||||
Valeurs renvoyées |
|
OTJoinerStart
otError otJoinerStart( otInstance *aInstance, const char *aPskd, const char *aProvisioningUrl, const char *aVendorName, const char *aVendorModel, const char *aVendorSwVersion, const char *aVendorData, otJoinerCallback aCallback, void *aContext )
Cette fonction active le rôle "Jointeur".
Détails | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Paramètres |
|
||||||||||||||||||
Valeurs renvoyées |
|
otJoinerStateToString
const char * otJoinerStateToString( otJoinerState aState )
Cette fonction convertit une valeur d'énumération de l'état de jointure en chaîne lisible.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
Représentation de
aState sous forme lisible. |
otJoinerStop
void otJoinerStop( otInstance *aInstance )
Cette fonction désactive le rôle de jointure de fil de discussion.
Détails | |||
---|---|---|---|
Paramètres |
|
Macros
OT_JOINER_MAX_DISCERNER_LENGTH
OT_JOINER_MAX_DISCERNER_LENGTH 64
Longueur maximale d'un outil de jointure en bits.
Resources
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 page Ressources.