Comissionário
Este módulo inclui funções para o papel Thread Commissioner.
Resumo
Enumerações |
|
---|---|
otCommissionerJoinerEvent
|
tipo enumerado Esta enumeração define um evento do combinador no comissário. |
otCommissionerState{
|
tipo enumerado Esta enumeração define o estado "Comissário". |
otJoinerInfoType{
|
tipo enumerado Esta enumeração define um tipo de informação do combinador. |
Typedefs |
|
---|---|
otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)
|
typedefvoid(*
Esse ponteiro de função é chamado quando o comissionador recebe um relatório de energia. |
otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)
|
typedefvoid(*
Esse ponteiro de função é chamado sempre que o estado do combinador muda. |
otCommissionerJoinerEvent
|
typedef Esta enumeração define um evento do combinador no comissário. |
otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)
|
typedefvoid(*
Esse ponteiro de função é chamado quando o comissário recebe uma mensagem de conflito de ID do PAN. |
otCommissionerState
|
typedefenum otCommissionerState
Esta enumeração define o estado "Comissário". |
otCommissionerStateCallback)(otCommissionerState aState, void *aContext)
|
typedefvoid(*
Esse ponteiro de função é chamado sempre que o estado do encarregado é alterado. |
otCommissioningDataset
|
typedefstruct otCommissioningDataset
Essa estrutura representa um conjunto de dados de comissionamento. |
otJoinerInfo
|
typedefstruct otJoinerInfo
Essa estrutura representa uma informação de combinador. |
otJoinerInfoType
|
typedefenum otJoinerInfoType
Esta enumeração define um tipo de informação do combinador. |
otJoinerPskd
|
typedefstruct otJoinerPskd
Essa estrutura representa um PSKd combinador. |
otSteeringData
|
typedefstruct otSteeringData
Essa estrutura representa os dados de direção. |
Functions |
|
---|---|
otCommissionerAddJoiner(otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout)
|
Essa função adiciona uma entrada do Combinador.
|
otCommissionerAddJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout)
|
Essa função adiciona uma entrada do Combinador com um determinado valor do Discerner do combinador.
|
otCommissionerAnnounceBegin(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress)
|
Essa função envia uma mensagem "Anunciar início".
|
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 de consulta de verificação de energia.
|
otCommissionerGetId(otInstance *aInstance)
|
const char *
Essa função retorna o ID do comissário.
|
otCommissionerGetNextJoinerInfo(otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner)
|
Esse método acessa informações do combinador na posição do aiterador.
|
otCommissionerGetProvisioningUrl(otInstance *aInstance)
|
const char *
Essa função recebe o URL de provisionamento.
|
otCommissionerGetSessionId(otInstance *aInstance)
|
uint16_t
Essa função retorna o ID da sessão do Commissioner.
|
otCommissionerGetState(otInstance *aInstance)
|
Essa função retorna o estado "Comissário".
|
otCommissionerPanIdQuery(otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext)
|
Essa função envia uma mensagem de consulta do ID do PAN.
|
otCommissionerRemoveJoiner(otInstance *aInstance, const otExtAddress *aEui64)
|
Essa função remove uma entrada do Combinador.
|
otCommissionerRemoveJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner)
|
Essa função remove uma entrada do Combinador.
|
otCommissionerSendMgmtGet(otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength)
|
Essa função envia MGMT_COMMISSIONER_GET.
|
otCommissionerSendMgmtSet(otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength)
|
Essa função envia MGMT_COMMISSIONER_SET.
|
otCommissionerSetId(otInstance *aInstance, const char *aId)
|
Essa função define o ID de comissário.
|
otCommissionerSetProvisioningUrl(otInstance *aInstance, const char *aProvisioningUrl)
|
Esta função define o URL de provisionamento.
|
otCommissionerStart(otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext)
|
Essa função ativa o papel Thread Commissioner.
|
otCommissionerStop(otInstance *aInstance)
|
Essa função desativa o papel Thread Commissioner.
|
Estruturas |
|
---|---|
otCommissioningDataset (em inglês) |
Essa estrutura representa um conjunto de dados de comissionamento. |
otJoinerInfo (em inglês) |
Essa estrutura representa uma informação de combinador. |
otJoinerPskd (em inglês) |
Essa estrutura representa um PSKd combinador. |
otSteeringData (em inglês) |
Essa estrutura representa os dados de direção. |
Enumerações
OtCommissionerJoinerEvent
otCommissionerJoinerEvent
Esta enumeração define um evento do combinador no comissário.
OtCommissionerState
otCommissionerState
Esta enumeração define o estado "Comissário".
Propriedades | |
---|---|
OT_COMMISSIONER_STATE_ACTIVE
|
O papel de comissário está ativo. |
OT_COMMISSIONER_STATE_DISABLED
|
O papel de comissário está desativado. |
OT_COMMISSIONER_STATE_PETITION
|
A solicitação para se tornar um comissário está em andamento. |
otJoinerInfoType
otJoinerInfoType
Esta enumeração define um tipo de informação do combinador.
Propriedades | |
---|---|
OT_JOINER_INFO_TYPE_ANY
|
Aceitar qualquer Combinador (nenhum EUI64 ou Discerner é especificado). |
OT_JOINER_INFO_TYPE_DISCERNER
|
O Discerner do combinador é especificado ( |
OT_JOINER_INFO_TYPE_EUI64
|
O participante EUI-64 foi especificado ( |
Typedefs
OtCommissionerEnergyReportCallback
void(* otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)
Esse ponteiro de função é chamado quando o comissionador recebe um relatório de energia.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
OtCommissionerJoinerCallback
void(* otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)
Esse ponteiro de função é chamado sempre que o estado do combinador muda.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
OtCommissionerJoinerEvent
enum otCommissionerJoinerEvent otCommissionerJoinerEvent
Esta enumeração define um evento do combinador no comissário.
OtCommissionerPanIdConflictCallback
void(* otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)
Esse ponteiro de função é chamado quando o comissário recebe uma mensagem de conflito de ID do PAN.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
OtCommissionerState
enum otCommissionerState otCommissionerState
Esta enumeração define o estado "Comissário".
OtCommissionerStateCallback
void(* otCommissionerStateCallback)(otCommissionerState aState, void *aContext)
Esse ponteiro de função é chamado sempre que o estado do encarregado é alterado.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
OtCommissioningDataset
struct otCommissioningDataset otCommissioningDataset
Essa estrutura representa um conjunto de dados de comissionamento.
OtJoinerInfo
struct otJoinerInfo otJoinerInfo
Essa estrutura representa uma informação de combinador.
otJoinerInfoType
enum otJoinerInfoType otJoinerInfoType
Esta enumeração define um tipo de informação do combinador.
Functions
OtCommissionerAddJoiner
otError otCommissionerAddJoiner( otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout )
Essa função adiciona uma entrada do Combinador.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||
Valores de retorno |
|
OtCommissionerAddJoinerWithDiscerner
otError otCommissionerAddJoinerWithDiscerner( otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout )
Essa função adiciona uma entrada do Combinador com um determinado valor do Discerner do combinador.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||
Valores de retorno |
|
otCommissionerAnnounceBegin
otError otCommissionerAnnounceBegin( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress )
Essa função envia uma mensagem "Anunciar início".
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 de consulta de verificação de energia.
Detalhes | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||||||||
Valores de retorno |
|
OtCommissionerGetId
const char * otCommissionerGetId( otInstance *aInstance )
Essa função retorna o ID do comissário.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
O ID de comissário.
|
OtCommissionerGetNextJoinerInfo
otError otCommissionerGetNextJoinerInfo( otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner )
Esse método acessa informações do combinador na posição do aiterador.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||
Valores de retorno |
|
OtCommissionerGetProvisioningUrl
const char * otCommissionerGetProvisioningUrl( otInstance *aInstance )
Essa função recebe o URL de provisionamento.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
Um ponteiro para a string de URL.
|
OtCommissionerGetSessionId
uint16_t otCommissionerGetSessionId( otInstance *aInstance )
Essa função retorna o ID da sessão do Commissioner.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
O ID atual da sessão do encarregado.
|
OtCommissionerGetState
otCommissionerState otCommissionerGetState( otInstance *aInstance )
Essa função retorna o estado "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 )
Essa função envia uma mensagem de consulta do ID do PAN.
Detalhes | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||||
Valores de retorno |
|
OtCommissionerRemoveJoiner
otError otCommissionerRemoveJoiner( otInstance *aInstance, const otExtAddress *aEui64 )
Essa função remove uma entrada do Combinador.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||
Valores de retorno |
|
OtCommissionerRemoveJoinerWithDiscerner
otError otCommissionerRemoveJoinerWithDiscerner( otInstance *aInstance, const otJoinerDiscerner *aDiscerner )
Essa função remove uma entrada do Combinador.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||
Valores de retorno |
|
OtCommissionerSendMgmtGet
otError otCommissionerSendMgmtGet( otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength )
Essa 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 )
Essa função envia MGMT_COMMISSIONER_SET.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||
Valores de retorno |
|
OtCommissionerSetId
otError otCommissionerSetId( otInstance *aInstance, const char *aId )
Essa função define o ID de comissário.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||
Valores de retorno |
|
OtCommissionerSetProvisioningUrl
otError otCommissionerSetProvisioningUrl( otInstance *aInstance, const char *aProvisioningUrl )
Esta função define o URL de provisionamento.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Valores de retorno |
|
OtCommissionerStart
otError otCommissionerStart( otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext )
Essa função ativa o papel Thread Commissioner.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||
Valores de retorno |
|
OtCommissionerStop
otError otCommissionerStop( otInstance *aInstance )
Essa função desativa o papel 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
Tamanho máximo da string de um PSKd do Combinador (não inclui caracteres nulos).
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 caracteres nulos).
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 são originados do código-fonte, disponível no GitHub. Para saber mais ou contribuir com nossa documentação, consulte Recursos.