Comisionado
Este módulo incluye funciones para el rol de Comisionado de subprocesos.
Resumen
Enumeraciones |
|
---|---|
otCommissionerJoinerEvent
|
Enum Define un evento de Joiner en el Comisionado. |
otCommissionerState{
|
Enum Define el estado del comisionado. |
otJoinerInfoType{
|
Enum 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 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 de Joiner en el Comisionado. |
otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)
|
typedefvoid(*
Se llama al puntero cuando el comisionado recibe un mensaje de conflicto de ID de PAN. |
otCommissionerState
|
typedefenum otCommissionerState
Define el estado del 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 Joiner. |
otJoinerPskd
|
typedefstruct otJoinerPskd
Representa un PSKd de Joiner. |
otSteeringData
|
typedefstruct otSteeringData
Representa los datos de la dirección. |
Funciones |
|
---|---|
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 específico de Disterner de Joiner.
|
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 búsqueda de energía.
|
otCommissionerGetId(otInstance *aInstance)
|
const char *
Muestra el ID del comisionado.
|
otCommissionerGetNextJoinerInfo(otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner)
|
Obtenga información de unedores 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 comisión.
|
otCommissionerPanIdQuery(otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext)
|
Envía un mensaje de consulta de ID de 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 del comisionado.
|
otCommissionerSetProvisioningUrl(otInstance *aInstance, const char *aProvisioningUrl)
|
Establece la URL de aprovisionamiento.
|
otCommissionerStart(otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext)
|
Habilita la función de Thread Commissioner.
|
otCommissionerStop(otInstance *aInstance)
|
Inhabilita el rol Comisionado de subprocesos.
|
Structs |
|
---|---|
OtCommissioningDataset |
Representa un conjunto de datos de comisión. |
OtJoinerInfo. |
Representa una información de unión. |
otJoinerPskd. |
Representa un PSKd de Joiner. |
OtSteeringData |
Representa los datos de la dirección. |
Enumeraciones
otCommissionerJoinerEvent
otCommissionerJoinerEvent
Define un evento de Joiner en el Comisionado.
Estado de comisión
otCommissionerState
Define el estado del comisionado.
Propiedades | |
---|---|
OT_COMMISSIONER_STATE_ACTIVE
|
El rol de comisionado está activo. |
OT_COMMISSIONER_STATE_DISABLED
|
La función de comisionado está inhabilitada. |
OT_COMMISSIONER_STATE_PETITION
|
Actualmente petición para convertirte en Comisionada. |
Tipo de información de unión del ot
otJoinerInfoType
Define un tipo de información de Joiner.
Propiedades | |
---|---|
OT_JOINER_INFO_TYPE_ANY
|
Acepta cualquier unión (no se especifica EUI64 ni Discerner). |
OT_JOINER_INFO_TYPE_DISCERNER
|
Se especifica el Disparador de unión ( |
OT_JOINER_INFO_TYPE_EUI64
|
Se especifica el unión EUI-64 ( |
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 de Joiner en el Comisionado.
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 de 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.
Tipo de información de unión del ot
enum otJoinerInfoType otJoinerInfoType
Define un tipo de información de Joiner.
Funciones
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 específico de Disterner de Joiner.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||
Valores que se muestran |
|
Comisionado de anuncios
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 búsqueda de energía.
Detalles | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||||||||||
Valores que se muestran |
|
otCommissionerGetId
const char * otCommissionerGetId( otInstance *aInstance )
Muestra el ID del comisionado.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
El ID del comisionado.
|
otCommissionerGetNextJoinerInfo
otError otCommissionerGetNextJoinerInfo( otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner )
Obtenga información de unedores 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 la 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 del comisionado actual.
|
otCommissionerGetState
otCommissionerState otCommissionerGetState( otInstance *aInstance )
Muestra el estado de comisión.
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 de ID de 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 |
|
ID de comisión de Ot
otError otCommissionerSetId( otInstance *aInstance, const char *aId )
Establece el ID del comisionado.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Valores que se muestran |
|
otCommissionerSetProvisioningUrl
otError otCommissionerSetProvisioningUrl( otInstance *aInstance, const char *aProvisioningUrl )
Establece la URL de aprovisionamiento.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Valores que se muestran |
|
Comisionado inicial
otError otCommissionerStart( otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext )
Habilita la función de Thread Commissioner.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||
Valores que se muestran |
|
otCommissionerStop
otError otCommissionerStop( otInstance *aInstance )
Inhabilita el rol Comisionado de subprocesos.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Valores que se muestran |
|
Macros
TS_COMMISSIONING_PASSPHRASE_MAX_SIZE
OT_COMMISSIONING_PASSPHRASE_MAX_SIZE 255
Tamaño máximo de la frase de contraseña de comisión.
TS_COMMISSIONING_PASSPHRASE_MIN_SIZE
OT_COMMISSIONING_PASSPHRASE_MIN_SIZE 6
Tamaño mínimo de la frase de contraseña de comisión.
TS_JOINER_MAX_PSKD_LENGTH
OT_JOINER_MAX_PSKD_LENGTH 32
Longitud máxima de la string de un PSKd de Joiner (no incluye un carácter nulo).
PO_PROVISIONING_URL_MAX_SIZE
OT_PROVISIONING_URL_MAX_SIZE 64
Tamaño máximo (número de caracteres) en la cadena de URL de aprovisionamiento (no se incluye el carácter nulo).
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 a partir del código fuente, disponible en GitHub. Para obtener más información o colaborar con nuestra documentación, consulta la sección Recursos.