Comissário
Este módulo inclui funções para a função de Comissário de Tópicos.
Resumo
Enumerações | |
---|---|
otCommissionerJoinerEvent | enumerar Esta enumeração define um evento Joiner no Comissário. |
otCommissionerState { | enumerar Esta enumeração define o Estado Comissário. |
otJoinerInfoType { | enumerar Essa enumeração define um tipo de informações do Joiner. |
Typedefs | |
---|---|
otCommissionerEnergyReportCallback )(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext) | typedefvoid(* Este ponteiro de função é chamado quando o Comissário recebe um Relatório de Energia. |
otCommissionerJoinerCallback )(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext) | typedefvoid(* Este ponteiro de função é chamado sempre que o estado do joiner muda. |
otCommissionerJoinerEvent | typedef Esta enumeração define um evento Joiner no Comissário. |
otCommissionerPanIdConflictCallback )(uint16_t aPanId, uint32_t aChannelMask, void *aContext) | typedefvoid(* Este ponteiro de função é chamado quando o Comissário recebe uma mensagem PAN ID Conflict. |
otCommissionerState | typedefenum otCommissionerState Esta enumeração define o Estado Comissário. |
otCommissionerStateCallback )(otCommissionerState aState, void *aContext) | typedefvoid(* Este ponteiro de função é chamado sempre que o estado do comissário muda. |
otCommissioningDataset | typedefstruct otCommissioningDataset Essa estrutura representa um conjunto de dados de comissionamento. |
otJoinerInfo | typedefstruct otJoinerInfo Essa estrutura representa um Joiner Info. |
otJoinerInfoType | typedefenum otJoinerInfoType Essa enumeração define um tipo de informações do Joiner. |
otJoinerPskd | typedefstruct otJoinerPskd Esta estrutura representa um Joiner PSKd. |
otSteeringData | typedefstruct otSteeringData Essa estrutura representa os dados de direção. |
Funções | |
---|---|
otCommissionerAddJoiner ( otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout) | Esta função adiciona uma entrada Joiner. |
otCommissionerAddJoinerWithDiscerner ( otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout) | Esta função adiciona uma entrada de Joiner com um determinado valor de Joiner Discerner. |
otCommissionerAnnounceBegin ( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress) | Esta função envia uma mensagem Announce Begin. |
otCommissionerEnergyScan ( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext) | Esta função envia uma mensagem Energy Scan Query. |
otCommissionerGetId ( otInstance *aInstance) | const char * Esta função retorna o ID do Comissário. |
otCommissionerGetNextJoinerInfo ( otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner) | Este método obtém informações do joiner na posição aIterator. |
otCommissionerGetProvisioningUrl ( otInstance *aInstance) | const char * Essa função obtém a URL de provisionamento. |
otCommissionerGetSessionId ( otInstance *aInstance) | uint16_t Esta função retorna o ID da Sessão do Comissário. |
otCommissionerGetState ( otInstance *aInstance) | Esta função retorna o Estado do Comissário. |
otCommissionerPanIdQuery ( otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext) | Esta função envia uma mensagem PAN ID Query. |
otCommissionerRemoveJoiner ( otInstance *aInstance, const otExtAddress *aEui64) | Esta função remove uma entrada do Joiner. |
otCommissionerRemoveJoinerWithDiscerner ( otInstance *aInstance, const otJoinerDiscerner *aDiscerner) | Esta função remove uma entrada do Joiner. |
otCommissionerSendMgmtGet ( otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength) | Esta função envia MGMT_COMMISSIONER_GET. |
otCommissionerSendMgmtSet ( otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength) | Esta função envia MGMT_COMMISSIONER_SET. |
otCommissionerSetId ( otInstance *aInstance, const char *aId) | Esta função define o ID do Comissário. |
otCommissionerSetProvisioningUrl ( otInstance *aInstance, const char *aProvisioningUrl) | Essa função define a URL de provisionamento. |
otCommissionerStart ( otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext) | Esta função habilita a função Thread Commissioner. |
otCommissionerStop ( otInstance *aInstance) | Esta função desativa a função Thread Commissioner. |
Estruturas | |
---|---|
otCommissioningDataset | Essa estrutura representa um conjunto de dados de comissionamento. |
otJoinerInfo | Essa estrutura representa um Joiner Info. |
otJoinerPskd | Esta estrutura representa um Joiner PSKd. |
otSteeringData | Essa estrutura representa os dados de direção. |
Enumerações
otCommissionerJoinerEvent
otCommissionerJoinerEvent
Esta enumeração define um evento Joiner no Comissário.
otCommissionerState
otCommissionerState
otJoinerInfoType
otJoinerInfoType
Essa enumeração define um tipo de informações do Joiner.
Propriedades | |
---|---|
OT_JOINER_INFO_TYPE_ANY | Aceite qualquer Joiner (nenhum EUI64 ou Discerner é especificado). |
OT_JOINER_INFO_TYPE_DISCERNER | O Joiner Discerner é especificado ( |
OT_JOINER_INFO_TYPE_EUI64 | O Joiner EUI-64 é especificado ( |
Typedefs
otCommissionerEnergyReportCallback
void(* otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)
Este ponteiro de função é chamado quando o Comissário recebe um Relatório de Energia.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
otCommissionerJoinerCallback
void(* otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)
Este ponteiro de função é chamado sempre que o estado do joiner muda.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
otCommissionerJoinerEvent
enum otCommissionerJoinerEvent otCommissionerJoinerEvent
Esta enumeração define um evento Joiner no Comissário.
otCommissionerPanIdConflictCallback
void(* otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)
Este ponteiro de função é chamado quando o Comissário recebe uma mensagem PAN ID Conflict.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
otCommissionerState
enum otCommissionerState otCommissionerState
Esta enumeração define o Estado Comissário.
otCommissionerStateCallback
void(* otCommissionerStateCallback)(otCommissionerState aState, void *aContext)
Este ponteiro de função é chamado sempre que o estado do comissário muda.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
otCommissioningDataset
struct otCommissioningDataset otCommissioningDataset
Essa estrutura representa um conjunto de dados de comissionamento.
otJoinerInfoType
enum otJoinerInfoType otJoinerInfoType
Essa enumeração define um tipo de informações do Joiner.
Funções
otCommissionerAddJoiner
otError otCommissionerAddJoiner( otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout )
Esta função adiciona uma entrada Joiner.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||||
Valores de retorno |
|
otCommissionerAddJoinerWithDiscerner
otError otCommissionerAddJoinerWithDiscerner( otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout )
Esta função adiciona uma entrada de Joiner com um determinado valor de Joiner Discerner.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||||
Valores de retorno |
|
otComissionerAnnounceBegin
otError otCommissionerAnnounceBegin( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress )
Esta função envia uma mensagem Announce Begin.
Detalhes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||||||
Valores de retorno |
|
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 função envia uma mensagem Energy Scan Query.
Detalhes | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||||||||||||
Valores de retorno |
|
otCommissionerGetId
const char * otCommissionerGetId( otInstance *aInstance )
Esta função retorna o ID do Comissário.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Devoluções | A identificação do comissário. |
otCommissionerGetNextJoinerInfo
otError otCommissionerGetNextJoinerInfo( otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner )
Este método obtém informações do joiner na posição aIterator.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||
Valores de retorno |
|
otCommissionerGetProvisioningUrl
const char * otCommissionerGetProvisioningUrl( otInstance *aInstance )
Essa função obtém a URL de provisionamento.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Devoluções | Um ponteiro para a string de URL. |
otCommissionerGetSessionId
uint16_t otCommissionerGetSessionId( otInstance *aInstance )
Esta função retorna o ID da Sessão do Comissário.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Devoluções | O ID da sessão do comissário atual. |
otCommissionerGetState
otCommissionerState otCommissionerGetState( otInstance *aInstance )
Esta função retorna o Estado do Comissário.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||
Valores de retorno |
|
otCommissionerPanIdQuery
otError otCommissionerPanIdQuery( otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext )
Esta função envia uma mensagem PAN ID Query.
Detalhes | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||||||||
Valores de retorno |
|
otCommissionerRemoveJoiner
otError otCommissionerRemoveJoiner( otInstance *aInstance, const otExtAddress *aEui64 )
Esta função remove uma entrada do Joiner.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||||
Valores de retorno |
|
otCommissionerRemoveJoinerWithDiscerner
otError otCommissionerRemoveJoinerWithDiscerner( otInstance *aInstance, const otJoinerDiscerner *aDiscerner )
Esta função remove uma entrada do Joiner.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||||
Valores de retorno |
|
otCommissionerSendMgmtGet
otError otCommissionerSendMgmtGet( otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength )
Esta função envia MGMT_COMMISSIONER_GET.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||
Valores de retorno |
|
otCommissionerSendMgmtSet
otError otCommissionerSendMgmtSet( otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength )
Esta função envia MGMT_COMMISSIONER_SET.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||||
Valores de retorno |
|
otCommissionerSetId
otError otCommissionerSetId( otInstance *aInstance, const char *aId )
Esta função define o ID do Comissário.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||
Valores de retorno |
|
otCommissionerSetProvisioningUrl
otError otCommissionerSetProvisioningUrl( otInstance *aInstance, const char *aProvisioningUrl )
Essa função define a URL de provisionamento.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
| ||||
Valores de retorno |
|
otCommissionerStart
otError otCommissionerStart( otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext )
Esta função habilita a função Thread Commissioner.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||||
Valores de retorno |
|
otCommissionerStop
otError otCommissionerStop( otInstance *aInstance )
Esta função desativa a função Thread Commissioner.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
| ||||
Valores de retorno |
|
Macros
OT_COMMISSIONING_PASSPHRASE_MAX_SIZE
OT_COMMISSIONING_PASSPHRASE_MAX_SIZE 255
Tamanho máximo da senha de comissionamento.
OT_COMMISSIONING_PASSPHRASE_MIN_SIZE
OT_COMMISSIONING_PASSPHRASE_MIN_SIZE 6
Tamanho mínimo da senha de comissionamento.
OT_JOINER_MAX_PSKD_LENGTH
OT_JOINER_MAX_PSKD_LENGTH 32
Comprimento máximo da string de um Joiner PSKd (não inclui caractere nulo).
OT_PROVISIONING_URL_MAX_SIZE
OT_PROVISIONING_URL_MAX_SIZE 64
Tamanho máximo (número de caracteres) na string de URL de provisionamento (exclui caractere nulo).
OT_STEERING_DATA_MAX_LENGTH
OT_STEERING_DATA_MAX_LENGTH 16
Comprimento máximo dos dados de direção (bytes)
Recursos
Os tópicos de referência da API OpenThread se originam do código-fonte, disponível no GitHub . Para obter mais informações ou contribuir com nossa documentação, consulte Recursos .