Comisionado
En este módulo, se incluyen funciones para el rol de Thread Commissioner.
Resumen
Enumeraciones |
|
---|---|
otCommissionerJoinerEvent
|
enum Define un evento Joiner en el Commissioner. |
otCommissionerState{
|
enum Define el estado de comisionado. |
otJoinerInfoType{
|
enum Define un tipo de información de unión. |
Typedefs |
|
---|---|
otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)
|
typedefvoid(*
Se llama al puntero cuando el comisionado recibe un Informe de energía. |
otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)
|
typedefvoid(*
Se llama al puntero cada vez que cambia el estado de la unión. |
otCommissionerJoinerEvent
|
typedef Define un evento Joiner en el Commissioner. |
otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)
|
typedefvoid(*
Se llama al puntero cuando el comisionado recibe un mensaje de conflicto de ID del PAN. |
otCommissionerState
|
typedefenum otCommissionerState
Define el estado de comisionado. |
otCommissionerStateCallback)(otCommissionerState aState, void *aContext)
|
typedefvoid(*
Se llama al puntero cada vez que cambia el estado del comisionado. |
otCommissioningDataset
|
typedefstruct otCommissioningDataset
Representa un conjunto de datos de comisión. |
otJoinerInfo
|
typedefstruct otJoinerInfo
Representa una información de unión. |
otJoinerInfoType
|
typedefenum otJoinerInfoType
Define un tipo de información de unión. |
otJoinerPskd
|
typedefstruct otJoinerPskd
Representa una PSKd de unión. |
otSteeringData
|
typedefstruct otSteeringData
Representa los datos del volante. |
remotas |
|
---|---|
otCommissionerAddJoiner(otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout)
|
Agrega una entrada de Joiner.
|
otCommissionerAddJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout)
|
Agrega una entrada de Joiner con un valor determinado de Joiner Discerner.
|
otCommissionerAnnounceBegin(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress)
|
Envía un mensaje de inicio del anuncio.
|
otCommissionerEnergyScan(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext)
|
Envía un mensaje de consulta de análisis de energía.
|
otCommissionerGetId(otInstance *aInstance)
|
const char *
Muestra el ID de Commissioner.
|
otCommissionerGetNextJoinerInfo(otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner)
|
Obtén información de la unión en la posición aIterator.
|
otCommissionerGetProvisioningUrl(otInstance *aInstance)
|
const char *
Obtiene la URL de aprovisionamiento.
|
otCommissionerGetSessionId(otInstance *aInstance)
|
uint16_t
Muestra el ID de sesión del comisionado.
|
otCommissionerGetState(otInstance *aInstance)
|
Muestra el estado de comisionado.
|
otCommissionerPanIdQuery(otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext)
|
Envía un mensaje de consulta del ID del PAN.
|
otCommissionerRemoveJoiner(otInstance *aInstance, const otExtAddress *aEui64)
|
Quita una entrada de Joiner.
|
otCommissionerRemoveJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner)
|
Quita una entrada de Joiner.
|
otCommissionerSendMgmtGet(otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength)
|
Envía MGMT_COMMISSIONER_GET.
|
otCommissionerSendMgmtSet(otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength)
|
Envía MGMT_COMMISSIONER_SET.
|
otCommissionerSetId(otInstance *aInstance, const char *aId)
|
Establece el ID de comisionado.
|
otCommissionerSetProvisioningUrl(otInstance *aInstance, const char *aProvisioningUrl)
|
Configura la URL de aprovisionamiento.
|
otCommissionerStart(otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext)
|
Habilita el rol Thread Commissioner.
|
otCommissionerStop(otInstance *aInstance)
|
Inhabilita el rol Thread Commissioner.
|
Structs |
|
---|---|
otCommissioningDataset |
Representa un conjunto de datos de comisión. |
otJoinerInfo |
Representa una información de unión. |
otJoinerPskd |
Representa una PSKd de unión. |
otSteeringData |
Representa los datos del volante. |
Enumeraciones
otCommissionerJoinerEvent
otCommissionerJoinerEvent
Define un evento Joiner en el Commissioner.
otCommissionerState
otCommissionerState
Define el estado de comisionado.
Propiedades | |
---|---|
OT_COMMISSIONER_STATE_ACTIVE
|
El rol de comisionado está activo. |
OT_COMMISSIONER_STATE_DISABLED
|
El rol de comisionado está inhabilitado. |
OT_COMMISSIONER_STATE_PETITION
|
Actualmente solicita convertirse en Comisionado. |
otJoinerInfoType
otJoinerInfoType
Define un tipo de información de unión.
Propiedades | |
---|---|
OT_JOINER_INFO_TYPE_ANY
|
Aceptar cualquier Joiner (no se especifica EUI64 ni Discerner). |
OT_JOINER_INFO_TYPE_DISCERNER
|
Se especificó el algoritmo de unión ( |
OT_JOINER_INFO_TYPE_EUI64
|
Se especificó el EUI-64 de unión ( |
Typedefs
otCommissionerEnergyReportCallback
void(* otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)
Se llama al puntero 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 al puntero cada vez que cambia el estado de la unión.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
otCommissionerJoinerEvent
enum otCommissionerJoinerEvent otCommissionerJoinerEvent
Define un evento Joiner en el Commissioner.
otCommissionerPanIdConflictCallback
void(* otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)
Se llama al puntero cuando el comisionado recibe un mensaje de conflicto de ID del PAN.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
otCommissionerStateCallback
void(* otCommissionerStateCallback)(otCommissionerState aState, void *aContext)
Se llama al puntero cada vez que cambia el estado del comisionado.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otCommissioningDataset
struct otCommissioningDataset otCommissioningDataset
Representa un conjunto de datos de comisión.
remotas
otCommissionerAddJoiner
otError otCommissionerAddJoiner(
otInstance *aInstance,
const otExtAddress *aEui64,
const char *aPskd,
uint32_t aTimeout
)
Agrega una entrada de Joiner.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||
Valores que se muestran |
|
otCommissionerAddJoinerWithDiscerner
otError otCommissionerAddJoinerWithDiscerner(
otInstance *aInstance,
const otJoinerDiscerner *aDiscerner,
const char *aPskd,
uint32_t aTimeout
)
Agrega una entrada de Joiner con un valor determinado de Joiner Discerner.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||
Valores que se muestran |
|
otCommissionerAnnounceBegin
otError otCommissionerAnnounceBegin(
otInstance *aInstance,
uint32_t aChannelMask,
uint8_t aCount,
uint16_t aPeriod,
const otIp6Address *aAddress
)
Envía un mensaje de inicio del anuncio.
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
)
Envía un mensaje de consulta de análisis de energía.
Detalles | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||||||||||
Valores que se muestran |
|
otCommissionerGetId
const char * otCommissionerGetId(
otInstance *aInstance
)
Muestra el ID de Commissioner.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
El ID de comisionado
|
otCommissionerGetNextJoinerInfo
otError otCommissionerGetNextJoinerInfo(
otInstance *aInstance,
uint16_t *aIterator,
otJoinerInfo *aJoiner
)
Obtén información de la unión en la posición aIterator.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Valores que se muestran |
|
otCommissionerGetProvisioningUrl
const char * otCommissionerGetProvisioningUrl(
otInstance *aInstance
)
Obtiene la URL de aprovisionamiento.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
Un puntero para la string de URL.
|
otCommissionerGetSessionId
uint16_t otCommissionerGetSessionId(
otInstance *aInstance
)
Muestra el ID de sesión del comisionado.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
El ID de sesión actual del comisionado.
|
otCommissionerGetState
otCommissionerState otCommissionerGetState(
otInstance *aInstance
)
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
)
Envía un mensaje de consulta del ID del PAN.
Detalles | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||||||
Valores que se muestran |
|
otCommissionerRemoveJoiner
otError otCommissionerRemoveJoiner(
otInstance *aInstance,
const otExtAddress *aEui64
)
Quita una entrada de Joiner.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||
Valores que se muestran |
|
otCommissionerRemoveJoinerWithDiscerner
otError otCommissionerRemoveJoinerWithDiscerner(
otInstance *aInstance,
const otJoinerDiscerner *aDiscerner
)
Quita una entrada de Joiner.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||
Valores que se muestran |
|
otCommissionerSendMgmtGet
otError otCommissionerSendMgmtGet(
otInstance *aInstance,
const uint8_t *aTlvs,
uint8_t aLength
)
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
)
Envía MGMT_COMMISSIONER_SET.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||
Valores que se muestran |
|
otCommissionerSetId
otError otCommissionerSetId(
otInstance *aInstance,
const char *aId
)
Establece el ID de comisionado.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Valores que se muestran |
|
otCommissionerSetProvisioningUrl
otError otCommissionerSetProvisioningUrl(
otInstance *aInstance,
const char *aProvisioningUrl
)
Configura la URL de aprovisionamiento.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Valores que se muestran |
|
otCommissionerStart
otError otCommissionerStart(
otInstance *aInstance,
otCommissionerStateCallback aStateCallback,
otCommissionerJoinerCallback aJoinerCallback,
void *aCallbackContext
)
Habilita el rol Thread Commissioner.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||
Valores que se muestran |
|
otCommissionerStop
otError otCommissionerStop(
otInstance *aInstance
)
Inhabilita el rol Thread Commissioner.
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 un PSKd de Joiner (no incluye los caracteres nulos).
OT_PROVISIONING_URL_MAX_SIZE
OT_PROVISIONING_URL_MAX_SIZE 64
Tamaño máximo (cantidad de caracteres) de la string de la URL de aprovisionamiento (no incluye los caracteres nulos).
OT_STEERING_DATA_MAX_LENGTH
OT_STEERING_DATA_MAX_LENGTH 16
Longitud máxima de los datos de direccionamiento (bytes)
Recursos
Los temas de referencia de la API de OpenThread se originan a partir del código fuente, disponible en GitHub. Para obtener más información o contribuir a nuestra documentación, consulta Recursos.