Comissionário
Este módulo inclui funções para o papel de Thread Commissioner.
Resumo
Enumerações |
|
---|---|
otCommissionerJoinerEvent
|
tipo enumerado Define um evento de Joiner no Commissioner. |
otCommissionerState{
|
tipo enumerado Define o estado do comissário. |
otJoinerInfoType{
|
tipo enumerado Define um tipo de informações do combinador. |
Typedefs |
|
---|---|
otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)
|
typedefvoid(*
O ponteiro é chamado quando o comissário recebe um relatório de energia. |
otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)
|
typedefvoid(*
O ponteiro é chamado sempre que o estado do combinador muda. |
otCommissionerJoinerEvent
|
typedef Define um evento de Joiner no Commissioner. |
otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)
|
typedefvoid(*
O ponteiro é chamado quando o comissário recebe uma mensagem de conflito de código PAN. |
otCommissionerState
|
typedefenum otCommissionerState
Define o estado do comissário. |
otCommissionerStateCallback)(otCommissionerState aState, void *aContext)
|
typedefvoid(*
O ponteiro é chamado sempre que o estado do comissário muda. |
otCommissioningDataset
|
typedefstruct otCommissioningDataset
Representa um conjunto de dados de comissionamento. |
otJoinerInfo
|
typedefstruct otJoinerInfo
Representa um Joiner Info. |
otJoinerInfoType
|
typedefenum otJoinerInfoType
Define um tipo de informações do combinador. |
otJoinerPskd
|
typedefstruct otJoinerPskd
Representa um PSKd do Joiner. |
otSteeringData
|
typedefstruct otSteeringData
Representa os dados de direcionamento. |
Funções |
|
---|---|
otCommissionerAddJoiner(otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout)
|
Adiciona uma entrada do Joiner.
|
otCommissionerAddJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout)
|
Adiciona uma entrada do Joiner com um determinado valor do Discerner do Joiner.
|
otCommissionerAnnounceBegin(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress)
|
Envia uma mensagem "Begin Begin".
|
otCommissionerEnergyScan(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext)
|
Envia uma mensagem de consulta de verificação de energia.
|
otCommissionerGetId(otInstance *aInstance)
|
const char *
Retorna o ID do comissário.
|
otCommissionerGetNextJoinerInfo(otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner)
|
Receba informações do combinador na posição aIterator.
|
otCommissionerGetProvisioningUrl(otInstance *aInstance)
|
const char *
Obtém o URL de aprovisionamento.
|
otCommissionerGetSessionId(otInstance *aInstance)
|
uint16_t
Retorna o ID de sessão do comissário.
|
otCommissionerGetState(otInstance *aInstance)
|
Retorna o estado do comissário.
|
otCommissionerPanIdQuery(otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext)
|
Envia uma mensagem de consulta do código PAN.
|
otCommissionerRemoveJoiner(otInstance *aInstance, const otExtAddress *aEui64)
|
Remove uma entrada do Joiner.
|
otCommissionerRemoveJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner)
|
Remove uma entrada do Joiner.
|
otCommissionerSendMgmtGet(otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength)
|
Envia MGMT_COMMISSIONER_GET.
|
otCommissionerSendMgmtSet(otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength)
|
Envia MGMT_COMMISSIONER_SET.
|
otCommissionerSetId(otInstance *aInstance, const char *aId)
|
Define o ID do comissário.
|
otCommissionerSetProvisioningUrl(otInstance *aInstance, const char *aProvisioningUrl)
|
Define o URL de provisionamento.
|
otCommissionerStart(otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext)
|
Ativa o papel Thread Commissioner.
|
otCommissionerStop(otInstance *aInstance)
|
Desativa o papel Thread Commissioner.
|
Estruturas |
|
---|---|
otCommissioningDataset (link em inglês) |
Representa um conjunto de dados de comissionamento. |
otJoinerInfo (em inglês) |
Representa um Joiner Info. |
otJoinerPskd (em inglês) |
Representa um PSKd do Joiner. |
otSteeringData (em inglês) |
Representa os dados de direcionamento. |
Enumerações
OtcommissionerJoinerEvent
otCommissionerJoinerEvent
Define um evento de Joiner no Commissioner.
OtCommissionerState
otCommissionerState
Define o estado do comissário.
Propriedades | |
---|---|
OT_COMMISSIONER_STATE_ACTIVE
|
O papel de comissário está ativo. |
OT_COMMISSIONER_STATE_DISABLED
|
A função "Comissário" está desativada. |
OT_COMMISSIONER_STATE_PETITION
|
Solicitando atualmente que se torne um comissário. |
InfoType integrado
otJoinerInfoType
Define um tipo de informações do combinador.
Propriedades | |
---|---|
OT_JOINER_INFO_TYPE_ANY
|
Aceitar qualquer Joiner (nenhum EUI64 ou Discerner é especificado). |
OT_JOINER_INFO_TYPE_DISCERNER
|
O Discerner do mesclagem é especificado ( |
OT_JOINER_INFO_TYPE_EUI64
|
O combinador EUI-64 é especificado ( |
Typedefs
OtCommissionerEnergyReportCallback
void(* otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)
O ponteiro é 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)
O ponteiro é chamado sempre que o estado do combinador muda.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
OtcommissionerJoinerEvent
enum otCommissionerJoinerEvent otCommissionerJoinerEvent
Define um evento de Joiner no Commissioner.
OtCommissionerPanIdConflictCallback
void(* otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)
O ponteiro é chamado quando o comissário recebe uma mensagem de conflito de código PAN.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
OtCommissionerStateCallback
void(* otCommissionerStateCallback)(otCommissionerState aState, void *aContext)
O ponteiro é chamado sempre que o estado do comissário muda.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
Conjunto de dados de composição
struct otCommissioningDataset otCommissioningDataset
Representa um conjunto de dados de comissionamento.
InfoType integrado
enum otJoinerInfoType otJoinerInfoType
Define um tipo de informações do combinador.
Funções
OtcommissionerAddJoiner
otError otCommissionerAddJoiner( otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout )
Adiciona uma entrada do Joiner.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||
Valores de retorno |
|
OtcommissionerAddJoinerWithDiscerner
otError otCommissionerAddJoinerWithDiscerner( otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout )
Adiciona uma entrada do Joiner com um determinado valor do Discerner do Joiner.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||
Valores de retorno |
|
OtCommissionerAdvertiseBegin
otError otCommissionerAnnounceBegin( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress )
Envia uma mensagem "Begin Begin".
Detalhes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||
Valores de retorno |
|
Verificação de energia otcommissioner
otError otCommissionerEnergyScan( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext )
Envia uma mensagem de consulta de verificação de energia.
Detalhes | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||||||||
Valores de retorno |
|
OtCommissionerGetId
const char * otCommissionerGetId( otInstance *aInstance )
Retorna o ID do comissário.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
O ID do comissário.
|
OtcommissionerGetNextJoinerInfo
otError otCommissionerGetNextJoinerInfo( otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner )
Receba informações do combinador na posição aIterator.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||
Valores de retorno |
|
URL da solicitação de provisionamento
const char * otCommissionerGetProvisioningUrl( otInstance *aInstance )
Obtém o URL de aprovisionamento.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
Um ponteiro para a string do URL.
|
OtCommissionerGetSessionId
uint16_t otCommissionerGetSessionId( otInstance *aInstance )
Retorna o ID de sessão do comissário.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
O ID da sessão atual do comissário.
|
OtcommissionerGetState
otCommissionerState otCommissionerGetState( otInstance *aInstance )
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 )
Envia uma mensagem de consulta do código PAN.
Detalhes | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||||
Valores de retorno |
|
OtcommissionerRemoveJoiner
otError otCommissionerRemoveJoiner( otInstance *aInstance, const otExtAddress *aEui64 )
Remove uma entrada do Joiner.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||
Valores de retorno |
|
OtcommissionerRemoveJoinerWithDiscerner
otError otCommissionerRemoveJoinerWithDiscerner( otInstance *aInstance, const otJoinerDiscerner *aDiscerner )
Remove uma entrada do Joiner.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||
Valores de retorno |
|
otCommissionerSendMgmtGet
otError otCommissionerSendMgmtGet( otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength )
Envia MGMT_COMMISSIONER_GET.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||
Valores de retorno |
|
Configuração do otcommissionerSendMgmtt
otError otCommissionerSendMgmtSet( otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength )
Envia MGMT_COMMISSIONER_SET.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||
Valores de retorno |
|
Código do conjunto de atividades
otError otCommissionerSetId( otInstance *aInstance, const char *aId )
Define o ID do comissário.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||
Valores de retorno |
|
URL de configuração de provisionamento
otError otCommissionerSetProvisioningUrl( otInstance *aInstance, const char *aProvisioningUrl )
Define o URL de provisionamento.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Valores de retorno |
|
OtCommissionerStart
otError otCommissionerStart( otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext )
Ativa o papel Thread Commissioner.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||
Valores de retorno |
|
OtcommissionerStop
otError otCommissionerStop( otInstance *aInstance )
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.
PR_JOINER_MAX_PSKD_LENGTH
OT_JOINER_MAX_PSKD_LENGTH 32
Comprimento máximo da string de um PSKd do Joiner (não inclui caractere nulo).
PRO_PROVISIONING_URL_MAX_SIZE
OT_PROVISIONING_URL_MAX_SIZE 64
Tamanho máximo (número de caracteres) na string do URL de aprovisionamento (exclui caracteres curinga).
PR_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 mais informações ou para contribuir com nossa documentação, consulte Recursos.