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.

Geral

Este módulo inclui funções para todos os papéis da Thread.

Resumo

O Network Data Publisher fornece mecanismos para limitar o número de entradas de serviço e/ou prefixo semelhantes (prefixo da malha ou rota externa) nos dados da rede Thread, monitorando os dados de rede e gerenciando se ou quando adicionar ou remover entradas.

Todas as funções neste módulo exigem a ativação de OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE.

Enumerações

anonymous enum{
  OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS = 0,
  OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS = 1,
  OT_NETWORK_DIAGNOSTIC_TLV_MODE = 2,
  OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT = 3,
  OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY = 4,
  OT_NETWORK_DIAGNOSTIC_TLV_ROUTE = 5,
  OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA = 6,
  OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA = 7,
  OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST = 8,
  OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS = 9,
  OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL = 14,
  OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE = 15,
  OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE = 16,
  OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES = 17,
  OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST = 18,
  OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT = 19
}
tipo enumerado
otDeviceRole{
  OT_DEVICE_ROLE_DISABLED = 0,
  OT_DEVICE_ROLE_DETACHED = 1,
  OT_DEVICE_ROLE_CHILD = 2,
  OT_DEVICE_ROLE_ROUTER = 3,
  OT_DEVICE_ROLE_LEADER = 4
}
tipo enumerado
Representa um papel de dispositivo Thread.
otNetDataPublisherEvent{
  OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED = 0,
  OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED = 1
}
tipo enumerado
Essa enumeração representa os eventos informados pelos callbacks do editor.
otRoutePreference{
  OT_ROUTE_PREFERENCE_LOW = -1,
  OT_ROUTE_PREFERENCE_MED = 0,
  OT_ROUTE_PREFERENCE_HIGH = 1
}
tipo enumerado
Define valores válidos para mPreference em otExternalRouteConfig e otBorderRouterConfig.

Typedefs

otBorderRouterConfig typedef
Essa estrutura representa uma configuração do roteador de borda.
otDetachGracefullyCallback)(void *aContext) typedef
void(*
Esse callback informa ao aplicativo que o processo de remoção foi concluído.
otExternalRouteConfig typedef
Essa estrutura representa uma configuração de rota externa.
otIpCounters typedef
struct otIpCounters
Essa estrutura representa os contadores de nível de IP.
otLeaderData typedef
struct otLeaderData
Essa estrutura representa os dados do líder da linha de execução.
otLinkModeConfig typedef
Essa estrutura representa uma configuração do modo de vinculação do MLE.
otMleCounters typedef
struct otMleCounters
Essa estrutura representa os contadores de Thread MLE.
otNeighborInfoIterator typedef
int16_t
Usado para iterar por meio da tabela vizinha.
otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext) typedef
void(*
Esse tipo de ponteiro de função define o callback usado para notificar quando uma entrada "DNS/SRP Service" é adicionada ou removida dos dados da rede Thread.
otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext) typedef
void(*
Esse tipo de ponteiro de função define o callback usado para notificar quando uma entrada de prefixo (em malha ou externa) é adicionada ou removida dos dados da rede Thread.
otNetDataPublisherEvent typedef
Essa enumeração representa os eventos informados pelos callbacks do editor.
otNetworkDataIterator typedef
uint32_t
Usado para iterar por informações de dados da rede.
otNetworkDiagChildEntry typedef
Essa estrutura representa uma entrada da tabela filha de diagnósticos de rede.
otNetworkDiagConnectivity typedef
Essa estrutura representa um valor de conectividade de diagnóstico da rede.
otNetworkDiagIterator typedef
uint16_t
Usado para iterar pelo TLV de diagnóstico de rede.
otNetworkDiagMacCounters typedef
Essa estrutura representa um valor de contadores de diagnóstico da rede do Mac.
otNetworkDiagRoute typedef
Essa estrutura representa um valor de TLV da rota de diagnóstico de rede.
otNetworkDiagRouteData typedef
Essa estrutura representa os dados da rota de diagnóstico de rede.
otNetworkDiagTlv typedef
Essa estrutura representa um TLV de diagnóstico de rede.
otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext) typedef
void(*
Esse ponteiro de função é chamado quando a resposta de recebimento do diagnóstico de rede é recebida.
otRoutePreference typedef
Define valores válidos para mPreference em otExternalRouteConfig e otBorderRouterConfig.
otServerConfig typedef
Essa estrutura representa uma configuração do servidor.
otServiceConfig typedef
Essa estrutura representa uma configuração do serviço.
otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16) typedef
void(*
Esse tipo de ponteiro de função define o callback para notificar o resultado de uma solicitação otThreadLocateAnycastDestination().
otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext) typedef
void(*
Esse ponteiro de função é chamado sempre que uma mensagem de solicitação de descoberta de MLE é recebida.
otThreadDiscoveryRequestInfo typedef
Essa estrutura representa os dados da solicitação de descoberta de linhas de execução.
otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext) typedef
void(*
Esse ponteiro de função é chamado sempre que uma mensagem de resposta pai do MLE é recebida.
otThreadParentResponseInfo typedef
Essa estrutura representa os dados de resposta pai do MLE.

Funções

otNetDataContainsOmrPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
Esta função verifica se um determinado prefixo pode atuar como um prefixo OMR válido, e também os dados de rede da Leader's contêm esse prefixo.
otNetDataGet(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
Esse método fornece uma cópia completa ou estável dos dados da rede Thread da Partition.
otNetDataGetNextOnMeshPrefix(otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
Essa função recebe o próximo prefixo da malha on-line nos dados de rede da partição.
otNetDataGetNextRoute(otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)
Esta função recebe a próxima rota externa nos dados de rede da partição.
otNetDataGetNextService(otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig)
Essa função recebe o próximo serviço nos dados de rede da partição.
otNetDataGetStableVersion(otInstance *aInstance)
uint8_t
Acessar a versão estável dos dados da rede.
otNetDataGetVersion(otInstance *aInstance)
uint8_t
Acessar a versão dos dados de rede.
otNetDataIsDnsSrpServiceAdded(otInstance *aInstance)
bool
Esta função indica se a entrada do "DNS/SRP Service" é adicionada ou não aos dados da rede Thread.
otNetDataIsPrefixAdded(otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
Esta função indica se uma entrada de prefixo publicada (em malha ou rota externa) foi adicionada ou não aos dados da rede Thread.
otNetDataPublishDnsSrpServiceAnycast(otInstance *aInstance, uint8_t aSequenceNUmber)
void
Esta função solicita que o endereço Anycast de serviço de DNS/SRP" seja publicado nos dados da rede Thread.
otNetDataPublishDnsSrpServiceUnicast(otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort)
void
Essa função solicita a publicação de "DNS/SRP serviço Unicast" nos dados da rede Thread.
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(otInstance *aInstance, uint16_t aPort)
void
Essa função solicita a publicação de "DNS/SRP serviço Unicast" nos dados da rede Thread.
otNetDataPublishExternalRoute(otInstance *aInstance, const otExternalRouteConfig *aConfig)
Essa função solicita que um prefixo de rota externo seja publicado nos dados da rede Thread.
otNetDataPublishOnMeshPrefix(otInstance *aInstance, const otBorderRouterConfig *aConfig)
Essa função solicita que um prefixo da malha seja publicado nos dados da rede Thread.
otNetDataSetDnsSrpServicePublisherCallback(otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext)
void
Essa função define um callback para notificar quando um "serviço de DNS/SRP publicado</a> for adicionado ou removido dos dados da rede Thread.
otNetDataSetPrefixPublisherCallback(otInstance *aInstance, otNetDataPrefixPublisherCallback aCallback, void *aContext)
void
Essa função define um callback para notificar quando uma entrada de prefixo publicada é realmente adicionada ou removida dos dados da rede Thread.
otNetDataSteeringDataCheckJoiner(otInstance *aInstance, const otExtAddress *aEui64)
Verificar se os dados de direcionamento incluem um Joiner.
otNetDataSteeringDataCheckJoinerWithDiscerner(otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner)
Verificar se os dados de direcionamento incluem um combinador com um determinado valor de disjuntor.
otNetDataUnpublishDnsSrpService(otInstance *aInstance)
void
Cancela a publicação de qualquer entrada do serviço DNS/SRP (Anycast ou Unicast) adicionada anteriormente dos dados da rede Thread.
otNetDataUnpublishPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
Cancela a publicação de um prefixo de trajeto externo ou de malha já publicado anteriormente.
otThreadBecomeChild(otInstance *aInstance)
Tente reconectar como criança.
otThreadBecomeDetached(otInstance *aInstance)
Desconecte-se da rede Thread.
otThreadDetachGracefully(otInstance *aInstance, otDetachGracefullyCallback aCallback, void *aContext)
Essa função notifica outros nós na rede (se houver) e, em seguida, interrompe a operação do protocolo Thread.
otThreadDeviceRoleToString(otDeviceRole aRole)
const char *
Converta o papel do dispositivo em uma string legível.
otThreadDiscover(otInstance *aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void *aCallbackContext)
Essa função inicia uma verificação do Thread Discovery.
otThreadGetChildTimeout(otInstance *aInstance)
uint32_t
Recebe o tempo limite de linha de execução filha (em segundos) usado ao operar na função filha.
otThreadGetDeviceRole(otInstance *aInstance)
Acessar o papel do dispositivo.
otThreadGetDomainName(otInstance *aInstance)
const char *
Recebe o nome de domínio do Thread.
otThreadGetExtendedPanId(otInstance *aInstance)
const otExtendedPanId *
Recebe o ID do PAN estendido IEEE 802.15.4.
otThreadGetFixedDuaInterfaceIdentifier(otInstance *aInstance)
Recebe o identificador da interface especificado manualmente para o endereço Unicast do domínio Thread.
otThreadGetIp6Counters(otInstance *aInstance)
const otIpCounters *
Recebe os contadores IPv6.
otThreadGetKeySequenceCounter(otInstance *aInstance)
uint32_t
Acesse o thCREDENTIALSSequenceCounter.
otThreadGetKeySwitchGuardTime(otInstance *aInstance)
uint32_t
Receba o thvCPMSwitchGuardTime.
otThreadGetLeaderData(otInstance *aInstance, otLeaderData *aLeaderData)
Essa função recebe os dados do líder da linha de execução.
otThreadGetLeaderRloc(otInstance *aInstance, otIp6Address *aLeaderRloc)
Esta função retorna um ponteiro para o RLOC do líder.
otThreadGetLeaderRouterId(otInstance *aInstance)
uint8_t
Obtenha o ID do roteador do líder.
otThreadGetLeaderWeight(otInstance *aInstance)
uint8_t
Obtenha o peso do líder.
otThreadGetLinkLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
const otIp6Address *
Essa função retorna o endereço multicast de Thread Link-Local All Thread Nodes.
otThreadGetLinkLocalIp6Address(otInstance *aInstance)
const otIp6Address *
Essa função retorna o endereço IPv6 link-local Thread.
otThreadGetLinkMode(otInstance *aInstance)
Acessar a configuração do modo de vinculação do MLE.
otThreadGetMeshLocalEid(otInstance *aInstance)
const otIp6Address *
Essa função retorna um ponteiro para o endereço EID local da malha.
otThreadGetMeshLocalPrefix(otInstance *aInstance)
Essa função retorna um ponteiro para o prefixo local da malha.
otThreadGetMleCounters(otInstance *aInstance)
const otMleCounters *
Recebe os contadores de Thread MLE.
otThreadGetNetworkKey(otInstance *aInstance, otNetworkKey *aNetworkKey)
void
Receba a chave de rede do Thread.
otThreadGetNetworkKeyRef(otInstance *aInstance)
Consiga o otNetworkKeyRef para a chave de rede do Thread.
otThreadGetNetworkName(otInstance *aInstance)
const char *
Encontre o nome da rede Thread.
otThreadGetNextDiagnosticTlv(const otMessage *aMessage, otNetworkDiagIterator *aIterator, otNetworkDiagTlv *aNetworkDiagTlv)
Essa função recebe o próximo TLV de diagnóstico de rede na mensagem.
otThreadGetNextNeighborInfo(otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo)
Essa função recebe as informações do próximo vizinho.
otThreadGetParentAverageRssi(otInstance *aInstance, int8_t *aParentRssi)
A função recupera a RSSI média do pai da linha de execução.
otThreadGetParentInfo(otInstance *aInstance, otRouterInfo *aParentInfo)
A função recupera informações de diagnóstico de um roteador de linha de execução como pai.
otThreadGetParentLastRssi(otInstance *aInstance, int8_t *aLastRssi)
A função recupera o RSSI do último pacote do pai do Thread.
otThreadGetPartitionId(otInstance *aInstance)
uint32_t
Consiga o ID da partição.
otThreadGetRealmLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
const otIp6Address *
Essa função retorna o endereço multicast de Thread Realm-Local All Nodes.
otThreadGetRloc(otInstance *aInstance)
const otIp6Address *
Essa função retorna um ponteiro para o endereço do Localizador de roteamento de linhas de execução (RLOC).
otThreadGetRloc16(otInstance *aInstance)
uint16_t
Acessar o RLOC16.
otThreadGetServiceAloc(otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc)
Esta função recupera a ALOC de serviço para o ID de serviço fornecido.
otThreadGetVersion(void)
uint16_t
Essa função recebe a versão do protocolo Thread.
otThreadIsAnycastLocateInProgress(otInstance *aInstance)
bool
Esta função indica se uma solicitação de localização anycast está em andamento.
otThreadIsDiscoverInProgress(otInstance *aInstance)
bool
Esta função determina se uma descoberta de linha de execução de MLE está em andamento.
otThreadIsSingleton(otInstance *aInstance)
bool
Essa função indica se um nó é o único roteador da rede.
otThreadLocateAnycastDestination(otInstance *aInstance, const otIp6Address *aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext)
Essa função solicita a localização mais próxima de um determinado endereço anycast a ser localizado.
otThreadRegisterParentResponseCallback(otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext)
void
Esta função registra um callback para receber dados da resposta pai do MLE.
otThreadResetIp6Counters(otInstance *aInstance)
void
Redefine os contadores IPv6.
otThreadResetMleCounters(otInstance *aInstance)
void
Redefine os contadores de Thread MLE.
otThreadSearchForBetterParent(otInstance *aInstance)
Inicia o processo de busca de um pai/mãe melhor enquanto continua conectado ao pai atual.
otThreadSendAddressNotification(otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid)
void
Esta função envia uma mensagem proativa de endereço proativo (ADDR_NTF.ntf).
otThreadSendDiagnosticGet(otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext)
Envie uma solicitação de recebimento de diagnóstico de rede.
otThreadSendDiagnosticReset(otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount)
Envie uma solicitação de redefinição de diagnóstico de rede.
otThreadSendProactiveBackboneNotification(otInstance *aInstance, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction)
Esta função envia uma mensagem proativa da espinha dorsal (PRO_BB.ntf) no link da Estrutura.
otThreadSetChildTimeout(otInstance *aInstance, uint32_t aTimeout)
void
Define o tempo limite filho da linha de execução (em segundos) usado ao operar no papel filho filho.
otThreadSetDiscoveryRequestCallback(otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext)
void
Essa função define um callback para receber dados da solicitação de descoberta do MLE.
otThreadSetDomainName(otInstance *aInstance, const char *aDomainName)
Define o nome de domínio da linha de execução.
otThreadSetEnabled(otInstance *aInstance, bool aEnabled)
Esta função inicia a operação do protocolo Thread.
otThreadSetExtendedPanId(otInstance *aInstance, const otExtendedPanId *aExtendedPanId)
Define o ID do PAN estendido IEEE 802.15.4.
otThreadSetFixedDuaInterfaceIdentifier(otInstance *aInstance, const otIp6InterfaceIdentifier *aIid)
Define ou limpa o identificador de interface especificado manualmente para o endereço Unicast do domínio Thread.
otThreadSetJoinerAdvertisement(otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength)
Esse método define a publicidade de junção de linhas de execução ao descobrir a rede Thread.
otThreadSetKeySequenceCounter(otInstance *aInstance, uint32_t aKeySequenceCounter)
void
Defina o thRevisarSequenceCounter.
otThreadSetKeySwitchGuardTime(otInstance *aInstance, uint32_t aKeySwitchGuardTime)
void
Defina o thvCPMSwitchGuardTime.
otThreadSetLinkMode(otInstance *aInstance, otLinkModeConfig aConfig)
Defina a configuração do modo de vinculação do MLE.
otThreadSetMeshLocalPrefix(otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix)
Essa função define o prefixo local da malha.
otThreadSetNetworkKey(otInstance *aInstance, const otNetworkKey *aKey)
Defina a chave de rede Thread.
otThreadSetNetworkKeyRef(otInstance *aInstance, otNetworkKeyRef aKeyRef)
Defina a chave de rede Thread como um otNetworkKeyRef.
otThreadSetNetworkName(otInstance *aInstance, const char *aNetworkName)
Defina o nome da rede Thread.

Estruturas

otBorderRouterConfig

Essa estrutura representa uma configuração do roteador de borda.

otExternalRouteConfig (link em inglês)

Essa estrutura representa uma configuração de rota externa.

otIpCounters (em inglês)

Essa estrutura representa os contadores de nível de IP.

OtLeaderData (em inglês)

Essa estrutura representa os dados do líder da linha de execução.

otLinkModeConfig.

Essa estrutura representa uma configuração do modo de vinculação do MLE.

otMleCounters (em inglês)

Essa estrutura representa os contadores de Thread MLE.

OtNeighborInfo (em inglês)

Essa estrutura contém informações de diagnóstico para um nó Thread vizinho.

otNetworkDiagChildEntry

Essa estrutura representa uma entrada da tabela filha de diagnósticos de rede.

otNetworkDiagConnectivity

Essa estrutura representa um valor de conectividade de diagnóstico da rede.

otNetworkDiagMacCounters

Essa estrutura representa um valor de contadores de diagnóstico da rede do Mac.

otNetworkDiagRoute

Essa estrutura representa um valor de TLV da rota de diagnóstico de rede.

otNetworkDiagRouteData

Essa estrutura representa os dados da rota de diagnóstico de rede.

otNetworkDiagTlv

Essa estrutura representa um TLV de diagnóstico de rede.

otRouterInfo (link em inglês)

Essa estrutura contém informações de diagnóstico para um roteador de linha de execução.

OtServerConfig (link em inglês)

Essa estrutura representa uma configuração do servidor.

otServiceConfig.

Essa estrutura representa uma configuração do serviço.

otThreadDiscoveryRequestInfo (link em inglês)

Essa estrutura representa os dados da solicitação de descoberta de linhas de execução.

otThreadParentResponseInfo (link em inglês)

Essa estrutura representa os dados de resposta pai do MLE.

Enumerações

enumeração anônima

 anonymous enum
Propriedades
OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL

Nível de bateria TLV.

OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES

TLV das páginas do canal.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE

TLV da tabela filha.

OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY

TLV de conectividade.

OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS

TLV do endereço estendido de MAC.

OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST

Lista de endereços IPv6 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA

TLV de dados do líder.

OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS

TLV de contadores MAC.

OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT

TLV de tempo limite filho

OT_NETWORK_DIAGNOSTIC_TLV_MODE

TLV do modo.

OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA

TLV de dados de rede.

OT_NETWORK_DIAGNOSTIC_TLV_ROUTE

TLV da Route64.

OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS

TLV do endereço16.

OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE

Tensão de fornecimento TLV

OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT

Tempo limite de TLV (o tempo máximo de pesquisa para SEDs)

OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST

Digite "TLV".

Função DeviceOt

 otDeviceRole

Representa um papel de dispositivo Thread.

Propriedades
OT_DEVICE_ROLE_CHILD

Papel filho Thread.

OT_DEVICE_ROLE_DETACHED

Não participa de uma rede/partição de linha de execução.

OT_DEVICE_ROLE_DISABLED

A pilha de conversas está desativada.

OT_DEVICE_ROLE_LEADER

Papel de líder de linha de execução

OT_DEVICE_ROLE_ROUTER

Papel de roteador de linha de execução

OtNetDataPublisherEvent

 otNetDataPublisherEvent

Essa enumeração representa os eventos informados pelos callbacks do editor.

Propriedades
OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED

A entrada publicada é adicionada aos dados da rede Thread.

OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED

A entrada publicada é removida dos dados da rede Thread.

OtRoutePreference

 otRoutePreference

Define valores válidos para mPreference em otExternalRouteConfig e otBorderRouterConfig.

Propriedades
OT_ROUTE_PREFERENCE_HIGH

Preferência de trajeto alto.

OT_ROUTE_PREFERENCE_LOW

Preferência de trajeto baixo.

OT_ROUTE_PREFERENCE_MED

Preferência de rota média.

Typedefs

OtBorderRouterConfig

struct otBorderRouterConfig otBorderRouterConfig

Essa estrutura representa uma configuração do roteador de borda.

otDetachGracefulCallback

void(* otDetachGracefullyCallback)(void *aContext)

Esse callback informa ao aplicativo que o processo de remoção foi concluído.

Detalhes
Parâmetros
[in] aContext
Um ponteiro para contextos específicos do aplicativo.

OtExternalRouteConfig

struct otExternalRouteConfig otExternalRouteConfig

Essa estrutura representa uma configuração de rota externa.

OtIpCounters

struct otIpCounters otIpCounters

Essa estrutura representa os contadores de nível de IP.

Dados de lead

struct otLeaderData otLeaderData

Essa estrutura representa os dados do líder da linha de execução.

OtLinkModeConfig

struct otLinkModeConfig otLinkModeConfig

Essa estrutura representa uma configuração do modo de vinculação do MLE.

Contadores on-line

struct otMleCounters otMleCounters

Essa estrutura representa os contadores de Thread MLE.

OtNeighborInfoIterator

int16_t otNeighborInfoIterator

Usado para iterar por meio da tabela vizinha.

OtNetDataDnsSrpServicePublisherCallback

void(* otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext)

Esse tipo de ponteiro de função define o callback usado para notificar quando uma entrada "DNS/SRP Service" é adicionada ou removida dos dados da rede Thread.

Na remoção, o callback é invocado independentemente de a entrada ser removida pelo Publisher (por exemplo, quando há muitas entradas semelhantes já presentes nos dados da rede) ou por uma chamada explícita para cancelar a publicação da entrada (ou seja, uma chamada para otNetDataUnpublishDnsSrpService()).

Detalhes
Parâmetros
[in] aEvent
Indica o evento (se a entrada foi adicionada ou removida).
[in] aContext
Um ponteiro para contextos específicos do aplicativo.

OtNetDataPrefixPublisherCallback

void(* otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext)

Esse tipo de ponteiro de função define o callback usado para notificar quando uma entrada de prefixo (em malha ou externa) é adicionada ou removida dos dados da rede Thread.

Na remoção, o callback é invocado independentemente de a entrada ser removida pelo Publisher (por exemplo, quando há muitas entradas semelhantes já presentes nos dados da rede) ou por uma chamada explícita para cancelar a publicação da entrada.

Detalhes
Parâmetros
[in] aEvent
Indica o evento (se a entrada foi adicionada ou removida).
[in] aPrefix
Um ponteiro para a entrada de prefixo.
[in] aContext
Um ponteiro para contextos específicos do aplicativo.

OtNetDataPublisherEvent

enum otNetDataPublisherEvent otNetDataPublisherEvent

Essa enumeração representa os eventos informados pelos callbacks do editor.

OtNetworkDataIterator

uint32_t otNetworkDataIterator

Usado para iterar por informações de dados da rede.

OtNetworkDiagChildEntry

struct otNetworkDiagChildEntry otNetworkDiagChildEntry

Essa estrutura representa uma entrada da tabela filha de diagnósticos de rede.

OtNetworkDiagConnectivity

struct otNetworkDiagConnectivity otNetworkDiagConnectivity

Essa estrutura representa um valor de conectividade de diagnóstico da rede.

OtNetworkDiagIterator

uint16_t otNetworkDiagIterator

Usado para iterar pelo TLV de diagnóstico de rede.

OtNetworkDiagMacCounters

struct otNetworkDiagMacCounters otNetworkDiagMacCounters

Essa estrutura representa um valor de contadores de diagnóstico da rede do Mac.

Consulte o RFC 2863 para ver as definições dos campos do membro.

OtNetworkDiagRoute

struct otNetworkDiagRoute otNetworkDiagRoute

Essa estrutura representa um valor de TLV da rota de diagnóstico de rede.

OtNetworkDiagRouteData

struct otNetworkDiagRouteData otNetworkDiagRouteData

Essa estrutura representa os dados da rota de diagnóstico de rede.

OtNetworkDiagTlv

struct otNetworkDiagTlv otNetworkDiagTlv

Essa estrutura representa um TLV de diagnóstico de rede.

OtReceiveDiagnosticGetCallback

void(* otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext)

Esse ponteiro de função é chamado quando a resposta de recebimento do diagnóstico de rede é recebida.

Detalhes
Parâmetros
[in] aError
Erro quando não há resposta.
[in] aMessage
Um ponteiro para o buffer de mensagens que contém o payload de resposta recebido do diagnóstico de rede recebido. Disponível apenas quando aError for OT_ERROR_NONE.
[in] aMessageInfo
Um ponteiro para as informações da mensagem para aMessage. Disponível apenas quando aError for OT_ERROR_NONE.
[in] aContext
Um ponteiro para contextos específicos do aplicativo.

OtRoutePreference

enum otRoutePreference otRoutePreference

Define valores válidos para mPreference em otExternalRouteConfig e otBorderRouterConfig.

OtServerConfig

struct otServerConfig otServerConfig

Essa estrutura representa uma configuração do servidor.

OtServiceConfig

struct otServiceConfig otServiceConfig

Essa estrutura representa uma configuração do serviço.

OtThreadAnycastLocatorCallback

void(* otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16)

Esse tipo de ponteiro de função define o callback para notificar o resultado de uma solicitação otThreadLocateAnycastDestination().

Detalhes
Parâmetros
[in] aContext
Um ponteiro para um contexto arbitrário (fornecido quando o callback é registrado).
[in] aError
Ocorreu um erro ao processar a solicitação. OT_ERROR_NONE indica sucesso. OT_ERROR_RESPONSE_THRESHOLD indica um destino não encontrado. OT_ERROR_ABORT indica que a solicitação foi cancelada.
[in] aMeshLocalAddress
Um ponteiro para o EID local da malha do destino mais próximo do endereço Anycast quando aError é OT_ERROR_NONE. Caso contrário, o valor NULL é NULL.
[in] aRloc16
O RLOC16 do destino, se encontrado. Caso contrário, é o RLOC16 (0xfffe) inválido.

OtThreadDiscoveryRequestCallback

void(* otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext)

Esse ponteiro de função é chamado sempre que uma mensagem de solicitação de descoberta de MLE é recebida.

Detalhes
Parâmetros
[in] aInfo
Um ponteiro para os dados de informações da solicitação de descoberta.
[in] aContext
Um ponteiro para retornar um contexto específico do aplicativo.

OtThreadDiscoveryRequestInfo

struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo

Essa estrutura representa os dados da solicitação de descoberta de linhas de execução.

OtThreadParentResponseCallback

void(* otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext)

Esse ponteiro de função é chamado sempre que uma mensagem de resposta pai do MLE é recebida.

Detalhes
Parâmetros
[in] aInfo
Um ponteiro para um local na pilha que contém os dados de estatísticas.
[in] aContext
Um ponteiro para retornar contexto específico do cliente.

OtThreadParentResponseInfo

struct otThreadParentResponseInfo otThreadParentResponseInfo

Essa estrutura representa os dados de resposta pai do MLE.

Funções

OtNetDataContainsOmrPrefix

bool otNetDataContainsOmrPrefix(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

Esta função verifica se um determinado prefixo pode atuar como um prefixo OMR válido, e também os dados de rede da Leader's contêm esse prefixo.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aPrefix
Um ponteiro para o prefixo IPv6.
Retorna
Se aPrefix é um prefixo OMR válido e os dados de rede do líder são o prefixo OMR aPrefix.

OtNetDataGet

otError otNetDataGet(
  otInstance *aInstance,
  bool aStable,
  uint8_t *aData,
  uint8_t *aDataLength
)

Esse método fornece uma cópia completa ou estável dos dados da rede Thread da Partition.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aStable
TRUE ao copiar a versão estável, FALSE ao copiar a versão completa.
[out] aData
Um ponteiro para o buffer de dados.
[in,out] aDataLength
Na entrada, o tamanho do buffer de dados apontado por aData. Na saída, número de bytes copiados.

Prefixo otNetDataGetNextOnMeshshPrefix

otError otNetDataGetNextOnMeshPrefix(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otBorderRouterConfig *aConfig
)

Essa função recebe o próximo prefixo da malha on-line nos dados de rede da partição.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in,out] aIterator
Um ponteiro para o contexto do iterador de dados de rede. Para conseguir a primeira entrada da malha, defina como OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Um ponteiro para onde as informações do prefixo da malha serão colocadas.
Valores de retorno
OT_ERROR_NONE
Próximo prefixo da malha mesh encontrado.
OT_ERROR_NOT_FOUND
Não existe nenhum prefixo da malha posterior nos dados da rede Thread.

OtNetDataGetNextRoute

otError otNetDataGetNextRoute(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otExternalRouteConfig *aConfig
)

Esta função recebe a próxima rota externa nos dados de rede da partição.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in,out] aIterator
Um ponteiro para o contexto do iterador de dados de rede. Para obter a primeira entrada de rota externa, ela precisa ser definida como OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Um ponteiro para onde as informações da rota externa serão colocadas.
Valores de retorno
OT_ERROR_NONE
Encontramos a próxima rota externa.
OT_ERROR_NOT_FOUND
Não existe nenhuma entrada de rota externa nos dados da rede Thread.

Serviço OtNetDataGetNextService

otError otNetDataGetNextService(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otServiceConfig *aConfig
)

Essa função recebe o próximo serviço nos dados de rede da partição.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in,out] aIterator
Um ponteiro para o contexto do iterador de dados de rede. Para conseguir a primeira entrada de serviço, defina como OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Um ponteiro para onde as informações do serviço serão colocadas.
Valores de retorno
OT_ERROR_NONE
O próximo serviço foi encontrado.
OT_ERROR_NOT_FOUND
Não existe nenhum serviço subsequente nos dados de rede da partição.

Versão otNetDataGetStable

uint8_t otNetDataGetStableVersion(
  otInstance *aInstance
)

Acessar a versão estável dos dados da rede.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
A versão estável dos dados de rede.

Versão OtNetDataGetVersion

uint8_t otNetDataGetVersion(
  otInstance *aInstance
)

Acessar a versão dos dados de rede.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
A versão dos dados de rede.

OtNetDataIsDnsSrpServiceAdded

bool otNetDataIsDnsSrpServiceAdded(
  otInstance *aInstance
)

Esta função indica se a entrada do "DNS/SRP Service" é adicionada ou não aos dados da rede Thread.

Para esta função, o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE precisa estar ativado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Valores de retorno
TRUE
A entrada de serviço DNS/SRP publicada é adicionada aos dados da rede Thread.
FALSE
A entrada não é adicionada aos dados da rede Thread ou não há entrada para publicar.

OtNetDataIsPrefixAdded

bool otNetDataIsPrefixAdded(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

Esta função indica se uma entrada de prefixo publicada (em malha ou rota externa) foi adicionada ou não aos dados da rede Thread.

Para esta função, o recurso OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE precisa estar ativado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aPrefix
Um ponteiro para o prefixo (NÃO DEVE ser NULL).
Valores de retorno
TRUE
A entrada de prefixo publicada é adicionada aos dados da rede Thread.
FALSE
A entrada não é adicionada aos dados da rede Thread ou não há entrada para publicar.

OtNetDataPublishDnsSrpServiceAnycast

void otNetDataPublishDnsSrpServiceAnycast(
  otInstance *aInstance,
  uint8_t aSequenceNUmber
)

Esta função solicita que o endereço Anycast de serviço de DNS/SRP" seja publicado nos dados da rede Thread.

Para esta função, o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE precisa estar ativado.

Uma chamada para essa função removerá e substituirá qualquer entrada anterior de "DNS/SRP de serviço" que estava sendo publicada (da chamada anterior para qualquer uma das funções otNetDataPublishDnsSrpService{Type}()).

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aSequenceNUmber
O número de sequência do serviço Anycast DNS/SRP.

OtNetDataPublishDnsSrpServiceUnicast

void otNetDataPublishDnsSrpServiceUnicast(
  otInstance *aInstance,
  const otIp6Address *aAddress,
  uint16_t aPort
)

Essa função solicita a publicação de "DNS/SRP serviço Unicast" nos dados da rede Thread.

Para esta função, o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE precisa estar ativado.

Uma chamada para essa função removerá e substituirá qualquer entrada anterior de "DNS/SRP de serviço" que estava sendo publicada (da chamada anterior para qualquer uma das funções otNetDataPublishDnsSrpService{Type}()).

Esta função publica o "Endereço de Unicast de serviço DNS/SRP" incluindo as informações de endereço e porta nos dados TLV do serviço.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aAddress
O endereço do servidor DNS/SRP a ser publicado (NÃO pode ser NULO).
[in] aPort
O número da porta do servidor SRP a ser publicado.

OtNetDataPublishDnsSrpServiceUnicastMeshLocalEid

void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(
  otInstance *aInstance,
  uint16_t aPort
)

Essa função solicita a publicação de "DNS/SRP serviço Unicast" nos dados da rede Thread.

Para esta função, o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE precisa estar ativado.

Uma chamada para essa função removerá e substituirá qualquer entrada anterior de "DNS/SRP de serviço" que estava sendo publicada (da chamada anterior para qualquer uma das funções otNetDataPublishDnsSrpService{Type}()).

Ao contrário de otNetDataPublishDnsSrpServiceUnicast(), que requer o endereço publicado, e inclui as informações nos dados de TLV do serviço, essa função usa o EID da rede local do dispositivo e inclui as informações nos dados de TLV do servidor.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aPort
O número da porta do servidor SRP a ser publicado.

Rota otNetDataPublishExternal

otError otNetDataPublishExternalRoute(
  otInstance *aInstance,
  const otExternalRouteConfig *aConfig
)

Essa função solicita que um prefixo de rota externo seja publicado nos dados da rede Thread.

Para esta função, o recurso OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE precisa estar ativado.

Somente as entradas estáveis podem ser publicadas (ou seja,aConfig.mStable PRECISA ser VERDADEIRO).

Uma chamada subsequente para esse método substituirá uma solicitação anterior pelo mesmo prefixo. Se a nova chamada só mudar as sinalizações (por exemplo, nível de preferência) e o prefixo já tiver sido adicionado aos dados da rede, a mudança nas sinalizações será refletida imediatamente nos dados da rede. Isso garante que as entradas existentes nos dados de rede não sejam removidas abruptamente. Observe que uma alteração no nível de preferência pode fazer com que a entrada seja removida dos dados da rede após determinar que há outros nós publicando o mesmo prefixo com a mesma preferência ou maior.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aConfig
A configuração da rota externa a ser publicada (NÃO pode ser NULL).
Valores de retorno
OT_ERROR_NONE
A rota externa foi publicada.
OT_ERROR_INVALID_ARGS
O aConfig não é válido (prefixo inválido, combinações de sinalização inválidas ou instável).
OT_ERROR_NO_BUFS
Não foi possível alocar uma entrada para a nova solicitação. O editor aceita um número limitado de entradas (compartilhadas entre o prefixo da malha e a rota externa) determinadas pela configuração OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES.

OtNetDataPublishOnMeshshPrefix

otError otNetDataPublishOnMeshPrefix(
  otInstance *aInstance,
  const otBorderRouterConfig *aConfig
)

Essa função solicita que um prefixo da malha seja publicado nos dados da rede Thread.

Para esta função, o recurso OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE precisa estar ativado.

Somente as entradas estáveis podem ser publicadas (ou seja,aConfig.mStable PRECISA ser VERDADEIRO).

Uma chamada subsequente para esse método substituirá uma solicitação anterior pelo mesmo prefixo. Se a nova chamada só mudar as sinalizações (por exemplo, nível de preferência) e o prefixo já tiver sido adicionado aos dados da rede, a mudança nas sinalizações será refletida imediatamente nos dados da rede. Isso garante que as entradas existentes nos dados de rede não sejam removidas abruptamente. Observe que uma alteração no nível de preferência pode fazer com que a entrada seja removida dos dados da rede após determinar que há outros nós publicando o mesmo prefixo com a mesma preferência ou maior.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aConfig
A configuração do prefixo da malha a ser publicada (NÃO DEVE ser NULL).
Valores de retorno
OT_ERROR_NONE
O prefixo da malha foi publicado.
OT_ERROR_INVALID_ARGS
O aConfig não é válido (prefixo inválido, combinações de sinalização inválidas ou instável).
OT_ERROR_NO_BUFS
Não foi possível alocar uma entrada para a nova solicitação. O editor aceita um número limitado de entradas (compartilhadas entre o prefixo da malha e a rota externa) determinadas pela configuração OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES.

OtNetDataSetDnsSrpServicePublisherCallback

void otNetDataSetDnsSrpServicePublisherCallback(
  otInstance *aInstance,
  otNetDataDnsSrpServicePublisherCallback aCallback,
  void *aContext
)

Essa função define um callback para notificar quando um "serviço de DNS/SRP publicado</a> for adicionado ou removido dos dados da rede Thread.

Uma chamada subsequente para essa função substitui qualquer função de callback definida anteriormente.

Para esta função, o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE precisa estar ativado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aCallback
O ponteiro da função de callback (pode ser NULL se não for necessário).
[in] aContext
Um ponteiro para contexto específico do aplicativo (usado quando aCallback é invocado).

OtNetDataSetPrefixPublisherCallback

void otNetDataSetPrefixPublisherCallback(
  otInstance *aInstance,
  otNetDataPrefixPublisherCallback aCallback,
  void *aContext
)

Essa função define um callback para notificar quando uma entrada de prefixo publicada é realmente adicionada ou removida dos dados da rede Thread.

Uma chamada subsequente para essa função substitui qualquer função de callback definida anteriormente.

Para esta função, o recurso OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE precisa estar ativado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aCallback
O ponteiro da função de callback (pode ser NULL se não for necessário).
[in] aContext
Um ponteiro para contexto específico do aplicativo (usado quando aCallback é invocado).

OtNetDataSteeringDataCheckJoiner

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

Verificar se os dados de direcionamento incluem um Joiner.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aEui64
Um ponteiro para o IEEE EUI-64 do Joiner.
Valores de retorno
OT_ERROR_NONE
aEui64 está incluído nos dados de direcionamento.
OT_ERROR_INVALID_STATE
Nenhum dado de direcionamento
OT_ERROR_NOT_FOUND
aEui64 não está incluído nos dados de direcionamento.

OtNetDataSteeringDataCheckJoinerWithDiscerner

otError otNetDataSteeringDataCheckJoinerWithDiscerner(
  otInstance *aInstance,
  const struct otJoinerDiscerner *aDiscerner
)

Verificar se os dados de direcionamento incluem um combinador com um determinado valor de disjuntor.

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
aDiscerner está incluído nos dados de direcionamento.
OT_ERROR_INVALID_STATE
Nenhum dado de direcionamento
OT_ERROR_NOT_FOUND
aDiscerner não está incluído nos dados de direcionamento.

OtNetDataPublishDnsSrpService

void otNetDataUnpublishDnsSrpService(
  otInstance *aInstance
)

Cancela a publicação de qualquer entrada do serviço DNS/SRP (Anycast ou Unicast) adicionada anteriormente dos dados da rede Thread.

O OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE precisa estar ativado.

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

OtNetDataDataPrefix

otError otNetDataUnpublishPrefix(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

Cancela a publicação de um prefixo de trajeto externo ou de malha já publicado anteriormente.

O OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE precisa estar ativado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aPrefix
O prefixo a ser cancelado (NÃO DEVE ser NULL).
Valores de retorno
OT_ERROR_NONE
A publicação do prefixo foi cancelada.
OT_ERROR_NOT_FOUND
Não foi possível encontrar o prefixo na lista publicada.

OtThreadMakeChild

otError otThreadBecomeChild(
  otInstance *aInstance
)

Tente reconectar como criança.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Valores de retorno
OT_ERROR_NONE
A tentativa de se tornar uma criança foi iniciada.
OT_ERROR_INVALID_STATE
A conversa está desativada.

OtThreadMakeDetached

otError otThreadBecomeDetached(
  otInstance *aInstance
)

Desconecte-se da rede Thread.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Valores de retorno
OT_ERROR_NONE
Desconectado da rede Thread.
OT_ERROR_INVALID_STATE
A conversa está desativada.

OtThreadDetachGraceously

otError otThreadDetachGracefully(
  otInstance *aInstance,
  otDetachGracefullyCallback aCallback,
  void *aContext
)

Essa função notifica outros nós na rede (se houver) e, em seguida, interrompe a operação do protocolo Thread.

Ele vai enviar uma versão de endereço se for um roteador ou definir o tempo limite filho como 0 se for um filho.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aCallback
Um ponteiro para uma função chamada após a conclusão da remoção.
[in] aContext
Um ponteiro para retornar um contexto específico do aplicativo.
Valores de retorno
OT_ERROR_NONE
A remoção foi iniciada.
OT_ERROR_BUSY
A remoção já está em andamento.

OtThreadDeviceRoleToString

const char * otThreadDeviceRoleToString(
  otDeviceRole aRole
)

Converta o papel do dispositivo em uma string legível.

Detalhes
Parâmetros
[in] aRole
A função de dispositivo a ser convertida.
Retorna
Uma string que representa aRole.

OtThreadDiscover

otError otThreadDiscover(
  otInstance *aInstance,
  uint32_t aScanChannels,
  uint16_t aPanId,
  bool aJoiner,
  bool aEnableEui64Filtering,
  otHandleActiveScanResult aCallback,
  void *aCallbackContext
)

Essa função inicia uma verificação do Thread Discovery.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aScanChannels
Um vetor de bit que indica quais canais verificar (por exemplo, OT_CHANNEL_11_MASK).
[in] aPanId
O filtro de ID do PAN (definido como "Transmitir PAN" para desativar o filtro).
[in] aJoiner
Valor da sinalização do Combinador no TLV de solicitação de descoberta.
[in] aEnableEui64Filtering
Verdadeiro para filtrar respostas no EUI-64. Caso contrário, FALSO.
[in] aCallback
Um ponteiro para uma função chamada para receber uma resposta de descoberta do MLE ou concluir a verificação.
[in] aCallbackContext
Um ponteiro para contextos específicos do aplicativo.
Valores de retorno
OT_ERROR_NONE
Uma verificação de descoberta de linha de execução foi iniciada.
OT_ERROR_INVALID_STATE
A interface IPv6 não está ativada (netif não está ativo).
OT_ERROR_NO_BUFS
Não foi possível alocar a mensagem para a solicitação de descoberta.
OT_ERROR_BUSY
A verificação de descoberta de conversas já está em andamento.

OtThreadGetChildTimeout

uint32_t otThreadGetChildTimeout(
  otInstance *aInstance
)

Recebe o tempo limite de linha de execução filha (em segundos) usado ao operar na função filha.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
O valor de tempo limite filho da linha de execução em segundos.
Veja também:
otThreadSetChildTimeout

OtThreadGetDeviceRole

otDeviceRole otThreadGetDeviceRole(
  otInstance *aInstance
)

Acessar o papel do dispositivo.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Valores de retorno
OT_DEVICE_ROLE_DISABLED
A pilha de conversas está desativada.
OT_DEVICE_ROLE_DETACHED
O dispositivo não está participando de uma rede/partição do Thread no momento.
OT_DEVICE_ROLE_CHILD
No momento, o dispositivo está operando como um Thread Child.
OT_DEVICE_ROLE_ROUTER
No momento, o dispositivo está operando como um roteador de linha de execução.
OT_DEVICE_ROLE_LEADER
No momento, o dispositivo está operando como um líder de linha de execução.

OtThreadGetDomainName

const char * otThreadGetDomainName(
  otInstance *aInstance
)

Recebe o nome de domínio do Thread.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Um ponteiro para o nome de domínio do Thread.
Veja também:
otThreadSetDomainName

OtThreadGetExtendedPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

Recebe o ID do PAN estendido IEEE 802.15.4.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Um ponteiro para o ID PAN estendido da IEEE 802.15.4.
Veja também:
otThreadSetExtendedPanId

OtThreadGetFixedDuaInterfaceIdentifier

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
  otInstance *aInstance
)

Recebe o identificador da interface especificado manualmente para o endereço Unicast do domínio Thread.

Disponível quando o OPENTHREAD_CONFIG_DUA_ENABLE estiver ativado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Um ponteiro para o identificador de interface que foi definido manualmente ou NULL se nenhum tiver sido definido.
Veja também:
otThreadSetFixedDuaInterfaceIdentifier

Contadores de otThreadGetIp6

const otIpCounters * otThreadGetIp6Counters(
  otInstance *aInstance
)

Recebe os contadores IPv6.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Um ponteiro para os contadores de IPv6.

OtThreadGetKeySequenceCounter

uint32_t otThreadGetKeySequenceCounter(
  otInstance *aInstance
)

Acesse o thCREDENTIALSSequenceCounter.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
O valor thCREDENTIALSSequenceCounter.
Veja também:
otThreadSetKeySequenceCounter

OtThreadGetKeySwitchGuardTime

uint32_t otThreadGetKeySwitchGuardTime(
  otInstance *aInstance
)

Receba o thvCPMSwitchGuardTime.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
O valor thCREDENTIALSSwitchGuardTime (em horas).
Veja também:
otThreadSetKeySwitchGuardTime

OtThreadGetLeaderData

otError otThreadGetLeaderData(
  otInstance *aInstance,
  otLeaderData *aLeaderData
)

Essa função recebe os dados do líder da linha de execução.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[out] aLeaderData
Um ponteiro para onde os dados líderes são colocados.
Valores de retorno
OT_ERROR_NONE
Os dados da variante líder foram recuperados.
OT_ERROR_DETACHED
Não anexado no momento.

OtThreadGetLeaderRloc

otError otThreadGetLeaderRloc(
  otInstance *aInstance,
  otIp6Address *aLeaderRloc
)

Esta função retorna um ponteiro para o RLOC do líder.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[out] aLeaderRloc
Um ponteiro para o RLOC do líder.
Valores de retorno
OT_ERROR_NONE
O RLOC do líder foi gravado em aLeaderRloc.
OT_ERROR_INVALID_ARGS
aLeaderRloc era NULL.
OT_ERROR_DETACHED
Não anexado a uma partição de linha de execução.

OtThreadGetLeaderRouterId

uint8_t otThreadGetLeaderRouterId(
  otInstance *aInstance
)

Obtenha o ID do roteador do líder.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
O ID do roteador do líder.

OtThreadGetLeaderWeight

uint8_t otThreadGetLeaderWeight(
  otInstance *aInstance
)

Obtenha o peso do líder.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
O peso do líder.

OtThreadGetLinkLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetLinkLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

Essa função retorna o endereço multicast de Thread Link-Local All Thread Nodes.

O endereço é um endereço multilink baseado em prefixo Unicast local [RFC 3306], com:

  • flgs definidos como 3 (P = 1 e T = 1)
  • escopo definido como 2
  • plen definido como 64
  • prefixo de rede definido como o prefixo local da malha
  • ID do grupo definido como 1

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Um ponteiro para endereços multicast de Thread Link-Local All Thread Nodes.

Endereço otThreadGetLinkLocalIp6

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

Essa função retorna o endereço IPv6 link-local Thread.

O endereço local do link Thread é derivado usando o endereço estendido IEEE802.15.4 como identificador de interface.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Um ponteiro para endereço IPv6 link-local Thread.

OtThreadGetLinkMode

otLinkModeConfig otThreadGetLinkMode(
  otInstance *aInstance
)

Acessar a configuração do modo de vinculação do MLE.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
A configuração do modo de vinculação do MLE.
Veja também:
otThreadSetLinkMode

OtThreadGetMeshLocalEid

const otIp6Address * otThreadGetMeshLocalEid(
  otInstance *aInstance
)

Essa função retorna um ponteiro para o endereço EID local da malha.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Um ponteiro para o endereço EID local da malha.

OtThreadGetMeshLocalPrefix

const otMeshLocalPrefix * otThreadGetMeshLocalPrefix(
  otInstance *aInstance
)

Essa função retorna um ponteiro para o prefixo local da malha.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Um ponteiro para o prefixo local de malha.

OtThreadGetMleCounters

const otMleCounters * otThreadGetMleCounters(
  otInstance *aInstance
)

Recebe os contadores de Thread MLE.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Um ponteiro para os contadores de Thread MLE.

Troca de redeOtThreadGet

void otThreadGetNetworkKey(
  otInstance *aInstance,
  otNetworkKey *aNetworkKey
)

Receba a chave de rede do Thread.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[out] aNetworkKey
Um ponteiro para um otNetworkkey para retornar a chave de rede de linhas de execução.
Veja também:
otThreadSetNetworkKey

OtThreadGetNetworkKeyRef

otNetworkKeyRef otThreadGetNetworkKeyRef(
  otInstance *aInstance
)

Consiga o otNetworkKeyRef para a chave de rede do Thread.

Essa função requer que o recurso de tempo de compilação OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE esteja ativado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Referência à chave de rede de linhas de execução armazenada na memória.
Veja também:
otThreadSetNetworkKeyRef

Nome da rede otThreadGet

const char * otThreadGetNetworkName(
  otInstance *aInstance
)

Encontre o nome da rede Thread.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Um ponteiro para o nome da rede da linha de execução.
Veja também:
otThreadSetNetworkName

OtThreadGetNextDiagnosticTlv

otError otThreadGetNextDiagnosticTlv(
  const otMessage *aMessage,
  otNetworkDiagIterator *aIterator,
  otNetworkDiagTlv *aNetworkDiagTlv
)

Essa função recebe o próximo TLV de diagnóstico de rede na mensagem.

Uma chamada subsequente para essa função só é permitida quando o valor de retorno atual é OT_ERROR_NONE.

Detalhes
Parâmetros
[in] aMessage
Um ponteiro para uma mensagem.
[in,out] aIterator
Um ponteiro para o contexto do iterador de diagnóstico de rede. Para obter o primeiro TLV de diagnóstico de rede, defina-o como OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT.
[out] aNetworkDiagTlv
Um ponteiro para onde as informações de TLV de diagnóstico da rede serão colocadas.
Valores de retorno
OT_ERROR_NONE
Encontrado o próximo TLV de diagnóstico de rede.
OT_ERROR_NOT_FOUND
Não existe nenhum TLV de diagnóstico de rede na mensagem.
OT_ERROR_PARSE
Falha na análise do próximo diagnóstico de rede.

OtThreadGetNextNeighborInfo

otError otThreadGetNextNeighborInfo(
  otInstance *aInstance,
  otNeighborInfoIterator *aIterator,
  otNeighborInfo *aInfo
)

Essa função recebe as informações do próximo vizinho.

Ele é usado para analisar as entradas da tabela vizinha.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in,out] aIterator
Um ponteiro para o contexto do iterador. Para conseguir a primeira entrada vizinha, defina-a como OT_NEIGHBOR_INFO_ITERATOR_INIT.
[out] aInfo
Um ponteiro para as informações ao vizinho.
Valores de retorno
OT_ERROR_NONE
Encontrada com sucesso a próxima entrada da vizinha na tabela.
OT_ERROR_NOT_FOUND
Não há entrada para vizinhos subsequente na tabela.
OT_ERROR_INVALID_ARGS
aIterator ou aInfo era NULL.

OtThreadGetParentAverageRssi

otError otThreadGetParentAverageRssi(
  otInstance *aInstance,
  int8_t *aParentRssi
)

A função recupera a RSSI média do pai da linha de execução.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[out] aParentRssi
Um ponteiro para onde a RSSI mãe precisa ser colocada.

OtThreadGetParentInfo

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

A função recupera informações de diagnóstico de um roteador de linha de execução como pai.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[out] aParentInfo
Um ponteiro para onde as informações do roteador pai são colocadas.

OtThreadGetParentLastRssi

otError otThreadGetParentLastRssi(
  otInstance *aInstance,
  int8_t *aLastRssi
)

A função recupera o RSSI do último pacote do pai do Thread.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[out] aLastRssi
Um ponteiro para onde o último RSSI precisa ser colocado.
Valores de retorno
OT_ERROR_NONE
Os dados RSSI foram recuperados.
OT_ERROR_FAILED
Não foi possível obter os dados RSSI.
OT_ERROR_INVALID_ARGS
aLastRssi é NULO.

OtThreadGetPartitionId

uint32_t otThreadGetPartitionId(
  otInstance *aInstance
)

Consiga o ID da partição.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
O código da partição.

OtThreadGetRealmLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

Essa função retorna o endereço multicast de Thread Realm-Local All Nodes.

O endereço é um endereço Multcast baseado em prefixo Unicast local [RFC 3306], com:

  • flgs definidos como 3 (P = 1 e T = 1)
  • escopo definido como 3
  • plen definido como 64
  • prefixo de rede definido como o prefixo local da malha
  • ID do grupo definido como 1

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Um ponteiro para endereço multicast de Thread Realm-Local All Thread Nodes.

OtThreadGetRloc

const otIp6Address * otThreadGetRloc(
  otInstance *aInstance
)

Essa função retorna um ponteiro para o endereço do Localizador de roteamento de linhas de execução (RLOC).

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Um ponteiro para o endereço do Thread Routing Locator (RLOC).

OtThreadGetRloc16

uint16_t otThreadGetRloc16(
  otInstance *aInstance
)

Acessar o RLOC16.

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

OtThreadGetServiceAloc

otError otThreadGetServiceAloc(
  otInstance *aInstance,
  uint8_t aServiceId,
  otIp6Address *aServiceAloc
)

Esta função recupera a ALOC de serviço para o ID de serviço fornecido.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aServiceId
ID do serviço para receber ALOC.
[out] aServiceAloc
Um ponteiro para gerar a ALOC de serviço. NÃO PODE SER NULO.
Valores de retorno
OT_ERROR_NONE
O ALOC de serviço foi recuperado.
OT_ERROR_DETACHED
A interface da Thread não está anexada a uma partição Thread no momento.

Versão de otThreadGet

uint16_t otThreadGetVersion(
  void
)

Essa função recebe a versão do protocolo Thread.

Detalhes
Retorna
a versão do protocolo Thread.

OtThreadIsAnycastFindInProgress

bool otThreadIsAnycastLocateInProgress(
  otInstance *aInstance
)

Esta função indica se uma solicitação de localização anycast está em andamento.

Esta função só está disponível quando OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE está ativado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
TRUE se uma solicitação de localização de anycast estiver em andamento. Caso contrário, FALSE.

OtThreadIsDiscoverInProgress

bool otThreadIsDiscoverInProgress(
  otInstance *aInstance
)

Esta função determina se uma descoberta de linha de execução de MLE está em andamento.

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

OtThreadIsSingleton

bool otThreadIsSingleton(
  otInstance *aInstance
)

Essa função indica se um nó é o único roteador da rede.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Valores de retorno
TRUE
Ele é o único roteador da rede.
FALSE
Ele é um filho ou não é um único roteador na rede.

OtThreadLocalAnycastDestination

otError otThreadLocateAnycastDestination(
  otInstance *aInstance,
  const otIp6Address *aAnycastAddress,
  otThreadAnycastLocatorCallback aCallback,
  void *aContext
)

Essa função solicita a localização mais próxima de um determinado endereço anycast a ser localizado.

Esta função só está disponível quando OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE está ativado.

Se uma solicitação anterior estiver em andamento, uma chamada subsequente para essa função cancelará e substituirá a solicitação anterior.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aAnycastAddress
O endereço Anycast a ser localizado. NÃO PRECISA ser NULL.
[in] aCallback
A função de callback para relatar o resultado.
[in] aContext
Um contexto arbitrário usado com aCallback.
Valores de retorno
OT_ERROR_NONE
A solicitação foi iniciada. aCallback será invocado para informar o resultado.
OT_ERROR_INVALID_ARGS
O aAnycastAddress não é um endereço anycast válido ou aCallback é NULL.
OT_ERROR_NO_BUFS
Sem buffer para preparar e enviar a mensagem de solicitação.

OtThreadRegisterParentResponseCallback

void otThreadRegisterParentResponseCallback(
  otInstance *aInstance,
  otThreadParentResponseCallback aCallback,
  void *aContext
)

Esta função registra um callback para receber dados da resposta pai do MLE.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aCallback
Um ponteiro para uma função chamada ao receber uma mensagem de resposta pai do MLE.
[in] aContext
Um ponteiro para retornar contexto específico do cliente.

Contadores de otThreadResetIp6

void otThreadResetIp6Counters(
  otInstance *aInstance
)

Redefine os contadores IPv6.

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

OtThreadResetMleCounters

void otThreadResetMleCounters(
  otInstance *aInstance
)

Redefine os contadores de Thread MLE.

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

OtThreadSearchForBetterParent

otError otThreadSearchForBetterParent(
  otInstance *aInstance
)

Inicia o processo de busca de um pai/mãe melhor enquanto continua conectado ao pai atual.

Precisa ser usado quando o dispositivo está anexado como uma criança.

Detalhes
Valores de retorno
OT_ERROR_NONE
O processo para pesquisar um pai/mãe melhor foi iniciado.
OT_ERROR_INVALID_STATE
A função do dispositivo não é filha.

ThreadThreadAddressAddress

void otThreadSendAddressNotification(
  otInstance *aInstance,
  otIp6Address *aDestination,
  otIp6Address *aTarget,
  otIp6InterfaceIdentifier *aMlIid
)

Esta função envia uma mensagem proativa de endereço proativo (ADDR_NTF.ntf).

Esta função só está disponível quando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE está ativado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aDestination
O destino de envio da mensagem ADDR_NTF.ntf.
[in] aTarget
O endereço de destino da mensagem ADDR_NTF.ntf.
[in] aMlIid
O ML-IID da mensagem ADDR_NTF.ntf.

OtThreadSendDiagnosticGet

otError otThreadSendDiagnosticGet(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  const uint8_t aTlvTypes[],
  uint8_t aCount,
  otReceiveDiagnosticGetCallback aCallback,
  void *aCallbackContext
)

Envie uma solicitação de recebimento de diagnóstico de rede.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aDestination
Um ponteiro para endereço de destino.
[in] aTlvTypes
Uma matriz de tipos de TLV de diagnóstico de rede.
[in] aCount
Número de tipos em aTlvTypes.
[in] aCallback
Um ponteiro para uma função chamada quando a resposta de recebimento do diagnóstico de rede é recebida ou NULL para desativar o callback.
[in] aCallbackContext
Um ponteiro para contextos específicos do aplicativo.
Valores de retorno
OT_ERROR_NONE
Na fila DIAG_GET.req.
OT_ERROR_NO_BUFS
Buffers de mensagens insuficientes disponíveis para enviar DIAG_GET.req.

OtThreadSendDiagnosticReset

otError otThreadSendDiagnosticReset(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  const uint8_t aTlvTypes[],
  uint8_t aCount
)

Envie uma solicitação de redefinição de diagnóstico de rede.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aDestination
Um ponteiro para endereço de destino.
[in] aTlvTypes
Uma matriz de tipos de TLV de diagnóstico de rede. No momento, somente o Tipo 9 é permitido.
[in] aCount
Número de tipos em aTlvTypes
Valores de retorno
OT_ERROR_NONE
Na fila DIAG_RST.ntf.
OT_ERROR_NO_BUFS
Buffers de mensagens insuficientes disponíveis para enviar DIAG_RST.ntf.

OtThreadSendProactiveBackboneNotification

otError otThreadSendProactiveBackboneNotification(
  otInstance *aInstance,
  otIp6Address *aTarget,
  otIp6InterfaceIdentifier *aMlIid,
  uint32_t aTimeSinceLastTransaction
)

Esta função envia uma mensagem proativa da espinha dorsal (PRO_BB.ntf) no link da Estrutura.

Esta função só está disponível quando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE está ativado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aTarget
O endereço de destino da mensagem PRO_BB.ntf.
[in] aMlIid
O ML-IID da mensagem PRO_BB.ntf.
[in] aTimeSinceLastTransaction
Tempo desde a última transação (em segundos).
Valores de retorno
OT_ERROR_NONE
PRO_BB.ntf enviado no link de backbone.
OT_ERROR_NO_BUFS
Se os buffers de mensagem não estiverem disponíveis.

OtThreadSetChildTimeout

void otThreadSetChildTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

Define o tempo limite filho da linha de execução (em segundos) usado ao operar no papel filho filho.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aTimeout
O valor de tempo limite em segundos.
Veja também:
otThreadGetChildTimeout

OtThreadSetDiscoveryRequestCallback

void otThreadSetDiscoveryRequestCallback(
  otInstance *aInstance,
  otThreadDiscoveryRequestCallback aCallback,
  void *aContext
)

Essa função define um callback para receber dados da solicitação de descoberta do MLE.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aCallback
Um ponteiro para uma função que é chamada ao receber uma mensagem de solicitação de descoberta do MLE.
[in] aContext
Um ponteiro para retornar um contexto específico do aplicativo.

OtThreadSetDomainName

otError otThreadSetDomainName(
  otInstance *aInstance,
  const char *aDomainName
)

Define o nome de domínio da linha de execução.

Só funciona quando os protocolos Thread estão desativados.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aDomainName
Um ponteiro para o nome de domínio do Thread.
Valores de retorno
OT_ERROR_NONE
O nome de domínio da conversa foi definido.
OT_ERROR_INVALID_STATE
Os protocolos de linha de execução estão ativados.
Veja também:
otThreadGetDomainName

OtThreadSetEnabled

otError otThreadSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Esta função inicia a operação do protocolo Thread.

A interface precisa estar ativa ao chamar essa função.

Chamar essa função com aEnabled definido como FALSE interrompe qualquer processo contínuo de remoção iniciado por otThreadDetachGraceously(). O callback dele será chamado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aEnabled
TRUE se a Thread estiver ativada. Caso contrário, FALSE.
Valores de retorno
OT_ERROR_NONE
A operação do protocolo Thread foi iniciada.
OT_ERROR_INVALID_STATE
A interface de rede não estava ativa.

OtThreadSetExtendedPanId

otError otThreadSetExtendedPanId(
  otInstance *aInstance,
  const otExtendedPanId *aExtendedPanId
)

Define o ID do PAN estendido IEEE 802.15.4.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aExtendedPanId
Um ponteiro para o ID PAN estendido da IEEE 802.15.4.
Valores de retorno
OT_ERROR_NONE
O código PAN estendido foi definido.
OT_ERROR_INVALID_STATE
Os protocolos de linha de execução estão ativados.
Veja também:
otThreadGetExtendedPanId

OtThreadSetFixedDuaInterfaceIdentifier

otError otThreadSetFixedDuaInterfaceIdentifier(
  otInstance *aInstance,
  const otIp6InterfaceIdentifier *aIid
)

Define ou limpa o identificador de interface especificado manualmente para o endereço Unicast do domínio Thread.

Disponível quando o OPENTHREAD_CONFIG_DUA_ENABLE estiver ativado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aIid
Um ponteiro para o identificador de interface a ser definido ou NULL para limpar.
Valores de retorno
OT_ERROR_NONE
O identificador da interface foi definido/liberado.
OT_ERROR_INVALID_ARGS
O identificador de interface especificado está reservado.
Veja também:
otThreadGetFixedDuaInterfaceIdentifier

OtThreadSetJoinerAdvertisingment

otError otThreadSetJoinerAdvertisement(
  otInstance *aInstance,
  uint32_t aOui,
  const uint8_t *aAdvData,
  uint8_t aAdvDataLength
)

Esse método define a publicidade de junção de linhas de execução ao descobrir a rede Thread.

A Publicidade de Combinadores de linhas de execução é usada para permitir que um Comissário de publicidade anuncie suas informações específicas da inscrição (como ID do fornecedor, ID do produto, Discriminador etc.) por meio de um TLV de publicidade de proposta recente e para disponibilizar essas informações aos Comissários ou candidatos a Comissários sem interação humana.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aOui
O valor da OUI IEEE do fornecedor que será incluído na Publicidade de Combinador. Somente os 3 bytes menos significativos serão usados, e o byte mais significativo será ignorado.
[in] aAdvData
Um ponteiro para o AdvData que será incluído na Publicidade de Combinador.
[in] aAdvDataLength
O tamanho de AdvData em bytes.
Valores de retorno
OT_ERROR_NONE
Anúncio de combinador definido.
OT_ERROR_INVALID_ARGS
Dados de Adv inválidos.

OtThreadSetKeySequenceCounter

void otThreadSetKeySequenceCounter(
  otInstance *aInstance,
  uint32_t aKeySequenceCounter
)

Defina o thRevisarSequenceCounter.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aKeySequenceCounter
O valor thCREDENTIALSSequenceCounter.
Veja também:
otThreadGetKeySequenceCounter

OtThreadSetKeySwitchGuardTime

void otThreadSetKeySwitchGuardTime(
  otInstance *aInstance,
  uint32_t aKeySwitchGuardTime
)

Defina o thvCPMSwitchGuardTime.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aKeySwitchGuardTime
O valor thCREDENTIALSSwitchGuardTime (em horas).
Veja também:
otThreadGetKeySwitchGuardTime

OtThreadSetLinkMode

otError otThreadSetLinkMode(
  otInstance *aInstance,
  otLinkModeConfig aConfig
)

Defina a configuração do modo de vinculação do MLE.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aConfig
Um ponteiro para a configuração do modo de vinculação.
Valores de retorno
OT_ERROR_NONE
A configuração do modo de vinculação do MLE foi concluída.
Veja também:
otThreadGetLinkMode

OtThreadSetMeshLocalPrefix

otError otThreadSetMeshLocalPrefix(
  otInstance *aInstance,
  const otMeshLocalPrefix *aMeshLocalPrefix
)

Essa função define o prefixo local da malha.

Esta função só funciona quando os protocolos Thread estão desativados. Uma chamada bem-sucedida para essa função invalida os conjuntos de dados operacionais ativos e pendentes na memória não volátil.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aMeshLocalPrefix
Um ponteiro para o prefixo local de malha.
Valores de retorno
OT_ERROR_NONE
O prefixo local da malha foi definido com sucesso.
OT_ERROR_INVALID_STATE
Os protocolos de linha de execução estão ativados.

Conjunto de redes otThread

otError otThreadSetNetworkKey(
  otInstance *aInstance,
  const otNetworkKey *aKey
)

Defina a chave de rede Thread.

Esta função só funciona quando os protocolos Thread estão desativados. Uma chamada bem-sucedida para essa função invalida os conjuntos de dados operacionais ativos e pendentes na memória não volátil.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aKey
Um ponteiro para um buffer que contém a chave de rede do Thread.
Valores de retorno
OT_ERROR_NONE
A chave de rede da linha de execução foi definida.
OT_ERROR_INVALID_STATE
Os protocolos de linha de execução estão ativados.
Veja também:
otThreadGetNetworkKey

OtThreadSetNetworkKeyRef

otError otThreadSetNetworkKeyRef(
  otInstance *aInstance,
  otNetworkKeyRef aKeyRef
)

Defina a chave de rede Thread como um otNetworkKeyRef.

Esta função só funciona quando os protocolos Thread estão desativados. Uma chamada bem-sucedida para essa função invalida os conjuntos de dados operacionais ativos e pendentes na memória não volátil.

Essa função requer que o recurso de tempo de compilação OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE esteja ativado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aKeyRef
Referência à chave de rede do Thread.
Valores de retorno
OT_ERROR_NONE
A chave de rede da linha de execução foi definida.
OT_ERROR_INVALID_STATE
Os protocolos de linha de execução estão ativados.
Veja também:
otThreadGetNetworkKeyRef

NomedaRedeDeLinha

otError otThreadSetNetworkName(
  otInstance *aInstance,
  const char *aNetworkName
)

Defina o nome da rede Thread.

Esta função só funciona quando os protocolos Thread estão desativados. Uma chamada bem-sucedida para essa função invalida os conjuntos de dados operacionais ativos e pendentes na memória não volátil.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aNetworkName
Um ponteiro para o nome da rede da linha de execução.
Valores de retorno
OT_ERROR_NONE
O nome da rede da linha de execução foi definido.
OT_ERROR_INVALID_STATE
Os protocolos de linha de execução estão ativados.
Veja também:
otThreadGetNetworkName

Macros

OT_JOINER_ADVDATA_MAX_LENGTH

 OT_JOINER_ADVDATA_MAX_LENGTH 64

Duração máxima do anúncio dos dados do anunciante do Joiner.

OT_NEIGHBOR_INFO_ITERATOR_INIT

 OT_NEIGHBOR_INFO_ITERATOR_INIT 0

Inicialização do otNeighborInfoJUnit

OT_NETWORK_BASE_TLV_MAX_LENGTH

 OT_NETWORK_BASE_TLV_MAX_LENGTH 254

Comprimento máximo do valor do TLV de base da linha de execução.

OT_NETWORK_DATA_ITERATOR_INIT

 OT_NETWORK_DATA_ITERATOR_INIT 0

Valor para inicializar otNetworkDataIterator.

OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE

 OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE 3

Tamanho da entrada da tabela filha de diagnóstico de rede.

OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT

 OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT 0

Inicializador de otNetworkDiagIterator.

OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES

 OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19

Número máximo de tipos de TLV de diagnóstico de rede para solicitar ou redefinir.

OT_NETWORK_MAX_ROUTER_ID

 OT_NETWORK_MAX_ROUTER_ID 62

ID máximo do roteador.

OT_SERVER_DATA_MAX_SIZE

 OT_SERVER_DATA_MAX_SIZE 248

Tamanho máximo dos dados do servidor em bytes. Limite teórico, praticamente muito menor.

OT_SERVICE_DATA_MAX_SIZE

 OT_SERVICE_DATA_MAX_SIZE 252

Tamanho máximo dos dados do serviço em bytes.

Recursos

Os tópicos de referência da API OpenThread são provenientes do código-fonte, disponível no GitHub. Para saber mais ou contribuir com nossa documentação, consulte Recursos.