Google se compromete a impulsar la igualdad racial para las comunidades afrodescendientes. Obtén información al respecto.

General

Este módulo incluye funciones para todos los roles de Thread.

Resumen

Network Data Publisher proporciona mecanismos para limitar el número de entradas de servicio y / o prefijo similares (prefijo en malla o ruta externa) en los datos de la red de subprocesos mediante la supervisión de los datos de red y la gestión de si agregar o eliminar entradas o cuándo.

Todas las funciones de este módulo requieren OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE esté habilitado.

Enumeraciones

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
}
enumeración
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
}
enumeración
Representa una función de dispositivo Thread.
otNetDataPublisherEvent {
OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED = 0,
OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED = 1
}
enumeración
Esta enumeración representa los eventos informados de las devoluciones de llamada del publicador.
otRoutePreference {
OT_ROUTE_PREFERENCE_LOW = -1,
OT_ROUTE_PREFERENCE_MED = 0,
OT_ROUTE_PREFERENCE_HIGH = 1
}
enumeración
Define los valores válidos para mPreference en otExternalRouteConfig y otBorderRouterConfig .

Typedefs

otBorderRouterConfig typedef
Esta estructura representa una configuración de Border Router.
otExternalRouteConfig typedef
Esta estructura representa una configuración de ruta externa.
otIpCounters typedef
struct otIpCounters
Esta estructura representa los contadores de nivel de IP.
otLeaderData typedef
struct otLeaderData
Esta estructura representa los datos del líder del hilo.
otLinkModeConfig typedef
Esta estructura representa una configuración del modo de enlace MLE.
otMleCounters typedef
Esta estructura representa los contadores de Thread MLE.
otNeighborInfoIterator typedef
int16_t
Se usa para iterar a través de la tabla vecina.
otNetDataDnsSrpServicePublisherCallback )(otNetDataPublisherEvent aEvent, void *aContext) typedef
void(*
Este tipo de puntero de función define la devolución de llamada utilizada para notificar cuando se agrega o elimina una entrada de "Servicio DNS / SRP" de los datos de la red de subprocesos.
otNetDataPrefixPublisherCallback )(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext) typedef
void(*
Este tipo de puntero de función define la devolución de llamada utilizada para notificar cuando se agrega o elimina una entrada de prefijo (en malla o ruta externa) de los datos de la red de subprocesos.
otNetDataPublisherEvent typedef
Esta enumeración representa los eventos informados de las devoluciones de llamada del publicador.
otNetworkDataIterator typedef
uint32_t
Se utiliza para iterar a través de la información de datos de red.
otNetworkDiagChildEntry typedef
Esta estructura representa una entrada de tabla secundaria de diagnóstico de red.
otNetworkDiagConnectivity typedef
Esta estructura representa un valor de conectividad de diagnóstico de red.
otNetworkDiagIterator typedef
uint16_t
Se utiliza para iterar a través del TLV de diagnóstico de red.
otNetworkDiagMacCounters typedef
Esta estructura representa un valor de Contadores Mac de diagnóstico de red.
otNetworkDiagRoute typedef
Esta estructura representa un valor TLV de ruta de diagnóstico de red.
otNetworkDiagRouteData typedef
Esta estructura representa los datos de una ruta de diagnóstico de red.
otNetworkDiagTlv typedef
Esta estructura representa un TLV de diagnóstico de red.
otReceiveDiagnosticGetCallback )(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext) typedef
void(*
Este puntero de función se llama cuando se recibe una respuesta de obtención de diagnóstico de red.
otRoutePreference typedef
Define los valores válidos para mPreference en otExternalRouteConfig y otBorderRouterConfig .
otServerConfig typedef
Esta estructura representa una configuración de servidor.
otServiceConfig typedef
Esta estructura representa una configuración de servicio.
otThreadAnycastLocatorCallback )(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16) typedef
void(*
Este tipo de puntero función define la devolución de llamada para notificar el resultado de un otThreadLocateAnycastDestination() petición.
otThreadDiscoveryRequestCallback )(const otThreadDiscoveryRequestInfo *aInfo, void *aContext) typedef
void(*
Este puntero de función se llama cada vez que se recibe un mensaje de solicitud de descubrimiento de MLE.
otThreadDiscoveryRequestInfo typedef
Esta estructura representa los datos de la solicitud de descubrimiento de subprocesos.
otThreadParentResponseCallback )(otThreadParentResponseInfo *aInfo, void *aContext) typedef
void(*
Este puntero de función se llama cada vez que se recibe un mensaje de respuesta de los padres de MLE.
otThreadParentResponseInfo typedef
Esta estructura representa los datos de Respuesta de los padres de MLE.

Funciones

otNetDataGet ( otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
Este método proporciona una copia completa o estable de los datos de red de subprocesos de la partición.
otNetDataGetNextOnMeshPrefix ( otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
Esta función obtiene el siguiente prefijo On Mesh en los datos de red de la partición.
otNetDataGetNextRoute ( otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)
Esta función obtiene la siguiente ruta externa en los datos de red de la partición.
otNetDataGetNextService ( otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig)
Esta función obtiene el siguiente servicio en los datos de red de la partición.
otNetDataGetStableVersion ( otInstance *aInstance)
uint8_t
Obtenga la versión de datos de red estable.
otNetDataGetVersion ( otInstance *aInstance)
uint8_t
Obtenga la versión de datos de red.
otNetDataIsDnsSrpServiceAdded ( otInstance *aInstance)
bool
Esta función indica si actualmente se agrega o no la entrada "Servicio DNS / SRP" a los datos de la red de subprocesos.
otNetDataIsPrefixAdded ( otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
Esta función indica si actualmente se agrega o no una entrada de prefijo publicada (en malla o ruta externa) a los datos de la red de subprocesos.
otNetDataPublishDnsSrpServiceAnycast ( otInstance *aInstance, uint8_t aSequenceNUmber)
void
Esta función solicita que la "Dirección Anycast del servicio DNS / SRP" se publique en Thread Network Data.
otNetDataPublishDnsSrpServiceUnicast ( otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort)
void
Esta función solicita que se publique la "Dirección de unidifusión del servicio DNS / SRP" en los datos de la red de subprocesos.
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid ( otInstance *aInstance, uint16_t aPort)
void
Esta función solicita que se publique la "Dirección de unidifusión del servicio DNS / SRP" en los datos de la red de subprocesos.
otNetDataPublishExternalRoute ( otInstance *aInstance, const otExternalRouteConfig *aConfig)
Esta función solicita que se publique un prefijo de ruta externo en Thread Network Data.
otNetDataPublishOnMeshPrefix ( otInstance *aInstance, const otBorderRouterConfig *aConfig)
Esta función solicita que se publique un prefijo en malla en Thread Network Data.
otNetDataSetDnsSrpServicePublisherCallback ( otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext)
void
Esta función establece una devolución de llamada para notificar cuando un "Servicio DNS / SRP" publicado se agrega o elimina de los datos de la red de subprocesos.
otNetDataSetPrefixPublisherCallback ( otInstance *aInstance, otNetDataPrefixPublisherCallback aCallback, void *aContext)
void
Esta función establece una devolución de llamada para notificar cuando una entrada de prefijo publicada realmente se agrega o se elimina de los datos de la red de subprocesos.
otNetDataSteeringDataCheckJoiner ( otInstance *aInstance, const otExtAddress *aEui64)
Compruebe si los datos de dirección incluyen un Joiner.
otNetDataSteeringDataCheckJoinerWithDiscerner ( otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner)
Compruebe si los datos de dirección incluyen un Joiner con un valor de discernimiento determinado.
otNetDataUnpublishDnsSrpService ( otInstance *aInstance)
void
Esta función anula la publicación de cualquier entrada de "Servicio DNS / SRP (Anycast o Unicast)" agregada anteriormente de los datos de la red de subprocesos.
otNetDataUnpublishPrefix ( otInstance *aInstance, const otIp6Prefix *aPrefix)
Esta función anula la publicación de un prefijo previamente publicado (en malla o ruta externa).
otThreadBecomeChild ( otInstance *aInstance)
Intenta volver a unirte como un niño.
otThreadBecomeDetached ( otInstance *aInstance)
Desconectarse de la red Thread.
otThreadDeviceRoleToString ( otDeviceRole aRole)
const char *
Convierta la función del dispositivo en una cadena legible por humanos.
otThreadDiscover ( otInstance *aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void *aCallbackContext)
Esta función inicia un análisis de Thread Discovery.
otThreadGetChildTimeout ( otInstance *aInstance)
uint32_t
Obtenga el Thread Child Timeout usado cuando se opera en el rol Child.
otThreadGetDeviceRole ( otInstance *aInstance)
Obtén el rol del dispositivo.
otThreadGetDomainName ( otInstance *aInstance)
const char *
Obtenga el nombre de dominio del hilo.
otThreadGetExtendedPanId ( otInstance *aInstance)
Obtenga el ID de PAN extendido IEEE 802.15.4.
otThreadGetFixedDuaInterfaceIdentifier ( otInstance *aInstance)
Obtenga el identificador de interfaz especificado manualmente para la dirección de unidifusión de dominio de subprocesos.
otThreadGetIp6Counters ( otInstance *aInstance)
const otIpCounters *
Obtenga los contadores de IPv6.
otThreadGetKeySequenceCounter ( otInstance *aInstance)
uint32_t
Obtenga thrKeySequenceCounter.
otThreadGetKeySwitchGuardTime ( otInstance *aInstance)
uint32_t
Obtenga thrKeySwitchGuardTime.
otThreadGetLeaderData ( otInstance *aInstance, otLeaderData *aLeaderData)
Esta función obtiene los datos del líder del hilo.
otThreadGetLeaderRloc ( otInstance *aInstance, otIp6Address *aLeaderRloc)
Esta función devuelve un puntero al RLOC del líder.
otThreadGetLeaderRouterId ( otInstance *aInstance)
uint8_t
Obtenga la identificación del enrutador del líder.
otThreadGetLeaderWeight ( otInstance *aInstance)
uint8_t
Obtenga el peso del líder.
otThreadGetLinkLocalAllThreadNodesMulticastAddress ( otInstance *aInstance)
const otIp6Address *
Esta función devuelve la dirección de multidifusión Thread Link-Local All Thread Nodes.
otThreadGetLinkLocalIp6Address ( otInstance *aInstance)
const otIp6Address *
Esta función devuelve la dirección IPv6 local de enlace de subproceso.
otThreadGetLinkMode ( otInstance *aInstance)
Obtenga la configuración del modo de enlace MLE.
otThreadGetMeshLocalEid ( otInstance *aInstance)
const otIp6Address *
Esta función devuelve un puntero a la dirección EID local de malla.
otThreadGetMeshLocalPrefix ( otInstance *aInstance)
Esta función devuelve un puntero al prefijo local de malla.
otThreadGetMleCounters ( otInstance *aInstance)
const otMleCounters *
Obtenga los contadores de Thread MLE.
otThreadGetNetworkKey ( otInstance *aInstance, otNetworkKey *aNetworkKey)
void
Obtenga la clave de red del hilo.
otThreadGetNetworkKeyRef ( otInstance *aInstance)
Obtener el otNetworkKeyRef de Tema Clave de red.
otThreadGetNetworkName ( otInstance *aInstance)
const char *
Obtenga el nombre de la red de subprocesos.
otThreadGetNextDiagnosticTlv (const otMessage *aMessage, otNetworkDiagIterator *aIterator, otNetworkDiagTlv *aNetworkDiagTlv)
Esta función obtiene el siguiente TLV de diagnóstico de red en el mensaje.
otThreadGetNextNeighborInfo ( otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo)
Esta función obtiene la siguiente información del vecino.
otThreadGetParentAverageRssi ( otInstance *aInstance, int8_t *aParentRssi)
La función recupera el RSSI promedio para el Thread Parent.
otThreadGetParentInfo ( otInstance *aInstance, otRouterInfo *aParentInfo)
La función recupera información de diagnóstico para un Thread Router como padre.
otThreadGetParentLastRssi ( otInstance *aInstance, int8_t *aLastRssi)
La función recupera el RSSI del último paquete del Thread Parent.
otThreadGetPartitionId ( otInstance *aInstance)
uint32_t
Obtenga el ID de partición.
otThreadGetRealmLocalAllThreadNodesMulticastAddress ( otInstance *aInstance)
const otIp6Address *
Esta función devuelve la dirección de multidifusión Thread Realm-Local All Thread Nodes.
otThreadGetRloc ( otInstance *aInstance)
const otIp6Address *
Esta función devuelve un puntero a la dirección del localizador de enrutamiento de subprocesos (RLOC).
otThreadGetRloc16 ( otInstance *aInstance)
uint16_t
Obtenga el RLOC16.
otThreadGetServiceAloc ( otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc)
Esta función recupera el servicio ALOC para un ID de servicio dado.
otThreadGetVersion (void)
uint16_t
Esta función obtiene la versión del protocolo Thread.
otThreadIsAnycastLocateInProgress ( otInstance *aInstance)
bool
Esta función indica si hay una solicitud de localización anycast en curso.
otThreadIsDiscoverInProgress ( otInstance *aInstance)
bool
Esta función determina si un descubrimiento de subprocesos MLE está actualmente en curso.
otThreadIsSingleton ( otInstance *aInstance)
bool
Esta función indica si un nodo es el único enrutador en la red.
otThreadLocateAnycastDestination ( otInstance *aInstance, const otIp6Address *aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext)
Esta función solicita que se ubique el destino más cercano de una determinada dirección anycast.
otThreadRegisterParentResponseCallback ( otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext)
void
Esta función registra una devolución de llamada para recibir datos de Respuesta de los padres de MLE.
otThreadResetIp6Counters ( otInstance *aInstance)
void
Reinicie los contadores de IPv6.
otThreadResetMleCounters ( otInstance *aInstance)
void
Restablezca los contadores de Thread MLE.
otThreadSendAddressNotification ( otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid)
void
Esta función envía un mensaje de notificación de dirección proactiva (ADDR_NTF.ntf).
otThreadSendDiagnosticGet ( otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext)
Envíe una solicitud de obtención de diagnóstico de red.
otThreadSendDiagnosticReset ( otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount)
Envíe una solicitud de restablecimiento de diagnóstico de red.
otThreadSendProactiveBackboneNotification ( otInstance *aInstance, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction)
Esta función envía un mensaje de Notificación Proactive Backbone (PRO_BB.ntf) en el enlace Backbone.
otThreadSetChildTimeout ( otInstance *aInstance, uint32_t aTimeout)
void
Establezca el tiempo de espera de subproceso secundario que se utiliza al operar en el rol secundario.
otThreadSetDiscoveryRequestCallback ( otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext)
void
Esta función establece una devolución de llamada para recibir datos de solicitud de descubrimiento de MLE.
otThreadSetDomainName ( otInstance *aInstance, const char *aDomainName)
Establezca el nombre de dominio del subproceso.
otThreadSetEnabled ( otInstance *aInstance, bool aEnabled)
Esta función inicia la operación del protocolo Thread.
otThreadSetExtendedPanId ( otInstance *aInstance, const otExtendedPanId *aExtendedPanId)
Configure el ID de PAN extendido IEEE 802.15.4.
otThreadSetFixedDuaInterfaceIdentifier ( otInstance *aInstance, const otIp6InterfaceIdentifier *aIid)
Establezca / borre el identificador de interfaz especificado manualmente para la dirección de unidifusión del dominio de subprocesos.
otThreadSetJoinerAdvertisement ( otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength)
Este método establece el anuncio Thread Joiner al descubrir la red Thread.
otThreadSetKeySequenceCounter ( otInstance *aInstance, uint32_t aKeySequenceCounter)
void
Establezca thrKeySequenceCounter.
otThreadSetKeySwitchGuardTime ( otInstance *aInstance, uint32_t aKeySwitchGuardTime)
void
Establezca thrKeySwitchGuardTime.
otThreadSetLinkMode ( otInstance *aInstance, otLinkModeConfig aConfig)
Establezca la configuración del modo de enlace MLE.
otThreadSetMeshLocalPrefix ( otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix)
Esta función establece el prefijo local de malla.
otThreadSetNetworkKey ( otInstance *aInstance, const otNetworkKey *aKey)
Establezca la clave de red del hilo.
otThreadSetNetworkKeyRef ( otInstance *aInstance, otNetworkKeyRef aKeyRef)
Ajuste el hilo de la clave de red como otNetworkKeyRef .
otThreadSetNetworkName ( otInstance *aInstance, const char *aNetworkName)
Establezca el nombre de la red de subprocesos.

Estructuras

otBorderRouterConfig

Esta estructura representa una configuración de Border Router.

otExternalRouteConfig

Esta estructura representa una configuración de ruta externa.

otIpCounters

Esta estructura representa los contadores de nivel de IP.

otLeaderData

Esta estructura representa los datos del líder del hilo.

otLinkModeConfig

Esta estructura representa una configuración del modo de enlace MLE.

otMleCounters

Esta estructura representa los contadores de Thread MLE.

otNeighborInfo

Esta estructura contiene información de diagnóstico para un nodo Thread vecino.

otNetworkDiagChildEntry

Esta estructura representa una entrada de tabla secundaria de diagnóstico de red.

otNetworkDiagConnectivity

Esta estructura representa un valor de conectividad de diagnóstico de red.

otNetworkDiagMacCounters

Esta estructura representa un valor de Contadores Mac de diagnóstico de red.

otNetworkDiagRoute

Esta estructura representa un valor TLV de ruta de diagnóstico de red.

otNetworkDiagRouteData

Esta estructura representa los datos de una ruta de diagnóstico de red.

otNetworkDiagTlv

Esta estructura representa un TLV de diagnóstico de red.

otRouterInfo

Esta estructura contiene información de diagnóstico para un enrutador de subprocesos.

otServerConfig

Esta estructura representa una configuración de servidor.

otServiceConfig

Esta estructura representa una configuración de servicio.

otThreadDiscoveryRequestInfo

Esta estructura representa los datos de la solicitud de descubrimiento de subprocesos.

otThreadParentResponseInfo

Esta estructura representa los datos de Respuesta de los padres de MLE.

Enumeraciones

enumeración anónima

 anonymous enum
Propiedades
OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL

TLV de nivel de batería.

OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES

TLV de las páginas del canal.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE

TLV de tabla secundaria.

OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY

TLV de conectividad.

OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS

TLV de dirección extendida MAC.

OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST

TLV de lista de direcciones IPv6.

OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA

TLV de datos de líder.

OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS

Contadores MAC TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT

TLV de tiempo de espera máximo para niños.

OT_NETWORK_DIAGNOSTIC_TLV_MODE

Modo TLV.

OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA

TLV de datos de red.

OT_NETWORK_DIAGNOSTIC_TLV_ROUTE

Route64 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS

Dirección16 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE

Voltaje de suministro TLV.

OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT

TLV de tiempo de espera (el período de tiempo máximo de sondeo para los SED)

OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST

TLV de lista de tipos.

otDeviceRole

 otDeviceRole

Representa una función de dispositivo Thread.

Propiedades
OT_DEVICE_ROLE_CHILD

El papel de Thread Child.

OT_DEVICE_ROLE_DETACHED

Actualmente no participa en una red / partición de subprocesos.

OT_DEVICE_ROLE_DISABLED

La pila de subprocesos está deshabilitada.

OT_DEVICE_ROLE_LEADER

El rol del líder del hilo.

OT_DEVICE_ROLE_ROUTER

El rol de Thread Router.

otNetDataPublisherEvent

 otNetDataPublisherEvent

Esta enumeración representa los eventos informados de las devoluciones de llamada del publicador.

Propiedades
OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED

La entrada publicada se agrega a los datos de la red de subprocesos.

OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED

La entrada publicada se elimina de Thread Network Data.

otRoutePreference

 otRoutePreference

Define los valores válidos para mPreference en otExternalRouteConfig y otBorderRouterConfig .

Propiedades
OT_ROUTE_PREFERENCE_HIGH

Preferencia de ruta alta.

OT_ROUTE_PREFERENCE_LOW

Preferencia de ruta baja.

OT_ROUTE_PREFERENCE_MED

Preferencia de ruta media.

Typedefs

otBorderRouterConfig

struct otBorderRouterConfig otBorderRouterConfig

Esta estructura representa una configuración de Border Router.

otExternalRouteConfig

struct otExternalRouteConfig otExternalRouteConfig

Esta estructura representa una configuración de ruta externa.

otIpCounters

struct otIpCounters otIpCounters

Esta estructura representa los contadores de nivel de IP.

otLeaderData

struct otLeaderData otLeaderData

Esta estructura representa los datos del líder del hilo.

otLinkModeConfig

struct otLinkModeConfig otLinkModeConfig

Esta estructura representa una configuración del modo de enlace MLE.

otMleCounters

struct otMleCounters otMleCounters

Esta estructura representa los contadores de Thread MLE.

otNeighborInfoIterator

int16_t otNeighborInfoIterator

Se usa para iterar a través de la tabla vecina.

otNetDataDnsSrpServicePublisherCallback

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

Este tipo de puntero de función define la devolución de llamada que se utiliza para notificar cuando se agrega o elimina una entrada de "Servicio DNS / SRP" de los datos de la red de subprocesos.

En quitar la devolución de llamada se invoca independiente de si la entrada se elimina por Publisher (por ejemplo, cuando hay demasiadas entradas similares ya presentes en los datos de red) o a través de una llamada explícita a anular la publicación de la entrada (es decir, una llamada a otNetDataUnpublishDnsSrpService() ).

Detalles
Parámetros
[in] aEvent
Indica el evento (si la entrada fue agregada o eliminada).
[in] aContext
Un puntero al contexto específico de la aplicación.

otNetDataPrefixPublisherCallback

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

Este tipo de puntero de función define la devolución de llamada utilizada para notificar cuando se agrega o elimina una entrada de prefijo (en malla o ruta externa) de los datos de la red de subprocesos.

En Retire la devolución de llamada se invoca independiente de si la entrada se elimina por Publisher (por ejemplo, cuando hay demasiadas entradas similares ya presentes en los datos de red) o mediante una llamada explícita a anular la publicación de la entrada.

Detalles
Parámetros
[in] aEvent
Indica el evento (si la entrada fue agregada o eliminada).
[in] aPrefix
Un puntero a la entrada del prefijo.
[in] aContext
Un puntero al contexto específico de la aplicación.

otNetDataPublisherEvent

enum otNetDataPublisherEvent otNetDataPublisherEvent

Esta enumeración representa los eventos informados de las devoluciones de llamada del publicador.

otNetworkDataIterator

uint32_t otNetworkDataIterator

Se utiliza para iterar a través de la información de datos de red.

otNetworkDiagChildEntry

struct otNetworkDiagChildEntry otNetworkDiagChildEntry

Esta estructura representa una entrada de tabla secundaria de diagnóstico de red.

otNetworkDiagConnectivity

struct otNetworkDiagConnectivity otNetworkDiagConnectivity

Esta estructura representa un valor de conectividad de diagnóstico de red.

otNetworkDiagIterator

uint16_t otNetworkDiagIterator

Se utiliza para iterar a través del TLV de diagnóstico de red.

otNetworkDiagMacCounters

struct otNetworkDiagMacCounters otNetworkDiagMacCounters

Esta estructura representa un valor de Contadores Mac de diagnóstico de red.

Ver RFC 2863 para las definiciones de campos miembros.

otNetworkDiagRoute

struct otNetworkDiagRoute otNetworkDiagRoute

Esta estructura representa un valor TLV de ruta de diagnóstico de red.

otNetworkDiagRouteData

struct otNetworkDiagRouteData otNetworkDiagRouteData

Esta estructura representa los datos de una ruta de diagnóstico de red.

otNetworkDiagTlv

struct otNetworkDiagTlv otNetworkDiagTlv

Esta estructura representa un TLV de diagnóstico de red.

otReceiveDiagnosticGetCallback

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

Este puntero de función se llama cuando se recibe una respuesta de obtención de diagnóstico de red.

Detalles
Parámetros
[in] aError
El error cuando no se pudo obtener la respuesta.
[in] aMessage
Un puntero al búfer de mensajes que contiene la carga útil de respuesta de obtención de diagnóstico de red recibida. Sólo está disponible cuando aError es OT_ERROR_NONE .
[in] aMessageInfo
Un puntero a la información de mensajes para aMessage . Sólo está disponible cuando aError es OT_ERROR_NONE .
[in] aContext
Un puntero al contexto específico de la aplicación.

otRoutePreference

enum otRoutePreference otRoutePreference

Define los valores válidos para mPreference en otExternalRouteConfig y otBorderRouterConfig .

otServerConfig

struct otServerConfig otServerConfig

Esta estructura representa una configuración de servidor.

otServiceConfig

struct otServiceConfig otServiceConfig

Esta estructura representa una configuración de servicio.

otThreadAnycastLocatorCallback

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

Este tipo de puntero función define la devolución de llamada para notificar el resultado de un otThreadLocateAnycastDestination() petición.

Detalles
Parámetros
[in] aContext
Un puntero a un contexto arbitrario (proporcionado cuando se registra la devolución de llamada).
[in] aError
El error al manejar la solicitud. OT_ERROR_NONE indica éxito. OT_ERROR_RESPONSE_TIMEOUT indica que no se pudo encontrar un destino. OT_ERROR_ABORT indica que la solicitud fue cancelada.
[in] aMeshLocalAddress
Un puntero a la EID-malla local de los destinos más cerca de la dirección anycast cuando aError es OT_ERROR_NONE, NULL en otro caso.
[in] aRloc16
El RLOC16 del destino si se encuentra, de lo contrario RLOC16 no válido (0xfffe).

otThreadDiscoveryRequestCallback

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

Este puntero de función se llama cada vez que se recibe un mensaje de solicitud de descubrimiento de MLE.

Detalles
Parámetros
[in] aInfo
Un puntero a los datos de información de la solicitud de descubrimiento.
[in] aContext
Un puntero al contexto específico de la aplicación de devolución de llamada.

otThreadDiscoveryRequestInfo

struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo

Esta estructura representa los datos de la solicitud de descubrimiento de subprocesos.

otThreadParentResponseCallback

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

Este puntero de función se llama cada vez que se recibe un mensaje de respuesta de los padres de MLE.

Detalles
Parámetros
[in] aStats
puntero a una ubicación en la pila que contiene los datos de estadísticas.
[in] aContext
Un puntero al contexto específico del cliente de devolución de llamada.

otThreadParentResponseInfo

struct otThreadParentResponseInfo otThreadParentResponseInfo

Esta estructura representa los datos de Respuesta de los padres de MLE.

Funciones

otNetDataGet

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

Este método proporciona una copia completa o estable de los datos de red de subprocesos de la partición.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aStable
VERDADERO al copiar la versión estable, FALSO al copiar la versión completa.
[out] aData
Un puntero al búfer de datos.
[in,out] aDataLength
En la entrada, el tamaño del búfer de datos a la que apunta aData . Al salir, número de bytes copiados.

otNetDataGetNextOnMeshPrefix

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

Esta función obtiene el siguiente prefijo On Mesh en los datos de red de la partición.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in,out] aIterator
Un puntero al contexto del iterador de datos de red. Para obtener la primera entrada en malla, debe establecerse en OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Un puntero al lugar donde se colocará la información del Prefijo de malla.
Valores devueltos
OT_ERROR_NONE
Encontré con éxito el siguiente prefijo de On Mesh.
OT_ERROR_NOT_FOUND
No existe ningún prefijo On Mesh subsiguiente en los datos de la red de subprocesos.

otNetDataGetNextRoute

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

Esta función obtiene la siguiente ruta externa en los datos de red de la partición.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in,out] aIterator
Un puntero al contexto del iterador de datos de red. Para obtener la primera entrada de ruta externa, debe establecerse en OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Un puntero al lugar donde se colocará la información de la ruta externa.
Valores devueltos
OT_ERROR_NONE
Encontré con éxito la siguiente ruta externa.
OT_ERROR_NOT_FOUND
No existe ninguna entrada de ruta externa posterior en los datos de la red de subprocesos.

otNetDataGetNextService

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

Esta función obtiene el siguiente servicio en los datos de red de la partición.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in,out] aIterator
Un puntero al contexto del iterador de datos de red. Para obtener la primera entrada de servicio, debe establecerse en OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Un puntero al lugar donde se colocará la información del servicio.
Valores devueltos
OT_ERROR_NONE
Encontré con éxito el siguiente servicio.
OT_ERROR_NOT_FOUND
No existe ningún servicio posterior en los datos de red de la partición.

otNetDataGetStableVersion

uint8_t otNetDataGetStableVersion(
  otInstance *aInstance
)

Obtenga la versión de datos de red estable.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
La versión de datos de red estable.

otNetDataGetVersion

uint8_t otNetDataGetVersion(
  otInstance *aInstance
)

Obtenga la versión de datos de red.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
La versión de datos de red.

otNetDataIsDnsSrpServiceAdded

bool otNetDataIsDnsSrpServiceAdded(
  otInstance *aInstance
)

Esta función indica si actualmente se agrega o no la entrada "Servicio DNS / SRP" a los datos de la red de subprocesos.

Esta función requiere la función OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE esté habilitado.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Valores devueltos
TRUE
La entrada de servicio DNS / SRP publicada se agrega a los datos de la red de subprocesos.
FALSE
La entrada no se agrega a Thread Network Data o no hay ninguna entrada para publicar.

otNetDataIsPrefixAdded

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

Esta función indica si actualmente se agrega o no una entrada de prefijo publicada (en malla o ruta externa) a los datos de la red de subprocesos.

Esta función requiere la función OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE esté habilitado.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aPrefix
Un puntero al prefijo (NO DEBE ser NULO).
Valores devueltos
TRUE
La entrada de prefijo publicada se agrega a Thread Network Data.
FALSE
La entrada no se agrega a Thread Network Data o no hay ninguna entrada para publicar.

otNetDataPublishDnsSrpServiceAnycast

void otNetDataPublishDnsSrpServiceAnycast(
  otInstance *aInstance,
  uint8_t aSequenceNUmber
)

Esta función solicita que la "Dirección Anycast del servicio DNS / SRP" se publique en Thread Network Data.

Esta función requiere la función OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE esté habilitado.

Una llamada a esta función será quitar y reemplazar cualquier entrada anterior "DNS / Servicio SRP" que estaba siendo publicado (de llamada anterior a cualquiera de otNetDataPublishDnsSrpService{Type}() funciones).

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aSequenceNUmber
El número de secuencia del servicio Anycast DNS / SRP.

otNetDataPublishDnsSrpServiceUnicast

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

Esta función solicita que se publique la "Dirección de unidifusión del servicio DNS / SRP" en los datos de la red de subprocesos.

Esta función requiere la función OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE esté habilitado.

Una llamada a esta función será quitar y reemplazar cualquier entrada anterior "DNS / Servicio SRP" que estaba siendo publicado (de llamada anterior a cualquiera de otNetDataPublishDnsSrpService{Type}() funciones).

Esta función publica la "Dirección de unidifusión del servicio DNS / SRP" al incluir la dirección y la información del puerto en los datos del TLV del servicio.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aAddress
La dirección del servidor DNS / SRP para publicar (NO DEBE ser NULL).
[in] aPort
El número de puerto del servidor SRP para publicar.

otNetDataPublishDnsSrpServiceUnicastMeshLocalEid

void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(
  otInstance *aInstance,
  uint16_t aPort
)

Esta función solicita que se publique la "Dirección de unidifusión del servicio DNS / SRP" en los datos de la red de subprocesos.

Esta función requiere la función OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE esté habilitado.

Una llamada a esta función será quitar y reemplazar cualquier entrada anterior "DNS / Servicio SRP" que estaba siendo publicado (de llamada anterior a cualquiera de otNetDataPublishDnsSrpService{Type}() funciones).

A diferencia de otNetDataPublishDnsSrpServiceUnicast() que requiere la dirección publicada ser dado e incluye la información en los datos de servicio TLV, esta función utiliza EID-malla local del dispositivo e incluye la información en los datos del servidor TLV.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aPort
El número de puerto del servidor SRP para publicar.

otNetDataPublishExternalRoute

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

Esta función solicita que se publique un prefijo de ruta externa en Thread Network Data.

Esta función requiere la función OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE esté habilitado.

Sólo entradas estables pueden ser publicados (es decir, aConfig.mStable DEBE ser TRUE).

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aConfig
La configuración de la ruta externa para publicar (NO DEBE ser NULA).
Valores devueltos
OT_ERROR_NONE
La ruta externa se publica con éxito.
OT_ERROR_INVALID_ARGS
El aConfig no es válido (mala prefijo, combinaciones de indicadores válidos, o no estable).
OT_ERROR_ALREADY
Una entrada con el mismo prefijo ya está en la lista publicada.
OT_ERROR_NO_BUFS
No se pudo asignar una entrada para la nueva solicitud. Editorial soporta un número limitado de entradas (compartido entre on-malla prefijo y ruta externa) determinado por configuración OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES .

otNetDataPublishOnMeshPrefix

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

Esta función solicita que se publique un prefijo en malla en Thread Network Data.

Esta función requiere la función OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE esté habilitado.

Sólo entradas estables pueden ser publicados (es decir, aConfig.mStable DEBE ser TRUE).

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aConfig
La configuración del prefijo en malla para publicar (NO DEBE ser NULO).
Valores devueltos
OT_ERROR_NONE
El prefijo en malla se publicó correctamente.
OT_ERROR_INVALID_ARGS
El aConfig no es válido (mala prefijo, combinaciones de indicadores válidos, o no estable).
OT_ERROR_ALREADY
Una entrada con el mismo prefijo ya está en la lista publicada.
OT_ERROR_NO_BUFS
No se pudo asignar una entrada para la nueva solicitud. Editorial soporta un número limitado de entradas (compartido entre on-malla prefijo y ruta externa) determinado por configuración OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES .

otNetDataSetDnsSrpServicePublisherCallback

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

Esta función establece una devolución de llamada para notificar cuando un "Servicio DNS / SRP" publicado se agrega o elimina de los datos de la red de subprocesos.

Una llamada posterior a esta función reemplaza cualquier función de devolución de llamada establecida previamente.

Esta función requiere la función OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE esté habilitado.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aCallback
El puntero de la función de devolución de llamada (puede ser NULL si no es necesario).
[in] aContext
Un puntero a contexto de aplicación específica (se utiliza cuando aCallback se invoca).

otNetDataSetPrefixPublisherCallback

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

Esta función establece una devolución de llamada para notificar cuando una entrada de prefijo publicada realmente se agrega o se elimina de Thread Network Data.

Una llamada posterior a esta función reemplaza cualquier función de devolución de llamada establecida previamente.

Esta función requiere la función OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE esté habilitado.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aCallback
El puntero de la función de devolución de llamada (puede ser NULL si no es necesario).
[in] aContext
Un puntero a contexto de aplicación específica (se utiliza cuando aCallback se invoca).

otNetDataSteeringDataCheckJoiner

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

Compruebe si los datos de dirección incluyen un Joiner.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aEui64
Un puntero al IEEE EUI-64 de Joiner.
Valores devueltos
OT_ERROR_NONE
aEui64 se incluye en los datos de dirección.
OT_ERROR_INVALID_STATE
No hay datos de dirección presentes.
OT_ERROR_NOT_FOUND
aEui64 no está incluido en los datos de dirección.

otNetDataSteeringDataCheckJoinerWithDiscerner

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

Compruebe si los datos de dirección incluyen un Joiner con un valor de discernimiento determinado.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aDiscerner
Un puntero para el Joiner Discerner.
Valores devueltos
OT_ERROR_NONE
aDiscerner se incluye en los datos de dirección.
OT_ERROR_INVALID_STATE
No hay datos de dirección presentes.
OT_ERROR_NOT_FOUND
aDiscerner no está incluido en los datos de dirección.

otNetDataUnpublishDnsSrpService

void otNetDataUnpublishDnsSrpService(
  otInstance *aInstance
)

Esta función anula la publicación de cualquier entrada de "Servicio DNS / SRP (Anycast o Unicast)" agregada anteriormente de los datos de la red de subprocesos.

Esta función requiere la función OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE esté habilitado.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.

otNetDataUnpublishPrefix

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

Esta función anula la publicación de un prefijo previamente publicado (en malla o ruta externa).

Esta función requiere la función OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE esté habilitado.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aPrefix
El prefijo para anular la publicación (NO DEBE ser NULO).
Valores devueltos
OT_ERROR_NONE
El prefijo se anuló con éxito.
OT_ERROR_NOT_FOUND
No se pudo encontrar el prefijo en la lista publicada.

otThreadBecomeChild

otError otThreadBecomeChild(
  otInstance *aInstance
)

Intenta volver a unirte como un niño.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Valores devueltos
OT_ERROR_NONE
Comience con éxito el intento de convertirse en un niño.
OT_ERROR_INVALID_STATE
El hilo está deshabilitado.

otThreadBecomeDetached

otError otThreadBecomeDetached(
  otInstance *aInstance
)

Desconectarse de la red Thread.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Valores devueltos
OT_ERROR_NONE
Se separó con éxito de la red Thread.
OT_ERROR_INVALID_STATE
El hilo está deshabilitado.

otThreadDeviceRoleToString

const char * otThreadDeviceRoleToString(
  otDeviceRole aRole
)

Convierta la función del dispositivo en una cadena legible por humanos.

Detalles
Parámetros
[in] aRole
La función del dispositivo que se va a convertir.
Devoluciones
Una cadena que representa aRole .

otThreadDiscover

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

Esta función inicia un análisis de Thread Discovery.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in] aScanChannels
Un vector de bits que indica qué canales escanear (por ejemplo, OT_CHANNEL_11_MASK).
[in] aPanId
El filtro PAN ID (configurado en Broadcast PAN para deshabilitar el filtro).
[in] aJoiner
Valor del indicador de incorporación en el TLV de solicitud de descubrimiento.
[in] aEnableEui64Filtering
TRUE para filtrar respuestas en EUI-64, FALSE en caso contrario.
[in] aCallback
Un puntero a una función llamada al recibir una respuesta de descubrimiento de MLE o se completa el escaneo.
[in] aCallbackContext
Un puntero al contexto específico de la aplicación.
Valores devueltos
OT_ERROR_NONE
Se inició con éxito un análisis de detección de subprocesos.
OT_ERROR_INVALID_STATE
La interfaz IPv6 no está habilitada (netif no está activo).
OT_ERROR_NO_BUFS
No se pudo asignar el mensaje para la solicitud de descubrimiento.
OT_ERROR_BUSY
Thread Discovery Scan ya está en curso.

otThreadGetChildTimeout

uint32_t otThreadGetChildTimeout(
  otInstance *aInstance
)

Obtenga el Thread Child Timeout usado cuando se opera en el rol Child.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
El valor de Thread Child Timeout en segundos.
Ver también:
otThreadSetChildTimeout

otThreadGetDeviceRole

otDeviceRole otThreadGetDeviceRole(
  otInstance *aInstance
)

Obtén el rol del dispositivo.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Valores devueltos
OT_DEVICE_ROLE_DISABLED
La pila de subprocesos está deshabilitada.
OT_DEVICE_ROLE_DETACHED
El dispositivo no participa actualmente en una red / partición de subprocesos.
OT_DEVICE_ROLE_CHILD
El dispositivo está funcionando actualmente como Thread Child.
OT_DEVICE_ROLE_ROUTER
El dispositivo está funcionando actualmente como un enrutador de subprocesos.
OT_DEVICE_ROLE_LEADER
El dispositivo está funcionando actualmente como líder de subprocesos.

otThreadGetDomainName

const char * otThreadGetDomainName(
  otInstance *aInstance
)

Obtenga el nombre de dominio del hilo.

Esta función solo está disponible desde Thread 1.2.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
Un puntero al nombre de dominio del subproceso.
Ver también:
otThreadSetDomainName

otThreadGetExtendedPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

Obtenga el ID de PAN extendido IEEE 802.15.4.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
Un puntero al IEEE 802.15.4 Extended PAN ID.
Ver también:
otThreadSetExtendedPanId

otThreadGetFixedDuaInterfaceIdentifier

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
  otInstance *aInstance
)

Obtenga el identificador de interfaz especificado manualmente para la dirección de unidifusión de dominio de subprocesos.

Esta función sólo está disponible desde Hilo 1.2 cuando OPENTHREAD_CONFIG_DUA_ENABLE está activado.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
Un puntero al identificador de interfaz que se estableció manualmente, o NULL si no se estableció ninguno.
Ver también:
otThreadSetFixedDuaInterfaceIdentifier

otThreadGetIp6Counters

const otIpCounters * otThreadGetIp6Counters(
  otInstance *aInstance
)

Obtenga los contadores de IPv6.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
Un puntero a los contadores de IPv6.

otThreadGetKeySequenceCounter

uint32_t otThreadGetKeySequenceCounter(
  otInstance *aInstance
)

Obtenga thrKeySequenceCounter.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
El valor de thrKeySequenceCounter.
Ver también:
otThreadSetKeySequenceCounter

otThreadGetKeySwitchGuardTime

uint32_t otThreadGetKeySwitchGuardTime(
  otInstance *aInstance
)

Obtenga thrKeySwitchGuardTime.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
El valor de thrKeySwitchGuardTime (en horas).
Ver también:
otThreadSetKeySwitchGuardTime

otThreadGetLeaderData

otError otThreadGetLeaderData(
  otInstance *aInstance,
  otLeaderData *aLeaderData
)

Esta función obtiene los datos del líder del hilo.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[out] aLeaderData
Un puntero al lugar donde se colocan los datos del líder.
Valores devueltos
OT_ERROR_NONE
Recuperado con éxito los datos del líder.
OT_ERROR_DETACHED
Actualmente no adjunto.

otThreadGetLeaderRloc

otError otThreadGetLeaderRloc(
  otInstance *aInstance,
  otIp6Address *aLeaderRloc
)

Esta función devuelve un puntero al RLOC del líder.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[out] aLeaderRloc
Un puntero al RLOC del líder.
Valores devueltos
OT_ERROR_NONE
RLOC del Líder se escribió correctamente a aLeaderRloc .
OT_ERROR_INVALID_ARGS
aLeaderRloc era NULL.
OT_ERROR_DETACHED
Actualmente no está adjunto a una partición de subproceso.

otThreadGetLeaderRouterId

uint8_t otThreadGetLeaderRouterId(
  otInstance *aInstance
)

Obtenga la identificación del enrutador del líder.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
ID del enrutador del líder.

otThreadGetLeaderWeight

uint8_t otThreadGetLeaderWeight(
  otInstance *aInstance
)

Obtenga el peso del líder.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
El peso del líder.

otThreadGetLinkLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetLinkLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

Esta función devuelve la dirección de multidifusión Thread Link-Local All Thread Nodes.

La dirección es una dirección de multidifusión basada en prefijo de unidifusión local de enlace [RFC 3306], con:

  • flgs establecidos en 3 (P = 1 y T = 1)
  • scop establecido en 2
  • plen fijado a 64
  • prefijo de red establecido en el prefijo local de malla
  • ID de grupo establecido en 1

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
Un puntero a la dirección de multidifusión Thread Link-Local All Thread Nodes.

otThreadGetLinkLocalIp6Address

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

Esta función devuelve la dirección IPv6 local de enlace de subproceso.

La dirección local del enlace de subprocesos se deriva utilizando IEEE802.15.4 Extended Address como identificador de interfaz.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
Un puntero a la dirección IPv6 local de enlace de subprocesos.

otThreadGetLinkMode

otLinkModeConfig otThreadGetLinkMode(
  otInstance *aInstance
)

Obtenga la configuración del modo de enlace MLE.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
La configuración del modo de enlace MLE.
Ver también:
otThreadSetLinkMode

otThreadGetMeshLocalEid

const otIp6Address * otThreadGetMeshLocalEid(
  otInstance *aInstance
)

Esta función devuelve un puntero a la dirección EID local de malla.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
Un puntero a la dirección EID local de malla.

otThreadGetMeshLocalPrefix

const otMeshLocalPrefix * otThreadGetMeshLocalPrefix(
  otInstance *aInstance
)

Esta función devuelve un puntero al prefijo local de malla.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
Un puntero al prefijo local de malla.

otThreadGetMleCounters

const otMleCounters * otThreadGetMleCounters(
  otInstance *aInstance
)

Obtenga los contadores de Thread MLE.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
Un puntero a los contadores de Thread MLE.

otThreadGetNetworkKey

void otThreadGetNetworkKey(
  otInstance *aInstance,
  otNetworkKey *aNetworkKey
)

Obtenga la clave de red del hilo.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[out] aNetworkKey
Un puntero a un otNetworkkey para devolver el hilo clave de red.
Ver también:
otThreadSetNetworkKey

otThreadGetNetworkKeyRef

otNetworkKeyRef otThreadGetNetworkKeyRef(
  otInstance *aInstance
)

Obtener el otNetworkKeyRef de Tema Clave de red.

Esta función requiere la función del tiempo de construcción OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE esté habilitado.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
Referencia a la clave de red de subprocesos almacenada en la memoria.
Ver también:
otThreadSetNetworkKeyRef

otThreadGetNetworkName

const char * otThreadGetNetworkName(
  otInstance *aInstance
)

Obtenga el nombre de la red de subprocesos.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
Devoluciones
Un puntero al nombre de la red de subprocesos.
Ver también:
otThreadSetNetworkName

otThreadGetNextDiagnosticTlv

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

Esta función obtiene el siguiente TLV de diagnóstico de red en el mensaje.

Se permite una llamada posterior a esta función solo cuando el valor de retorno actual es OT_ERROR_NONE.

Detalles
Parámetros
[in] aMessage
Un puntero a un mensaje.
[in,out] aIterator
Un puntero al contexto del iterador de diagnóstico de red. Para obtener el primer TLV de diagnóstico de red, debe establecerse en OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT.
[out] aNetworkDiagTlv
Un puntero al lugar donde se colocará la información del TLV de diagnóstico de red.
Valores devueltos
OT_ERROR_NONE
Encontré con éxito el próximo TLV de diagnóstico de red.
OT_ERROR_NOT_FOUND
No existe ningún TLV de diagnóstico de red posterior en el mensaje.
OT_ERROR_PARSE
Error al analizar el siguiente diagnóstico de red.

otThreadGetNextNeighborInfo

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

Esta función obtiene la siguiente información del vecino.

Se utiliza para revisar las entradas de la tabla vecina.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[in,out] aIterator
Un puntero al contexto del iterador. Para obtener la primera entrada de vecino, debe establecerse en OT_NEIGHBOR_INFO_ITERATOR_INIT.
[out] aInfo
Un puntero a la información del vecino.
Valores devueltos
OT_ERROR_NONE
Se encontró con éxito la siguiente entrada de vecino en la tabla.
OT_ERROR_NOT_FOUND
No existe ninguna entrada de vecino posterior en la tabla.
OT_ERROR_INVALID_ARGS
aIterator o aInfo era nulo.

otThreadGetParentAverageRssi

otError otThreadGetParentAverageRssi(
  otInstance *aInstance,
  int8_t *aParentRssi
)

La función recupera el RSSI promedio para el Thread Parent.

Detalles
Parámetros
[in] aInstance
Un puntero a una instancia de OpenThread.
[out] aParentRssi
Un puntero al lugar donde se debe colocar el RSSI padre.

otThreadGetParentInfo

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

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

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

otThreadGetParentLastRssi

otError otThreadGetParentLastRssi(
  otInstance *aInstance,
  int8_t *aLastRssi
)

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

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

otThreadGetPartitionId

uint32_t otThreadGetPartitionId(
  otInstance *aInstance
)

Get the Partition ID.

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

otThreadGetRealmLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

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

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

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

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

otThreadGetRloc

const otIp6Address * otThreadGetRloc(
  otInstance *aInstance
)

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

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

otThreadGetRloc16

uint16_t otThreadGetRloc16(
  otInstance *aInstance
)

Get the RLOC16.

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

otThreadGetServiceAloc

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

This function retrieves the Service ALOC for given Service ID.

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

otThreadGetVersion

uint16_t otThreadGetVersion(
  void
)

This function gets the Thread protocol version.

Details
Returns
the Thread protocol version.

otThreadIsAnycastLocateInProgress

bool otThreadIsAnycastLocateInProgress(
  otInstance *aInstance
)

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

This function is only available when OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE is enabled.

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

otThreadIsDiscoverInProgress

bool otThreadIsDiscoverInProgress(
  otInstance *aInstance
)

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

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

otThreadIsSingleton

bool otThreadIsSingleton(
  otInstance *aInstance
)

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

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

otThreadLocateAnycastDestination

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

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

This function is only available when OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE is enabled.

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

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

otThreadRegisterParentResponseCallback

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

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

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

otThreadResetIp6Counters

void otThreadResetIp6Counters(
  otInstance *aInstance
)

Reset the IPv6 counters.

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

otThreadResetMleCounters

void otThreadResetMleCounters(
  otInstance *aInstance
)

Reset the Thread MLE counters.

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

otThreadSendAddressNotification

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

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

This function is only available when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE is enabled.

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

otThreadSendDiagnosticGet

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

Send a Network Diagnostic Get request.

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

otThreadSendDiagnosticReset

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

Send a Network Diagnostic Reset request.

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

otThreadSendProactiveBackboneNotification

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

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

This function is only available when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE is enabled.

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

otThreadSetChildTimeout

void otThreadSetChildTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

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

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

otThreadSetDiscoveryRequestCallback

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

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

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

otThreadSetDomainName

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

Set the Thread Domain Name.

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

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

otThreadSetEnabled

otError otThreadSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

This function starts Thread protocol operation.

The interface must be up when calling this function.

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

otThreadSetExtendedPanId

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

Set the IEEE 802.15.4 Extended PAN ID.

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

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

otThreadSetFixedDuaInterfaceIdentifier

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

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

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

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

otThreadSetJoinerAdvertisement

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

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

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

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

otThreadSetKeySequenceCounter

void otThreadSetKeySequenceCounter(
  otInstance *aInstance,
  uint32_t aKeySequenceCounter
)

Set the thrKeySequenceCounter.

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

otThreadSetKeySwitchGuardTime

void otThreadSetKeySwitchGuardTime(
  otInstance *aInstance,
  uint32_t aKeySwitchGuardTime
)

Set the thrKeySwitchGuardTime.

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

otThreadSetLinkMode

otError otThreadSetLinkMode(
  otInstance *aInstance,
  otLinkModeConfig aConfig
)

Set the MLE Link Mode configuration.

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

otThreadSetMeshLocalPrefix

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

This function sets the Mesh Local Prefix.

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

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

otThreadSetNetworkKey

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

Set the Thread Network Key.

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

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

otThreadSetNetworkKeyRef

otError otThreadSetNetworkKeyRef(
  otInstance *aInstance,
  otNetworkKeyRef aKeyRef
)

Set the Thread Network Key as a otNetworkKeyRef .

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

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

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

otThreadSetNetworkName

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

Set the Thread Network Name.

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

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

Macros

OT_JOINER_ADVDATA_MAX_LENGTH

 OT_JOINER_ADVDATA_MAX_LENGTH 64

Maximum AdvData Length of Joiner Advertisement.

OT_NEIGHBOR_INFO_ITERATOR_INIT

 OT_NEIGHBOR_INFO_ITERATOR_INIT 0

Initializer for otNeighborInfoIterator.

OT_NETWORK_BASE_TLV_MAX_LENGTH

 OT_NETWORK_BASE_TLV_MAX_LENGTH 254

Maximum value length of Thread Base TLV.

OT_NETWORK_DATA_ITERATOR_INIT

 OT_NETWORK_DATA_ITERATOR_INIT 0

Value to initialize otNetworkDataIterator .

OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE

 OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE 3

Size of Network Diagnostic Child Table entry.

OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT

 OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT 0

Initializer for otNetworkDiagIterator.

OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES

 OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19

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

OT_NETWORK_MAX_ROUTER_ID

 OT_NETWORK_MAX_ROUTER_ID 62

Maximum Router ID.

OT_SERVER_DATA_MAX_SIZE

 OT_SERVER_DATA_MAX_SIZE 248

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

OT_SERVICE_DATA_MAX_SIZE

 OT_SERVICE_DATA_MAX_SIZE 252

Max size of Service Data in bytes.