Joiner

Ce module inclut des fonctions pour le rôle Thread Joiner.

Résumé

Énumérations
otJoinerState enum
Définit l'état de la jointure.

Typedefs
otJoinerCallback)(otError aError, void *aContext) typedef
void(*
Le pointeur est appelé pour avertir la fin d'une opération de jointure.
otJoinerDiscerner typedef
Représente un Joiner Discerner.
otJoinerState typedef
Définit l'état de la jointure.

distantes
otJoinerGetDiscerner(otInstance *aInstance)
Attribue le Joiner Discerner.
otJoinerGetId(otInstance *aInstance)
const otExtAddress *
Récupère l'ID de jointure.
otJoinerGetState(otInstance *aInstance)
Récupère l'état de jointure.
otJoinerSetDiscerner(otInstance *aInstance, otJoinerDiscerner *aDiscerner)
Définit le Joiner Discerner.
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)
Active le rôle Thread Joiner.
otJoinerStateToString(otJoinerState aState)
const char *
Convertit une valeur d'énumération d'état de jointure donnée en chaîne lisible.
otJoinerStop(otInstance *aInstance)
void
Désactive le rôle Thread Joiner.

Structs
otJoinerDiscerner

Représente un Joiner Discerner.

Énumérations

otJoinerState

 otJoinerState

Définit l'état de la jointure.

Typedefs

otJoinerCallback

void(* otJoinerCallback)(otError aError, void *aContext)

Le pointeur est appelé pour avertir la fin d'une opération de jointure.

Détails
Paramètres
[in] aError
OT_ERROR_NONE si le processus de jointure 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 pouvant être joint n'a été découvert. OT_ERROR_ANSWER_TIMEOUT si le délai d'une réponse a expiré.
[in] aContext
Pointeur vers un contexte spécifique à l'application.

otJoinerDiscerner

struct otJoinerDiscerner otJoinerDiscerner

Représente un Joiner Discerner.

otJoinerState

enum otJoinerState otJoinerState

Définit l'état de la jointure.

distantes

otJoinerGetDiscerner

const otJoinerDiscerner * otJoinerGetDiscerner(
  otInstance *aInstance
)

Attribue le Joiner Discerner.

Pour en savoir plus, consultez otJoinerSetDiscerner.

Détails
Paramètres
[in] aInstance
Un pointeur vers l'instance OpenThread.
Renvoie
Pointeur vers Joiner Discerner ou NULL si aucun n'est défini.

otJoinerGetId

const otExtAddress * otJoinerGetId(
  otInstance *aInstance
)

Récupère l'ID de jointure.

Si aucun Joiner Discerner n'est défini, l'ID de jointure correspond aux 64 premiers bits du résultat du calcul de SHA-256 sur la norme IEEE EUI-64 attribuée en usine. Sinon, l'ID de jointure est calculé à partir de la valeur Joiner Discerner.

L'ID de jointure est également utilisé comme adresse étendue IEEE 802.15.4 de l'appareil lors du processus de mise en service.

Détails
Paramètres
[in] aInstance
Un pointeur vers l'instance OpenThread.
Renvoie
Pointeur vers l'ID de jointure.

otJoinerGetState

otJoinerState otJoinerGetState(
  otInstance *aInstance
)

Récupère l'état de jointure.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Renvoie
État de jointure.

otJoinerSetDiscerner

otError otJoinerSetDiscerner(
  otInstance *aInstance,
  otJoinerDiscerner *aDiscerner
)

Définit le Joiner Discerner.

Joiner Discerner est utilisé pour calculer l'ID de jointure au cours du processus de mise en service de thread. Pour en savoir plus, consultez otJoinerGetId.

Détails
Paramètres
[in] aInstance
Un pointeur vers l'instance OpenThread.
[in] aDiscerner
Pointeur vers un Joiner Discerner. Si la valeur NULL efface tout discerner précédemment défini.
Valeurs de retour
OT_ERROR_NONE
Joiner Discerner a bien été mis à jour.
OT_ERROR_INVALID_ARGS
aDiscerner n'est pas valide (la longueur spécifiée n'est pas comprise dans la plage valide).
OT_ERROR_INVALID_STATE
Un processus d'association étant en cours, Joiner Discerner ne peut pas être modifié.

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
)

Active le rôle Thread Joiner.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aPskd
Pointeur vers la clé PSKd.
[in] aProvisioningUrl
Pointeur vers l'URL de provisionnement (peut être NULL).
[in] aVendorName
Un pointeur vers le nom du fournisseur (peut être NULL).
[in] aVendorModel
Un pointeur vers le modèle de fournisseur (peut être NULL).
[in] aVendorSwVersion
Pointeur vers la version logicielle du fournisseur (peut être NULL).
[in] aVendorData
Un 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 un contexte spécifique à l'application.
Valeurs de retour
OT_ERROR_NONE
Le rôle Joiner a bien été démarré.
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
)

Convertit une valeur d'énumération d'état de jointure donnée en chaîne lisible.

Détails
Paramètres
[in] aState
État de jointure.
Renvoie
Représentation de aState sous forme de chaîne lisible.

otJoinerStop

void otJoinerStop(
  otInstance *aInstance
)

Désactive le rôle Thread Joiner.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.

Macros

OT_JOINER_MAX_DISCERNER_LENGTH

 OT_JOINER_MAX_DISCERNER_LENGTH 64

Longueur maximale d'un Joiner Discerner en bits.

Ressources

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 section Ressources.