Google is committed to advancing racial equity for Black communities. See how.
Cette page a été traduite par l'API Cloud Translation.
Switch to English

Menuisier

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

Résumé

Énumérations

otJoinerState énumération
Cette énumération définit l'état de jointure.

Typedefs

otJoinerCallback )(otError aError, void *aContext) typedef
void(*
Ce pointeur de fonction est appelé pour notifier la fin d'une opération de jointure.
otJoinerDiscerner typedef
Cette structure représente un Joiner Discerner.
otJoinerState typedef
Cette énumération définit l'état de jointure.

Les fonctions

otJoinerGetDiscerner ( otInstance *aInstance)
Cette méthode obtient le Joiner Discerner.
otJoinerGetId ( otInstance *aInstance)
const otExtAddress *
Cette méthode obtient l'ID de joint.
otJoinerGetState ( otInstance *aInstance)
Cette fonction renvoie l'état de jointure.
otJoinerSetDiscerner ( otInstance *aInstance, otJoinerDiscerner *aDiscerner)
Cette méthode 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)
Cette fonction active le rôle Thread Joiner.
otJoinerStop ( otInstance *aInstance)
void
Cette fonction désactive le rôle Thread Joiner.

Structs

otJoinerDiscerner

Cette structure représente un Joiner Discerner.

Énumérations

otJoinerState

 otJoinerState

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

Typedefs

otJoinerCallback

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

Ce pointeur de fonction est appelé pour notifier 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 jointure a échoué en raison d'informations d'identification de sécurité. OT_ERROR_NOT_FOUND si aucun réseau joignable n'a été découvert. OT_ERROR_RESPONSE_TIMEOUT si une réponse a expiré.
[in] aContext
Un pointeur vers le contexte spécifique à l'application.

otJoinerDiscerner

struct otJoinerDiscerner otJoinerDiscerner

Cette structure représente un Joiner Discerner.

otJoinerState

enum otJoinerState otJoinerState

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

Les fonctions

otJoinerGetDiscerner

const otJoinerDiscerner * otJoinerGetDiscerner(
  otInstance *aInstance
)

Cette méthode obtient le Joiner Discerner.

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

otJoinerGetId

const otExtAddress * otJoinerGetId(
  otInstance *aInstance
)

Cette méthode obtient l'ID de joint.

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

Le Joiner ID est également utilisé comme adresse étendue IEEE 802.15.4 de l'appareil pendant le processus de mise en service.

Détails
Paramètres
[in] aInstance
Un pointeur vers l'instance d'OpenThread.
Retour
Un pointeur vers l'ID de joint.

otJoinerGetState

 otJoinerState otJoinerGetState(
  otInstance *aInstance
)

Cette fonction renvoie l'état de jointure.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
Valeurs de retour
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 méthode définit le Joiner Discerner.

Le Joiner Discerner est utilisé pour calculer l'ID de menuisier utilisé pendant le processus de mise en service / d'assemblage.

Par défaut (lorsqu'un discerneur n'est pas fourni ou défini sur NULL), l'ID de joint est dérivé comme les 64 premiers bits du résultat du calcul de SHA-256 sur IEEE EUI-64 attribué en usine. Notez que c'est le comportement principal attendu par la spécification de Thread.

Détails
Paramètres
[in] aInstance
Un pointeur vers l'instance d'OpenThread.
[in] aDiscerner
Un pointeur vers un menuisier discerner. Si NULL efface tout discerner précédemment défini.
Valeurs de retour
OT_ERROR_NONE
Le Joiner Discerner a été mis à jour avec succès.
OT_ERROR_INVALID_ARGS
aDiscerner n'est pas valide (la longueur spécifiée n'est pas dans la plage valide).
OT_ERROR_INVALID_STATE
Il y a un processus d'adhésion en cours, donc 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
)

Cette fonction active le rôle Thread Joiner.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aPskd
Un pointeur vers le PSKd.
[in] aProvisioningUrl
Un pointeur vers l'URL de provisioning (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
Un pointeur vers la version du logiciel 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
Un pointeur vers le contexte spécifique à l'application.
Valeurs de retour
OT_ERROR_NONE
Démarrage réussi du rôle Joiner.
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 de threads est entièrement activée.

otJoinerStop

void otJoinerStop(
  otInstance *aInstance
)

Cette fonction désactive le rôle Thread Joiner.

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

Macros

OT_JOINER_MAX_DISCERNER_LENGTH

 OT_JOINER_MAX_DISCERNER_LENGTH 64

Longueur maximale d'un Joiner Discerner en bits.