Commissaire

Ce module inclut des fonctions pour le rôle "Commissaire de threads".

Résumé

Énumérations
otCommissionerJoinerEvent enum
Définit un événement de jointure au niveau du commissaire.
otCommissionerState{
  OT_COMMISSIONER_STATE_DISABLED = 0,
  OT_COMMISSIONER_STATE_PETITION = 1,
  OT_COMMISSIONER_STATE_ACTIVE = 2
} 		enum
Définit l'état du commissaire.
otJoinerInfoType{
  OT_JOINER_INFO_TYPE_ANY = 0,
  OT_JOINER_INFO_TYPE_EUI64 = 1,
  OT_JOINER_INFO_TYPE_DISCERNER = 2
} 		enum
Définit un type d'informations de jointure.

Typedefs
otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext) typedef
void(*
Le pointeur est appelé lorsque le commissaire reçoit un rapport énergétique.
otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext) typedef
void(*
Le pointeur est appelé chaque fois que l'état de la jointure change.
otCommissionerJoinerEvent typedef
Définit un événement de jointure au niveau du commissaire.
otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext) typedef
void(*
Le pointeur est appelé lorsque le commissaire reçoit un message de conflit d'ID de PAN.
otCommissionerState typedef
Définit l'état du commissaire.
otCommissionerStateCallback)(otCommissionerState aState, void *aContext) typedef
void(*
Le pointeur est appelé chaque fois que l'état du commissaire change.
otCommissioningDataset typedef
Représente un ensemble de données de mise en service.
otJoinerInfo typedef
struct otJoinerInfo
Représente un élément de jointure.
otJoinerInfoType typedef
Définit un type d'informations de jointure.
otJoinerPskd typedef
struct otJoinerPskd
Représente une clé PSKd de jointure.
otSteeringData typedef
Représente les données de pilotage.

distantes
otCommissionerAddJoiner(otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout)
Ajoute une entrée Joiner.
otCommissionerAddJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout)
Ajoute une entrée Joiner avec une valeur de discerner de jointure donnée.
otCommissionerAnnounceBegin(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress)
Envoie un message d'annonce de début.
otCommissionerEnergyScan(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext)
Envoie un message de requête d'analyse d'énergie.
otCommissionerGetId(otInstance *aInstance)
const char *
Renvoie l'ID de commissaire.
otCommissionerGetNextJoinerInfo(otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner)
Obtenir des informations sur les jointures à la position aIterator.
otCommissionerGetProvisioningUrl(otInstance *aInstance)
const char *
Récupère l'URL de provisionnement.
otCommissionerGetSessionId(otInstance *aInstance)
uint16_t
Renvoie l'ID de session du commissaire.
otCommissionerGetState(otInstance *aInstance)
Affiche l'état du commissaire.
otCommissionerPanIdQuery(otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext)
Envoie un message de requête d'ID de PAN.
otCommissionerRemoveJoiner(otInstance *aInstance, const otExtAddress *aEui64)
Supprime une entrée de jointure.
otCommissionerRemoveJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner)
Supprime une entrée de jointure.
otCommissionerSendMgmtGet(otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength)
Envoie MGMT_COMMISSIONER_GET.
otCommissionerSendMgmtSet(otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength)
Envoie MGMT_COMMISSIONER_SET.
otCommissionerSetId(otInstance *aInstance, const char *aId)
Définit l'ID du commissaire.
otCommissionerSetProvisioningUrl(otInstance *aInstance, const char *aProvisioningUrl)
Définit l'URL de provisionnement.
otCommissionerStart(otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext)
Active le rôle "Thread Commissioner".
otCommissionerStop(otInstance *aInstance)
Désactive le rôle "Thread Commissioner".

Structs
otCommissioningDataset

Représente un ensemble de données de mise en service.

otJoinerInfo

Représente un élément de jointure.

otJoinerPskd

Représente une clé PSKd de jointure.

otSteeringData

Représente les données de pilotage.

Énumérations

otCommissionerJoinerEvent

 otCommissionerJoinerEvent

Définit un événement de jointure au niveau du commissaire.

otCommissionerState

 otCommissionerState

Définit l'état du commissaire.

Propriétés
OT_COMMISSIONER_STATE_ACTIVE

Le rôle de commissaire est actif.

OT_COMMISSIONER_STATE_DISABLED

Le rôle de commissaire est désactivé.

OT_COMMISSIONER_STATE_PETITION

Demande en cours de demande pour devenir commissaire

otJoinerInfoType

 otJoinerInfoType

Définit un type d'informations de jointure.

Propriétés
OT_JOINER_INFO_TYPE_ANY

Accepter n'importe quel Joiner (aucun EUI64 ou Discerner n'est spécifié).

OT_JOINER_INFO_TYPE_DISCERNER

Joiner Discerner est spécifié (mSharedId.mDiscerner dans otJoinerInfo).

OT_JOINER_INFO_TYPE_EUI64

L'EUI-64 de jointure est spécifiée (mSharedId.mEui64 dans otJoinerInfo).

Typedefs

otCommissionerEnergyReportCallback

void(* otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)

Le pointeur est appelé lorsque le commissaire reçoit un rapport énergétique.

Détails
Paramètres
[in] aChannelMask
Valeur du masque de canal.
[in] aEnergyList
Curseur vers la liste des mesures d'énergie.
[in] aEnergyListLength
Nombre d'entrées dans aEnergyListLength.
[in] aContext
Pointeur vers un contexte spécifique à l'application.

otCommissionerJoinerCallback

void(* otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)

Le pointeur est appelé chaque fois que l'état de la jointure change.

Détails
Paramètres
[in] aEvent
Type d'événement de jointure.
[in] aJoinerInfo
Pointeur vers les informations de jointure.
[in] aJoinerId
Pointeur vers l'ID de jointure (s'il est inconnu, il sera NULL).
[in] aContext
Pointeur vers un contexte spécifique à l'application.

otCommissionerJoinerEvent

enum otCommissionerJoinerEvent otCommissionerJoinerEvent

Définit un événement de jointure au niveau du commissaire.

otCommissionerPanIdConflictCallback

void(* otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)

Le pointeur est appelé lorsque le commissaire reçoit un message de conflit d'ID de PAN.

Détails
Paramètres
[in] aPanId
Valeur de l'ID du PAN.
[in] aChannelMask
Valeur du masque de canal.
[in] aContext
Pointeur vers un contexte spécifique à l'application.

otCommissionerState

enum otCommissionerState otCommissionerState

Définit l'état du commissaire.

otCommissionerStateCallback

void(* otCommissionerStateCallback)(otCommissionerState aState, void *aContext)

Le pointeur est appelé chaque fois que l'état du commissaire change.

Détails
Paramètres
[in] aState
État du commissaire.
[in] aContext
Pointeur vers un contexte spécifique à l'application.

otCommissioningDataset

struct otCommissioningDataset otCommissioningDataset

Représente un ensemble de données de mise en service.

otJoinerInfo

struct otJoinerInfo otJoinerInfo

Représente un élément de jointure.

otJoinerInfoType

enum otJoinerInfoType otJoinerInfoType

Définit un type d'informations de jointure.

otJoinerPskd

struct otJoinerPskd otJoinerPskd

Représente une clé PSKd de jointure.

otSteeringData

struct otSteeringData otSteeringData

Représente les données de pilotage.

distantes

otCommissionerAddJoiner

otError otCommissionerAddJoiner(
  otInstance *aInstance,
  const otExtAddress *aEui64,
  const char *aPskd,
  uint32_t aTimeout
)

Ajoute une entrée Joiner.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aEui64
Pointeur vers la classe IEEE EUI-64 de Joiner ou la valeur NULL pour n'importe quelle classe Joiner.
[in] aPskd
Pointeur vers la clé PSKd.
[in] aTimeout
Délai au terme duquel une jointure est automatiquement supprimée, en secondes.
Valeurs de retour
OT_ERROR_NONE
La jointure a bien été ajoutée.
OT_ERROR_NO_BUFS
Aucun tampon disponible pour ajouter l'élément Joiner.
OT_ERROR_INVALID_ARGS
aEui64 ou aPskd n'est pas valide.
OT_ERROR_INVALID_STATE
Le commissaire n'est pas actif.

otCommissionerAddJoinerWithDiscerner

otError otCommissionerAddJoinerWithDiscerner(
  otInstance *aInstance,
  const otJoinerDiscerner *aDiscerner,
  const char *aPskd,
  uint32_t aTimeout
)

Ajoute une entrée Joiner avec une valeur de discerner de jointure donnée.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aDiscerner
Pointeur sur le Joiner Discerner.
[in] aPskd
Pointeur vers la clé PSKd.
[in] aTimeout
Délai au terme duquel une jointure est automatiquement supprimée, en secondes.
Valeurs de retour
OT_ERROR_NONE
La jointure a bien été ajoutée.
OT_ERROR_NO_BUFS
Aucun tampon disponible pour ajouter l'élément Joiner.
OT_ERROR_INVALID_ARGS
aDiscerner ou aPskd n'est pas valide.
OT_ERROR_INVALID_STATE
Le commissaire n'est pas actif.

otCommissionerAnnounceBegin

otError otCommissionerAnnounceBegin(
  otInstance *aInstance,
  uint32_t aChannelMask,
  uint8_t aCount,
  uint16_t aPeriod,
  const otIp6Address *aAddress
)

Envoie un message d'annonce de début.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aChannelMask
Valeur du masque de canal.
[in] aCount
Nombre de messages d'annonce par chaîne.
[in] aPeriod
Durée entre deux transmissions successives de l'annonce MLE (en millisecondes).
[in] aAddress
Pointeur vers la destination IPv6.
Valeurs de retour
OT_ERROR_NONE
Le message "Annoncer le début" a bien été placé dans la file d'attente.
OT_ERROR_NO_BUFS
Tampons insuffisants pour générer un message d'annonce de début.
OT_ERROR_INVALID_STATE
Le commissaire n'est pas actif.

otCommissionerEnergyScan

otError otCommissionerEnergyScan(
  otInstance *aInstance,
  uint32_t aChannelMask,
  uint8_t aCount,
  uint16_t aPeriod,
  uint16_t aScanDuration,
  const otIp6Address *aAddress,
  otCommissionerEnergyReportCallback aCallback,
  void *aContext
)

Envoie un message de requête d'analyse d'énergie.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aChannelMask
Valeur du masque de canal.
[in] aCount
Nombre de mesures d'énergie par canal.
[in] aPeriod
Délai entre les mesures énergétiques (millisecondes).
[in] aScanDuration
Durée de l'analyse pour chaque mesure d'énergie (millisecondes).
[in] aAddress
Pointeur vers la destination IPv6.
[in] aCallback
Pointeur vers une fonction appelée lors de la réception d'un message de rapport énergétique.
[in] aContext
Pointeur vers un contexte spécifique à l'application.
Valeurs de retour
OT_ERROR_NONE
Le message de requête d'analyse énergétique a bien été placé dans la file d'attente.
OT_ERROR_NO_BUFS
Tampons insuffisants pour générer un message de requête d'analyse d'énergie.
OT_ERROR_INVALID_STATE
Le commissaire n'est pas actif.

otCommissionerGetId

const char * otCommissionerGetId(
  otInstance *aInstance
)

Renvoie l'ID de commissaire.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Renvoie
L'ID du commissaire

otCommissionerGetNextJoinerInfo

otError otCommissionerGetNextJoinerInfo(
  otInstance *aInstance,
  uint16_t *aIterator,
  otJoinerInfo *aJoiner
)

Obtenir des informations sur les jointures à la position aIterator.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance.
[in,out] aIterator
Pointeur vers le contexte de l'itérateur d'informations de jointure.
[out] aJoiner
Référence à des informations Joiner.
Valeurs de retour
OT_ERROR_NONE
Les informations de jointure ont bien été récupérées.
OT_ERROR_NOT_FOUND
Joiner suivant introuvable.

otCommissionerGetProvisioningUrl

const char * otCommissionerGetProvisioningUrl(
  otInstance *aInstance
)

Récupère l'URL de provisionnement.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Renvoie
Pointeur vers la chaîne d'URL.

otCommissionerGetSessionId

uint16_t otCommissionerGetSessionId(
  otInstance *aInstance
)

Renvoie l'ID de session du commissaire.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Renvoie
ID de session du commissaire actuel.

otCommissionerGetState

otCommissionerState otCommissionerGetState(
  otInstance *aInstance
)

Affiche l'état du commissaire.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Valeurs de retour
OT_COMMISSIONER_STATE_DISABLED
Bouton de mise en service désactivé.
OT_COMMISSIONER_STATE_PETITION
Devenir commissaire.
OT_COMMISSIONER_STATE_ACTIVE
Bouton de mise en service activé.

otCommissionerPanIdQuery

otError otCommissionerPanIdQuery(
  otInstance *aInstance,
  uint16_t aPanId,
  uint32_t aChannelMask,
  const otIp6Address *aAddress,
  otCommissionerPanIdConflictCallback aCallback,
  void *aContext
)

Envoie un message de requête d'ID de PAN.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aPanId
ID du PAN à interroger.
[in] aChannelMask
Valeur du masque de canal.
[in] aAddress
Pointeur vers la destination IPv6.
[in] aCallback
Pointeur vers une fonction appelée à la réception d'un message de conflit d'ID de PAN.
[in] aContext
Pointeur vers un contexte spécifique à l'application.
Valeurs de retour
OT_ERROR_NONE
Le message de requête de l'ID du PAN a bien été placé dans la file d'attente.
OT_ERROR_NO_BUFS
Tampons insuffisants pour générer un message de requête d'ID de PAN.
OT_ERROR_INVALID_STATE
Le commissaire n'est pas actif.

otCommissionerRemoveJoiner

otError otCommissionerRemoveJoiner(
  otInstance *aInstance,
  const otExtAddress *aEui64
)

Supprime une entrée de jointure.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aEui64
Pointeur vers la classe IEEE EUI-64 de Joiner ou la valeur NULL pour n'importe quelle classe Joiner.
Valeurs de retour
OT_ERROR_NONE
L'élément Joiner a bien été supprimé.
OT_ERROR_NOT_FOUND
La jointure spécifiée par aEui64 est introuvable.
OT_ERROR_INVALID_ARGS
aEui64 non valide.
OT_ERROR_INVALID_STATE
Le commissaire n'est pas actif.

otCommissionerRemoveJoinerWithDiscerner

otError otCommissionerRemoveJoinerWithDiscerner(
  otInstance *aInstance,
  const otJoinerDiscerner *aDiscerner
)

Supprime une entrée de jointure.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aDiscerner
Pointeur sur le Joiner Discerner.
Valeurs de retour
OT_ERROR_NONE
L'élément Joiner a bien été supprimé.
OT_ERROR_NOT_FOUND
La jointure spécifiée par aEui64 est introuvable.
OT_ERROR_INVALID_ARGS
aDiscerner non valide.
OT_ERROR_INVALID_STATE
Le commissaire n'est pas actif.

otCommissionerSendMgmtGet

otError otCommissionerSendMgmtGet(
  otInstance *aInstance,
  const uint8_t *aTlvs,
  uint8_t aLength
)

Envoie MGMT_COMMISSIONER_GET.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aTlvs
Point sur les TLV.
[in] aLength
La durée des TLV.
Valeurs de retour
OT_ERROR_NONE
La commande de l'ensemble de données meshcop a bien été envoyée.
OT_ERROR_NO_BUFS
Espace de mémoire tampon insuffisant pour envoyer.
OT_ERROR_INVALID_STATE
Le commissaire n'est pas actif.

otCommissionerSendMgmtSet

otError otCommissionerSendMgmtSet(
  otInstance *aInstance,
  const otCommissioningDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength
)

Envoie MGMT_COMMISSIONER_SET.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aDataset
Pointeur vers l'ensemble de données de mise en service.
[in] aTlvs
Point sur les TLV.
[in] aLength
La durée des TLV.
Valeurs de retour
OT_ERROR_NONE
La commande de l'ensemble de données meshcop a bien été envoyée.
OT_ERROR_NO_BUFS
Espace de mémoire tampon insuffisant pour envoyer.
OT_ERROR_INVALID_STATE
Le commissaire n'est pas actif.

otCommissionerSetId

otError otCommissionerSetId(
  otInstance *aInstance,
  const char *aId
)

Définit l'ID du commissaire.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aId
Pointeur vers un tableau de caractères de chaîne. La valeur doit être nulle et terminée.
Valeurs de retour
OT_ERROR_NONE
L'ID du commissaire a bien été défini.
OT_ERROR_INVALID_ARGS
Le prénom est trop long.
OT_ERROR_INVALID_STATE
Le commissaire est actif et l'ID ne peut pas être modifié.

otCommissionerSetProvisioningUrl

otError otCommissionerSetProvisioningUrl(
  otInstance *aInstance,
  const char *aProvisioningUrl
)

Définit l'URL de provisionnement.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aProvisioningUrl
Pointeur vers l'URL de provisionnement (peut être défini sur NULL pour être défini comme une chaîne vide).
Valeurs de retour
OT_ERROR_NONE
L'URL de gestion des comptes a bien été définie.
OT_ERROR_INVALID_ARGS
aProvisioningUrl n'est pas valide (trop long).

otCommissionerStart

otError otCommissionerStart(
  otInstance *aInstance,
  otCommissionerStateCallback aStateCallback,
  otCommissionerJoinerCallback aJoinerCallback,
  void *aCallbackContext
)

Active le rôle "Thread Commissioner".

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aStateCallback
Pointeur vers une fonction appelée lorsque l'état du commissaire change.
[in] aJoinerCallback
Un pointeur vers une fonction appelée avec un événement de jointure se produit.
[in] aCallbackContext
Pointeur vers un contexte spécifique à l'application.
Valeurs de retour
OT_ERROR_NONE
Le service Commissioner a bien été démarré.
OT_ERROR_ALREADY
Le champ "Commissaire" a déjà commencé.
OT_ERROR_INVALID_STATE
L'appareil n'est actuellement connecté à aucun réseau.

otCommissionerStop

otError otCommissionerStop(
  otInstance *aInstance
)

Désactive le rôle "Thread Commissioner".

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Valeurs de retour
OT_ERROR_NONE
Le service Commissioner a bien été arrêté.
OT_ERROR_ALREADY
Le service de mise en service est déjà arrêté.

Macros

OT_COMMISSIONING_PASSPHRASE_MAX_SIZE

 OT_COMMISSIONING_PASSPHRASE_MAX_SIZE 255

Taille maximale de la phrase secrète de mise en service.

OT_COMMISSIONING_PASSPHRASE_MIN_SIZE

 OT_COMMISSIONING_PASSPHRASE_MIN_SIZE 6

Taille minimale de la phrase secrète de mise en service.

OT_JOINER_MAX_PSKD_LENGTH

 OT_JOINER_MAX_PSKD_LENGTH 32

Longueur maximale de chaîne d'une clé PSKd Joiner (n'inclut pas le caractère nul).

OT_PROVISIONING_URL_MAX_SIZE

 OT_PROVISIONING_URL_MAX_SIZE 64

Taille maximale (nombre de caractères) dans la chaîne de l'URL de gestion des comptes (caractères nuls exclus).

OT_STEERING_DATA_MAX_LENGTH

 OT_STEERING_DATA_MAX_LENGTH 16

Longueur maximale des données de pilotage (octets)

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.