Geral

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

Resumo

O editor de dados de rede fornece mecanismos para limitar o número de entradas de serviço e/ou prefixo (prefixo de malha ou rota externa) semelhantes nos dados de rede do thread monitorando os dados de rede e gerenciando se deve ser adicionado ou removido.

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

Enumerações

anonymous enum{
  OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS = 0,
  OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS = 1,
  OT_NETWORK_DIAGNOSTIC_TLV_MODE = 2,
  OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT = 3,
  OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY = 4,
  OT_NETWORK_DIAGNOSTIC_TLV_ROUTE = 5,
  OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA = 6,
  OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA = 7,
  OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST = 8,
  OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS = 9,
  OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL = 14,
  OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE = 15,
  OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE = 16,
  OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES = 17,
  OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST = 18,
  OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT = 19,
  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
}
tipo enumerado
otDeviceRole{
  OT_DEVICE_ROLE_DISABLED = 0,
  OT_DEVICE_ROLE_DETACHED = 1,
  OT_DEVICE_ROLE_CHILD = 2,
  OT_DEVICE_ROLE_ROUTER = 3,
  OT_DEVICE_ROLE_LEADER = 4
}
tipo enumerado
Representa uma função de dispositivo Thread.
otNetDataPublisherEvent{
  OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED = 0,
  OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED = 1
}
tipo enumerado
Representa os eventos informados a partir dos retornos de chamada do editor.
otRoutePreference{
  OT_ROUTE_PREFERENCE_LOW = -1,
  OT_ROUTE_PREFERENCE_MED = 0,
  OT_ROUTE_PREFERENCE_HIGH = 1
}
tipo enumerado
Define valores válidos para mPreference em otExternalRouteConfig e otBorderRouterConfig.

Typedefs

otBorderRouterConfig typedef
Representa uma configuração de roteador de borda.
otDetachGracefullyCallback)(void *aContext) typedef
void(*
Esse callback informa ao aplicativo que o processo de desconexão foi concluído.
otExternalRouteConfig typedef
Representa uma configuração de rota externa.
otIpCounters typedef
struct otIpCounters
Representa os contadores de nível 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 vinculação MLE.
otLowpanContextInfo typedef
Representa informações de código do contexto do 6LoWPAN associadas a um prefixo em dados de rede.
otMleCounters typedef
struct otMleCounters
Representa os contadores de Thread MLE.
otNeighborInfoIterator typedef
int16_t
Usado para iterar pela tabela vizinha.
otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext) typedef
void(*
O tipo de ponteiro define o callback usado para notificar quando uma entrada "DNS/SRP Service" é adicionada ou removida dos dados da rede Thread.
otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext) typedef
void(*
O tipo de ponteiro define o callback usado para notificar quando uma entrada de prefixo (rota em malha ou externa) é adicionada ou removida dos dados da rede Thread.
otNetDataPublisherEvent typedef
Representa os eventos informados a partir dos retornos de chamada do editor.
otNetworkDataIterator typedef
uint32_t
Usado para iterar as informações de dados da 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 por meio do TLV de diagnóstico de rede.
otNetworkDiagMacCounters typedef
Representa um valor de Contadores de diagnóstico de rede para Mac.
otNetworkDiagMleCounters typedef
Representa um valor de contadores MLE de diagnósticos de rede.
otNetworkDiagRoute typedef
Representa um valor de TLV da rota de diagnóstico de rede.
otNetworkDiagRouteData typedef
Representa um dado de 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 de 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 de 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 da linha de execução.
otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext) typedef
void(*
O ponteiro é chamado sempre que uma mensagem de resposta pai do MLE é recebida.
otThreadParentResponseInfo typedef
Representa os dados da resposta pai do MLE.

Funções

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
Verifique 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)
Forneça uma cópia completa ou estável dos dados da rede Thread da partição.
otNetDataGetLength(otInstance *aInstance)
uint8_t
Obtém o comprimento atual (número de bytes) dos dados da rede Thread da partição.
otNetDataGetMaxLength(otInstance *aInstance)
uint8_t
Obtém o comprimento máximo observado dos dados da rede Thread desde a inicialização da pilha de OT ou desde a última chamada para otNetDataResetMaxLength().
otNetDataGetNextLowpanContextInfo(otInstance *aInstance, otNetworkDataIterator *aIterator, otLowpanContextInfo *aContextInfo)
Receba as próximas informações do ID do contexto do 6LoWPAN nos dados de rede da partição.
otNetDataGetNextOnMeshPrefix(otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
Receba o próximo prefixo da malha nos dados de rede da partição.
otNetDataGetNextRoute(otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)
Obtém a próxima rota externa nos dados de rede da partição.
otNetDataGetNextService(otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig)
Recebe o próximo serviço nos dados de rede da partição.
otNetDataGetStableVersion(otInstance *aInstance)
uint8_t
Acessar a versão estável dos dados de rede.
otNetDataGetVersion(otInstance *aInstance)
uint8_t
Obtenha a versão dos dados de rede.
otNetDataIsDnsSrpServiceAdded(otInstance *aInstance)
bool
Indica se a entrada "Serviço de DNS/SRP" foi adicionada ou não aos dados da rede Thread.
otNetDataIsPrefixAdded(otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
Indica se uma entrada de prefixo publicada (na malha ou em uma rota externa) foi adicionada aos dados da rede Thread.
otNetDataPublishDnsSrpServiceAnycast(otInstance *aInstance, uint8_t aSequenceNUmber)
void
Solicita a publicação de "DNS/SRP Service Anycast Address" nos dados de rede Thread.
otNetDataPublishDnsSrpServiceUnicast(otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort)
void
Solicita a publicação de "DNS/SRP Service Unicast Service" nos dados da rede Thread.
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(otInstance *aInstance, uint16_t aPort)
void
Solicita a publicação de "DNS/SRP Service Unicast Service" nos dados da rede Thread.
otNetDataPublishExternalRoute(otInstance *aInstance, const otExternalRouteConfig *aConfig)
Solicita a publicação de um prefixo de rota externa nos dados da rede Thread.
otNetDataPublishOnMeshPrefix(otInstance *aInstance, const otBorderRouterConfig *aConfig)
Solicita a publicação de um prefixo de malha nos dados da rede Thread.
otNetDataReplacePublishedExternalRoute(otInstance *aInstance, const otIp6Prefix *aPrefix, const otExternalRouteConfig *aConfig)
Substitui uma rota externa publicada anteriormente nos dados da rede Thread.
otNetDataResetMaxLength(otInstance *aInstance)
void
Redefinir o comprimento máximo rastreado dos dados da rede Thread.
otNetDataSetDnsSrpServicePublisherCallback(otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext)
void
Define um callback para notificar quando um "Serviço de 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 for realmente adicionada ou removida dos dados da rede Thread.
otNetDataSteeringDataCheckJoiner(otInstance *aInstance, const otExtAddress *aEui64)
Verifique se os dados de direcionamento incluem um Joiner.
otNetDataSteeringDataCheckJoinerWithDiscerner(otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner)
Verifique se os dados de direcionamento incluem um Joiner com um determinado valor de discerner.
otNetDataUnpublishDnsSrpService(otInstance *aInstance)
void
Cancela a publicação de qualquer entrada de serviço DNS/SRP (Anycast ou Unicast) previamente adicionada nos 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)
Tente se reconectar como filho.
otThreadBecomeDetached(otInstance *aInstance)
Separe 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 *
Converter a função 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 do Thread Discovery.
otThreadGetChildTimeout(otInstance *aInstance)
uint32_t
Obtém o Timeout do Thread Child (em segundos) usado na operação no papel Child.
otThreadGetDeviceRole(otInstance *aInstance)
Receba a função do dispositivo.
otThreadGetDomainName(otInstance *aInstance)
const char *
Obtém o nome de domínio do thread.
otThreadGetExtendedPanId(otInstance *aInstance)
const otExtendedPanId *
Recebe o código PAN estendido do IEEE 802.15.4.
otThreadGetFixedDuaInterfaceIdentifier(otInstance *aInstance)
Obtém o identificador de interface especificado manualmente para o endereço Unicast do domínio Thread.
otThreadGetIp6Counters(otInstance *aInstance)
const otIpCounters *
Recebe os contadores IPv6.
otThreadGetKeySequenceCounter(otInstance *aInstance)
uint32_t
Obtém o thrKeySequenceCounter.
otThreadGetKeySwitchGuardTime(otInstance *aInstance)
uint32_t
Obtém o thrKeySwitchGuardTime (em horas).
otThreadGetLeaderData(otInstance *aInstance, otLeaderData *aLeaderData)
Acessar os dados do Thread Leader.
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
Obtenha o peso do líder.
otThreadGetLinkLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
const otIp6Address *
Obtém o endereço multicast de Thread Link-Local.
otThreadGetLinkLocalIp6Address(otInstance *aInstance)
const otIp6Address *
Obtém o endereço IPv6 link-local do Thread.
otThreadGetLinkMode(otInstance *aInstance)
Acessar a configuração do modo de vinculação do MLE.
otThreadGetMaxTimeInQueue(otInstance *aInstance)
uint32_t
Recebe o tempo máximo na fila de mensagens na fila do TX.
otThreadGetMeshLocalEid(otInstance *aInstance)
const otIp6Address *
Obtém o endereço EID local da malha.
otThreadGetMeshLocalPrefix(otInstance *aInstance)
Retorna um ponteiro para o prefixo local da malha.
otThreadGetMleCounters(otInstance *aInstance)
const otMleCounters *
Recebe os contadores de Thread MLE.
otThreadGetNetworkKey(otInstance *aInstance, otNetworkKey *aNetworkKey)
void
Receba a chave de rede Thread.
otThreadGetNetworkKeyRef(otInstance *aInstance)
Encontre o otNetworkKeyRef da chave de rede da linha de execução.
otThreadGetNetworkName(otInstance *aInstance)
const char *
Consiga o nome da rede Thread.
otThreadGetNextDiagnosticTlv(const otMessage *aMessage, otNetworkDiagIterator *aIterator, otNetworkDiagTlv *aNetworkDiagTlv)
Obtém o próximo TLV de diagnóstico de rede na mensagem.
otThreadGetNextNeighborInfo(otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo)
Recebe as informações do próximo vizinho.
otThreadGetParentAverageRssi(otInstance *aInstance, int8_t *aParentRssi)
A função recupera a RSSI média do Thread Parent.
otThreadGetParentInfo(otInstance *aInstance, otRouterInfo *aParentInfo)
A função recupera informações de diagnóstico para um roteador de linha de execução como pai.
otThreadGetParentLastRssi(otInstance *aInstance, int8_t *aLastRssi)
A função recupera o RSSI do último pacote do Thread Parent.
otThreadGetPartitionId(otInstance *aInstance)
uint32_t
Consiga o ID da partição.
otThreadGetRealmLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
const otIp6Address *
Recebe o endereço multicast de todos os nós do Thread Realm-Local.
otThreadGetRloc(otInstance *aInstance)
const otIp6Address *
Recebe o endereço do Thread Routing Locator (RLOC).
otThreadGetRloc16(otInstance *aInstance)
uint16_t
Acesse o RLOC16.
otThreadGetServiceAloc(otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc)
Recupera o ALOC de serviço para um determinado ID de serviço.
otThreadGetTimeInQueueHistogram(otInstance *aInstance, uint16_t *aNumBins, uint32_t *aBinInterval)
const uint32_t *
Obtém o histograma de tempo na fila para mensagens na fila do TX.
otThreadGetVendorModel(otInstance *aInstance)
const char *
Consiga a string do modelo do fornecedor.
otThreadGetVendorName(otInstance *aInstance)
const char *
Obtém a string do nome do fornecedor.
otThreadGetVendorSwVersion(otInstance *aInstance)
const char *
Obtém a string da versão do fornecedor.
otThreadGetVersion(void)
uint16_t
Obtém a versão do protocolo Thread.
otThreadIsAnycastLocateInProgress(otInstance *aInstance)
bool
Indica se uma solicitação de localização do anycast está em andamento.
otThreadIsDiscoverInProgress(otInstance *aInstance)
bool
Determina se uma descoberta de encadeamento do 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 determinado endereço anycast.
otThreadRegisterParentResponseCallback(otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext)
void
Registra um callback para receber dados de resposta pai do MLE.
otThreadResetIp6Counters(otInstance *aInstance)
void
Redefine os contadores IPv6.
otThreadResetMleCounters(otInstance *aInstance)
void
Redefine os contadores de Thread MLE.
otThreadResetTimeInQueueStat(otInstance *aInstance)
void
Redefine as estatísticas de tempo na fila do TX.
otThreadSearchForBetterParent(otInstance *aInstance)
Inicia o processo para a criança procurar um pai melhor enquanto permanece vinculado ao 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)
Envie uma solicitação 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 de diagnóstico de rede.
otThreadSendProactiveBackboneNotification(otInstance *aInstance, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction)
Envia uma mensagem proativa de backbone (PRO_BB.ntf) no link do Backbone.
otThreadSetChildTimeout(otInstance *aInstance, uint32_t aTimeout)
void
Define o Thread Child Timeout (em segundos) usado ao operar na função Child.
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 código 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 Thread.
otThreadSetJoinerAdvertisement(otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength)
Define a publicidade do combinador de linhas de execução ao descobrir a rede Thread.
otThreadSetKeySequenceCounter(otInstance *aInstance, uint32_t aKeySequenceCounter)
void
Define o thrKeySequenceCounter.
otThreadSetKeySwitchGuardTime(otInstance *aInstance, uint32_t aKeySwitchGuardTime)
void
Define o thrKeySwitchGuardTime (em horas).
otThreadSetLinkMode(otInstance *aInstance, otLinkModeConfig aConfig)
Definir a configuração do Modo de vinculação MLE.
otThreadSetMeshLocalPrefix(otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix)
Define o prefixo local da malha.
otThreadSetNetworkKey(otInstance *aInstance, const otNetworkKey *aKey)
Defina a chave de rede Thread.
otThreadSetNetworkKeyRef(otInstance *aInstance, otNetworkKeyRef aKeyRef)
Defina a chave de rede Thread como otNetworkKeyRef.
otThreadSetNetworkName(otInstance *aInstance, const char *aNetworkName)
Defina 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 (em inglês).

Representa uma configuração de roteador de borda.

otExternalRouteConfig.

Representa uma configuração de rota externa.

otIpCounters (em inglês)

Representa os contadores de nível IP.

otLeaderData (em inglês)

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

otLinkModeConfig.

Representa uma configuração do Modo de vinculação MLE.

otLowpanContextInfo.

Representa informações de código do contexto do 6LoWPAN associadas a um prefixo em dados de rede.

otMleCounters (em inglês)

Representa os contadores de Thread MLE.

OtNeighborInfo (em inglês)

Contém informações de diagnóstico para um nó do 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 diagnóstico de rede para Mac.

otNetworkDiagMleCounters

Representa um valor de contadores MLE de diagnósticos de rede.

otNetworkDiagRoute (em inglês)

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

otNetworkDiagRouteData (em inglês)

Representa um dado de rota de diagnóstico de rede.

otNetworkDiagTlv (em inglês)

Representa um TLV de diagnóstico de rede.

otRouterInfo.

Contém informações de diagnóstico para um roteador de linhas de execução.

otServerConfig (em inglês)

Representa uma configuração de servidor.

otServiceConfig (em inglês)

Representa uma configuração de serviço.

otThreadDiscoveryRequestInfo.

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

otThreadParentResponseInfo (link em inglês)

Representa os dados da resposta pai do MLE.

Enumerações

enumeração anônima

 anonymous enum
Propriedades
OT_NETWORK_DIAGNOSTIC_TLV_ANSWER

Responder TLV.

OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL

Nível de bateria TLV.

OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES

TLV das páginas do canal.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD

TLV filho.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_IP6_ADDR_LIST

TLV secundário da lista de endereços IPv6.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE

TLV da tabela filha.

OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY

TLV de conectividade.

OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS

TLV do endereço estendido de MAC.

OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST

TLV da lista de endereços IPv6.

OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA

TLV de dados do líder.

OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS

TLV de contadores MAC.

OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT

TLV de tempo limite máximo derivado.

OT_NETWORK_DIAGNOSTIC_TLV_MLE_COUNTERS

MLE Contrata TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MODE

Modo TLV.

OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA

TLV dos dados de rede.

OT_NETWORK_DIAGNOSTIC_TLV_QUERY_ID

ID de 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 Address16.

OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE

TLV da fonte de alimentação.

OT_NETWORK_DIAGNOSTIC_TLV_THREAD_STACK_VERSION

Versão TLV da pilha de linhas de execução.

OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT

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

OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST

Lista de tipos 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

TLV da versão de software do fornecedor.

OT_NETWORK_DIAGNOSTIC_TLV_VERSION

Versão TLV.

Função do dispositivo

 otDeviceRole

Representa uma função de dispositivo Thread.

Propriedades
OT_DEVICE_ROLE_CHILD

Papel Thread Child.

OT_DEVICE_ROLE_DETACHED

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

OT_DEVICE_ROLE_DISABLED

A pilha Thread está desativada.

OT_DEVICE_ROLE_LEADER

O papel de líder da linha de execução.

OT_DEVICE_ROLE_ROUTER

Papel Roteador de linhas de execução

OtNetDataPublisherEvent

 otNetDataPublisherEvent

Representa os eventos informados a partir dos retornos de chamada do editor.

Propriedades
OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED

A entrada publicada é adicionada aos dados da rede Thread.

OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED

A entrada publicada é removida dos dados da rede Thread.

OtRoutePreference

 otRoutePreference

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

Propriedades
OT_ROUTE_PREFERENCE_HIGH

Preferência de trajeto alto.

OT_ROUTE_PREFERENCE_LOW

Preferência de trajeto baixo.

OT_ROUTE_PREFERENCE_MED

Preferência de trajeto médio.

Typedefs

OtBorderRouterConfig.

struct otBorderRouterConfig otBorderRouterConfig

Representa uma configuração de roteador de borda.

OtDetachGracefulCallback

void(* otDetachGracefullyCallback)(void *aContext)

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

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

otExternalRouteConfig.

struct otExternalRouteConfig otExternalRouteConfig

Representa uma configuração de rota externa.

otIpCounters

struct otIpCounters otIpCounters

Representa os contadores de nível IP.

Dados do lead

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 vinculação MLE.

OpLowpanContextInfo

struct otLowpanContextInfo otLowpanContextInfo

Representa informações de código do contexto do 6LoWPAN associadas a um prefixo em dados de rede.

Contadores otMle

struct otMleCounters otMleCounters

Representa os contadores de Thread MLE.

OtNeighborInfoIterator

int16_t otNeighborInfoIterator

Usado para iterar pela tabela vizinha.

OtNetDataDnsSrpServicePublisherCallback

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

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

Na remoção, o callback é invocado independentemente de a entrada ser removida por Publisher (por exemplo, quando há muitas entradas semelhantes já presentes nos dados de rede) ou por meio de 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 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 (rota em malha ou externa) é adicionada ou removida dos dados da rede Thread.

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

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

OtNetDataPublisherEvent

enum otNetDataPublisherEvent otNetDataPublisherEvent

Representa os eventos informados a partir dos retornos de chamada do editor.

OtNetworkDataIterator

uint32_t otNetworkDataIterator

Usado para iterar as informações de dados da 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 por meio do TLV de diagnóstico de rede.

OtNetworkDiagMacCounters

struct otNetworkDiagMacCounters otNetworkDiagMacCounters

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

Consulte as definições dos campos de membros em RFC 2863.

otNetworkDiagMleCounters

struct otNetworkDiagMleCounters otNetworkDiagMleCounters

Representa um valor de contadores MLE de diagnósticos de rede.

OtNetworkDiagRoute

struct otNetworkDiagRoute otNetworkDiagRoute

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

OtNetworkDiagRouteData

struct otNetworkDiagRouteData otNetworkDiagRouteData

Representa um dado de rota de diagnóstico de rede.

RedeRedeDiag

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 de recebimento de diagnóstico de rede é recebida.

Detalhes
Parâmetros
[in] aError
Ocorreu um erro ao receber a resposta.
[in] aMessage
Um ponteiro para o buffer de mensagem que contém a carga útil de resposta recebida do diagnóstico de rede. Disponível apenas quando aError for OT_ERROR_NONE.
[in] aMessageInfo
Um ponteiro para as informações da mensagem de aMessage. Disponível apenas quando aError for OT_ERROR_NONE.
[in] aContext
Um ponteiro para 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 de servidor.

OtConfigConfig

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 local da malha do destino mais próximo do endereço anycast quando aError for OT_ERROR_NONE. Caso contrário, será NULL.
[in] aRloc16
O RLOC16 do destino, se encontrado, ou RLOC16 (0xfffe) inválido.

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ções da solicitação de descoberta.
[in] aContext
Um ponteiro para chamar o contexto específico do aplicativo.

ThreadThreadRequest

struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo

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

ThreadThreadResponseCallback

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

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

Isso é usado em otThreadRegisterParentResponseCallback().

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

ThreadThreadResponseInfo

struct otThreadParentResponseInfo otThreadParentResponseInfo

Representa os dados da resposta pai do MLE.

Funções

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.

O OPENTHREAD_CONFIG_UPTIME_ENABLE precisa estar ativado.

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

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

Se a string resultante não couber em aBuffer (dentro dos caracteres aSize), ela será truncada, mas a string de saída será sempre terminada com 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 para gerar a string.
[in] aSize
O tamanho de aBuffer (em bytes). Recomenda-se o uso de OT_DURATION_STRING_SIZE.

otNetDataContainsOmrPrefix

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

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

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

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aStable
VERDADEIRO ao copiar a versão estável, FALSO 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 aDataLength.
OT_ERROR_NO_BUFS
Não há espaço suficiente em aData para copiar completamente os dados da rede Thread.

otNetDataGetLength

uint8_t otNetDataGetLength(
  otInstance *aInstance
)

Obtém o comprimento atual (número de bytes) dos dados da rede Thread 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
)

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

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

OtNetDataGetNextLowpanContextInfo

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

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

OtNetDataGetNextOnMeshPrefix

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

Receba o próximo prefixo da 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 obter a primeira entrada da malha, ela deve ser definida como OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Um ponteiro para o local em que as informações do prefixo da malha serão colocadas.
Valores de retorno
OT_ERROR_NONE
O próximo prefixo da malha foi encontrado.
OT_ERROR_NOT_FOUND
Não há nenhum prefixo de malha subsequente nos dados da rede Thread.

otNetDataGetNextRoute

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

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 do OpenThread.
[in,out] aIterator
Um ponteiro para o contexto do iterador de dados de rede. Para obter a primeira entrada de rota externa, ela deve ser definida como OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Um ponteiro para o local em que as informações da rota externa serão colocadas.
Valores de retorno
OT_ERROR_NONE
A próxima rota externa foi encontrada.
OT_ERROR_NOT_FOUND
Não há entrada de rota externa subsequente nos dados da rede Thread.

OtNetDataGetNextService

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

Recebe o próximo serviço nos dados de rede da partição.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in,out] aIterator
Um ponteiro para o contexto do iterador de dados de rede. Para obter a primeira entrada de serviço, ela deve ser definida 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
Nenhum serviço subsequente existe nos dados de rede da partição.

Versão otNetDataGetStable

uint8_t otNetDataGetStableVersion(
  otInstance *aInstance
)

Acessar 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 estável dos dados de rede.

Versão otNetDataGet

uint8_t otNetDataGetVersion(
  otInstance *aInstance
)

Obtenha a versão dos dados de rede.

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

OtNetDataIsDnsSrpServiceAdded

bool otNetDataIsDnsSrpServiceAdded(
  otInstance *aInstance
)

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

Exige que o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE esteja ativado.

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

OtNetDataIsPrefixAdded

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

Indica se uma entrada de prefixo publicada (na malha ou em uma rota externa) foi adicionada aos dados da rede Thread.

Exige que o recurso OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE esteja ativado.

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

OtNetDataPublishDnsSrpServiceAnycast

void otNetDataPublishDnsSrpServiceAnycast(
  otInstance *aInstance,
  uint8_t aSequenceNUmber
)

Solicita a publicação de "DNS/SRP Service Anycast Address" nos dados de rede Thread.

Exige que o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE esteja ativado.

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

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

OtNetDataPublishDnsSrpServiceUnicast

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

Solicita a publicação de "DNS/SRP Service Unicast Service" nos dados da rede Thread.

Exige que o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE esteja ativado.

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

Publica o "DNS/SRP Serviço Unicast" incluindo o endereço e as informações da porta nos dados de TLV de 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 DEVE ser NULL).
[in] aPort
O número da porta do servidor SRP a ser publicado.

OtNetDataPublishDnsSrpServiceUnicastMeshLocalEid

void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(
  otInstance *aInstance,
  uint16_t aPort
)

Solicita a publicação de "DNS/SRP Service Unicast Service" nos dados da rede Thread.

Exige que o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE esteja ativado.

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

Ao contrário de otNetDataPublishDnsSrpServiceUnicast(), que exige que o endereço publicado seja fornecido e inclua as informações nos dados de TLV de serviço, essa função usa o EID local de malha do dispositivo e inclui os 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 a publicação de um prefixo de rota externa nos dados da rede Thread.

Exige que o recurso OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE esteja ativado.

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 para o mesmo prefixo. Se a nova chamada alterar apenas as sinalizações (por exemplo, nível de preferência) e o prefixo já tiver sido adicionado aos dados de rede, a alteração nas sinalizações será refletida imediatamente nos dados de rede. Isso garante que as entradas existentes nos dados de rede não sejam removidas abruptamente. Uma alteração no nível de preferência pode fazer com que a entrada seja removida dos dados da rede posteriormente, após determinar que há outros nós que estão publicando o mesmo prefixo com a mesma preferência ou maior.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aConfig
A configuração de rota externa a ser publicada (NÃO DEVE 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 inválidas de sinalizações 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 prefixo de malha e rota externa) determinadas pela configuração OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES.

OtNetDataPublishOnMeshPrefix

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

Solicita a publicação de um prefixo de malha nos dados da rede Thread.

Exige que o recurso OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE esteja ativado.

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 para o mesmo prefixo. Se a nova chamada alterar apenas as sinalizações (por exemplo, nível de preferência) e o prefixo já tiver sido adicionado aos dados de rede, a alteração nas sinalizações será refletida imediatamente nos dados de rede. Isso garante que as entradas existentes nos dados de rede não sejam removidas abruptamente. Uma alteração no nível de preferência pode fazer com que a entrada seja removida dos dados da rede posteriormente, após determinar que há outros nós que estão publicando o mesmo prefixo com a mesma preferência ou maior.

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

Exige que o recurso OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE esteja ativado.

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

Se houver uma entrada de trajeto publicada anteriormente que corresponda 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 no novo prefixo em aConfig vai aparecer imediatamente. 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 anteriormente 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 iniciará o processo de publicação nos dados de rede (monitorando os dados de rede para determinar quando/se adicionar o prefixo, dependendo do número de prefixos semelhantes presentes nos dados de rede).

Detalhes
Parâmetros
[in] aPrefix
O prefixo de rota externa publicado anteriormente para substituir.
[in] aConfig
A configuração de rota externa a ser publicada.
[in] aRequester
O solicitante (módulo kFromUser ou kFromRoutingManager).
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 inválidas de sinalizações 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 prefixo de malha e rota externa) determinadas pela configuração OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES.

OtNetDataResetMaxLength

void otNetDataResetMaxLength(
  otInstance *aInstance
)

Redefinir o comprimento máximo rastreado dos dados da 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 de DNS/SRP" publicado é realmente adicionado ou removido dos dados da rede Thread.

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

Exige que o recurso OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE esteja ativado.

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

OtNetDataSetPrefixPublisherCallback

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

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

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

Exige que o recurso OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE esteja ativado.

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

OtNetDataSteeringDataCheckJoiner

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

Verifique se os dados de direcionamento incluem um Joiner.

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

OtNetDataSteeringDataCheckJoinerWithDiscerner

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

Verifique se os dados de direcionamento incluem um Joiner com um determinado valor de discerner.

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

Serviço de publicação de otNetDataDataDnsSrp

void otNetDataUnpublishDnsSrpService(
  otInstance *aInstance
)

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

É necessário ativar OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

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

OtNetDataCancelarPrefixo

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

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

É necessário 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.

ThreadThreadChild

otError otThreadBecomeChild(
  otInstance *aInstance
)

Tente se reconectar como filho.

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

ThreadThreadFill

otError otThreadBecomeDetached(
  otInstance *aInstance
)

Separe da rede Thread.

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

otThreadDetachGraceful

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

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aCallback
Um ponteiro para uma função chamada ao terminar a desanexação.
[in] aContext
Um ponteiro para chamar o contexto específico do aplicativo.
Valores de retorno
OT_ERROR_NONE
A separação foi iniciada.
OT_ERROR_BUSY
A remoção já está em andamento.

ThreadThreadRoleToString

const char * otThreadDeviceRoleToString(
  otDeviceRole aRole
)

Converter a função 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.

oThreadThread

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

Inicia uma verificação do Thread Discovery.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aScanChannels
Um vetor de bit indicando os canais a serem verificados (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 Joiner na TLV de solicitação de descoberta.
[in] aEnableEui64Filtering
Verdadeiro para filtrar respostas em EUI-64. Caso contrário, FALSO.
[in] aCallback
Um ponteiro para uma função chamada ao receber uma resposta de descoberta ou verificação de MLE é concluída.
[in] aCallbackContext
Um ponteiro para contexto específico do aplicativo.
Valores de retorno
OT_ERROR_NONE
Uma verificação de Thread Discovery foi iniciada.
OT_ERROR_INVALID_STATE
A interface IPv6 não está ativada (netif não está ativo).
OT_ERROR_NO_BUFS
Não foi possível alocar a mensagem para a solicitação de descoberta.
OT_ERROR_BUSY
A verificação de descoberta de conversas já está em andamento.

ThreadThreadChild

uint32_t otThreadGetChildTimeout(
  otInstance *aInstance
)

Obtém o Timeout do Thread Child (em segundos) usado na operação no papel Child.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
O valor de Thread Thread Timeout em segundos.
Consulte também:
otThreadSetChildTimeout

ThreadThreadDevice

otDeviceRole otThreadGetDeviceRole(
  otInstance *aInstance
)

Receba 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 Thread está desativada.
OT_DEVICE_ROLE_DETACHED
No momento, o dispositivo não está participando de uma rede/partição de linhas de execução.
OT_DEVICE_ROLE_CHILD
No momento, o dispositivo está operando como um Thread Child.
OT_DEVICE_ROLE_ROUTER
O dispositivo está operando como um roteador de linha de execução.
OT_DEVICE_ROLE_LEADER
O dispositivo está operando como um líder de conversa.

ThreadGetDomainName

const char * otThreadGetDomainName(
  otInstance *aInstance
)

Obtém o nome de domínio do thread.

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

ThreadGetExtendedPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

Recebe o código PAN estendido do IEEE 802.15.4.

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

OtThreadGetFixedDuaInterfaceIdentifier

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
  otInstance *aInstance
)

Obtém o identificador de interface especificado manualmente para o endereço Unicast do domínio Thread.

Disponível quando o OPENTHREAD_CONFIG_DUA_ENABLE está ativado.

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

Contadores de otThreadGetIp6

const otIpCounters * otThreadGetIp6Counters(
  otInstance *aInstance
)

Recebe os contadores IPv6.

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

ThreadThreadKeyKey

uint32_t otThreadGetKeySequenceCounter(
  otInstance *aInstance
)

Obtém o thrKeySequenceCounter.

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

ThreadGetKeySwitchGuardTime

uint32_t otThreadGetKeySwitchGuardTime(
  otInstance *aInstance
)

Obtém o thrKeySwitchGuardTime (em horas).

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

OtThreadGetLeaderData

otError otThreadGetLeaderData(
  otInstance *aInstance,
  otLeaderData *aLeaderData
)

Acessar os dados do Thread Leader.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[out] aLeaderData
Um ponteiro para o local 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.

ThreadGetLeaderRloc

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 ponteiro para o RLOC do líder.
Valores de retorno
OT_ERROR_NONE
O RLOC do líder foi gravado em aLeaderRloc.
OT_ERROR_INVALID_ARGS
aLeaderRloc era NULL.
OT_ERROR_DETACHED
Não anexado a uma partição de linha de execução.

ThreadThreadLeaderId

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.

ThreadGetLeaderWeight

uint8_t otThreadGetLeaderWeight(
  otInstance *aInstance
)

Obtenha o peso do líder.

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

OtThreadGetLinkLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetLinkLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

Obtém o endereço multicast de Thread Link-Local.

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

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

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

OtThreadGetLinkLocalIp6Address

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

Obtém o endereço IPv6 link-local do Thread.

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

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

ThreadThreadMode

otLinkModeConfig otThreadGetLinkMode(
  otInstance *aInstance
)

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

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

ThreadGetMaxTimeInQueue

uint32_t otThreadGetMaxTimeInQueue(
  otInstance *aInstance
)

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

Exige OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE.

O tempo na fila é rastreado somente para transmissões diretas e é medido como a duração desde quando uma mensagem é adicionada à fila de transmissão até ser 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 do TX (até agora).

ThreadGetMeshLocalEid

const otIp6Address * otThreadGetMeshLocalEid(
  otInstance *aInstance
)

Obtém 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.

OtThreadGetMeshLocalPrefix

const otMeshLocalPrefix * otThreadGetMeshLocalPrefix(
  otInstance *aInstance
)

Retorna um ponteiro para o prefixo local da malha.

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

otThreadGetMleCounters

const otMleCounters * otThreadGetMleCounters(
  otInstance *aInstance
)

Recebe os contadores de Thread MLE.

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

ThreadThreadNetwork

void otThreadGetNetworkKey(
  otInstance *aInstance,
  otNetworkKey *aNetworkKey
)

Receba 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 de linhas de execução.
Consulte também:
otThreadSetNetworkKey

ThreadThreadNetworkRef

otNetworkKeyRef otThreadGetNetworkKeyRef(
  otInstance *aInstance
)

Encontre o otNetworkKeyRef da chave de rede da linha de execução.

O recurso de tempo de compilação OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE precisa estar 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

ThreadThreadNetwork

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

ThreadThreadNextDiagnosticTlv

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

Obtém o próximo TLV de diagnóstico de rede na mensagem.

Exige OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE.

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

Detalhes
Parâmetros
[in] aMessage
Um ponteiro para uma mensagem.
[in,out] aIterator
Um ponteiro para o contexto do iterador de diagnóstico de rede. Para obter o primeiro TLV de diagnóstico de rede, ele deve ser definido como OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT.
[out] aNetworkDiagTlv
Um ponteiro para o local em que as informações de TLV de diagnóstico de rede serão colocadas.
Valores de retorno
OT_ERROR_NONE
O próximo TLV de 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 na análise do próximo diagnóstico de rede.

otThreadGetNextNeighborInfo

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

Recebe as informações do próximo vizinho.

Ele é usado para analisar as entradas da tabela vizinha.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in,out] aIterator
Um ponteiro para o contexto do iterador. Para obter a primeira entrada vizinha, ela deve ser definida como OT_NEIGHBOR_INFO_ITERATOR_INIT.
[out] aInfo
Um ponteiro para as informações do vizinho.
Valores de retorno
OT_ERROR_NONE
A próxima entrada da vizinha foi encontrada na tabela.
OT_ERROR_NOT_FOUND
Não há entrada vizinha subsequente na tabela.
OT_ERROR_INVALID_ARGS
aIterator ou aInfo era NULL.

ThreadThreadParent=Rssi

otError otThreadGetParentAverageRssi(
  otInstance *aInstance,
  int8_t *aParentRssi
)

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

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[out] aParentRssi
Um ponteiro para o local da RSSI mãe.

ThreadThreadParent

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

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

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

threadThreadParentLastRssi

otError otThreadGetParentLastRssi(
  otInstance *aInstance,
  int8_t *aLastRssi
)

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

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;

ThreadThreadPartition

uint32_t otThreadGetPartitionId(
  otInstance *aInstance
)

Consiga o ID da partição.

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

OtThreadGetRealmLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

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

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

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

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

ThreadThreadRloc

const otIp6Address * otThreadGetRloc(
  otInstance *aInstance
)

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

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

ThreadThreadR16

uint16_t otThreadGetRloc16(
  otInstance *aInstance
)

Acesse o RLOC16.

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

ThreadGetServiceAloc

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

Recupera o ALOC de serviço para um determinado ID de serviço.

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

OtThreadGetTimeInQueueHistogram

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

Obtém o histograma de tempo na fila para 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 somente para transmissões diretas e é medido como a duração desde quando uma mensagem é adicionada à fila de transmissão até ser 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 inferior a aBinInterval. A segunda entrada representa o número de mensagens com um 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 que a última 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 (tamanho da matriz).
[out] aBinInterval
Ponteiro para retornar o comprimento do intervalo de agrupamento do histograma em milissegundos.
Retorna
Um ponteiro para uma matriz de entradas aNumBins que representam as informações do histograma coletadas.

Modelo de otThreadGetVendor

const char * otThreadGetVendorModel(
  otInstance *aInstance
)

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

Linha de execução de otThreadGet

const char * otThreadGetVendorName(
  otInstance *aInstance
)

Obtém a string do nome do fornecedor.

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

Versão da linha de execução otThreadGetVendorSw

const char * otThreadGetVendorSwVersion(
  otInstance *aInstance
)

Obtém a string da versão do fornecedor.

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

Versão da linha de execução otThread

uint16_t otThreadGetVersion(
  void
)

Obtém a versão do protocolo Thread.

Detalhes
Retorna
a versão do protocolo Thread.

ThreadThread

bool otThreadIsAnycastLocateInProgress(
  otInstance *aInstance
)

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

Disponível apenas 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.

ThreadThreadDiscover

bool otThreadIsDiscoverInProgress(
  otInstance *aInstance
)

Determina se uma descoberta de encadeamento do 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
É o único roteador na rede.
FALSE
É um filho ou não é um único roteador na rede.

otThreadFindAnycastDestination

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

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

Disponível apenas quando OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE está ativado.

Se uma solicitação anterior estiver em andamento, uma chamada subsequente para esta 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 DEVE ser NULL.
[in] aCallback
A função de retorno de chamada para relatar o resultado.
[in] aContext
Um contexto arbitrário usado com aCallback.
Valores de retorno
OT_ERROR_NONE
A solicitação foi iniciada. aCallback será invocado para relatar o resultado.
OT_ERROR_INVALID_ARGS
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 do 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 chamada ao receber uma mensagem de resposta pai do MLE.
[in] aContext
Um ponteiro para chamar o contexto específico do cliente.

Contadores otThreadResetIp6

void otThreadResetIp6Counters(
  otInstance *aInstance
)

Redefine os contadores IPv6.

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

otThreadResetMleCounters

void otThreadResetMleCounters(
  otInstance *aInstance
)

Redefine os contadores de Thread MLE.

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

ThreadThreadTimeInQueueStat

void otThreadResetTimeInQueueStat(
  otInstance *aInstance
)

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

Exige OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE.

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

ThreadThreadForBetterParent

otError otThreadSearchForBetterParent(
  otInstance *aInstance
)

Inicia o processo para a criança procurar um pai melhor enquanto permanece vinculado ao pai atual.

Precisa ser usado quando o dispositivo estiver conectado como uma criança.

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

ThreadThreadAddress

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

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

Disponível apenas 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 para enviar 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.

ThreadThreadDiagnosticGet

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

Envie uma solicitação 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 endereço de destino.
[in] aTlvTypes
Uma matriz de tipos de TLV de diagnóstico de rede.
[in] aCount
Número de tipos em aTlvTypes.
[in] aCallback
Um ponteiro para uma função chamada quando a resposta de recebimento de diagnóstico de rede é recebida ou NULL para desativar o callback.
[in] aCallbackContext
Um ponteiro para contexto específico do aplicativo.
Valores de retorno
OT_ERROR_NONE
Colocado na fila DIAG_GET.req.
OT_ERROR_NO_BUFS
Buffers de mensagem insuficientes disponíveis para enviar DIAG_GET.req.

ThreadThreadDiagnosticReset

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

Enviar uma solicitação de redefinição 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 endereço de destino.
[in] aTlvTypes
Uma matriz de tipos de TLV de diagnóstico de rede. No momento, somente o Tipo 9 é permitido.
[in] aCount
Número de tipos em aTlvTypes
Valores de retorno
OT_ERROR_NONE
Na fila, DIAG_RST.ntf.
OT_ERROR_NO_BUFS
Buffers de mensagem insuficientes disponíveis para enviar DIAG_RST.ntf.

OtThreadSendProactiveBackboneNotification

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

Envia uma mensagem proativa de backbone (PRO_BB.ntf) no link do Backbone.

Disponível apenas 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 com sucesso para o link de backbone.
OT_ERROR_NO_BUFS
Se não houver buffers de mensagem suficientes.

ThreadSetChildTimeout

void otThreadSetChildTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

Define o Thread Child Timeout (em segundos) usado ao operar na função Child.

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

ThreadSetDiscoveryRequestCallback

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 chamada ao receber uma mensagem de solicitação de descoberta de MLE.
[in] aContext
Um ponteiro para chamar o contexto específico do aplicativo.

ThreadSetDomainName

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

Define o nome de domínio do thread.

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

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

ThreadSetEnabled ativado

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 qualquer processo em andamento de desanexação iniciado por otThreadDetachGraceful(). O callback dele será chamado.

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

ThreadSetExtendedPanId

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

Define o código 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 código PAN estendido do IEEE 802.15.4.
Valores de retorno
OT_ERROR_NONE
O código PAN estendido foi definido.
OT_ERROR_INVALID_STATE
Os protocolos de linha de execução estão ativados.
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 Thread.

Disponível quando o OPENTHREAD_CONFIG_DUA_ENABLE está ativado.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aIid
Um ponteiro para "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 publicidade do combinador de linhas de execução ao descobrir a rede Thread.

O anúncio da Combinador de conversas é usado para permitir que um Combinador divulgue 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 proposta recém-proposta e para disponibilizar essas informações aos Comissários ou candidatos a Comissário sem interação humana.

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

ThreadSetKeySequenceCounter

void otThreadSetKeySequenceCounter(
  otInstance *aInstance,
  uint32_t aKeySequenceCounter
)

Define o thrKeySequenceCounter.

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

ThreadSetKeySwitchGuardTime

void otThreadSetKeySwitchGuardTime(
  otInstance *aInstance,
  uint32_t aKeySwitchGuardTime
)

Define o thrKeySwitchGuardTime (em horas).

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

ThreadSetMode

otError otThreadSetLinkMode(
  otInstance *aInstance,
  otLinkModeConfig aConfig
)

Definir a configuração do Modo de vinculação MLE.

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

ThreadThreadMeshLocalPrefix

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

Define o prefixo local da malha.

Só funciona quando os protocolos 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 malha.
Valores de retorno
OT_ERROR_NONE
O prefixo local da malha foi definido.
OT_ERROR_INVALID_STATE
Os protocolos de linha de execução estão ativados.

ThreadSetNetworkKey

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

Defina a chave de rede Thread.

Só funciona quando os protocolos 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
Chave de rede Thread definida.
OT_ERROR_INVALID_STATE
Os protocolos de linha de execução estão ativados.
Consulte também:
otThreadGetNetworkKey

ThreadSetNetworkKeyRef

otError otThreadSetNetworkKeyRef(
  otInstance *aInstance,
  otNetworkKeyRef aKeyRef
)

Defina a chave de rede Thread como otNetworkKeyRef.

Só funciona quando os protocolos 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.

O recurso de tempo de compilação OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE precisa estar 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
Chave de rede Thread definida.
OT_ERROR_INVALID_STATE
Os protocolos de linha de execução estão ativados.
Consulte também:
otThreadGetNetworkKeyRef

NomedaRedeConjunto

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

Defina o nome da rede Thread.

Só funciona quando os protocolos 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 linha de execução estão ativados.
Consulte também:
otThreadGetNetworkName

ThreadSetVendorVendor

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 UTF8).

ThreadSetVendorName

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
A 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 UTF8).

ThreadSetVendorVendorVersion

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 UTF8).

Macros

PRO_DURATION_STRING_SIZE

 OT_DURATION_STRING_SIZE 21

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

PR_JOINER_ADVDATA_MAX_LENGTH

 OT_JOINER_ADVDATA_MAX_LENGTH 64

Extensão máxima do valor dos anúncios de publicidade.

OT_NEIGHBOR_INFO_ITERATOR_INIT

 OT_NEIGHBOR_INFO_ITERATOR_INIT 0

Inicializador para otNeighborInfoIterator.

PR_NETWORK_BASE_TLV_MAX_LENGTH

 OT_NETWORK_BASE_TLV_MAX_LENGTH 254

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

OT_NETWORK_DATA_ITERATOR_INIT

 OT_NETWORK_DATA_ITERATOR_INIT 0

Valor para inicializar otNetworkDataIterator.

OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE

 OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE 3

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

OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT

 OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT 0

Inicializador para otNetworkDiagIterator.

PR_NETWORK_DIAGNOSTIC_MAX_THREAD_STACK_VERSION_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_THREAD_STACK_VERSION_TLV_LENGTH 64

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

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

PR_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH 32

Tamanho máximo do nome do fornecedor TLV.

PR_NETWORK_DIAGNOSTIC_MAX_VENDOR_SW_VERSION_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_SW_VERSION_TLV_LENGTH 16

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

OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES

 OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19

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

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

PR_SERVICE_DATA_MAX_SIZE

 OT_SERVICE_DATA_MAX_SIZE 252

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

Recursos

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