Google is committed to advancing racial equity for Black communities. See how.
Esta página foi traduzida pela API Cloud Translation.
Switch to English

Comissário

Este módulo inclui funções para a função Comissário de Thread.

Resumo

Enumerações

otCommissionerJoinerEvent enum
Essa enumeração define um evento de marceneiro no comissário.
otCommissionerState {
OT_COMMISSIONER_STATE_DISABLED = 0,
OT_COMMISSIONER_STATE_PETITION = 1,
OT_COMMISSIONER_STATE_ACTIVE = 2
}
enum
Esta enumeração 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
Essa enumeração define um Joiner Info Typer.

Typedefs

otCommissionerEnergyReportCallback )(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext) typedef
void(*
Este ponteiro de função é chamado quando o Comissário 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 marceneiro muda.
otCommissionerJoinerEvent typedef
Essa enumeração define um evento de marceneiro no comissário.
otCommissionerPanIdConflictCallback )(uint16_t aPanId, uint32_t aChannelMask, void *aContext) typedef
void(*
Este ponteiro de função é chamado quando o Comissário recebe uma mensagem de conflito de ID de PAN.
otCommissionerState typedef
Esta enumeração define o Estado do Comissário.
otCommissionerStateCallback )(otCommissionerState aState, void *aContext) typedef
void(*
Esse ponteiro de função é chamado sempre que o estado do comissário mudar.
otCommissioningDataset typedef
Essa estrutura representa um conjunto de dados de comissionamento.
otJoinerInfo typedef
struct otJoinerInfo
Essa estrutura representa uma informação de marceneiro.
otJoinerInfoType typedef
Essa enumeração define um Joiner Info Typer.
otJoinerPskd typedef
struct otJoinerPskd
Essa estrutura representa um Joiner PSKd.
otSteeringData typedef
Essa estrutura representa os dados da direção.

Funções

otCommissionerAddJoiner ( otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout)
Esta função adiciona uma entrada de Marceneiro.
otCommissionerAddJoinerWithDiscerner ( otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout)
Essa função adiciona uma entrada do Joiner com um determinado valor do Joiner Discerner.
otCommissionerAnnounceBegin ( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress)
Esta 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.
otCommissionerGetNextJoinerInfo ( otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner)
Este método obtém informações do marceneiro na posição aIterator.
otCommissionerGetProvisioningUrl ( otInstance *aInstance)
const char *
Esta função obtém o URL de provisionamento.
otCommissionerGetSessionId ( otInstance *aInstance)
uint16_t
Esta função retorna o ID da sessão do comissário.
otCommissionerGetState ( otInstance *aInstance)
Esta função retorna o Estado do Comissário.
otCommissionerPanIdQuery ( otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext)
Esta função envia uma mensagem de consulta de identificação de PAN.
otCommissionerRemoveJoiner ( otInstance *aInstance, const otExtAddress *aEui64)
Esta função remove uma entrada do Joiner.
otCommissionerRemoveJoinerWithDiscerner ( otInstance *aInstance, const otJoinerDiscerner *aDiscerner)
Esta função remove uma entrada do Joiner.
otCommissionerSendMgmtGet ( otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength)
Esta função envia MGMT_COMMISSIONER_GET.
otCommissionerSendMgmtSet ( otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength)
Esta função envia MGMT_COMMISSIONER_SET.
otCommissionerSetProvisioningUrl ( otInstance *aInstance, const char *aProvisioningUrl)
Esta função define o URL de provisionamento.
otCommissionerStart ( otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext)
Esta função ativa a função de Comissário de Thread.
otCommissionerStop ( otInstance *aInstance)
Esta função desabilita a função Comissário de Thread.

Estruturas

otCommissioningDataset

Essa estrutura representa um conjunto de dados de comissionamento.

otJoinerInfo

Essa estrutura representa uma informação de marceneiro.

otJoinerPskd

Essa estrutura representa um Joiner PSKd.

otSteeringData

Essa estrutura representa os dados da direção.

Enumerações

otCommissionerJoinerEvent

 otCommissionerJoinerEvent

Essa enumeração define um evento de marceneiro no comissário.

otCommissionerState

 otCommissionerState

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

Atualmente, está pedindo para se tornar um Comissário.

otJoinerInfoType

 otJoinerInfoType

Essa enumeração define um Joiner Info Typer.

Propriedades
OT_JOINER_INFO_TYPE_ANY

Aceite qualquer Joiner (nenhum EUI64 ou Discerner está especificado).

OT_JOINER_INFO_TYPE_DISCERNER

O Joiner Discerner está especificado ( mSharedId.mDiscerner em otJoinerInfo ).

OT_JOINER_INFO_TYPE_EUI64

O marceneiro EUI-64 está especificado ( mSharedId.mEui64 em otJoinerInfo ).

Typedefs

otCommissionerEnergyReportCallback

void(* otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)

Este ponteiro de função é 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 medidas 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)

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

Detalhes
Parâmetros
[in] aEvent
O tipo de evento do marceneiro.
[in] aJoinerInfo
Um ponteiro para o Joiner Info.
[in] aJoinerId
Um ponteiro para o Joiner ID (se não for conhecido, será NULL).
[in] aContext
Um ponteiro para o contexto específico do aplicativo.

otCommissionerJoinerEvent

enum otCommissionerJoinerEvent otCommissionerJoinerEvent

Essa enumeração define um evento de marceneiro no comissário.

otCommissionerPanIdConflictCallback

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

Este ponteiro de função é chamado quando o Comissário recebe uma mensagem de conflito de ID de 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 o contexto específico do aplicativo.

otCommissionerState

enum otCommissionerState otCommissionerState

Esta enumeração define o Estado do Comissário.

otCommissionerStateCallback

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

Esse ponteiro de função é chamado sempre que o estado do comissário mudar.

Detalhes
Parâmetros
[in] aChannelMask
O valor da máscara de canal.
[in] aEnergyList
Um ponteiro para a lista de medidas de energia.
[in] aEnergyListLength
Número de entradas em aEnergyListLength .
[in] aContext
Um ponteiro para o 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 marceneiro.

otJoinerInfoType

enum otJoinerInfoType otJoinerInfoType

Essa enumeração define um Joiner Info Typer.

otJoinerPskd

struct otJoinerPskd otJoinerPskd

Essa estrutura representa um Joiner PSKd.

otSteeringData

struct otSteeringData otSteeringData

Essa estrutura representa os dados da direção.

Funções

otCommissionerAddJoiner

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

Esta função adiciona uma entrada de Marceneiro.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aEui64
Um ponteiro para o IEEE EUI-64 ou o NULL do Joiner para qualquer Joiner.
[in] aPskd
Um ponteiro para o PSKd.
[in] aTimeout
Um tempo após o qual um Joiner é removido automaticamente, em segundos.
Retornar valores
OT_ERROR_NONE
O Joiner foi adicionado com sucesso.
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
)

Essa função adiciona uma entrada do Joiner com um determinado valor do Joiner Discerner.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aDiscerner
Um ponteiro para o Joiner Discerner.
[in] aPskd
Um ponteiro para o PSKd.
[in] aTimeout
Um tempo após o qual um Joiner é removido automaticamente, em segundos.
Retornar valores
OT_ERROR_NONE
O Joiner foi adicionado com sucesso.
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.

otCommissionerAnnounceBegin

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

Esta 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 de canal.
[in] aCount
O número de mensagens de anúncio por canal.
[in] aPeriod
O tempo entre duas transmissões MLE Announce sucessivas (em milissegundos).
[in] aAddress
Um ponteiro para o destino IPv6.
Retornar valores
OT_ERROR_NONE
Enfileirou com êxito a mensagem Anunciar Início.
OT_ERROR_NO_BUFS
Buffers insuficientes para gerar uma mensagem Announce Begin.
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
)

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 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 varredura 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 de Relatório de Energia.
[in] aContext
Um ponteiro para o contexto específico do aplicativo.
Retornar valores
OT_ERROR_NONE
Enfileirou com êxito a mensagem Consulta de Verificação de Energia.
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.

otCommissionerGetNextJoinerInfo

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

Este método obtém informações do marceneiro na posição aIterator.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para instância.
[in,out] aIterator
Um ponteiro para o contexto do iterador do Joiner Info.
[out] aJoiner
Uma referência às informações do Joiner.
Retornar valores
OT_ERROR_NONE
Obtenha com êxito as informações do Joiner.
OT_ERROR_NOT_FOUND
Não encontrado próximo Marceneiro.

otCommissionerGetProvisioningUrl

const char * otCommissionerGetProvisioningUrl(
  otInstance *aInstance
)

Esta função obtém o URL de provisionamento.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Devoluções
Um ponteiro para a string da URL.

otCommissionerGetSessionId

uint16_t otCommissionerGetSessionId(
  otInstance *aInstance
)

Esta função retorna o ID da sessão do comissário.

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

otCommissionerGetState

 otCommissionerState otCommissionerGetState(
  otInstance *aInstance
)

Esta função retorna o Estado do Comissário.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retornar valores
OT_COMMISSIONER_STATE_DISABLED
Comissário desativado.
OT_COMMISSIONER_STATE_PETITION
Tornando-se o comissário.
OT_COMMISSIONER_STATE_ACTIVE
Comissário habilitado.

otCommissionerPanIdQuery

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

Esta função envia uma mensagem de consulta de identificação de PAN.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aPanId
O PAN ID 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 ID de PAN.
[in] aContext
Um ponteiro para o contexto específico do aplicativo.
Retornar valores
OT_ERROR_NONE
Enfileirou com êxito a mensagem de Consulta de ID do PAN.
OT_ERROR_NO_BUFS
Buffers insuficientes para gerar uma mensagem de Consulta de ID do PAN.
OT_ERROR_INVALID_STATE
O comissário não está ativo.

otCommissionerRemoveJoiner

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

Esta função remove uma entrada do Joiner.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aEui64
Um ponteiro para o IEEE EUI-64 ou o NULL do Joiner para qualquer Joiner.
Retornar valores
OT_ERROR_NONE
O Joiner removido com sucesso.
OT_ERROR_NOT_FOUND
O Joiner especificado por aEui64 não foi encontrado.
OT_ERROR_INVALID_ARGS
aEui64 é inválido.
OT_ERROR_INVALID_STATE
O comissário não está ativo.

otCommissionerRemoveJoinerWithDiscerner

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

Esta função remove uma entrada do Joiner.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aEui64
Um ponteiro para o Joiner Discerner.
Retornar valores
OT_ERROR_NONE
O Joiner removido com sucesso.
OT_ERROR_NOT_FOUND
O Joiner especificado por aEui64 não foi encontrado.
OT_ERROR_INVALID_ARGS
aDiscerner é inválido.
OT_ERROR_INVALID_STATE
O comissário não está ativo.

otCommissionerSendMgmtGet

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

Esta 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.
Retornar valores
OT_ERROR_NONE
Envie com êxito o comando do conjunto de dados do meshcop.
OT_ERROR_NO_BUFS
Espaço insuficiente no buffer 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
)

Esta função envia MGMT_COMMISSIONER_SET.

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

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 sequência vazia).
Retornar valores
OT_ERROR_NONE
Defina com êxito o URL de provisionamento.
OT_ERROR_INVALID_ARGS
aProvisioningUrl é inválido (muito longo).

otCommissionerStart

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

Esta função ativa a função de Comissário de Thread.

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
Um ponteiro para uma função chamada com um evento de marceneiro ocorre.
[in] aCallbackContext
Um ponteiro para o contexto específico do aplicativo.
Retornar valores
OT_ERROR_NONE
Iniciado com sucesso o serviço do Comissário.
OT_ERROR_ALREADY
O comissário já está iniciado.
OT_ERROR_INVALID_STATE
O dispositivo não está atualmente conectado a uma rede.

otCommissionerStop

 otError otCommissionerStop(
  otInstance *aInstance
)

Esta função desabilita a função Comissário de Thread.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retornar valores
OT_ERROR_NONE
Interrompido com êxito o serviço do Comissário.
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 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

Comprimento máximo da string de um Joiner PSKd (não inclui caracteres nulos).

OT_PROVISIONING_URL_MAX_SIZE

 OT_PROVISIONING_URL_MAX_SIZE 64

Tamanho máximo (número de caracteres) na cadeia 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)