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) Typedef
void(*
Ce pointeur de fonction est appelé pour avertir l'achèvement d'une opération de jointure.
otJoinerDiscerner Typedef
Cette structure représente un élément jointeur.
otJoinerState Typedef
Cette énumération définit l'état du jointure.

Functions

otJoinerGetDiscerner(otInstance *aInstance)
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
[in] aError
OT_ERROR_NONE si le processus de connexion a réussi. OT_ERROR_SECURITY si le processus de connexion a échoué en raison d'identifiants de sécurité. OT_ERROR_NOT_FOUND si aucun réseau joignable n'a été détecté. OT_ERROR_RESPONSE_TIMEOUT si une réponse a expiré.
[in] aContext
Pointeur vers le contexte spécifique à l'application

otJoinerDiscerner

struct otJoinerDiscerner otJoinerDiscerner

Cette structure représente un élément jointeur.

otJoinerState

enum otJoinerState otJoinerState

Cette énumération définit l'état du jointure.

Functions

otJoinerGetDiscerner

const otJoinerDiscerner * otJoinerGetDiscerner(
  otInstance *aInstance
)

Cette fonction obtient le jointier.

Détails
Paramètres
[in] aInstance
Pointeur vers l'instance OpenThread.
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
[in] aInstance
Pointeur vers l'instance OpenThread.
Renvoie
Un pointeur vers l'ID de jointure.

otJoinerGetState

otJoinerState otJoinerGetState(
  otInstance *aInstance
)

Cette fonction renvoie l'état de jointure.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Valeurs renvoyées
OT_JOINER_STATE_IDLE
OT_JOINER_STATE_DISCOVER
OT_JOINER_STATE_CONNECT
OT_JOINER_STATE_CONNECTED
OT_JOINER_STATE_ENTRUST
OT_JOINER_STATE_JOINED

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
[in] aInstance
Pointeur vers l'instance OpenThread.
[in] aDiscerner
Un pointeur vers un outil de jointure Si la valeur NULL efface tous les champs précédemment définis.
Valeurs renvoyées
OT_ERROR_NONE
La jointure discutable a bien été mise à jour.
OT_ERROR_INVALID_ARGS
aDiscerner n'est pas une valeur valide (la longueur spécifiée n'est pas comprise dans une plage valide).
OT_ERROR_INVALID_STATE
Un processus de jointure est en cours. Impossible de modifier Joiner Disker.

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
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aPskd
Un pointeur vers le PSKd.
[in] aProvisioningUrl
Pointeur vers l'URL de gestion des comptes (peut être NULL).
[in] aVendorName
Pointeur vers le nom du fournisseur (peut être NULL).
[in] aVendorModel
Pointeur vers le modèle du fournisseur (peut être NULL).
[in] aVendorSwVersion
Pointeur vers la version du fournisseur de logiciel (peut être NULL).
[in] aVendorData
Pointeur vers les données du fournisseur (peut être NULL).
[in] aCallback
Pointeur vers une fonction appelée à la fin de l'opération de jointure.
[in] aContext
Pointeur vers le contexte spécifique à l'application
Valeurs renvoyées
OT_ERROR_NONE
Le rôle de jointure a bien été lancé.
OT_ERROR_BUSY
La tentative précédente est toujours en cours.
OT_ERROR_INVALID_ARGS
aPskd ou aProvisioningUrl n'est pas valide.
OT_ERROR_INVALID_STATE
La pile IPv6 n'est pas activée ou la pile Thread est entièrement activée.

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
[in] aState
État de jointure
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
[in] aInstance
Pointeur vers une instance OpenThread.

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.