O Google tem o compromisso de promover a igualdade racial para as comunidades negras. Saiba como.
Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

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{
  OT_COMMISSIONER_STATE_DISABLED = 0,
  OT_COMMISSIONER_STATE_PETITION = 1,
  OT_COMMISSIONER_STATE_ACTIVE = 2
} 		tipo enumerado
Esta enumeração define o estado "Comissário".
otJoinerInfoType{
  OT_JOINER_INFO_TYPE_ANY = 0,
  OT_JOINER_INFO_TYPE_EUI64 = 1,
  OT_JOINER_INFO_TYPE_DISCERNER = 2
} 		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) typedef
void(*
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) typedef
void(*
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) typedef
void(*
Esse ponteiro de função é chamado quando o comissário recebe uma mensagem de conflito de ID do PAN.
otCommissionerState typedef
Esta enumeração define o estado "Comissário".
otCommissionerStateCallback)(otCommissionerState aState, void *aContext) typedef
void(*
Esse ponteiro de função é chamado sempre que o estado do encarregado é alterado.
otCommissioningDataset typedef
Essa estrutura representa um conjunto de dados de comissionamento.
otJoinerInfo typedef
struct otJoinerInfo
Essa estrutura representa uma informação de combinador.
otJoinerInfoType typedef
Esta enumeração define um tipo de informação do combinador.
otJoinerPskd typedef
struct otJoinerPskd
Essa estrutura representa um PSKd combinador.
otSteeringData typedef
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 (mSharedId.mDiscerner em otJoinerInfo).

OT_JOINER_INFO_TYPE_EUI64

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

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
[in] aChannelMask
O valor da máscara do canal.
[in] aEnergyList
Um ponteiro para a lista de medição 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)

Esse ponteiro de função é chamado sempre que o estado do combinador muda.

Detalhes
Parâmetros
[in] aEvent
É o tipo de evento do 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

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

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
[in] aState
O estado "Comissário".
[in] aContext
Um ponteiro para contexto específico do aplicativo.

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.

OtJoinerPskd

struct otJoinerPskd otJoinerPskd

Essa estrutura representa um PSKd combinador.

OtSteeringData

struct otSteeringData otSteeringData

Essa estrutura representa os dados de direção.

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
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aEui64
Um ponteiro para o IEEE EUI-64 ou NULL para qualquer 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
O Combinador foi adicionado.
OT_ERROR_NO_BUFS
Nenhum buffer disponível para adicionar o combinador.
OT_ERROR_INVALID_ARGS
aEui64 ou aPskd são inválidos.
OT_ERROR_INVALID_STATE
O comissionador não está ativo.

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
[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 Combinador é removido automaticamente, em segundos.
Valores de retorno
OT_ERROR_NONE
O Combinador foi adicionado.
OT_ERROR_NO_BUFS
Nenhum buffer disponível para adicionar o combinador.
OT_ERROR_INVALID_ARGS
aDiscerner ou aPskd são inválidos.
OT_ERROR_INVALID_STATE
O comissionador não está ativo.

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
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aChannelMask
O valor da máscara do canal.
[in] aCount
O número de mensagens de aviso por canal.
[in] aPeriod
O tempo entre duas transmissões sucessivas do MLE Announce (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 "Anunciar início".
OT_ERROR_INVALID_STATE
O comissionador 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
)

Esta função 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 do 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 de consulta de verificação de energia foi adicionada à fila.
OT_ERROR_NO_BUFS
Buffers insuficientes para gerar uma mensagem de consulta de verificação de energia.
OT_ERROR_INVALID_STATE
O comissionador não está ativo.

OtCommissionerGetId

const char * otCommissionerGetId(
  otInstance *aInstance
)

Essa função retorna o ID do comissário.

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

OtCommissionerGetProvisioningUrl

const char * otCommissionerGetProvisioningUrl(
  otInstance *aInstance
)

Essa função recebe o URL de provisionamento.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
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
[in] aInstance
Um ponteiro para uma instância do OpenThread.
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
[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 encarregado.
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
)

Essa função envia uma mensagem de consulta do 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
O valor da máscara do 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 contexto específico do aplicativo.
Valores de retorno
OT_ERROR_NONE
A mensagem de consulta do ID do PAN foi adicionada à fila.
OT_ERROR_NO_BUFS
Buffers insuficientes para gerar uma mensagem de consulta de código PAN.
OT_ERROR_INVALID_STATE
O comissionador não está ativo.

OtCommissionerRemoveJoiner

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

Essa função 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 para qualquer 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 comissionador não está ativo.

OtCommissionerRemoveJoinerWithDiscerner

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

Essa função remove uma entrada do Combinador.

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
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 comissionador não está ativo.

OtCommissionerSendMgmtGet

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

Essa função 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 do conjunto de dados meshcop foi enviado.
OT_ERROR_NO_BUFS
Espaço para buffer insuficiente para envio.
OT_ERROR_INVALID_STATE
O comissionador não está ativo.

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
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aDataset
Um ponteiro para comissionamento do conjunto de dados.
[in] aTlvs
Um ponteiro para TLVs.
[in] aLength
O comprimento dos TLVs.
Valores de retorno
OT_ERROR_NONE
O comando do conjunto de dados meshcop foi enviado.
OT_ERROR_NO_BUFS
Espaço para buffer insuficiente para envio.
OT_ERROR_INVALID_STATE
O comissionador não está ativo.

OtCommissionerSetId

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

Essa função define o ID de 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 cancelado.
Valores de retorno
OT_ERROR_NONE
O ID de comissário foi definido.
OT_ERROR_INVALID_ARGS
O nome fornecido é muito longo.
OT_ERROR_INVALID_STATE
O comissionador está ativo e o ID não pode ser alterado.

OtCommissionerSetProvisioningUrl

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

Esta função 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 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
)

Essa função 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 Joiner
[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.

OtCommissionerStop

otError otCommissionerStop(
  otInstance *aInstance
)

Essa função desativa o papel Thread Commissioner.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Valores de retorno
OT_ERROR_NONE
Interrompeu o serviço do Commissioner.
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.

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.