General

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

Resumen

El Publicador de datos de red proporciona mecanismos para limitar la cantidad de entradas de servicio o prefijo similares (prefijo en la malla o ruta externa) en los datos de red de Thread supervisando los datos de red y administrando si agregar o quitar entradas, o cuándo hacerlo.

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,
  OT_NETWORK_DIAGNOSTIC_TLV_VERSION = 24,
  OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_NAME = 25,
  OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_MODEL = 26,
  OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_SW_VERSION = 27,
  OT_NETWORK_DIAGNOSTIC_TLV_THREAD_STACK_VERSION = 28,
  OT_NETWORK_DIAGNOSTIC_TLV_CHILD = 29,
  OT_NETWORK_DIAGNOSTIC_TLV_CHILD_IP6_ADDR_LIST = 30,
  OT_NETWORK_DIAGNOSTIC_TLV_ROUTER_NEIGHBOR = 31,
  OT_NETWORK_DIAGNOSTIC_TLV_ANSWER = 32,
  OT_NETWORK_DIAGNOSTIC_TLV_QUERY_ID = 33,
  OT_NETWORK_DIAGNOSTIC_TLV_MLE_COUNTERS = 34
}
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 de dispositivo de Thread.
otNetDataPublisherEvent{
  OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED = 0,
  OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED = 1
}
enum
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
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
Representa una configuración de ruta externa.
otIpCounters typedef
struct otIpCounters
Representa los contadores de nivel de IP.
otLeaderData typedef
struct otLeaderData
Representa los datos líderes del subproceso.
otLinkModeConfig typedef
Representa una configuración de modo de vínculo de MLE.
otLowpanContextInfo typedef
Representa la información del ID de contexto de 6LoWPAN asociado con un prefijo en los datos de red.
otMleCounters typedef
struct otMleCounters
Representa los contadores de Thread MLE.
otNeighborInfoIterator typedef
int16_t
Se usa para iterar a través de la tabla de vecinos.
otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext) typedef
void(*
El tipo de puntero define la devolución de llamada que se usa para notificar cuando se agrega una entrada de "Servicio DNS/SRP" a los datos de red de Thread o se la quita de estos.
otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext) typedef
void(*
El tipo de puntero define la devolución de llamada que se usa para notificar cuando se agrega una entrada de prefijo (en la malla o ruta externa) a los datos de red de Thread o se quita de ellos.
otNetDataPublisherEvent typedef
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
Representa una entrada de la tabla secundaria de diagnóstico de red.
otNetworkDiagConnectivity typedef
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
Representa un valor de los contadores de Mac de diagnóstico de red.
otNetworkDiagMleCounters typedef
Representa un valor de los contadores de MLE del diagnóstico de la red.
otNetworkDiagRoute typedef
Representa un valor de TLV de ruta de diagnóstico de red.
otNetworkDiagRouteData typedef
Representa los datos de una ruta de diagnóstico de red.
otNetworkDiagTlv typedef
Representa un TLV de diagnóstico de red.
otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext) typedef
void(*
Se llama al puntero cuando se recibe la respuesta de Network Diagnostic Get.
otRoutePreference typedef
Define valores válidos para mPreference en otExternalRouteConfig y otBorderRouterConfig.
otServerConfig typedef
Representa una configuración del servidor.
otServiceConfig typedef
Representa una configuración de Service.
otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16) typedef
void(*
El tipo de puntero define la devolución de llamada para notificar el resultado de una solicitud otThreadLocateAnycastDestination().
otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext) typedef
void(*
Se llama al puntero cada vez que se recibe un mensaje de solicitud de descubrimiento de MLE.
otThreadDiscoveryRequestInfo typedef
Representa los datos de la solicitud de detección de subprocesos.
otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext) typedef
void(*
Se llama al puntero cada vez que se recibe un mensaje de respuesta para padres de MLE.
otThreadParentResponseInfo typedef
Representa los datos de la respuesta superior de MLE.

remotas

otConvertDurationInSecondsToString(uint32_t aDuration, char *aBuffer, uint16_t aSize)
void
Convierte una duración de uint32_t (en segundos) en una string legible.
otNetDataContainsOmrPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
Verifica si un prefijo determinado puede actuar como un prefijo OMR válido y, además, los datos de red del líder contienen este prefijo.
otNetDataGet(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
Proporciona una copia completa o estable de los datos de red del Thread de la partición.
otNetDataGetCommissioningDataset(otInstance *aInstance, otCommissioningDataset *aDataset)
void
Obtiene el conjunto de datos de comisión de los datos de red de la partición.
otNetDataGetLength(otInstance *aInstance)
uint8_t
Obtén la longitud actual (cantidad de bytes) de datos de red de Thread de la partición.
otNetDataGetMaxLength(otInstance *aInstance)
uint8_t
Obtiene la longitud máxima observada de los datos de red de Thread desde la inicialización de la pila de OT o desde la última llamada a otNetDataResetMaxLength().
otNetDataGetNextLowpanContextInfo(otInstance *aInstance, otNetworkDataIterator *aIterator, otLowpanContextInfo *aContextInfo)
Obtén la siguiente información del ID de contexto de 6LoWPAN en los datos de red de la partición.
otNetDataGetNextOnMeshPrefix(otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
Obtener el siguiente prefijo de malla activada en los datos de red de la partición
otNetDataGetNextRoute(otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)
Obtén la siguiente ruta externa en los datos de red de la partición.
otNetDataGetNextService(otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig)
Obtén el siguiente servicio de los datos de red de la partición.
otNetDataGetStableVersion(otInstance *aInstance)
uint8_t
Obtén la versión de datos de la red estable.
otNetDataGetVersion(otInstance *aInstance)
uint8_t
Obtén la versión de los datos de red.
otNetDataIsDnsSrpServiceAdded(otInstance *aInstance)
bool
Indica si se agregó la entrada "Servicio DNS/SRP" a los datos de red de Thread.
otNetDataIsPrefixAdded(otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
Indica si se agrega o no una entrada de prefijo publicada (en malla o ruta externa) a los datos de red de Thread.
otNetDataPublishDnsSrpServiceAnycast(otInstance *aInstance, uint8_t aSequenceNUmber)
void
Solicita que se publique la "Dirección Anycast del servicio de DNS/SRP" en los datos de red de Thread.
otNetDataPublishDnsSrpServiceUnicast(otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort)
void
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
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)
Solicita que se publique un prefijo de ruta externo en los datos de red de Thread.
otNetDataPublishOnMeshPrefix(otInstance *aInstance, const otBorderRouterConfig *aConfig)
Solicita que se publique un prefijo en la malla en los datos de red de Thread.
otNetDataReplacePublishedExternalRoute(otInstance *aInstance, const otIp6Prefix *aPrefix, const otExternalRouteConfig *aConfig)
Reemplaza una ruta externa publicada anteriormente en los datos de red de Thread.
otNetDataResetMaxLength(otInstance *aInstance)
void
Restablece la longitud máxima monitoreada de los datos de red de Thread.
otNetDataSetDnsSrpServicePublisherCallback(otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext)
void
Establece 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
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)
Verifica si los datos de conducción incluyen una unión.
otNetDataSteeringDataCheckJoinerWithDiscerner(otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner)
Comprueba si los datos de dirección incluyen un Joiner con un valor de discernador determinado.
otNetDataUnpublishDnsSrpService(otInstance *aInstance)
void
Anula la publicación de cualquier entrada del servicio de DNS/SRP (Anycast o Unicast) que se haya agregado previamente desde los datos de red de Thread.
otNetDataUnpublishPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
Anula la publicación de un prefijo de ruta externo o en malla publicado anteriormente.
otThreadBecomeChild(otInstance *aInstance)
Intenta volver a adjuntar como hijo.
otThreadBecomeDetached(otInstance *aInstance)
Desconéctate de la red Thread.
otThreadDetachGracefully(otInstance *aInstance, otDetachGracefullyCallback aCallback, void *aContext)
Notifica a otros nodos en la red (si los hay) y, luego, detiene la operación del protocolo Thread.
otThreadDeviceRoleToString(otDeviceRole aRole)
const char *
Convierte el rol del dispositivo en una cadena legible.
otThreadDiscover(otInstance *aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void *aCallbackContext)
Inicia un análisis de detección de subprocesos.
otThreadGetChildTimeout(otInstance *aInstance)
uint32_t
Obtiene el tiempo de espera del subproceso secundario (en segundos) que se usa cuando se opera con el rol secundario.
otThreadGetDeviceRole(otInstance *aInstance)
Obtén el rol del dispositivo.
otThreadGetDomainName(otInstance *aInstance)
const char *
Obtiene el nombre de dominio del subproceso.
otThreadGetExtendedPanId(otInstance *aInstance)
const otExtendedPanId *
Obtiene el ID PAN extendido de IEEE 802.15.4.
otThreadGetFixedDuaInterfaceIdentifier(otInstance *aInstance)
Obtiene el identificador de interfaz especificado manualmente para la dirección unicast del dominio de Thread.
otThreadGetIp6Counters(otInstance *aInstance)
const otIpCounters *
Obtiene los contadores IPv6.
otThreadGetKeySequenceCounter(otInstance *aInstance)
uint32_t
Obtiene el thrKeySequenceCounter.
otThreadGetKeySwitchGuardTime(otInstance *aInstance)
uint32_t
Obtiene el thrKeySwitchGuardTime (en horas).
otThreadGetLeaderData(otInstance *aInstance, otLeaderData *aLeaderData)
Obtén los datos del líder de subprocesos.
otThreadGetLeaderRloc(otInstance *aInstance, otIp6Address *aLeaderRloc)
Muestra un puntero al RLOC del líder.
otThreadGetLeaderRouterId(otInstance *aInstance)
uint8_t
Obtén el ID del router líder.
otThreadGetLeaderWeight(otInstance *aInstance)
uint8_t
Levanten 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 local del vínculo de Thread.
otThreadGetLinkMode(otInstance *aInstance)
Obtén la configuración del modo de vínculo de MLE.
otThreadGetMaxTimeInQueue(otInstance *aInstance)
uint32_t
Obtiene el tiempo máximo en cola para los mensajes en la cola de transmisión.
otThreadGetMeshLocalEid(otInstance *aInstance)
const otIp6Address *
Obtiene la dirección del EID local de la malla.
otThreadGetMeshLocalPrefix(otInstance *aInstance)
Muestra un puntero al prefijo local de malla.
otThreadGetMleCounters(otInstance *aInstance)
const otMleCounters *
Obtiene los contadores de Thread MLE.
otThreadGetNetworkKey(otInstance *aInstance, otNetworkKey *aNetworkKey)
void
Obtén la clave de red de Thread.
otThreadGetNetworkKeyRef(otInstance *aInstance)
Obtén el 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)
Obtiene el siguiente TLV de diagnóstico de red del mensaje.
otThreadGetNextNeighborInfo(otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo)
Obtiene la información del próximo vecino.
otThreadGetParentAverageRssi(otInstance *aInstance, int8_t *aParentRssi)
La función recupera el RSSI promedio del Thread Parent.
otThreadGetParentInfo(otInstance *aInstance, otRouterInfo *aParentInfo)
La función recupera información de diagnóstico para un router de Thread como elemento superior.
otThreadGetParentLastRssi(otInstance *aInstance, int8_t *aLastRssi)
La función recupera el RSSI del último paquete del Thread Parent.
otThreadGetPartitionId(otInstance *aInstance)
uint32_t
Obtén el ID de partición.
otThreadGetRealmLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
const otIp6Address *
Obtiene la dirección de 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 RLOC16.
otThreadGetServiceAloc(otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc)
Recupera el ALOC del servicio para un ID de servicio determinado.
otThreadGetTimeInQueueHistogram(otInstance *aInstance, uint16_t *aNumBins, uint32_t *aBinInterval)
const uint32_t *
Obtiene el histograma de tiempo en cola para los mensajes en la cola de TX.
otThreadGetVendorModel(otInstance *aInstance)
const char *
Obtén la string de modelo del proveedor.
otThreadGetVendorName(otInstance *aInstance)
const char *
Obtén la string del nombre del proveedor.
otThreadGetVendorSwVersion(otInstance *aInstance)
const char *
Obtén la cadena de versión de software del proveedor.
otThreadGetVersion(void)
uint16_t
Obtiene la versión del protocolo Thread.
otThreadIsAnycastLocateInProgress(otInstance *aInstance)
bool
Indica si una solicitud de ubicación Anycast está en curso.
otThreadIsDiscoverInProgress(otInstance *aInstance)
bool
Determina si un descubrimiento de subprocesos de MLE está actualmente en curso.
otThreadIsSingleton(otInstance *aInstance)
bool
Indica si un nodo es el único router de la red.
otThreadLocateAnycastDestination(otInstance *aInstance, const otIp6Address *aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext)
Solicita que se encuentre el destino más cercano de una dirección Anycast determinada.
otThreadRegisterParentResponseCallback(otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext)
void
Registra una devolución de llamada para recibir datos de respuestas para padres de MLE.
otThreadResetIp6Counters(otInstance *aInstance)
void
Restablece los contadores de IPv6.
otThreadResetMleCounters(otInstance *aInstance)
void
Restablece los contadores de Thread MLE.
otThreadResetTimeInQueueStat(otInstance *aInstance)
void
Restablece las estadísticas de tiempo en la cola de la cola de transmisión.
otThreadSearchForBetterParent(otInstance *aInstance)
Inicia el proceso para que el hijo o la hija busque a uno mejor mientras permanece vinculado al elemento superior actual.
otThreadSendAddressNotification(otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid)
void
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ía una solicitud de restablecimiento de diagnóstico de red.
otThreadSendProactiveBackboneNotification(otInstance *aInstance, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction)
Envía un mensaje de notificación proactiva de la red troncal (PRO_BB.ntf) en el vínculo de la red troncal.
otThreadSetChildTimeout(otInstance *aInstance, uint32_t aTimeout)
void
Establece el tiempo de espera del subproceso secundario (en segundos) que se usa cuando se opera con el rol secundario.
otThreadSetDiscoveryRequestCallback(otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext)
void
Configura 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)
Inicia la operación del protocolo Thread.
otThreadSetExtendedPanId(otInstance *aInstance, const otExtendedPanId *aExtendedPanId)
Establece el ID 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 Unicast del dominio de Thread.
otThreadSetJoinerAdvertisement(otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength)
Establece el anuncio de unión de subprocesos cuando se descubre la red de Thread.
otThreadSetKeySequenceCounter(otInstance *aInstance, uint32_t aKeySequenceCounter)
void
Establece el thrKeySequenceCounter.
otThreadSetKeySwitchGuardTime(otInstance *aInstance, uint32_t aKeySwitchGuardTime)
void
Establece el thrKeySwitchGuardTime (en horas).
otThreadSetLinkMode(otInstance *aInstance, otLinkModeConfig aConfig)
Establece la configuración del modo de vínculo de MLE.
otThreadSetMeshLocalPrefix(otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix)
Establece el prefijo local de malla.
otThreadSetNetworkKey(otInstance *aInstance, const otNetworkKey *aKey)
Configura la clave de red de Thread.
otThreadSetNetworkKeyRef(otInstance *aInstance, otNetworkKeyRef aKeyRef)
Establece la clave de red de Thread como otNetworkKeyRef.
otThreadSetNetworkName(otInstance *aInstance, const char *aNetworkName)
Establece el nombre de red de Thread.
otThreadSetVendorModel(otInstance *aInstance, const char *aVendorModel)
Establece la cadena del modelo del proveedor.
otThreadSetVendorName(otInstance *aInstance, const char *aVendorName)
Establece la cadena de nombre del proveedor.
otThreadSetVendorSwVersion(otInstance *aInstance, const char *aVendorSwVersion)
Establece la string de la versión del software del proveedor.

Structs

otBorderRouterConfig

Representa una configuración de router de borde.

otExternalRouteConfig

Representa una configuración de ruta externa.

otIpCounters

Representa los contadores de nivel de IP.

otLeaderData

Representa los datos líderes del subproceso.

otLinkModeConfig

Representa una configuración de modo de vínculo de MLE.

otLowpanContextInfo

Representa la información del ID de contexto de 6LoWPAN asociado con un prefijo en los datos de red.

otMleCounters

Representa los contadores de Thread MLE.

otNeighborInfo

Contiene información de diagnóstico para un nodo Thread cercano.

otNetworkDiagChildEntry

Representa una entrada de la tabla secundaria de diagnóstico de red.

otNetworkDiagConnectivity

Representa un valor de conectividad de diagnóstico de red.

otNetworkDiagMacCounters

Representa un valor de los contadores de Mac de diagnóstico de red.

otNetworkDiagMleCounters

Representa un valor de los contadores de MLE del diagnóstico de la red.

otNetworkDiagRoute

Representa un valor de TLV de ruta de diagnóstico de red.

otNetworkDiagRouteData

Representa los datos de una ruta de diagnóstico de red.

otNetworkDiagTlv

Representa un TLV de diagnóstico de red.

otRouterInfo

Contiene información de diagnóstico para un router Thread.

otServerConfig

Representa una configuración del servidor.

otServiceConfig

Representa una configuración de Service.

otThreadDiscoveryRequestInfo

Representa los datos de la solicitud de detección de subprocesos.

otThreadParentResponseInfo

Representa los datos de la respuesta superior de MLE.

Enumeraciones

enumeración anónima

 anonymous enum
Propiedades
OT_NETWORK_DIAGNOSTIC_TLV_ANSWER

Responde a TLV.

OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL

Nivel de batería (TLV).

OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES

Canales de usuario (TLV).

OT_NETWORK_DIAGNOSTIC_TLV_CHILD

TLV secundario.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_IP6_ADDR_LIST

Lista de direcciones IPv6 secundarias del TLV.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE

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

Lista de direcciones IPv6 del TLV.

OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA

TLV de datos líderes

OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS

Contadores MAC del TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT

TLV máx. de tiempo de espera secundario.

OT_NETWORK_DIAGNOSTIC_TLV_MLE_COUNTERS

Contadores de MLE para TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MODE

Modo TLV.

OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA

TLV de datos de red

OT_NETWORK_DIAGNOSTIC_TLV_QUERY_ID

ID de consulta del TLV.

OT_NETWORK_DIAGNOSTIC_TLV_ROUTE

TLV de Route64.

OT_NETWORK_DIAGNOSTIC_TLV_ROUTER_NEIGHBOR

TLV vecino del router

OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS

Address16 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE

Voltaje de suministro (TLV).

OT_NETWORK_DIAGNOSTIC_TLV_THREAD_STACK_VERSION

Thread Stack Version TLV

OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT

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

OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST

Lista de tipos de TLV.

OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_MODEL

Modelo de proveedor TLV.

OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_NAME

Nombre del proveedor TLV.

OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_SW_VERSION

Versión de SW del proveedor (TLV).

OT_NETWORK_DIAGNOSTIC_TLV_VERSION

Versión TLV.

otDeviceRole

 otDeviceRole

Representa una función de dispositivo de Thread.

Propiedades
OT_DEVICE_ROLE_CHILD

El rol secundario de Thread

OT_DEVICE_ROLE_DETACHED

Actualmente, no participa en una red o partición de Thread.

OT_DEVICE_ROLE_DISABLED

La pila de Thread está inhabilitada.

OT_DEVICE_ROLE_LEADER

Rol de líder de subprocesos

OT_DEVICE_ROLE_ROUTER

La función Router de Thread

otNetDataPublisherEvent

 otNetDataPublisherEvent

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 quitó 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

Representa una configuración de router de borde.

otDetachGracefullyCallback

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

Representa una configuración de ruta externa.

otIpCounters

struct otIpCounters otIpCounters

Representa los contadores de nivel de IP.

otLeaderData

struct otLeaderData otLeaderData

Representa los datos líderes del subproceso.

otLinkModeConfig

struct otLinkModeConfig otLinkModeConfig

Representa una configuración de modo de vínculo de MLE.

otLowpanContextInfo

struct otLowpanContextInfo otLowpanContextInfo

Representa la información del ID de contexto de 6LoWPAN asociado con un prefijo en los datos de red.

otMleCounters

struct otMleCounters otMleCounters

Representa los contadores de Thread MLE.

otNeighborInfoIterator

int16_t otNeighborInfoIterator

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

otNetDataDnsSrpServicePublisherCallback

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

El tipo de puntero define la devolución de llamada que se usa para notificar cuando se agrega una entrada de "Servicio DNS/SRP" a los datos de red de Thread o se la quita de estos.

Cuando se realiza la eliminación, se invoca la devolución de llamada independientemente de si Publisher (p. ej., cuando ya hay demasiadas entradas similares presentes en los datos de red) o una llamada explícita para anular la publicación de la entrada (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)

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

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

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

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

Representa una entrada de la tabla secundaria de diagnóstico de red.

otNetworkDiagConnectivity

struct otNetworkDiagConnectivity otNetworkDiagConnectivity

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

Representa un valor de los contadores de Mac de diagnóstico de red.

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

otNetworkDiagMleCounters

struct otNetworkDiagMleCounters otNetworkDiagMleCounters

Representa un valor de los contadores de MLE del diagnóstico de la red.

otNetworkDiagRoute

struct otNetworkDiagRoute otNetworkDiagRoute

Representa un valor de TLV de ruta de diagnóstico de red.

otNetworkDiagRouteData

struct otNetworkDiagRouteData otNetworkDiagRouteData

Representa los datos de una ruta de diagnóstico de red.

otNetworkDiagTlv

struct otNetworkDiagTlv otNetworkDiagTlv

Representa un TLV de diagnóstico de red.

otReceiveDiagnosticGetCallback

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

Se llama al puntero cuando se recibe la respuesta de Network Diagnostic Get.

Detalles
Parámetros
[in] aError
El error que se produce cuando no se puede obtener la respuesta.
[in] aMessage
Un puntero al búfer de mensajes que contiene la carga útil de la respuesta "Network Diagnostic Get" recibida. Disponible solo cuando aError es OT_ERROR_NONE.
[in] aMessageInfo
Un puntero para la información del mensaje de aMessage. Disponible solo 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

Representa una configuración del servidor.

otServiceConfig

struct otServiceConfig otServiceConfig

Representa una configuración de Service.

otThreadAnycastLocatorCallback

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

El tipo de puntero 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 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 para el 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, RLOC16 (0xfffe) no es válido.

otThreadDiscoveryRequestCallback

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

Se llama al puntero 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

Representa los datos de la solicitud de detección de subprocesos.

otThreadParentResponseCallback

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

Se llama al puntero cada vez que se recibe un mensaje de respuesta para padres de MLE.

Se usa en otThreadRegisterParentResponseCallback().

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

otThreadParentResponseInfo

struct otThreadParentResponseInfo otThreadParentResponseInfo

Representa los datos de la respuesta superior de MLE.

remotas

otConvertDurationInSecondsToString

void otConvertDurationInSecondsToString(
  uint32_t aDuration,
  char *aBuffer,
  uint16_t aSize
)

Convierte una duración de uint32_t (en segundos) en una string legible.

Requiere que se habilite OPENTHREAD_CONFIG_UPTIME_ENABLE.

La cadena sigue el formato "::" para horas, minutos y segundos (si la duración es menor a un día) o "

d.::" (si dura más de un día).

Si la string resultante no cabe en aBuffer (dentro de sus caracteres aSize), la string se truncará, pero la string resultante siempre tendrá terminación nula.

Está diseñada para usarse con mAge o mConnectionTime en estructuras otNeighborInfo o otChildInfo.

Detalles
Parámetros
[in] aDuration
Es un intervalo de duración en segundos.
[out] aBuffer
Un puntero para un array de caracteres como resultado de la string.
[in] aSize
El tamaño de aBuffer (en bytes). Se recomienda usar OT_DURATION_STRING_SIZE.

otNetDataContainsOmrPrefix

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

Verifica si un prefijo determinado puede actuar como un prefijo OMR válido y, además, los datos de red del líder contienen este prefijo.

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

otNetDataGet

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

Proporciona una copia completa o estable de los datos de red del Thread de la partición.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aStable
TRUE cuando se copia la versión estable, 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, número de bytes copiados.
Valores que se muestran
OT_ERROR_NONE
Se copiaron correctamente los datos de red de Thread en aData y se actualizaron aDataLength.
OT_ERROR_NO_BUFS
No hay espacio suficiente en aData para copiar por completo los datos de red de Thread.

otNetDataGetCommissioningDataset

void otNetDataGetCommissioningDataset(
  otInstance *aInstance,
  otCommissioningDataset *aDataset
)

Obtiene el conjunto de datos de comisión de los datos de red de la partición.

Detalles
Parámetros
[in] aInstance
Un puntero para la instancia de OpenThread.
[out] aDataset
Un puntero para un elemento otCommissioningDataset que se propagará.

otNetDataGetLength

uint8_t otNetDataGetLength(
  otInstance *aInstance
)

Obtén la longitud actual (cantidad de bytes) de datos de red de Thread de la partición.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
Es la longitud de los datos de la red.

otNetDataGetMaxLength

uint8_t otNetDataGetMaxLength(
  otInstance *aInstance
)

Obtiene la longitud máxima observada de los datos de red de Thread desde la inicialización de la pila de OT o desde la última llamada a otNetDataResetMaxLength().

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
La longitud máxima de los datos de red (marca de agua alta para la longitud de los datos de red)

otNetDataGetNextLowpanContextInfo

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

Obtén la siguiente información del ID de contexto de 6LoWPAN 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 iterador de datos de red. Para obtener la primera entrada de servicio, se debe configurar como OT_NETWORK_DATA_ITERATOR_INIT.
[out] aContextInfo
Un puntero hacia el lugar en el que se ubicará la información recuperada del ID de contexto de 6LoWPAN.
Valores que se muestran
OT_ERROR_NONE
Se encontró correctamente la información del ID de contexto de 6LoWPAN siguiente.
OT_ERROR_NOT_FOUND
No existe información posterior de contexto de 6LoWPAN en los datos de red de la partición.

otNetDataGetNextOnMeshPrefix

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

Obtener el siguiente prefijo de malla activada 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, se debe configurar como OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Un puntero al lugar en el que se colocará la información del prefijo de malla activada.
Valores que se muestran
OT_ERROR_NONE
Se encontró correctamente el siguiente prefijo de malla activada.
OT_ERROR_NOT_FOUND
No existe ningún prefijo posterior de On Mesh en los datos de red de Thread.

otNetDataGetNextRoute

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

Obtén 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, se debe configurar como OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Un puntero donde se ubicará 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 existe ninguna entrada de ruta externa posterior en los datos de red de Thread.

otNetDataGetNextService

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

Obtén el siguiente servicio de 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, se debe configurar como OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Un puntero hacia el lugar en el que se ubicará la información del servicio.
Valores que se muestran
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 de datos de la red estable.

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

otNetDataGetVersion

uint8_t otNetDataGetVersion(
  otInstance *aInstance
)

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

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

otNetDataIsDnsSrpServiceAdded

bool otNetDataIsDnsSrpServiceAdded(
  otInstance *aInstance
)

Indica si se agregó la entrada "Servicio DNS/SRP" a los datos de red de Thread.

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
La entrada publicada del servicio de DNS/SRP se agrega a los datos de red de Thread.
FALSE
La entrada no se agregó a los datos de red de Thread o no hay ninguna entrada para publicar.

otNetDataIsPrefixAdded

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

Indica si se agrega o no una entrada de prefijo publicada (en malla o ruta externa) a los datos de red de Thread.

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 NULL).
Valores que se muestran
TRUE
La entrada de prefijo publicada se agrega a los datos de red de Thread.
FALSE
La entrada no se agregó a los datos de red de Thread o no hay ninguna entrada para publicar.

otNetDataPublishDnsSrpServiceAnycast

void otNetDataPublishDnsSrpServiceAnycast(
  otInstance *aInstance,
  uint8_t aSequenceNUmber
)

Solicita que se publique la "Dirección Anycast del servicio de DNS/SRP" en los datos de red de Thread.

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

Solicita que se publique la "Dirección Unicast del servicio de DNS/SRP" en los datos de red de Thread.

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 una llamada anterior a cualquiera de las funciones otNetDataPublishDnsSrpService{Type}()).

Publica la “Dirección unicast del servicio de DNS/SRP” mediante la inclusión de la dirección y la información del puerto en los datos del 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 NULA).
[in] aPort
El número de puerto del servidor de SRP para publicar.

otNetDataPublishDnsSrpServiceUnicastMeshLocalEid

void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(
  otInstance *aInstance,
  uint16_t aPort
)

Solicita que se publique la "Dirección Unicast del servicio de DNS/SRP" en los datos de red de Thread.

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 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 incluye la información en los datos del TLV del Service, esta función usa el EID de la malla local del dispositivo y, además, incluye la información en los datos del 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 para publicar.

otNetDataPublishExternalRoute

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

Solicita que se publique un prefijo de ruta externo en los datos de red de Thread.

Requiere que se habilite la función OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

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

Una llamada posterior a este método reemplazará una solicitud anterior para 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 en las marcas se reflejará de inmediato en los datos de red. Esto garantiza que las entradas existentes en los datos de red no se quiten de forma abrupta. Ten en cuenta que un cambio en el nivel de preferencia puede hacer que más adelante se quite la entrada de los datos de red si se determina que hay otros nodos que publican el mismo prefijo con la misma preferencia o una preferencia más alta.

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 NULA).
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 marca 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) que determina la configuración OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES.

otNetDataPublishOnMeshPrefix

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

Solicita que se publique un prefijo en la malla en los datos de red de Thread.

Requiere que se habilite la función OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

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

Una llamada posterior a este método reemplazará una solicitud anterior para 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 en las marcas se reflejará de inmediato en los datos de red. Esto garantiza que las entradas existentes en los datos de red no se quiten de forma abrupta. Ten en cuenta que un cambio en el nivel de preferencia puede hacer que más adelante se quite la entrada de los datos de red si se determina que hay otros nodos que publican el mismo prefijo con la misma preferencia o una preferencia más alta.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aConfig
La configuración del prefijo de la malla que se publicará (NO DEBE ser NULA).
Valores que se muestran
OT_ERROR_NONE
El prefijo de la malla se publicó correctamente.
OT_ERROR_INVALID_ARGS
El aConfig no es válido (prefijo incorrecto, combinaciones de marca 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) que determina la configuración OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES.

otNetDataReplacePublishedExternalRoute

otError otNetDataReplacePublishedExternalRoute(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix,
  const otExternalRouteConfig *aConfig
)

Reemplaza una ruta externa publicada anteriormente en los datos de red de Thread.

Requiere que se habilite la función OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

Si no hay ninguna ruta externa publicada que coincida con aPrefix, esta función se comporta de manera similar a otNetDataPublishExternalRoute(), es decir, iniciará el proceso de publicar aConfig como una ruta externa en los datos de red de Thread.

Si hay una entrada de ruta publicada anteriormente que coincide con aPrefix, se reemplazará por el nuevo prefijo de aConfig.

  • Si aPrefix ya se agregó en los datos de red, el cambio al nuevo prefijo en aConfig se refleja de inmediato en los datos de red. Esto garantiza que las entradas de ruta en los datos de red no se quiten de forma abrupta y que la transición de aPrefix al nuevo prefijo sea fluida.
  • Si el aPrefix publicado anterior no se agregó a los datos de red, se reemplazará por el nuevo prefijo aConfig, pero no se agregará de inmediato. En cambio, iniciará el proceso de publicación en los datos de la red (supervisando los datos de la red para determinar cuándo agregar el prefijo o si debe hacerlo, según la cantidad de prefijos similares presentes en los datos de la red).

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aPrefix
El prefijo de ruta externo publicado con anterioridad que se reemplazará.
[in] aConfig
La configuración de ruta externa que se publicará.
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 marca 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) que determina la configuración OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES.

otNetDataResetMaxLength

void otNetDataResetMaxLength(
  otInstance *aInstance
)

Restablece la longitud máxima monitoreada de los datos de red de Thread.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Consulta también:
otNetDataGetMaxLength

otNetDataSetDnsSrpServicePublisherCallback

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

Establece 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 previamente configurada.

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

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 previamente configurada.

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

Verifica si los datos de conducción incluyen una unión.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aEui64
Un puntero al EUI-64 del IEEE 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 volante presentes.
OT_ERROR_NOT_FOUND
No se incluye aEui64 en los datos del volante.

otNetDataSteeringDataCheckJoinerWithDiscerner

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

Comprueba si los datos de dirección incluyen un Joiner con un valor de discernador determinado.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aDiscerner
Un puntero para el Discerner de Joiner.
Valores que se muestran
OT_ERROR_NONE
aDiscerner se incluye en los datos del volante.
OT_ERROR_INVALID_STATE
No hay datos de volante presentes.
OT_ERROR_NOT_FOUND
No se incluye aDiscerner 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 haya agregado previamente 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 externo 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 NULL).
Valores que se muestran
OT_ERROR_NONE
Se anuló la publicación del prefijo correctamente.
OT_ERROR_NOT_FOUND
No se encontró el prefijo en la lista publicada.

otThreadBecomeChild

otError otThreadBecomeChild(
  otInstance *aInstance
)

Intenta volver a adjuntar como hijo.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Valores que se muestran
OT_ERROR_NONE
Se inició correctamente el intento de convertirse en hijo.
OT_ERROR_INVALID_STATE
La conversación está inhabilitada.

otThreadBecomeDetached

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.

otThreadDetachGracefully

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

Notifica a otros nodos en la red (si los hay) y, luego, detiene la operación del protocolo Thread.

Si es un router, envía una liberación de dirección o, si es un router secundario, establece el tiempo de espera en 0.

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 finaliza la desconexión.
[in] aContext
Un puntero para devolver la llamada al contexto específico de la aplicación.
Valores que se muestran
OT_ERROR_NONE
La desvinculación se inició con éxito.
OT_ERROR_BUSY
La desconexión ya está en curso.

otThreadDeviceRoleToString

const char * otThreadDeviceRoleToString(
  otDeviceRole aRole
)

Convierte el rol del dispositivo en una cadena legible.

Detalles
Parámetros
[in] aRole
El rol del dispositivo que se convertirá.
Qué muestra
Una cadena que representa aRole.

otThreadDiscover

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

Inicia un análisis de detección de subprocesos.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aScanChannels
Vector de bits que indica qué canales buscar (p. ej., OT_CHANNEL_11_MASK)
[in] aPanId
El filtro ID del PAN (configurado en Transmitir PAN para inhabilitar el filtro)
[in] aJoiner
Valor de la marca de unión en el TLV de solicitud de descubrimiento.
[in] aEnableEui64Filtering
TRUE para filtrar las respuestas en EUI-64, FALSE de lo contrario.
[in] aCallback
Un puntero a una función a la que se llama cuando recibe una respuesta de descubrimiento de MLE o se completa el análisis.
[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 detección 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 para la solicitud de descubrimiento.
OT_ERROR_BUSY
El análisis de descubrimiento de subprocesos ya está en curso.

otThreadGetChildTimeout

uint32_t otThreadGetChildTimeout(
  otInstance *aInstance
)

Obtiene el tiempo de espera del subproceso secundario (en segundos) que se usa cuando se opera con el rol secundario.

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

otThreadGetDeviceRole

otDeviceRole otThreadGetDeviceRole(
  otInstance *aInstance
)

Obtén el rol del dispositivo.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Valores que se muestran
OT_DEVICE_ROLE_DISABLED
La pila de Thread está inhabilitada.
OT_DEVICE_ROLE_DETACHED
Actualmente, el dispositivo no participa en una red o partición de Thread.
OT_DEVICE_ROLE_CHILD
Actualmente, el dispositivo funciona como un elemento secundario de Thread.
OT_DEVICE_ROLE_ROUTER
Actualmente, el dispositivo funciona como un router Thread.
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 de Thread.
Consulta también:
otThreadSetDomainName

otThreadGetExtendedPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

Obtiene el ID PAN extendido de IEEE 802.15.4.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
Un puntero para el ID PAN extendido de 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 unicast del dominio de Thread.

Disponible cuando se habilita OPENTHREAD_CONFIG_DUA_ENABLE.

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 configuró ninguno.
Consulta también:
otThreadSetFixedDuaInterfaceIdentifier

otThreadGetIp6Counters

const otIpCounters * otThreadGetIp6Counters(
  otInstance *aInstance
)

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

Obtiene el thrKeySequenceCounter.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
Es 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 thrKeySwitchGuardTime (en horas).
Consulta también:
otThreadSetKeySwitchGuardTime

otThreadGetLeaderData

otError otThreadGetLeaderData(
  otInstance *aInstance,
  otLeaderData *aLeaderData
)

Obtén los datos del líder de subprocesos.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aLeaderData
Un puntero que señala el lugar en el que se colocan los datos líderes.
Valores que se muestran
OT_ERROR_NONE
Se recuperaron correctamente los datos líderes.
OT_ERROR_DETACHED
No conectado actualmente.

otThreadGetLeaderRloc

otError otThreadGetLeaderRloc(
  otInstance *aInstance,
  otIp6Address *aLeaderRloc
)

Muestra un puntero al RLOC del líder.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aLeaderRloc
Un puntero a la RLOC del líder.
Valores que se muestran
OT_ERROR_NONE
La RLOC del líder se escribió correctamente en aLeaderRloc.
OT_ERROR_INVALID_ARGS
aLeaderRloc era NULL.
OT_ERROR_DETACHED
No está conectado a una partición de subproceso.

otThreadGetLeaderRouterId

uint8_t otThreadGetLeaderRouterId(
  otInstance *aInstance
)

Obtén el ID del router líder.

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

otThreadGetLeaderWeight

uint8_t otThreadGetLeaderWeight(
  otInstance *aInstance
)

Levanten 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 multidifusión basada en prefijos Unicast de vínculo local [RFC 3306], que incluye lo siguiente:

  • flgs establecido en 3 (P = 1 y T = 1)
  • alcance establecido en 2
  • plen establecido en 64
  • prefijo de red establecido en el prefijo local de malla
  • 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 de multidifusión local de todos los nodos de subprocesos de Thread.

otThreadGetLinkLocalIp6Address

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

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

La dirección local del vínculo de Thread se deriva mediante 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 a la dirección IPv6 local de vínculo de Thread.

otThreadGetLinkMode

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

otThreadGetMaxTimeInQueue

uint32_t otThreadGetMaxTimeInQueue(
  otInstance *aInstance
)

Obtiene el tiempo máximo en cola para los mensajes en la cola de transmisión.

Requiere OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE.

El tiempo en cola solo se registra para las transmisiones directas y se mide como la duración desde que un mensaje se agrega a la cola de transmisión hasta que se pasa a la capa MAC para su transmisión o se descarta.

Las estadísticas recopiladas se pueden restablecer llamando a otThreadResetTimeInQueueStat().

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
El tiempo máximo en cola en milisegundos para todos los mensajes en la cola de transmisión (hasta el momento).

otThreadGetMeshLocalEid

const otIp6Address * otThreadGetMeshLocalEid(
  otInstance *aInstance
)

Obtiene la dirección del 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
)

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 Thread MLE.

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

otThreadGetNetworkKey

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 a un otNetworkKey para mostrar la clave de red de Thread.
Consulta también:
otThreadSetNetworkKey

otThreadGetNetworkKeyRef

otNetworkKeyRef otThreadGetNetworkKeyRef(
  otInstance *aInstance
)

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

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

otThreadGetNetworkName

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 para el nombre de la red de Thread.
Consulta también:
otThreadSetNetworkName

otThreadGetNextDiagnosticTlv

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

Obtiene el siguiente TLV de diagnóstico de red del mensaje.

Requiere OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE.

Solo se permite una llamada posterior a esta función cuando el valor que se muestra actual es OT_ERROR_NONE.

Detalles
Parámetros
[in] aMessage
Un puntero para un mensaje.
[in,out] aIterator
Un puntero al contexto de iterador de diagnóstico de red. Para obtener el primer TLV de diagnóstico de red, se debe configurar como OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT.
[out] aNetworkDiagTlv
Un puntero al lugar en el que se ubicará la información de TLV de diagnóstico de red.
Valores que se muestran
OT_ERROR_NONE
Se encontró correctamente el siguiente TLV de diagnóstico de red.
OT_ERROR_NOT_FOUND
No existe un TLV de diagnóstico de red posterior en el mensaje.
OT_ERROR_PARSE
No se pudo analizar el siguiente diagnóstico de red.

otThreadGetNextNeighborInfo

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

Obtiene la información del próximo vecino.

Se usa para revisar las entradas de la tabla de vecinos.

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, se debe configurar como OT_NEIGHBOR_INFO_ITERATOR_INIT.
[out] aInfo
Un puntero a la información de vecino.
Valores que se muestran
OT_ERROR_NONE
Se encontró correctamente la entrada de vecino siguiente 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 NULL.

otThreadGetParentAverageRssi

otError otThreadGetParentAverageRssi(
  otInstance *aInstance,
  int8_t *aParentRssi
)

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

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aParentRssi
Un puntero hacia el lugar en el que se debe colocar el RSSI superior.

otThreadGetParentInfo

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

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

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aParentInfo
Un puntero hacia el lugar en el que 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 Thread Parent.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aLastRssi
Un puntero hacia la ubicación en la que 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 pudieron obtener los 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 de multidifusión de Thread Realm-Local All Thread Nodes.

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

  • flgs establecido en 3 (P = 1 y T = 1)
  • alcance establecido en 3
  • plen establecido en 64
  • prefijo de red establecido en el prefijo local de malla
  • 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 multicast de todos los nodos de Thread Realm-Local.

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 a la dirección del Localizador de enrutamiento de subprocesos (RLOC).

otThreadGetRloc16

uint16_t otThreadGetRloc16(
  otInstance *aInstance
)

Obtén RLOC16.

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

otThreadGetServiceAloc

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

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 que se puede obtener ALOC.
[out] aServiceAloc
Un puntero para generar el ALOC del servicio. NO DEBE SER NULO.
Valores que se muestran
OT_ERROR_NONE
Se recuperó correctamente el ALOC del servicio.
OT_ERROR_DETACHED
La interfaz Thread no está conectada actualmente a una partición de Thread.

otThreadGetTimeInQueueHistogram

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

Obtiene el histograma de tiempo en cola para los mensajes en la cola de TX.

Requiere OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE.

Se recopila el histograma del tiempo en cola de los mensajes en la cola de transmisión. El tiempo en cola solo se registra para las transmisiones directas y se mide como la duración desde que un mensaje se agrega a la cola de transmisión hasta que se pasa a la capa MAC para su transmisión o se descarta.

El histograma se muestra como un array de valores uint32_t con entradas aNumBins. La primera entrada del array (en el índice 0) representa la cantidad de mensajes con un tiempo en cola inferior a aBinInterval. La segunda entrada representa la cantidad de mensajes con un tiempo en cola mayor o igual que aBinInterval, pero menor que 2 * aBinInterval. Y así sucesivamente. La última entrada representa la cantidad de mensajes con tiempo en cola mayor o igual que (aNumBins - 1) * aBinInterval.

Las estadísticas recopiladas se pueden restablecer llamando a otThreadResetTimeInQueueStat(). La información del histograma se recopila desde que se inicializó la instancia de OpenThread o desde la última vez que se restableció la recopilación de estadísticas mediante una llamada a otThreadResetTimeInQueueStat().

Los punteros aNumBins y aBinInterval NO DEBEN ser NULO.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aNumBins
Puntero para mostrar el número de discretizaciones en el histograma (longitud del array).
[out] aBinInterval
Es el puntero que muestra la longitud del intervalo de depósitos del histograma en milisegundos.
Qué muestra
Un puntero para un array de entradas aNumBins que representan la información de histograma recopilada.

otThreadGetVendorModel

const char * otThreadGetVendorModel(
  otInstance *aInstance
)

Obtén la string de modelo del proveedor.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
Es la cadena de modelo del proveedor.

otThreadGetVendorName

const char * otThreadGetVendorName(
  otInstance *aInstance
)

Obtén la string del nombre del proveedor.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
Es la string del nombre del proveedor.

otThreadGetVendorSwVersion

const char * otThreadGetVendorSwVersion(
  otInstance *aInstance
)

Obtén la cadena de versión de software del proveedor.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
La string de versión de software del proveedor.

otThreadGetVersion

uint16_t otThreadGetVersion(
  void
)

Obtiene la versión del protocolo Thread.

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

otThreadIsAnycastLocateInProgress

bool otThreadIsAnycastLocateInProgress(
  otInstance *aInstance
)

Indica si una solicitud de ubicación Anycast está en curso.

Solo está disponible cuando se habilita OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
TRUE si una solicitud de ubicación anycast está actualmente en curso, de lo contrario, FALSE.

otThreadIsDiscoverInProgress

bool otThreadIsDiscoverInProgress(
  otInstance *aInstance
)

Determina si un descubrimiento de subprocesos de MLE está actualmente en curso.

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

otThreadIsSingleton

bool otThreadIsSingleton(
  otInstance *aInstance
)

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
)

Solicita que se encuentre el destino más cercano de una dirección Anycast determinada.

Solo está disponible cuando se habilita OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE.

Si una solicitud anterior está en curso, las llamadas posteriores a esta función cancelarán y reemplazarán la solicitud anterior.

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 que se usa 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 NULL.
OT_ERROR_NO_BUFS
Sin búfer para preparar y enviar el mensaje de solicitud.

otThreadRegisterParentResponseCallback

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

Registra una devolución de llamada para recibir datos de respuestas para padres de MLE.

Requiere OPENTHREAD_CONFIG_MLE_PARENT_RESPONSE_CALLBACK_API_ENABLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aCallback
Un puntero a una función a la que se llama cuando se recibe un mensaje de respuesta para padres de MLE.
[in] aContext
Un puntero para devolver la llamada al 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 Thread MLE.

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

otThreadResetTimeInQueueStat

void otThreadResetTimeInQueueStat(
  otInstance *aInstance
)

Restablece las estadísticas de tiempo en la cola de la cola de transmisión.

Requiere OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE.

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

otThreadSearchForBetterParent

otError otThreadSearchForBetterParent(
  otInstance *aInstance
)

Inicia el proceso para que el hijo o la hija busque a uno mejor mientras permanece vinculado al elemento superior actual.

Debe usarse cuando el dispositivo está conectado como hijo o hija.

Detalles
Valores que se muestran
OT_ERROR_NONE
Se inició correctamente el proceso de búsqueda de un mejor padre o madre.
OT_ERROR_INVALID_STATE
El rol del dispositivo no es secundario.

otThreadSendAddressNotification

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

Envía un mensaje de notificación de dirección proactiva (ADDR_NTF.ntf).

Solo está disponible cuando se habilita OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE.

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 de destino del mensaje ADDR_NTF.ntf.
[in] aMlIid
El ML-IID 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.

Requiere OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE.

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 array de tipos de TLV de diagnóstico de red.
[in] aCount
Cantidad de tipos en aTlvTypes.
[in] aCallback
Un puntero a una función a la que se llama cuando se recibe la respuesta "Network Diagnostic Get" 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 solicitud 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ía una solicitud de restablecimiento de diagnóstico de red.

Requiere OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE.

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 array 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 colocó correctamente el archivo DIAG_RST.ntf en cola.
OT_ERROR_NO_BUFS
No hay suficientes búferes de mensajes disponibles para enviar DIAG_RST.ntf.

otThreadSendProactiveBackboneNotification

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

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

Solo está disponible cuando se habilita OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aTarget
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 la red troncal.
OT_ERROR_NO_BUFS
Si no hay búferes de mensajes disponibles insuficientes.

otThreadSetChildTimeout

void otThreadSetChildTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

Establece el tiempo de espera del subproceso secundario (en segundos) que se usa cuando se opera con el rol secundario.

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

otThreadSetDiscoveryRequestCallback

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

Configura 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 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 se realiza de forma correcta cuando los protocolos de subprocesos están inhabilitados.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aDomainName
Un puntero para el nombre de dominio de Thread.
Valores que se muestran
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
)

Inicia la operación del protocolo Thread.

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

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

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

otThreadSetExtendedPanId

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

Establece el ID PAN extendido de IEEE 802.15.4.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aExtendedPanId
Un puntero para el ID PAN extendido de IEEE 802.15.4.
Valores que se muestran
OT_ERROR_NONE
Se configuró correctamente el ID 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 del dominio de Thread.

Disponible 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
El identificador de interfaz se estableció o borró correctamente.
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
)

Establece el anuncio de unión de subprocesos cuando se descubre la red de Thread.

El anuncio de unión de subprocesos se usa para permitir que un miembro de este anunciante anuncie información específica de su aplicación (como el ID del proveedor, el ID del producto, el discriminador, etc.) a través de un TLV de anuncio de unión de la propuesta nueva, así como para que la información esté disponible para los comisionados o los candidatos de comisionados sin interacción humana.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aOui
El valor de OUI de IEEE del proveedor que se incluirá en el anuncio de unión. Solo se usarán los 3 bytes menos significativos y se ignorará el más importante.
[in] aAdvData
Un puntero para AdvData que se incluirá en el anuncio de Joiner.
[in] aAdvDataLength
Es 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
AdvData no es válido.

otThreadSetKeySequenceCounter

void otThreadSetKeySequenceCounter(
  otInstance *aInstance,
  uint32_t aKeySequenceCounter
)

Establece el thrKeySequenceCounter.

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

otThreadSetKeySwitchGuardTime

void otThreadSetKeySwitchGuardTime(
  otInstance *aInstance,
  uint32_t aKeySwitchGuardTime
)

Establece el thrKeySwitchGuardTime (en horas).

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

otThreadSetLinkMode

otError otThreadSetLinkMode(
  otInstance *aInstance,
  otLinkModeConfig aConfig
)

Establece la configuración del modo de vínculo 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
)

Establece el prefijo local de malla.

Solo tiene éxito 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 la 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 de Thread.

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

otThreadSetNetworkKeyRef

otError otThreadSetNetworkKeyRef(
  otInstance *aInstance,
  otNetworkKeyRef aKeyRef
)

Establece la clave de red de Thread como otNetworkKeyRef.

Solo tiene éxito 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.

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 Thread.
OT_ERROR_INVALID_STATE
Los protocolos de subprocesos están habilitados.
Consulta también:
otThreadGetNetworkKeyRef

otThreadSetNetworkName

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

Establece el nombre de red de Thread.

Solo tiene éxito 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 la red de Thread.
Valores que se muestran
OT_ERROR_NONE
Se configuró correctamente el nombre de la red de Thread.
OT_ERROR_INVALID_STATE
Los protocolos de subprocesos están habilitados.
Consulta también:
otThreadGetNetworkName

otThreadSetVendorModel

otError otThreadSetVendorModel(
  otInstance *aInstance,
  const char *aVendorModel
)

Establece la cadena del modelo del proveedor.

Requiere OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE.

aVendorModel debe ser UTF8 y tener una longitud máxima de 32 caracteres (MAX_VENDOR_MODEL_TLV_LENGTH). La longitud máxima no incluye el carácter nulo \0.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aVendorModel
Es la cadena de modelo del proveedor.
Valores que se muestran
OT_ERROR_NONE
Se configuró correctamente el modelo de proveedor.
OT_ERROR_INVALID_ARGS
aVendorModel no es válido (demasiado largo o no tiene codificación UTF8).

otThreadSetVendorName

otError otThreadSetVendorName(
  otInstance *aInstance,
  const char *aVendorName
)

Establece la cadena de nombre del proveedor.

Requiere OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE.

aVendorName debe ser UTF8 y tener una longitud máxima de 32 caracteres (MAX_VENDOR_NAME_TLV_LENGTH). La longitud máxima no incluye el carácter nulo \0.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aVendorName
Es la string del nombre del proveedor.
Valores que se muestran
OT_ERROR_NONE
El nombre del proveedor se configuró correctamente.
OT_ERROR_INVALID_ARGS
aVendorName no es válido (demasiado largo o no tiene codificación UTF8).

otThreadSetVendorSwVersion

otError otThreadSetVendorSwVersion(
  otInstance *aInstance,
  const char *aVendorSwVersion
)

Establece la string de la versión del software del proveedor.

Requiere OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE.

aVendorSwVersion debe ser UTF8 y tener una longitud máxima de 16 caracteres(MAX_VENDOR_SW_VERSION_TLV_LENGTH). La longitud máxima no incluye el carácter nulo \0.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aVendorSwVersion
Es la string de la versión del software del proveedor.
Valores que se muestran
OT_ERROR_NONE
Se configuró correctamente la versión del software del proveedor.
OT_ERROR_INVALID_ARGS
aVendorSwVersion no es válido (demasiado largo o no tiene codificación UTF8).

Macros

OT_DURATION_STRING_SIZE

 OT_DURATION_STRING_SIZE 21

Tamaño recomendado para la representación de cadena de uint32_t de duración en segundos.

OT_JOINER_ADVDATA_MAX_LENGTH

 OT_JOINER_ADVDATA_MAX_LENGTH 64

Longitud máxima de los datos de AdvData del anuncio de unión.

OT_NEIGHBOR_INFO_ITERATOR_INIT

 OT_NEIGHBOR_INFO_ITERATOR_INIT 0

Inicializador para otNeighborInfoIterator.

OT_NETWORK_BASE_TLV_MAX_LENGTH

 OT_NETWORK_BASE_TLV_MAX_LENGTH 254

Longitud de valor máxima del TLV de base de Thread.

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 red

OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT

 OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT 0

Inicializador de otNetworkDiagIterator.

OT_NETWORK_DIAGNOSTIC_MAX_THREAD_STACK_VERSION_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_THREAD_STACK_VERSION_TLV_LENGTH 64

Longitud máxima del TLV de la versión de Thread Stack.

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_MODEL_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_MODEL_TLV_LENGTH 32

Longitud máxima del TLV del modelo de proveedor.

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH 32

Longitud máxima del TLV del nombre del proveedor.

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_SW_VERSION_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_SW_VERSION_TLV_LENGTH 16

Longitud máxima del TLV de la versión de SW del proveedor.

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 solicitarán o restablecerán.

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 los datos del servidor en bytes. Límite teórico, prácticamente mucho más bajo.

OT_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 a partir del código fuente, disponible en GitHub. Para obtener más información o contribuir a nuestra documentación, consulta Recursos.