Google se compromete a impulsar la igualdad racial para las comunidades afrodescendientes. Obtén información al respecto.
Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

General

Este módulo incluye funciones para todas las funciones de Thread.

Resumen

El editor de datos de red proporciona mecanismos para limitar la cantidad de entradas de servicios o prefijos similares (prefijo en malla o ruta externa) en los datos de red de subprocesos mediante la supervisión de los datos de red y la administración de si se deben agregar o quitar entradas.

Todas las funciones de este módulo requieren que se habilite OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE.

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

Typedefs

otBorderRouterConfig typedef
Esta estructura representa una configuración de router de borde.
otDetachGracefullyCallback)(void *aContext) typedef
void(*
Este callback le informa a la aplicación que finalizó el proceso de desconexión.
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 de subprocesos.
otLinkModeConfig typedef
Esta estructura representa una configuración del modo de vínculo MLE.
otMleCounters typedef
struct otMleCounters
Esta estructura representa los contadores de MLE de Thread.
otNeighborInfoIterator typedef
int16_t
Se usa para iterar a través de una tabla vecina.
otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext) typedef
void(*
Este tipo de puntero de función define la devolución de llamada que se usa para notificar cuando se agrega una entrada de servicio de DNS/SRP a los datos de red de subprocesos o se quita de ellos.
otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext) typedef
void(*
Este tipo de puntero de función define la devolución de llamada que se usa para notificar cuando se agrega una entrada de prefijo (en la malla o una ruta externa) a los datos de red de Thread o se quita.
otNetDataPublisherEvent typedef
Esta enumeración representa los eventos informados desde las devoluciones de llamada del publicador.
otNetworkDataIterator typedef
uint32_t
Se usa 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 usa para iterar a través del TLV de diagnóstico de red.
otNetworkDiagMacCounters typedef
Esta estructura representa un valor de contador de Mac de diagnóstico de red.
otNetworkDiagRoute typedef
Esta estructura representa un valor de TLV de la 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(*
Se llama a este puntero de función cuando se recibe una respuesta Get de diagnóstico de la red.
otRoutePreference typedef
Define valores válidos para mPreference en otExternalRouteConfig y otBorderRouterConfig.
otServerConfig typedef
Esta estructura representa una configuración del 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 de función define la devolución de llamada para notificar el resultado de una solicitud otThreadLocateAnycastDestination().
otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext) typedef
void(*
Se llama a este puntero de función 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(*
Se llama a este puntero de función cada vez que se recibe un mensaje de respuesta superior de MLE.
otThreadParentResponseInfo typedef
Esta estructura representa los datos de la respuesta principal de MLE.

Funciones

otNetDataContainsOmrPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
Esta función verifica si un prefijo determinado puede actuar como un prefijo de OMR válido y si también lo contiene el dato de red del líder.
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 de malla 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
Obtén la versión estable de datos de red.
otNetDataGetVersion(otInstance *aInstance)
uint8_t
Obtén la versión de datos de la red.
otNetDataIsDnsSrpServiceAdded(otInstance *aInstance)
bool
Esta función indica si se agregó o no la entrada "DNS/SRP Service' a los datos de red de Thread.
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 una ruta externa) a los datos de red de Thread.
otNetDataPublishDnsSrpServiceAnycast(otInstance *aInstance, uint8_t aSequenceNUmber)
void
Esta función solicita que la dirección Anycast del servicio de DNS/SRP se publique en los datos de la red Thread.
otNetDataPublishDnsSrpServiceUnicast(otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort)
void
Esta función solicita que la dirección Unicast del servicio DNS/SRP se publique en los datos de la red Thread.
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(otInstance *aInstance, uint16_t aPort)
void
Esta función solicita que la dirección Unicast del servicio DNS/SRP se publique en los datos de la red Thread.
otNetDataPublishExternalRoute(otInstance *aInstance, const otExternalRouteConfig *aConfig)
Esta función solicita que se publique un prefijo de ruta externo en los datos de la red Thread.
otNetDataPublishOnMeshPrefix(otInstance *aInstance, const otBorderRouterConfig *aConfig)
Esta función solicita que se publique un prefijo en la malla en los datos de la red Thread.
otNetDataSetDnsSrpServicePublisherCallback(otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext)
void
Esta función configura una devolución de llamada para notificar cuando un "servicio DNS/SRP" publicado se agrega o quita de los datos de red de Thread.
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 se agrega o quita de los datos de red de Thread.
otNetDataSteeringDataCheckJoiner(otInstance *aInstance, const otExtAddress *aEui64)
Compruebe si los datos de dirección incluyen un elemento Joiner.
otNetDataSteeringDataCheckJoinerWithDiscerner(otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner)
Verifica si los datos de dirección incluyen un elemento Joiner con un valor determinado de discernimiento.
otNetDataUnpublishDnsSrpService(otInstance *aInstance)
void
Anula la publicación de cualquier entrada de servicio de DNS/SRP (Anycast o Unicast) que se haya agregado anteriormente de los datos de red de Thread.
otNetDataUnpublishPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
Anula la publicación de un prefijo de ruta externa o en malla ya publicado.
otThreadBecomeChild(otInstance *aInstance)
Intenta volver a adjuntarte como niño.
otThreadBecomeDetached(otInstance *aInstance)
Desconéctate de la red Thread.
otThreadDetachGracefully(otInstance *aInstance, otDetachGracefullyCallback aCallback, void *aContext)
Esta función notifica a otros nodos de la red (si los hubiera) y, luego, detiene la operación del protocolo Thread.
otThreadDeviceRoleToString(otDeviceRole aRole)
const char *
Convierte la función del dispositivo en una string legible.
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
Obtiene el tiempo de espera de conversación de subprocesos secundarios (en segundos) que se usa cuando se opera en la función secundaria.
otThreadGetDeviceRole(otInstance *aInstance)
Obtén la función de dispositivo.
otThreadGetDomainName(otInstance *aInstance)
const char *
Obtiene el nombre de dominio del subproceso.
otThreadGetExtendedPanId(otInstance *aInstance)
const otExtendedPanId *
Obtiene el ID PAN extendido IEEE 802.15.4.
otThreadGetFixedDuaInterfaceIdentifier(otInstance *aInstance)
Obtiene el identificador de interfaz especificado manualmente para la dirección de unicat de dominio de Thread.
otThreadGetIp6Counters(otInstance *aInstance)
const otIpCounters *
Obtiene los contadores de IPv6.
otThreadGetKeySequenceCounter(otInstance *aInstance)
uint32_t
Obtiene el thrKeySequenceCounter.
otThreadGetKeySwitchGuardTime(otInstance *aInstance)
uint32_t
Obtiene el thrKeySwitchGuardTime (en horas).
otThreadGetLeaderData(otInstance *aInstance, otLeaderData *aLeaderData)
Esta función obtiene los datos del líder de subprocesos.
otThreadGetLeaderRloc(otInstance *aInstance, otIp6Address *aLeaderRloc)
Esta función muestra un puntero al RLOC del líder.
otThreadGetLeaderRouterId(otInstance *aInstance)
uint8_t
Obtén el ID de router del líder.
otThreadGetLeaderWeight(otInstance *aInstance)
uint8_t
Obtén el peso del líder.
otThreadGetLinkLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
const otIp6Address *
Obtiene la dirección de multidifusión de Thread Link-Local All Thread Nodes.
otThreadGetLinkLocalIp6Address(otInstance *aInstance)
const otIp6Address *
Obtiene la dirección IPv6 del vínculo local de Thread.
otThreadGetLinkMode(otInstance *aInstance)
Obtén la configuración del modo de vínculo MLE.
otThreadGetMeshLocalEid(otInstance *aInstance)
const otIp6Address *
Obtiene la dirección EID local de la malla.
otThreadGetMeshLocalPrefix(otInstance *aInstance)
Esta función muestra un puntero al prefijo local de malla.
otThreadGetMleCounters(otInstance *aInstance)
const otMleCounters *
Obtiene los contadores de MLE de Thread.
otThreadGetNetworkKey(otInstance *aInstance, otNetworkKey *aNetworkKey)
void
Obtén la clave de red Thread.
otThreadGetNetworkKeyRef(otInstance *aInstance)
Obtén la otNetworkKeyRef para la clave de red de Thread.
otThreadGetNetworkName(otInstance *aInstance)
const char *
Obtén el nombre de la red de Thread.
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 del subproceso superior.
otThreadGetParentInfo(otInstance *aInstance, otRouterInfo *aParentInfo)
La función recupera información de diagnóstico para un Thread Router como superior.
otThreadGetParentLastRssi(otInstance *aInstance, int8_t *aLastRssi)
La función recupera el RSSI del último paquete del subproceso superior.
otThreadGetPartitionId(otInstance *aInstance)
uint32_t
Obtén el ID de partición.
otThreadGetRealmLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
const otIp6Address *
Obtiene la dirección multidifusión de Thread Realm-Local All Thread Nodes.
otThreadGetRloc(otInstance *aInstance)
const otIp6Address *
Obtiene la dirección del localizador de enrutamiento de subprocesos (RLOC).
otThreadGetRloc16(otInstance *aInstance)
uint16_t
Obtén el RLOC16.
otThreadGetServiceAloc(otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc)
Esta función recupera el ALOC del servicio para un ID de servicio determinado.
otThreadGetVersion(void)
uint16_t
Esta función obtiene la versión de protocolo de Thread.
otThreadIsAnycastLocateInProgress(otInstance *aInstance)
bool
Esta función indica si una solicitud de ubicación Anycast está en curso.
otThreadIsDiscoverInProgress(otInstance *aInstance)
bool
Esta función determina si actualmente hay un descubrimiento de subprocesos de MLE en curso.
otThreadIsSingleton(otInstance *aInstance)
bool
Esta función indica si un nodo es el único router de 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 dirección Anycast determinada.
otThreadRegisterParentResponseCallback(otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext)
void
Esta función registra una devolución de llamada para recibir datos de la respuesta principal de MLE.
otThreadResetIp6Counters(otInstance *aInstance)
void
Restablece los contadores de IPv6.
otThreadResetMleCounters(otInstance *aInstance)
void
Restablece los contadores de MLE de Thread.
otThreadSearchForBetterParent(otInstance *aInstance)
Inicia el proceso para que el elemento secundario busque un superior y, al mismo tiempo, permanezca conectado a su elemento superior actual.
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ía 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 troncal proactiva (PRO_BB.ntf) en el vínculo de la red troncal.
otThreadSetChildTimeout(otInstance *aInstance, uint32_t aTimeout)
void
Establece el tiempo de espera del elemento secundario del subproceso (en segundos) que se usa cuando se opera en la función secundaria.
otThreadSetDiscoveryRequestCallback(otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext)
void
Esta función establece una devolución de llamada para recibir datos de la solicitud de descubrimiento de MLE.
otThreadSetDomainName(otInstance *aInstance, const char *aDomainName)
Establece 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)
Configura el ID de PAN extendido IEEE 802.15.4.
otThreadSetFixedDuaInterfaceIdentifier(otInstance *aInstance, const otIp6InterfaceIdentifier *aIid)
Establece o borra el identificador de interfaz especificado manualmente para la dirección Unicast de Thread.
otThreadSetJoinerAdvertisement(otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength)
Este método establece el anuncio del conector de subprocesos cuando se descubre la red de subprocesos.
otThreadSetKeySequenceCounter(otInstance *aInstance, uint32_t aKeySequenceCounter)
void
Configura thrKeySequenceCounter.
otThreadSetKeySwitchGuardTime(otInstance *aInstance, uint32_t aKeySwitchGuardTime)
void
Configura el thrKeySwitchGuardTime (en horas).
otThreadSetLinkMode(otInstance *aInstance, otLinkModeConfig aConfig)
Establece la configuración del modo de vínculo MLE.
otThreadSetMeshLocalPrefix(otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix)
Esta función establece el prefijo local de la malla.
otThreadSetNetworkKey(otInstance *aInstance, const otNetworkKey *aKey)
Configura la clave de red del subproceso.
otThreadSetNetworkKeyRef(otInstance *aInstance, otNetworkKeyRef aKeyRef)
Configura la clave de red del subproceso como otNetworkKeyRef.
otThreadSetNetworkName(otInstance *aInstance, const char *aNetworkName)
Configura el nombre de la red Thread.

Structs

otBorderRouterConfig

Esta estructura representa una configuración de router de borde.

otExternalRouteConfig

Esta estructura representa una configuración de ruta externa.

otIpCounters

Esta estructura representa los contadores de nivel de IP.

DatosdeotLeader

Esta estructura representa los datos del líder de subprocesos.

otLinkModeConfig

Esta estructura representa una configuración del modo de vínculo MLE.

otMleCounters

Esta estructura representa los contadores de MLE de Thread.

otvecino

Esta estructura contiene información de diagnóstico para un nodo de 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 contador de Mac de diagnóstico de red.

otNetworkDiagRoute

Esta estructura representa un valor de TLV de la 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 router de subprocesos.

otServerConfig.

Esta estructura representa una configuración del 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 la respuesta principal de MLE.

Enumeraciones

enumeración anónima

 anonymous enum
Propiedades
OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL

Nivel de batería TLV.

OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES

TLV de los canales de usuario.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE

TLV de la tabla secundaria

OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY

TLV de la conectividad

OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS

TLV de dirección extendida de MAC

OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST

Lista TLV de la dirección IPv6.

OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA

TLV de los datos del líder.

OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS

TLV del contador de MAC

OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT

TLV máx. de tiempo de espera del elemento secundario

OT_NETWORK_DIAGNOSTIC_TLV_MODE

Modo TLV.

OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA

TLV de los datos de red

OT_NETWORK_DIAGNOSTIC_TLV_ROUTE

TLV de Route64.

OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS

Address16 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE

TLV del voltaje de suministro

OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT

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

OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST

Escribe el TLV de la lista.

Función del dispositivo ot

 otDeviceRole

Representa una función del dispositivo Thread.

Propiedades
OT_DEVICE_ROLE_CHILD

La función Thread Child.

OT_DEVICE_ROLE_DETACHED

No participas en una red o partición de Thread.

OT_DEVICE_ROLE_DISABLED

La pila Thread está inhabilitada.

OT_DEVICE_ROLE_LEADER

La función de líder del subproceso

OT_DEVICE_ROLE_ROUTER

La función de router de subprocesos.

otNetDataPublisherEvent

 otNetDataPublisherEvent

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

Propiedades
OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED

La entrada publicada se agrega a los datos de red de Thread.

OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED

Se quita la entrada publicada de los datos de red de Thread.

otRoutePreference

 otRoutePreference

Define 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 router de borde.

otDetachGraceGraceCallback

void(* otDetachGracefullyCallback)(void *aContext)

Este callback le informa a la aplicación que finalizó el proceso de desconexión.

Detalles
Parámetros
[in] aContext
Un puntero al contexto específico de la aplicación.

Configuración otExternalRouteConfig

struct otExternalRouteConfig otExternalRouteConfig

Esta estructura representa una configuración de ruta externa.

Contadores otIp

struct otIpCounters otIpCounters

Esta estructura representa los contadores de nivel de IP.

Datos principales de otLeader

struct otLeaderData otLeaderData

Esta estructura representa los datos del líder de subprocesos.

otLinkModeConfig

struct otLinkModeConfig otLinkModeConfig

Esta estructura representa una configuración del modo de vínculo MLE.

otMleCounters

struct otMleCounters otMleCounters

Esta estructura representa los contadores de MLE de Thread.

otNeighborInfoIterator

int16_t otNeighborInfoIterator

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

otNetDataDnsSrpServicePublisherCallback

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

Este tipo de puntero de función define la devolución de llamada que se usa para notificar cuando se agrega una entrada de servicio de DNS/SRP a los datos de red de subprocesos o se quita de ellos.

Cuando se quita la devolución de llamada, se invoca independientemente de que Publisher quite la entrada (p. ej., cuando ya hay demasiadas entradas similares en los datos de red) o mediante una llamada explícita para anular la publicación (es decir, una llamada a otNetDataUnpublishDnsSrpService()).

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

otNetDataPrefixPublisherPublisher

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

Este tipo de puntero de función define la devolución de llamada que se usa para notificar cuando se agrega una entrada de prefijo (en la malla o una ruta externa) a los datos de red de Thread o se quita.

Cuando se quita, se invoca la devolución de llamada independientemente de que Publisher quite la entrada (p.ej., cuando ya hay demasiadas entradas similares en los datos de red) o mediante una llamada explícita para anular la publicación.

Detalles
Parámetros
[in] aEvent
Indica el evento (si se agregó o quitó la entrada).
[in] aPrefix
Un puntero para la entrada de prefijo.
[in] aContext
Un puntero al contexto específico de la aplicación.

otNetDataPublisherEvent

enum otNetDataPublisherEvent otNetDataPublisherEvent

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

otNetworkDataIterator

uint32_t otNetworkDataIterator

Se usa 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 usa para iterar a través del TLV de diagnóstico de red.

otNetworkDiagMacCounters

struct otNetworkDiagMacCounters otNetworkDiagMacCounters

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

Consulta RFC 2863 para ver las definiciones de los campos de los miembros.

otNetworkDiagRoute

struct otNetworkDiagRoute otNetworkDiagRoute

Esta estructura representa un valor de TLV de la 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)

Se llama a este puntero de función cuando se recibe una respuesta Get de diagnóstico de la red.

Detalles
Parámetros
[in] aError
Se produjo un error al obtener la respuesta.
[in] aMessage
Un puntero al búfer de mensajes que contiene la carga útil de respuesta de diagnóstico de red recibida. Solo está disponible cuando aError es OT_ERROR_NONE.
[in] aMessageInfo
Un puntero a la información del mensaje para aMessage. Solo 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 valores válidos para mPreference en otExternalRouteConfig y otBorderRouterConfig.

Configuración del servidor ot

struct otServerConfig otServerConfig

Esta estructura representa una configuración del 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 de función define la devolución de llamada para notificar el resultado de una solicitud otThreadLocateAnycastDestination().

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 procesar la solicitud. OT_ERROR_NONE indica que la prueba se realizó con éxito. OT_ERROR_RESPONSE_TIMEOUT indica que no se pudo encontrar un destino. OT_ERROR_ABORT indica que la solicitud se anuló.
[in] aMeshLocalAddress
Un puntero al EID local de la malla del destino más cercano de la dirección Anycast cuando aError es OT_ERROR_NONE; de lo contrario, es NULL.
[in] aRloc16
El RLOC16 del destino, si se encuentra; de lo contrario, el RLOC16 (0xfffe) no es válido.

otThreadDiscoveryRequestCallback

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

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

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

otThreadDiscoveryRequestInfo

struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo

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

otThreadParentResponseCallback.

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

Se llama a este puntero de función cada vez que se recibe un mensaje de respuesta superior de MLE.

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

otThreadParentResponseInfo.

struct otThreadParentResponseInfo otThreadParentResponseInfo

Esta estructura representa los datos de la respuesta principal de MLE.

Funciones

otNetDataContainsOmrPrefix

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

Esta función verifica si un prefijo determinado puede actuar como un prefijo de OMR válido y si también lo contiene el dato de red del líder.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aPrefix
Un puntero al prefijo IPv6
Qué muestra
Si aPrefix es un prefijo de OMR válido y los Datos de red del líder contienen el prefijo de OMR aPrefix.

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 para una instancia de OpenThread.
[in] aStable
Es TRUE cuando se copia la versión estable y FALSE cuando se copia la versión completa.
[out] aData
Un puntero para el búfer de datos.
[in,out] aDataLength
En la entrada, el tamaño del búfer de datos al que apunta aData. Al salir, la cantidad de bytes copiados.

otNetDataGetNextOnMeshPrefix

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

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

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in,out] aIterator
Un puntero al contexto del iterador de datos de red. Para obtener la primera entrada en la malla, debe configurarse como OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Un puntero a la ubicación en la que se colocará la información del prefijo On Mesh.
Valores de retorno
OT_ERROR_NONE
Se encontró correctamente el siguiente prefijo de malla.
OT_ERROR_NOT_FOUND
No existe ningún prefijo On Mesh posterior en los datos de red de Thread.

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 para 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, debes establecerla en OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Un puntero a la ubicación en la que se colocará la información de la ruta externa.
Valores de retorno
OT_ERROR_NONE
Se encontró correctamente la siguiente ruta externa.
OT_ERROR_NOT_FOUND
No existe una entrada de ruta externa posterior en los datos de red de Thread.

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 para 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 configurarse como OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Un puntero al lugar donde se colocará la información del servicio.
Valores de retorno
OT_ERROR_NONE
Se encontró correctamente 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
)

Obtén la versión estable de datos de red.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
La versión de datos de red estable.

otNetDataGetVersion

uint8_t otNetDataGetVersion(
  otInstance *aInstance
)

Obtén la versión de datos de la red.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
La versión de datos de red.

otNetDataIsDnsSrpServiceAdded

bool otNetDataIsDnsSrpServiceAdded(
  otInstance *aInstance
)

Esta función indica si se agregó o no la entrada "DNS/SRP Service' a los datos de red de Thread.

Esta función requiere que se habilite la función OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Valores de retorno
TRUE
La entrada del servicio de DNS/SRP publicada se agrega a los datos de la red de Thread.
FALSE
La entrada no se agrega a los datos de red de Thread o no hay entradas 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 una ruta externa) a los datos de red de Thread.

Esta función requiere que se habilite la función OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aPrefix
Un puntero para el prefijo (NO DEBE ser NULO).
Valores de retorno
TRUE
La entrada de prefijo publicada se agrega a los datos de red de Thread.
FALSE
La entrada no se agrega a los datos de red de Thread o no hay entradas para publicar.

otNetDataPublishDnsSrpServiceAnycast

void otNetDataPublishDnsSrpServiceAnycast(
  otInstance *aInstance,
  uint8_t aSequenceNUmber
)

Esta función solicita que la dirección Anycast del servicio de DNS/SRP se publique en los datos de la red Thread.

Esta función requiere que se habilite la función OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

Una llamada a esta función quitará y reemplazará cualquier entrada anterior del "Servicio DNS/SRP" que se haya publicado (de una llamada anterior a cualquiera de las funciones otNetDataPublishDnsSrpService{Type}()).

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

otNetDataPublishDnsSrpServiceUnicast

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

Esta función solicita que la dirección Unicast del servicio DNS/SRP se publique en los datos de la red Thread.

Esta función requiere que se habilite la función OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

Una llamada a esta función quitará y reemplazará cualquier entrada anterior del "Servicio DNS/SRP" que se haya publicado (de una llamada anterior a cualquiera de las funciones otNetDataPublishDnsSrpService{Type}()).

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

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

otNetDataPublishDnsSrpServiceUnicastMeshLocalEid

void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(
  otInstance *aInstance,
  uint16_t aPort
)

Esta función solicita que la dirección Unicast del servicio DNS/SRP se publique en los datos de la red Thread.

Esta función requiere que se habilite la función OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

Una llamada a esta función quitará y reemplazará cualquier entrada anterior del"Servicio DNS/SRP"que se haya publicado (de una llamada anterior a cualquiera de las funciones otNetDataPublishDnsSrpService{Type}()).

A diferencia de otNetDataPublishDnsSrpServiceUnicast(), que requiere que se proporcione la dirección publicada y que incluya la información de los datos de TLV del servicio, esta función usa el EID local de la malla del dispositivo y, además, incluye la información de los datos de TLV del servidor.

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

otNetDataPublishExternalRoute

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

Esta función solicita que se publique un prefijo de ruta externo en los datos de la red Thread.

Esta función requiere que se habilite la función OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

Solo se pueden publicar entradas estables (es decir,aConfig.mStable DEBE ser VERDADERO.

Una llamada posterior a este método reemplazará una solicitud anterior por el mismo prefijo. En particular, si la nueva llamada solo cambia las marcas (p.ej., el nivel de preferencia) y el prefijo ya se agregó en los datos de red, el cambio a las marcas se refleja de inmediato en los datos de red. Esto garantiza que las entradas existentes en los datos de red no se quiten abruptamente. Ten en cuenta que un cambio en el nivel de preferencia puede hacer que la entrada se quite de los datos de red después de determinar que hay otros nodos que publican el mismo prefijo con la misma preferencia o una superior.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aConfig
La configuración de ruta externa para publicar (NO DEBE ser NULO).
Valores de retorno
OT_ERROR_NONE
La ruta externa se publicó correctamente.
OT_ERROR_INVALID_ARGS
El aConfig no es válido (prefijo no válido, combinaciones de marcas no válidas o no estables).
OT_ERROR_NO_BUFS
No se pudo asignar una entrada para la solicitud nueva. El editor admite una cantidad limitada de entradas (compartidas entre el prefijo en malla y la ruta externa) determinadas por la 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 la malla en los datos de la red Thread.

Esta función requiere que se habilite la función OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

Solo se pueden publicar entradas estables (es decir,aConfig.mStable DEBE ser VERDADERO.

Una llamada posterior a este método reemplazará una solicitud anterior por el mismo prefijo. En particular, si la nueva llamada solo cambia las marcas (p.ej., el nivel de preferencia) y el prefijo ya se agregó en los datos de red, el cambio a las marcas se refleja de inmediato en los datos de red. Esto garantiza que las entradas existentes en los datos de red no se quiten abruptamente. Ten en cuenta que un cambio en el nivel de preferencia puede hacer que la entrada se quite de los datos de red después de determinar que hay otros nodos que publican el mismo prefijo con la misma preferencia o una superior.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aConfig
La configuración de prefijo en malla para publicar (NO DEBE ser NULO).
Valores de retorno
OT_ERROR_NONE
El prefijo en malla se publicó correctamente.
OT_ERROR_INVALID_ARGS
El aConfig no es válido (prefijo no válido, combinaciones de marcas no válidas o no estables).
OT_ERROR_NO_BUFS
No se pudo asignar una entrada para la solicitud nueva. El editor admite una cantidad limitada de entradas (compartidas entre el prefijo en malla y la ruta externa) determinadas por la configuración OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES.

otNetDataSetDnsSrpServicePublisherCallback

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

Esta función configura una devolución de llamada para notificar cuando un "servicio DNS/SRP" publicado se agrega o quita de los datos de red de Thread.

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

Esta función requiere que se habilite la función OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

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

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 se agrega o quita de los datos de red de Thread.

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

Esta función requiere que se habilite la función OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

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

otNetDataSteeringDataCheckJoiner

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

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

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aEui64
Un puntero del IEEE EUI-64 de Joiner.
Valores de retorno
OT_ERROR_NONE
aEui64 se incluye en los datos de dirección.
OT_ERROR_INVALID_STATE
No hay datos de la dirección.
OT_ERROR_NOT_FOUND
aEui64 no se incluye en los datos de dirección.

otNetDataSteeringDataCheckJoinerWithDiscerner

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

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

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aDiscerner
Un puntero del receptor de la unión.
Valores de retorno
OT_ERROR_NONE
aDiscerner se incluye en los datos de dirección.
OT_ERROR_INVALID_STATE
No hay datos de la dirección.
OT_ERROR_NOT_FOUND
aDiscerner no se incluye en los datos de dirección.

otNetDataUnpublishDnsSrpService

void otNetDataUnpublishDnsSrpService(
  otInstance *aInstance
)

Anula la publicación de cualquier entrada de servicio de DNS/SRP (Anycast o Unicast) que se haya agregado anteriormente de los datos de red de Thread.

Se debe habilitar OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

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

otNetDataUnpublishPrefix

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

Anula la publicación de un prefijo de ruta externa o en malla ya publicado.

Se debe habilitar OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

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

otThreadConvertChild

otError otThreadBecomeChild(
  otInstance *aInstance
)

Intenta volver a adjuntarte como niño.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Valores de retorno
OT_ERROR_NONE
Intenta convertirte en niño correctamente.
OT_ERROR_INVALID_STATE
La conversación está inhabilitada.

otThread Separe

otError otThreadBecomeDetached(
  otInstance *aInstance
)

Desconéctate de la red Thread.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Valores de retorno
OT_ERROR_NONE
Se desvinculó correctamente de la red Thread.
OT_ERROR_INVALID_STATE
La conversación está inhabilitada.

otThreadDetachGraceful

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

Esta función notifica a otros nodos de la red (si los hubiera) y, luego, detiene la operación del protocolo Thread.

Envía una liberación de dirección si es un router o establece el tiempo de espera de su hijo en 0 si es un secundario.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aCallback
Un puntero para una función que se llama cuando se termina la desconexión.
[in] aContext
Un puntero para devolver la llamada al contexto específico de la aplicación.
Valores de retorno
OT_ERROR_NONE
Se inició la desvinculación correctamente.
OT_ERROR_BUSY
La desvinculación ya está en curso.

otThreadDeviceRoleToString;

const char * otThreadDeviceRoleToString(
  otDeviceRole aRole
)

Convierte la función del dispositivo en una string legible.

Detalles
Parámetros
[in] aRole
La función del dispositivo que desea convertir.
Qué muestra
Una string 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 para una instancia de OpenThread.
[in] aScanChannels
Un vector pequeño que indica qué canales analizar (p.ej., OT_CHANNEL_11_MASK).
[in] aPanId
El filtro de ID de PAN (configurado como PAN de transmisión para inhabilitar el filtro)
[in] aJoiner
Valor de la marca de unión en el TLV de la solicitud de descubrimiento.
[in] aEnableEui64Filtering
TRUE para filtrar respuestas en EUI-64; de lo contrario, FALSE.
[in] aCallback
Un puntero para una función llamada “recibir una respuesta o un análisis de descubrimiento de MLE”.
[in] aCallbackContext
Un puntero al contexto específico de la aplicación.
Valores de retorno
OT_ERROR_NONE
Se inició correctamente un análisis de subprocesos.
OT_ERROR_INVALID_STATE
La interfaz IPv6 no está habilitada (netif no está activa).
OT_ERROR_NO_BUFS
No se pudo asignar el mensaje a la solicitud de descubrimiento.
OT_ERROR_BUSY
La búsqueda de subprocesos ya está en curso.

otThreadGetChildTimeout

uint32_t otThreadGetChildTimeout(
  otInstance *aInstance
)

Obtiene el tiempo de espera de conversación de subprocesos secundarios (en segundos) que se usa cuando se opera en la función secundaria.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
El valor de tiempo de espera de la conversación secundaria en segundos.
Consulta también:
otThreadSetChildTimeout

otThreadGetDeviceRole

otDeviceRole otThreadGetDeviceRole(
  otInstance *aInstance
)

Obtén la función de dispositivo.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Valores de retorno
OT_DEVICE_ROLE_DISABLED
La pila Thread está inhabilitada.
OT_DEVICE_ROLE_DETACHED
Actualmente, el dispositivo no participa en una red/partición de Thread.
OT_DEVICE_ROLE_CHILD
En este momento, el dispositivo está funcionando como Thread Child.
OT_DEVICE_ROLE_ROUTER
El dispositivo está funcionando como router de subprocesos.
OT_DEVICE_ROLE_LEADER
Actualmente, el dispositivo funciona como líder de subprocesos.

otThreadGetDomainName

const char * otThreadGetDomainName(
  otInstance *aInstance
)

Obtiene el nombre de dominio del subproceso.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
Un puntero para el nombre de dominio del subproceso.
Consulta también:
otThreadSetDomainName

ID de otThreadGetExtendedPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

Obtiene el ID PAN extendido IEEE 802.15.4.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
Un puntero del ID de PAN extendido IEEE 802.15.4.
Consulta también:
otThreadSetExtendedPanId

otThreadGetFixedDuaInterfaceIdentifier

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
  otInstance *aInstance
)

Obtiene el identificador de interfaz especificado manualmente para la dirección de unicat de dominio de Thread.

Disponible cuando OPENTHREAD_CONFIG_DUA_ENABLE está habilitado.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
Un puntero para el identificador de interfaz que se configuró manualmente o NULL si no se estableció ninguno.
Consulta también:
otThreadSetFixedDuaInterfaceIdentifier

otThreadGetIp6Counters

const otIpCounters * otThreadGetIp6Counters(
  otInstance *aInstance
)

Obtiene los contadores de IPv6.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
Un puntero para los contadores de IPv6.

otThreadGetKeySequenceCounter

uint32_t otThreadGetKeySequenceCounter(
  otInstance *aInstance
)

Obtiene el thrKeySequenceCounter.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
El valor thrKeySequenceCounter.
Consulta también:
otThreadSetKeySequenceCounter

otThreadGetKeySwitchGuardTime

uint32_t otThreadGetKeySwitchGuardTime(
  otInstance *aInstance
)

Obtiene el thrKeySwitchGuardTime (en horas).

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
El valor de thrKeySwitchGuardTime (en horas).
Consulta también:
otThreadSetKeySwitchGuardTime

otThreadGetLeaderData

otError otThreadGetLeaderData(
  otInstance *aInstance,
  otLeaderData *aLeaderData
)

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

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aLeaderData
Un puntero para ubicar los datos del líder.
Valores de retorno
OT_ERROR_NONE
Los datos del líder se recuperaron correctamente.
OT_ERROR_DETACHED
No conectado actualmente.

oThreadThreadGetLeaderRloc

otError otThreadGetLeaderRloc(
  otInstance *aInstance,
  otIp6Address *aLeaderRloc
)

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

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aLeaderRloc
Una señal del RLOC del líder.
Valores de retorno
OT_ERROR_NONE
El RLOC del líder se escribió correctamente en aLeaderRloc.
OT_ERROR_INVALID_ARGS
aLeaderRloc era NULO.
OT_ERROR_DETACHED
No conectado actualmente a una partición de subprocesos.

ID de otThreadGetLeaderRouter

uint8_t otThreadGetLeaderRouterId(
  otInstance *aInstance
)

Obtén el ID de router del líder.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
El ID de router del líder.

otThreadGetLeaderWeight

uint8_t otThreadGetLeaderWeight(
  otInstance *aInstance
)

Obtén el peso del líder.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
El peso del líder.

otThreadGetLinkLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetLinkLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

Obtiene la dirección de multidifusión de Thread Link-Local All Thread Nodes.

La dirección es una dirección de multidifusión basada en prefijos Unicast local [RFC 3306] de vínculo, con:

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

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

Dirección otThreadGetLinkLocalIp6

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

Obtiene la dirección IPv6 del vínculo local de Thread.

La dirección local del vínculo de Thread se deriva de la dirección extendida IEEE802.15.4 como identificador de interfaz.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
Un puntero para la dirección IPv6 de vínculo local de Thread.

otThreadGetLinkMode

otLinkModeConfig otThreadGetLinkMode(
  otInstance *aInstance
)

Obtén la configuración del modo de vínculo MLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
La configuración del modo de vínculo MLE.
Consulta también:
otThreadSetLinkMode

otThreadGetMeshLocalEid

const otIp6Address * otThreadGetMeshLocalEid(
  otInstance *aInstance
)

Obtiene la dirección EID local de la malla.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
Un puntero para la dirección EID local de la malla.

otThreadGetMeshLocalPrefix

const otMeshLocalPrefix * otThreadGetMeshLocalPrefix(
  otInstance *aInstance
)

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

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
Un puntero para el prefijo local de malla.

otThreadGetMleCounters

const otMleCounters * otThreadGetMleCounters(
  otInstance *aInstance
)

Obtiene los contadores de MLE de Thread.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
Un puntero para los contadores de MLE de Thread.

otThreadGetNetworkKey

void otThreadGetNetworkKey(
  otInstance *aInstance,
  otNetworkKey *aNetworkKey
)

Obtén la clave de red Thread.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aNetworkKey
Un puntero para un otNetworkkey a fin de mostrar la clave de red del subproceso.
Consulta también:
otThreadSetNetworkKey

otThreadGetNetworkKeyRef

otNetworkKeyRef otThreadGetNetworkKeyRef(
  otInstance *aInstance
)

Obtén la otNetworkKeyRef para la clave de red de Thread.

Esta función requiere que se habilite la función de tiempo de compilación OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
Referencia a la clave de red Thread almacenada en la memoria.
Consulta también:
otThreadSetNetworkKeyRef

otThreadGetNetworkName

const char * otThreadGetNetworkName(
  otInstance *aInstance
)

Obtén el nombre de la red de Thread.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
Un puntero para el nombre de red del subproceso.
Consulta 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 para 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 para ubicar la información de TLV del diagnóstico de la red.
Valores de retorno
OT_ERROR_NONE
Se encontró correctamente el siguiente TLV de diagnóstico de red.
OT_ERROR_NOT_FOUND
No hay ningún TLV de diagnóstico de red posterior en el mensaje.
OT_ERROR_PARSE
Se produjo un 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 usa para recorrer las entradas de la tabla vecina.

Detalles
Parámetros
[in] aInstance
Un puntero para 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 para la información del vecino.
Valores de retorno
OT_ERROR_NONE
Se encontró correctamente 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 del subproceso superior.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aParentRssi
Un puntero para ubicar el RSSI principal

otThreadGetParentInfo

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

La función recupera información de diagnóstico para un Thread Router como superior.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aParentInfo
Un puntero a la ubicación de la información del router superior.

otThreadGetParentLastRssi

otError otThreadGetParentLastRssi(
  otInstance *aInstance,
  int8_t *aLastRssi
)

La función recupera el RSSI del último paquete del subproceso superior.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aLastRssi
Un puntero para ubicar el último RSSI.
Valores de retorno
OT_ERROR_NONE
Se recuperaron correctamente los datos de RSSI.
OT_ERROR_FAILED
No se pueden obtener datos de RSSI.
OT_ERROR_INVALID_ARGS
aLastRssi es NULO.

otThreadGetPartitionId

uint32_t otThreadGetPartitionId(
  otInstance *aInstance
)

Obtén el ID de partición.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
El ID de partición.

otThreadGetRealmLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

Obtiene la dirección multidifusión de Thread Realm-Local All Thread Nodes.

La dirección es una dirección multidifusión basada en prefijos Unicast local [RFC 3306], con lo siguiente:

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

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
Un puntero para la dirección multidifusión de Thread Realm-Local All Thread Nodes.

otThreadGetRloc

const otIp6Address * otThreadGetRloc(
  otInstance *aInstance
)

Obtiene la dirección del localizador de enrutamiento de subprocesos (RLOC).

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
Un puntero para la dirección del localizador de enrutamiento de subprocesos (RLOC).

otThreadGetRloc16

uint16_t otThreadGetRloc16(
  otInstance *aInstance
)

Obtén el RLOC16.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
El RLOC16.

oThreadThreadGetServiceAloc

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

Esta función recupera el ALOC del servicio para un ID de servicio determinado.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aServiceId
ID de servicio para el ALOC.
[out] aServiceAloc
Un puntero para mostrar el ALOC del servicio. NO DEBE SER NULO.
Valores de retorno
OT_ERROR_NONE
Se recuperó correctamente el ALOC del servicio.
OT_ERROR_DETACHED
La interfaz de Thread no está conectada actualmente a una partición de Thread.

otThreadGetVersion

uint16_t otThreadGetVersion(
  void
)

Esta función obtiene la versión de protocolo de Thread.

Detalles
Qué muestra
la versión del protocolo Thread.

otThreadIsAnycastLocateInProgress

bool otThreadIsAnycastLocateInProgress(
  otInstance *aInstance
)

Esta función indica si una solicitud de ubicación Anycast está en curso.

Esta función solo está disponible cuando OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE está habilitado.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
VERDADERO si una solicitud de ubicación Anycast está en curso; de lo contrario, se muestra FALSO.

otThreadIsDiscoverInProgress

bool otThreadIsDiscoverInProgress(
  otInstance *aInstance
)

Esta función determina si actualmente hay un descubrimiento de subprocesos de MLE en curso.

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

otThreadIsSingleton

bool otThreadIsSingleton(
  otInstance *aInstance
)

Esta función indica si un nodo es el único router de la red.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Valores de retorno
TRUE
Es el único router de la red.
FALSE
Es un elemento secundario o no es un router único de la red.

otThreadLocateAnycastDestination

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

Esta función solicita que se ubique el destino más cercano de una dirección Anycast determinada.

Esta función solo está disponible cuando OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE está habilitado.

Si hay una solicitud anterior en curso, se cancelará y reemplazará la solicitud anterior con una llamada posterior a esta función.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aAnycastAddress
La dirección Anycast que se ubicará NO DEBE ser NULO.
[in] aCallback
La función de devolución de llamada para informar el resultado.
[in] aContext
Un contexto arbitrario usado con aCallback.
Valores de retorno
OT_ERROR_NONE
La solicitud se inició correctamente. Se invocará a aCallback para informar el resultado.
OT_ERROR_INVALID_ARGS
aAnycastAddress no es una dirección Anycast válida o aCallback es NULO.
OT_ERROR_NO_BUFS
No hay búfer para preparar y enviar el mensaje de solicitud.

otThreadRegisterParentResponseCallback

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

Esta función registra una devolución de llamada para recibir datos de la respuesta principal de MLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aCallback
Un puntero para una función que se llama cuando se recibe un mensaje de respuesta superior de MLE.
[in] aContext
Un puntero para devolver el contexto específico del cliente.

otThreadResetIp6Counters

void otThreadResetIp6Counters(
  otInstance *aInstance
)

Restablece los contadores de IPv6.

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

otThreadResetMleCounters

void otThreadResetMleCounters(
  otInstance *aInstance
)

Restablece los contadores de MLE de Thread.

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

otThreadSearchForBetterParent.

otError otThreadSearchForBetterParent(
  otInstance *aInstance
)

Inicia el proceso para que el elemento secundario busque un superior y, al mismo tiempo, permanezca conectado a su elemento superior actual.

Debe usarse cuando el dispositivo esté conectado como niño.

Detalles
Valores de retorno
OT_ERROR_NONE
Se inició con éxito el proceso para buscar un mejor padre o madre.
OT_ERROR_INVALID_STATE
La función del dispositivo no es secundaria.

otThreadSendAddressNotification

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

Esta función envía un mensaje de Notificación de dirección proactiva (ADDR_NTF.ntf).

Esta función solo está disponible cuando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE está habilitado.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aDestination
El destino para enviar el mensaje ADDR_NTF.ntf.
[in] aTarget
La dirección objetivo del mensaje ADDR_NTF.ntf.
[in] aMlIid
Es el ID de AA del mensaje ADDR_NTF.ntf.

otThreadSendDiagnosticGet

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

Envía una solicitud de obtención de diagnóstico de red.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aDestination
Un puntero para la dirección de destino.
[in] aTlvTypes
Una matriz de tipos de TLV de diagnóstico de red.
[in] aCount
Cantidad de tipos en aTlvTypes.
[in] aCallback
Un puntero para una función que se llama cuando se recibe una respuesta Get de diagnóstico de la red o NULL para inhabilitar la devolución de llamada.
[in] aCallbackContext
Un puntero al contexto específico de la aplicación.
Valores de retorno
OT_ERROR_NONE
Se puso en cola correctamente el DIAG_GET.req.
OT_ERROR_NO_BUFS
No hay suficientes búferes de mensajes disponibles para enviar DIAG_GET.req.

otThreadSendDiagnosticReset

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

Envíe una solicitud de restablecimiento de diagnóstico de red.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aDestination
Un puntero para la dirección de destino.
[in] aTlvTypes
Una matriz de tipos de TLV de diagnóstico de red. Actualmente, solo se permite el tipo 9.
[in] aCount
Cantidad de tipos en aTlvTypes
Valores de retorno
OT_ERROR_NONE
El DIAG_RST.ntf se agregó correctamente a la cola.
OT_ERROR_NO_BUFS
No hay suficientes búferes de mensajes disponibles para enviar DIAG_RST.ntf.

notificación de la espina dorsal otThreadSend

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

Esta función envía un mensaje de notificación troncal proactiva (PRO_BB.ntf) en el vínculo de la red troncal.

Esta función solo está disponible cuando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE está habilitado.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aTarget
Es la dirección de destino del mensaje PRO_BB.ntf.
[in] aMlIid
El ML-IID del mensaje PRO_BB.ntf.
[in] aTimeSinceLastTransaction
Tiempo transcurrido desde la última transacción (en segundos).
Valores de retorno
OT_ERROR_NONE
El vínculo PRO_BB.ntf se envió correctamente a la red troncal.
OT_ERROR_NO_BUFS
Si no hay suficientes búferes de mensajes disponibles.

otThreadSetChildTimeout

void otThreadSetChildTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

Establece el tiempo de espera del elemento secundario del subproceso (en segundos) que se usa cuando se opera en la función secundaria.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aTimeout
El valor de tiempo de espera en segundos.
Consulta también:
otThreadGetChildTimeout

otThreadSetDiscoveryRequestCallback

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

Esta función establece una devolución de llamada para recibir datos de la solicitud de descubrimiento de MLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aCallback
Un puntero para una función a la que se llama cuando recibe un mensaje de solicitud de descubrimiento de MLE.
[in] aContext
Un puntero para devolver la llamada al contexto específico de la aplicación.

otThreadSetDomainName

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

Establece el nombre de dominio del subproceso.

Solo tiene éxito cuando se inhabilitan los protocolos de Thread.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aDomainName
Un puntero para el nombre de dominio del subproceso.
Valores de retorno
OT_ERROR_NONE
Se configuró correctamente el nombre de dominio del subproceso.
OT_ERROR_INVALID_STATE
Los protocolos de subprocesos están habilitados.
Consulta también:
otThreadGetDomainName

otThreadSetEnabled

otError otThreadSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Esta función inicia la operación del protocolo Thread.

La interfaz debe estar activa cuando se llama a esta función.

Si llamas a esta función con aEnabled establecido en FALSE, se detendrá cualquier proceso de desconexión iniciado por otThreadDetachGraceful(). Se llamará a su devolución de llamada.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aEnabled
TRUE si Thread está habilitado; de lo contrario, se muestra FALSE.
Valores de retorno
OT_ERROR_NONE
La operación del protocolo Thread se inició correctamente.
OT_ERROR_INVALID_STATE
La interfaz de red no funcionaba.

otThreadSetExtendedPanId

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

Configura el ID de PAN extendido IEEE 802.15.4.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aExtendedPanId
Un puntero del ID de PAN extendido IEEE 802.15.4.
Valores de retorno
OT_ERROR_NONE
Se estableció correctamente el ID de PAN extendido.
OT_ERROR_INVALID_STATE
Los protocolos de subprocesos están habilitados.
Consulta también:
otThreadGetExtendedPanId

otThreadSetFixedDuaInterfaceIdentifier

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

Establece o borra el identificador de interfaz especificado manualmente para la dirección Unicast de Thread.

Disponible cuando OPENTHREAD_CONFIG_DUA_ENABLE está habilitado.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aIid
Un puntero para el identificador de interfaz que se debe establecer o NULL para borrar.
Valores de retorno
OT_ERROR_NONE
Se configuró y borró correctamente el identificador de interfaz.
OT_ERROR_INVALID_ARGS
El identificador de interfaz especificado está reservado.
Consulta también:
otThreadGetFixedDuaInterfaceIdentifier

otThreadSetJoinerAdvertisement

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

Este método establece el anuncio del conector de subprocesos cuando se descubre la red de subprocesos.

Este anuncio se utiliza para permitirle a este usuario anunciar su propia información específica de la aplicación (como el ID de proveedor, el ID del producto, el Discriminante, etc.) a través de un TLV del anuncio de los recién llegados, y poner esta información a disposición de los comisionados o candidatas sin interacción humana.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aOui
Es el valor de OUI del proveedor del IEEE que se incluirá en el anuncio de unión. Solo se usarán los 3 bytes menos significativos y se ignorará el byte más importante.
[in] aAdvData
Un puntero para los datos de anuncios que se incluirán en el anuncio de unión.
[in] aAdvDataLength
La longitud de AdvData en bytes.
Valores de retorno
OT_ERROR_NONE
Se ha configurado correctamente el anuncio de unión.
OT_ERROR_INVALID_ARGS
AdvData no válido.

otThreadSetKeySequenceCounter

void otThreadSetKeySequenceCounter(
  otInstance *aInstance,
  uint32_t aKeySequenceCounter
)

Configura thrKeySequenceCounter.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aKeySequenceCounter
El valor thrKeySequenceCounter.
Consulta también:
otThreadGetKeySequenceCounter

otThreadSetKeySwitchGuardTime

void otThreadSetKeySwitchGuardTime(
  otInstance *aInstance,
  uint32_t aKeySwitchGuardTime
)

Configura el thrKeySwitchGuardTime (en horas).

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aKeySwitchGuardTime
El valor de thrKeySwitchGuardTime (en horas).
Consulta también:
otThreadGetKeySwitchGuardTime

otThreadSetLinkMode

otError otThreadSetLinkMode(
  otInstance *aInstance,
  otLinkModeConfig aConfig
)

Establece la configuración del modo de vínculo MLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aConfig
Un puntero para la configuración del modo de vínculo.
Valores de retorno
OT_ERROR_NONE
Se configuró correctamente la configuración del modo de vínculo MLE.
Consulta también:
otThreadGetLinkMode

otThreadSetMeshLocalPrefix

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

Esta función establece el prefijo local de la malla.

Esta función tiene éxito solo cuando los protocolos de Thread están inhabilitados. Una llamada exitosa a esta función invalida los conjuntos de datos operativos activos y pendientes en la memoria no volátil.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aMeshLocalPrefix
Un puntero para el prefijo local de malla.
Valores de retorno
OT_ERROR_NONE
Se configuró correctamente el prefijo local de malla.
OT_ERROR_INVALID_STATE
Los protocolos de subprocesos están habilitados.

otThreadSetNetworkKey

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

Configura la clave de red del subproceso.

Esta función tiene éxito solo cuando los protocolos de Thread están inhabilitados. Una llamada exitosa a esta función invalida los conjuntos de datos operativos activos y pendientes en la memoria no volátil.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aKey
Un puntero para un búfer que contiene la clave de red del subproceso.
Valores de retorno
OT_ERROR_NONE
Se configuró correctamente la clave de red Thread.
OT_ERROR_INVALID_STATE
Los protocolos de subprocesos están habilitados.
Consulta también:
otThreadGetNetworkKey

otThreadSetNetworkKeyRef

otError otThreadSetNetworkKeyRef(
  otInstance *aInstance,
  otNetworkKeyRef aKeyRef
)

Configura la clave de red del subproceso como otNetworkKeyRef.

Esta función tiene éxito solo cuando los protocolos de Thread están inhabilitados. Una llamada exitosa a esta función invalida los conjuntos de datos operativos activos y pendientes en la memoria no volátil.

Esta función requiere que se habilite la función de tiempo de compilación OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aKeyRef
Referencia a la clave de red del subproceso.
Valores de retorno
OT_ERROR_NONE
Se configuró correctamente la clave de red Thread.
OT_ERROR_INVALID_STATE
Los protocolos de subprocesos están habilitados.
Consulta también:
otThreadGetNetworkKeyRef

otThreadSetNetworkName

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

Configura el nombre de la red Thread.

Esta función tiene éxito solo cuando los protocolos de Thread están inhabilitados. Una llamada exitosa a esta función invalida los conjuntos de datos operativos activos y pendientes en la memoria no volátil.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aNetworkName
Un puntero para el nombre de red del subproceso.
Valores de retorno
OT_ERROR_NONE
Se configuró correctamente el nombre de la red Thread.
OT_ERROR_INVALID_STATE
Los protocolos de subprocesos están habilitados.
Consulta también:
otThreadGetNetworkName

Macros

TS_JOINER_ADVDATA_MAX_LENGTH

 OT_JOINER_ADVDATA_MAX_LENGTH 64

Longitud máxima de los datos del anunciante para los anuncios de unión.

OT_NEIGHBOR_INFO_ITERATOR_INIT

 OT_NEIGHBOR_INFO_ITERATOR_INIT 0

Inicializador de otNeighborInfoIterator

TS_NETWORK_BASE_TLV_MAX_LENGTH

 OT_NETWORK_BASE_TLV_MAX_LENGTH 254

Longitud máxima del valor del TLV base de la conversación.

OT_NETWORK_DATA_ITERATOR_INIT

 OT_NETWORK_DATA_ITERATOR_INIT 0

Valor para inicializar otNetworkDataIterator.

TS_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE

 OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE 3

Tamaño de la entrada de la tabla secundaria de diagnóstico de red.

TS_NETWORK_DIAGNOSTIC_ITERATOR_INIT

 OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT 0

Inicializador de otNetworkDiagIterator.

TS_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES

 OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19

Cantidad máxima de tipos de TLV de diagnóstico de red que se deben solicitar o restablecer.

TS_NETWORK_MAX_ROUTER_ID

 OT_NETWORK_MAX_ROUTER_ID 62

ID máximo del router.

TS_SERVER_DATA_MAX_SIZE

 OT_SERVER_DATA_MAX_SIZE 248

Tamaño máximo de datos del servidor en bytes. Límite teórico, prácticamente mucho menor.

TS_SERVICE_DATA_MAX_SIZE

 OT_SERVICE_DATA_MAX_SIZE 252

Tamaño máximo de datos del servicio en bytes.

Recursos

Los temas de referencia de la API de OpenThread se originan a partir del código fuente, disponible en GitHub. Para obtener más información o contribuir con nuestra documentación, consulta Recursos.