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

le commissaire

Ce module comprend des fonctions pour le rôle de commissaire de thread.

Résumé

Énumérations

otCommissionerJoinerEvent énumération
Cette énumération définit un événement de participation sur le commissaire.
otCommissionerState {
OT_COMMISSIONER_STATE_DISABLED = 0,
OT_COMMISSIONER_STATE_PETITION = 1,
OT_COMMISSIONER_STATE_ACTIVE = 2
}
énumération
Cette énumération définit l'État commissaire.
otJoinerInfoType {
OT_JOINER_INFO_TYPE_ANY = 0,
OT_JOINER_INFO_TYPE_EUI64 = 1,
OT_JOINER_INFO_TYPE_DISCERNER = 2
}
énumération
Cette énumération définit un type d'informations de jointure.

Typedefs

otCommissionerEnergyReportCallback )(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext) typedef
void(*
Ce pointeur de fonction est appelé lorsque le commissaire reçoit un rapport énergétique.
otCommissionerJoinerCallback )(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext) typedef
void(*
Ce pointeur de fonction est appelé chaque fois que l'état de la jointure change.
otCommissionerJoinerEvent typedef
Cette énumération définit un événement de participation sur le commissaire.
otCommissionerPanIdConflictCallback )(uint16_t aPanId, uint32_t aChannelMask, void *aContext) typedef
void(*
Ce pointeur de fonction est appelé lorsque le commissaire reçoit un message de conflit d'ID PAN.
otCommissionerState typedef
Cette énumération définit l'État commissaire.
otCommissionerStateCallback )(otCommissionerState aState, void *aContext) typedef
void(*
Ce pointeur de fonction est appelé chaque fois que l'état du commissaire change.
otCommissioningDataset typedef
Cette structure représente un ensemble de données de mise en service.
otJoinerInfo typedef
struct otJoinerInfo
Cette structure représente une information de joint.
otJoinerInfoType typedef
Cette énumération définit un type d'informations de jointure.
otJoinerPskd typedef
struct otJoinerPskd
Cette structure représente un PSKd Joiner.
otSteeringData typedef
Cette structure représente les données de pilotage.

Les fonctions

otCommissionerAddJoiner ( otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout)
Cette fonction ajoute une entrée Joiner.
otCommissionerAddJoinerWithDiscerner ( otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout)
Cette fonction ajoute une entrée Joiner avec une valeur Joiner Discerner donnée.
otCommissionerAnnounceBegin ( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress)
Cette fonction envoie un message de début d'annonce.
otCommissionerEnergyScan ( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext)
Cette fonction envoie un message de requête d'analyse d'énergie.
otCommissionerGetNextJoinerInfo ( otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner)
Cette méthode obtient des informations de menuisier à la position d'un Itérateur.
otCommissionerGetProvisioningUrl ( otInstance *aInstance)
const char *
Cette fonction obtient l'URL de provisionnement.
otCommissionerGetSessionId ( otInstance *aInstance)
uint16_t
Cette fonction renvoie l'ID de session du commissaire.
otCommissionerGetState ( otInstance *aInstance)
Cette fonction renvoie l'état de commissaire.
otCommissionerPanIdQuery ( otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext)
Cette fonction envoie un message de requête PAN ID.
otCommissionerRemoveJoiner ( otInstance *aInstance, const otExtAddress *aEui64)
Cette fonction supprime une entrée Joiner.
otCommissionerRemoveJoinerWithDiscerner ( otInstance *aInstance, const otJoinerDiscerner *aDiscerner)
Cette fonction supprime une entrée Joiner.
otCommissionerSendMgmtGet ( otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength)
Cette fonction envoie MGMT_COMMISSIONER_GET.
otCommissionerSendMgmtSet ( otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength)
Cette fonction envoie MGMT_COMMISSIONER_SET.
otCommissionerSetProvisioningUrl ( otInstance *aInstance, const char *aProvisioningUrl)
Cette fonction définit l'URL de provisionnement.
otCommissionerStart ( otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext)
Cette fonction active le rôle de commissaire de thread.
otCommissionerStop ( otInstance *aInstance)
Cette fonction désactive le rôle de commissaire de thread.

Structs

otCommissioningDataset

Cette structure représente un ensemble de données de mise en service.

otJoinerInfo

Cette structure représente une information de joint.

otJoinerPskd

Cette structure représente un PSKd Joiner.

otSteeringData

Cette structure représente les données de pilotage.

Énumérations

otCommissionerJoinerEvent

 otCommissionerJoinerEvent

Cette énumération définit un événement de participation sur le commissaire.

otCommissionerState

 otCommissionerState

Cette énumération définit l'État commissaire.

Propriétés
OT_COMMISSIONER_STATE_ACTIVE

Le rôle du commissaire est actif.

OT_COMMISSIONER_STATE_DISABLED

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

OT_COMMISSIONER_STATE_PETITION

Présentement une pétition pour devenir commissaire.

otJoinerInfoType

 otJoinerInfoType

Cette énumération définit un type d'informations de jointure.

Propriétés
OT_JOINER_INFO_TYPE_ANY

Acceptez 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

Joiner EUI-64 est spécifié ( mSharedId.mEui64 dans otJoinerInfo ).

Typedefs

otCommissionerEnergyReportCallback

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

Ce pointeur de fonction est appelé lorsque le commissaire reçoit un rapport énergétique.

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

otCommissionerJoinerCallback

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

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

Détails
Paramètres
[in] aEvent
Le type d'événement de joint.
[in] aJoinerInfo
Un pointeur vers les informations de jointure.
[in] aJoinerId
Un pointeur vers l'ID du joint (s'il n'est pas connu, il sera NULL).
[in] aContext
Un pointeur vers le contexte spécifique à l'application.

otCommissionerJoinerEvent

enum otCommissionerJoinerEvent otCommissionerJoinerEvent

Cette énumération définit un événement de participation sur le commissaire.

otCommissionerPanIdConflictCallback

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

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

Détails
Paramètres
[in] aPanId
La valeur de l'ID PAN.
[in] aChannelMask
La valeur du masque de canal.
[in] aContext
Un pointeur vers le contexte spécifique à l'application.

otCommissionerState

enum otCommissionerState otCommissionerState

Cette énumération définit l'État commissaire.

otCommissionerStateCallback

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

Ce pointeur de fonction est appelé chaque fois que l'état du commissaire change.

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

otCommissioningDataset

struct otCommissioningDataset otCommissioningDataset

Cette structure représente un ensemble de données de mise en service.

otJoinerInfo

struct otJoinerInfo otJoinerInfo

Cette structure représente une information de joint.

otJoinerInfoType

enum otJoinerInfoType otJoinerInfoType

Cette énumération définit un type d'informations de jointure.

otJoinerPskd

struct otJoinerPskd otJoinerPskd

Cette structure représente un PSKd Joiner.

otSteeringData

struct otSteeringData otSteeringData

Cette structure représente les données de pilotage.

Les fonctions

otCommissionerAddJoiner

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

Cette fonction ajoute une entrée Joiner.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aEui64
Un pointeur vers IEEE EUI-64 du Joiner ou NULL pour tout Joiner.
[in] aPskd
Un pointeur vers le PSKd.
[in] aTimeout
Un temps après lequel un Joiner est automatiquement supprimé, en secondes.
Valeurs de retour
OT_ERROR_NONE
Ajout réussi du Joiner.
OT_ERROR_NO_BUFS
Aucun tampon disponible pour ajouter le 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
)

Cette fonction ajoute une entrée Joiner avec une valeur Joiner Discerner donnée.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aDiscerner
Un pointeur vers le Joiner Discerner.
[in] aPskd
Un pointeur vers le PSKd.
[in] aTimeout
Un temps après lequel un Joiner est automatiquement supprimé, en secondes.
Valeurs de retour
OT_ERROR_NONE
Ajout réussi du Joiner.
OT_ERROR_NO_BUFS
Aucun tampon disponible pour ajouter le 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
)

Cette fonction envoie un message de début d'annonce.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aChannelMask
La valeur du masque de canal.
[in] aCount
Le nombre de messages d'annonce par canal.
[in] aPeriod
Le temps entre deux transmissions d'annonce MLE successives (en millisecondes).
[in] aAddress
Un pointeur vers la destination IPv6.
Valeurs de retour
OT_ERROR_NONE
Mise en file d'attente du message de début d'annonce.
OT_ERROR_NO_BUFS
Tampons insuffisants pour générer un message de début d'annonce.
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
)

Cette fonction envoie un message de requête d'analyse d'énergie.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aChannelMask
La valeur du masque de canal.
[in] aCount
Le nombre de mesures d'énergie par canal.
[in] aPeriod
Le temps entre les mesures d'énergie (millisecondes).
[in] aScanDuration
La durée du balayage pour chaque mesure d'énergie (millisecondes).
[in] aAddress
Un pointeur vers la destination IPv6.
[in] aCallback
Un pointeur vers une fonction appelée lors de la réception d'un message Energy Report.
[in] aContext
Un pointeur vers le contexte spécifique à l'application.
Valeurs de retour
OT_ERROR_NONE
Mise en file d'attente réussie du message de requête d'analyse énergétique.
OT_ERROR_NO_BUFS
Tampons insuffisants pour générer un message de requête d'analyse énergétique.
OT_ERROR_INVALID_STATE
Le commissaire n'est pas actif.

otCommissionerGetNextJoinerInfo

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

Cette méthode obtient des informations de menuisier à la position d'un Itérateur.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance.
[in,out] aIterator
Un pointeur vers le contexte de l'itérateur Joiner Info.
[out] aJoiner
Une référence aux informations de menuisier.
Valeurs de retour
OT_ERROR_NONE
Obtention réussie des informations sur le participant.
OT_ERROR_NOT_FOUND
Non trouvé prochain Joiner.

otCommissionerGetProvisioningUrl

const char * otCommissionerGetProvisioningUrl(
  otInstance *aInstance
)

Cette fonction obtient l'URL de provisionnement.

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

otCommissionerGetSessionId

uint16_t otCommissionerGetSessionId(
  otInstance *aInstance
)

Cette fonction renvoie l'ID de session du commissaire.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
Retour
L'ID de session du commissaire en cours.

otCommissionerGetState

 otCommissionerState otCommissionerGetState(
  otInstance *aInstance
)

Cette fonction renvoie l'état de commissaire.

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

otCommissionerPanIdQuery

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

Cette fonction envoie un message de requête PAN ID.

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

otCommissionerRemoveJoiner

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

Cette fonction supprime une entrée Joiner.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aEui64
Un pointeur vers IEEE EUI-64 du Joiner ou NULL pour tout Joiner.
Valeurs de retour
OT_ERROR_NONE
Suppression réussie du Joiner.
OT_ERROR_NOT_FOUND
Le aEui64 spécifié par aEui64 est introuvable.
OT_ERROR_INVALID_ARGS
aEui64 n'est pas valide.
OT_ERROR_INVALID_STATE
Le commissaire n'est pas actif.

otCommissionerRemoveJoinerWithDiscerner

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

Cette fonction supprime une entrée Joiner.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aEui64
Un pointeur vers le Joiner Discerner.
Valeurs de retour
OT_ERROR_NONE
Suppression réussie du Joiner.
OT_ERROR_NOT_FOUND
Le aEui64 spécifié par aEui64 est introuvable.
OT_ERROR_INVALID_ARGS
aDiscerner n'est pas valide.
OT_ERROR_INVALID_STATE
Le commissaire n'est pas actif.

otCommissionerSendMgmtGet

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

Cette fonction envoie MGMT_COMMISSIONER_GET.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aTlvs
Un pointeur vers les TLV.
[in] aLength
La longueur des TLV.
Valeurs de retour
OT_ERROR_NONE
Envoyez avec succès la commande de l'ensemble de données meshcop.
OT_ERROR_NO_BUFS
Espace tampon insuffisant pour l'envoi.
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
)

Cette fonction envoie MGMT_COMMISSIONER_SET.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aDataset
Un pointeur vers l'ensemble de données de mise en service.
[in] aTlvs
Un pointeur vers les TLV.
[in] aLength
La longueur des TLV.
Valeurs de retour
OT_ERROR_NONE
Envoyez avec succès la commande de l'ensemble de données meshcop.
OT_ERROR_NO_BUFS
Espace tampon insuffisant pour l'envoi.
OT_ERROR_INVALID_STATE
Le commissaire n'est pas actif.

otCommissionerSetProvisioningUrl

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

Cette fonction définit l'URL de provisionnement.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aProvisioningUrl
Un pointeur vers l'URL de provisioning (peut être NULL pour définir comme chaîne vide).
Valeurs de retour
OT_ERROR_NONE
Définissez avec succès l'URL de provisionnement.
OT_ERROR_INVALID_ARGS
aProvisioningUrl n'est pas valide (trop long).

otCommissionerStart

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

Cette fonction active le rôle de commissaire de thread.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aStateCallback
Un pointeur vers une fonction qui est 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
Un pointeur vers le contexte spécifique à l'application.
Valeurs de retour
OT_ERROR_NONE
Démarrage réussi du service des commissaires.
OT_ERROR_ALREADY
Le commissaire est déjà commencé.
OT_ERROR_INVALID_STATE
L'appareil n'est actuellement pas connecté à un réseau.

otCommissionerStop

 otError otCommissionerStop(
  otInstance *aInstance
)

Cette fonction désactive le rôle de commissaire de thread.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
Valeurs de retour
OT_ERROR_NONE
Arrêt réussi du service des commissaires.
OT_ERROR_ALREADY
Le commissaire est déjà arrêté.

Macros

OT_COMMISSIONING_PASSPHRASE_MAX_SIZE

 OT_COMMISSIONING_PASSPHRASE_MAX_SIZE 255

Taille maximale de la phrase de passe de mise en service.

OT_COMMISSIONING_PASSPHRASE_MIN_SIZE

 OT_COMMISSIONING_PASSPHRASE_MIN_SIZE 6

Taille minimale de la phrase de passe de mise en service.

OT_JOINER_MAX_PSKD_LENGTH

 OT_JOINER_MAX_PSKD_LENGTH 32

Longueur de chaîne maximale d'un joint PSKd (n'inclut pas de 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 provisioning (exclut le caractère nul).

OT_STEERING_DATA_MAX_LENGTH

 OT_STEERING_DATA_MAX_LENGTH 16

Longueur maximale des données de direction (octets)