Comissionário

Esse módulo inclui funções para o papel Thread Commissioner.

Resumo

Enumerações
otCommissionerJoinerEvent enum
Define um evento Joiner no Comissário.
otCommissionerState{
  OT_COMMISSIONER_STATE_DISABLED = 0,
  OT_COMMISSIONER_STATE_PETITION = 1,
  OT_COMMISSIONER_STATE_ACTIVE = 2
} 		enum
Define o estado do comissário.
otJoinerInfoType{
  OT_JOINER_INFO_TYPE_ANY = 0,
  OT_JOINER_INFO_TYPE_EUI64 = 1,
  OT_JOINER_INFO_TYPE_DISCERNER = 2
} 		enum
Define um tipo de informações do Combinador.

Typedefs
otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext) typedef
void(*
O ponteiro é chamado quando o comissário recebe um relatório de energia.
otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext) typedef
void(*
O ponteiro é chamado sempre que o estado dele muda.
otCommissionerJoinerEvent typedef
Define um evento Joiner no Comissário.
otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext) typedef
void(*
O ponteiro é chamado quando o Comissário recebe uma mensagem de conflito de ID do PAN.
otCommissionerState typedef
Define o estado do comissário.
otCommissionerStateCallback)(otCommissionerState aState, void *aContext) typedef
void(*
O ponteiro é chamado sempre que o estado do comissário muda.
otCommissioningDataset typedef
Representa um conjunto de dados de comissionamento.
otJoinerInfo typedef
struct otJoinerInfo
Representa as informações de um Combinador.
otJoinerInfoType typedef
Define um tipo de informações do Combinador.
otJoinerPskd typedef
struct otJoinerPskd
Representa um PSKd do Joiner.
otSteeringData typedef
Representa os dados de direção.

remotas
otCommissionerAddJoiner(otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout)
Adiciona uma entrada Combinador.
otCommissionerAddJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout)
Adiciona uma entrada do Combinador com um determinado valor do Identificador do Combinador.
otCommissionerAnnounceBegin(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress)
Envia uma mensagem de início do anúncio.
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 da verificação de energia.
otCommissionerGetId(otInstance *aInstance)
const char *
Retorna o ID do Commissioner.
otCommissionerGetNextJoinerInfo(otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner)
Confira as informações do agrupamento em uma posição de aIterator.
otCommissionerGetProvisioningUrl(otInstance *aInstance)
const char *
Extrai o URL de provisionamento.
otCommissionerGetSessionId(otInstance *aInstance)
uint16_t
Retorna o ID da sessão do comissário.
otCommissionerGetState(otInstance *aInstance)
Retorna o estado do Commissioner.
otCommissionerPanIdQuery(otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext)
Envia uma mensagem de consulta de ID do PAN.
otCommissionerRemoveJoiner(otInstance *aInstance, const otExtAddress *aEui64)
Remove uma entrada do Combinador.
otCommissionerRemoveJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner)
Remove uma entrada do Combinador.
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 Commissioner.
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

Representa um conjunto de dados de comissionamento.

otJoinerInfo

Representa as informações de um Combinador.

otJoinerPskd

Representa um PSKd do Joiner.

otSteeringData

Representa os dados de direção.

Enumerações

otCommissionerJoinerEvent

 otCommissionerJoinerEvent

Define um evento Joiner no Comissário.

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 de comissário está desativada.

OT_COMMISSIONER_STATE_PETITION

Solicitação para se tornar um comissário.

otJoinerInfoType

 otJoinerInfoType

Define um tipo de informações do Combinador.

Propriedades
OT_JOINER_INFO_TYPE_ANY

Aceitar qualquer participante (nenhum EUI64 ou Discernador é especificado).

OT_JOINER_INFO_TYPE_DISCERNER

O discador do Joiner foi especificado (mSharedId.mDiscerner em otJoinerInfo).

OT_JOINER_INFO_TYPE_EUI64

O EUI-64 do Joiner foi especificado (mSharedId.mEui64 em otJoinerInfo).

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
[in] aChannelMask
Valor da máscara de canal.
[in] aEnergyList
Ponteiro para a lista de medição de energia.
[in] aEnergyListLength
Número de entradas em aEnergyListLength.
[in] aContext
Um ponteiro para o contexto específico do aplicativo.

otCommissionerJoinerCallback

void(* otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)

O ponteiro é chamado sempre que o estado dele muda.

Detalhes
Parâmetros
[in] aEvent
O tipo de evento do agrupamento.
[in] aJoinerInfo
Um ponteiro para as informações do Combinador.
[in] aJoinerId
Um ponteiro para o ID do combinador (se não for conhecido, será NULL).
[in] aContext
Um ponteiro para o contexto específico do aplicativo.

otCommissionerJoinerEvent

enum otCommissionerJoinerEvent otCommissionerJoinerEvent

Define um evento Joiner no Comissário.

otCommissionerPanIdConflictCallback

void(* otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)

O ponteiro é chamado quando o Comissário recebe uma mensagem de conflito de ID do PAN.

Detalhes
Parâmetros
[in] aPanId
O valor do ID do PAN.
[in] aChannelMask
Valor da máscara de canal.
[in] aContext
Um ponteiro para o contexto específico do aplicativo.

otCommissionerState

enum otCommissionerState otCommissionerState

Define o estado do comissário.

otCommissionerStateCallback

void(* otCommissionerStateCallback)(otCommissionerState aState, void *aContext)

O ponteiro é chamado sempre que o estado do comissário muda.

Detalhes
Parâmetros
[in] aState
O estado do comissário.
[in] aContext
Um ponteiro para o contexto específico do aplicativo.

otCommissioningDataset

struct otCommissioningDataset otCommissioningDataset

Representa um conjunto de dados de comissionamento.

otJoinerInfo

struct otJoinerInfo otJoinerInfo

Representa as informações de um Combinador.

otJoinerInfoType

enum otJoinerInfoType otJoinerInfoType

Define um tipo de informações do Combinador.

otJoinerPskd

struct otJoinerPskd otJoinerPskd

Representa um PSKd do Joiner.

otSteeringData

struct otSteeringData otSteeringData

Representa os dados de direção.

remotas

otCommissionerAddJoiner

otError otCommissionerAddJoiner(
  otInstance *aInstance,
  const otExtAddress *aEui64,
  const char *aPskd,
  uint32_t aTimeout
)

Adiciona uma entrada Combinador.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aEui64
Um ponteiro para o IEEE EUI-64 ou NULL do Combinador.
[in] aPskd
Um ponteiro para o PSKd.
[in] aTimeout
Tempo após o qual um Combinador é removido automaticamente, em segundos.
Valores de retorno
OT_ERROR_NONE
Combinador adicionado.
OT_ERROR_NO_BUFS
Não há reservas disponíveis para adicionar o Combinador.
OT_ERROR_INVALID_ARGS
aEui64 ou aPskd é inválido.
OT_ERROR_INVALID_STATE
O comissário não está ativo.

otCommissionerAddJoinerWithDiscerner

otError otCommissionerAddJoinerWithDiscerner(
  otInstance *aInstance,
  const otJoinerDiscerner *aDiscerner,
  const char *aPskd,
  uint32_t aTimeout
)

Adiciona uma entrada do Combinador com um determinado valor do Identificador do Combinador.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aDiscerner
Um ponteiro para o separador do Combinador.
[in] aPskd
Um ponteiro para o PSKd.
[in] aTimeout
Tempo após o qual um Combinador é removido automaticamente, em segundos.
Valores de retorno
OT_ERROR_NONE
Combinador adicionado.
OT_ERROR_NO_BUFS
Não há reservas disponíveis para adicionar o Combinador.
OT_ERROR_INVALID_ARGS
aDiscerner ou aPskd é inválido.
OT_ERROR_INVALID_STATE
O comissário não está ativo.

otCommissionerAnnounceBegin

otError otCommissionerAnnounceBegin(
  otInstance *aInstance,
  uint32_t aChannelMask,
  uint8_t aCount,
  uint16_t aPeriod,
  const otIp6Address *aAddress
)

Envia uma mensagem de início do anúncio.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aChannelMask
Valor da máscara de canal.
[in] aCount
O número de mensagens de anúncio por canal.
[in] aPeriod
O tempo entre duas transmissões sucessivas de Anúncio do MLE (em milissegundos).
[in] aAddress
Um ponteiro para o destino IPv6.
Valores de retorno
OT_ERROR_NONE
A mensagem "Anunciar início" foi enfileirada.
OT_ERROR_NO_BUFS
Buffers insuficientes para gerar uma mensagem de início de anúncio.
OT_ERROR_INVALID_STATE
O comissário não está ativo.

otCommissionerEnergyScan

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 da verificação de energia.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aChannelMask
Valor da máscara de canal.
[in] aCount
O número de medições de energia por canal.
[in] aPeriod
O tempo entre as medições de energia (milissegundos).
[in] aScanDuration
A duração da verificação de cada medição de energia (milissegundos).
[in] aAddress
Um ponteiro para o destino IPv6.
[in] aCallback
Um ponteiro para uma função chamada ao receber uma mensagem do relatório de energia.
[in] aContext
Um ponteiro para o contexto específico do aplicativo.
Valores de retorno
OT_ERROR_NONE
A mensagem de consulta de verificação de energia foi colocada na fila com sucesso.
OT_ERROR_NO_BUFS
Buffers insuficientes para gerar uma mensagem de consulta de verificação de energia.
OT_ERROR_INVALID_STATE
O comissário não está ativo.

otCommissionerGetId

const char * otCommissionerGetId(
  otInstance *aInstance
)

Retorna o ID do Commissioner.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
O ID do Commissioner.

otCommissionerGetNextJoinerInfo

otError otCommissionerGetNextJoinerInfo(
  otInstance *aInstance,
  uint16_t *aIterator,
  otJoinerInfo *aJoiner
)

Confira as informações do agrupamento em uma posição de aIterator.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para a instância.
[in,out] aIterator
Um ponteiro para o contexto do iterador de informações do Joiner.
[out] aJoiner
Uma referência às informações do Combinador.
Valores de retorno
OT_ERROR_NONE
Você recebe as informações do Combinador.
OT_ERROR_NOT_FOUND
Próximo agrupamento não encontrado.

otCommissionerGetProvisioningUrl

const char * otCommissionerGetProvisioningUrl(
  otInstance *aInstance
)

Extrai o URL de provisionamento.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Um ponteiro para a string do URL.

otCommissionerGetSessionId

uint16_t otCommissionerGetSessionId(
  otInstance *aInstance
)

Retorna o ID da sessão do comissário.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
O ID da sessão do comissário atual.

otCommissionerGetState

otCommissionerState otCommissionerGetState(
  otInstance *aInstance
)

Retorna o estado do Commissioner.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Valores de retorno
OT_COMMISSIONER_STATE_DISABLED
Comissário desativado.
OT_COMMISSIONER_STATE_PETITION
Tornar-se o comissário.
OT_COMMISSIONER_STATE_ACTIVE
Comissário ativado.

otCommissionerPanIdQuery

otError otCommissionerPanIdQuery(
  otInstance *aInstance,
  uint16_t aPanId,
  uint32_t aChannelMask,
  const otIp6Address *aAddress,
  otCommissionerPanIdConflictCallback aCallback,
  void *aContext
)

Envia uma mensagem de consulta de ID do PAN.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aPanId
O ID do PAN a ser consultado.
[in] aChannelMask
Valor da máscara de canal.
[in] aAddress
Um ponteiro para o destino IPv6.
[in] aCallback
Um ponteiro para uma função chamada ao receber uma mensagem de conflito de ID do PAN.
[in] aContext
Um ponteiro para o contexto específico do aplicativo.
Valores de retorno
OT_ERROR_NONE
A mensagem de consulta do ID do PAN foi colocada na fila.
OT_ERROR_NO_BUFS
Buffers insuficientes para gerar uma mensagem de consulta de ID PAN.
OT_ERROR_INVALID_STATE
O comissário não está ativo.

otCommissionerRemoveJoiner

otError otCommissionerRemoveJoiner(
  otInstance *aInstance,
  const otExtAddress *aEui64
)

Remove uma entrada do Combinador.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aEui64
Um ponteiro para o IEEE EUI-64 ou NULL do Combinador.
Valores de retorno
OT_ERROR_NONE
Combinador removido.
OT_ERROR_NOT_FOUND
O Combinador especificado por aEui64 não foi encontrado.
OT_ERROR_INVALID_ARGS
aEui64 não é uma entrada válida.
OT_ERROR_INVALID_STATE
O comissário não está ativo.

otCommissionerRemoveJoinerWithDiscerner

otError otCommissionerRemoveJoinerWithDiscerner(
  otInstance *aInstance,
  const otJoinerDiscerner *aDiscerner
)

Remove uma entrada do Combinador.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aDiscerner
Um ponteiro para o separador do Combinador.
Valores de retorno
OT_ERROR_NONE
Combinador removido.
OT_ERROR_NOT_FOUND
O Combinador especificado por aEui64 não foi encontrado.
OT_ERROR_INVALID_ARGS
aDiscerner não é uma entrada válida.
OT_ERROR_INVALID_STATE
O comissário não está ativo.

otCommissionerSendMgmtGet

otError otCommissionerSendMgmtGet(
  otInstance *aInstance,
  const uint8_t *aTlvs,
  uint8_t aLength
)

Envia MGMT_COMMISSIONER_GET.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aTlvs
Um ponteiro para TLVs.
[in] aLength
O comprimento dos TLVs.
Valores de retorno
OT_ERROR_NONE
O comando de conjunto de dados meshcop foi enviado.
OT_ERROR_NO_BUFS
Espaço de buffer insuficiente para enviar.
OT_ERROR_INVALID_STATE
O comissário não está ativo.

otCommissionerSendMgmtSet

otError otCommissionerSendMgmtSet(
  otInstance *aInstance,
  const otCommissioningDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength
)

Envia MGMT_COMMISSIONER_SET.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aDataset
Um ponteiro para o conjunto de dados de comissionamento.
[in] aTlvs
Um ponteiro para TLVs.
[in] aLength
O comprimento dos TLVs.
Valores de retorno
OT_ERROR_NONE
O comando de conjunto de dados meshcop foi enviado.
OT_ERROR_NO_BUFS
Espaço de buffer insuficiente para enviar.
OT_ERROR_INVALID_STATE
O comissário não está ativo.

otCommissionerSetId

otError otCommissionerSetId(
  otInstance *aInstance,
  const char *aId
)

Define o ID do Commissioner.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aId
Um ponteiro para uma matriz de caracteres de string. Deve ser encerrado como nulo.
Valores de retorno
OT_ERROR_NONE
O ID do Commissioner foi definido.
OT_ERROR_INVALID_ARGS
O nome é muito longo.
OT_ERROR_INVALID_STATE
O comissário está ativo, e o ID não pode ser alterado.

otCommissionerSetProvisioningUrl

otError otCommissionerSetProvisioningUrl(
  otInstance *aInstance,
  const char *aProvisioningUrl
)

Define o URL de provisionamento.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aProvisioningUrl
Um ponteiro para o URL de provisionamento (pode ser NULL para definir como uma string vazia).
Valores de retorno
OT_ERROR_NONE
O URL de provisionamento foi definido.
OT_ERROR_INVALID_ARGS
aProvisioningUrl é inválido (muito longo).

otCommissionerStart

otError otCommissionerStart(
  otInstance *aInstance,
  otCommissionerStateCallback aStateCallback,
  otCommissionerJoinerCallback aJoinerCallback,
  void *aCallbackContext
)

Ativa o papel Thread Commissioner.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aStateCallback
Um ponteiro para uma função que é chamada quando o estado do comissário muda.
[in] aJoinerCallback
Ocorre um ponteiro para uma função chamada com um evento de agrupamento.
[in] aCallbackContext
Um ponteiro para o contexto específico do aplicativo.
Valores de retorno
OT_ERROR_NONE
O serviço Commissioner foi iniciado.
OT_ERROR_ALREADY
O Commissioner já começou.
OT_ERROR_INVALID_STATE
O dispositivo não está conectado a uma rede.

otCommissionerStop

otError otCommissionerStop(
  otInstance *aInstance
)

Desativa o papel Thread Commissioner.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Valores de retorno
OT_ERROR_NONE
O serviço Commissioner foi interrompido.
OT_ERROR_ALREADY
O Comissário já está parado.

Macros

OT_COMMISSIONING_PASSPHRASE_MAX_SIZE

 OT_COMMISSIONING_PASSPHRASE_MAX_SIZE 255

Tamanho máximo da senha longa de comissionamento.

OT_COMMISSIONING_PASSPHRASE_MIN_SIZE

 OT_COMMISSIONING_PASSPHRASE_MIN_SIZE 6

Tamanho mínimo da senha longa de comissionamento.

OT_JOINER_MAX_PSKD_LENGTH

 OT_JOINER_MAX_PSKD_LENGTH 32

Comprimento máximo da string de um PSKd do Joiner (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 do URL de provisionamento (exclui caracteres nulos).

OT_STEERING_DATA_MAX_LENGTH

 OT_STEERING_DATA_MAX_LENGTH 16

Comprimento máximo dos dados de direcionamento (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.