Geral

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

Resumo

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

Todas as funções neste módulo exigem que OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE esteja 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,
  OT_NETWORK_DIAGNOSTIC_TLV_VERSION = 24,
  OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_NAME = 25,
  OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_MODEL = 26,
  OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_SW_VERSION = 27,
  OT_NETWORK_DIAGNOSTIC_TLV_THREAD_STACK_VERSION = 28,
  OT_NETWORK_DIAGNOSTIC_TLV_CHILD = 29,
  OT_NETWORK_DIAGNOSTIC_TLV_CHILD_IP6_ADDR_LIST = 30,
  OT_NETWORK_DIAGNOSTIC_TLV_ROUTER_NEIGHBOR = 31,
  OT_NETWORK_DIAGNOSTIC_TLV_ANSWER = 32,
  OT_NETWORK_DIAGNOSTIC_TLV_QUERY_ID = 33,
  OT_NETWORK_DIAGNOSTIC_TLV_MLE_COUNTERS = 34
}
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 um papel de dispositivo Thread.
otNetDataPublisherEvent{
  OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED = 0,
  OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED = 1
}
enum
Representa os eventos informados pelos callbacks do editor.
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
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
Representa uma configuração de rota externa.
otIpCounters typedef
struct otIpCounters
Representa os contadores no nível do IP.
otLeaderData typedef
struct otLeaderData
Representa os dados do líder da linha de execução.
otLinkModeConfig typedef
Representa uma configuração do modo de link MLE.
otLowpanContextInfo typedef
Representa as informações do ID de contexto 6LoWPAN associadas a um prefixo nos dados de rede.
otMleCounters typedef
struct otMleCounters
Representa os contadores do Thread MLE.
otNeighborInfoIterator typedef
int16_t
Usado para iterar na tabela vizinha.
otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext) typedef
void(*
O tipo de ponteiro define o callback usado para notificar quando uma entrada "Serviço DNS/SRP" é adicionada ou removida dos dados da rede Thread.
otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext) typedef
void(*
O tipo de ponteiro define o callback usado para notificar quando uma entrada de prefixo (em malha ou rota externa) é adicionada ou removida dos dados da rede Thread.
otNetDataPublisherEvent typedef
Representa os eventos informados pelos callbacks do editor.
otNetworkDataIterator typedef
uint32_t
Usado para iterar informações de dados de rede.
otNetworkDiagChildEntry typedef
Representa uma entrada de tabela filha de diagnóstico de rede.
otNetworkDiagConnectivity typedef
Representa um valor de conectividade de diagnóstico de rede.
otNetworkDiagIterator typedef
uint16_t
Usado para iterar o TLV do diagnóstico de rede.
otNetworkDiagMacCounters typedef
Representa um valor de Contadores de Mac de diagnóstico de rede.
otNetworkDiagMleCounters typedef
Representa um valor dos contadores MLE do Diagnóstico de Rede.
otNetworkDiagRoute typedef
Representa um valor de TLV da rota de diagnóstico de rede.
otNetworkDiagRouteData typedef
Representa os dados de uma rota de diagnóstico de rede.
otNetworkDiagTlv typedef
Representa um TLV de diagnóstico de rede.
otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext) typedef
void(*
O ponteiro é chamado quando a resposta do recebimento de diagnóstico de rede é recebida.
otRoutePreference typedef
Define valores válidos para mPreference em otExternalRouteConfig e otBorderRouterConfig.
otServerConfig typedef
Representa uma configuração do servidor.
otServiceConfig typedef
Representa uma configuração de serviço.
otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16) typedef
void(*
O tipo de ponteiro define o callback para notificar o resultado de uma solicitação otThreadLocateAnycastDestination().
otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext) typedef
void(*
O ponteiro é chamado sempre que uma mensagem de solicitação de descoberta de MLE é recebida.
otThreadDiscoveryRequestInfo typedef
Representa os dados da solicitação de descoberta de linhas de execução.
otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext) typedef
void(*
O ponteiro é chamado sempre que uma mensagem de resposta do pai de MLE é recebida.
otThreadParentResponseInfo typedef
Representa os dados da resposta pai de MLE.

remotas

otConvertDurationInSecondsToString(uint32_t aDuration, char *aBuffer, uint16_t aSize)
void
Converte uma duração de uint32_t (em segundos) em uma string legível.
otNetDataContainsOmrPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
Verifica se determinado prefixo pode atuar como um prefixo OMR válido e se os dados de rede do líder contêm esse prefixo.
otNetDataGet(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
Fornecer uma cópia completa ou estável dos dados de rede de Thread da partição.
otNetDataGetCommissioningDataset(otInstance *aInstance, otCommissioningDataset *aDataset)
void
Recebe o conjunto de dados de comissionamento dos dados de rede da partição.
otNetDataGetLength(otInstance *aInstance)
uint8_t
Extrai o comprimento atual (número de bytes) dos dados da rede de encadeamento da partição.
otNetDataGetMaxLength(otInstance *aInstance)
uint8_t
Recebe o comprimento máximo observado dos dados da rede Thread desde a inicialização da pilha OT ou desde a última chamada para otNetDataResetMaxLength().
otNetDataGetNextLowpanContextInfo(otInstance *aInstance, otNetworkDataIterator *aIterator, otLowpanContextInfo *aContextInfo)
Acessar as próximas informações do ID de contexto 6LoWPAN nos dados de rede da partição.
otNetDataGetNextOnMeshPrefix(otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
Consiga o próximo prefixo de malha nos dados de rede da partição.
otNetDataGetNextRoute(otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)
Acessa a próxima rota externa nos dados de rede da partição.
otNetDataGetNextService(otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig)
Acessar o próximo serviço nos dados de rede da partição.
otNetDataGetStableVersion(otInstance *aInstance)
uint8_t
Consiga a versão estável dos dados de rede.
otNetDataGetVersion(otInstance *aInstance)
uint8_t
Consiga a versão dos dados de rede.
otNetDataIsDnsSrpServiceAdded(otInstance *aInstance)
bool
Indica se a entrada "Serviço DNS/SRP" está ou não adicionada aos dados de rede do Thread.
otNetDataIsPrefixAdded(otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
Indica se uma entrada de prefixo publicada no momento (em malha ou rota externa) foi adicionada aos dados da Thread Network Data.
otNetDataPublishDnsSrpServiceAnycast(otInstance *aInstance, uint8_t aSequenceNUmber)
void
Solicita que o "Endereço Anycast do serviço DNS/SRP" seja publicado nos dados da rede do Thread.
otNetDataPublishDnsSrpServiceUnicast(otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort)
void
Solicita que o "Endereço Unicast do serviço DNS/SRP" seja publicado nos dados da rede do Thread.
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(otInstance *aInstance, uint16_t aPort)
void
Solicita que o "Endereço Unicast do serviço DNS/SRP" seja publicado nos dados da rede do Thread.
otNetDataPublishExternalRoute(otInstance *aInstance, const otExternalRouteConfig *aConfig)
Solicita um prefixo de rota externa a ser publicado nos dados de rede do Thread.
otNetDataPublishOnMeshPrefix(otInstance *aInstance, const otBorderRouterConfig *aConfig)
Solicita um prefixo on-malha para ser publicado nos dados da rede da linha de execução.
otNetDataReplacePublishedExternalRoute(otInstance *aInstance, const otIp6Prefix *aPrefix, const otExternalRouteConfig *aConfig)
Substitui uma rota externa publicada anteriormente nos dados de rede de Thread.
otNetDataResetMaxLength(otInstance *aInstance)
void
Redefinir o comprimento máximo rastreado dos dados de rede Thread.
otNetDataSetDnsSrpServicePublisherCallback(otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext)
void
Define um callback para notificar quando um "Serviço DNS/SRP" publicado é realmente adicionado ou removido dos dados da rede Thread.
otNetDataSetPrefixPublisherCallback(otInstance *aInstance, otNetDataPrefixPublisherCallback aCallback, void *aContext)
void
Define um callback para notificar quando uma entrada de prefixo publicada é realmente adicionada ou removida dos dados da rede do Thread.
otNetDataSteeringDataCheckJoiner(otInstance *aInstance, const otExtAddress *aEui64)
Verifique se os dados de direcionamento incluem um Combinador.
otNetDataSteeringDataCheckJoinerWithDiscerner(otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner)
Verifique se os dados de direcionamento incluem um Combinador com um determinado valor de discernimento.
otNetDataUnpublishDnsSrpService(otInstance *aInstance)
void
Cancela a publicação de qualquer entrada de 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 rota externa ou em malha publicado anteriormente.
otThreadBecomeChild(otInstance *aInstance)
Tentar anexar novamente como filho.
otThreadBecomeDetached(otInstance *aInstance)
Remover da rede Thread.
otThreadDetachGracefully(otInstance *aInstance, otDetachGracefullyCallback aCallback, void *aContext)
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)
Inicia uma verificação de descoberta de encadeamento.
otThreadGetChildTimeout(otInstance *aInstance)
uint32_t
Recebe o tempo limite de filho da linha de execução (em segundos) usado ao operar no papel filho.
otThreadGetDeviceRole(otInstance *aInstance)
Consiga a função do dispositivo.
otThreadGetDomainName(otInstance *aInstance)
const char *
Recebe o nome de domínio do Thread.
otThreadGetExtendedPanId(otInstance *aInstance)
const otExtendedPanId *
Recebe o ID PAN IEEE 802.15.4.
otThreadGetFixedDuaInterfaceIdentifier(otInstance *aInstance)
Recebe o identificador de interface especificado manualmente para o endereço Unicast do domínio do Thread.
otThreadGetIp6Counters(otInstance *aInstance)
const otIpCounters *
Acessa os contadores IPv6.
otThreadGetKeySequenceCounter(otInstance *aInstance)
uint32_t
Extrai o thwebkitSequenceCounter.
otThreadGetKeySwitchGuardTime(otInstance *aInstance)
uint32_t
Recebe o th IoTSwitchGuardTime (em horas).
otThreadGetLeaderData(otInstance *aInstance, otLeaderData *aLeaderData)
Acessa os dados do líder da linha de execução.
otThreadGetLeaderRloc(otInstance *aInstance, otIp6Address *aLeaderRloc)
Retorna um ponteiro para o RLOC do líder.
otThreadGetLeaderRouterId(otInstance *aInstance)
uint8_t
Consiga o ID do roteador do líder.
otThreadGetLeaderWeight(otInstance *aInstance)
uint8_t
Conquiste o peso do líder.
otThreadGetLinkLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
const otIp6Address *
Recebe o endereço multicast de todos os nós de Thread Link-Local.
otThreadGetLinkLocalIp6Address(otInstance *aInstance)
const otIp6Address *
Recebe o endereço IPv6 link-local do Thread.
otThreadGetLinkMode(otInstance *aInstance)
Acessa a configuração do modo de link do MLE.
otThreadGetMaxTimeInQueue(otInstance *aInstance)
uint32_t
Recebe o tempo máximo na fila de mensagens na fila TX.
otThreadGetMeshLocalEid(otInstance *aInstance)
const otIp6Address *
Recebe o endereço EID local da malha.
otThreadGetMeshLocalPrefix(otInstance *aInstance)
Retorna um ponteiro para o prefixo local da rede mesh.
otThreadGetMleCounters(otInstance *aInstance)
const otMleCounters *
Recebe os contadores do Thread MLE.
otThreadGetNetworkKey(otInstance *aInstance, otNetworkKey *aNetworkKey)
void
Consiga a chave de rede Thread.
otThreadGetNetworkKeyRef(otInstance *aInstance)
Consiga o otNetworkKeyRef para a chave de rede Thread.
otThreadGetNetworkName(otInstance *aInstance)
const char *
Consiga o nome da rede Thread.
otThreadGetNextDiagnosticTlv(const otMessage *aMessage, otNetworkDiagIterator *aIterator, otNetworkDiagTlv *aNetworkDiagTlv)
Recebe o próximo TLV do diagnóstico de rede na mensagem.
otThreadGetNextNeighborInfo(otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo)
Recebe as próximas informações vizinhas.
otThreadGetParentAverageRssi(otInstance *aInstance, int8_t *aParentRssi)
A função recupera o RSSI médio do Thread Parent.
otThreadGetParentInfo(otInstance *aInstance, otRouterInfo *aParentInfo)
A função recupera informações de diagnóstico para um roteador Thread como pai.
otThreadGetParentLastRssi(otInstance *aInstance, int8_t *aLastRssi)
A função recupera o RSSI do último pacote do Thread pai.
otThreadGetPartitionId(otInstance *aInstance)
uint32_t
Recebe o ID da partição.
otThreadGetRealmLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
const otIp6Address *
Recebe o endereço multicast de todos os nós de Thread Realm-Local.
otThreadGetRloc(otInstance *aInstance)
const otIp6Address *
Recebe o endereço Thread Routing Locator (RLOC).
otThreadGetRloc16(otInstance *aInstance)
uint16_t
Acesse o RLOC16.
otThreadGetServiceAloc(otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc)
Recupera o ALOC do serviço para o ID de serviço fornecido.
otThreadGetTimeInQueueHistogram(otInstance *aInstance, uint16_t *aNumBins, uint32_t *aBinInterval)
const uint32_t *
Recebe o histograma de tempo na fila das mensagens na fila do TX.
otThreadGetVendorModel(otInstance *aInstance)
const char *
Acessa a string do modelo do fornecedor.
otThreadGetVendorName(otInstance *aInstance)
const char *
Acessa a string do nome do fornecedor.
otThreadGetVendorSwVersion(otInstance *aInstance)
const char *
Acessa a string da versão do sw do fornecedor.
otThreadGetVersion(void)
uint16_t
Recebe a versão do protocolo Thread.
otThreadIsAnycastLocateInProgress(otInstance *aInstance)
bool
Indica se uma solicitação de localização anycast está em andamento.
otThreadIsDiscoverInProgress(otInstance *aInstance)
bool
Determina se uma descoberta de linha de execução MLE está em andamento.
otThreadIsSingleton(otInstance *aInstance)
bool
Indica se um nó é o único roteador na rede.
otThreadLocateAnycastDestination(otInstance *aInstance, const otIp6Address *aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext)
Solicita a localização do destino mais próximo de um determinado endereço anycast.
otThreadRegisterParentResponseCallback(otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext)
void
Registra um callback para receber dados de resposta pai de MLE.
otThreadResetIp6Counters(otInstance *aInstance)
void
Redefine os contadores IPv6.
otThreadResetMleCounters(otInstance *aInstance)
void
Redefine os contadores do Thread MLE.
otThreadResetTimeInQueueStat(otInstance *aInstance)
void
Redefine as estatísticas de tempo na fila da fila TX.
otThreadSearchForBetterParent(otInstance *aInstance)
Inicia o processo para a criança procurar um pai melhor sem perder o vínculo com o pai atual.
otThreadSendAddressNotification(otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid)
void
Envia uma mensagem de notificação de endereço proativa (ADDR_NTF.ntf).
otThreadSendDiagnosticGet(otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext)
Enviar uma solicitação Get de diagnóstico de rede.
otThreadSendDiagnosticReset(otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount)
Enviar uma solicitação de redefinição do diagnóstico de rede.
otThreadSendProactiveBackboneNotification(otInstance *aInstance, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction)
Envia uma mensagem de notificação proativa de backbone (PRO_BB.ntf) no link do backbone.
otThreadSetChildTimeout(otInstance *aInstance, uint32_t aTimeout)
void
Define o tempo limite do filho da linha de execução (em segundos) usado ao operar no papel filho.
otThreadSetDiscoveryRequestCallback(otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext)
void
Define um callback para receber dados da solicitação de descoberta de MLE.
otThreadSetDomainName(otInstance *aInstance, const char *aDomainName)
Define o nome de domínio do Thread.
otThreadSetEnabled(otInstance *aInstance, bool aEnabled)
Inicia a operação do protocolo Thread.
otThreadSetExtendedPanId(otInstance *aInstance, const otExtendedPanId *aExtendedPanId)
Define o ID PAN estendido do 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 do Thread.
otThreadSetJoinerAdvertisement(otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength)
Define a divulgação do Thread Joiner ao descobrir a rede Thread.
otThreadSetKeySequenceCounter(otInstance *aInstance, uint32_t aKeySequenceCounter)
void
Define o thDataSequenceCounter.
otThreadSetKeySwitchGuardTime(otInstance *aInstance, uint32_t aKeySwitchGuardTime)
void
Define o thwebkitSwitchGuardTime (em horas).
otThreadSetLinkMode(otInstance *aInstance, otLinkModeConfig aConfig)
Defina a configuração do modo de link do MLE.
otThreadSetMeshLocalPrefix(otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix)
Define o prefixo local da rede mesh.
otThreadSetNetworkKey(otInstance *aInstance, const otNetworkKey *aKey)
Define a chave de rede Thread.
otThreadSetNetworkKeyRef(otInstance *aInstance, otNetworkKeyRef aKeyRef)
Defina a chave da rede Thread como otNetworkKeyRef.
otThreadSetNetworkName(otInstance *aInstance, const char *aNetworkName)
Define o nome da rede Thread.
otThreadSetVendorModel(otInstance *aInstance, const char *aVendorModel)
Defina a string do modelo do fornecedor.
otThreadSetVendorName(otInstance *aInstance, const char *aVendorName)
Defina a string do nome do fornecedor.
otThreadSetVendorSwVersion(otInstance *aInstance, const char *aVendorSwVersion)
Defina a string da versão do software do fornecedor.

Estruturas

otBorderRouterConfig

Representa uma configuração do roteador de borda.

otExternalRouteConfig

Representa uma configuração de rota externa.

otIpCounters

Representa os contadores no nível do IP.

otLeaderData

Representa os dados do líder da linha de execução.

otLinkModeConfig

Representa uma configuração do modo de link MLE.

otLowpanContextInfo

Representa as informações do ID de contexto 6LoWPAN associadas a um prefixo nos dados de rede.

otMleCounters

Representa os contadores do Thread MLE.

otNeighborInfo

Mantém as informações de diagnóstico de um nó Thread vizinho.

otNetworkDiagChildEntry

Representa uma entrada de tabela filha de diagnóstico de rede.

otNetworkDiagConnectivity

Representa um valor de conectividade de diagnóstico de rede.

otNetworkDiagMacCounters

Representa um valor de Contadores de Mac de diagnóstico de rede.

otNetworkDiagMleCounters

Representa um valor dos contadores MLE do Diagnóstico de Rede.

otNetworkDiagRoute

Representa um valor de TLV da rota de diagnóstico de rede.

otNetworkDiagRouteData

Representa os dados de uma rota de diagnóstico de rede.

otNetworkDiagTlv

Representa um TLV de diagnóstico de rede.

otRouterInfo

Mantém as informações de diagnóstico de um roteador Thread.

otServerConfig

Representa uma configuração do servidor.

otServiceConfig

Representa uma configuração de serviço.

otThreadDiscoveryRequestInfo

Representa os dados da solicitação de descoberta de linhas de execução.

otThreadParentResponseInfo

Representa os dados da resposta pai de MLE.

Enumerações

enumeração anônima

 anonymous enum
Propriedades
OT_NETWORK_DIAGNOSTIC_TLV_ANSWER

Responda TLV.

OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL

TLV no nível da bateria.

OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES

TLV das páginas do canal.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD

TLV filho.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_IP6_ADDR_LIST

TLV da lista de endereços IPv6 filha.

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 MAC.

OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST

TLV da lista de endereços IPv6.

OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA

TLV de dados líder.

OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS

TLV dos contadores MAC.

OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT

Tempo limite máximo do filho TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MLE_COUNTERS

O MLE conta o TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MODE

Modo TLV.

OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA

TLV de dados de rede.

OT_NETWORK_DIAGNOSTIC_TLV_QUERY_ID

ID da consulta TLV.

OT_NETWORK_DIAGNOSTIC_TLV_ROUTE

TLV do Route64.

OT_NETWORK_DIAGNOSTIC_TLV_ROUTER_NEIGHBOR

TLV do vizinho do roteador.

OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS

TLV do endereço 16.

OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE

Tensão de alimentação TLV.

OT_NETWORK_DIAGNOSTIC_TLV_THREAD_STACK_VERSION

Versão Thread Stack TLV.

OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT

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

OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST

Tipo de lista TLV.

OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_MODEL

Modelo de fornecedor TLV.

OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_NAME

Nome do fornecedor TLV.

OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_SW_VERSION

Versão SW do fornecedor TLV.

OT_NETWORK_DIAGNOSTIC_TLV_VERSION

Versão TLV.

otDeviceRole

 otDeviceRole

Representa um papel de dispositivo Thread.

Propriedades
OT_DEVICE_ROLE_CHILD

O papel Thread Child.

OT_DEVICE_ROLE_DETACHED

Não participa de uma partição/rede Thread no momento.

OT_DEVICE_ROLE_DISABLED

A pilha de linhas de execução está desativada.

OT_DEVICE_ROLE_LEADER

O papel de líder da conversa.

OT_DEVICE_ROLE_ROUTER

O papel Roteador de Thread.

otNetDataPublisherEvent

 otNetDataPublisherEvent

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 foi 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 baixa.

OT_ROUTE_PREFERENCE_MED

Preferência de trajeto médio.

Typedefs

otBorderRouterConfig

struct otBorderRouterConfig otBorderRouterConfig

Representa uma configuração do roteador de borda.

otDetachGracefullyCallback

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 o contexto específico do aplicativo.

otExternalRouteConfig

struct otExternalRouteConfig otExternalRouteConfig

Representa uma configuração de rota externa.

otIpCounters

struct otIpCounters otIpCounters

Representa os contadores no nível do IP.

otLeaderData

struct otLeaderData otLeaderData

Representa os dados do líder da linha de execução.

otLinkModeConfig

struct otLinkModeConfig otLinkModeConfig

Representa uma configuração do modo de link MLE.

otLowpanContextInfo

struct otLowpanContextInfo otLowpanContextInfo

Representa as informações do ID de contexto 6LoWPAN associadas a um prefixo nos dados de rede.

otMleCounters

struct otMleCounters otMleCounters

Representa os contadores do Thread MLE.

otNeighborInfoIterator

int16_t otNeighborInfoIterator

Usado para iterar na tabela vizinha.

otNetDataDnsSrpServicePublisherCallback

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

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

Na remoção, o callback é invocado independentemente de a entrada ser removida por Publisher (por exemplo, quando há muitas entradas semelhantes já presentes nos dados de 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 o contexto específico do aplicativo.

otNetDataPrefixPublisherCallback

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

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

Na remoção, o callback é invocado independentemente de a entrada ser removida por Publisher (por exemplo, quando há muitas entradas semelhantes já presentes nos dados de 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 do prefixo.
[in] aContext
Um ponteiro para o contexto específico do aplicativo.

otNetDataPublisherEvent

enum otNetDataPublisherEvent otNetDataPublisherEvent

Representa os eventos informados pelos callbacks do editor.

otNetworkDataIterator

uint32_t otNetworkDataIterator

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

otNetworkDiagChildEntry

struct otNetworkDiagChildEntry otNetworkDiagChildEntry

Representa uma entrada de tabela filha de diagnóstico de rede.

otNetworkDiagConnectivity

struct otNetworkDiagConnectivity otNetworkDiagConnectivity

Representa um valor de conectividade de diagnóstico de rede.

otNetworkDiagIterator

uint16_t otNetworkDiagIterator

Usado para iterar o TLV do diagnóstico de rede.

otNetworkDiagMacCounters

struct otNetworkDiagMacCounters otNetworkDiagMacCounters

Representa um valor de Contadores de Mac de diagnóstico de rede.

Consulte a RFC 2863 (link em inglês) para definições de campos de membro.

otNetworkDiagMleCounters

struct otNetworkDiagMleCounters otNetworkDiagMleCounters

Representa um valor dos contadores MLE do Diagnóstico de Rede.

otNetworkDiagRoute

struct otNetworkDiagRoute otNetworkDiagRoute

Representa um valor de TLV da rota de diagnóstico de rede.

otNetworkDiagRouteData

struct otNetworkDiagRouteData otNetworkDiagRouteData

Representa os dados de uma rota de diagnóstico de rede.

otNetworkDiagTlv

struct otNetworkDiagTlv otNetworkDiagTlv

Representa um TLV de diagnóstico de rede.

otReceiveDiagnosticGetCallback

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

O ponteiro é chamado quando a resposta do recebimento de diagnóstico de rede é recebida.

Detalhes
Parâmetros
[in] aError
O erro quando não é possível receber a resposta.
[in] aMessage
Um ponteiro para o buffer de mensagem que contém o payload de resposta do recebimento de 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 o contexto específico do aplicativo.

otRoutePreference

enum otRoutePreference otRoutePreference

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

otServerConfig

struct otServerConfig otServerConfig

Representa uma configuração do servidor.

otServiceConfig

struct otServiceConfig otServiceConfig

Representa uma configuração de serviço.

otThreadAnycastLocatorCallback

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

O tipo de ponteiro 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
O erro ao processar a solicitação. OT_ERROR_NONE indica sucesso. OT_ERROR_RESPONSE_TIMEOUT indica que não foi possível encontrar um destino. OT_ERROR_ABORT indica que a solicitação foi cancelada.
[in] aMeshLocalAddress
Um ponteiro para o EID da malha local do destino mais próximo do endereço anycast quando aError for OT_ERROR_NONE, caso contrário, NULL.
[in] aRloc16
O RLOC16 do destino, se encontrado. Caso contrário, o RLOC16 é inválido (0xfffe).

otThreadDiscoveryRequestCallback

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

O ponteiro é 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ção da Solicitação de descoberta.
[in] aContext
Um ponteiro para o contexto específico do aplicativo de callback.

otThreadDiscoveryRequestInfo

struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo

Representa os dados da solicitação de descoberta de linhas de execução.

otThreadParentResponseCallback

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

O ponteiro é chamado sempre que uma mensagem de resposta do pai de MLE é recebida.

Isso é usado em otThreadRegisterParentResponseCallback().

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 o contexto específico do cliente de callback.

otThreadParentResponseInfo

struct otThreadParentResponseInfo otThreadParentResponseInfo

Representa os dados da resposta pai de MLE.

remotas

otConvertDurationInSecondsToString

void otConvertDurationInSecondsToString(
  uint32_t aDuration,
  char *aBuffer,
  uint16_t aSize
)

Converte uma duração de uint32_t (em segundos) em uma string legível.

A ativação do OPENTHREAD_CONFIG_UPTIME_ENABLE é necessária.

A string segue o formato "::" para horas, minutos, segundos (se a duração for menor que um dia) ou "

d.::" (se for mais de um dia).

Se a string resultante não couber em aBuffer (dentro dos caracteres aSize), ela será truncada, mas a gerada sempre será terminada com valor nulo.

Destina-se ao uso com mAge ou mConnectionTime em estruturas otNeighborInfo ou otChildInfo.

Detalhes
Parâmetros
[in] aDuration
Um intervalo de duração em segundos.
[out] aBuffer
Um ponteiro para uma matriz de caracteres que vai gerar a string.
[in] aSize
O tamanho de aBuffer (em bytes). Recomendamos usar OT_DURATION_STRING_SIZE.

otNetDataContainsOmrPrefix

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

Verifica se determinado prefixo pode atuar como um prefixo OMR válido e se os dados de rede do líder 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 se os dados de rede do líder contêm o prefixo OMR aPrefix.

otNetDataGet

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

Fornecer uma cópia completa ou estável dos dados de rede de Thread da partição.

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, o número de bytes copiados.
Valores de retorno
OT_ERROR_NONE
Os dados da rede Thread foram copiados para aData e atualizados para aDataLength.
OT_ERROR_NO_BUFS
Não há espaço suficiente em aData para copiar completamente os dados da rede de Thread.

otNetDataGetCommissioningDataset

void otNetDataGetCommissioningDataset(
  otInstance *aInstance,
  otCommissioningDataset *aDataset
)

Recebe o conjunto de dados de comissionamento dos dados de rede da partição.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para a instância do OpenThread.
[out] aDataset
Um ponteiro para um otCommissioningDataset a ser preenchido.

otNetDataGetLength

uint8_t otNetDataGetLength(
  otInstance *aInstance
)

Extrai o comprimento atual (número de bytes) dos dados da rede de encadeamento da partição.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
O tamanho dos dados de rede.

otNetDataGetMaxLength

uint8_t otNetDataGetMaxLength(
  otInstance *aInstance
)

Recebe o comprimento máximo observado dos dados da rede Thread desde a inicialização da pilha OT ou desde a última chamada para otNetDataResetMaxLength().

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
O comprimento máximo dos dados de rede (marca-d'água alta para comprimento de dados de rede).

otNetDataGetNextLowpanContextInfo

otError otNetDataGetNextLowpanContextInfo(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otLowpanContextInfo *aContextInfo
)

Acessar as próximas informações do ID de contexto 6LoWPAN 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 iterador de dados de rede. Para conseguir a primeira entrada de serviço, defina como OT_NETWORK_DATA_ITERATOR_INIT.
[out] aContextInfo
Um ponteiro para onde as informações do ID de contexto 6LoWPAN recuperadas serão colocadas.
Valores de retorno
OT_ERROR_NONE
As próximas informações do ID de contexto 6LoWPAN foram encontradas.
OT_ERROR_NOT_FOUND
Não há informações de contexto 6LoWPAN subsequentes nos dados de rede da partição.

otNetDataGetNextOnMeshPrefix

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

Consiga o próximo prefixo de malha 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 na malha, defina como OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Um ponteiro para o local onde as informações do prefixo na malha serão colocadas.
Valores de retorno
OT_ERROR_NONE
O próximo prefixo "On Mesh" foi encontrado.
OT_ERROR_NOT_FOUND
Nenhum prefixo "On Mesh" subsequente nos dados da rede de Thread.

otNetDataGetNextRoute

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

Acessa 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 conseguir a primeira entrada de rota externa, defina como OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Um ponteiro para onde as informações de rota externa serão colocadas.
Valores de retorno
OT_ERROR_NONE
A próxima rota externa foi encontrada.
OT_ERROR_NOT_FOUND
Nenhuma entrada de rota externa subsequente existe nos dados da rede do Thread.

otNetDataGetNextService

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

Acessar 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 o local em que 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 há serviços subsequentes nos dados de rede da partição.

otNetDataGetStableVersion

uint8_t otNetDataGetStableVersion(
  otInstance *aInstance
)

Consiga a versão estável dos dados de rede.

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

otNetDataGetVersion

uint8_t otNetDataGetVersion(
  otInstance *aInstance
)

Consiga a versão dos dados de rede.

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

otNetDataIsDnsSrpServiceAdded

bool otNetDataIsDnsSrpServiceAdded(
  otInstance *aInstance
)

Indica se a entrada "Serviço DNS/SRP" está ou não adicionada aos dados de rede do Thread.

É necessário ativar o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

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

otNetDataIsPrefixAdded

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

Indica se uma entrada de prefixo publicada no momento (em malha ou rota externa) foi adicionada aos dados da Thread Network Data.

É necessário ativar o recurso OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

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 de rede de Thread.
FALSE
A entrada não foi adicionada aos dados da rede Thread ou não há entrada para publicar.

otNetDataPublishDnsSrpServiceAnycast

void otNetDataPublishDnsSrpServiceAnycast(
  otInstance *aInstance,
  uint8_t aSequenceNUmber
)

Solicita que o "Endereço Anycast do serviço DNS/SRP" seja publicado nos dados da rede do Thread.

É necessário ativar o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

Uma chamada para essa função vai remover e substituir qualquer entrada "Serviço DNS/SRP" anterior que estivesse sendo publicada (de chamadas anteriores 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
)

Solicita que o "Endereço Unicast do serviço DNS/SRP" seja publicado nos dados da rede do Thread.

É necessário ativar o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

Uma chamada para essa função vai remover e substituir qualquer entrada "Serviço DNS/SRP" anterior que estivesse sendo publicada (de chamadas anteriores para qualquer uma das funções otNetDataPublishDnsSrpService{Type}()).

Publica o "Endereço Unicast do 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 NULL).
[in] aPort
O número da porta do servidor SRP a ser publicado.

otNetDataPublishDnsSrpServiceUnicastMeshLocalEid

void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(
  otInstance *aInstance,
  uint16_t aPort
)

Solicita que o "Endereço Unicast do serviço DNS/SRP" seja publicado nos dados da rede do Thread.

É necessário ativar o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

Uma chamada para essa função vai remover e substituir qualquer entrada "Serviço DNS/SRP" anterior que estivesse sendo publicada (de chamadas anteriores para qualquer uma das funções otNetDataPublishDnsSrpService{Type}()).

Ao contrário de otNetDataPublishDnsSrpServiceUnicast(), que exige o fornecimento do endereço publicado e inclui as informações nos dados de TLV do serviço, essa função usa o EID da malha 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.

otNetDataPublishExternalRoute

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

Solicita um prefixo de rota externa a ser publicado nos dados de rede do Thread.

É necessário ativar o recurso OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

Somente 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 com o mesmo prefixo. Particularmente, se a nova chamada só mudar as flags (por exemplo, o nível de preferência) e o prefixo já estiver adicionado aos dados da rede, a mudança nas flags vai 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 de rede depois de determinar que há outros nós que estão publicando o mesmo prefixo com a mesma preferência ou superior.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aConfig
A configuração de 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ções 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 na malha e a rota externa) determinada pela configuração OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES.

otNetDataPublishOnMeshPrefix

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

Solicita um prefixo on-malha para ser publicado nos dados da rede da linha de execução.

É necessário ativar o recurso OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

Somente 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 com o mesmo prefixo. Particularmente, se a nova chamada só mudar as flags (por exemplo, o nível de preferência) e o prefixo já estiver adicionado aos dados da rede, a mudança nas flags vai 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 de rede depois de determinar que há outros nós que estão publicando o mesmo prefixo com a mesma preferência ou superior.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aConfig
A configuração do prefixo na malha a ser publicada (NÃO PODE ser NULL).
Valores de retorno
OT_ERROR_NONE
O prefixo na malha foi publicado.
OT_ERROR_INVALID_ARGS
O aConfig não é válido (prefixo inválido, combinações de sinalizações 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 na malha e a rota externa) determinada pela configuração OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES.

otNetDataReplacePublishedExternalRoute

otError otNetDataReplacePublishedExternalRoute(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix,
  const otExternalRouteConfig *aConfig
)

Substitui uma rota externa publicada anteriormente nos dados de rede de Thread.

É necessário ativar o recurso OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

Se não houver uma rota externa publicada anteriormente correspondente a aPrefix, essa função vai se comportar de maneira semelhante a otNetDataPublishExternalRoute(), ou seja, vai iniciar o processo de publicação de aConfig como uma rota externa nos dados da rede do Thread.

Se houver uma entrada de trajeto publicada anteriormente correspondente a aPrefix, ela será substituída pelo novo prefixo de aConfig.

  • Se o aPrefix já tiver sido adicionado aos dados da rede, a mudança do novo prefixo em aConfig será refletida imediatamente nos dados da rede. Isso garante que as entradas de rota nos dados de rede não sejam removidas abruptamente e que a transição de aPrefix para o novo prefixo seja tranquila.
  • Se o aPrefix publicado não tiver sido adicionado aos dados de rede, ele será substituído pelo novo prefixo aConfig, mas não será adicionado imediatamente. Em vez disso, ele inicia o processo de publicação nos dados de rede, monitorando os dados da rede para determinar quando/se adicionar o prefixo, dependendo do número de prefixos semelhantes presentes nos dados de rede.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aPrefix
O prefixo de rota externa publicado anteriormente para substituir.
[in] aConfig
A configuração de rota externa a ser publicada.
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ções 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 na malha e a rota externa) determinada pela configuração OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES.

otNetDataResetMaxLength

void otNetDataResetMaxLength(
  otInstance *aInstance
)

Redefinir o comprimento máximo rastreado dos dados de rede Thread.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Consulte também:
otNetDataGetMaxLength

otNetDataSetDnsSrpServicePublisherCallback

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

Define um callback para notificar quando um "Serviço DNS/SRP" publicado é realmente adicionado ou removido dos dados da rede Thread.

Uma chamada subsequente para essa função substitui todas as funções de callback definidas anteriormente.

É necessário ativar o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

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 o contexto específico do aplicativo (usado quando aCallback é invocado).

otNetDataSetPrefixPublisherCallback

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

Define um callback para notificar quando uma entrada de prefixo publicada é realmente adicionada ou removida dos dados da rede do Thread.

Uma chamada subsequente para essa função substitui todas as funções de callback definidas anteriormente.

É necessário ativar o recurso OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

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 o contexto específico do aplicativo (usado quando aCallback é invocado).

otNetDataSteeringDataCheckJoiner

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

Verifique se os dados de direcionamento incluem um Combinador.

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 direção.
OT_ERROR_INVALID_STATE
Não há dados de direcionamento presentes.
OT_ERROR_NOT_FOUND
aEui64 não está incluído nos dados de direção.

otNetDataSteeringDataCheckJoinerWithDiscerner

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

Verifique se os dados de direcionamento incluem um Combinador com um determinado valor de discernimento.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aDiscerner
Um ponteiro para o separador do Combinador.
Valores de retorno
OT_ERROR_NONE
aDiscerner está incluído nos dados de direção.
OT_ERROR_INVALID_STATE
Não há dados de direcionamento presentes.
OT_ERROR_NOT_FOUND
aDiscerner não está incluído nos dados de direção.

otNetDataUnpublishDnsSrpService

void otNetDataUnpublishDnsSrpService(
  otInstance *aInstance
)

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

É preciso ativar OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

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

otNetDataUnpublishPrefix

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

Cancela a publicação de um prefixo de rota externa ou em malha publicado anteriormente.

É preciso ativar OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aPrefix
O prefixo para cancelar publicação (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.

otThreadBecomeChild

otError otThreadBecomeChild(
  otInstance *aInstance
)

Tentar anexar novamente como filho.

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

otThreadBecomeDetached

otError otThreadBecomeDetached(
  otInstance *aInstance
)

Remover da rede Thread.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Valores de retorno
OT_ERROR_NONE
Removido da rede Thread.
OT_ERROR_INVALID_STATE
A linha de execução está desativada.

otThreadDetachGracefully

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

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

Ele envia uma liberação de endereço se for um roteador ou define o tempo limite do 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 que é chamada após a conclusão da remoção.
[in] aContext
Um ponteiro para o contexto específico do aplicativo de callback.
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 do 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
)

Inicia uma verificação de descoberta de encadeamento.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aScanChannels
Um vetor de bits que indica quais canais verificar (por exemplo, OT_CHANNEL_11_MASK).
[in] aPanId
O filtro de ID do PAN (definido como "Broadcast PAN" para desativar o filtro).
[in] aJoiner
Valor da sinalização do Combinador no TLV da solicitação de descoberta.
[in] aEnableEui64Filtering
TRUE para filtrar respostas com EUI-64; caso contrário, FALSE.
[in] aCallback
Um ponteiro para uma função chamada ao receber uma resposta de descoberta MLE ou verificação concluída.
[in] aCallbackContext
Um ponteiro para o contexto específico do aplicativo.
Valores de retorno
OT_ERROR_NONE
Uma verificação de descoberta de linhas de execução foi iniciada.
OT_ERROR_INVALID_STATE
A interface IPv6 não está ativada (o 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 linhas de execução já está em andamento.

otThreadGetChildTimeout

uint32_t otThreadGetChildTimeout(
  otInstance *aInstance
)

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

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

otThreadGetDeviceRole

otDeviceRole otThreadGetDeviceRole(
  otInstance *aInstance
)

Consiga a função 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 linhas de execução está desativada.
OT_DEVICE_ROLE_DETACHED
No momento, o dispositivo não está participando de uma partição/rede Thread.
OT_DEVICE_ROLE_CHILD
O dispositivo está operando no momento como um Thread Child.
OT_DEVICE_ROLE_ROUTER
O dispositivo está operando como um roteador Thread.
OT_DEVICE_ROLE_LEADER
O dispositivo está operando como 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 da linha de execução.
Consulte também:
otThreadSetDomainName

otThreadGetExtendedPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

Recebe o ID PAN 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 IEEE 802.15.4.
Consulte também:
otThreadSetExtendedPanId

otThreadGetFixedDuaInterfaceIdentifier

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
  otInstance *aInstance
)

Recebe o identificador de interface especificado manualmente para o endereço Unicast do domínio do 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 foi definido.
Consulte também:
otThreadSetFixedDuaInterfaceIdentifier

otThreadGetIp6Counters

const otIpCounters * otThreadGetIp6Counters(
  otInstance *aInstance
)

Acessa os contadores IPv6.

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

otThreadGetKeySequenceCounter

uint32_t otThreadGetKeySequenceCounter(
  otInstance *aInstance
)

Extrai o thwebkitSequenceCounter.

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

otThreadGetKeySwitchGuardTime

uint32_t otThreadGetKeySwitchGuardTime(
  otInstance *aInstance
)

Recebe o th IoTSwitchGuardTime (em horas).

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

otThreadGetLeaderData

otError otThreadGetLeaderData(
  otInstance *aInstance,
  otLeaderData *aLeaderData
)

Acessa 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 do líder são colocados.
Valores de retorno
OT_ERROR_NONE
Os dados do líder foram recuperados.
OT_ERROR_DETACHED
Não anexado no momento.

otThreadGetLeaderRloc

otError otThreadGetLeaderRloc(
  otInstance *aInstance,
  otIp6Address *aLeaderRloc
)

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 indicador para o RLOC do líder.
Valores de retorno
OT_ERROR_NONE
O RLOC do líder foi gravado para aLeaderRloc.
OT_ERROR_INVALID_ARGS
aLeaderRloc estava NULL.
OT_ERROR_DETACHED
No momento, não está anexado a uma partição de linha de execução.

otThreadGetLeaderRouterId

uint8_t otThreadGetLeaderRouterId(
  otInstance *aInstance
)

Consiga 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
)

Conquiste 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
)

Recebe o endereço multicast de todos os nós de Thread Link-Local.

O endereço é um endereço multicast baseado em prefixo unicast link-local [RFC 3306], com:

  • flgs definidos como 3 (P = 1 e T = 1)
  • Policial definido como 2
  • plen definido como 64
  • definido como o prefixo local da rede mesh
  • O ID do grupo foi definido como 1

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Um ponteiro para o endereço multicast de todos os nós de Thread Link-Local.

otThreadGetLinkLocalIp6Address

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

Recebe o endereço IPv6 link-local do Thread.

O endereço local do link do 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 o endereço IPv6 link-local da linha de execução.

otThreadGetLinkMode

otLinkModeConfig otThreadGetLinkMode(
  otInstance *aInstance
)

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

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

otThreadGetMaxTimeInQueue

uint32_t otThreadGetMaxTimeInQueue(
  otInstance *aInstance
)

Recebe o tempo máximo na fila de mensagens na fila TX.

Exige OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE.

O tempo na fila é rastreado apenas para transmissões diretas e é medido como a duração entre o momento em que uma mensagem é adicionada à fila de transmissão e o momento em que ela é passada para a camada MAC para transmissão ou descartada.

As estatísticas coletadas podem ser redefinidas chamando otThreadResetTimeInQueueStat().

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
O tempo máximo na fila em milissegundos para todas as mensagens na fila TX (até o momento).

otThreadGetMeshLocalEid

const otIp6Address * otThreadGetMeshLocalEid(
  otInstance *aInstance
)

Recebe 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 da rede mesh local.

otThreadGetMeshLocalPrefix

const otMeshLocalPrefix * otThreadGetMeshLocalPrefix(
  otInstance *aInstance
)

Retorna um ponteiro para o prefixo local da rede mesh.

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

otThreadGetMleCounters

const otMleCounters * otThreadGetMleCounters(
  otInstance *aInstance
)

Recebe os contadores do Thread MLE.

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

otThreadGetNetworkKey

void otThreadGetNetworkKey(
  otInstance *aInstance,
  otNetworkKey *aNetworkKey
)

Consiga a chave de rede 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 Thread.
Consulte também:
otThreadSetNetworkKey

otThreadGetNetworkKeyRef

otNetworkKeyRef otThreadGetNetworkKeyRef(
  otInstance *aInstance
)

Consiga o otNetworkKeyRef para a chave de rede Thread.

É necessário que o recurso de tempo de build 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 Thread armazenada na memória.
Consulte também:
otThreadSetNetworkKeyRef

otThreadGetNetworkName

const char * otThreadGetNetworkName(
  otInstance *aInstance
)

Consiga 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 Thread.
Consulte também:
otThreadSetNetworkName

otThreadGetNextDiagnosticTlv

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

Recebe o próximo TLV do diagnóstico de rede na mensagem.

Exige OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE.

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 do diagnóstico de rede. Para conseguir o primeiro TLV do diagnóstico de rede, ele deve ser definido como OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT.
[out] aNetworkDiagTlv
Um ponteiro para o local em que as informações do TLV do diagnóstico de rede serão colocadas.
Valores de retorno
OT_ERROR_NONE
O próximo TLV do diagnóstico de rede foi encontrado.
OT_ERROR_NOT_FOUND
Não há nenhum TLV de diagnóstico de rede subsequente na mensagem.
OT_ERROR_PARSE
Falha ao analisar o próximo diagnóstico de rede.

otThreadGetNextNeighborInfo

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

Recebe as próximas informações vizinhas.

É usado para percorrer 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, é preciso definir como OT_NEIGHBOR_INFO_ITERATOR_INIT.
[out] aInfo
Um ponteiro para as informações vizinhas.
Valores de retorno
OT_ERROR_NONE
A próxima entrada vizinha foi encontrada na tabela.
OT_ERROR_NOT_FOUND
Nenhuma entrada vizinha subsequente existe na tabela.
OT_ERROR_INVALID_ARGS
aIterator ou aInfo estava NULL.

otThreadGetParentAverageRssi

otError otThreadGetParentAverageRssi(
  otInstance *aInstance,
  int8_t *aParentRssi
)

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

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

otThreadGetParentInfo

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

A função recupera informações de diagnóstico para um roteador Thread 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 principal são colocadas.

otThreadGetParentLastRssi

otError otThreadGetParentLastRssi(
  otInstance *aInstance,
  int8_t *aLastRssi
)

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

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[out] aLastRssi
Um ponteiro para onde o último RSSI deve 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 é NULL.

otThreadGetPartitionId

uint32_t otThreadGetPartitionId(
  otInstance *aInstance
)

Recebe o ID da partição.

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

otThreadGetRealmLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

Recebe o endereço multicast de todos os nós de Thread Realm-Local.

O endereço é um endereço multicast baseado em prefixo unicast realm-local [RFC 3306], com:

  • flgs definidos como 3 (P = 1 e T = 1)
  • Policial em 3
  • plen definido como 64
  • definido como o prefixo local da rede mesh
  • O ID do grupo foi definido como 1

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
Um ponteiro para o endereço multicast de todos os nós de thread Realm-Local.

otThreadGetRloc

const otIp6Address * otThreadGetRloc(
  otInstance *aInstance
)

Recebe o endereço Thread Routing Locator (RLOC).

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

otThreadGetRloc16

uint16_t otThreadGetRloc16(
  otInstance *aInstance
)

Acesse 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
)

Recupera o ALOC do 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 o qual receber o ALOC.
[out] aServiceAloc
Um ponteiro para gerar o ALOC do serviço. NÃO PODE SER NULL.
Valores de retorno
OT_ERROR_NONE
O ALOC do serviço foi recuperado.
OT_ERROR_DETACHED
No momento, a interface Thread não está anexada a uma partição de Thread.

otThreadGetTimeInQueueHistogram

const uint32_t * otThreadGetTimeInQueueHistogram(
  otInstance *aInstance,
  uint16_t *aNumBins,
  uint32_t *aBinInterval
)

Recebe o histograma de tempo na fila das mensagens na fila do TX.

Exige OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE.

O histograma do tempo na fila de mensagens na fila de transmissão é coletado. O tempo na fila é rastreado apenas para transmissões diretas e é medido como a duração entre o momento em que uma mensagem é adicionada à fila de transmissão e o momento em que ela é passada para a camada MAC para transmissão ou descartada.

O histograma é retornado como uma matriz de valores uint32_t com entradas aNumBins. A primeira entrada na matriz (no índice 0) representa o número de mensagens com um tempo na fila menor que aBinInterval. A segunda entrada representa o número de mensagens com tempo na fila maior ou igual a aBinInterval, mas menor que 2 * aBinInterval. E assim por diante. A última entrada representa o número de mensagens com tempo na fila maior ou igual a (aNumBins - 1) * aBinInterval.

As estatísticas coletadas podem ser redefinidas chamando otThreadResetTimeInQueueStat(). As informações do histograma são coletadas desde que a instância do OpenThread foi inicializada ou desde a última vez que a coleta de estatísticas foi redefinida chamando o otThreadResetTimeInQueueStat().

Os ponteiros aNumBins e aBinInterval NÃO PODEM ser NULL.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[out] aNumBins
Ponteiro para retornar o número de agrupamentos no histograma (comprimento da matriz).
[out] aBinInterval
Ponteiro para retornar a duração do intervalo do agrupamento do histograma em milissegundos.
Retorna
Um ponteiro para uma matriz de entradas aNumBins que representam as informações do histograma coletadas.

otThreadGetVendorModel

const char * otThreadGetVendorModel(
  otInstance *aInstance
)

Acessa a string do modelo do fornecedor.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
A string do modelo do fornecedor.

otThreadGetVendorName

const char * otThreadGetVendorName(
  otInstance *aInstance
)

Acessa a string do nome do fornecedor.

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

otThreadGetVendorSwVersion

const char * otThreadGetVendorSwVersion(
  otInstance *aInstance
)

Acessa a string da versão do sw do fornecedor.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
A string da versão do provedor do fornecedor.

otThreadGetVersion

uint16_t otThreadGetVersion(
  void
)

Recebe a versão do protocolo Thread.

Detalhes
Retorna
a versão do protocolo Thread.

otThreadIsAnycastLocateInProgress

bool otThreadIsAnycastLocateInProgress(
  otInstance *aInstance
)

Indica se uma solicitação de localização anycast está em andamento.

Só fica 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 Anycast estiver em andamento; caso contrário, FALSE.

otThreadIsDiscoverInProgress

bool otThreadIsDiscoverInProgress(
  otInstance *aInstance
)

Determina se uma descoberta de linha de execução MLE está em andamento.

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

otThreadIsSingleton

bool otThreadIsSingleton(
  otInstance *aInstance
)

Indica se um nó é o único roteador na 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 é filho ou não é um único roteador na rede.

otThreadLocateAnycastDestination

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

Solicita a localização do destino mais próximo de um determinado endereço anycast.

Só fica 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 PODE ser NULL.
[in] aCallback
A função de callback para informar 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
)

Registra um callback para receber dados de resposta pai de MLE.

Exige OPENTHREAD_CONFIG_MLE_PARENT_RESPONSE_CALLBACK_API_ENABLE.

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 resposta pai de MLE.
[in] aContext
Um ponteiro para o contexto específico do cliente de callback.

otThreadResetIp6Counters

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 do Thread MLE.

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

otThreadResetTimeInQueueStat

void otThreadResetTimeInQueueStat(
  otInstance *aInstance
)

Redefine as estatísticas de tempo na fila da fila TX.

Exige OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE.

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

otThreadSearchForBetterParent

otError otThreadSearchForBetterParent(
  otInstance *aInstance
)

Inicia o processo para a criança procurar um pai melhor sem perder o vínculo com o pai atual.

Deve ser usado quando o dispositivo está anexado como filho.

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

otThreadSendAddressNotification

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

Envia uma mensagem de notificação de endereço proativa (ADDR_NTF.ntf).

Só fica 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 a ser enviado para a 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
)

Enviar uma solicitação Get de diagnóstico de rede.

Exige OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE.

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

otThreadSendDiagnosticReset

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

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

Exige OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE.

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

otThreadSendProactiveBackboneNotification

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

Envia uma mensagem de notificação proativa de backbone (PRO_BB.ntf) no link do backbone.

Só fica 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 houver buffers de mensagem insuficientes disponíveis.

otThreadSetChildTimeout

void otThreadSetChildTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

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

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

otThreadSetDiscoveryRequestCallback

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

Define um callback para receber dados da solicitação de descoberta de 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 o contexto específico do aplicativo de callback.

otThreadSetDomainName

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

Define o nome de domínio do Thread.

Só funciona quando os protocolos do 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 da linha de execução.
Valores de retorno
OT_ERROR_NONE
O nome de domínio do Thread foi definido.
OT_ERROR_INVALID_STATE
Os protocolos de Thread estão ativados.
Consulte também:
otThreadGetDomainName

otThreadSetEnabled

otError otThreadSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

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 todos os processos em andamento de separação iniciados por otThreadDetachGracefully(). O callback será chamado.

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

otThreadSetExtendedPanId

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

Define o ID PAN estendido do 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 IEEE 802.15.4.
Valores de retorno
OT_ERROR_NONE
O ID do PAN estendido foi definido.
OT_ERROR_INVALID_STATE
Os protocolos de Thread estão ativados.
Consulte 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 do 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 de interface foi definido/limpado.
OT_ERROR_INVALID_ARGS
O identificador de interface especificado está reservado.
Consulte também:
otThreadGetFixedDuaInterfaceIdentifier

otThreadSetJoinerAdvertisement

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

Define a divulgação do Thread Joiner ao descobrir a rede Thread.

A publicidade do combinador de conversas é usada para permitir que um combinador anuncie as próprias informações específicas do aplicativo (como ID do fornecedor, ID do produto, discriminador etc.) por meio de um TLV de anúncio de conjunto recém-proposto e disponibilizar essas informações para comissários ou candidatos sem interação humana.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aOui
O valor de OUI do IEEE do fornecedor que será incluído no Anúncio do Combinador. Somente os 3 bytes menos significativos são usados e o mais significativo é ignorado.
[in] aAdvData
Um ponteiro para o AdvData que será incluído no anúncio do Combinador.
[in] aAdvDataLength
O tamanho de AdvData em bytes.
Valores de retorno
OT_ERROR_NONE
O anúncio do Combinador foi configurado.
OT_ERROR_INVALID_ARGS
AdvData inválido.

otThreadSetKeySequenceCounter

void otThreadSetKeySequenceCounter(
  otInstance *aInstance,
  uint32_t aKeySequenceCounter
)

Define o thDataSequenceCounter.

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

otThreadSetKeySwitchGuardTime

void otThreadSetKeySwitchGuardTime(
  otInstance *aInstance,
  uint32_t aKeySwitchGuardTime
)

Define o thwebkitSwitchGuardTime (em horas).

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

otThreadSetLinkMode

otError otThreadSetLinkMode(
  otInstance *aInstance,
  otLinkModeConfig aConfig
)

Defina a configuração do modo de link 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 link.
Valores de retorno
OT_ERROR_NONE
A configuração do modo de link do MLE foi definida.
Consulte também:
otThreadGetLinkMode

otThreadSetMeshLocalPrefix

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

Define o prefixo local da rede mesh.

Só funciona quando os protocolos do Thread estão desativados. Uma chamada bem-sucedida para esta 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 da rede mesh.
Valores de retorno
OT_ERROR_NONE
O prefixo local da rede mesh foi definido.
OT_ERROR_INVALID_STATE
Os protocolos de Thread estão ativados.

otThreadSetNetworkKey

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

Define a chave de rede Thread.

Só funciona quando os protocolos do Thread estão desativados. Uma chamada bem-sucedida para esta 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 Thread.
Valores de retorno
OT_ERROR_NONE
A chave de rede Thread foi definida.
OT_ERROR_INVALID_STATE
Os protocolos de Thread estão ativados.
Consulte também:
otThreadGetNetworkKey

otThreadSetNetworkKeyRef

otError otThreadSetNetworkKeyRef(
  otInstance *aInstance,
  otNetworkKeyRef aKeyRef
)

Defina a chave da rede Thread como otNetworkKeyRef.

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

É necessário que o recurso de tempo de build 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 Thread.
Valores de retorno
OT_ERROR_NONE
A chave de rede Thread foi definida.
OT_ERROR_INVALID_STATE
Os protocolos de Thread estão ativados.
Consulte também:
otThreadGetNetworkKeyRef

otThreadSetNetworkName

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

Define o nome da rede Thread.

Só funciona quando os protocolos do Thread estão desativados. Uma chamada bem-sucedida para esta 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 Thread.
Valores de retorno
OT_ERROR_NONE
O nome da rede Thread foi definido.
OT_ERROR_INVALID_STATE
Os protocolos de Thread estão ativados.
Consulte também:
otThreadGetNetworkName

otThreadSetVendorModel

otError otThreadSetVendorModel(
  otInstance *aInstance,
  const char *aVendorModel
)

Defina a string do modelo do fornecedor.

Exige OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE.

aVendorModel deve ser UTF8 com comprimento máximo de 32 caracteres (MAX_VENDOR_MODEL_TLV_LENGTH). O tamanho máximo não inclui o caractere \0 nulo.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aVendorModel
A string do modelo do fornecedor.
Valores de retorno
OT_ERROR_NONE
O modelo do fornecedor foi definido.
OT_ERROR_INVALID_ARGS
aVendorModel não é válido (muito longo ou não está em UTF8).

otThreadSetVendorName

otError otThreadSetVendorName(
  otInstance *aInstance,
  const char *aVendorName
)

Defina a string do nome do fornecedor.

Exige OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE.

aVendorName deve ser UTF8 com comprimento máximo de 32 caracteres (MAX_VENDOR_NAME_TLV_LENGTH). O tamanho máximo não inclui o caractere \0 nulo.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aVendorName
String do nome do fornecedor.
Valores de retorno
OT_ERROR_NONE
O nome do fornecedor foi definido.
OT_ERROR_INVALID_ARGS
aVendorName não é válido (muito longo ou não está em UTF8).

otThreadSetVendorSwVersion

otError otThreadSetVendorSwVersion(
  otInstance *aInstance,
  const char *aVendorSwVersion
)

Defina a string da versão do software do fornecedor.

Exige OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE.

aVendorSwVersion deve ser UTF8, com comprimento máximo de 16 caracteres(MAX_VENDOR_SW_VERSION_TLV_LENGTH). O tamanho máximo não inclui o caractere \0 nulo.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aVendorSwVersion
A string da versão do software do fornecedor.
Valores de retorno
OT_ERROR_NONE
A versão do software do fornecedor foi definida.
OT_ERROR_INVALID_ARGS
aVendorSwVersion não é válido (muito longo ou não está em UTF8).

Macros

OT_DURATION_STRING_SIZE

 OT_DURATION_STRING_SIZE 21

Tamanho recomendado para a representação de string da duração de uint32_t em segundos.

OT_JOINER_ADVDATA_MAX_LENGTH

 OT_JOINER_ADVDATA_MAX_LENGTH 64

Tamanho máximo de AdvData do anúncio do Combinador.

OT_NEIGHBOR_INFO_ITERATOR_INIT

 OT_NEIGHBOR_INFO_ITERATOR_INIT 0

Inicializador para otNeighborInfoIterator.

OT_NETWORK_BASE_TLV_MAX_LENGTH

 OT_NETWORK_BASE_TLV_MAX_LENGTH 254

Comprimento máximo do valor do TLV do Thread Base.

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 para otNetworkDiagIterator.

OT_NETWORK_DIAGNOSTIC_MAX_THREAD_STACK_VERSION_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_THREAD_STACK_VERSION_TLV_LENGTH 64

Comprimento máximo da versão TLV da pilha de execução.

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_MODEL_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_MODEL_TLV_LENGTH 32

Tamanho máximo do TLV do modelo de fornecedor.

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH 32

Comprimento máximo do TLV do nome do fornecedor.

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_SW_VERSION_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_SW_VERSION_TLV_LENGTH 16

Tamanho máximo da versão SW do fornecedor TLV.

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 a serem solicitados ou redefinidos.

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 de serviço em bytes.

Recursos

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