Comisionado
En este módulo, se incluyen funciones para la función de Thread Commissioner.
Resumen
Enumeraciones |
|
---|---|
otCommissionerJoinerEvent
|
enum En esta enumeración se define un evento de Joiner sobre el encargado. |
otCommissionerState{
|
enum En esta enumeración se define el estado como comisionado. |
otJoinerInfoType{
|
enum Esta enumeración define un tipo de información de Joiner. |
Typedefs |
|
---|---|
otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)
|
typedefvoid(*
Se llama a este puntero de función cuando el comisionado recibe un informe de energía. |
otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)
|
typedefvoid(*
Se llama a este puntero de función cada vez que cambia el estado de unión. |
otCommissionerJoinerEvent
|
typedef En esta enumeración se define un evento de Joiner sobre el encargado. |
otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)
|
typedefvoid(*
Se llama a este puntero de función cuando el comisionado recibe un mensaje de conflicto de ID de PAN. |
otCommissionerState
|
typedefenum otCommissionerState
En esta enumeración se define el estado como comisionado. |
otCommissionerStateCallback)(otCommissionerState aState, void *aContext)
|
typedefvoid(*
Se llama a este puntero de función cada vez que cambia el estado de comisión. |
otCommissioningDataset
|
typedefstruct otCommissioningDataset
Esta estructura representa un conjunto de datos Commissioning. |
otJoinerInfo
|
typedefstruct otJoinerInfo
Esta estructura representa la información de Joiner. |
otJoinerInfoType
|
typedefenum otJoinerInfoType
Esta enumeración define un tipo de información de Joiner. |
otJoinerPskd
|
typedefstruct otJoinerPskd
Esta estructura representa una PSKd de Joiner. |
otSteeringData
|
typedefstruct otSteeringData
Esta estructura representa los datos del volante. |
Functions |
|
---|---|
otCommissionerAddJoiner(otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout)
|
Esta función agrega una entrada de Joiner.
|
otCommissionerAddJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout)
|
Esta función agrega una entrada de Joiner con un valor específico de Discerner de Joiner.
|
otCommissionerAnnounceBegin(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress)
|
Esta función envía un mensaje de anuncio de inicio.
|
otCommissionerEnergyScan(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext)
|
Esta función envía un mensaje de búsqueda de Energy Scan.
|
otCommissionerGetId(otInstance *aInstance)
|
const char *
Esta función muestra el ID de comisionado.
|
otCommissionerGetNextJoinerInfo(otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner)
|
Este método obtiene información de la unión en la posición aIterator.
|
otCommissionerGetProvisioningUrl(otInstance *aInstance)
|
const char *
Esta función obtiene la URL de aprovisionamiento.
|
otCommissionerGetSessionId(otInstance *aInstance)
|
uint16_t
Esta función muestra el ID de la sesión de Commissioner.
|
otCommissionerGetState(otInstance *aInstance)
|
Esta función muestra el estado de Comisionado.
|
otCommissionerPanIdQuery(otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext)
|
Esta función envía un mensaje de búsqueda de ID de PAN.
|
otCommissionerRemoveJoiner(otInstance *aInstance, const otExtAddress *aEui64)
|
Esta función quita una entrada de Joiner.
|
otCommissionerRemoveJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner)
|
Esta función quita una entrada de Joiner.
|
otCommissionerSendMgmtGet(otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength)
|
Esta función envía MGMT_COMMISSIONER_GET.
|
otCommissionerSendMgmtSet(otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength)
|
Esta función envía MGMT_COMMISSIONER_SET.
|
otCommissionerSetId(otInstance *aInstance, const char *aId)
|
Esta función establece el ID de comisionado.
|
otCommissionerSetProvisioningUrl(otInstance *aInstance, const char *aProvisioningUrl)
|
Esta función establece la URL de aprovisionamiento.
|
otCommissionerStart(otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext)
|
Esta función habilita la función de Thread Commissioner.
|
otCommissionerStop(otInstance *aInstance)
|
Esta función inhabilita la función de Comisionado de subprocesos.
|
Structs |
|
---|---|
otCommissioningDataset |
Esta estructura representa un conjunto de datos Commissioning. |
otJoinerInfo. |
Esta estructura representa la información de Joiner. |
otJoinerPskd |
Esta estructura representa una PSKd de Joiner. |
OtSteeringData |
Esta estructura representa los datos del volante. |
Enumeraciones
otCommissionerJoinerEvent
otCommissionerJoinerEvent
En esta enumeración se define un evento de Joiner sobre el encargado.
Estado de la comisión
otCommissionerState
En esta enumeración se define el estado como comisionado.
Properties | |
---|---|
OT_COMMISSIONER_STATE_ACTIVE
|
La función de comisionado está activa. |
OT_COMMISSIONER_STATE_DISABLED
|
La función de comisionado está inhabilitada. |
OT_COMMISSIONER_STATE_PETITION
|
Solicitando convertirte en comisionado. |
Tipo de información de unión de ot
otJoinerInfoType
Esta enumeración define un tipo de información de Joiner.
Properties | |
---|---|
OT_JOINER_INFO_TYPE_ANY
|
Acepte cualquier unión (no se especifica EUI64 ni Discerner). |
OT_JOINER_INFO_TYPE_DISCERNER
|
Se especifica el identificador de la unión ( |
OT_JOINER_INFO_TYPE_EUI64
|
Se especificó la unión EUI-64 ( |
Typedefs
otCommissionerEnergyReportCallback
void(* otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)
Se llama a este puntero de función cuando el comisionado recibe un informe de energía.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
otCommissionerJoinerCallback
void(* otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)
Se llama a este puntero de función cada vez que cambia el estado de unión.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
otCommissionerJoinerEvent
enum otCommissionerJoinerEvent otCommissionerJoinerEvent
En esta enumeración se define un evento de Joiner sobre el encargado.
otCommissionerPanIdConflictCallback
void(* otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)
Se llama a este puntero de función cuando el comisionado recibe un mensaje de conflicto de ID de PAN.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
Estado de la comisión
enum otCommissionerState otCommissionerState
En esta enumeración se define el estado como comisionado.
otCommissionerStateCallback
void(* otCommissionerStateCallback)(otCommissionerState aState, void *aContext)
Se llama a este puntero de función cada vez que cambia el estado de comisión.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otCommissioningDataset
struct otCommissioningDataset otCommissioningDataset
Esta estructura representa un conjunto de datos Commissioning.
Tipo de información de unión de ot
enum otJoinerInfoType otJoinerInfoType
Esta enumeración define un tipo de información de Joiner.
otSteeringData
struct otSteeringData otSteeringData
Esta estructura representa los datos del volante.
Functions
otCommissionerAddJoiner
otError otCommissionerAddJoiner( otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout )
Esta función agrega una entrada de Joiner.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||
Valores que se muestran |
|
otCommissionerAddJoinerConDiscerner
otError otCommissionerAddJoinerWithDiscerner( otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout )
Esta función agrega una entrada de Joiner con un valor específico de Discerner de Joiner.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||
Valores que se muestran |
|
Comienzo de la comisión
otError otCommissionerAnnounceBegin( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress )
Esta función envía un mensaje de anuncio de inicio.
Detalles | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||||
Valores que se muestran |
|
otCommissionerEnergyScan
otError otCommissionerEnergyScan( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext )
Esta función envía un mensaje de búsqueda de Energy Scan.
Detalles | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||||||||||
Valores que se muestran |
|
ID de la organización otCommissionerGetId
const char * otCommissionerGetId( otInstance *aInstance )
Esta función muestra el ID de comisionado.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
El ID de comisionado.
|
otCommissionerGetNextJoinerInfo
otError otCommissionerGetNextJoinerInfo( otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner )
Este método obtiene información de la unión en la posición aIterator.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Valores que se muestran |
|
otCommissionerGetProvisioningUrl
const char * otCommissionerGetProvisioningUrl( otInstance *aInstance )
Esta función obtiene la URL de aprovisionamiento.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
Un puntero para la string de la URL.
|
ID de sesión de otCommissionerGetSessionId
uint16_t otCommissionerGetSessionId( otInstance *aInstance )
Esta función muestra el ID de la sesión de Commissioner.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
El ID de la sesión de comisionado actual.
|
otCommissionerGetState
otCommissionerState otCommissionerGetState( otInstance *aInstance )
Esta función muestra el estado de Comisionado.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Valores que se muestran |
|
OtCommissionerPanIdQuery
otError otCommissionerPanIdQuery( otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext )
Esta función envía un mensaje de búsqueda de ID de PAN.
Detalles | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||||||
Valores que se muestran |
|
otCommissionerRemoveJoiner
otError otCommissionerRemoveJoiner( otInstance *aInstance, const otExtAddress *aEui64 )
Esta función quita una entrada de Joiner.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||
Valores que se muestran |
|
otCommissionerRemoveJoinerWithDiscerner
otError otCommissionerRemoveJoinerWithDiscerner( otInstance *aInstance, const otJoinerDiscerner *aDiscerner )
Esta función quita una entrada de Joiner.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||
Valores que se muestran |
|
otCommissionerSendMgmtGet
otError otCommissionerSendMgmtGet( otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength )
Esta función envía MGMT_COMMISSIONER_GET.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Valores que se muestran |
|
otCommissionerSendMgmtSet
otError otCommissionerSendMgmtSet( otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength )
Esta función envía MGMT_COMMISSIONER_SET.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||
Valores que se muestran |
|
ID decomposición de ot
otError otCommissionerSetId( otInstance *aInstance, const char *aId )
Esta función establece el ID de comisionado.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Valores que se muestran |
|
otCommissionerSetProvisioningUrl
otError otCommissionerSetProvisioningUrl( otInstance *aInstance, const char *aProvisioningUrl )
Esta función establece la URL de aprovisionamiento.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Valores que se muestran |
|
Comité de inicio de ot
otError otCommissionerStart( otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext )
Esta función habilita la función de Thread Commissioner.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||
Valores que se muestran |
|
OtCommissionerStop
otError otCommissionerStop( otInstance *aInstance )
Esta función inhabilita la función de Comisionado de subprocesos.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Valores que se muestran |
|
Macros
OT_COMMISSIONING_PASSPHRASE_MAX_SIZE
OT_COMMISSIONING_PASSPHRASE_MAX_SIZE 255
Tamaño máximo de la frase de contraseña de comisión.
OT_COMMISSIONING_PASSPHRASE_MIN_SIZE
OT_COMMISSIONING_PASSPHRASE_MIN_SIZE 6
Tamaño mínimo de la frase de contraseña de comisión.
OT_JOINER_MAX_PSKD_LENGTH
OT_JOINER_MAX_PSKD_LENGTH 32
Longitud máxima de la string de una PSKd de Joiner (no incluye el valor nulo).
OT_PROVISIONING_URL_MAX_SIZE
OT_PROVISIONING_URL_MAX_SIZE 64
Tamaño máximo (cantidad de caracteres) en la string de la URL de aprovisionamiento (no incluye caracteres nulos).
TS_STEERING_DATA_MAX_LENGTH
OT_STEERING_DATA_MAX_LENGTH 16
Longitud máxima de los datos de dirección (bytes)
Recursos
Los temas de referencia de la API de OpenThread se originan en el código fuente, disponible en GitHub. Para obtener más información o colaborar con nuestra documentación, consulta Recursos.