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 todas las funciones de Thread.

Resumen

El editor de datos de red proporciona mecanismos para limitar la cantidad de entradas de servicio o prefijo (de prefijo en malla o similares) similares en los datos de red de Thread. Para ello, supervisa los datos de red y administra 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 la función de un 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(*
Esta devolución de llamada 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 Thread.
otLinkModeConfig typedef
Esta estructura representa una configuración del Modo de vínculo de MLE.
otMleCounters typedef
struct otMleCounters
Esta estructura representa los contadores de MLE de Thread.
otNeighborInfoIterator typedef
int16_t
Se usa para iterar en una tabla vecina.
otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext) typedef
void(*
Este tipo de puntero define la devolución de llamada utilizada para notificar cuando se agrega una entrada de servicio de DNS/SRP a los datos de red de Thread o cuando se los quita.
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 cuando 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 información de los datos de red.
otNetworkDiagChildEntry typedef
Esta estructura representa una entrada de la tabla secundaria de diagnóstico de la 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 de un 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 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 la 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 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 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 detección de Thread.
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 superior de MLE.

Funciones

otNetDataContainsOmrPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
Esta función verifica si un prefijo determinado puede actuar como un prefijo OMR válido y también contiene los prefijos de datos 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 la red Thread.
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 los 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 actualmente se agrega o no la entrada “Servicio de DNS/SRP” a los datos de la red de Thread.
otNetDataIsPrefixAdded(otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
Esta función indica si se agrega una entrada de prefijo publicada (en la malla o una ruta externa) a los datos de red de Thread.
otNetDataPublishDnsSrpServiceAnycast(otInstance *aInstance, uint8_t aSequenceNUmber)
void
Esta función solicita que se publique la dirección Anycast Address&DNS de servicio de DNS/SRP en los datos de red de Thread.
otNetDataPublishDnsSrpServiceUnicast(otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort)
void
Esta función solicita que se publique la dirección Unicast del servicio de DNS/SRP en los datos de red de Thread.
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(otInstance *aInstance, uint16_t aPort)
void
Esta función solicita que se publique la dirección Unicast del servicio de DNS/SRP en los datos de red de Thread.
otNetDataPublishExternalRoute(otInstance *aInstance, const otExternalRouteConfig *aConfig)
Esta función solicita que se publique un prefijo de ruta externo en los datos de red de Thread.
otNetDataPublishOnMeshPrefix(otInstance *aInstance, const otBorderRouterConfig *aConfig)
Esta función solicita que se publique un prefijo en la malla en los datos de red de Thread.
otNetDataSetDnsSrpServicePublisherCallback(otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext)
void
Esta función configura una devolución de llamada para notificar cuando un servicio de DNS/SRP publicado se agrega o se quita de los datos de red de Thread.
otNetDataSetPrefixPublisherCallback(otInstance *aInstance, otNetDataPrefixPublisherCallback aCallback, void *aContext)
void
Esta función configura una devolución de llamada para notificar cuando se agrega o se quita una entrada de prefijo publicada de los datos de la red de Thread.
otNetDataSteeringDataCheckJoiner(otInstance *aInstance, const otExtAddress *aEui64)
Verifique si los datos de dirección incluyen un Joiner.
otNetDataSteeringDataCheckJoinerWithDiscerner(otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner)
Verifica si los datos de dirección incluyen un objeto Joiner con un valor de discerner determinado.
otNetDataUnpublishDnsSrpService(otInstance *aInstance)
void
Anula la publicación de cualquier entrada del servicio de DNS/SRP (Anycast o Unicast) que se agregó anteriormente desde 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 publicado anteriormente.
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 en 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 elemento secundario de Thread que se usa cuando se opera en la función de elemento secundario.
otThreadGetDeviceRole(otInstance *aInstance)
Obtenga la función de dispositivo.
otThreadGetDomainName(otInstance *aInstance)
const char *
Obtén el nombre de dominio de Thread.
otThreadGetExtendedPanId(otInstance *aInstance)
const otExtendedPanId *
Obtén el ID de PAN extendido de IEEE 802.15.4.
otThreadGetFixedDuaInterfaceIdentifier(otInstance *aInstance)
Obtén el identificador de interfaz especificado de forma manual para la dirección de unicat del dominio de Thread.
otThreadGetIp6Counters(otInstance *aInstance)
const otIpCounters *
Obtenga los contadores IPv6.
otThreadGetKeySequenceCounter(otInstance *aInstance)
uint32_t
Obtén la thrKeySequenceCounter.
otThreadGetKeySwitchGuardTime(otInstance *aInstance)
uint32_t
Obtén el thrKeySwitchGuardTime.
otThreadGetLeaderData(otInstance *aInstance, otLeaderData *aLeaderData)
Esta función obtiene los datos del líder de Thread.
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 del router de la variante principal.
otThreadGetLeaderWeight(otInstance *aInstance)
uint8_t
Obtén el peso del líder.
otThreadGetLinkLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
const otIp6Address *
Esta función muestra la dirección multidifusión de Thread Link-Local All Thread Node.
otThreadGetLinkLocalIp6Address(otInstance *aInstance)
const otIp6Address *
Esta función muestra la dirección IPv6 del vínculo de Thread.
otThreadGetLinkMode(otInstance *aInstance)
Obtén la configuración del Modo de vínculo de MLE.
otThreadGetMeshLocalEid(otInstance *aInstance)
const otIp6Address *
Esta función muestra un puntero a la dirección EID local de la malla.
otThreadGetMeshLocalPrefix(otInstance *aInstance)
Esta función muestra un puntero al prefijo local de la malla.
otThreadGetMleCounters(otInstance *aInstance)
const otMleCounters *
Obtén los contadores de MLE de Thread.
otThreadGetNetworkKey(otInstance *aInstance, otNetworkKey *aNetworkKey)
void
Obtén la clave de red de 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 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 elemento superior de Thread.
otThreadGetParentInfo(otInstance *aInstance, otRouterInfo *aParentInfo)
La función recupera la información de diagnóstico de un subproceso de subprocesos como superior.
otThreadGetParentLastRssi(otInstance *aInstance, int8_t *aLastRssi)
La función recupera el RSSI del último paquete del subproceso superior de subprocesos.
otThreadGetPartitionId(otInstance *aInstance)
uint32_t
Obtenga el ID de partición.
otThreadGetRealmLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
const otIp6Address *
Esta función muestra la dirección multidifusión de Thread Realm-Local All Thread Node.
otThreadGetRloc(otInstance *aInstance)
const otIp6Address *
Esta función muestra un puntero a la dirección del localizador 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 del protocolo de Thread.
otThreadIsAnycastLocateInProgress(otInstance *aInstance)
bool
Esta función indica si una solicitud de localización de Anycast está en curso actualmente.
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 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 respuestas superiores de MLE.
otThreadResetIp6Counters(otInstance *aInstance)
void
Restablece los contadores de IPv6.
otThreadResetMleCounters(otInstance *aInstance)
void
Restablece los contadores de MLE de Thread.
otThreadSendAddressNotification(otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid)
void
Esta función envía un mensaje proactivo de notificación de dirección (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 Obtener 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 la red.
otThreadSendProactiveBackboneNotification(otInstance *aInstance, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction)
Esta función envía un mensaje proactivo de notificación troncal (PRO_BB.ntf) en el vínculo de Backbone.
otThreadSetChildTimeout(otInstance *aInstance, uint32_t aTimeout)
void
Configura el tiempo de espera de subprocesos secundarios de Thread que se usa para operar en la función de elementos secundarios.
otThreadSetDiscoveryRequestCallback(otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext)
void
Esta función establece una devolución de llamada para recibir datos de solicitudes 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 de Thread.
otThreadSetExtendedPanId(otInstance *aInstance, const otExtendedPanId *aExtendedPanId)
Establece el ID de PAN extendido de IEEE 802.15.4.
otThreadSetFixedDuaInterfaceIdentifier(otInstance *aInstance, const otIp6InterfaceIdentifier *aIid)
Establece o borra el identificador de interfaz especificado manualmente para la dirección de unicat del dominio de Thread.
otThreadSetJoinerAdvertisement(otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength)
Este método establece el anuncio del combinador de subprocesos cuando se descubre la red de Thread.
otThreadSetKeySequenceCounter(otInstance *aInstance, uint32_t aKeySequenceCounter)
void
Configura el thrKeySequenceCounter.
otThreadSetKeySwitchGuardTime(otInstance *aInstance, uint32_t aKeySwitchGuardTime)
void
Configura el thrKeySwitchGuardTime.
otThreadSetLinkMode(otInstance *aInstance, otLinkModeConfig aConfig)
Establece la configuración del modo de vinculación de 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 de Thread.
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 de 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.

DatosOtLeaderData

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

otLinkModeConfig

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

otMleCounters

Esta estructura representa los contadores de MLE de Thread.

otNeighborInfo.

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

otNetworkDiagChildEntry

Esta estructura representa una entrada de la tabla secundaria de diagnóstico de la 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 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 Thread.

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 detección de Thread.

otThreadParentResponseInfo.

Esta estructura representa los datos de la respuesta superior 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

Conectividad TLV.

OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS

TLV de dirección extendida de MAC

OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST

TLV de la lista de direcciones IPv6

OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA

TLV de datos líder.

OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS

TLV de contadores 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

Tensión de suministro de TLV.

OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT

Tiempo de espera del TLV (período máximo de sondeo para los SED)

OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST

Escribe List TLV.

OtDeviceRole

 otDeviceRole

Representa la función de un dispositivo Thread.

Propiedades
OT_DEVICE_ROLE_CHILD

La función de hijo de la conversación

OT_DEVICE_ROLE_DETACHED

No estás participando en una partición o red de Thread.

OT_DEVICE_ROLE_DISABLED

La pila de subprocesos está inhabilitada.

OT_DEVICE_ROLE_LEADER

La función de líder de Thread.

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

Se agrega la entrada publicada a los datos de la red de Thread.

OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED

Se quita la entrada publicada de los datos de la 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.

oDisconnectDisconnectedCallback

void(* otDetachGracefullyCallback)(void *aContext)

Esta devolución de llamada informa a la aplicación que finalizó el proceso de desconexión.

Detalles
Parámetros
[in] aContext
Un puntero para el contexto específico de la aplicació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 del otLeader

struct otLeaderData otLeaderData

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

otLinkModeConfig

struct otLinkModeConfig otLinkModeConfig

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

Contadores de otMle

struct otMleCounters otMleCounters

Esta estructura representa los contadores de MLE de Thread.

otNeighborInfoIterator

int16_t otNeighborInfoIterator

Se usa para iterar en una tabla vecina.

otNetDataDnsSrpServicePublisherCallback

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

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

Cuando se quita, se invoca la devolución de llamada independientemente de que Publisher haya quitado 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 para el 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 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 cuando se quita.

Cuando se quita, se invoca la devolución de llamada independientemente de que Publisher haya quitado 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 para el 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 información de los datos de red.

otNetworkDiagChildEntry

struct otNetworkDiagChildEntry otNetworkDiagChildEntry

Esta estructura representa una entrada de la tabla secundaria de diagnóstico de la 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 de un 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 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 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 la respuesta Get de diagnóstico de la red.

Detalles
Parámetros
[in] aError
Se produjo un error cuando no se podía obtener la respuesta.
[in] aMessage
Un puntero para el búfer de mensajes que contiene la carga útil de Obtener respuesta de diagnóstico de red. Solo está disponible cuando aError es OT_ERROR_NONE.
[in] aMessageInfo
Un puntero para la información del mensaje para aMessage. Solo está disponible cuando aError es OT_ERROR_NONE.
[in] aContext
Un puntero para el contexto específico de la aplicación.

otRoutePreference

enum otRoutePreference otRoutePreference

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

Detalles
Parámetros
[in] aContext
Un puntero para un contexto arbitrario (proporcionado cuando se registra la devolución de llamada).
[in] aError
El error que se produce cuando se controla 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 se anuló la solicitud.
[in] aMeshLocalAddress
Un puntero al EID de malla local del destino más cercano de la dirección Anycast cuando aError es OT_ERROR_NONE, si no es NULL.
[in] aRloc16
El RLOC16 del destino, si se encuentra; de lo contrario, el RLOC16 no es válido (0xfffe).

oThreadThreadRequestRequestCallback

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 solicitud de descubrimiento.
[in] aContext
Un puntero para mostrar el contexto específico de la aplicación.

oThreadDiscoveryRequestInfo

struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo

Esta estructura representa los datos de la solicitud de detección de Thread.

oThreadThreadResponseCallback

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 para una ubicación en la pila que contiene los datos estadísticos.
[in] aContext
Un puntero para mostrar el contexto específico del cliente.

oThreadThreadResponseInfo

struct otThreadParentResponseInfo otThreadParentResponseInfo

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

Funciones

OtNetDataContainsOmrPrefix

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

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

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

onetNetDataGet

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 la red Thread.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aStable
Se le asigna el valor TRUE cuando se copia la versión estable. El valor es FALSE al copiar la versión completa.
[out] aData
Un puntero para el búfer de datos.
[in,out] aDataLength
En la entrada, es el tamaño del búfer de datos al que apunta aData. Al salir, la cantidad de bytes copiados.

Prefijo otDataDataGetNextOnMesh

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 de iteradores de datos de red. Para obtener la primera entrada en la malla, debe configurarse en OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Un puntero sobre dónde se colocará la información del prefijo de malla.
Valores que se muestran
OT_ERROR_NONE
Se encontró correctamente el siguiente prefijo de malla.
OT_ERROR_NOT_FOUND
No existe ningún prefijo de malla 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 de iteradores de datos de red. Para obtener la primera entrada de ruta externa, se debe configurar en OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Un puntero sobre dónde se colocará la información de la ruta externa.
Valores que se muestran
OT_ERROR_NONE
Se encontró correctamente la siguiente ruta externa.
OT_ERROR_NOT_FOUND
No hay ninguna entrada de ruta externa posterior en los datos de la 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 de iteradores de datos de red. Para obtener la primera entrada de servicio, se debe configurar en OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Un puntero sobre dónde se colocará la información del servicio.
Valores que se muestran
OT_ERROR_NONE
Se encontró correctamente el siguiente servicio.
OT_ERROR_NOT_FOUND
No existen servicios posteriores en los datos de red de la partición.

otNetDataGetStableVersion

uint8_t otNetDataGetStableVersion(
  otInstance *aInstance
)

Obtén la versión estable de los 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 la red.

otNetDataIsDnsSrpServiceAgregado

bool otNetDataIsDnsSrpServiceAdded(
  otInstance *aInstance
)

Esta función indica si actualmente se agrega o no la entrada “Servicio de DNS/SRP” a los datos de la 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 que se muestran
TRUE
Se agrega la entrada publicada del servicio DNS/SRP a los datos de red de Thread.
FALSE
No se agregó la entrada a Thread Network Data o no hay ninguna entrada para publicar.

otNetDataIsPrefixAgregar

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

Esta función indica si se agrega una entrada de prefijo publicada (en la 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 que se muestran
TRUE
Se agrega la entrada de prefijo publicado a los datos de la red de Thread.
FALSE
No se agregó la entrada a Thread Network Data o no hay ninguna entrada para publicar.

otNetDataPublishDnsSrpServiceAnycast

void otNetDataPublishDnsSrpServiceAnycast(
  otInstance *aInstance,
  uint8_t aSequenceNUmber
)

Esta función solicita que se publique la dirección Anycast Address&DNS de servicio de DNS/SRP en los datos de red de 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 de "Servicio DNS/SRP" que se haya publicado (de la 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 del DNS/SRP.

otNetDataPublishDnsSrpServiceUnicast

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

Esta función solicita que se publique la dirección Unicast del servicio de DNS/SRP en los datos de red de 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 de "Servicio DNS/SRP" que se haya publicado (de la llamada anterior a cualquiera de las funciones otNetDataPublishDnsSrpService{Type}()).

Esta función publica la dirección de unicato del servicio de DNS/SRP. Para ello, incluye la dirección y la información del puerto 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 o SRP que se publicará (NO DEBE ser NULO).
[in] aPort
El número de puerto del servidor de SRP que se publicará.

otNetDataPublishDnsSrpServiceUnicastMeshLocalEid

void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(
  otInstance *aInstance,
  uint16_t aPort
)

Esta función solicita que se publique la dirección Unicast del servicio de DNS/SRP en los datos de red de 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 de "Servicio DNS/SRP" que se haya publicado (de la 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 también incluye la información en 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 de 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 red de 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., nivel de preferencia) y el prefijo ya se agregó a 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 de manera repentina. 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 la ruta externa que se publicará (NO DEBE ser NULO).
Valores que se muestran
OT_ERROR_NONE
La ruta externa se publicó correctamente.
OT_ERROR_INVALID_ARGS
El aConfig no es válido (prefijo incorrecto, combinaciones de marcas no válidas o no estable).
OT_ERROR_NO_BUFS
No se pudo asignar una entrada para la solicitud nueva. El publicador admite una cantidad limitada de entradas (compartidas entre el prefijo en la malla y la ruta externa) determinadas por la configuración OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES.

Prefijo otDataDataPublishOnMesh

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

Esta función solicita que se publique un prefijo en la malla en los datos de red de 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., nivel de preferencia) y el prefijo ya se agregó a 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 de manera repentina. 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 del prefijo en malla para publicar (NO DEBE ser NULO).
Valores que se muestran
OT_ERROR_NONE
El prefijo en la malla se publicó de forma correcta.
OT_ERROR_INVALID_ARGS
El aConfig no es válido (prefijo incorrecto, combinaciones de marcas no válidas o no estable).
OT_ERROR_NO_BUFS
No se pudo asignar una entrada para la solicitud nueva. El publicador admite una cantidad limitada de entradas (compartidas entre el prefijo en la 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 de DNS/SRP publicado se agrega o se quita de los datos de red de Thread.

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

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 configura una devolución de llamada para notificar cuando se agrega o se quita una entrada de prefijo publicada de los datos de la red de Thread.

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

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
)

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

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

otNetDataSteeringDataCheckJoinerWithDiscerner

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

Verifica si los datos de dirección incluyen un objeto Joiner con un valor de discerner determinado.

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

otNetDataUnpublishDnsSrpService

void otNetDataUnpublishDnsSrpService(
  otInstance *aInstance
)

Anula la publicación de cualquier entrada del servicio de DNS/SRP (Anycast o Unicast) que se agregó anteriormente desde 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 publicado anteriormente.

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 que se muestran
OT_ERROR_NONE
Se anuló correctamente la publicación del prefijo.
OT_ERROR_NOT_FOUND
No se encontró el prefijo en la lista publicada.

oThreadThreadChild

otError otThreadBecomeChild(
  otInstance *aInstance
)

Intenta volver a adjuntarte como niño.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Valores que se muestran
OT_ERROR_NONE
Empieza a intentar convertirse en hijo de forma correcta.
OT_ERROR_INVALID_STATE
La conversación está inhabilitada.

oThreadThreadJoined

otError otThreadBecomeDetached(
  otInstance *aInstance
)

Desconéctate de la red Thread.

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

oThreadThreadGraceGrace

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

Esta función notifica a otros nodos en 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 secundario 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 al finalizar la desconexión.
[in] aContext
Un puntero para mostrar el contexto específico de la aplicación.
Valores que se muestran
OT_ERROR_NONE
La desconexión se inició 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 se desea convertir.
Qué muestra
Una string que representa a aRole.

oThreadThread

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 un poco que indica qué canales se deben escanear (p.ej., OT_CHANNEL_11_MASK).
[in] aPanId
El filtro de PAN con ID (configurado en PAN de transmisión para inhabilitar el filtro).
[in] aJoiner
Valor de la marca de Joiner en el TLV de la solicitud de detección.
[in] aEnableEui64Filtering
TRUE para filtrar las respuestas en EUI-64; de lo contrario, es FALSE.
[in] aCallback
Un puntero para una función llamada en la recepción de una respuesta o un análisis de MLE Discovery.
[in] aCallbackContext
Un puntero para el contexto específico de la aplicación.
Valores que se muestran
OT_ERROR_NONE
Se inició correctamente un análisis de Thread Discovery.
OT_ERROR_INVALID_STATE
La interfaz IPv6 no está habilitada (netif no está habilitada).
OT_ERROR_NO_BUFS
No se pudo asignar el mensaje para la solicitud de descubrimiento.
OT_ERROR_BUSY
El análisis de subprocesos ya está en curso.

otThreadGetChildTimeout

uint32_t otThreadGetChildTimeout(
  otInstance *aInstance
)

Obtiene el tiempo de espera de elemento secundario de Thread que se usa cuando se opera en la función de elemento secundario.

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

oThreadThreadGetDeviceRole

otDeviceRole otThreadGetDeviceRole(
  otInstance *aInstance
)

Obtenga la función de dispositivo.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Valores que se muestran
OT_DEVICE_ROLE_DISABLED
La pila de subprocesos está inhabilitada.
OT_DEVICE_ROLE_DETACHED
El dispositivo no está participando en una red o partición de Thread.
OT_DEVICE_ROLE_CHILD
Actualmente, el dispositivo funciona como elemento secundario de Thread.
OT_DEVICE_ROLE_ROUTER
Actualmente, el dispositivo funciona como un router de Thread.
OT_DEVICE_ROLE_LEADER
Actualmente, el dispositivo funciona como líder de Thread.

oThreadThreadGetDomainName

const char * otThreadGetDomainName(
  otInstance *aInstance
)

Obtén el nombre de dominio de Thread.

Esta función solo está disponible a partir de la versión Thread 1.2.

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

ID de conversación de otThreadGetExtendedPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

Obtén el ID de PAN extendido de IEEE 802.15.4.

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

otThreadGetFixedDuaInterfaceIdentifier

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
  otInstance *aInstance
)

Obtén el identificador de interfaz especificado de forma manual para la dirección de unicat del dominio de Thread.

Esta función solo está disponible a partir de la conversación 1.2 cuando se habilita OPENTHREAD_CONFIG_DUA_ENABLE.

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

oThreadThreadGetIp6Counters

const otIpCounters * otThreadGetIp6Counters(
  otInstance *aInstance
)

Obtenga los contadores IPv6.

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

otThreadGetKeySequenceCounter

uint32_t otThreadGetKeySequenceCounter(
  otInstance *aInstance
)

Obtén la 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
)

Obtén el thrKeySwitchGuardTime.

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

oThreadThreadLead

otError otThreadGetLeaderData(
  otInstance *aInstance,
  otLeaderData *aLeaderData
)

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

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aLeaderData
Un puntero sobre dónde se colocan los datos del líder.
Valores que se muestran
OT_ERROR_NONE
Se recuperaron correctamente los datos del líder.
OT_ERROR_DETACHED
No conectado actualmente.

oThreadThreadLead

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
Un puntero del RLOC del líder.
Valores que se muestran
OT_ERROR_NONE
El RLOC del líder se escribió correctamente en aLeaderRloc.
OT_ERROR_INVALID_ARGS
aLeaderRloc era NULL.
OT_ERROR_DETACHED
Actualmente no está conectado a una partición de subprocesos.

ID de conversación de otThreadGetLeaderRouter

uint8_t otThreadGetLeaderRouterId(
  otInstance *aInstance
)

Obtén el ID del router de la variante principal.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
El ID del router de la variante principal.

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
)

Esta función muestra la dirección multidifusión de Thread Link-Local All Thread Node.

La dirección es una dirección de Multcast basada en prefijos Unicast local con vínculo [RFC 3306], que contiene lo siguiente:

  • Se estableció el valor 3 (P = 1 y T = 1)
  • Scop configurado en 2
  • plen configurado en 64
  • Se estableció el prefijo de red en el prefijo de malla local
  • Se estableció el ID de grupo en 1

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

otThreadGetLinkLocalIp6Address

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

Esta función muestra la dirección IPv6 del vínculo de Thread.

La dirección local del vínculo de Thread se obtiene con 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.

oThreadThreadGetLinkMode

otLinkModeConfig otThreadGetLinkMode(
  otInstance *aInstance
)

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

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

oThreadThreadGetMeshLocalEid

const otIp6Address * otThreadGetMeshLocalEid(
  otInstance *aInstance
)

Esta función muestra un puntero a 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 la malla.

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

oThreadThreadGetMleCounters

const otMleCounters * otThreadGetMleCounters(
  otInstance *aInstance
)

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

oThreadThreadGetNetworkKey

void otThreadGetNetworkKey(
  otInstance *aInstance,
  otNetworkKey *aNetworkKey
)

Obtén la clave de red de Thread.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aNetworkKey
Un puntero para un elemento otNetworkkey que muestra la clave de red de Thread.
Consulta también:
otThreadSetNetworkKey

oThreadThreadGetNetworkKeyRef

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 del subproceso almacenada en la memoria.
Consulta también:
otThreadSetNetworkKeyRef

oThreadThreadGetNetworkName

const char * otThreadGetNetworkName(
  otInstance *aInstance
)

Obtén el nombre de red de Thread.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
Un puntero al nombre de la red del subproceso.
Consulta también:
otThreadSetNetworkName

oThreadThreadGetNextDiagnosticTlv

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

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

Solo se permite realizar una llamada a esta función cuando el valor 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, se debe configurar en OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT.
[out] aNetworkDiagTlv
Un puntero sobre dónde se colocará la información de TLV del diagnóstico de la red.
Valores que se muestran
OT_ERROR_NONE
Se encontró correctamente el próximo 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 en el análisis de la siguiente red.

oThreadThreadGetNextNeighborInfo

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

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

Se usa para pasar por 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 que se muestran
OT_ERROR_NONE
Se encontró correctamente la siguiente entrada del vecino en la tabla.
OT_ERROR_NOT_FOUND
No hay ninguna entrada de vecino posterior en la tabla.
OT_ERROR_INVALID_ARGS
aIterator o aInfo era NULL.

otThreadGetParentAverageRssi

otError otThreadGetParentAverageRssi(
  otInstance *aInstance,
  int8_t *aParentRssi
)

La función recupera el RSSI promedio del elemento superior de Thread.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aParentRssi
Un puntero sobre dónde se debe colocar el RSSI superior

otThreadGetParentInfo

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

La función recupera la información de diagnóstico de un subproceso de subprocesos como superior.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aParentInfo
Un puntero sobre dónde se coloca 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 de subprocesos.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aLastRssi
Un puntero sobre dónde se debe colocar el último RSSI
Valores que se muestran
OT_ERROR_NONE
Se recuperaron correctamente los datos de RSSI.
OT_ERROR_FAILED
No se pueden obtener los datos de RSSI.
OT_ERROR_INVALID_ARGS
aLastRssi es NULO.

otThreadGetPartitionId

uint32_t otThreadGetPartitionId(
  otInstance *aInstance
)

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

Esta función muestra la dirección multidifusión de Thread Realm-Local All Thread Node.

La dirección es una dirección de Multcast basada en prefijos Unicast local-RFC [RFC 3306] con:

  • Se estableció el valor 3 (P = 1 y T = 1)
  • Scop configurado en 3
  • plen configurado en 64
  • Se estableció el prefijo de red en el prefijo de malla local
  • Se estableció el ID de grupo 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 Node.

OThreadThreadGetRloc

const otIp6Address * otThreadGetRloc(
  otInstance *aInstance
)

Esta función muestra un puntero a la dirección del localizador 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 subprocesos (RLOC).

oThreadThreadRr11

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.

oThreadThreadServiceServiceloc

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 utilizar ALOC.
[out] aServiceAloc
Un puntero para mostrar el ALOC del servicio. NO DEBE SER NULO.
Valores que se muestran
OT_ERROR_NONE
Se recuperó el ALOC del servicio de forma correcta.
OT_ERROR_DETACHED
La interfaz de Thread no está conectada a una partición de subprocesos en este momento.

OThreadThreadGetVersion

uint16_t otThreadGetVersion(
  void
)

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

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

otThreadIsAnycastLocateInProgress

bool otThreadIsAnycastLocateInProgress(
  otInstance *aInstance
)

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

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
Se le asigna el valor TRUE si una solicitud de localización Anycast está en curso. De lo contrario, aparecerá el valor FALSE.

oThreadThreadDiscoverInProgress

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.

oThreadThreadIsSingleton

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 que se muestran
TRUE
Es el único router de la red.
FALSE
Es un elemento secundario o no es un único router 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 determinada dirección Anycast.

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 llamada anterior con una llamada a esta función.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aAnycastAddress
La dirección Anycast que se debe 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 que se muestran
OT_ERROR_NONE
La solicitud se inició correctamente. Se invocará 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
Se quitó el 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 respuestas superiores 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 mostrar el contexto específico del cliente.

oThreadThreadIp6Counters

void otThreadResetIp6Counters(
  otInstance *aInstance
)

Restablece los contadores de IPv6.

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

OThreadThreadResetMleCounters

void otThreadResetMleCounters(
  otInstance *aInstance
)

Restablece los contadores de MLE de Thread.

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

oThreadThreadAddressAddressNotification

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

Esta función envía un mensaje proactivo de notificación de dirección (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
Es la dirección de destino del mensaje ADDR_NTF.ntf.
[in] aMlIid
El AA-IID del mensaje ADDR_NTF.ntf.

oThreadThreadDiDiagnosticGet

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

Envía una solicitud de Obtener 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
Un arreglo 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 la respuesta Obtener diagnóstico de red o NULL para inhabilitar la devolución de llamada
[in] aCallbackContext
Un puntero para el contexto específico de la aplicación.
Valores que se muestran
OT_ERROR_NONE
Se agregó correctamente la fila DIAG_GET.req.
OT_ERROR_NO_BUFS
No hay suficientes búferes de mensajes disponibles para enviar DIAG_GET.req.

oThreadThreadSendDiagnosticReset

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

Envíe una solicitud de restablecimiento de diagnóstico de la 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
Un arreglo de tipos de TLV de diagnóstico de red. Actualmente, solo se permite el Tipo 9.
[in] aCount
Cantidad de tipos en aTlvTypes
Valores que se muestran
OT_ERROR_NONE
Se puso en cola correctamente el DIAG_RST.ntf.
OT_ERROR_NO_BUFS
No hay suficientes búferes de mensajes disponibles para enviar DIAG_RST.ntf.

oThreadThreadProactivoBackboneNotification

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

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

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 que se muestran
OT_ERROR_NONE
Se envió correctamente PRO_BB.ntf en el vínculo de columna.
OT_ERROR_NO_BUFS
Si no hay suficientes búferes de mensajes disponibles.

oThreadThreadChildTimeout

void otThreadSetChildTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

Configura el tiempo de espera de subprocesos secundarios de Thread que se usa para operar en la función de elementos secundarios.

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

oThreadSetDiscoveryRequestCallback

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

Esta función establece una devolución de llamada para recibir datos de solicitudes de descubrimiento 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 solicitud de descubrimiento de MLE.
[in] aContext
Un puntero para mostrar el contexto específico de la aplicación.

otThreadSetDomainName

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

Establece el nombre de dominio del subproceso.

Esta función solo está disponible a partir de la versión Thread 1.2. Esta función tiene éxito solo cuando los protocolos de Thread están inhabilitados.

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

oThreadThreadEnabled

otError otThreadSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

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

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

Si se llama a esta función con aEnabled establecido en FALSE, se detiene cualquier proceso en curso de desconexión que inició otThreadDisconnectGraceful(). Se llamará a su devolución de llamada.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aEnabled
Se le asigna el valor TRUE si la conversación está habilitada. De lo contrario, se asigna el valor FALSE.
Valores que se muestran
OT_ERROR_NONE
La operación del protocolo Thread se inició de forma correcta.
OT_ERROR_INVALID_STATE
La interfaz de red no estaba activa.

ID de cadena de subprocesos

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

Establece el ID de PAN extendido de IEEE 802.15.4.

Solo se puede llamar a esta función 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] aExtendedPanId
Un puntero del ID del PAN extendido de IEEE 802.15.4.
Valores que se muestran
OT_ERROR_NONE
Se configuró correctamente el ID extendido del PAN.
OT_ERROR_INVALID_STATE
Los protocolos de Thread 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 de unicat del dominio de Thread.

Esta función solo está disponible a partir de la conversación 1.2 cuando se habilita OPENTHREAD_CONFIG_DUA_ENABLE.

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

otThreadSetJoinerPublicidad

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

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

El anuncio de unión de subprocesos se usa para permitir a un empresario que anuncie su propia información específica de la aplicación (como el ID de proveedor, el ID de producto, el Discriminante, etc.) a través de un TLV que anuncia la participación de un comparador y poner esta información a disposición de los comisionados o candidatos a comisionados sin interacción humana.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aOui
Es el valor de IUI del proveedor que se incluirá en el anuncio de unión. Solo se usarán los 3 bytes menos importantes, y se ignorará el byte más importante.
[in] aAdvData
Un puntero para los datos de anuncios que se incluirán en los anuncios de Joiner.
[in] aAdvDataLength
La longitud de AdvData en bytes.
Valores que se muestran
OT_ERROR_NONE
Se configuró correctamente el anuncio de unión.
OT_ERROR_INVALID_ARGS
Los datos de anuncios no son válidos.

oThreadThreadKeySequenceCounter

void otThreadSetKeySequenceCounter(
  otInstance *aInstance,
  uint32_t aKeySequenceCounter
)

Configura el 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.

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

oThreadThreadLinkMode

otError otThreadSetLinkMode(
  otInstance *aInstance,
  otLinkModeConfig aConfig
)

Establece la configuración del modo de vinculación de 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 que se muestran
OT_ERROR_NONE
Se estableció correctamente la configuración del modo de vínculo de 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 que se muestran
OT_ERROR_NONE
Se configuró correctamente el prefijo local de malla.
OT_ERROR_INVALID_STATE
Los protocolos de Thread están habilitados.

oThreadThreadNetworkKey

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

Configura la clave de red de 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] aKey
Un puntero para un búfer que contiene la clave de red del subproceso.
Valores que se muestran
OT_ERROR_NONE
Se configuró correctamente la clave de red de la conversación.
OT_ERROR_INVALID_STATE
Los protocolos de Thread están habilitados.
Consulta también:
otThreadGetNetworkKey

oThreadThreadNetworkNetworkRef

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 de Thread.
Valores que se muestran
OT_ERROR_NONE
Se configuró correctamente la clave de red de la conversación.
OT_ERROR_INVALID_STATE
Los protocolos de Thread están habilitados.
Consulta también:
otThreadGetNetworkKeyRef

otThreadSetNetworkName

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

Configura el nombre de la red de 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 al nombre de la red del subproceso.
Valores que se muestran
OT_ERROR_NONE
Se estableció correctamente el nombre de la red del subproceso.
OT_ERROR_INVALID_STATE
Los protocolos de Thread están habilitados.
Consulta también:
otThreadGetNetworkName

Macros

OT_JOINER_ADVDATA_MAX_LENGTH

 OT_JOINER_ADVDATA_MAX_LENGTH 64

Longitud máxima del anuncio 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 de TLV de la base de subproceso.

OT_NETWORK_DATA_ITERATOR_INIT

 OT_NETWORK_DATA_ITERATOR_INIT 0

Valor para inicializar otNetworkDataIterator.

OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE

 OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE 3

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

OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT

 OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT 0

Inicializador de otNetworkDiagIterator.

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

OT_NETWORK_MAX_ROUTER_ID

 OT_NETWORK_MAX_ROUTER_ID 62

ID máximo del router.

OT_SERVER_DATA_MAX_SIZE

 OT_SERVER_DATA_MAX_SIZE 248

Tamaño máximo de datos del servidor en bytes. El límite teórico es prácticamente mucho más bajo.

TS_SERVICE_DATA_MAX_SIZE

 OT_SERVICE_DATA_MAX_SIZE 252

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

Recursos

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