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{
  OT_COMMISSIONER_STATE_DISABLED = 0,
  OT_COMMISSIONER_STATE_PETITION = 1,
  OT_COMMISSIONER_STATE_ACTIVE = 2
} 		tipo enumerado
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
} 		tipo enumerado
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 do combinador muda.
otCommissionerJoinerEvent typedef
Define um evento de Joiner no Commissioner.
otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext) typedef
void(*
O ponteiro é chamado quando o comissário recebe uma mensagem de conflito de código 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 um Joiner Info.
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 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 (mSharedId.mDiscerner em otJoinerInfo).

OT_JOINER_INFO_TYPE_EUI64

O combinador EUI-64 é 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
O valor da máscara de canal.
[in] aEnergyList
Um ponteiro para a lista de medições de energia.
[in] aEnergyListLength
Número de entradas em aEnergyListLength.
[in] aContext
Um ponteiro para 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 do combinador muda.

Detalhes
Parâmetros
[in] aEvent
O tipo de evento de mesclagem.
[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 contexto específico do aplicativo.

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
[in] aPanId
O valor do ID do PAN.
[in] aChannelMask
O valor da máscara de canal.
[in] aContext
Um ponteiro para 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 contexto específico do aplicativo.

Conjunto de dados de composição

struct otCommissioningDataset otCommissioningDataset

Representa um conjunto de dados de comissionamento.

Informações do contato

struct otJoinerInfo otJoinerInfo

Representa um Joiner Info.

InfoType integrado

enum otJoinerInfoType otJoinerInfoType

Define um tipo de informações do combinador.

OtJoiner Pskd

struct otJoinerPskd otJoinerPskd

Representa um PSKd do Joiner.

Dados otSteering

struct otSteeringData otSteeringData

Representa os dados de direcionamento.

Funções

OtcommissionerAddJoiner

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

Adiciona uma entrada do Joiner.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aEui64
Um ponteiro para IEEE EUI-64 ou NULL para qualquer Combinador.
[in] aPskd
Um ponteiro para o PSKd.
[in] aTimeout
Tempo após o qual um Joiner é removido automaticamente, em segundos.
Valores de retorno
OT_ERROR_NONE
O Joiner foi adicionado.
OT_ERROR_NO_BUFS
Nenhum buffer disponível para adicionar o Joiner.
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 Joiner com um determinado valor do Discerner do Joiner.

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

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
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aChannelMask
O valor da máscara de canal.
[in] aCount
O número de mensagens de avisos 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" foi enfileirada.
OT_ERROR_NO_BUFS
Buffers insuficientes para gerar uma mensagem Advertise Begin.
OT_ERROR_INVALID_STATE
O comissário não está ativo.

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
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aChannelMask
O valor da máscara de canal.
[in] aCount
O número de medições de energia por canal.
[in] aPeriod
O tempo entre medições de energia (milissegundos).
[in] aScanDuration
A duração da verificação para 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 contexto específico do aplicativo.
Valores de retorno
OT_ERROR_NONE
A mensagem da consulta de verificação de energia foi enfileirada.
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 comissário.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
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
[in] aInstance
Um ponteiro para instância.
[in,out] aIterator
Um ponteiro para o contexto do iterador Informações do combinador.
[out] aJoiner
Uma referência às informações do Joiner.
Valores de retorno
OT_ERROR_NONE
As informações do Joiner foram recebidas.
OT_ERROR_NOT_FOUND
Próximo combinador não encontrado.

URL da solicitação de provisionamento

const char * otCommissionerGetProvisioningUrl(
  otInstance *aInstance
)

Obtém o URL de aprovisionamento.

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 de sessão do comissário.

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

OtcommissionerGetState

otCommissionerState otCommissionerGetState(
  otInstance *aInstance
)

Retorna o estado do comissário.

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
Como se tornar 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 do código 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
O 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 código PAN.
[in] aContext
Um ponteiro para contexto específico do aplicativo.
Valores de retorno
OT_ERROR_NONE
A mensagem de consulta do ID do PAN foi enfileirada.
OT_ERROR_NO_BUFS
Buffers insuficientes para gerar uma mensagem de consulta de código PAN.
OT_ERROR_INVALID_STATE
O comissário não está ativo.

OtcommissionerRemoveJoiner

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

Remove uma entrada do Joiner.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aEui64
Um ponteiro para IEEE EUI-64 ou NULL para qualquer Combinador.
Valores de retorno
OT_ERROR_NONE
O Joiner foi removido.
OT_ERROR_NOT_FOUND
O Joiner 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 Joiner.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aDiscerner
Um ponteiro para o Discerner do Combinador.
Valores de retorno
OT_ERROR_NONE
O Joiner foi removido.
OT_ERROR_NOT_FOUND
O Joiner 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 tamanho dos TLVs.
Valores de retorno
OT_ERROR_NONE
O comando do 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.

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
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aDataset
Um ponteiro para comissionar o conjunto de dados.
[in] aTlvs
Um ponteiro para TLVs.
[in] aLength
O tamanho dos TLVs.
Valores de retorno
OT_ERROR_NONE
O comando do 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.

Código do conjunto de atividades

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

Define o ID do comissário.

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

URL de configuração de provisionamento

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 aprovisionamento (pode ser NULL a ser definido 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 chamada quando o estado do encarregado é alterado.
[in] aJoinerCallback
Um ponteiro para uma função chamada com um evento de junção ocorre.
[in] aCallbackContext
Um ponteiro para contexto específico do aplicativo.
Valores de retorno
OT_ERROR_NONE
O serviço Commissioner foi iniciado.
OT_ERROR_ALREADY
O comissário já foi iniciado.
OT_ERROR_INVALID_STATE
O dispositivo não está conectado a uma rede no momento.

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
Interrupção do serviço do Comissário.
OT_ERROR_ALREADY
O comissário já foi interrompido.

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.