Geral

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

Resumo

Nota: As funções neste módulo requerem OPENTHREAD_FTD=1 ou OPENTHREAD_MTD=1 .

Enumerações
`anonymous enum { OT_SECURITY_POLICY_OBTAIN_MASTER_KEY = 1 << 7, OT_SECURITY_POLICY_NATIVE_COMMISSIONING = 1 << 6, OT_SECURITY_POLICY_ROUTERS = 1 << 5, OT_SECURITY_POLICY_EXTERNAL_COMMISSIONER = 1 << 4, OT_SECURITY_POLICY_BEACONS = 1 << 3 }`	enum Essa enumeração define os sinalizadores TLV da Política de Segurança.
anonymous enum { OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS = 0, OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS = 1, OT_NETWORK_DIAGNOSTIC_TLV_MODE = 2, OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT = 3, OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY = 4, OT_NETWORK_DIAGNOSTIC_TLV_ROUTE = 5, OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA = 6, OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA = 7, OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST = 8, OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS = 9, OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL = 14, OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE = 15, OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE = 16, OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES = 17, OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST = 18, OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT = 19 }	enum
`otDeviceRole { OT_DEVICE_ROLE_DISABLED = 0, OT_DEVICE_ROLE_DETACHED = 1, OT_DEVICE_ROLE_CHILD = 2, OT_DEVICE_ROLE_ROUTER = 3, OT_DEVICE_ROLE_LEADER = 4 }`	enum Representa uma função de dispositivo Thread.
otMeshcopTlvType { OT_MESHCOP_TLV_CHANNEL = 0, OT_MESHCOP_TLV_PANID = 1, OT_MESHCOP_TLV_EXTPANID = 2, OT_MESHCOP_TLV_NETWORKNAME = 3, OT_MESHCOP_TLV_PSKC = 4, OT_MESHCOP_TLV_MASTERKEY = 5, OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE = 6, OT_MESHCOP_TLV_MESHLOCALPREFIX = 7, OT_MESHCOP_TLV_STEERING_DATA = 8, OT_MESHCOP_TLV_BORDER_AGENT_RLOC = 9, OT_MESHCOP_TLV_COMMISSIONER_ID = 10, OT_MESHCOP_TLV_COMM_SESSION_ID = 11, OT_MESHCOP_TLV_SECURITYPOLICY = 12, OT_MESHCOP_TLV_GET = 13, OT_MESHCOP_TLV_ACTIVETIMESTAMP = 14, OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT = 15, OT_MESHCOP_TLV_STATE = 16, OT_MESHCOP_TLV_JOINER_DTLS = 17, OT_MESHCOP_TLV_JOINER_UDP_PORT = 18, OT_MESHCOP_TLV_JOINER_IID = 19, OT_MESHCOP_TLV_JOINER_RLOC = 20, OT_MESHCOP_TLV_JOINER_ROUTER_KEK = 21, OT_MESHCOP_TLV_PROVISIONING_URL = 32, OT_MESHCOP_TLV_VENDOR_NAME_TLV = 33, OT_MESHCOP_TLV_VENDOR_MODEL_TLV = 34, OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV = 35, OT_MESHCOP_TLV_VENDOR_DATA_TLV = 36, OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV = 37, OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV = 48, OT_MESHCOP_TLV_IPV6_ADDRESS_TLV = 49, OT_MESHCOP_TLV_PENDINGTIMESTAMP = 51, OT_MESHCOP_TLV_DELAYTIMER = 52, OT_MESHCOP_TLV_CHANNELMASK = 53, OT_MESHCOP_TLV_COUNT = 54, OT_MESHCOP_TLV_PERIOD = 55, OT_MESHCOP_TLV_SCAN_DURATION = 56, OT_MESHCOP_TLV_ENERGY_LIST = 57, OT_MESHCOP_TLV_DISCOVERYREQUEST = 128, OT_MESHCOP_TLV_DISCOVERYRESPONSE = 129, OT_MESHCOP_TLV_JOINERADVERTISEMENT = 241 }	enum Esta enumeração representa os tipos de TLV meshcop.
`otRoutePreference { OT_ROUTE_PREFERENCE_LOW = -1, OT_ROUTE_PREFERENCE_MED = 0, OT_ROUTE_PREFERENCE_HIGH = 1 }`	enum Define valores válidos para o membro mPreference em otExternalRouteConfig e otBorderRouterConfig .

Typedefs
`otBorderRouterConfig`	typedef `struct otBorderRouterConfig` Esta estrutura representa uma configuração do Border Router.
`otChannelMask`	typedef `uint32_t` Este tipo representa a máscara do canal.
`otExtendedPanId`	typedef `struct otExtendedPanId` Esta estrutura representa um PAN ID estendido.
`otExternalRouteConfig`	typedef `struct otExternalRouteConfig` Esta estrutura representa uma configuração de rota externa.
`otIpCounters`	typedef `struct otIpCounters` Esta estrutura representa os contadores de nível de IP.
`otLeaderData`	typedef `struct otLeaderData` Esta estrutura representa os dados do Thread Leader.
`otLinkModeConfig`	typedef `struct otLinkModeConfig` Esta estrutura representa uma configuração do modo de link MLE.
`otMasterKey`	typedef `struct otMasterKey` Esta estrutura representa uma Thread Master Key.
`otMeshLocalPrefix`	typedef `otIp6NetworkPrefix` Esta estrutura representa um prefixo local de malha.
`otMeshcopTlvType`	typedef `enum otMeshcopTlvType` Esta enumeração representa os tipos de TLV meshcop.
`otMleCounters`	typedef `struct otMleCounters` Esta estrutura representa os contadores Thread MLE.
`otNeighborInfoIterator`	typedef `int16_t` Usado para iterar por meio da tabela de vizinhos.
`otNetworkDataIterator`	typedef `uint32_t` Usado para iterar por meio de informações de dados de rede.
`otNetworkDiagChildEntry`	typedef `struct otNetworkDiagChildEntry` Essa estrutura representa uma entrada de tabela filho de diagnóstico de rede.
`otNetworkDiagConnectivity`	typedef `struct otNetworkDiagConnectivity` Esta estrutura representa um valor de conectividade de diagnóstico de rede.
`otNetworkDiagIterator`	typedef `uint16_t` Usado para iterar por meio do TLV de diagnóstico de rede.
`otNetworkDiagMacCounters`	typedef `struct otNetworkDiagMacCounters` Esta estrutura representa um valor de contadores Mac de diagnóstico de rede.
`otNetworkDiagRoute`	typedef `struct otNetworkDiagRoute` Esta estrutura representa um valor TLV de rota de diagnóstico de rede.
`otNetworkDiagRouteData`	typedef `struct otNetworkDiagRouteData` Esta estrutura representa os dados da rota de diagnóstico da rede.
`otNetworkDiagTlv`	typedef `struct otNetworkDiagTlv` Esta estrutura representa um TLV de diagnóstico de rede.
`otNetworkName`	typedef `struct otNetworkName` Esta estrutura representa um nome de rede.
`otOperationalDataset`	typedef `struct otOperationalDataset` Esta estrutura representa um conjunto de dados operacional ativo ou pendente.
`otOperationalDatasetComponents`	typedef `struct otOperationalDatasetComponents` Esta estrutura representa a presença de diferentes componentes no conjunto de dados operacional ativo ou pendente.
`otOperationalDatasetTlvs`	typedef `struct otOperationalDatasetTlvs` Esta estrutura representa um conjunto de dados operacional ativo ou pendente.
`otPskc`	typedef `struct otPskc` Esta estrutura representa um PSKc.
`otReceiveDiagnosticGetCallback )(otMessage aMessage, const otMessageInfo aMessageInfo, void *aContext)`	typedef `void(*` Este ponteiro de função é chamado quando a resposta Get de diagnóstico de rede é recebida.
`otRoutePreference`	typedef `enum otRoutePreference` Define valores válidos para o membro mPreference em otExternalRouteConfig e otBorderRouterConfig .
`otSecurityPolicy`	typedef `struct otSecurityPolicy` Esta estrutura representa a Política de Segurança.
`otServerConfig`	typedef `struct otServerConfig` Esta estrutura representa uma configuração de servidor.
`otServiceConfig`	typedef `struct otServiceConfig` Esta estrutura representa uma configuração de serviço.
`otThreadDiscoveryRequestCallback )(const otThreadDiscoveryRequestInfo aInfo, void aContext)`	typedef `void(*` Este ponteiro de função é chamado sempre que uma mensagem de solicitação de descoberta MLE é recebida.
`otThreadDiscoveryRequestInfo`	typedef `struct otThreadDiscoveryRequestInfo` Esta estrutura representa os dados do Thread Discovery Request.
`otThreadParentResponseCallback )(otThreadParentResponseInfo aInfo, void aContext)`	typedef `void(*` Este ponteiro de função é chamado toda vez que uma mensagem de resposta pai MLE é recebida.
`otThreadParentResponseInfo`	typedef `struct otThreadParentResponseInfo` Esta estrutura representa os dados da Resposta Pai MLE.

Variáveis
`OT_TOOL_PACKED_END`	`OT_TOOL_PACKED_BEGIN struct otMasterKey`

Funções
`otDatasetCreateNewNetwork ( otInstance aInstance, otOperationalDataset aDataset)`	`otError` Este método cria um novo conjunto de dados operacionais para usar ao formar uma nova rede.
`otDatasetGeneratePskc (const char aPassPhrase, const otNetworkName aNetworkName, const otExtendedPanId aExtPanId, otPskc aPskc)`	`otError` Esta função gera PSKc a partir de uma determinada frase-senha, nome de rede e PAN ID estendido.
`otDatasetGetActive ( otInstance aInstance, otOperationalDataset aDataset)`	`otError` Esta função obtém o conjunto de dados operacional ativo.
`otDatasetGetActiveTlvs ( otInstance aInstance, otOperationalDatasetTlvs aDataset)`	`otError` Esta função obtém o conjunto de dados operacional ativo.
`otDatasetGetDelayTimerMinimal ( otInstance *aInstance)`	`uint32_t` Obtenha temporizador de atraso mínimo.
`otDatasetGetPending ( otInstance aInstance, otOperationalDataset aDataset)`	`otError` Esta função obtém o conjunto de dados operacionais pendentes.
`otDatasetGetPendingTlvs ( otInstance aInstance, otOperationalDatasetTlvs aDataset)`	`otError` Esta função obtém o conjunto de dados operacionais pendentes.
`otDatasetIsCommissioned ( otInstance *aInstance)`	`bool` Esta função indica se uma rede válida está presente no Dataset Operacional Ativo ou não.
`otDatasetSendMgmtActiveGet ( otInstance aInstance, const otOperationalDatasetComponents aDatasetComponents, const uint8_t aTlvTypes, uint8_t aLength, const otIp6Address aAddress)`	`otError` Esta função envia MGMT_ACTIVE_GET.
`otDatasetSendMgmtActiveSet ( otInstance aInstance, const otOperationalDataset aDataset, const uint8_t *aTlvs, uint8_t aLength)`	`otError` Esta função envia MGMT_ACTIVE_SET.
`otDatasetSendMgmtPendingGet ( otInstance aInstance, const otOperationalDatasetComponents aDatasetComponents, const uint8_t aTlvTypes, uint8_t aLength, const otIp6Address aAddress)`	`otError` Esta função envia MGMT_PENDING_GET.
`otDatasetSendMgmtPendingSet ( otInstance aInstance, const otOperationalDataset aDataset, const uint8_t *aTlvs, uint8_t aLength)`	`otError` Esta função envia MGMT_PENDING_SET.
`otDatasetSetActive ( otInstance aInstance, const otOperationalDataset aDataset)`	`otError` Esta função define o conjunto de dados operacionais ativos.
`otDatasetSetActiveTlvs ( otInstance aInstance, const otOperationalDatasetTlvs aDataset)`	`otError` Esta função define o conjunto de dados operacionais ativos.
`otDatasetSetDelayTimerMinimal ( otInstance *aInstance, uint32_t aDelayTimerMinimal)`	`otError` Defina o temporizador de atraso mínimo.
`otDatasetSetPending ( otInstance aInstance, const otOperationalDataset aDataset)`	`otError` Esta função define o conjunto de dados operacionais pendentes.
`otDatasetSetPendingTlvs ( otInstance aInstance, const otOperationalDatasetTlvs aDataset)`	`otError` Esta função define o conjunto de dados operacionais pendentes.
`otNetDataGet ( otInstance aInstance, bool aStable, uint8_t aData, uint8_t *aDataLength)`	`otError` Este método fornece uma cópia completa ou estável dos Dados de Rede de Threads da Partição.
`otNetDataGetNextOnMeshPrefix ( otInstance aInstance, otNetworkDataIterator aIterator, otBorderRouterConfig *aConfig)`	`otError` Esta função obtém o próximo Prefixo On Mesh nos Dados de Rede da partição.
`otNetDataGetNextRoute ( otInstance aInstance, otNetworkDataIterator aIterator, otExternalRouteConfig *aConfig)`	`otError` Esta função obtém a próxima rota externa nos dados de rede da partição.
`otNetDataGetNextService ( otInstance aInstance, otNetworkDataIterator aIterator, otServiceConfig *aConfig)`	`otError` Esta função obtém o próximo serviço nos dados de rede da partição.
`otNetDataGetStableVersion ( otInstance *aInstance)`	`uint8_t` Obtenha a versão de dados de rede estável.
`otNetDataGetVersion ( otInstance *aInstance)`	`uint8_t` Obtenha a versão de dados da rede.
`otNetDataSteeringDataCheckJoiner ( otInstance aInstance, const otExtAddress aEui64)`	`otError` Verifique se os dados de direção incluem um marceneiro.
`otNetDataSteeringDataCheckJoinerWithDiscerner ( otInstance aInstance, const struct otJoinerDiscerner aDiscerner)`	`otError` Verifique se os dados de direção incluem um Joiner com um determinado valor de discerner.
`otThreadBecomeChild ( otInstance *aInstance)`	`otError` Tente se reconectar quando era criança.
`otThreadBecomeDetached ( otInstance *aInstance)`	`otError` Desconecte-se da rede Thread.
`otThreadDiscover ( otInstance aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void aCallbackContext)`	`otError` Esta função inicia uma varredura de descoberta de thread.
`otThreadGetChildTimeout ( otInstance *aInstance)`	`uint32_t` Obtenha o Thread Child Timeout usado ao operar na função Child.
`otThreadGetDeviceRole ( otInstance *aInstance)`	`otDeviceRole` Obtenha a função do dispositivo.
`otThreadGetDomainName ( otInstance *aInstance)`	`const char *` Obtenha o nome de domínio do thread.
`otThreadGetExtendedPanId ( otInstance *aInstance)`	`const otExtendedPanId *` Obtenha o PAN ID estendido IEEE 802.15.4.
`otThreadGetFixedDuaInterfaceIdentifier ( otInstance *aInstance)`	`const otIp6InterfaceIdentifier *` Obtenha o identificador de interface especificado manualmente para o endereço Unicast do domínio do thread.
`otThreadGetIp6Counters ( otInstance *aInstance)`	`const otIpCounters *` Obtenha os contadores IPv6.
`otThreadGetKeySequenceCounter ( otInstance *aInstance)`	`uint32_t` Obtenha o thrKeySequenceCounter.
`otThreadGetKeySwitchGuardTime ( otInstance *aInstance)`	`uint32_t` Obtenha o thrKeySwitchGuardTime.
`otThreadGetLeaderData ( otInstance aInstance, otLeaderData aLeaderData)`	`otError` Esta função obtém os dados do Thread Leader.
`otThreadGetLeaderRloc ( otInstance aInstance, otIp6Address aLeaderRloc)`	`otError` Esta função retorna um ponteiro para o RLOC do líder.
`otThreadGetLeaderRouterId ( otInstance *aInstance)`	`uint8_t` Obtenha a ID do roteador do líder.
`otThreadGetLeaderWeight ( otInstance *aInstance)`	`uint8_t` Obtenha o peso do líder.
`otThreadGetLinkLocalIp6Address ( otInstance *aInstance)`	`const otIp6Address *` Esta função retorna o endereço IPv6 local do link do thread.
`otThreadGetLinkMode ( otInstance *aInstance)`	`otLinkModeConfig` Obtenha a configuração do modo de link MLE.
`otThreadGetMasterKey ( otInstance *aInstance)`	`const otMasterKey *` Obtenha a thrMasterKey.
`otThreadGetMeshLocalEid ( otInstance *aInstance)`	`const otIp6Address *` Esta função retorna um ponteiro para o endereço EID local da malha.
`otThreadGetMeshLocalPrefix ( otInstance *aInstance)`	`const otMeshLocalPrefix *` Esta função retorna um ponteiro para o prefixo local da malha.
`otThreadGetMleCounters ( otInstance *aInstance)`	`const otMleCounters *` Obtenha os contadores Thread MLE.
`otThreadGetNetworkName ( otInstance *aInstance)`	`const char *` Obtenha o nome da rede do thread.
`otThreadGetNextDiagnosticTlv (const otMessage aMessage, otNetworkDiagIterator aIterator, otNetworkDiagTlv *aNetworkDiagTlv)`	`otError` Esta função obtém o próximo TLV de diagnóstico de rede na mensagem.
`otThreadGetNextNeighborInfo ( otInstance aInstance, otNeighborInfoIterator aIterator, otNeighborInfo *aInfo)`	`otError` Esta função obtém as informações do próximo vizinho.
`otThreadGetParentAverageRssi ( otInstance aInstance, int8_t aParentRssi)`	`otError` A função recupera o RSSI médio para o Thread Parent.
`otThreadGetParentInfo ( otInstance aInstance, otRouterInfo aParentInfo)`	`otError` A função recupera informações de diagnóstico para um Thread Router como pai.
`otThreadGetParentLastRssi ( otInstance aInstance, int8_t aLastRssi)`	`otError` A função recupera o RSSI do último pacote do Thread Parent.
`otThreadGetPartitionId ( otInstance *aInstance)`	`uint32_t` Obtenha o ID da partição.
`otThreadGetRloc ( otInstance *aInstance)`	`const otIp6Address *` Esta função retorna um ponteiro para o endereço Thread Routing Locator (RLOC).
`otThreadGetRloc16 ( otInstance *aInstance)`	`uint16_t` Obtenha o RLOC16.
`otThreadGetVersion (void)`	`uint16_t` Esta função obtém a versão do protocolo Thread.
`otThreadIsDiscoverInProgress ( otInstance *aInstance)`	`bool` Esta função determina se um MLE Thread Discovery está em andamento.
`otThreadIsSingleton ( otInstance *aInstance)`	`bool` Esta função indica se um nó é o único roteador na rede.
`otThreadRegisterParentResponseCallback ( otInstance aInstance, otThreadParentResponseCallback aCallback, void aContext)`	`void` Esta função registra um retorno de chamada para receber dados de resposta do pai MLE.
`otThreadResetIp6Counters ( otInstance *aInstance)`	`void` Redefina os contadores IPv6.
`otThreadResetMleCounters ( otInstance *aInstance)`	`void` Redefina os contadores Thread MLE.
`otThreadSendDiagnosticGet ( otInstance aInstance, const otIp6Address aDestination, const uint8_t aTlvTypes[], uint8_t aCount)`	`otError` Envie uma solicitação Get de diagnóstico de rede.
`otThreadSendDiagnosticReset ( otInstance aInstance, const otIp6Address aDestination, const uint8_t aTlvTypes[], uint8_t aCount)`	`otError` Envie uma solicitação de redefinição de diagnóstico de rede.
`otThreadSetChildTimeout ( otInstance *aInstance, uint32_t aTimeout)`	`void` Defina o Thread Child Timeout usado ao operar na função Child.
`otThreadSetDiscoveryRequestCallback ( otInstance aInstnace, otThreadDiscoveryRequestCallback aCallback, void aContext)`	`void` Esta função define um retorno de chamada para receber dados de solicitação de descoberta de MLE.
`otThreadSetDomainName ( otInstance aInstance, const char aDomainName)`	`otError` Defina o nome do domínio do thread.
`otThreadSetEnabled ( otInstance *aInstance, bool aEnabled)`	`otError` Esta função inicia a operação do protocolo Thread.
`otThreadSetExtendedPanId ( otInstance aInstance, const otExtendedPanId aExtendedPanId)`	`otError` Defina o PAN ID estendido IEEE 802.15.4.
`otThreadSetFixedDuaInterfaceIdentifier ( otInstance aInstance, const otIp6InterfaceIdentifier aIid)`	`otError` Definir / limpar o identificador de interface especificado manualmente para o endereço Unicast do domínio do thread.
`otThreadSetJoinerAdvertisement ( otInstance aInstance, uint32_t aOui, const uint8_t aAdvData, uint8_t aAdvDataLength)`	`otError` Este método define o Thread Joiner Advertising ao descobrir a rede Thread.
`otThreadSetKeySequenceCounter ( otInstance *aInstance, uint32_t aKeySequenceCounter)`	`void` Defina o thrKeySequenceCounter.
`otThreadSetKeySwitchGuardTime ( otInstance *aInstance, uint32_t aKeySwitchGuardTime)`	`void` Defina o thrKeySwitchGuardTime.
`otThreadSetLinkMode ( otInstance *aInstance, otLinkModeConfig aConfig)`	`otError` Defina a configuração do modo de link MLE.
`otThreadSetMasterKey ( otInstance aInstance, const otMasterKey aKey)`	`otError` Defina a thrMasterKey.
`otThreadSetMeshLocalPrefix ( otInstance aInstance, const otMeshLocalPrefix aMeshLocalPrefix)`	`otError` Esta função define o prefixo local da malha.
`otThreadSetNetworkName ( otInstance aInstance, const char aNetworkName)`	`otError` Defina o nome da rede do thread.
`otThreadSetReceiveDiagnosticGetCallback ( otInstance aInstance, otReceiveDiagnosticGetCallback aCallback, void aCallbackContext)`	`void` Esta função registra um retorno de chamada para fornecer carga útil de resposta Get de diagnóstico de rede bruto recebida.

Structs
otBorderRouterConfig	Esta estrutura representa uma configuração do Border Router.
otExtendedPanId	Esta estrutura representa um PAN ID estendido.
otExternalRouteConfig	Esta estrutura representa uma configuração de rota externa.
otIpCounters	Esta estrutura representa os contadores de nível de IP.
otLeaderData	Esta estrutura representa os dados do Thread Leader.
otLinkModeConfig	Esta estrutura representa uma configuração do modo de link MLE.
otMasterKey	Esta estrutura representa uma Thread Master Key.
otMleCounters	Esta estrutura representa os contadores Thread MLE.
otNeighborInfo	Esta estrutura contém informações de diagnóstico para um nó de Thread vizinho.
otNetworkDiagChildEntry	Essa estrutura representa uma entrada de tabela filho de diagnóstico de rede.
otNetworkDiagConnectivity	Esta estrutura representa um valor de conectividade de diagnóstico de rede.
otNetworkDiagMacCounters	Esta estrutura representa um valor de contadores Mac de diagnóstico de rede.
otNetworkDiagRoute	Esta estrutura representa um valor TLV de rota de diagnóstico de rede.
otNetworkDiagRouteData	Esta estrutura representa os dados da rota de diagnóstico da rede.
otNetworkDiagTlv	Esta estrutura representa um TLV de diagnóstico de rede.
otNetworkName	Esta estrutura representa um nome de rede.
otOperationalDataset	Esta estrutura representa um conjunto de dados operacional ativo ou pendente.
otOperationalDatasetComponents	Esta estrutura representa a presença de diferentes componentes no conjunto de dados operacionais ativos ou pendentes.
otOperationalDatasetTlvs	Esta estrutura representa um conjunto de dados operacional ativo ou pendente.
otPskc	Esta estrutura representa PSKc.
otRouterInfo	Esta estrutura contém informações de diagnóstico para um Thread Router.
otSecurityPolicy	Esta estrutura representa a Política de Segurança.
otServerConfig	Esta estrutura representa uma configuração de servidor.
otServiceConfig	Esta estrutura representa uma configuração de serviço.
otThreadDiscoveryRequestInfo	Esta estrutura representa os dados do Thread Discovery Request.
otThreadParentResponseInfo	Esta estrutura representa os dados da Resposta Pai MLE.

Enumerações

enum anônimo

 anonymous enum

Essa enumeração define os sinalizadores TLV da Política de Segurança.

Propriedades
`OT_SECURITY_POLICY_BEACONS`	Beacons ativados.
`OT_SECURITY_POLICY_EXTERNAL_COMMISSIONER`	Comissário externo permitido.
`OT_SECURITY_POLICY_NATIVE_COMMISSIONING`	Comissionamento nativo.
`OT_SECURITY_POLICY_OBTAIN_MASTER_KEY`	Obtendo a chave mestra.
`OT_SECURITY_POLICY_ROUTERS`	Roteadores habilitados.

enum anônimo

 anonymous enum

Propriedades
`OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL`	Nível da bateria TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES`	Páginas do canal TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE`	Tabela infantil TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY`	Conectividade TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS`	Endereço estendido MAC TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST`	Lista de endereços IPv6 TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA`	Dados do líder TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS`	Contadores MAC TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT`	Tempo limite máximo da criança TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_MODE`	Modo TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA`	Rede de dados TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_ROUTE`	Route64 TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS`	Address16 TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE`	Tensão de alimentação TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT`	Tempo limite TLV (o período máximo de pesquisa para SEDs)
`OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST`	Lista de tipos TLV.

otDeviceRole

 otDeviceRole

Representa uma função de dispositivo Thread.

Propriedades
`OT_DEVICE_ROLE_CHILD`	A função Thread Child.
`OT_DEVICE_ROLE_DETACHED`	Atualmente não participa de uma rede / partição Thread.
`OT_DEVICE_ROLE_DISABLED`	A pilha de threads está desativada.
`OT_DEVICE_ROLE_LEADER`	A função Thread Leader.
`OT_DEVICE_ROLE_ROUTER`	A função Thread Router.

otMeshcopTlvType

 otMeshcopTlvType

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

Propriedades
`OT_MESHCOP_TLV_ACTIVETIMESTAMP`	meshcop Active Timestamp TLV
`OT_MESHCOP_TLV_BORDER_AGENT_RLOC`	meshcop Border Agent Locator TLV
`OT_MESHCOP_TLV_CHANNEL`	meshcop Canal TLV
`OT_MESHCOP_TLV_CHANNELMASK`	máscara de canal meshcop TLV
`OT_MESHCOP_TLV_COMMISSIONER_ID`	meshcop Comissário ID TLV
`OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT`	meshcop Comissário UDP Porta TLV
`OT_MESHCOP_TLV_COMM_SESSION_ID`	meshcop Commissioner Session ID TLV
`OT_MESHCOP_TLV_COUNT`	meshcop contagem TLV
`OT_MESHCOP_TLV_DELAYTIMER`	meshcop Delay Timer TLV
`OT_MESHCOP_TLV_DISCOVERYREQUEST`	TLV de solicitação de descoberta de meshcop
`OT_MESHCOP_TLV_DISCOVERYRESPONSE`	TLV de resposta de descoberta meshcop
`OT_MESHCOP_TLV_ENERGY_LIST`	meshcop Lista de energia TLV
`OT_MESHCOP_TLV_EXTPANID`	meshcop Extended Pan Id TLV
`OT_MESHCOP_TLV_GET`	meshcop Obter TLV
`OT_MESHCOP_TLV_IPV6_ADDRESS_TLV`	endereço meshcop IPv6 TLV
`OT_MESHCOP_TLV_JOINERADVERTISEMENT`	meshcop Joiner Publicidade TLV
`OT_MESHCOP_TLV_JOINER_DTLS`	meshcop Joiner DTLS Encapsulation TLV
`OT_MESHCOP_TLV_JOINER_IID`	meshcop Joiner IID TLV
`OT_MESHCOP_TLV_JOINER_RLOC`	meshcop Joiner Router Locator TLV
`OT_MESHCOP_TLV_JOINER_ROUTER_KEK`	meshcop Joiner Router KEK TLV
`OT_MESHCOP_TLV_JOINER_UDP_PORT`	meshcop Joiner Porta UDP TLV
`OT_MESHCOP_TLV_MASTERKEY`	meshcop Chave mestra de rede TLV
`OT_MESHCOP_TLV_MESHLOCALPREFIX`	meshcop Mesh Local Prefix TLV
`OT_MESHCOP_TLV_NETWORKNAME`	meshcop Nome da rede TLV
`OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE`	TLV de sequência de chave de rede meshcop
`OT_MESHCOP_TLV_PANID`	meshcop Pan Id TLV
`OT_MESHCOP_TLV_PENDINGTIMESTAMP`	meshcop Pendente Timestamp TLV
`OT_MESHCOP_TLV_PERIOD`	meshcop Período TLV
`OT_MESHCOP_TLV_PROVISIONING_URL`	meshcop Provisioning URL TLV
`OT_MESHCOP_TLV_PSKC`	meshcop PSKc TLV
`OT_MESHCOP_TLV_SCAN_DURATION`	meshcop Scan Duração TLV
`OT_MESHCOP_TLV_SECURITYPOLICY`	Política de Segurança meshcop TLV
`OT_MESHCOP_TLV_STATE`	meshcop Estado TLV
`OT_MESHCOP_TLV_STEERING_DATA`	meshcop Dados de direção TLV
`OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV`	meshcop UDP encapsulamento TLV
`OT_MESHCOP_TLV_VENDOR_DATA_TLV`	Dados do fornecedor meshcop TLV
`OT_MESHCOP_TLV_VENDOR_MODEL_TLV`	Modelo de Fornecedor meshcop TLV
`OT_MESHCOP_TLV_VENDOR_NAME_TLV`	Nome do fornecedor meshcop TLV
`OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV`	meshcop Vendor Stack Versão TLV
`OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV`	meshcop Fornecedor Versão SW TLV

otRoutePreference

 otRoutePreference

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

Propriedades
`OT_ROUTE_PREFERENCE_HIGH`	Alta preferência de rota.
`OT_ROUTE_PREFERENCE_LOW`	Preferência de rota baixa.
`OT_ROUTE_PREFERENCE_MED`	Preferência de rota média.

Typedefs

otBorderRouterConfig

struct otBorderRouterConfig otBorderRouterConfig

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

otChannelMask

uint32_t otChannelMask

Este tipo representa a máscara do canal.

otExtendedPanId

struct otExtendedPanId otExtendedPanId

Esta estrutura representa um PAN ID estendido.

otExternalRouteConfig

struct otExternalRouteConfig otExternalRouteConfig

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

otIpCounters

struct otIpCounters otIpCounters

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

otLeaderData

struct otLeaderData otLeaderData

Esta estrutura representa os dados do Thread Leader.

otLinkModeConfig

struct otLinkModeConfig otLinkModeConfig

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

otMasterKey

struct otMasterKey otMasterKey

Esta estrutura representa uma Thread Master Key.

otMeshLocalPrefix

otIp6NetworkPrefix otMeshLocalPrefix

Esta estrutura representa um prefixo local de malha.

otMeshcopTlvType

enum otMeshcopTlvType otMeshcopTlvType

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

otMleCounters

struct otMleCounters otMleCounters

Esta estrutura representa os contadores Thread MLE.

otNeighborInfoIterator

int16_t otNeighborInfoIterator

Usado para iterar por meio da tabela de vizinhos.

otNetworkDataIterator

uint32_t otNetworkDataIterator

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

otNetworkDiagChildEntry

struct otNetworkDiagChildEntry otNetworkDiagChildEntry

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

otNetworkDiagConnectivity

struct otNetworkDiagConnectivity otNetworkDiagConnectivity

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

otNetworkDiagIterator

uint16_t otNetworkDiagIterator

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

otNetworkDiagMacCounters

struct otNetworkDiagMacCounters otNetworkDiagMacCounters

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

Consulte RFC 2863 para obter as definições dos campos de membro.

otNetworkDiagRoute

struct otNetworkDiagRoute otNetworkDiagRoute

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

otNetworkDiagRouteData

struct otNetworkDiagRouteData otNetworkDiagRouteData

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

otNetworkDiagTlv

struct otNetworkDiagTlv otNetworkDiagTlv

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

otNetworkName

struct otNetworkName otNetworkName

Esta estrutura representa um nome de rede.

otOperationalDataset

struct otOperationalDataset otOperationalDataset

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

Os componentes do conjunto de dados são opcionais. mComponets estrutura mComponets especifica quais componentes estão presentes no Dataset.

otOperationalDatasetComponents

struct otOperationalDatasetComponents otOperationalDatasetComponents

Esta estrutura representa a presença de diferentes componentes no conjunto de dados operacionais ativos ou pendentes.

otOperationalDatasetTlvs

struct otOperationalDatasetTlvs otOperationalDatasetTlvs

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

O conjunto de dados operacionais é codificado em TLV conforme especificado por Thread.

otPskc

struct otPskc otPskc

Esta estrutura representa um PSKc.

otReceiveDiagnosticGetCallback

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

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

Detalhes

Parâmetros

`[in] aMessage`	Um ponteiro para o buffer de mensagem que contém a carga útil de resposta Get de diagnóstico de rede recebida.
`[in] aMessageInfo`	Um ponteiro para as informações da mensagem para `aMessage` .
`[in] aContext`	Um ponteiro para o contexto específico do aplicativo.

otRoutePreference

enum otRoutePreference otRoutePreference

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

otSecurityPolicy

struct otSecurityPolicy otSecurityPolicy

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

otServerConfig

struct otServerConfig otServerConfig

Esta estrutura representa uma configuração de servidor.

otServiceConfig

struct otServiceConfig otServiceConfig

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

otThreadDiscoveryRequestCallback

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

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

Detalhes

Parâmetros

`[in] aInfo`	Um ponteiro para os dados de informações da solicitação de descoberta.
`[in] aContext`	Um ponteiro para o contexto específico do aplicativo de retorno de chamada.

otThreadDiscoveryRequestInfo

struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo

Esta estrutura representa os dados do Thread Discovery Request.

otThreadParentResponseCallback

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

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

Detalhes

Parâmetros

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

otThreadParentResponseInfo

struct otThreadParentResponseInfo otThreadParentResponseInfo

Esta estrutura representa os dados da Resposta Pai MLE.

Variáveis

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otMasterKey OT_TOOL_PACKED_END

Funções

otDatasetCreateNewNetwork

otError otDatasetCreateNewNetwork(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Este método cria um novo conjunto de dados operacionais para usar ao formar uma nova rede.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[out] aDataset`	O conjunto de dados operacionais.

Valores Retornados

`OT_ERROR_NONE`	Criado com sucesso um novo conjunto de dados operacionais.
`OT_ERROR_FAILED`	Falha ao gerar valores aleatórios para novos parâmetros.

otDatasetGeneratePskc

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

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

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

Detalhes

Parâmetros

`[in] aPassPhrase`	A frase-senha de comissionamento.
`[in] aNetworkName`	O nome da rede para computação PSKc.
`[in] aExtPanId`	O PAN ID estendido para computação PSKc.
`[out] aPskc`	Um ponteiro para a variável de saída do PSKc gerado.

Valores Retornados

`OT_ERROR_NONE`	Gerar PSKc com sucesso.
`OT_ERROR_INVALID_ARGS`	Se algum dos argumentos de entrada for inválido.

otDatasetGetActive

otError otDatasetGetActive(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

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

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[out] aDataset`	Um ponteiro para onde o conjunto de dados operacional ativo será colocado.

Valores Retornados

`OT_ERROR_NONE`	O conjunto de dados operacional ativo foi recuperado com sucesso.
`OT_ERROR_NOT_FOUND`	Nenhum valor correspondente no armazenamento de configuração.

otDatasetGetActiveTlvs

otError otDatasetGetActiveTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

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

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[out] aDataset`	Um ponteiro para onde o conjunto de dados operacional ativo será colocado.

Valores Retornados

`OT_ERROR_NONE`	O conjunto de dados operacional ativo foi recuperado com sucesso.
`OT_ERROR_NOT_FOUND`	Nenhum valor correspondente no armazenamento de configuração.

otDatasetGetDelayTimerMinimal

uint32_t otDatasetGetDelayTimerMinimal(
  otInstance *aInstance
)

Obtenha temporizador de atraso mínimo.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Valores Retornados

the

valor do temporizador de atraso mínimo (em ms).

otDatasetGetPending

otError otDatasetGetPending(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Esta função obtém o conjunto de dados operacionais pendentes.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[out] aDataset`	Um ponteiro para onde o conjunto de dados operacionais pendentes será colocado.

Valores Retornados

`OT_ERROR_NONE`	O conjunto de dados operacional pendente foi recuperado com êxito.
`OT_ERROR_NOT_FOUND`	Nenhum valor correspondente no armazenamento de configuração.

otDatasetGetPendingTlvs

otError otDatasetGetPendingTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

Esta função obtém o conjunto de dados operacionais pendentes.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[out] aDataset`	Um ponteiro para onde o conjunto de dados operacionais pendentes será colocado.

Valores Retornados

`OT_ERROR_NONE`	O conjunto de dados operacional pendente foi recuperado com êxito.
`OT_ERROR_NOT_FOUND`	Nenhum valor correspondente no armazenamento de configuração.

otDatasetIsCommissioned

bool otDatasetIsCommissioned(
  otInstance *aInstance
)

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

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

TRUE se uma rede válida estiver presente no Active Operational Dataset, FALSE caso contrário.

otDatasetSendMgmtActiveGet

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

Esta função envia MGMT_ACTIVE_GET.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aDatasetComponents`	Um ponteiro para uma estrutura de Componentes do Conjunto de Dados especificando quais componentes solicitar.
`[in] aTlvTypes`	Um ponteiro para uma matriz contendo tipos TLV brutos adicionais a serem solicitados.
`[in] aLength`	O comprimento de `aTlvTypes` .
`[in] aAddress`	Um ponteiro para o destino IPv6, se for NULL, usará Leader ALOC como padrão.

Valores Retornados

`OT_ERROR_NONE`	Envie com sucesso o comando meshcop dataset.
`OT_ERROR_NO_BUFS`	Espaço de buffer insuficiente para enviar.

otDatasetSendMgmtActiveSet

otError otDatasetSendMgmtActiveSet(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength
)

Esta função envia MGMT_ACTIVE_SET.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aDataset`	Um ponteiro para um conjunto de dados operacional.
`[in] aTlvs`	Um ponteiro para TLVs.
`[in] aLength`	O comprimento dos TLVs.

Valores Retornados

`OT_ERROR_NONE`	Envie com sucesso o comando meshcop dataset.
`OT_ERROR_NO_BUFS`	Espaço de buffer insuficiente para enviar.

otDatasetSendMgmtPendingGet

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

Esta função envia MGMT_PENDING_GET.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aDatasetComponents`	Um ponteiro para uma estrutura de Componentes do Conjunto de Dados especificando quais componentes solicitar.
`[in] aTlvTypes`	Um ponteiro para uma matriz contendo tipos TLV brutos adicionais a serem solicitados.
`[in] aLength`	O comprimento de `aTlvTypes` .
`[in] aAddress`	Um ponteiro para o destino IPv6, se for NULL, usará Leader ALOC como padrão.

Valores Retornados

`OT_ERROR_NONE`	Envie com sucesso o comando meshcop dataset.
`OT_ERROR_NO_BUFS`	Espaço de buffer insuficiente para enviar.

otDatasetSendMgmtPendingSet

otError otDatasetSendMgmtPendingSet(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength
)

Esta função envia MGMT_PENDING_SET.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aDataset`	Um ponteiro para um conjunto de dados operacional.
`[in] aTlvs`	Um ponteiro para TLVs.
`[in] aLength`	O comprimento dos TLVs.

Valores Retornados

`OT_ERROR_NONE`	Envie com sucesso o comando meshcop dataset.
`OT_ERROR_NO_BUFS`	Espaço de buffer insuficiente para enviar.

otDatasetSetActive

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

Esta função define o conjunto de dados operacionais ativos.

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

Se Thread estiver habilitado em um dispositivo que possui um conjunto de dados ativo parcialmente completo, o dispositivo tentará se conectar a uma rede Thread existente usando qualquer informação existente no conjunto de dados. Apenas a Thread Master Key é necessária para conectar a uma rede.

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

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

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aDataset`	Um ponteiro para o conjunto de dados operacional ativo.

Valores Retornados

`OT_ERROR_NONE`	Defina com êxito o conjunto de dados operacional ativo.
`OT_ERROR_NO_BUFS`	Espaço de buffer insuficiente para definir o conjunto de dados operacional ativo.
`OT_ERROR_NOT_IMPLEMENTED`	A plataforma não implementa a funcionalidade de configurações.

otDatasetSetActiveTlvs

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

Esta função define o conjunto de dados operacionais ativos.

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

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

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

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aDataset`	Um ponteiro para o conjunto de dados operacional ativo.

Valores Retornados

`OT_ERROR_NONE`	Defina com êxito o conjunto de dados operacional ativo.
`OT_ERROR_NO_BUFS`	Espaço de buffer insuficiente para definir o conjunto de dados operacional ativo.
`OT_ERROR_NOT_IMPLEMENTED`	A plataforma não implementa a funcionalidade de configurações.

otDatasetSetDelayTimerMinimal

otError otDatasetSetDelayTimerMinimal(
  otInstance *aInstance,
  uint32_t aDelayTimerMinimal
)

Defina o temporizador de atraso mínimo.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aDelayTimerMinimal`	O valor do temporizador de atraso mínimo (em ms).

Valores Retornados

`OT_ERROR_NONE`	Defina o temporizador de atraso mínimo com êxito.
`OT_ERROR_INVALID_ARGS`	Se `aDelayTimerMinimal` não for válido.

otDatasetSetPending

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

Esta função define o conjunto de dados operacionais pendentes.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aDataset`	Um ponteiro para o conjunto de dados operacionais pendentes.

Valores Retornados

`OT_ERROR_NONE`	Defina com sucesso o conjunto de dados operacionais pendentes.
`OT_ERROR_NO_BUFS`	Espaço de buffer insuficiente para definir o conjunto de dados operacionais pendentes.
`OT_ERROR_NOT_IMPLEMENTED`	A plataforma não implementa a funcionalidade de configurações.

otDatasetSetPendingTlvs

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

Esta função define o conjunto de dados operacionais pendentes.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aDataset`	Um ponteiro para o conjunto de dados operacionais pendentes.

Valores Retornados

`OT_ERROR_NONE`	Defina com sucesso o conjunto de dados operacionais pendentes.
`OT_ERROR_NO_BUFS`	Espaço de buffer insuficiente para definir o conjunto de dados operacionais pendentes.
`OT_ERROR_NOT_IMPLEMENTED`	A plataforma não implementa a funcionalidade de configurações.

otNetDataGet

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

Este método fornece uma cópia completa ou estável dos Dados de Rede de Threads da Partição.

Detalhes

Parâmetros

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

otNetDataGetNextOnMeshPrefix

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

Esta função obtém o próximo Prefixo On Mesh nos Dados de Rede da partição.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in,out] aIterator`	Um ponteiro para o contexto do iterador de dados de rede. Para obter a primeira entrada na malha, ela deve ser definida como OT_NETWORK_DATA_ITERATOR_INIT.
`[out] aConfig`	Um ponteiro para onde as informações do prefixo On Mesh serão colocadas.

Valores Retornados

`OT_ERROR_NONE`	O próximo prefixo On Mesh foi encontrado com sucesso.
`OT_ERROR_NOT_FOUND`	Não existe nenhum prefixo On Mesh subsequente nos Dados da Rede de Threads.

otNetDataGetNextRoute

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

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

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in,out] aIterator`	Um ponteiro para o contexto do iterador de dados de rede. Para obter a primeira entrada de rota externa, ela deve ser definida como OT_NETWORK_DATA_ITERATOR_INIT.
`[out] aConfig`	Um ponteiro para onde as informações de rota externa serão colocadas.

Valores Retornados

`OT_ERROR_NONE`	Encontrada com sucesso a próxima rota externa.
`OT_ERROR_NOT_FOUND`	Nenhuma entrada de rota externa subsequente existe nos dados de rede do segmento.

otNetDataGetNextService

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

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

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in,out] aIterator`	Um ponteiro para o contexto do iterador de dados de rede. Para obter a primeira entrada de serviço, deve ser definido como OT_NETWORK_DATA_ITERATOR_INIT.
`[out] aConfig`	Um ponteiro para onde as informações do serviço serão colocadas.

Valores Retornados

`OT_ERROR_NONE`	Encontrado com sucesso o próximo serviço.
`OT_ERROR_NOT_FOUND`	Nenhum serviço subsequente existe nos dados de rede da partição.

otNetDataGetStableVersion

uint8_t otNetDataGetStableVersion(
  otInstance *aInstance
)

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

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

A versão de dados de rede estável.

otNetDataGetVersion

uint8_t otNetDataGetVersion(
  otInstance *aInstance
)

Obtenha a versão de dados da rede.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

A versão de dados da rede.

otNetDataSteeringDataCheckJoiner

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

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

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aEui64`	Um ponteiro para o IEEE EUI-64 do marceneiro.

Valores Retornados

`OT_ERROR_NONE`	`aEui64` está incluído nos dados de direção.
`OT_ERROR_INVALID_STATE`	Nenhum dado de direção presente.
`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 direção incluem um Joiner com um determinado valor de discerner.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aDiscerner`	Um ponteiro para o Discerner Joiner.

Valores Retornados

`OT_ERROR_NONE`	`aDiscerner` está incluído nos dados de direção.
`OT_ERROR_INVALID_STATE`	Nenhum dado de direção presente.
`OT_ERROR_NOT_FOUND`	`aDiscerner` não está incluído nos dados de direção.

otThreadBecomeChild

otError otThreadBecomeChild(
  otInstance *aInstance
)

Tente reconectar quando criança.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Valores Retornados

`OT_ERROR_NONE`	Comece com sucesso a tentativa de se tornar uma criança.
`OT_ERROR_INVALID_STATE`	O tópico está desativado.

otThreadBecomeDetached

otError otThreadBecomeDetached(
  otInstance *aInstance
)

Desconecte-se da rede Thread.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Valores Retornados

`OT_ERROR_NONE`	Separado com sucesso da rede Thread.
`OT_ERROR_INVALID_STATE`	O tópico está desativado.

otThreadDiscover

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

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

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in] aScanChannels`	Um vetor de bit que indica quais canais fazer a varredura (por exemplo, OT_CHANNEL_11_MASK).
`[in] aPanId`	O filtro PAN ID (definido para Broadcast PAN para desabilitar o filtro).
`[in] aJoiner`	Valor do Sinalizador de Joiner no TLV de Solicitação de Descoberta.
`[in] aEnableEui64Filtering`	TRUE para filtrar respostas em EUI-64, FALSE caso contrário.
`[in] aCallback`	Um ponteiro para uma função chamada ao receber uma resposta de descoberta MLE ou varredura é concluída.
`[in] aCallbackContext`	Um ponteiro para o contexto específico do aplicativo.

Valores Retornados

`OT_ERROR_NONE`	Aceita a solicitação de descoberta de thread.
`OT_ERROR_BUSY`	Já realizando uma descoberta de thread.

otThreadGetChildTimeout

uint32_t otThreadGetChildTimeout(
  otInstance *aInstance
)

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

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

O valor do Tempo limite do filho do thread em segundos.

Veja também:
otThreadSetChildTimeout

otThreadGetDeviceRole

otDeviceRole otThreadGetDeviceRole(
  otInstance *aInstance
)

Obtenha a função do dispositivo.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Valores Retornados

`OT_DEVICE_ROLE_DISABLED`	A pilha de threads está desativada.
`OT_DEVICE_ROLE_DETACHED`	O dispositivo não está atualmente participando de uma rede / partição Thread.
`OT_DEVICE_ROLE_CHILD`	O dispositivo está operando atualmente como um Thread Child.
`OT_DEVICE_ROLE_ROUTER`	O dispositivo está operando atualmente como um Thread Router.
`OT_DEVICE_ROLE_LEADER`	O dispositivo está operando atualmente como Thread Leader.

otThreadGetDomainName

const char * otThreadGetDomainName(
  otInstance *aInstance
)

Obtenha o nome de domínio do thread.

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

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

Um ponteiro para o Thread Domain Name.

Veja também:
otThreadSetDomainName

otThreadGetExtendedPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

Obtenha o PAN ID estendido IEEE 802.15.4.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

Um ponteiro para o PAN ID estendido IEEE 802.15.4.

Veja também:
otThreadSetExtendedPanId

otThreadGetFixedDuaInterfaceIdentifier

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
  otInstance *aInstance
)

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

Esta função está disponível apenas a partir do Thread 1.2 quando OPENTHREAD_CONFIG_DUA_ENABLE está habilitado.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

Um ponteiro para o Identificador de interface que foi definido manualmente ou NULL se nenhum foi definido.

Veja também:
otThreadSetFixedDuaInterfaceIdentifier

otThreadGetIp6Counters

const otIpCounters * otThreadGetIp6Counters(
  otInstance *aInstance
)

Obtenha os contadores IPv6.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

Um ponteiro para os contadores IPv6.

otThreadGetKeySequenceCounter

uint32_t otThreadGetKeySequenceCounter(
  otInstance *aInstance
)

Obtenha o thrKeySequenceCounter.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

O valor thrKeySequenceCounter.

Veja também:
otThreadSetKeySequenceCounter

otThreadGetKeySwitchGuardTime

uint32_t otThreadGetKeySwitchGuardTime(
  otInstance *aInstance
)

Obtenha o thrKeySwitchGuardTime.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

O valor thrKeySwitchGuardTime (em horas).

Veja também:
otThreadSetKeySwitchGuardTime

otThreadGetLeaderData

otError otThreadGetLeaderData(
  otInstance *aInstance,
  otLeaderData *aLeaderData
)

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

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[out] aLeaderData`	Um ponteiro para onde os dados do líder são colocados.

Valores Retornados

`OT_ERROR_NONE`	Recuperado com sucesso os dados do líder.
`OT_ERROR_DETACHED`	Atualmente não anexado.

otThreadGetLeaderRloc

otError otThreadGetLeaderRloc(
  otInstance *aInstance,
  otIp6Address *aLeaderRloc
)

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

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[out] aLeaderRloc`	Um indicador para o RLOC do líder.

Valores Retornados

`OT_ERROR_NONE`	O RLOC do líder foi gravado com sucesso em `aLeaderRloc` .
`OT_ERROR_INVALID_ARGS`	`aLeaderRloc` era NULL.
`OT_ERROR_DETACHED`	Atualmente não anexado a uma partição de thread.

otThreadGetLeaderRouterId

uint8_t otThreadGetLeaderRouterId(
  otInstance *aInstance
)

Obtenha a ID do roteador do líder.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

O ID do roteador do líder.

otThreadGetLeaderWeight

uint8_t otThreadGetLeaderWeight(
  otInstance *aInstance
)

Obtenha o peso do líder.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

O peso do líder.

otThreadGetLinkLocalIp6Address

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

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

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

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

Um ponteiro para o endereço IPv6 local do link do thread.

otThreadGetLinkMode

otLinkModeConfig otThreadGetLinkMode(
  otInstance *aInstance
)

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

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

A configuração do modo de link MLE.

Veja também:
otThreadSetLinkMode

otThreadGetMasterKey

const otMasterKey * otThreadGetMasterKey(
  otInstance *aInstance
)

Obtenha a thrMasterKey.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

Um ponteiro para um buffer que contém a thrMasterKey.

Veja também:
otThreadSetMasterKey

otThreadGetMeshLocalEid

const otIp6Address * otThreadGetMeshLocalEid(
  otInstance *aInstance
)

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

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

Um ponteiro para o endereço EID local da malha.

otThreadGetMeshLocalPrefix

const otMeshLocalPrefix * otThreadGetMeshLocalPrefix(
  otInstance *aInstance
)

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

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

Um ponteiro para o prefixo local da malha.

otThreadGetMleCounters

const otMleCounters * otThreadGetMleCounters(
  otInstance *aInstance
)

Obtenha os contadores Thread MLE.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

Um ponteiro para os contadores Thread MLE.

otThreadGetNetworkName

const char * otThreadGetNetworkName(
  otInstance *aInstance
)

Obtenha o nome da rede do thread.

Detalhes

Parâmetros

[in] aInstance

Um ponteiro para uma instância OpenThread.

Devoluções

Um ponteiro para o Thread Network Name.

Veja também:
otThreadSetNetworkName

otThreadGetNextDiagnosticTlv

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

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

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

Detalhes

Parâmetros

`[in] aMessage`	Um ponteiro para uma mensagem.
`[in,out] aIterator`	Um ponteiro para o contexto do iterador de diagnóstico de rede. Para obter o primeiro TLV de diagnóstico de rede, ele deve ser definido como OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT.
`[out] aNetworkDiagTlv`	Um ponteiro para onde as informações do TLV de diagnóstico de rede serão colocadas.

Valores Retornados

`OT_ERROR_NONE`	Encontrado com sucesso o próximo TLV de diagnóstico de rede.
`OT_ERROR_NOT_FOUND`	Nenhum TLV de diagnóstico de rede subsequente existe na mensagem.
`OT_ERROR_PARSE`	A análise do próximo diagnóstico de rede falhou.

otThreadGetNextNeighborInfo

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

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

É usado para percorrer as entradas da tabela de vizinhos.

Detalhes

Parâmetros

`[in] aInstance`	Um ponteiro para uma instância OpenThread.
`[in,out] aIterator`	Um ponteiro para o contexto do iterador. Para obter a primeira entrada de vizinho, ela deve ser definida como OT_NEIGHBOR_INFO_ITERATOR_INIT.
`[out] aInfo`	Um ponteiro para as informações do vizinho.

Valores Retornados

`OT_ERROR_NONE`	Encontrada com sucesso a próxima entrada de vizinho na tabela.
`OT_ERROR_NOT_FOUND`	Nenhuma entrada subsequente de vizinho existe na tabela.
`OT_ERROR_INVALID_ARGS`	`aIterator` ou `aInfo` era NULL.

otThreadGetParentA AverageRssi

otError otThreadGetParentAverageRssi(
  otInstance *aInstance,
  int8_t *aParentRssi
)

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

Detalhes

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[out] aParentRssi`	A pointer to where the parent RSSI should be placed.

otThreadGetParentInfo

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

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

Details

Parameters

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

otThreadGetParentLastRssi

otError otThreadGetParentLastRssi(
  otInstance *aInstance,
  int8_t *aLastRssi
)

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

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[out] aLastRssi`	A pointer to where the last RSSI should be placed.

Return Values

`OT_ERROR_NONE`	Successfully retrieved the RSSI data.
`OT_ERROR_FAILED`	Unable to get RSSI data.
`OT_ERROR_INVALID_ARGS`	`aLastRssi` is NULL.

otThreadGetPartitionId

uint32_t otThreadGetPartitionId(
  otInstance *aInstance
)

Get the Partition ID.

Details

Parameters

[in] aInstance

A pointer to an OpenThread instance.

Returns

The Partition ID.

otThreadGetRloc

const otIp6Address * otThreadGetRloc(
  otInstance *aInstance
)

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

Details

Parameters

[in] aInstance

A pointer to an OpenThread instance.

Returns

A pointer to the Thread Routing Locator (RLOC) address.

otThreadGetRloc16

uint16_t otThreadGetRloc16(
  otInstance *aInstance
)

Get the RLOC16.

Details

Parameters

[in] aInstance

A pointer to an OpenThread instance.

Returns

The RLOC16.

otThreadGetVersion

uint16_t otThreadGetVersion(
  void
)

This function gets the Thread protocol version.

Details
Returns	the Thread protocol version.

otThreadIsDiscoverInProgress

bool otThreadIsDiscoverInProgress(
  otInstance *aInstance
)

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

Details

Parameters

[in] aInstance

A pointer to an OpenThread instance.

otThreadIsSingleton

bool otThreadIsSingleton(
  otInstance *aInstance
)

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

Details

Parameters

[in] aInstance

A pointer to an OpenThread instance.

Return Values

`TRUE`	It is the only router in the network.
`FALSE`	It is a child or is not a single router in the network.

otThreadRegisterParentResponseCallback

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

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

Details

Parameters

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

otThreadResetIp6Counters

void otThreadResetIp6Counters(
  otInstance *aInstance
)

Reset the IPv6 counters.

Details

Parameters

[in] aInstance

A pointer to an OpenThread instance.

otThreadResetMleCounters

void otThreadResetMleCounters(
  otInstance *aInstance
)

Reset the Thread MLE counters.

Details

Parameters

[in] aInstance

A pointer to an OpenThread instance.

otThreadSendDiagnosticGet

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

Send a Network Diagnostic Get request.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aDestination`	A pointer to destination address.
`[in] aTlvTypes`	An array of Network Diagnostic TLV types.
`[in] aCount`	Number of types in aTlvTypes.

Return Values

`OT_ERROR_NONE`	Successfully queued the DIAG_GET.req.
`OT_ERROR_NO_BUFS`	Insufficient message buffers available to send DIAG_GET.req.

otThreadSendDiagnosticReset

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

Send a Network Diagnostic Reset request.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aDestination`	A pointer to destination address.
`[in] aTlvTypes`	An array of Network Diagnostic TLV types. Currently only Type 9 is allowed.
`[in] aCount`	Number of types in aTlvTypes

Return Values

`OT_ERROR_NONE`	Successfully queued the DIAG_RST.ntf.
`OT_ERROR_NO_BUFS`	Insufficient message buffers available to send DIAG_RST.ntf.

otThreadSetChildTimeout

void otThreadSetChildTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

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

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aTimeout`	The timeout value in seconds.

See also:
otThreadGetChildTimeout

otThreadSetDiscoveryRequestCallback

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

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

Details

Parameters

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

otThreadSetDomainName

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

Set the Thread Domain Name.

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

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aDomainName`	A pointer to the Thread Domain Name.

Return Values

`OT_ERROR_NONE`	Successfully set the Thread Domain Name.
`OT_ERROR_INVALID_STATE`	Thread protocols are enabled.

See also:
otThreadGetDomainName

otThreadSetEnabled

otError otThreadSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

This function starts Thread protocol operation.

The interface must be up when calling this function.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aEnabled`	TRUE if Thread is enabled, FALSE otherwise.

Return Values

`OT_ERROR_NONE`	Successfully started Thread protocol operation.
`OT_ERROR_INVALID_STATE`	The network interface was not not up.

otThreadSetExtendedPanId

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

Set the IEEE 802.15.4 Extended PAN ID.

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

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aExtendedPanId`	A pointer to the IEEE 802.15.4 Extended PAN ID.

Return Values

`OT_ERROR_NONE`	Successfully set the Extended PAN ID.
`OT_ERROR_INVALID_STATE`	Thread protocols are enabled.

See also:
otThreadGetExtendedPanId

otThreadSetFixedDuaInterfaceIdentifier

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

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

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

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aIid`	A pointer to the Interface Identifier to set or NULL to clear.

Return Values

`OT_ERROR_NONE`	Successfully set/cleared the Interface Identifier.
`OT_ERROR_INVALID_ARGS`	The specified Interface Identifier is reserved.

See also:
otThreadGetFixedDuaInterfaceIdentifier

otThreadSetJoinerAdvertisement

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

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

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

Details

Parameters

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

Return Values

`OT_ERROR_NONE`	Successfully set Joiner Advertisement.
`OT_ERROR_INVALID_ARGS`	Invalid AdvData.

otThreadSetKeySequenceCounter

void otThreadSetKeySequenceCounter(
  otInstance *aInstance,
  uint32_t aKeySequenceCounter
)

Set the thrKeySequenceCounter.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aKeySequenceCounter`	The thrKeySequenceCounter value.

See also:
otThreadGetKeySequenceCounter

otThreadSetKeySwitchGuardTime

void otThreadSetKeySwitchGuardTime(
  otInstance *aInstance,
  uint32_t aKeySwitchGuardTime
)

Set the thrKeySwitchGuardTime.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aKeySwitchGuardTime`	The thrKeySwitchGuardTime value (in hours).

See also:
otThreadGetKeySwitchGuardTime

otThreadSetLinkMode

otError otThreadSetLinkMode(
  otInstance *aInstance,
  otLinkModeConfig aConfig
)

Set the MLE Link Mode configuration.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aConfig`	A pointer to the Link Mode configuration.

Return Values

OT_ERROR_NONE

Successfully set the MLE Link Mode configuration.

See also:
otThreadGetLinkMode

otThreadSetMasterKey

otError otThreadSetMasterKey(
  otInstance *aInstance,
  const otMasterKey *aKey
)

Set the thrMasterKey.

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

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aKey`	A pointer to a buffer containing the thrMasterKey.

Return Values

`OT_ERROR_NONE`	Successfully set the thrMasterKey.
`OT_ERROR_INVALID_ARGS`	If aKeyLength is larger than 16.
`OT_ERROR_INVALID_STATE`	Thread protocols are enabled.

See also:
otThreadGetMasterKey

otThreadSetMeshLocalPrefix

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

This function sets the Mesh Local Prefix.

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

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aMeshLocalPrefix`	A pointer to the Mesh Local Prefix.

Return Values

`OT_ERROR_NONE`	Successfully set the Mesh Local Prefix.
`OT_ERROR_INVALID_STATE`	Thread protocols are enabled.

otThreadSetNetworkName

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

Set the Thread Network Name.

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

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aNetworkName`	A pointer to the Thread Network Name.

Return Values

`OT_ERROR_NONE`	Successfully set the Thread Network Name.
`OT_ERROR_INVALID_STATE`	Thread protocols are enabled.

See also:
otThreadGetNetworkName

otThreadSetReceiveDiagnosticGetCallback

void otThreadSetReceiveDiagnosticGetCallback(
  otInstance *aInstance,
  otReceiveDiagnosticGetCallback aCallback,
  void *aCallbackContext
)

This function registers a callback to provide received raw Network Diagnostic Get response payload.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aCallback`	A pointer to a function that is called when Network Diagnostic Get response is received or NULL to disable the callback.
`[in] aCallbackContext`	A pointer to application-specific context.

Macros

OT_CHANNEL_10_MASK

 OT_CHANNEL_10_MASK (1 << 10)

Channel 10.

OT_CHANNEL_11_MASK

 OT_CHANNEL_11_MASK (1 << 11)

Channel 11.

OT_CHANNEL_12_MASK

 OT_CHANNEL_12_MASK (1 << 12)

Channel 12.

OT_CHANNEL_13_MASK

 OT_CHANNEL_13_MASK (1 << 13)

Channel 13.

OT_CHANNEL_14_MASK

 OT_CHANNEL_14_MASK (1 << 14)

Channel 14.

OT_CHANNEL_15_MASK

 OT_CHANNEL_15_MASK (1 << 15)

Channel 15.

OT_CHANNEL_16_MASK

 OT_CHANNEL_16_MASK (1 << 16)

Channel 16.

OT_CHANNEL_17_MASK

 OT_CHANNEL_17_MASK (1 << 17)

Channel 17.

OT_CHANNEL_18_MASK

 OT_CHANNEL_18_MASK (1 << 18)

Channel 18.

OT_CHANNEL_19_MASK

 OT_CHANNEL_19_MASK (1 << 19)

Channel 19.

OT_CHANNEL_1_MASK

 OT_CHANNEL_1_MASK (1 << 1)

Channel 1.

OT_CHANNEL_20_MASK

 OT_CHANNEL_20_MASK (1 << 20)

Channel 20.

OT_CHANNEL_21_MASK

 OT_CHANNEL_21_MASK (1 << 21)

Channel 21.

OT_CHANNEL_22_MASK

 OT_CHANNEL_22_MASK (1 << 22)

Channel 22.

OT_CHANNEL_23_MASK

 OT_CHANNEL_23_MASK (1 << 23)

Channel 23.

OT_CHANNEL_24_MASK

 OT_CHANNEL_24_MASK (1 << 24)

Channel 24.

OT_CHANNEL_25_MASK

 OT_CHANNEL_25_MASK (1 << 25)

Channel 25.

OT_CHANNEL_26_MASK

 OT_CHANNEL_26_MASK (1 << 26)

Channel 26.

OT_CHANNEL_2_MASK

 OT_CHANNEL_2_MASK (1 << 2)

Channel 2.

OT_CHANNEL_3_MASK

 OT_CHANNEL_3_MASK (1 << 3)

Channel 3.

OT_CHANNEL_4_MASK

 OT_CHANNEL_4_MASK (1 << 4)

Channel 4.

OT_CHANNEL_5_MASK

 OT_CHANNEL_5_MASK (1 << 5)

Channel 5.

OT_CHANNEL_6_MASK

 OT_CHANNEL_6_MASK (1 << 6)

Channel 6.

OT_CHANNEL_7_MASK

 OT_CHANNEL_7_MASK (1 << 7)

Channel 7.

OT_CHANNEL_8_MASK

 OT_CHANNEL_8_MASK (1 << 8)

Channel 8.

OT_CHANNEL_9_MASK

 OT_CHANNEL_9_MASK (1 << 9)

Channel 9.

OT_EXT_PAN_ID_SIZE

 OT_EXT_PAN_ID_SIZE 8

Size of a Thread PAN ID (bytes)

OT_JOINER_ADVDATA_MAX_LENGTH

 OT_JOINER_ADVDATA_MAX_LENGTH 64

Maximum AdvData Length of Joiner Advertisement.

OT_MASTER_KEY_SIZE

 OT_MASTER_KEY_SIZE 16

Size of the Thread Master Key (bytes)

OT_MESH_LOCAL_PREFIX_SIZE

 OT_MESH_LOCAL_PREFIX_SIZE OT_IP6_PREFIX_SIZE

Size of the Mesh Local Prefix (bytes)

OT_NEIGHBOR_INFO_ITERATOR_INIT

 OT_NEIGHBOR_INFO_ITERATOR_INIT 0

Initializer for otNeighborInfoIterator.

OT_NETWORK_BASE_TLV_MAX_LENGTH

 OT_NETWORK_BASE_TLV_MAX_LENGTH 254

Maximum value length of Thread Base TLV.

OT_NETWORK_DATA_ITERATOR_INIT

 OT_NETWORK_DATA_ITERATOR_INIT 0

Initializer for otNetworkDataIterator.

OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE

 OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE 3

Size of Network Diagnostic Child Table entry.

OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT

 OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT 0

Initializer for otNetworkDiagIterator.

OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES

 OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19

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

OT_NETWORK_MAX_ROUTER_ID

 OT_NETWORK_MAX_ROUTER_ID 62

Maximum Router ID.

OT_NETWORK_NAME_MAX_SIZE

 OT_NETWORK_NAME_MAX_SIZE 16

Maximum size of the Thread Network Name field (bytes)

OT_OPERATIONAL_DATASET_MAX_LENGTH

 OT_OPERATIONAL_DATASET_MAX_LENGTH 254

Maximum length of Operational Dataset in bytes.

OT_PSKC_MAX_SIZE

 OT_PSKC_MAX_SIZE 16

Maximum size of the PSKc (bytes)

OT_SERVER_DATA_MAX_SIZE

 OT_SERVER_DATA_MAX_SIZE 248

Maximum size of Server Data in bytes. This is theoretical limit, practical one is much lower.

OT_SERVICE_DATA_MAX_SIZE

 OT_SERVICE_DATA_MAX_SIZE 252

Maximum size of Service Data in bytes.

Geral

Resumo

Enumerações

Typedefs

Variáveis

Funções

Structs

Enumerações

enum anônimo

enum anônimo

otDeviceRole

otMeshcopTlvType

otRoutePreference

Typedefs

otBorderRouterConfig

otChannelMask

otExtendedPanId

otExternalRouteConfig

otIpCounters

otLeaderData

otLinkModeConfig

otMasterKey

otMeshLocalPrefix

otMeshcopTlvType

otMleCounters

otNeighborInfoIterator

otNetworkDataIterator

otNetworkDiagChildEntry

otNetworkDiagConnectivity

otNetworkDiagIterator

otNetworkDiagMacCounters

otNetworkDiagRoute

otNetworkDiagRouteData

otNetworkDiagTlv

otNetworkName

otOperationalDataset

otOperationalDatasetComponents

otOperationalDatasetTlvs

otPskc

otReceiveDiagnosticGetCallback

otRoutePreference

otSecurityPolicy

otServerConfig

otServiceConfig

otThreadDiscoveryRequestCallback

otThreadDiscoveryRequestInfo

otThreadParentResponseCallback

otThreadParentResponseInfo

Variáveis

OT_TOOL_PACKED_END

Funções

otDatasetCreateNewNetwork

otDatasetGeneratePskc

otDatasetGetActive

otDatasetGetActiveTlvs

otDatasetGetDelayTimerMinimal

otDatasetGetPending

otDatasetGetPendingTlvs

otDatasetIsCommissioned

otDatasetSendMgmtActiveGet

otDatasetSendMgmtActiveSet

otDatasetSendMgmtPendingGet

otDatasetSendMgmtPendingSet

otDatasetSetActive

otDatasetSetActiveTlvs

otDatasetSetDelayTimerMinimal

otDatasetSetPending

otDatasetSetPendingTlvs

otNetDataGet

otNetDataGetNextOnMeshPrefix

otNetDataGetNextRoute

otNetDataGetNextService

otNetDataGetStableVersion

otNetDataGetVersion

otNetDataSteeringDataCheckJoiner

otNetDataSteeringDataCheckJoinerWithDiscerner

otThreadBecomeChild

otThreadBecomeDetached

otThreadDiscover

otThreadGetChildTimeout