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

Em geral

Este módulo inclui funções para todas as funções de Thread.

Resumo

O Network Data Publisher fornece mecanismos para limitar o número de entradas de Serviço e / ou Prefixo semelhantes (prefixo em malha ou rota externa) nos Dados de Rede de Threads monitorando os Dados de Rede e gerenciando se ou quando adicionar ou remover entradas.

Todas as funções deste módulo requer OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE para ser ativado.

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
}
enum
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
}
enum
Representa uma função de dispositivo Thread.
otNetDataPublisherEvent {
OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED = 0,
OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED = 1
}
enum
Essa enumeração representa os eventos relatados dos retornos de chamada do Publicador.
otRoutePreference {
OT_ROUTE_PREFERENCE_LOW = -1,
OT_ROUTE_PREFERENCE_MED = 0,
OT_ROUTE_PREFERENCE_HIGH = 1
}
enum
Define valores válidos para mPreference em otExternalRouteConfig e otBorderRouterConfig .

Typedefs

otBorderRouterConfig typedef
Esta estrutura representa uma configuração do Border Router.
otExternalRouteConfig typedef
Esta 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
Esta estrutura representa os dados do Thread Leader.
otLinkModeConfig typedef
Esta estrutura representa uma configuração do modo de link MLE.
otMleCounters typedef
Esta estrutura representa os contadores Thread MLE.
otNeighborInfoIterator typedef
int16_t
Usado para iterar por meio da tabela de vizinhos.
otNetDataDnsSrpServicePublisherCallback )(otNetDataPublisherEvent aEvent, void *aContext) typedef
void(*
Este tipo de ponteiro de função define o retorno de chamada usado para notificar quando uma entrada "Serviço DNS / SRP" é adicionada ou removida dos Dados de Rede de Threads.
otNetDataPrefixPublisherCallback )(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext) typedef
void(*
Este tipo de ponteiro de função define o retorno de chamada usado para notificar quando uma entrada de prefixo (em malha ou rota externa) é adicionada ou removida dos Dados de Rede de Threads.
otNetDataPublisherEvent typedef
Essa enumeração representa os eventos relatados dos retornos de chamada do Publicador.
otNetworkDataIterator typedef
uint32_t
Usado para iterar por meio de informações de dados de rede.
otNetworkDiagChildEntry typedef
Essa estrutura representa uma entrada de tabela filho de diagnóstico de rede.
otNetworkDiagConnectivity typedef
Esta estrutura representa um valor de conectividade de diagnóstico de rede.
otNetworkDiagIterator typedef
uint16_t
Usado para iterar por meio do TLV de diagnóstico de rede.
otNetworkDiagMacCounters typedef
Esta estrutura representa um valor de contadores Mac de diagnóstico de rede.
otNetworkDiagRoute typedef
Esta estrutura representa um valor TLV de rota de diagnóstico de rede.
otNetworkDiagRouteData typedef
Esta estrutura representa os dados de uma rota de diagnóstico de rede.
otNetworkDiagTlv typedef
Esta estrutura representa um TLV de diagnóstico de rede.
otReceiveDiagnosticGetCallback )(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext) typedef
void(*
Este ponteiro de função é chamado quando a resposta Get de diagnóstico de rede é recebida.
otRoutePreference typedef
Define valores válidos para mPreference em otExternalRouteConfig e otBorderRouterConfig .
otServerConfig typedef
Esta estrutura representa uma configuração de servidor.
otServiceConfig typedef
Esta estrutura representa uma configuração de serviço.
otThreadAnycastLocatorCallback )(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16) typedef
void(*
Este tipo de ponteiro de função define o retorno de chamada para notificar o resultado de um otThreadLocateAnycastDestination() pedido.
otThreadDiscoveryRequestCallback )(const otThreadDiscoveryRequestInfo *aInfo, void *aContext) typedef
void(*
Este ponteiro de função é chamado sempre que uma mensagem de solicitação de descoberta MLE é recebida.
otThreadDiscoveryRequestInfo typedef
Esta estrutura representa os dados do Thread Discovery Request.
otThreadParentResponseCallback )(otThreadParentResponseInfo *aInfo, void *aContext) typedef
void(*
Este ponteiro de função é chamado toda vez que uma mensagem de resposta pai MLE é recebida.
otThreadParentResponseInfo typedef
Esta estrutura representa os dados da Resposta Pai MLE.

Funções

otNetDataGet ( otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
Este método fornece uma cópia completa ou estável dos Dados de Rede de Threads da Partição.
otNetDataGetNextOnMeshPrefix ( otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
Esta função obtém o próximo prefixo On Mesh nos dados de rede da partição.
otNetDataGetNextRoute ( otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)
Esta função obtém a próxima rota externa nos dados de rede da partição.
otNetDataGetNextService ( otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig)
Esta função obtém o próximo serviço nos dados de rede da partição.
otNetDataGetStableVersion ( otInstance *aInstance)
uint8_t
Obtenha a versão de dados de rede estável.
otNetDataGetVersion ( otInstance *aInstance)
uint8_t
Obtenha a versão de dados da rede.
otNetDataIsDnsSrpServiceAdded ( otInstance *aInstance)
bool
Esta função indica se a entrada "Serviço DNS / SRP" está ou não adicionada aos Dados de Rede de Threads.
otNetDataIsPrefixAdded ( otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
Esta função indica se uma entrada de prefixo publicada atualmente (em malha ou rota externa) é adicionada aos Dados de Rede de Threads ou não.
otNetDataPublishDnsSrpServiceAnycast ( otInstance *aInstance, uint8_t aSequenceNUmber)
void
Esta função solicita a publicação do "Endereço Anycast do Serviço DNS / SRP" nos Dados da Rede do Thread.
otNetDataPublishDnsSrpServiceUnicast ( otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort)
void
Esta função solicita a publicação do "Endereço Unicast do Serviço DNS / SRP" nos Dados da Rede do Thread.
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid ( otInstance *aInstance, uint16_t aPort)
void
Esta função solicita a publicação do "Endereço Unicast do Serviço DNS / SRP" nos Dados da Rede do Thread.
otNetDataPublishExternalRoute ( otInstance *aInstance, const otExternalRouteConfig *aConfig)
Esta função requer um prefixo de rota externa a ser publicado nos Thread Network Data.
otNetDataPublishOnMeshPrefix ( otInstance *aInstance, const otBorderRouterConfig *aConfig)
Esta função solicita que um prefixo em malha seja publicado nos Thread Network Data.
otNetDataSetDnsSrpServicePublisherCallback ( otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext)
void
Esta função define um retorno de chamada para notificar quando um "Serviço DNS / SRP" publicado é realmente adicionado ou removido dos Dados de Rede de Threads.
otNetDataSetPrefixPublisherCallback ( otInstance *aInstance, otNetDataPrefixPublisherCallback aCallback, void *aContext)
void
Esta função define um retorno de chamada para notificar quando uma entrada de prefixo publicada é realmente adicionada ou removida dos Dados de Rede de Threads.
otNetDataSteeringDataCheckJoiner ( otInstance *aInstance, const otExtAddress *aEui64)
Verifique se os dados de direção incluem um marceneiro.
otNetDataSteeringDataCheckJoinerWithDiscerner ( otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner)
Verifique se os dados de direção incluem um Joiner com um determinado valor de discerner.
otNetDataUnpublishDnsSrpService ( otInstance *aInstance)
void
Esta função cancela a publicação de qualquer entrada "Serviço DNS / SRP (Anycast ou Unicast)" adicionada anteriormente dos Dados de Rede de Threads.
otNetDataUnpublishPrefix ( otInstance *aInstance, const otIp6Prefix *aPrefix)
Esta função cancela a publicação de um prefixo publicado anteriormente (na malha ou rota externa).
otThreadBecomeChild ( otInstance *aInstance)
Tente se reconectar quando era criança.
otThreadBecomeDetached ( otInstance *aInstance)
Desconecte-se da rede Thread.
otThreadDeviceRoleToString ( otDeviceRole aRole)
const char *
Converta a função do dispositivo em string legível por humanos.
otThreadDiscover ( otInstance *aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void *aCallbackContext)
Esta função inicia uma varredura de descoberta de thread.
otThreadGetChildTimeout ( otInstance *aInstance)
uint32_t
Obtenha o Thread Child Timeout usado ao operar na função Child.
otThreadGetDeviceRole ( otInstance *aInstance)
Obtenha a função do dispositivo.
otThreadGetDomainName ( otInstance *aInstance)
const char *
Obtenha o nome de domínio do thread.
otThreadGetExtendedPanId ( otInstance *aInstance)
Obtenha o PAN ID estendido IEEE 802.15.4.
otThreadGetFixedDuaInterfaceIdentifier ( otInstance *aInstance)
Obtenha o identificador de interface especificado manualmente para o endereço Unicast do domínio do thread.
otThreadGetIp6Counters ( otInstance *aInstance)
const otIpCounters *
Obtenha os contadores IPv6.
otThreadGetKeySequenceCounter ( otInstance *aInstance)
uint32_t
Obtenha o thrKeySequenceCounter.
otThreadGetKeySwitchGuardTime ( otInstance *aInstance)
uint32_t
Obtenha o thrKeySwitchGuardTime.
otThreadGetLeaderData ( otInstance *aInstance, otLeaderData *aLeaderData)
Esta função obtém os dados do Thread Leader.
otThreadGetLeaderRloc ( otInstance *aInstance, otIp6Address *aLeaderRloc)
Esta função retorna um ponteiro para o RLOC do líder.
otThreadGetLeaderRouterId ( otInstance *aInstance)
uint8_t
Obtenha a ID do roteador do líder.
otThreadGetLeaderWeight ( otInstance *aInstance)
uint8_t
Obtenha o peso do líder.
otThreadGetLinkLocalAllThreadNodesMulticastAddress ( otInstance *aInstance)
const otIp6Address *
Esta função retorna o endereço multicast Thread Link-Local All Thread Nodes.
otThreadGetLinkLocalIp6Address ( otInstance *aInstance)
const otIp6Address *
Esta função retorna o endereço IPv6 local do link do thread.
otThreadGetLinkMode ( otInstance *aInstance)
Obtenha a configuração do modo de link MLE.
otThreadGetMeshLocalEid ( otInstance *aInstance)
const otIp6Address *
Esta função retorna um ponteiro para o endereço EID local da malha.
otThreadGetMeshLocalPrefix ( otInstance *aInstance)
Esta função retorna um ponteiro para o prefixo local da malha.
otThreadGetMleCounters ( otInstance *aInstance)
const otMleCounters *
Obtenha os contadores Thread MLE.
otThreadGetNetworkKey ( otInstance *aInstance, otNetworkKey *aNetworkKey)
void
Obtenha a Thread Network Key.
otThreadGetNetworkKeyRef ( otInstance *aInstance)
Obter o otNetworkKeyRef de Tópico Chave de rede.
otThreadGetNetworkName ( otInstance *aInstance)
const char *
Obtenha o nome da rede do thread.
otThreadGetNextDiagnosticTlv (const otMessage *aMessage, otNetworkDiagIterator *aIterator, otNetworkDiagTlv *aNetworkDiagTlv)
Esta função obtém o próximo TLV de diagnóstico de rede na mensagem.
otThreadGetNextNeighborInfo ( otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo)
Esta função obtém as informações do próximo vizinho.
otThreadGetParentAverageRssi ( otInstance *aInstance, int8_t *aParentRssi)
A função recupera o RSSI médio para o Thread Parent.
otThreadGetParentInfo ( otInstance *aInstance, otRouterInfo *aParentInfo)
A função recupera informações de diagnóstico para um Thread Router como pai.
otThreadGetParentLastRssi ( otInstance *aInstance, int8_t *aLastRssi)
A função recupera o RSSI do último pacote do Thread Parent.
otThreadGetPartitionId ( otInstance *aInstance)
uint32_t
Obtenha o ID da partição.
otThreadGetRealmLocalAllThreadNodesMulticastAddress ( otInstance *aInstance)
const otIp6Address *
Esta função retorna o endereço multicast Thread Realm-Local All Thread Nodes.
otThreadGetRloc ( otInstance *aInstance)
const otIp6Address *
Esta função retorna um ponteiro para o endereço Thread Routing Locator (RLOC).
otThreadGetRloc16 ( otInstance *aInstance)
uint16_t
Obtenha o RLOC16.
otThreadGetServiceAloc ( otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc)
Esta função recupera o ALOC de serviço para um determinado ID de serviço.
otThreadGetVersion (void)
uint16_t
Esta função obtém 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 um MLE Thread Discovery está em andamento.
otThreadIsSingleton ( otInstance *aInstance)
bool
Esta função indica se um nó é o único roteador na rede.
otThreadLocateAnycastDestination ( otInstance *aInstance, const otIp6Address *aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext)
Esta função solicita que o destino mais próximo de um determinado endereço anycast seja localizado.
otThreadRegisterParentResponseCallback ( otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext)
void
Esta função registra um retorno de chamada para receber dados de resposta do pai MLE.
otThreadResetIp6Counters ( otInstance *aInstance)
void
Redefina os contadores IPv6.
otThreadResetMleCounters ( otInstance *aInstance)
void
Redefina os contadores Thread MLE.
otThreadSendAddressNotification ( otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid)
void
Esta função envia uma mensagem Proactive Address Notification (ADDR_NTF.ntf).
otThreadSendDiagnosticGet ( otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext)
Envie uma solicitação Get 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 Proactive Backbone Notification (PRO_BB.ntf) no link Backbone.
otThreadSetChildTimeout ( otInstance *aInstance, uint32_t aTimeout)
void
Defina o Thread Child Timeout usado ao operar na função Child.
otThreadSetDiscoveryRequestCallback ( otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext)
void
Esta função define um retorno de chamada para receber dados de Solicitação de Descoberta MLE.
otThreadSetDomainName ( otInstance *aInstance, const char *aDomainName)
Defina o nome do domínio do thread.
otThreadSetEnabled ( otInstance *aInstance, bool aEnabled)
Esta função inicia a operação do protocolo Thread.
otThreadSetExtendedPanId ( otInstance *aInstance, const otExtendedPanId *aExtendedPanId)
Defina o PAN ID estendido IEEE 802.15.4.
otThreadSetFixedDuaInterfaceIdentifier ( otInstance *aInstance, const otIp6InterfaceIdentifier *aIid)
Definir / limpar o identificador de interface especificado manualmente para o endereço Unicast do domínio do thread.
otThreadSetJoinerAdvertisement ( otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength)
Este método define o Thread Joiner Advertisement ao descobrir a rede Thread.
otThreadSetKeySequenceCounter ( otInstance *aInstance, uint32_t aKeySequenceCounter)
void
Defina o thrKeySequenceCounter.
otThreadSetKeySwitchGuardTime ( otInstance *aInstance, uint32_t aKeySwitchGuardTime)
void
Defina o thrKeySwitchGuardTime.
otThreadSetLinkMode ( otInstance *aInstance, otLinkModeConfig aConfig)
Defina a configuração do modo de link MLE.
otThreadSetMeshLocalPrefix ( otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix)
Esta função define o prefixo local da malha.
otThreadSetNetworkKey ( otInstance *aInstance, const otNetworkKey *aKey)
Defina a chave de rede do thread.
otThreadSetNetworkKeyRef ( otInstance *aInstance, otNetworkKeyRef aKeyRef)
Definir o segmento chave de rede como um otNetworkKeyRef .
otThreadSetNetworkName ( otInstance *aInstance, const char *aNetworkName)
Defina o nome da rede do thread.

Structs

otBorderRouterConfig

Esta estrutura representa uma configuração do Border Router.

otExternalRouteConfig

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

otIpCounters

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

otLeaderData

Esta estrutura representa os dados do Thread Leader.

otLinkModeConfig

Esta estrutura representa uma configuração do modo de link MLE.

otMleCounters

Esta estrutura representa os contadores Thread MLE.

otNeighborInfo

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

otNetworkDiagChildEntry

Essa estrutura representa uma entrada de tabela filho de diagnóstico de rede.

otNetworkDiagConnectivity

Esta estrutura representa um valor de conectividade de diagnóstico de rede.

otNetworkDiagMacCounters

Esta estrutura representa um valor de contadores Mac de diagnóstico de rede.

otNetworkDiagRoute

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

otNetworkDiagRouteData

Esta estrutura representa os dados de uma rota de diagnóstico de rede.

otNetworkDiagTlv

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

otRouterInfo

Esta estrutura contém informações de diagnóstico para um Thread Router.

otServerConfig

Esta estrutura representa uma configuração de servidor.

otServiceConfig

Esta estrutura representa uma configuração de serviço.

otThreadDiscoveryRequestInfo

Esta estrutura representa os dados do Thread Discovery Request.

otThreadParentResponseInfo

Esta estrutura representa os dados da Resposta Pai MLE.

Enumerações

enum anônimo

 anonymous enum
Propriedades
OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL

Nível da bateria TLV.

OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES

Páginas do canal TLV.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE

Tabela infantil TLV.

OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY

Conectividade TLV.

OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS

Endereço estendido MAC TLV.

OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST

Lista de endereços IPv6 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA

Dados do líder TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS

Contadores MAC TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT

Tempo limite máximo da criança TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MODE

Modo TLV.

OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA

Rede de dados TLV.

OT_NETWORK_DIAGNOSTIC_TLV_ROUTE

Route64 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS

Address16 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE

Tensão de alimentação TLV.

OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT

Tempo limite TLV (o período máximo de pesquisa para SEDs)

OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST

Lista de tipos TLV.

otDeviceRole

 otDeviceRole

Representa uma função de dispositivo Thread.

Propriedades
OT_DEVICE_ROLE_CHILD

A função Thread Child.

OT_DEVICE_ROLE_DETACHED

Atualmente não participa de uma rede / partição Thread.

OT_DEVICE_ROLE_DISABLED

A pilha de threads está desabilitada.

OT_DEVICE_ROLE_LEADER

A função Thread Leader.

OT_DEVICE_ROLE_ROUTER

A função Thread Router.

otNetDataPublisherEvent

 otNetDataPublisherEvent

Essa enumeração representa os eventos relatados dos retornos de chamada do Publicador.

Propriedades
OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED

A entrada publicada é adicionada aos dados da rede do thread.

OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED

A entrada publicada é removida dos Dados da Rede do Thread.

otRoutePreference

 otRoutePreference

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

Propriedades
OT_ROUTE_PREFERENCE_HIGH

Alta preferência de rota.

OT_ROUTE_PREFERENCE_LOW

Preferência de rota baixa.

OT_ROUTE_PREFERENCE_MED

Preferência de rota média.

Typedefs

otBorderRouterConfig

struct otBorderRouterConfig otBorderRouterConfig

Esta estrutura representa uma configuração do Border Router.

otExternalRouteConfig

struct otExternalRouteConfig otExternalRouteConfig

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

otIpCounters

struct otIpCounters otIpCounters

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

otLeaderData

struct otLeaderData otLeaderData

Esta estrutura representa os dados do Thread Leader.

otLinkModeConfig

struct otLinkModeConfig otLinkModeConfig

Esta estrutura representa uma configuração do modo de link MLE.

otMleCounters

struct otMleCounters otMleCounters

Esta estrutura representa os contadores Thread MLE.

otNeighborInfoIterator

int16_t otNeighborInfoIterator

Usado para iterar por meio da tabela de vizinhos.

otNetDataDnsSrpServicePublisherCallback

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

Este tipo de ponteiro de função define o retorno de chamada usado para notificar quando uma entrada "Serviço DNS / SRP" é adicionada ou removida dos Dados de Rede de Threads.

Em remover o retorno de chamada é invocado independentemente da entrada é removida por Publisher (por exemplo, quando há muitas entradas semelhantes já presentes no Data Network) ou através de uma chamada explícita para despublicar a 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 o contexto específico do aplicativo.

otNetDataPrefixPublisherCallback

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

Este tipo de ponteiro de função define o retorno de chamada usado para notificar quando uma entrada de prefixo (em malha ou rota externa) é adicionada ou removida dos Dados de Rede de Threads.

Em remover o retorno de chamada é invocado independentemente da entrada é removida por Publisher (por exemplo, quando há muitas entradas semelhantes já presentes no Data Network) ou através de uma chamada explícita para despublicar a entrada.

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

otNetDataPublisherEvent

enum otNetDataPublisherEvent otNetDataPublisherEvent

Essa enumeração representa os eventos relatados dos retornos de chamada do Publicador.

otNetworkDataIterator

uint32_t otNetworkDataIterator

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

otNetworkDiagChildEntry

struct otNetworkDiagChildEntry otNetworkDiagChildEntry

Essa estrutura representa uma entrada de tabela filho de diagnóstico de rede.

otNetworkDiagConnectivity

struct otNetworkDiagConnectivity otNetworkDiagConnectivity

Esta estrutura representa um valor de conectividade de diagnóstico de rede.

otNetworkDiagIterator

uint16_t otNetworkDiagIterator

Usado para iterar por meio do TLV de diagnóstico de rede.

otNetworkDiagMacCounters

struct otNetworkDiagMacCounters otNetworkDiagMacCounters

Esta estrutura representa um valor de contadores Mac de diagnóstico de rede.

Veja RFC 2863 para a definição de campos de membros.

otNetworkDiagRoute

struct otNetworkDiagRoute otNetworkDiagRoute

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

otNetworkDiagRouteData

struct otNetworkDiagRouteData otNetworkDiagRouteData

Esta estrutura representa os dados de uma rota de diagnóstico de rede.

otNetworkDiagTlv

struct otNetworkDiagTlv otNetworkDiagTlv

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

otReceiveDiagnosticGetCallback

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

Este ponteiro de função é chamado quando a resposta Get de diagnóstico de rede é recebida.

Detalhes
Parâmetros
[in] aError
O erro ocorre quando falha em obter a resposta.
[in] aMessage
Um ponteiro para o buffer de mensagem que contém a carga útil de resposta Get de diagnóstico de rede recebida. Disponível apenas quando aError é OT_ERROR_NONE .
[in] aMessageInfo
Um ponteiro para a informação mensagem para aMessage . Disponível apenas quando aError é OT_ERROR_NONE .
[in] aContext
Um ponteiro para o contexto específico do aplicativo.

otRoutePreference

enum otRoutePreference otRoutePreference

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

otServerConfig

struct otServerConfig otServerConfig

Esta estrutura representa uma configuração de servidor.

otServiceConfig

struct otServiceConfig otServiceConfig

Esta estrutura representa uma configuração de serviço.

otThreadAnycastLocatorCallback

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

Este tipo de ponteiro de função define o retorno de chamada para notificar o resultado de um otThreadLocateAnycastDestination() pedido.

Detalhes
Parâmetros
[in] aContext
Um ponteiro para um contexto arbitrário (fornecido quando o retorno de chamada é registrado).
[in] aError
O erro ao lidar com a solicitação. OT_ERROR_NONE indica sucesso. OT_ERROR_RESPONSE_TIMEOUT indica que um destino não foi encontrado. OT_ERROR_ABORT indica que a solicitação foi abortada.
[in] aMeshLocalAddress
Um ponteiro para o EID malha-local do destino mais próximo do endereço anycast quando aError é OT_ERROR_NONE, NULL contrário.
[in] aRloc16
O RLOC16 do destino se encontrado, caso contrário, RLOC16 inválido (0xfffe).

otThreadDiscoveryRequestCallback

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

Este ponteiro de função é chamado sempre que uma mensagem de solicitação de descoberta 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 o contexto específico do aplicativo de retorno de chamada.

otThreadDiscoveryRequestInfo

struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo

Esta estrutura representa os dados do Thread Discovery Request.

otThreadParentResponseCallback

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

Este ponteiro de função é chamado toda vez que uma mensagem de resposta pai MLE é recebida.

Detalhes
Parâmetros
[in] aStats
ponteiro para um local na pilha que contém os dados estatísticos.
[in] aContext
Um ponteiro para o contexto específico do cliente de retorno de chamada.

otThreadParentResponseInfo

struct otThreadParentResponseInfo otThreadParentResponseInfo

Esta estrutura representa os dados da Resposta Pai MLE.

Funções

otNetDataGet

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

Este método fornece uma cópia completa ou estável dos dados de rede de threads da partição.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância 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 da memória tampão de dados apontado pelo aData . Na saída, número de bytes copiados.

otNetDataGetNextOnMeshPrefix

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

Esta função obtém o próximo prefixo On Mesh nos dados de rede da partição.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in,out] aIterator
Um ponteiro para o contexto do iterador de dados de rede. Para obter a primeira entrada na malha, ela deve ser definida como OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Um ponteiro para onde as informações do prefixo On Mesh serão colocadas.
Valores Retornados
OT_ERROR_NONE
Encontrado com sucesso o próximo prefixo On Mesh.
OT_ERROR_NOT_FOUND
Não existe nenhum prefixo On Mesh subsequente nos Dados da Rede de Threads.

otNetDataGetNextRoute

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

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

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in,out] aIterator
Um ponteiro para o contexto do iterador de dados de rede. Para obter a primeira entrada de rota externa, ela deve ser definida como OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Um ponteiro para onde as informações de rota externa serão colocadas.
Valores Retornados
OT_ERROR_NONE
Encontrada com sucesso a próxima rota externa.
OT_ERROR_NOT_FOUND
Nenhuma entrada de rota externa subsequente existe nos dados de rede do segmento.

otNetDataGetNextService

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

Esta função obtém o próximo serviço nos dados de rede da partição.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in,out] aIterator
Um ponteiro para o contexto do iterador de dados de rede. Para obter a primeira entrada de serviço, deve ser definido como OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Um indicador de onde as informações do serviço serão colocadas.
Valores Retornados
OT_ERROR_NONE
Encontrado com sucesso o próximo serviço.
OT_ERROR_NOT_FOUND
Nenhum serviço subsequente existe nos dados de rede da partição.

otNetDataGetStableVersion

uint8_t otNetDataGetStableVersion(
  otInstance *aInstance
)

Obtenha a versão de dados de rede estável.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
Devoluções
A versão de dados de rede estável.

otNetDataGetVersion

uint8_t otNetDataGetVersion(
  otInstance *aInstance
)

Obtenha a versão de dados da rede.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
Devoluções
A versão de dados da rede.

otNetDataIsDnsSrpServiceAdded

bool otNetDataIsDnsSrpServiceAdded(
  otInstance *aInstance
)

Esta função indica se a entrada "Serviço DNS / SRP" está ou não adicionada aos Dados da Rede do Thread.

Esta função exige o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE para ser ativado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
Valores Retornados
TRUE
A entrada de serviço DNS / SRP publicada é adicionada aos dados de rede do segmento.
FALSE
A entrada não é adicionada a Thread Network Data 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 atualmente (em malha ou rota externa) é adicionada ou não aos Dados de Rede de Threads.

Esta função exige o recurso OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE para ser ativado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aPrefix
Um ponteiro para o prefixo (NÃO DEVE ser NULL).
Valores Retornados
TRUE
A entrada de prefixo publicada é adicionada aos Dados de Rede de Threads.
FALSE
A entrada não é adicionada a Thread Network Data ou não há entrada para publicar.

otNetDataPublishDnsSrpServiceAnycast

void otNetDataPublishDnsSrpServiceAnycast(
  otInstance *aInstance,
  uint8_t aSequenceNUmber
)

Esta função solicita a publicação do "Endereço Anycast do Serviço DNS / SRP" nos Dados da Rede do Thread.

Esta função exige o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE para ser ativado.

Uma chamada para esta função irá remover e substituir qualquer entrada anterior "DNS / SRP Service" que estava sendo publicado (a partir de chamada anterior a qualquer um dos otNetDataPublishDnsSrpService{Type}() funções).

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

Esta função requer que "DNS / SRP Service Unicast Address" seja publicado nos Thread Network Data.

Esta função exige o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE para ser ativado.

Uma chamada para esta função irá remover e substituir qualquer entrada anterior "DNS / SRP Service" que estava sendo publicado (a partir de chamada anterior a qualquer um dos otNetDataPublishDnsSrpService{Type}() funções).

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

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

otNetDataPublishDnsSrpServiceUnicastMeshLocalEid

void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(
  otInstance *aInstance,
  uint16_t aPort
)

Esta função requer que "DNS / SRP Service Unicast Address" seja publicado nos Thread Network Data.

Esta função exige o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE para ser ativado.

Uma chamada para esta função irá remover e substituir qualquer entrada anterior "DNS / SRP Service" que estava sendo publicado (a partir de chamada anterior a qualquer um dos otNetDataPublishDnsSrpService{Type}() funções).

Ao contrário otNetDataPublishDnsSrpServiceUnicast() que requer o endereço publicada a ser dado e inclui a informação nos dados de Serviço TLV, essa função usa EID malha local do dispositivo e inclui a informação nos dados Servidor TLV.

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

otNetDataPublishExternalRoute

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

Esta função requer um prefixo de rota externa a ser publicado nos Thread Network Data.

Esta função exige o recurso OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE para ser ativado.

Somente as entradas estáveis pode ser publicado (ie, aConfig.mStable deve ser verdade).

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aConfig
A configuração da rota externa para publicar (NÃO DEVE ser NULL).
Valores Retornados
OT_ERROR_NONE
A rota externa foi publicada com sucesso.
OT_ERROR_INVALID_ARGS
O aConfig não é válido (mau prefixo, combinações de flag inválidas, ou não estável).
OT_ERROR_ALREADY
Uma entrada com o mesmo prefixo já está na lista publicada.
OT_ERROR_NO_BUFS
Não foi possível alocar uma entrada para a nova solicitação. Publisher suporta um número limitado de entradas (partilhada entre em malha-prefixo e via externa) determinada pela configuração OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES .

otNetDataPublishOnMeshPrefix

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

Esta função solicita que um prefixo em malha seja publicado nos Thread Network Data.

Esta função exige o recurso OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE para ser ativado.

Somente as entradas estáveis pode ser publicado (ie, aConfig.mStable deve ser verdade).

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aConfig
A configuração do prefixo na malha para publicar (NÃO DEVE ser NULL).
Valores Retornados
OT_ERROR_NONE
O prefixo na malha foi publicado com sucesso.
OT_ERROR_INVALID_ARGS
O aConfig não é válido (mau prefixo, combinações de flag inválidas, ou não estável).
OT_ERROR_ALREADY
Uma entrada com o mesmo prefixo já está na lista publicada.
OT_ERROR_NO_BUFS
Não foi possível alocar uma entrada para a nova solicitação. Publisher suporta um número limitado de entradas (partilhada entre em malha-prefixo e via externa) determinada pela configuração OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES .

otNetDataSetDnsSrpServicePublisherCallback

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

Esta função define um retorno de chamada para notificar quando um "Serviço DNS / SRP" publicado é realmente adicionado ou removido dos Dados de Rede de Threads.

Uma chamada subsequente para esta função substitui qualquer função de retorno de chamada definida anteriormente.

Esta função exige o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE para ser ativado.

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

otNetDataSetPrefixPublisherCallback

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

Esta função define um retorno de chamada para notificar quando uma entrada de prefixo publicada é realmente adicionada ou removida dos Dados de Rede de Threads.

Uma chamada subsequente para esta função substitui qualquer função de retorno de chamada definida anteriormente.

Esta função exige o recurso OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE para ser ativado.

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

otNetDataSteeringDataCheckJoiner

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

Verifique se os dados de direção incluem um marceneiro.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aEui64
Um ponteiro para o IEEE EUI-64 do marceneiro.
Valores Retornados
OT_ERROR_NONE
aEui64 está incluído nos dados de direcção.
OT_ERROR_INVALID_STATE
Sem dados de direção presentes.
OT_ERROR_NOT_FOUND
aEui64 não está incluído nos dados de direcção.

otNetDataSteeringDataCheckJoinerWithDiscerner

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

Verifique se os dados de direção incluem um Joiner com um determinado valor de discerner.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aDiscerner
Um ponteiro para o Discerner Joiner.
Valores Retornados
OT_ERROR_NONE
aDiscerner está incluído nos dados de direcção.
OT_ERROR_INVALID_STATE
Sem dados de direção presentes.
OT_ERROR_NOT_FOUND
aDiscerner não está incluído nos dados de direcção.

otNetDataUnpublishDnsSrpService

void otNetDataUnpublishDnsSrpService(
  otInstance *aInstance
)

Esta função cancela a publicação de qualquer entrada "Serviço DNS / SRP (Anycast ou Unicast)" adicionada anteriormente dos Dados de Rede de Threads.

Esta função exige o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE para ser ativado.

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

otNetDataUnpublishPrefix

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

Esta função cancela a publicação de um prefixo publicado anteriormente (em malha ou rota externa).

Esta função exige o recurso OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE para ser ativado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aPrefix
O prefixo para cancelar a publicação (NÃO DEVE ser NULL).
Valores Retornados
OT_ERROR_NONE
O prefixo não foi publicado com sucesso.
OT_ERROR_NOT_FOUND
Não foi possível encontrar o prefixo na lista publicada.

otThreadBecomeChild

otError otThreadBecomeChild(
  otInstance *aInstance
)

Tente se reconectar quando era criança.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
Valores Retornados
OT_ERROR_NONE
Comece com sucesso a tentativa de se tornar uma criança.
OT_ERROR_INVALID_STATE
O tópico está desativado.

otThreadBecomeDetached

otError otThreadBecomeDetached(
  otInstance *aInstance
)

Desconecte-se da rede Thread.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
Valores Retornados
OT_ERROR_NONE
Separado com sucesso da rede Thread.
OT_ERROR_INVALID_STATE
O tópico está desativado.

otThreadDeviceRoleToString

const char * otThreadDeviceRoleToString(
  otDeviceRole aRole
)

Converta a função do dispositivo em string legível por humanos.

Detalhes
Parâmetros
[in] aRole
A função do dispositivo a ser convertida.
Devoluções
Uma string representando aRole .

otThreadDiscover

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

Esta função inicia uma varredura de descoberta de thread.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aScanChannels
Um vetor de bit que indica quais canais fazer a varredura (por exemplo, OT_CHANNEL_11_MASK).
[in] aPanId
O filtro PAN ID (definido como Broadcast PAN para desabilitar o filtro).
[in] aJoiner
Valor do Sinalizador de Joiner no TLV de Solicitação de Descoberta.
[in] aEnableEui64Filtering
TRUE para filtrar respostas em EUI-64, FALSE caso contrário.
[in] aCallback
Um ponteiro para uma função chamada ao receber uma resposta de descoberta de MLE ou varredura é concluída.
[in] aCallbackContext
Um ponteiro para o contexto específico do aplicativo.
Valores Retornados
OT_ERROR_NONE
Iniciou com sucesso uma varredura de descoberta de thread.
OT_ERROR_INVALID_STATE
A interface IPv6 não está habilitada (netif não está ativo).
OT_ERROR_NO_BUFS
Não foi possível alocar mensagem para solicitação de descoberta.
OT_ERROR_BUSY
A varredura de descoberta de thread já está em andamento.

otThreadGetChildTimeout

uint32_t otThreadGetChildTimeout(
  otInstance *aInstance
)

Obtenha o Thread Child Timeout usado ao operar na função Child.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
Devoluções
O valor do Tempo Limite do Thread Filho em segundos.
Veja também:
otThreadSetChildTimeout

otThreadGetDeviceRole

otDeviceRole otThreadGetDeviceRole(
  otInstance *aInstance
)

Obtenha a função do dispositivo.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
Valores Retornados
OT_DEVICE_ROLE_DISABLED
A pilha de threads está desabilitada.
OT_DEVICE_ROLE_DETACHED
O dispositivo não está participando de uma rede / partição Thread.
OT_DEVICE_ROLE_CHILD
O dispositivo está operando atualmente como um Thread Child.
OT_DEVICE_ROLE_ROUTER
O dispositivo está operando atualmente como um Thread Router.
OT_DEVICE_ROLE_LEADER
O dispositivo está operando atualmente como Thread Leader.

otThreadGetDomainName

const char * otThreadGetDomainName(
  otInstance *aInstance
)

Obtenha o nome de domínio do thread.

Esta função está disponível apenas a partir do Tópico 1.2.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
Devoluções
Um ponteiro para o Thread Domain Name.
Veja também:
otThreadSetDomainName

otThreadGetExtendedPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

Obtenha o PAN ID estendido IEEE 802.15.4.

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

otThreadGetFixedDuaInterfaceIdentifier

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
  otInstance *aInstance
)

Obtenha o identificador de interface especificado manualmente para o endereço Unicast do domínio do thread.

Esta função só está disponível desde Tópico 1.2 quando OPENTHREAD_CONFIG_DUA_ENABLE está habilitado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
Devoluções
Um ponteiro para o Identificador de interface que foi definido manualmente ou NULL se nenhum foi definido.
Veja também:
otThreadSetFixedDuaInterfaceIdentifier

otThreadGetIp6Counters

const otIpCounters * otThreadGetIp6Counters(
  otInstance *aInstance
)

Obtenha os contadores IPv6.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
Devoluções
Um ponteiro para os contadores IPv6.

otThreadGetKeySequenceCounter

uint32_t otThreadGetKeySequenceCounter(
  otInstance *aInstance
)

Obtenha o thrKeySequenceCounter.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
Devoluções
O valor thrKeySequenceCounter.
Veja também:
otThreadSetKeySequenceCounter

otThreadGetKeySwitchGuardTime

uint32_t otThreadGetKeySwitchGuardTime(
  otInstance *aInstance
)

Obtenha o thrKeySwitchGuardTime.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
Devoluções
O valor thrKeySwitchGuardTime (em horas).
Veja também:
otThreadSetKeySwitchGuardTime

otThreadGetLeaderData

otError otThreadGetLeaderData(
  otInstance *aInstance,
  otLeaderData *aLeaderData
)

Esta função obtém os dados do Thread Leader.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[out] aLeaderData
Um ponteiro para onde os dados do líder são colocados.
Valores Retornados
OT_ERROR_NONE
Recuperado com sucesso os dados do líder.
OT_ERROR_DETACHED
Atualmente não anexado.

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 OpenThread.
[out] aLeaderRloc
Um ponteiro para o RLOC do líder.
Valores Retornados
OT_ERROR_NONE
RLOC do Líder foi escrito com sucesso para aLeaderRloc .
OT_ERROR_INVALID_ARGS
aLeaderRloc foi NULL.
OT_ERROR_DETACHED
Atualmente não anexado a uma partição de thread.

otThreadGetLeaderRouterId

uint8_t otThreadGetLeaderRouterId(
  otInstance *aInstance
)

Obtenha a ID do roteador do líder.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
Devoluções
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 OpenThread.
Devoluções
O peso do líder.

otThreadGetLinkLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetLinkLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

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

O endereço é um link local Unicast Prefix-Based Multcast Address [RFC 3306], com:

  • flgs definido como 3 (P = 1 e T = 1)
  • scop definido como 2
  • plenário definido para 64
  • prefixo de rede definido para o prefixo local de malha
  • ID do grupo definido como 1

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
Devoluções
Um ponteiro para o endereço multicast Thread Link-Local All Thread Nodes.

otThreadGetLinkLocalIp6Address

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

Esta função retorna o endereço IPv6 local do link do thread.

O endereço local do link de thread é derivado usando IEEE802.15.4 Extended Address as Interface Identifier.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
Devoluções
Um ponteiro para o endereço IPv6 local do link do thread.

otThreadGetLinkMode

otLinkModeConfig otThreadGetLinkMode(
  otInstance *aInstance
)

Obtenha a configuração do modo de link MLE.

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

otThreadGetMeshLocalEid

const otIp6Address * otThreadGetMeshLocalEid(
  otInstance *aInstance
)

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

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

otThreadGetMeshLocalPrefix

const otMeshLocalPrefix * otThreadGetMeshLocalPrefix(
  otInstance *aInstance
)

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

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
Devoluções
Um ponteiro para o prefixo local da malha.

otThreadGetMleCounters

const otMleCounters * otThreadGetMleCounters(
  otInstance *aInstance
)

Obtenha os contadores Thread MLE.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
Devoluções
Um ponteiro para os contadores Thread MLE.

otThreadGetNetworkKey

void otThreadGetNetworkKey(
  otInstance *aInstance,
  otNetworkKey *aNetworkKey
)

Obtenha a chave de rede do thread.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[out] aNetworkKey
Um ponteiro para uma otNetworkkey para retornar o segmento chave de rede.
Veja também:
otThreadSetNetworkKey

otThreadGetNetworkKeyRef

otNetworkKeyRef otThreadGetNetworkKeyRef(
  otInstance *aInstance
)

Obter o otNetworkKeyRef de Tópico Chave de rede.

Esta função exige o recurso de tempo de compilação OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE para ser ativado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
Devoluções
Referência à Thread Network Key armazenada na memória.
Veja também:
otThreadSetNetworkKeyRef

otThreadGetNetworkName

const char * otThreadGetNetworkName(
  otInstance *aInstance
)

Obtenha o nome da rede do thread.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
Devoluções
Um ponteiro para o Thread Network Name.
Veja também:
otThreadSetNetworkName

otThreadGetNextDiagnosticTlv

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

Esta função obtém o próximo TLV de diagnóstico de rede na mensagem.

Uma chamada subsequente para esta função é permitida apenas 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, ele deve ser definido como OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT.
[out] aNetworkDiagTlv
Um ponteiro para onde as informações do TLV de diagnóstico de rede serão colocadas.
Valores Retornados
OT_ERROR_NONE
Encontrado com sucesso o próximo TLV de diagnóstico de rede.
OT_ERROR_NOT_FOUND
Nenhum TLV de diagnóstico de rede subsequente existe na mensagem.
OT_ERROR_PARSE
A análise do próximo diagnóstico de rede falhou.

otThreadGetNextNeighborInfo

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

Esta função obtém as informações do próximo vizinho.

Ele é usado para percorrer as entradas da tabela de vizinhos.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in,out] aIterator
Um ponteiro para o contexto do iterador. Para obter a primeira entrada de vizinho, ela deve ser definida como OT_NEIGHBOR_INFO_ITERATOR_INIT.
[out] aInfo
Um ponteiro para as informações do vizinho.
Valores Retornados
OT_ERROR_NONE
Encontrada com sucesso a próxima entrada de vizinho na tabela.
OT_ERROR_NOT_FOUND
Nenhuma entrada subsequente de vizinho existe na tabela.
OT_ERROR_INVALID_ARGS
aIterator ou aInfo foi nula.

otThreadGetParentA AverageRssi

otError otThreadGetParentAverageRssi(
  otInstance *aInstance,
  int8_t *aParentRssi
)

A função recupera o RSSI médio para o Thread Parent.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[out] aParentRssi
Um ponteiro para onde o RSSI pai deve ser colocado.

otThreadGetParentInfo

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

The function retrieves diagnostic information for a Thread Router as parent.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[out] aParentInfo
A pointer to where the parent router information is placed.

otThreadGetParentLastRssi

otError otThreadGetParentLastRssi(
  otInstance *aInstance,
  int8_t *aLastRssi
)

The function retrieves the RSSI of the last packet from the Thread Parent.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[out] aLastRssi
A pointer to where the last RSSI should be placed.
Return Values
OT_ERROR_NONE
Successfully retrieved the RSSI data.
OT_ERROR_FAILED
Unable to get RSSI data.
OT_ERROR_INVALID_ARGS
aLastRssi is NULL.

otThreadGetPartitionId

uint32_t otThreadGetPartitionId(
  otInstance *aInstance
)

Get the Partition ID.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Returns
The Partition ID.

otThreadGetRealmLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

This function returns the Thread Realm-Local All Thread Nodes multicast address.

The address is a realm-local Unicast Prefix-Based Multcast Address [RFC 3306], with:

  • flgs set to 3 (P = 1 and T = 1)
  • scop set to 3
  • plen set to 64
  • network prefix set to the Mesh Local Prefix
  • group ID set to 1

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Returns
A pointer to Thread Realm-Local All Thread Nodes multicast address.

otThreadGetRloc

const otIp6Address * otThreadGetRloc(
  otInstance *aInstance
)

This function returns a pointer to the Thread Routing Locator (RLOC) address.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Returns
A pointer to the Thread Routing Locator (RLOC) address.

otThreadGetRloc16

uint16_t otThreadGetRloc16(
  otInstance *aInstance
)

Get the RLOC16.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Returns
The RLOC16.

otThreadGetServiceAloc

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

This function retrieves the Service ALOC for given Service ID.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aServiceId
Service ID to get ALOC for.
[out] aServiceAloc
A pointer to output the Service ALOC. MUST NOT BE NULL.
Return Values
OT_ERROR_NONE
Successfully retrieved the Service ALOC.
OT_ERROR_DETACHED
The Thread interface is not currently attached to a Thread Partition.

otThreadGetVersion

uint16_t otThreadGetVersion(
  void
)

This function gets the Thread protocol version.

Details
Returns
the Thread protocol version.

otThreadIsAnycastLocateInProgress

bool otThreadIsAnycastLocateInProgress(
  otInstance *aInstance
)

This function indicates whether an anycast locate request is currently in progress.

This function is only available when OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE is enabled.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Returns
TRUE if an anycast locate request is currently in progress, FALSE otherwise.

otThreadIsDiscoverInProgress

bool otThreadIsDiscoverInProgress(
  otInstance *aInstance
)

This function determines if an MLE Thread Discovery is currently in progress.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.

otThreadIsSingleton

bool otThreadIsSingleton(
  otInstance *aInstance
)

This function indicates whether a node is the only router on the network.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Return Values
TRUE
It is the only router in the network.
FALSE
It is a child or is not a single router in the network.

otThreadLocateAnycastDestination

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

This function requests the closest destination of a given anycast address to be located.

This function is only available when OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE is enabled.

If a previous request is ongoing, a subsequent call to this function will cancel and replace the earlier request.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aAnycastAddress
The anycast address to locate. MUST NOT be NULL.
[in] aCallback
The callback function to report the result.
[in] aContext
An arbitrary context used with aCallback .
Return Values
OT_ERROR_NONE
The request started successfully. aCallback will be invoked to report the result.
OT_ERROR_INVALID_ARGS
The aAnycastAddress is not a valid anycast address or aCallback is NULL.
OT_ERROR_NO_BUFS
Out of buffer to prepare and send the request message.

otThreadRegisterParentResponseCallback

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

This function registers a callback to receive MLE Parent Response data.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aCallback
A pointer to a function that is called upon receiving an MLE Parent Response message.
[in] aContext
A pointer to callback client-specific context.

otThreadResetIp6Counters

void otThreadResetIp6Counters(
  otInstance *aInstance
)

Reset the IPv6 counters.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.

otThreadResetMleCounters

void otThreadResetMleCounters(
  otInstance *aInstance
)

Reset the Thread MLE counters.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.

otThreadSendAddressNotification

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

This function sends a Proactive Address Notification (ADDR_NTF.ntf) message.

This function is only available when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE is enabled.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aDestination
The destination to send the ADDR_NTF.ntf message.
[in] aTarget
The target address of the ADDR_NTF.ntf message.
[in] aMlIid
The ML-IID of the ADDR_NTF.ntf message.

otThreadSendDiagnosticGet

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

Send a Network Diagnostic Get request.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aDestination
A pointer to destination address.
[in] aTlvTypes
An array of Network Diagnostic TLV types.
[in] aCount
Number of types in aTlvTypes.
[in] aCallback
A pointer to a function that is called when Network Diagnostic Get response is received or NULL to disable the callback.
[in] aCallbackContext
A pointer to application-specific context.
Return Values
OT_ERROR_NONE
Successfully queued the DIAG_GET.req.
OT_ERROR_NO_BUFS
Insufficient message buffers available to send DIAG_GET.req.

otThreadSendDiagnosticReset

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

Send a Network Diagnostic Reset request.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aDestination
A pointer to destination address.
[in] aTlvTypes
An array of Network Diagnostic TLV types. Currently only Type 9 is allowed.
[in] aCount
Number of types in aTlvTypes
Return Values
OT_ERROR_NONE
Successfully queued the DIAG_RST.ntf.
OT_ERROR_NO_BUFS
Insufficient message buffers available to send DIAG_RST.ntf.

otThreadSendProactiveBackboneNotification

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

This function sends a Proactive Backbone Notification (PRO_BB.ntf) message on the Backbone link.

This function is only available when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE is enabled.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aTarget
The target address of the PRO_BB.ntf message.
[in] aMlIid
The ML-IID of the PRO_BB.ntf message.
[in] aTimeSinceLastTransaction
Time since last transaction (in seconds).
Return Values
OT_ERROR_NONE
Successfully sent PRO_BB.ntf on backbone link.
OT_ERROR_NO_BUFS
If insufficient message buffers available.

otThreadSetChildTimeout

void otThreadSetChildTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

Set the Thread Child Timeout used when operating in the Child role.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aTimeout
The timeout value in seconds.
See also:
otThreadGetChildTimeout

otThreadSetDiscoveryRequestCallback

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

This function sets a callback to receive MLE Discovery Request data.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aCallback
A pointer to a function that is called upon receiving an MLE Discovery Request message.
[in] aContext
A pointer to callback application-specific context.

otThreadSetDomainName

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

Set the Thread Domain Name.

This function is only available since Thread 1.2. This function succeeds only when Thread protocols are disabled.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aDomainName
A pointer to the Thread Domain Name.
Return Values
OT_ERROR_NONE
Successfully set the Thread Domain Name.
OT_ERROR_INVALID_STATE
Thread protocols are enabled.
See also:
otThreadGetDomainName

otThreadSetEnabled

otError otThreadSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

This function starts Thread protocol operation.

The interface must be up when calling this function.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aEnabled
TRUE if Thread is enabled, FALSE otherwise.
Return Values
OT_ERROR_NONE
Successfully started Thread protocol operation.
OT_ERROR_INVALID_STATE
The network interface was not not up.

otThreadSetExtendedPanId

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

Set the IEEE 802.15.4 Extended PAN ID.

This function can only be called while Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aExtendedPanId
A pointer to the IEEE 802.15.4 Extended PAN ID.
Return Values
OT_ERROR_NONE
Successfully set the Extended PAN ID.
OT_ERROR_INVALID_STATE
Thread protocols are enabled.
See also:
otThreadGetExtendedPanId

otThreadSetFixedDuaInterfaceIdentifier

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

Set/Clear the Interface Identifier manually specified for the Thread Domain Unicast Address.

This function is only available since Thread 1.2 when OPENTHREAD_CONFIG_DUA_ENABLE is enabled.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aIid
A pointer to the Interface Identifier to set or NULL to clear.
Return Values
OT_ERROR_NONE
Successfully set/cleared the Interface Identifier.
OT_ERROR_INVALID_ARGS
The specified Interface Identifier is reserved.
See also:
otThreadGetFixedDuaInterfaceIdentifier

otThreadSetJoinerAdvertisement

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

This method sets the Thread Joiner Advertisement when discovering Thread network.

Thread Joiner Advertisement is used to allow a Joiner to advertise its own application-specific information (such as Vendor ID, Product ID, Discriminator, etc.) via a newly-proposed Joiner Advertisement TLV, and to make this information available to Commissioners or Commissioner Candidates without human interaction.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aOui
The Vendor IEEE OUI value that will be included in the Joiner Advertisement. Only the least significant 3 bytes will be used, and the most significant byte will be ignored.
[in] aAdvData
A pointer to the AdvData that will be included in the Joiner Advertisement.
[in] aAdvDataLength
The length of AdvData in bytes.
Return Values
OT_ERROR_NONE
Successfully set Joiner Advertisement.
OT_ERROR_INVALID_ARGS
Invalid AdvData.

otThreadSetKeySequenceCounter

void otThreadSetKeySequenceCounter(
  otInstance *aInstance,
  uint32_t aKeySequenceCounter
)

Set the thrKeySequenceCounter.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aKeySequenceCounter
The thrKeySequenceCounter value.
See also:
otThreadGetKeySequenceCounter

otThreadSetKeySwitchGuardTime

void otThreadSetKeySwitchGuardTime(
  otInstance *aInstance,
  uint32_t aKeySwitchGuardTime
)

Set the thrKeySwitchGuardTime.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aKeySwitchGuardTime
The thrKeySwitchGuardTime value (in hours).
See also:
otThreadGetKeySwitchGuardTime

otThreadSetLinkMode

otError otThreadSetLinkMode(
  otInstance *aInstance,
  otLinkModeConfig aConfig
)

Set the MLE Link Mode configuration.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aConfig
A pointer to the Link Mode configuration.
Return Values
OT_ERROR_NONE
Successfully set the MLE Link Mode configuration.
See also:
otThreadGetLinkMode

otThreadSetMeshLocalPrefix

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

This function sets the Mesh Local Prefix.

This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aMeshLocalPrefix
A pointer to the Mesh Local Prefix.
Return Values
OT_ERROR_NONE
Successfully set the Mesh Local Prefix.
OT_ERROR_INVALID_STATE
Thread protocols are enabled.

otThreadSetNetworkKey

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

Set the Thread Network Key.

This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aKey
A pointer to a buffer containing the Thread Network Key.
Return Values
OT_ERROR_NONE
Successfully set the Thread Network Key.
OT_ERROR_INVALID_STATE
Thread protocols are enabled.
See also:
otThreadGetNetworkKey

otThreadSetNetworkKeyRef

otError otThreadSetNetworkKeyRef(
  otInstance *aInstance,
  otNetworkKeyRef aKeyRef
)

Set the Thread Network Key as a otNetworkKeyRef .

This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

This function requires the build-time feature OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE to be enabled.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aKeyRef
Reference to the Thread Network Key.
Return Values
OT_ERROR_NONE
Successfully set the Thread Network Key.
OT_ERROR_INVALID_STATE
Thread protocols are enabled.
See also:
otThreadGetNetworkKeyRef

otThreadSetNetworkName

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

Set the Thread Network Name.

This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aNetworkName
A pointer to the Thread Network Name.
Return Values
OT_ERROR_NONE
Successfully set the Thread Network Name.
OT_ERROR_INVALID_STATE
Thread protocols are enabled.
See also:
otThreadGetNetworkName

Macros

OT_JOINER_ADVDATA_MAX_LENGTH

 OT_JOINER_ADVDATA_MAX_LENGTH 64

Maximum AdvData Length of Joiner Advertisement.

OT_NEIGHBOR_INFO_ITERATOR_INIT

 OT_NEIGHBOR_INFO_ITERATOR_INIT 0

Initializer for otNeighborInfoIterator.

OT_NETWORK_BASE_TLV_MAX_LENGTH

 OT_NETWORK_BASE_TLV_MAX_LENGTH 254

Maximum value length of Thread Base TLV.

OT_NETWORK_DATA_ITERATOR_INIT

 OT_NETWORK_DATA_ITERATOR_INIT 0

Value to initialize otNetworkDataIterator .

OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE

 OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE 3

Size of Network Diagnostic Child Table entry.

OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT

 OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT 0

Initializer for otNetworkDiagIterator.

OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES

 OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19

Maximum Number of Network Diagnostic TLV Types to Request or Reset.

OT_NETWORK_MAX_ROUTER_ID

 OT_NETWORK_MAX_ROUTER_ID 62

Maximum Router ID.

OT_SERVER_DATA_MAX_SIZE

 OT_SERVER_DATA_MAX_SIZE 248

Max size of Server Data in bytes. Theoretical limit, practically much lower.

OT_SERVICE_DATA_MAX_SIZE

 OT_SERVICE_DATA_MAX_SIZE 252

Max size of Service Data in bytes.