O Google tem o compromisso de promover a igualdade racial para as comunidades negras. Saiba como.

Comissário

Este módulo inclui funções para a função Thread Commissioner.

Resumo

Enumerações

otCommissionerJoinerEvent enum
Essa enumeração define um Evento de Joiner 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 tipo de informação do marceneiro.

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(*
Este ponteiro de função é chamado sempre que o estado do joiner muda.
otCommissionerJoinerEvent typedef
Essa enumeração define um Evento de Joiner 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 PAN ID.
otCommissionerState typedef
Esta enumeração define o Estado do Comissário.
otCommissionerStateCallback )(otCommissionerState aState, void *aContext) typedef
void(*
Este ponteiro de função é chamado sempre que o estado do comissário muda.
otCommissioningDataset typedef
Esta estrutura representa um conjunto de dados de comissionamento.
otJoinerInfo typedef
struct otJoinerInfo
Esta estrutura representa um Joiner Info.
otJoinerInfoType typedef
Esta enumeração define um tipo de informação de associador.
otJoinerPskd typedef
struct otJoinerPskd
Esta estrutura representa um Joiner PSKd.
otSteeringData typedef
Esta estrutura representa os dados de direção.

Funções

otCommissionerAddJoiner ( otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout)
Esta função adiciona uma entrada de Joiner.
otCommissionerAddJoinerWithDiscerner ( otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout)
Esta função adiciona uma entrada de Joiner com um determinado valor de Joiner Discerner.
otCommissionerAnnounceBegin ( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress)
Esta função envia uma mensagem Announce Begin.
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 do Energy Scan.
otCommissionerGetNextJoinerInfo ( otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner)
Este método obtém informações do marceneiro na posição do 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 PAN ID.
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 Thread Commissioner.
otCommissionerStop ( otInstance *aInstance)
Esta função desativa a função Thread Commissioner.

Structs

otCommissioningDataset

Esta estrutura representa um conjunto de dados de comissionamento.

otJoinerInfo

Esta estrutura representa um Joiner Info.

otJoinerPskd

Esta estrutura representa um Joiner PSKd.

otSteeringData

Esta estrutura representa os dados de direção.

Enumerações

otCommissionerJoinerEvent

 otCommissionerJoinerEvent

Essa enumeração define um Evento de Joiner no Comissário.

otCommissionerState

 otCommissionerState

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

Propriedades
OT_COMMISSIONER_STATE_ACTIVE

O papel do comissário é ativo.

OT_COMMISSIONER_STATE_DISABLED

A função de comissário está desativada.

OT_COMMISSIONER_STATE_PETITION

Atualmente peticionando para se tornar um Comissário.

otJoinerInfoType

 otJoinerInfoType

Esta enumeração define um tipo de informação de associador.

Propriedades
OT_JOINER_INFO_TYPE_ANY

Aceite qualquer Joiner (nenhum EUI64 ou Discerner é especificado).

OT_JOINER_INFO_TYPE_DISCERNER

Joiner discernidora é especificado ( mSharedId.mDiscerner em otJoinerInfo ).

OT_JOINER_INFO_TYPE_EUI64

Joiner EUI-64 é 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 do canal.
[in] aEnergyList
Um ponteiro para a lista de medição de energia.
[in] aEnergyListLength
Número de entradas no 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)

Este ponteiro de função é chamado sempre que o estado do joiner muda.

Detalhes
Parâmetros
[in] aEvent
O tipo de evento joiner.
[in] aJoinerInfo
Um ponteiro para as informações do marceneiro.
[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 Joiner 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 PAN ID.

Detalhes
Parâmetros
[in] aPanId
O valor do PAN ID.
[in] aChannelMask
O valor da máscara do 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)

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

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 no aEnergyListLength .
[in] aContext
Um ponteiro para o contexto específico do aplicativo.

otCommissioningDataset

struct otCommissioningDataset otCommissioningDataset

Esta estrutura representa um conjunto de dados de comissionamento.

otJoinerInfo

struct otJoinerInfo otJoinerInfo

Esta estrutura representa um Joiner Info.

otJoinerInfoType

enum otJoinerInfoType otJoinerInfoType

Esta enumeração define um tipo de informação de associador.

otJoinerPskd

struct otJoinerPskd otJoinerPskd

Esta estrutura representa um Joiner PSKd.

otSteeringData

struct otSteeringData otSteeringData

Esta estrutura representa os dados de 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 Joiner.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aEui64
Um ponteiro para o IEEE EUI-64 ou 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.
Valores Retornados
OT_ERROR_NONE
Adicionado com sucesso o Joiner.
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
)

Esta função adiciona uma entrada de Joiner com um determinado valor de Joiner Discerner.

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

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aChannelMask
O valor da máscara do 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.
Valores Retornados
OT_ERROR_NONE
A mensagem Announce Begin foi colocada na fila com sucesso.
OT_ERROR_NO_BUFS
Buffers insuficientes para gerar uma mensagem de anúncio de início.
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 do Energy Scan.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância 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 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 do Relatório de Energia.
[in] aContext
Um ponteiro para o contexto específico do aplicativo.
Valores Retornados
OT_ERROR_NONE
Enfileirou com sucesso a mensagem Energy Scan Query.
OT_ERROR_NO_BUFS
Buffers insuficientes para gerar uma mensagem de consulta de varredura 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 marcador na posição do aIterator.

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

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 OpenThread.
Devoluções
Um ponteiro para a string do 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 OpenThread.
Devoluções
O ID da sessão do comissário atual.

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 OpenThread.
Valores Retornados
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 PAN ID.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aPanId
O PAN ID 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 PAN ID.
[in] aContext
Um ponteiro para o contexto específico do aplicativo.
Valores Retornados
OT_ERROR_NONE
Mensagem de consulta do PAN ID colocada na fila com sucesso.
OT_ERROR_NO_BUFS
Buffers insuficientes para gerar uma mensagem de consulta PAN ID.
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 OpenThread.
[in] aEui64
Um ponteiro para o IEEE EUI-64 ou NULL do Joiner para qualquer Joiner.
Valores Retornados
OT_ERROR_NONE
Removido com sucesso o Joiner.
OT_ERROR_NOT_FOUND
O Joiner especificado pelo 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 OpenThread.
[in] aEui64
Um ponteiro para o Discerner Joiner.
Valores Retornados
OT_ERROR_NONE
Removido com sucesso o Joiner.
OT_ERROR_NOT_FOUND
O Joiner especificado pelo 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 OpenThread.
[in] aTlvs
Um ponteiro para TLVs.
[in] aLength
O comprimento dos TLVs.
Valores Retornados
OT_ERROR_NONE
Envie com sucesso o comando meshcop dataset.
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
)

Esta função envia MGMT_COMMISSIONER_SET.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aDataset
Um indicador para o conjunto de dados de comissionamento.
[in] aTlvs
Um ponteiro para TLVs.
[in] aLength
O comprimento dos TLVs.
Valores Retornados
OT_ERROR_NONE
Envie com sucesso o comando meshcop dataset.
OT_ERROR_NO_BUFS
Espaço de buffer insuficiente 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 OpenThread.
[in] aProvisioningUrl
Um ponteiro para a URL de provisionamento (pode ser NULL para definir como string vazia).
Valores Retornados
OT_ERROR_NONE
Defina o URL de provisionamento com sucesso.
OT_ERROR_INVALID_ARGS
aProvisioningUrl é inválido (muito tempo).

otCommissionerStart

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

Esta função ativa a função Thread Commissioner.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância 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 joiner.
[in] aCallbackContext
Um ponteiro para o contexto específico do aplicativo.
Valores Retornados
OT_ERROR_NONE
Iniciou com sucesso o serviço de comissário.
OT_ERROR_ALREADY
O comissário já começou.
OT_ERROR_INVALID_STATE
O dispositivo não está conectado a uma rede no momento.

otCommissionerStop

otError otCommissionerStop(
  otInstance *aInstance
)

Esta função desativa a função Thread Commissioner.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
Valores Retornados
OT_ERROR_NONE
O serviço de Comissário foi interrompido com sucesso.
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 frase de acesso de comissionamento.

OT_COMMISSIONING_PASSPHRASE_MIN_SIZE

 OT_COMMISSIONING_PASSPHRASE_MIN_SIZE 6

Tamanho mínimo da frase de acesso 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 caractere nulo).

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 de dados de direção (bytes)