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

Conjunto de dados operacionais

Este módulo inclui funções para Dataset Updater.

Resumo

As funções neste módulo estão disponíveis quando o recurso Dataset Updater está habilitado (ou seja, OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE está definido como 1). Além disso, esse recurso está disponível apenas em uma versão FTD.

Enumerações

otMeshcopTlvType {
OT_MESHCOP_TLV_CHANNEL = 0,
OT_MESHCOP_TLV_PANID = 1,
OT_MESHCOP_TLV_EXTPANID = 2,
OT_MESHCOP_TLV_NETWORKNAME = 3,
OT_MESHCOP_TLV_PSKC = 4,
OT_MESHCOP_TLV_NETWORKKEY = 5,
OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE = 6,
OT_MESHCOP_TLV_MESHLOCALPREFIX = 7,
OT_MESHCOP_TLV_STEERING_DATA = 8,
OT_MESHCOP_TLV_BORDER_AGENT_RLOC = 9,
OT_MESHCOP_TLV_COMMISSIONER_ID = 10,
OT_MESHCOP_TLV_COMM_SESSION_ID = 11,
OT_MESHCOP_TLV_SECURITYPOLICY = 12,
OT_MESHCOP_TLV_GET = 13,
OT_MESHCOP_TLV_ACTIVETIMESTAMP = 14,
OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT = 15,
OT_MESHCOP_TLV_STATE = 16,
OT_MESHCOP_TLV_JOINER_DTLS = 17,
OT_MESHCOP_TLV_JOINER_UDP_PORT = 18,
OT_MESHCOP_TLV_JOINER_IID = 19,
OT_MESHCOP_TLV_JOINER_RLOC = 20,
OT_MESHCOP_TLV_JOINER_ROUTER_KEK = 21,
OT_MESHCOP_TLV_PROVISIONING_URL = 32,
OT_MESHCOP_TLV_VENDOR_NAME_TLV = 33,
OT_MESHCOP_TLV_VENDOR_MODEL_TLV = 34,
OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV = 35,
OT_MESHCOP_TLV_VENDOR_DATA_TLV = 36,
OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV = 37,
OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV = 48,
OT_MESHCOP_TLV_IPV6_ADDRESS_TLV = 49,
OT_MESHCOP_TLV_PENDINGTIMESTAMP = 51,
OT_MESHCOP_TLV_DELAYTIMER = 52,
OT_MESHCOP_TLV_CHANNELMASK = 53,
OT_MESHCOP_TLV_COUNT = 54,
OT_MESHCOP_TLV_PERIOD = 55,
OT_MESHCOP_TLV_SCAN_DURATION = 56,
OT_MESHCOP_TLV_ENERGY_LIST = 57,
OT_MESHCOP_TLV_DISCOVERYREQUEST = 128,
OT_MESHCOP_TLV_DISCOVERYRESPONSE = 129,
OT_MESHCOP_TLV_JOINERADVERTISEMENT = 241
}
enumerar
Esta enumeração representa os tipos de TLV do meshcop.

Typedefs

otChannelMask typedef
uint32_t
Este tipo representa a Máscara de Canal.
otDatasetMgmtSetCallback )(otError aResult, void *aContext) typedef
void(*
Esse ponteiro de função é chamado quando uma resposta a uma solicitação MGMT_SET é recebida ou expira.
otDatasetUpdaterCallback )(otError aError, void *aContext) typedef
void(*
Esse ponteiro de função de retorno de chamada é chamado quando uma solicitação de atualização do conjunto de dados é concluída, relatando o status de sucesso ou falha da solicitação de atualização do conjunto de dados.
otExtendedPanId typedef
Essa estrutura representa um Extended PAN ID.
otMeshLocalPrefix typedef
Essa estrutura representa um prefixo local de malha.
otMeshcopTlvType typedef
Esta enumeração representa os tipos de TLV do meshcop.
otNetworkKey typedef
struct otNetworkKey
Essa estrutura representa uma chave de rede de thread.
otNetworkKeyRef typedef
Este tipo de dados representa KeyRef para NetworkKey.
otNetworkName typedef
Essa estrutura representa um nome de rede.
otOperationalDataset typedef
Essa estrutura representa um conjunto de dados operacional ativo ou pendente.
otOperationalDatasetComponents typedef
Essa estrutura representa a presença de diferentes componentes no conjunto de dados operacional ativo ou pendente.
otOperationalDatasetTlvs typedef
Essa estrutura representa um conjunto de dados operacional ativo ou pendente.
otPskc typedef
struct otPskc
Esta estrutura representa um PSKc.
otPskcRef typedef
Este tipo de dados representa KeyRef para PSKc.
otSecurityPolicy typedef
Esta estrutura representa a Política de Segurança.

Variáveis

OT_TOOL_PACKED_END

Funções

otDatasetCreateNewNetwork ( otInstance *aInstance, otOperationalDataset *aDataset)
Este método cria um novo Conjunto de Dados Operacionais para usar ao formar uma nova rede.
otDatasetGeneratePskc (const char *aPassPhrase, const otNetworkName *aNetworkName, const otExtendedPanId *aExtPanId, otPskc *aPskc)
Esta função gera PSKc a partir de uma determinada senha, nome de rede e ID de PAN estendido.
otDatasetGetActive ( otInstance *aInstance, otOperationalDataset *aDataset)
Esta função obtém o Conjunto de Dados Operacional Ativo.
otDatasetGetActiveTlvs ( otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
Esta função obtém o Conjunto de Dados Operacional Ativo.
otDatasetGetDelayTimerMinimal ( otInstance *aInstance)
uint32_t
Obtenha um temporizador de atraso mínimo.
otDatasetGetPending ( otInstance *aInstance, otOperationalDataset *aDataset)
Esta função obtém o conjunto de dados operacional pendente.
otDatasetGetPendingTlvs ( otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
Esta função obtém o conjunto de dados operacional pendente.
otDatasetIsCommissioned ( otInstance *aInstance)
bool
Esta função indica se uma rede válida está presente no Active Operational Dataset ou não.
otDatasetParseTlvs (const otOperationalDatasetTlvs *aDatasetTlvs, otOperationalDataset *aDataset)
Essa função analisa um conjunto de dados operacional de um otOperationalDatasetTlvs .
otDatasetSendMgmtActiveGet ( otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
Esta função envia MGMT_ACTIVE_GET.
otDatasetSendMgmtActiveSet ( otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
Esta função envia MGMT_ACTIVE_SET.
otDatasetSendMgmtPendingGet ( otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
Esta função envia MGMT_PENDING_GET.
otDatasetSendMgmtPendingSet ( otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
Esta função envia MGMT_PENDING_SET.
otDatasetSetActive ( otInstance *aInstance, const otOperationalDataset *aDataset)
Esta função define o Conjunto de Dados Operacional Ativo.
otDatasetSetActiveTlvs ( otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
Esta função define o Conjunto de Dados Operacional Ativo.
otDatasetSetDelayTimerMinimal ( otInstance *aInstance, uint32_t aDelayTimerMinimal)
Defina o temporizador de atraso mínimo.
otDatasetSetPending ( otInstance *aInstance, const otOperationalDataset *aDataset)
Esta função define o conjunto de dados operacional pendente.
otDatasetSetPendingTlvs ( otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
Esta função define o conjunto de dados operacional pendente.
otDatasetUpdaterCancelUpdate ( otInstance *aInstance)
void
Esta função cancela uma solicitação de atualização do Conjunto de Dados Operacionais em andamento (se houver).
otDatasetUpdaterIsUpdateOngoing ( otInstance *aInstance)
bool
Essa função indica se há uma solicitação de atualização do Conjunto de Dados da Operação em andamento.
otDatasetUpdaterRequestUpdate ( otInstance *aInstance, const otOperationalDataset *aDataset, otDatasetUpdaterCallback aCallback, void *aContext)
Esta função solicita uma atualização do Conjunto de Dados Operacionais.
otNetworkNameFromString ( otNetworkName *aNetworkName, const char *aNameString)
Essa função define uma instância otNetworkName de uma determinada string C terminada em nulo.

Estruturas

otExtendedPanId

Essa estrutura representa um Extended PAN ID.

otNetworkKey

Essa estrutura representa uma chave de rede de thread.

otNetworkName

Essa estrutura representa um nome de rede.

otOperationalDataset

Essa estrutura representa um conjunto de dados operacional ativo ou pendente.

otOperationalDatasetComponents

Essa estrutura representa a presença de diferentes componentes no conjunto de dados operacional ativo ou pendente.

otOperationalDatasetTlvs

Essa estrutura representa um conjunto de dados operacional ativo ou pendente.

otPskc

Esta estrutura representa PSKc.

otSecurityPolicy

Esta estrutura representa a Política de Segurança.

Enumerações

otMeshcopTlvType

 otMeshcopTlvType

Esta enumeração representa os tipos de TLV do meshcop.

Propriedades
OT_MESHCOP_TLV_ACTIVETIMESTAMP

Meshcop Active Timestamp TLV

OT_MESHCOP_TLV_BORDER_AGENT_RLOC

meshcop localizador de agente de fronteira TLV

OT_MESHCOP_TLV_CHANNEL

Meshcop Canal TLV

OT_MESHCOP_TLV_CHANNELMASK

Meshcop Channel Mask TLV

OT_MESHCOP_TLV_COMMISSIONER_ID

Meshcop Comissário ID TLV

OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT

Meshcop Comissário UDP Port TLV

OT_MESHCOP_TLV_COMM_SESSION_ID

Meshcop Comissário Sessão ID TLV

OT_MESHCOP_TLV_COUNT

Meshcop Conde TLV

OT_MESHCOP_TLV_DELAYTIMER

Meshcop Temporizador de Atraso TLV

OT_MESHCOP_TLV_DISCOVERYREQUEST

TLV da solicitação de descoberta do meshcop

OT_MESHCOP_TLV_DISCOVERYRESPONSE

meshcop Discovery Response TLV

OT_MESHCOP_TLV_ENERGY_LIST

Lista de Energia meshcop TLV

OT_MESHCOP_TLV_EXTPANID

Meshcop Extended Pan Id TLV

OT_MESHCOP_TLV_GET

meshcop Obter TLV

OT_MESHCOP_TLV_IPV6_ADDRESS_TLV

endereço IPv6 meshcop TLV

OT_MESHCOP_TLV_JOINERADVERTISEMENT

Anúncio de Marceneiro Meshcop TLV

OT_MESHCOP_TLV_JOINER_DTLS

Meshcop Joiner DTLS Encapsulamento TLV

OT_MESHCOP_TLV_JOINER_IID

Meshcop Joiner IID TLV

OT_MESHCOP_TLV_JOINER_RLOC

localizador de roteador meshcop Joiner TLV

OT_MESHCOP_TLV_JOINER_ROUTER_KEK

Meshcop Joiner Router KEK TLV

OT_MESHCOP_TLV_JOINER_UDP_PORT

Meshcop Joiner Porta UDP TLV

OT_MESHCOP_TLV_MESHLOCALPREFIX

meshcop Mesh Local Prefix TLV

OT_MESHCOP_TLV_NETWORKKEY

Chave de rede meshcop TLV

OT_MESHCOP_TLV_NETWORKNAME

Nome da Rede Meshcop TLV

OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE

Sequência de Chaves de Rede Meshcop TLV

OT_MESHCOP_TLV_PANID

Meshcop Pan Id TLV

OT_MESHCOP_TLV_PENDINGTIMESTAMP

Meshcop Pendente Timestamp TLV

OT_MESHCOP_TLV_PERIOD

Período meshcop TLV

OT_MESHCOP_TLV_PROVISIONING_URL

URL de provisionamento meshcop TLV

OT_MESHCOP_TLV_PSKC

meshcop PSKc TLV

OT_MESHCOP_TLV_SCAN_DURATION

Meshcop Duração da Varredura TLV

OT_MESHCOP_TLV_SECURITYPOLICY

Política de segurança meshcop TLV

OT_MESHCOP_TLV_STATE

Meshcop State TLV

OT_MESHCOP_TLV_STEERING_DATA

Dados de direção meshcop TLV

OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV

encapsulamento meshcop UDP TLV

OT_MESHCOP_TLV_VENDOR_DATA_TLV

Dados do fornecedor meshcop TLV

OT_MESHCOP_TLV_VENDOR_MODEL_TLV

Meshcop Vendor Modelo TLV

OT_MESHCOP_TLV_VENDOR_NAME_TLV

Meshcop Nome do Fornecedor TLV

OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV

Meshcop Vendor Stack Versão TLV

OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV

Meshcop Vendor SW Versão TLV

Typedefs

otChannelMask

uint32_t otChannelMask

Este tipo representa a Máscara de Canal.

otDatasetMgmtSetCallback

void(* otDatasetMgmtSetCallback)(otError aResult, void *aContext)

Esse ponteiro de função é chamado quando uma resposta a uma solicitação MGMT_SET é recebida ou expira.

Detalhes
Parâmetros
[in] aResult
Resultado da operação.
[in] aContext
Um ponteiro para o contexto específico do aplicativo.
Valores de retorno
OT_ERROR_NONE
O pedido foi aceito pelo líder.
OT_ERROR_REJECTED
O pedido foi rejeitado pelo líder.
OT_ERROR_PARSE
Ocorreu um erro durante a análise da resposta.
OT_ERROR_ABORT
A solicitação foi redefinida por peer.
OT_ERROR_RESPONSE_TIMEOUT
Nenhuma resposta ou confirmação recebida durante o período de tempo limite.

otDatasetUpdaterCallback

void(* otDatasetUpdaterCallback)(otError aError, void *aContext)

Esse ponteiro de função de retorno de chamada é chamado quando uma solicitação de atualização do conjunto de dados é concluída, relatando o status de sucesso ou falha da solicitação de atualização do conjunto de dados.

Detalhes
Parâmetros
[in] aError
O estado de erro. OT_ERROR_NONE indica atualização bem-sucedida do conjunto de dados. OT_ERROR_INVALID_STATE indica falha devido a estado inválido (MLE desabilitado). OT_ERROR_ALREADY indica falha devido a outro dispositivo na rede solicitando uma atualização de conjunto de dados conflitante.
[in] aContext
Um ponteiro para o contexto arbitrário (fornecido pelo usuário em otDatasetUpdaterRequestUpdate() ).

otExtendedPanId

struct otExtendedPanId otExtendedPanId

Essa estrutura representa um Extended PAN ID.

otMeshLocalPrefix

otIp6NetworkPrefix otMeshLocalPrefix

Essa estrutura representa um prefixo local de malha.

otMeshcopTlvType

enum otMeshcopTlvType otMeshcopTlvType

Esta enumeração representa os tipos de TLV do meshcop.

otNetworkKey

struct otNetworkKey otNetworkKey

Essa estrutura representa uma chave de rede de thread.

otNetworkKeyRef

otCryptoKeyRef otNetworkKeyRef

Este tipo de dados representa KeyRef para NetworkKey.

Referência à chave

otNetworkName

struct otNetworkName otNetworkName

Essa estrutura representa um nome de rede.

O otNetworkName é uma string C terminada em nulo (ou seja, m8 char array DEVE terminar com null char \0 ).

otOperationalDataset

struct otOperationalDataset otOperationalDataset

Essa estrutura representa um conjunto de dados operacional ativo ou pendente.

Os componentes no Dataset são opcionais. A estrutura mComponets especifica quais componentes estão presentes no Dataset.

otOperationalDatasetComponents

struct otOperationalDatasetComponents otOperationalDatasetComponents

Essa estrutura representa a presença de diferentes componentes no conjunto de dados operacional ativo ou pendente.

otOperationalDatasetTlvs

struct otOperationalDatasetTlvs otOperationalDatasetTlvs

Essa estrutura representa um conjunto de dados operacional ativo ou pendente.

O Conjunto de Dados Operacional é codificado em TLV conforme especificado por Thread.

otPskc

struct otPskc otPskc

Esta estrutura representa um PSKc.

otPskcRef

otCryptoKeyRef otPskcRef

Este tipo de dados representa KeyRef para PSKc.

Referência à chave

otSecurityPolicy

struct otSecurityPolicy otSecurityPolicy

Esta estrutura representa a Política de Segurança.

Variáveis

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otNetworkKey OT_TOOL_PACKED_END

Funções

otDatasetCriarNovaRede

otError otDatasetCreateNewNetwork(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Este método cria um novo Conjunto de Dados Operacionais para usar ao formar uma nova rede.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[out] aDataset
O Conjunto de Dados Operacionais.
Valores de retorno
OT_ERROR_NONE
Um novo conjunto de dados operacional foi criado com sucesso.
OT_ERROR_FAILED
Falha ao gerar valores aleatórios para novos parâmetros.

otDatasetGeneratePskc

otError otDatasetGeneratePskc(
  const char *aPassPhrase,
  const otNetworkName *aNetworkName,
  const otExtendedPanId *aExtPanId,
  otPskc *aPskc
)

Esta função gera PSKc a partir de uma determinada senha, nome de rede e ID de PAN estendido.

PSKc é usado para estabelecer a Sessão do Comissário.

Detalhes
Parâmetros
[in] aPassPhrase
A senha de comissionamento.
[in] aNetworkName
O nome da rede para computação PSKc.
[in] aExtPanId
O ID PAN estendido para cálculo PSKc.
[out] aPskc
Um ponteiro para variável para gerar o PSKc gerado.
Valores de retorno
OT_ERROR_NONE
Gere PSKc com sucesso.
OT_ERROR_INVALID_ARGS
Se algum dos argumentos de entrada for inválido.

otDatasetGetActive

otError otDatasetGetActive(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Esta função obtém o Conjunto de Dados Operacional Ativo.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[out] aDataset
Um ponteiro para onde o Conjunto de Dados Operacional Ativo será colocado.
Valores de retorno
OT_ERROR_NONE
O conjunto de dados operacional ativo foi recuperado com êxito.
OT_ERROR_NOT_FOUND
Nenhum valor correspondente no armazenamento de configuração.

otDatasetGetActiveTlvs

otError otDatasetGetActiveTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

Esta função obtém o Conjunto de Dados Operacional Ativo.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[out] aDataset
Um ponteiro para onde o Conjunto de Dados Operacional Ativo será colocado.
Valores de retorno
OT_ERROR_NONE
O conjunto de dados operacional ativo foi recuperado com êxito.
OT_ERROR_NOT_FOUND
Nenhum valor correspondente no armazenamento de configuração.

otDatasetGetDelayTimerMinimal

uint32_t otDatasetGetDelayTimerMinimal(
  otInstance *aInstance
)

Obtenha um temporizador de atraso mínimo.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
Valores de retorno
the
valor do temporizador de atraso mínimo (em ms).

otDatasetGetPending

otError otDatasetGetPending(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Esta função obtém o conjunto de dados operacional pendente.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[out] aDataset
Um ponteiro para onde o Conjunto de Dados Operacionais Pendentes será colocado.
Valores de retorno
OT_ERROR_NONE
O conjunto de dados operacional pendente foi recuperado com êxito.
OT_ERROR_NOT_FOUND
Nenhum valor correspondente no armazenamento de configuração.

otDatasetGetPendingTlvs

otError otDatasetGetPendingTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

Esta função obtém o conjunto de dados operacional pendente.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[out] aDataset
Um ponteiro para onde o Conjunto de Dados Operacionais Pendentes será colocado.
Valores de retorno
OT_ERROR_NONE
O conjunto de dados operacional pendente foi recuperado com êxito.
OT_ERROR_NOT_FOUND
Nenhum valor correspondente no armazenamento de configuração.

otDatasetIsComissioned

bool otDatasetIsCommissioned(
  otInstance *aInstance
)

Esta função indica se uma rede válida está presente no Active Operational Dataset ou não.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
Devoluções
TRUE se uma rede válida estiver presente no Active Operational Dataset, FALSE caso contrário.

otDatasetParseTlvs

otError otDatasetParseTlvs(
  const otOperationalDatasetTlvs *aDatasetTlvs,
  otOperationalDataset *aDataset
)

Essa função analisa um conjunto de dados operacional de um otOperationalDatasetTlvs .

Detalhes
Parâmetros
[in] aDatasetTlvs
Um ponteiro para TLVs de conjunto de dados.
[out] aDataset
Um ponteiro para onde o conjunto de dados será colocado.
Valores de retorno
OT_ERROR_NONE
Definido com sucesso aDataset de aDatasetTlvs .
OT_ERROR_INVALID_ARGS
aDatasetTlvs é inválido.

otDatasetSendMgmtActiveGet

otError otDatasetSendMgmtActiveGet(
  otInstance *aInstance,
  const otOperationalDatasetComponents *aDatasetComponents,
  const uint8_t *aTlvTypes,
  uint8_t aLength,
  const otIp6Address *aAddress
)

Esta função envia MGMT_ACTIVE_GET.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aDatasetComponents
Um ponteiro para uma estrutura de componentes do conjunto de dados especificando quais componentes solicitar.
[in] aTlvTypes
Um ponteiro para array contendo tipos de TLV brutos adicionais a serem solicitados.
[in] aLength
O comprimento de aTlvTypes .
[in] aAddress
Um ponteiro para o destino IPv6, se for NULL, usará Leader ALOC como padrão.
Valores de retorno
OT_ERROR_NONE
Envie com sucesso o comando meshcop dataset.
OT_ERROR_NO_BUFS
Espaço de buffer insuficiente para enviar.

otDatasetSendMgmtActiveSet

otError otDatasetSendMgmtActiveSet(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength,
  otDatasetMgmtSetCallback aCallback,
  void *aContext
)

Esta função envia MGMT_ACTIVE_SET.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aDataset
Um ponteiro para o conjunto de dados operacional.
[in] aTlvs
Um ponteiro para TLVs.
[in] aLength
O comprimento dos TLVs.
[in] aCallback
Um ponteiro para uma função que é chamada na recepção da resposta ou no tempo limite.
[in] aContext
Um ponteiro para o contexto específico do aplicativo para aCallback .
Valores de retorno
OT_ERROR_NONE
Envie com sucesso o comando meshcop dataset.
OT_ERROR_NO_BUFS
Espaço de buffer insuficiente para enviar.
OT_ERROR_BUSY
Uma solicitação anterior está em andamento.

otDatasetSendMgmtPendingGet

otError otDatasetSendMgmtPendingGet(
  otInstance *aInstance,
  const otOperationalDatasetComponents *aDatasetComponents,
  const uint8_t *aTlvTypes,
  uint8_t aLength,
  const otIp6Address *aAddress
)

Esta função envia MGMT_PENDING_GET.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aDatasetComponents
Um ponteiro para uma estrutura de componentes do conjunto de dados especificando quais componentes solicitar.
[in] aTlvTypes
Um ponteiro para array contendo tipos de TLV brutos adicionais a serem solicitados.
[in] aLength
O comprimento de aTlvTypes .
[in] aAddress
Um ponteiro para o destino IPv6, se for NULL, usará Leader ALOC como padrão.
Valores de retorno
OT_ERROR_NONE
Envie com sucesso o comando meshcop dataset.
OT_ERROR_NO_BUFS
Espaço de buffer insuficiente para enviar.

otDatasetSendMgmtPendingSet

otError otDatasetSendMgmtPendingSet(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength,
  otDatasetMgmtSetCallback aCallback,
  void *aContext
)

Esta função envia MGMT_PENDING_SET.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aDataset
Um ponteiro para o conjunto de dados operacional.
[in] aTlvs
Um ponteiro para TLVs.
[in] aLength
O comprimento dos TLVs.
[in] aCallback
Um ponteiro para uma função que é chamada na recepção da resposta ou no tempo limite.
[in] aContext
Um ponteiro para o contexto específico do aplicativo para aCallback .
Valores de retorno
OT_ERROR_NONE
Envie com sucesso o comando meshcop dataset.
OT_ERROR_NO_BUFS
Espaço de buffer insuficiente para enviar.
OT_ERROR_BUSY
Uma solicitação anterior está em andamento.

otDatasetSetActive

otError otDatasetSetActive(
  otInstance *aInstance,
  const otOperationalDataset *aDataset
)

Esta função define o Conjunto de Dados Operacional Ativo.

Se o conjunto de dados não incluir um carimbo de data/hora ativo, o conjunto de dados estará apenas parcialmente completo.

Se o Thread estiver habilitado em um dispositivo que tenha um Conjunto de Dados Ativo parcialmente completo, o dispositivo tentará se conectar a uma rede Thread existente usando qualquer informação existente no conjunto de dados. Somente a chave de rede de thread é necessária para conectar a uma rede.

Se o canal não estiver incluído no conjunto de dados, o dispositivo enviará mensagens de anúncio MLE em diferentes canais para encontrar vizinhos em outros canais.

Se o dispositivo se conectar com sucesso a uma rede Thread, o dispositivo recuperará o conjunto de dados ativo completo de seu pai. Observe que um dispositivo com capacidade de roteador não fará a transição para as funções de roteador ou líder até que tenha um conjunto de dados ativo completo.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aDataset
Um ponteiro para o conjunto de dados operacional ativo.
Valores de retorno
OT_ERROR_NONE
Defina com êxito o conjunto de dados operacional ativo.
OT_ERROR_NO_BUFS
Espaço de buffer insuficiente para definir o conjunto de dados operacional ativo.
OT_ERROR_NOT_IMPLEMENTED
A plataforma não implementa a funcionalidade de configurações.

otDatasetSetActiveTlvs

otError otDatasetSetActiveTlvs(
  otInstance *aInstance,
  const otOperationalDatasetTlvs *aDataset
)

Esta função define o Conjunto de Dados Operacional Ativo.

Se o conjunto de dados não incluir um carimbo de data/hora ativo, o conjunto de dados estará apenas parcialmente completo.

Se o Thread estiver habilitado em um dispositivo que tenha um Conjunto de Dados Ativo parcialmente completo, o dispositivo tentará se conectar a uma rede Thread existente usando qualquer informação existente no conjunto de dados. Somente a chave de rede de thread é necessária para conectar a uma rede.

Se o canal não estiver incluído no conjunto de dados, o dispositivo enviará mensagens de anúncio MLE em diferentes canais para encontrar vizinhos em outros canais.

Se o dispositivo se conectar com sucesso a uma rede Thread, o dispositivo recuperará o conjunto de dados ativo completo de seu pai. Observe que um dispositivo com capacidade de roteador não fará a transição para as funções de roteador ou líder até que tenha um conjunto de dados ativo completo.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aDataset
Um ponteiro para o conjunto de dados operacional ativo.
Valores de retorno
OT_ERROR_NONE
Defina com êxito o conjunto de dados operacional ativo.
OT_ERROR_NO_BUFS
Espaço de buffer insuficiente para definir o conjunto de dados operacional ativo.
OT_ERROR_NOT_IMPLEMENTED
A plataforma não implementa a funcionalidade de configurações.

otDatasetSetDelayTimerMinimal

otError otDatasetSetDelayTimerMinimal(
  otInstance *aInstance,
  uint32_t aDelayTimerMinimal
)

Defina o temporizador de atraso mínimo.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aDelayTimerMinimal
O valor do temporizador de atraso mínimo (em ms).
Valores de retorno
OT_ERROR_NONE
Temporizador de atraso mínimo definido com sucesso.
OT_ERROR_INVALID_ARGS
Se aDelayTimerMinimal não for válido.

otDatasetSetPending

otError otDatasetSetPending(
  otInstance *aInstance,
  const otOperationalDataset *aDataset
)

Esta função define o conjunto de dados operacional pendente.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aDataset
Um ponteiro para o conjunto de dados operacional pendente.
Valores de retorno
OT_ERROR_NONE
Defina com êxito o conjunto de dados operacional pendente.
OT_ERROR_NO_BUFS
Espaço de buffer insuficiente para definir o conjunto de dados operacional pendente.
OT_ERROR_NOT_IMPLEMENTED
A plataforma não implementa a funcionalidade de configurações.

otDatasetSetPendingTlvs

otError otDatasetSetPendingTlvs(
  otInstance *aInstance,
  const otOperationalDatasetTlvs *aDataset
)

Esta função define o conjunto de dados operacional pendente.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aDataset
Um ponteiro para o conjunto de dados operacional pendente.
Valores de retorno
OT_ERROR_NONE
Defina com êxito o conjunto de dados operacional pendente.
OT_ERROR_NO_BUFS
Espaço de buffer insuficiente para definir o conjunto de dados operacional pendente.
OT_ERROR_NOT_IMPLEMENTED
A plataforma não implementa a funcionalidade de configurações.

otDatasetUpdaterCancelUpdate

void otDatasetUpdaterCancelUpdate(
  otInstance *aInstance
)

Esta função cancela uma solicitação de atualização do Conjunto de Dados Operacionais em andamento (se houver).

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.

otDatasetUpdaterIsUpdateOngoing

bool otDatasetUpdaterIsUpdateOngoing(
  otInstance *aInstance
)

Essa função indica se há uma solicitação de atualização do Conjunto de Dados da Operação em andamento.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
Valores de retorno
TRUE
Há uma atualização em andamento.
FALSE
Não há atualização contínua.

otDatasetUpdaterRequestUpdate

otError otDatasetUpdaterRequestUpdate(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  otDatasetUpdaterCallback aCallback,
  void *aContext
)

Esta função solicita uma atualização do Conjunto de Dados Operacionais.

aDataset deve conter os campos a serem atualizados e seu novo valor. Ele não deve conter campos Active ou Pending Timestamp. O campo Delay é opcional, se não for fornecido um valor padrão (1000 ms) seria usado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aDataset
Um ponteiro para o conjunto de dados que contém os campos a serem alterados.
[in] aCallback
Um retorno de chamada para indicar quando a solicitação de atualização do conjunto de dados for concluída.
[in] aContext
Um contexto arbitrário passado para retorno de chamada.
Valores de retorno
OT_ERROR_NONE
A atualização do conjunto de dados foi iniciada com sucesso ( aCallback será invocado após a conclusão).
OT_ERROR_INVALID_STATE
O dispositivo está desabilitado (o MLE está desabilitado).
OT_ERROR_INVALID_ARGS
O aDataset não é válido (contém carimbo de data/hora ativo ou pendente).
OT_ERROR_BUSY
Não é possível iniciar a atualização, uma anterior está em andamento.
OT_ERROR_NO_BUFS
Não foi possível alocar buffer para salvar o conjunto de dados.

otNetworkNameFromString

otError otNetworkNameFromString(
  otNetworkName *aNetworkName,
  const char *aNameString
)

Essa função define uma instância otNetworkName de uma determinada string C terminada em nulo.

Essa função também valida que o aNameString fornecido segue a codificação UTF-8 e seu comprimento não é maior que OT_NETWORK_NAME_MAX_SIZE .

Detalhes
Parâmetros
[out] aNetworkName
Um ponteiro para otNetworkName a ser definido.
[in] aNameString
Uma string C de nome.
Valores de retorno
OT_ERROR_NONE
Definir com êxito aNetworkName de aNameString .
OT_ERROR_INVALID_ARGS
aNameStrng é inválido (muito longo ou não segue a codificação UTF-8).

Macros

OT_CHANNEL_10_MASK

 OT_CHANNEL_10_MASK (1 << 10)

Canal 10.

OT_CHANNEL_11_MASK

 OT_CHANNEL_11_MASK (1 << 11)

Canal 11.

OT_CHANNEL_12_MASK

 OT_CHANNEL_12_MASK (1 << 12)

Canal 12.

OT_CHANNEL_13_MASK

 OT_CHANNEL_13_MASK (1 << 13)

Canal 13.

OT_CHANNEL_14_MASK

 OT_CHANNEL_14_MASK (1 << 14)

Canal 14.

OT_CHANNEL_15_MASK

 OT_CHANNEL_15_MASK (1 << 15)

Canal 15.

OT_CHANNEL_16_MASK

 OT_CHANNEL_16_MASK (1 << 16)

Canal 16.

OT_CHANNEL_17_MASK

 OT_CHANNEL_17_MASK (1 << 17)

Canal 17.

OT_CHANNEL_18_MASK

 OT_CHANNEL_18_MASK (1 << 18)

Canal 18.

OT_CHANNEL_19_MASK

 OT_CHANNEL_19_MASK (1 << 19)

Canal 19.

OT_CHANNEL_1_MASK

 OT_CHANNEL_1_MASK (1 << 1)

Canal 1.

OT_CHANNEL_20_MASK

 OT_CHANNEL_20_MASK (1 << 20)

Canal 20.

OT_CHANNEL_21_MASK

 OT_CHANNEL_21_MASK (1 << 21)

Canal 21.

OT_CHANNEL_22_MASK

 OT_CHANNEL_22_MASK (1 << 22)

Canal 22.

OT_CHANNEL_23_MASK

 OT_CHANNEL_23_MASK (1 << 23)

Canal 23.

OT_CHANNEL_24_MASK

 OT_CHANNEL_24_MASK (1 << 24)

Canal 24.

OT_CHANNEL_25_MASK

 OT_CHANNEL_25_MASK (1 << 25)

Canal 25.

OT_CHANNEL_26_MASK

 OT_CHANNEL_26_MASK (1 << 26)

Canal 26.

OT_CHANNEL_2_MASK

 OT_CHANNEL_2_MASK (1 << 2)

Canal 2.

OT_CHANNEL_3_MASK

 OT_CHANNEL_3_MASK (1 << 3)

Canal 3.

OT_CHANNEL_4_MASK

 OT_CHANNEL_4_MASK (1 << 4)

Canal 4.

OT_CHANNEL_5_MASK

 OT_CHANNEL_5_MASK (1 << 5)

Canal 5.

OT_CHANNEL_6_MASK

 OT_CHANNEL_6_MASK (1 << 6)

Canal 6.

OT_CHANNEL_7_MASK

 OT_CHANNEL_7_MASK (1 << 7)

Canal 7.

OT_CHANNEL_8_MASK

 OT_CHANNEL_8_MASK (1 << 8)

Canal 8.

OT_CHANNEL_9_MASK

 OT_CHANNEL_9_MASK (1 << 9)

Canal 9.

OT_EXT_PAN_ID_SIZE

 OT_EXT_PAN_ID_SIZE 8

Tamanho de um Thread PAN ID (bytes)

OT_MESH_LOCAL_PREFIX_SIZE

 OT_MESH_LOCAL_PREFIX_SIZE OT_IP6_PREFIX_SIZE

Tamanho do prefixo local da malha (bytes)

OT_NETWORK_KEY_SIZE

 OT_NETWORK_KEY_SIZE 16

Tamanho da chave de rede do thread (bytes)

OT_NETWORK_NAME_MAX_SIZE

 OT_NETWORK_NAME_MAX_SIZE 16

Tamanho máximo do campo Thread Network Name (bytes)

OT_OPERATIONAL_DATASET_MAX_LENGTH

 OT_OPERATIONAL_DATASET_MAX_LENGTH 254

Comprimento máximo do conjunto de dados operacional em bytes.

OT_PSKC_MAX_SIZE

 OT_PSKC_MAX_SIZE 16

Tamanho máximo do PSKc (bytes)

Recursos

Os tópicos de referência da API OpenThread se originam do código-fonte, disponível no GitHub . Para obter mais informações ou contribuir com nossa documentação, consulte Recursos .