Consideraciones generales

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

Resumen

El editor de datos de red proporciona mecanismos para limitar la cantidad de entradas similares de servicio o prefijo (prefijo en malla o ruta externa) en los datos de red de Thread mediante la supervisión de los datos de red y la administración de las entradas o las salidas que se realicen.

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 el rol del dispositivo 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 del 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 del líder de Thread.
otLinkModeConfig typedef
Representa una configuración del modo de vínculo de MLE.
otLowpanContextInfo typedef
Representa la información de ID de contexto de 6LoWPAN asociada con un prefijo en los datos de red.
otMleCounters typedef
struct otMleCounters
Representa los contadores de MLE de Thread.
otNeighborInfoIterator typedef
int16_t
Se usa para iterar a través de la tabla vecina.
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 quita de allí.
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 malla o ruta externa) a los datos de red de Thread o cuando se la quita de esta.
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 contador de Mac de diagnóstico de red.
otNetworkDiagMleCounters typedef
Representa un valor de contador de MLE de diagnóstico de red.
otNetworkDiagRoute typedef
Representa un valor de TLV de la 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 una respuesta Get de diagnóstico de red.
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 del servicio.
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 descubrimiento de Thread.
otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext) typedef
void(*
Se llama al puntero cada vez que se recibe un mensaje de respuesta parental de MLE.
otThreadParentResponseInfo typedef
Representa los datos de la respuesta superior del MLE.

Funciones

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 si 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 de Thread de la partición.
otNetDataGetLength(otInstance *aInstance)
uint8_t
Obtiene la longitud actual (cantidad de bytes) de los datos de la red del subproceso de partición.
otNetDataGetMaxLength(otInstance *aInstance)
uint8_t
Obtén la longitud máxima observada de los datos de la 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)
Obtén el siguiente prefijo de malla 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 en los datos de red de la partición.
otNetDataGetStableVersion(otInstance *aInstance)
uint8_t
Obtén la versión de datos de red estable.
otNetDataGetVersion(otInstance *aInstance)
uint8_t
Obtén la versión de datos de red.
otNetDataIsDnsSrpServiceAdded(otInstance *aInstance)
bool
Indica si se agregó o no la entrada "Servicio DNS/SRP" a los datos de la red Thread.
otNetDataIsPrefixAdded(otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
Indica si se agregó o no una entrada de prefijo publicado (en una malla o una ruta externa) a los datos de la red Thread.
otNetDataPublishDnsSrpServiceAnycast(otInstance *aInstance, uint8_t aSequenceNUmber)
void
Solicita que se publique "DNS/SRP Service Anycast Address" en los datos de red de Thread.
otNetDataPublishDnsSrpServiceUnicast(otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort)
void
Solicita que se publique "DNS/SRP Service Unicast Address" en los datos de la red Thread.
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(otInstance *aInstance, uint16_t aPort)
void
Solicita que se publique "DNS/SRP Service Unicast Address" en los datos de la red 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 previamente en los datos de red de Thread.
otNetDataResetMaxLength(otInstance *aInstance)
void
Restablece la longitud máxima a la que se hace un seguimiento de los datos de red de Thread.
otNetDataSetDnsSrpServicePublisherCallback(otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext)
void
Establece una devolución de llamada para notificar cuando se agrega o quita un "Servicio DNS/SRP" publicado de los datos de red de Thread.
otNetDataSetPrefixPublisherCallback(otInstance *aInstance, otNetDataPrefixPublisherCallback aCallback, void *aContext)
void
Establece una devolución de llamada para notificar cuando se agrega una entrada de prefijo publicada a los datos de red de Thread o se quita de ellos.
otNetDataSteeringDataCheckJoiner(otInstance *aInstance, const otExtAddress *aEui64)
Verifique si los datos de la dirección incluyen un Joiner.
otNetDataSteeringDataCheckJoinerWithDiscerner(otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner)
Verifique si los datos de la dirección incluyen un Joiner con un valor determinado del discernimiento.
otNetDataUnpublishDnsSrpService(otInstance *aInstance)
void
Anula la publicación de cualquier entrada de servicio de DNS/SRP (Anycast o Unicast) que se haya agregado previamente de los datos de red de Thread.
otNetDataUnpublishPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
Anula la publicación de un prefijo de ruta externa o de malla publicado anteriormente.
otThreadBecomeChild(otInstance *aInstance)
Intenta volver a adjuntarlo como niño.
otThreadBecomeDetached(otInstance *aInstance)
Desconéctate de la red Thread.
otThreadDetachGracefully(otInstance *aInstance, otDetachGracefullyCallback aCallback, void *aContext)
Notifica a otros nodos de la red (si los hay) y, luego, detiene el funcionamiento del protocolo Thread.
otThreadDeviceRoleToString(otDeviceRole aRole)
const char *
Convierte la función del dispositivo en una string legible.
otThreadDiscover(otInstance *aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void *aCallbackContext)
Inicia un análisis de Thread Discovery.
otThreadGetChildTimeout(otInstance *aInstance)
uint32_t
Obtiene el tiempo de espera del elemento secundario de Thread (en segundos) que se usa cuando se opera la función secundaria.
otThreadGetDeviceRole(otInstance *aInstance)
Obtén la función de dispositivo.
otThreadGetDomainName(otInstance *aInstance)
const char *
Obtiene el nombre de dominio de Thread.
otThreadGetExtendedPanId(otInstance *aInstance)
const otExtendedPanId *
Obtiene el ID del PAN extendido de IEEE 802.15.4.
otThreadGetFixedDuaInterfaceIdentifier(otInstance *aInstance)
Obtiene el identificador de interfaz especificado manualmente para la dirección unicat del dominio de Thread.
otThreadGetIp6Counters(otInstance *aInstance)
const otIpCounters *
Obtiene los contadores de IPv6.
otThreadGetKeySequenceCounter(otInstance *aInstance)
uint32_t
Obtiene el thrKeySequenceCounter.
otThreadGetKeySwitchGuardTime(otInstance *aInstance)
uint32_t
Obtiene el thrKeySwitchGuardTime (en horas).
otThreadGetLeaderData(otInstance *aInstance, otLeaderData *aLeaderData)
Obtén los datos de Thread Leader.
otThreadGetLeaderRloc(otInstance *aInstance, otIp6Address *aLeaderRloc)
Muestra un puntero al RLOC del líder.
otThreadGetLeaderRouterId(otInstance *aInstance)
uint8_t
Obtenga el ID de router del líder.
otThreadGetLeaderWeight(otInstance *aInstance)
uint8_t
Obtenga el peso del líder.
otThreadGetLinkLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
const otIp6Address *
Obtiene la dirección de multidifusión de Thread Link-Local All Thread Node.
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 vinculación 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 de malla local.
otThreadGetMleCounters(otInstance *aInstance)
const otMleCounters *
Obtiene los contadores de MLE de Thread.
otThreadGetNetworkKey(otInstance *aInstance, otNetworkKey *aNetworkKey)
void
Obtén la clave de red de Thread.
otThreadGetNetworkKeyRef(otInstance *aInstance)
Obtén la otNetworkKeyRef para la clave de red de Thread.
otThreadGetNetworkName(otInstance *aInstance)
const char *
Obtén el nombre de la red de Thread.
otThreadGetNextDiagnosticTlv(const otMessage *aMessage, otNetworkDiagIterator *aIterator, otNetworkDiagTlv *aNetworkDiagTlv)
Obtiene el siguiente TLV de diagnóstico de red en el 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 elemento superior del subproceso.
otThreadGetParentInfo(otInstance *aInstance, otRouterInfo *aParentInfo)
La función recupera información de diagnóstico de un router de subprocesos como superior.
otThreadGetParentLastRssi(otInstance *aInstance, int8_t *aLastRssi)
La función recupera el RSSI del último paquete del elemento superior del subproceso.
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 Node.
otThreadGetRloc(otInstance *aInstance)
const otIp6Address *
Obtiene la dirección del localizador de enrutamiento de subprocesos (RLOC).
otThreadGetRloc16(otInstance *aInstance)
uint16_t
Obtén el RLOC16.
otThreadGetServiceAloc(otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc)
Recupera el ALOC del servicio para el 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 de la cola de transmisión.
otThreadGetVendorModel(otInstance *aInstance)
const char *
Obtén la string del modelo de proveedor.
otThreadGetVendorName(otInstance *aInstance)
const char *
Obtén la string del nombre del proveedor.
otThreadGetVendorSwVersion(otInstance *aInstance)
const char *
Obtiene la string de la versión del sw del proveedor.
otThreadGetVersion(void)
uint16_t
Obtiene la versión del protocolo Thread.
otThreadIsAnycastLocateInProgress(otInstance *aInstance)
bool
Indica si una solicitud de localización de anycast está en curso.
otThreadIsDiscoverInProgress(otInstance *aInstance)
bool
Determina si hay un descubrimiento de subprocesos de MLE 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 ubique 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 respuesta superior del MLE.
otThreadResetIp6Counters(otInstance *aInstance)
void
Restablece los contadores de IPv6.
otThreadResetMleCounters(otInstance *aInstance)
void
Restablece los contadores de MLE de Thread.
otThreadResetTimeInQueueStat(otInstance *aInstance)
void
Restablece las estadísticas de tiempo de cola de TX.
otThreadSearchForBetterParent(otInstance *aInstance)
Inicia el proceso para que el elemento secundario busque un mejor elemento superior y, al mismo tiempo, permanezca conectado con su elemento superior actual.
otThreadSendAddressNotification(otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid)
void
Envía un mensaje proactivo de dirección (ADDR_NTF.ntf).
otThreadSendDiagnosticGet(otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext)
Envía una solicitud Get 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 proactivo de notificación troncal (PRO_BB.ntf) en el vínculo de red troncal.
otThreadSetChildTimeout(otInstance *aInstance, uint32_t aTimeout)
void
Establece el tiempo de espera del elemento secundario de Thread (en segundos) que se usa cuando se opera en el rol secundario.
otThreadSetDiscoveryRequestCallback(otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext)
void
Configura una devolución de llamada para recibir los datos de la solicitud de descubrimiento de MLE.
otThreadSetDomainName(otInstance *aInstance, const char *aDomainName)
Establece el nombre de dominio de Thread.
otThreadSetEnabled(otInstance *aInstance, bool aEnabled)
Inicia la operación del protocolo Thread.
otThreadSetExtendedPanId(otInstance *aInstance, const otExtendedPanId *aExtendedPanId)
Configura el ID de PAN extendido IEEE 802.15.4.
otThreadSetFixedDuaInterfaceIdentifier(otInstance *aInstance, const otIp6InterfaceIdentifier *aIid)
Establece o borra el identificador de interfaz especificado manualmente para la dirección de Unicast de dominio de Thread.
otThreadSetJoinerAdvertisement(otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength)
Establece el anuncio de Thread Joiner cuando se descubre una red de Thread.
otThreadSetKeySequenceCounter(otInstance *aInstance, uint32_t aKeySequenceCounter)
void
Configura 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 vinculación 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 del subproceso como otNetworkKeyRef.
otThreadSetNetworkName(otInstance *aInstance, const char *aNetworkName)
Configura el nombre de red de Thread.
otThreadSetVendorModel(otInstance *aInstance, const char *aVendorModel)
Establece la string del modelo de proveedor.
otThreadSetVendorName(otInstance *aInstance, const char *aVendorName)
Establece la string del 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 del router de borde.

otExternalRouteConfig

Representa una configuración de ruta externa.

otIpCounters

Representa los contadores de nivel de IP.

OtLeaderData

Representa los datos del líder de Thread.

otLinkModeConfig

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

otLowpanContextInfo;

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

otMleCounters

Representa los contadores de MLE de Thread.

otNeighborInfo;

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

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 contador de Mac de diagnóstico de red.

otNetworkDiagMleCounters

Representa un valor de contador de MLE de diagnóstico de red.

otNetworkDiagRoute

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

Configuración del servidor

Representa una configuración del servidor.

otServiceConfig;

Representa una configuración del servicio.

otThreadDiscoveryRequestInfo.

Representa los datos de la solicitud de descubrimiento de Thread.

otThreadParentResponseInfo.

Representa los datos de la respuesta superior del MLE.

Enumeraciones

enumeración anónima

 anonymous enum
Propiedades
OT_NETWORK_DIAGNOSTIC_TLV_ANSWER

Responda TLV.

OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL

Nivel de batería (TLV)

OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES

TLV de los canales de usuario.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD

TLV secundario

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_IP6_ADDR_LIST

TLV de la lista de direcciones IPv6 secundarias

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE

TLV de la tabla secundaria

OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY

TLV de conectividad.

OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS

TLV de dirección extendida de MAC.

OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST

TLV de la lista de direcciones IPv6

OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA

TLV de datos líderes.

OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS

TLV de los contadores MAC.

OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT

TLV de tiempo de espera de elementos secundarios máx.

OT_NETWORK_DIAGNOSTIC_TLV_MLE_COUNTERS

MLE Counters 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 de TLV.

OT_NETWORK_DIAGNOSTIC_TLV_ROUTE

TLV de Route64.

OT_NETWORK_DIAGNOSTIC_TLV_ROUTER_NEIGHBOR

TLV del vecino del router

OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS

TLV de Address16.

OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE

Voltaje de suministro TLV.

OT_NETWORK_DIAGNOSTIC_TLV_THREAD_STACK_VERSION

Versión TLV de la pila de subprocesos.

OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT

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

OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST

TLV de lista de tipos.

OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_MODEL

Modelo TLV del proveedor

OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_NAME

Nombre del proveedor de TLV.

OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_SW_VERSION

Proveedor SW Versión TLV

OT_NETWORK_DIAGNOSTIC_TLV_VERSION

Versión TLV.

otDeviceRole

 otDeviceRole

Representa el rol del dispositivo Thread.

Propiedades
OT_DEVICE_ROLE_CHILD

La función Thread Child.

OT_DEVICE_ROLE_DETACHED

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

OT_DEVICE_ROLE_DISABLED

La pila de Thread está inhabilitada.

OT_DEVICE_ROLE_LEADER

El rol de líder de Thread

OT_DEVICE_ROLE_ROUTER

La función del router de subprocesos.

otNetDataPublisherEvent

 otNetDataPublisherEvent

Representa los eventos informados desde las devoluciones de llamada del publicador.

Propiedades
OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED

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

OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED

La entrada publicada se quita de los datos de red de Thread.

oRouteRoutePreference

 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

oBorderBorderrConfig

struct otBorderRouterConfig otBorderRouterConfig

Representa una configuración del router de borde.

desGraceGraceCallback

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 al contexto específico de la aplicación.

otExternalRouteConfig

struct otExternalRouteConfig otExternalRouteConfig

Representa una configuración de ruta externa.

Contadores de OTI

struct otIpCounters otIpCounters

Representa los contadores de nivel de IP.

Datos principales de otLeader

struct otLeaderData otLeaderData

Representa los datos del líder de Thread.

otLinkModeConfig

struct otLinkModeConfig otLinkModeConfig

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

otLowpanContextInfo

struct otLowpanContextInfo otLowpanContextInfo

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

Contador otMle

struct otMleCounters otMleCounters

Representa los contadores de MLE de Thread.

otNeighborInfoIterator

int16_t otNeighborInfoIterator

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

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 quita de allí.

Cuando se quita la devolución de llamada, esta se invoca independientemente de si Publisher quita la entrada (p. ej., cuando ya hay demasiadas entradas similares en los datos de red) o mediante una llamada explícita para anular la publicación 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 al 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 malla o ruta externa) a los datos de red de Thread o cuando se la quita de esta.

Cuando se quita la devolución de llamada, esta se invoca independientemente de si Publisher quita la entrada (p.ej., cuando ya hay demasiadas entradas similares en los datos de la red) o mediante 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 al 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 contador de Mac de diagnóstico de red.

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

otNetworkDiagMleCounters

struct otNetworkDiagMleCounters otNetworkDiagMleCounters

Representa un valor de contador de MLE de diagnóstico de red.

otNetworkDiagRoute

struct otNetworkDiagRoute otNetworkDiagRoute

Representa un valor de TLV de la 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 una respuesta Get de diagnóstico de red.

Detalles
Parámetros
[in] aError
Se produjo un error cuando no se pudo obtener la respuesta.
[in] aMessage
Un puntero al búfer de mensajes que contiene la carga útil de respuesta Get de diagnóstico de red recibida. Disponible solo cuando aError es OT_ERROR_NONE.
[in] aMessageInfo
Un puntero a la información del mensaje de aMessage. Disponible solo cuando aError es OT_ERROR_NONE.
[in] aContext
Un puntero al contexto específico de la aplicación.

oRouteRoutePreference

enum otRoutePreference otRoutePreference

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

Configuración del servidor de ot

struct otServerConfig otServerConfig

Representa una configuración del servidor.

otServiceConfig;

struct otServiceConfig otServiceConfig

Representa una configuración del servicio.

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

otThreadDiscoveryRequestCallback

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

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

oThreadThreadRequestRequestInfo

struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo

Representa los datos de la solicitud de descubrimiento de Thread.

otThreadParentResponseCallback.

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

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

Se usa en otThreadRegisterParentResponseCallback().

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

oThreadThreadResponseResponseInfo

struct otThreadParentResponseInfo otThreadParentResponseInfo

Representa los datos de la respuesta superior del MLE.

Funciones

oConvertConvertInSecondsToString

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 string sigue el formato "::" para horas, minutos, segundos (si la duración es menor que 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 será nula.

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

Detalles
Parámetros
[in] aDuration
Un intervalo de duración en segundos.
[out] aBuffer
Un puntero para un array de caracteres que genera 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 si 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 de IPv6.
Qué muestra
Si aPrefix es un prefijo de OMR y los datos de red del líder contienen el prefijo de OMR aPrefix.

otNetDataGet

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

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

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aStable
VERDADERO cuando copia la versión estable, FALSO cuando copia la versión completa.
[out] aData
Un puntero para el búfer de datos.
[in,out] aDataLength
Cuando se ingresa, establece el tamaño del búfer de datos al que apunta aData. Al salir, es la cantidad 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 la red Thread.

otNetDataGetLength

uint8_t otNetDataGetLength(
  otInstance *aInstance
)

Obtiene la longitud actual (cantidad de bytes) de los datos de la red del subproceso de partición.

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

otNetDataGetMaxLength

uint8_t otNetDataGetMaxLength(
  otInstance *aInstance
)

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

otNetDataGetNextOnMeshPrefix

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

Obtén el siguiente prefijo de malla en los datos de red de la partición.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in,out] aIterator
Un puntero al contexto del iterador de datos de red. Para obtener la primera entrada de la malla, debe establecerla en OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Un puntero al lugar en el que se colocará la información del prefijo On Mesh.
Valores que se muestran
OT_ERROR_NONE
Se encontró correctamente el siguiente prefijo de malla.
OT_ERROR_NOT_FOUND
No existe un prefijo de On Mesh posterior 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, debe establecerse en OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Un puntero al lugar 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 una 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 en los datos de red de la partición.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in,out] aIterator
Un puntero al contexto del iterador de datos de red. Para obtener la primera entrada de servicio, debe establecerse en OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Un puntero al lugar donde 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 un 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 red estable.

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

otNetDataGetVersion

uint8_t otNetDataGetVersion(
  otInstance *aInstance
)

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

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

otNetDataIsDnsSrpServiceAdded

bool otNetDataIsDnsSrpServiceAdded(
  otInstance *aInstance
)

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

otNetDataIsPrefixAdded

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

Indica si se agregó o no una entrada de prefijo publicado (en una malla o una ruta externa) a los datos de la red 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 NULO).
Valores que se muestran
TRUE
La entrada de prefijo publicado se agrega a los datos de red de Thread.
FALSE
La entrada no se agrega a los datos de la red Thread o no hay una entrada para publicar.

otNetDataPublishDnsSrpServiceAnycast

void otNetDataPublishDnsSrpServiceAnycast(
  otInstance *aInstance,
  uint8_t aSequenceNUmber
)

Solicita que se publique "DNS/SRP Service Anycast Address" 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 “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 de Anycast de DNS/SRP.

otNetDataPublishDnsSrpServiceUnicast

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

Solicita que se publique "DNS/SRP Service Unicast Address" en los datos de la red 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 “Servicio DNS/SRP” que se haya publicado (de una llamada anterior a cualquiera de las funciones otNetDataPublishDnsSrpService{Type}()).

Publica la “Dirección Unicat del Servicio de DNS/SRP” incluyendo 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 NULO).
[in] aPort
El número de puerto del servidor de SRP que se publicará.

otNetDataPublishDnsSrpServiceUnicastMeshLocalEid

void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(
  otInstance *aInstance,
  uint16_t aPort
)

Solicita que se publique "DNS/SRP Service Unicast Address" en los datos de la red 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 “Servicio DNS/SRP” que se haya publicado (de una llamada anterior a cualquiera de las funciones otNetDataPublishDnsSrpService{Type}()).

A diferencia de otNetDataPublishDnsSrpServiceUnicast(), que requiere que se proporcione la dirección publicada y que incluya la información de los datos del TLV del servicio, esta función usa el EID local de la malla del dispositivo y, además, incluye la información de los datos 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 que se 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 VERDADERO.

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

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

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

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

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

otNetDataReplacePublishedExternalRoute

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

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

Requiere que se habilite la función OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

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

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

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

Detalles
Parámetros
[in] aPrefix
El prefijo de ruta externo publicado anteriormente para reemplazar.
[in] aConfig
La configuración de ruta externa que se publicará.
[in] aRequester
El solicitante (módulo kFromUser o kFromRoutingManager).
Valores que se muestran
OT_ERROR_NONE
La ruta externa se publicó correctamente.
OT_ERROR_INVALID_ARGS
El aConfig no es válido (prefijo erróneo, combinaciones de marcas no válidas o no estable).
OT_ERROR_NO_BUFS
No se pudo asignar una entrada para la solicitud nueva. El publicador admite una cantidad limitada de entradas (compartidas entre el prefijo en la malla y la ruta externa) determinadas por la configuración OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES.

otNetDataResetMaxLength

void otNetDataResetMaxLength(
  otInstance *aInstance
)

Restablece la longitud máxima a la que se hace un seguimiento 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 se agrega o quita un "Servicio DNS/SRP" publicado de los datos de red de Thread.

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

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 se agrega una entrada de prefijo publicada a los datos de red de Thread o se quita de ellos.

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

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
)

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

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

otNetDataSteeringDataCheckJoinerWithDiscerner

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

Verifique si los datos de la dirección incluyen un Joiner con un valor determinado del discernimiento.

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

otNetDataUnpublishDnsSrpService

void otNetDataUnpublishDnsSrpService(
  otInstance *aInstance
)

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

Se debe habilitar OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

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

otNetDataUnpublishPrefix

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

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

Se debe habilitar OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

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

otThreadBeChild

otError otThreadBecomeChild(
  otInstance *aInstance
)

Intenta volver a adjuntarlo como niño.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Valores que se muestran
OT_ERROR_NONE
Empieza a intentar convertirte en un niño.
OT_ERROR_INVALID_STATE
La conversación está inhabilitada.

otThreadThreaded

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.

otThreadDetachGraceGrace

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

Notifica a otros nodos de la red (si los hay) y, luego, detiene el funcionamiento del protocolo Thread.

Si se trata de un router, envía una liberación de direcciones o, en el caso de los niños, establece el tiempo de espera en 0.

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

otThreadDeviceRoleToString

const char * otThreadDeviceRoleToString(
  otDeviceRole aRole
)

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

Detalles
Parámetros
[in] aRole
La función del dispositivo que se desea convertir.
Qué muestra
Una string que representa aRole.

OtThread Descubre

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

Inicia un análisis de Thread Discovery.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aScanChannels
Un vector pequeño que indica qué canales se deben buscar (p.ej., OT_CHANNEL_11_MASK).
[in] aPanId
El filtro de ID de PAN (configurado como PAN de transmisión para inhabilitar el filtro)
[in] aJoiner
Valor de la marca de Unión en el TLV de la solicitud de descubrimiento.
[in] aEnableEui64Filtering
TRUE para filtrar las respuestas en EUI-64; en caso contrario, FALSE.
[in] aCallback
Un puntero a una función a la que se llama cuando se recibe una respuesta o un análisis de MLE.
[in] aCallbackContext
Un puntero al contexto específico de la aplicación.
Valores que se muestran
OT_ERROR_NONE
Se inició correctamente un análisis de Thread Discovery.
OT_ERROR_INVALID_STATE
La interfaz IPv6 no está habilitada (netif no está activada).
OT_ERROR_NO_BUFS
No se pudo asignar el mensaje a la solicitud de descubrimiento.
OT_ERROR_BUSY
El análisis de Thread Discovery ya está en curso.

otThreadGetChildTimeout

uint32_t otThreadGetChildTimeout(
  otInstance *aInstance
)

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

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

OtThreadGetDeviceRole

otDeviceRole otThreadGetDeviceRole(
  otInstance *aInstance
)

Obtén la función de dispositivo.

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

OtThreadGetDomainName

const char * otThreadGetDomainName(
  otInstance *aInstance
)

Obtiene el nombre de dominio de Thread.

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 del 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 de PAN extendido IEEE 802.15.4.
Consulta también:
otThreadSetExtendedPanId

otThreadGetFixedDuaInterfaceIdentifier

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
  otInstance *aInstance
)

Obtiene el identificador de interfaz especificado manualmente para la dirección unicat 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 NULO si no se configuró ninguno.
Consulta también:
otThreadSetFixedDuaInterfaceIdentifier

otThreadGetIp6Counters

const otIpCounters * otThreadGetIp6Counters(
  otInstance *aInstance
)

Obtiene los contadores de IPv6.

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

otThreadGetKeySequenceCounter

uint32_t otThreadGetKeySequenceCounter(
  otInstance *aInstance
)

Obtiene el thrKeySequenceCounter.

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

otThreadGetKeySwitchGuardTime

uint32_t otThreadGetKeySwitchGuardTime(
  otInstance *aInstance
)

Obtiene el thrKeySwitchGuardTime (en horas).

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

otThreadGetLeaderData.

otError otThreadGetLeaderData(
  otInstance *aInstance,
  otLeaderData *aLeaderData
)

Obtén los datos de Thread Leader.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aLeaderData
Un puntero al lugar donde están ubicados los datos del líder.
Valores que se muestran
OT_ERROR_NONE
Se recuperaron correctamente los datos del líder.
OT_ERROR_DETACHED
No conectado actualmente.

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
Una señal sobre el RLOC del líder.
Valores que se muestran
OT_ERROR_NONE
El RLOC del líder se escribió correctamente en aLeaderRloc.
OT_ERROR_INVALID_ARGS
aLeaderRloc era NULO.
OT_ERROR_DETACHED
No está vinculada a una partición de subproceso.

otThreadGetLeaderRouterId

uint8_t otThreadGetLeaderRouterId(
  otInstance *aInstance
)

Obtenga el ID de router del líder.

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

otThreadGetLeaderWeight

uint8_t otThreadGetLeaderWeight(
  otInstance *aInstance
)

Obtenga 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 Node.

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

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

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

otThreadGetLinkLocalIp6Address

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

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 para la dirección IPv6 de vínculo local de Thread.

otThreadGetLinkMode

otLinkModeConfig otThreadGetLinkMode(
  otInstance *aInstance
)

Obtén la configuración del modo de vinculación 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 se rastrea solo para las transmisiones directas y se mide como la duración desde que se agrega un mensaje 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 para todos los mensajes de 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 a la dirección EID de la malla local.

otThreadGetMeshLocalPrefix

const otMeshLocalPrefix * otThreadGetMeshLocalPrefix(
  otInstance *aInstance
)

Muestra un puntero al prefijo de malla local.

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

otThreadGetMleCounters

const otMleCounters * otThreadGetMleCounters(
  otInstance *aInstance
)

Obtiene los contadores de MLE de Thread.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
Un puntero para los contadores de 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 la conversación.
Consulta también:
otThreadSetNetworkKey

otThreadGetNetworkKeyRef

otNetworkKeyRef otThreadGetNetworkKeyRef(
  otInstance *aInstance
)

Obtén la 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 la 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 en el mensaje.

Requiere OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE.

Se permite una llamada posterior a esta función solo cuando el valor que se muestra actualmente es OT_ERROR_NONE.

Detalles
Parámetros
[in] aMessage
Un puntero para un mensaje
[in,out] aIterator
Un puntero al contexto del iterador de diagnóstico de red. Para obtener el primer TLV de diagnóstico de red, debe establecerlo en OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT.
[out] aNetworkDiagTlv
Un puntero al lugar donde 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 pasar por las entradas de la tabla vecina.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in,out] aIterator
Un puntero al contexto del iterador Para obtener la primera entrada de vecino, debe establecerse en OT_NEIGHBOR_INFO_ITERATOR_INIT.
[out] aInfo
Un puntero a la información del vecino.
Valores que se muestran
OT_ERROR_NONE
Se encontró correctamente la siguiente entrada de vecino en la tabla.
OT_ERROR_NOT_FOUND
No existe ninguna entrada de vecino posterior en la tabla.
OT_ERROR_INVALID_ARGS
aIterator o aInfo eran NULL.

oThreadThreadGetParentAverageRssi

otError otThreadGetParentAverageRssi(
  otInstance *aInstance,
  int8_t *aParentRssi
)

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

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aParentRssi
Un puntero a la ubicación en la que se debe ubicar el RSSI principal

otThreadGetParentInfo.

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

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

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aParentInfo
Un puntero al lugar donde está ubicada la información del router superior.

otThreadGetParentLastRssi

otError otThreadGetParentLastRssi(
  otInstance *aInstance,
  int8_t *aLastRssi
)

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

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aLastRssi
Un puntero sobre el lugar en el 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 NULL.

oThreadThreadGetPartitionId

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

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

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

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

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

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

OtThreadGetServiceAloc

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

Recupera el ALOC del servicio para el 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 debe 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 de 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 de la cola de transmisión.

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 se rastrea solo para las transmisiones directas y se mide como la duración desde que se agrega un mensaje 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 menor que 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 un 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 NULOS.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aNumBins
Es un puntero para mostrar la cantidad de discretizaciones del histograma (longitud del array).
[out] aBinInterval
Es un puntero para mostrar la longitud del intervalo de los contenedores de histogramas 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 del modelo de proveedor.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
Es la string del modelo de 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
)

Obtiene la string de la versión del sw del proveedor.

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

otThreadGetVersion

uint16_t otThreadGetVersion(
  void
)

Obtiene la versión del protocolo Thread.

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

oThreadThreadAnycastLocateInProgress

bool otThreadIsAnycastLocateInProgress(
  otInstance *aInstance
)

Indica si una solicitud de localización de anycast está en curso.

Solo está disponible cuando OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE está habilitado.

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

otThreadIsDiscoverInProgress

bool otThreadIsDiscoverInProgress(
  otInstance *aInstance
)

Determina si hay un descubrimiento de subprocesos de MLE en curso.

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

otThreadIsSingleton

bool otThreadIsSingleton(
  otInstance *aInstance
)

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 en la red.
FALSE
Es un elemento secundario o no es un router único en la red.

otThreadLocateAnycastDestination

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

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

Solo está disponible cuando OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE está habilitado.

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

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aAnycastAddress
La dirección Anycast para ubicar. NO DEBE ser NULO.
[in] aCallback
La función de devolución de llamada para informar el resultado.
[in] aContext
Un contexto arbitrario usado con aCallback.
Valores que se muestran
OT_ERROR_NONE
La solicitud comenzó correctamente. Se invocará aCallback para informar el resultado.
OT_ERROR_INVALID_ARGS
aAnycastAddress no es una dirección Anycast válida, o bien aCallback es NULL.
OT_ERROR_NO_BUFS
Se agotó el 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 respuesta superior del 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 superior de MLE.
[in] aContext
Un puntero para devolver el contexto específico del cliente.

otThreadResetIp6Contadores

void otThreadResetIp6Counters(
  otInstance *aInstance
)

Restablece los contadores de IPv6.

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

otThreadResetMleCounters

void otThreadResetMleCounters(
  otInstance *aInstance
)

Restablece los contadores de MLE de Thread.

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

otThreadResetTimeInQueueStat

void otThreadResetTimeInQueueStat(
  otInstance *aInstance
)

Restablece las estadísticas de tiempo de cola de TX.

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 elemento secundario busque un mejor elemento superior y, al mismo tiempo, permanezca conectado con su elemento superior actual.

Se debe usar cuando el dispositivo se conecte como niño.

Detalles
Valores que se muestran
OT_ERROR_NONE
Se inició con éxito 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 proactivo de dirección (ADDR_NTF.ntf).

Solo está disponible cuando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE está habilitado.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aDestination
El destino para enviar el mensaje ADDR_NTF.ntf.
[in] aTarget
La dirección 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 Get 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 a 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 una respuesta Get de diagnóstico de red o NULL para inhabilitar la devolución de llamada.
[in] aCallbackContext
Un puntero al contexto específico de la aplicación.
Valores que se muestran
OT_ERROR_NONE
Se puso en cola correctamente el DIAG_GET.req.
OT_ERROR_NO_BUFS
No hay suficientes búferes de mensajes disponibles para enviar DIAG_GET.req.

otThreadSendDiagnosticReset

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

Enví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 a 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 puso en cola correctamente el DIAG_RST.ntf.
OT_ERROR_NO_BUFS
No hay suficientes búferes de mensajes disponibles para enviar DIAG_RST.ntf.

otThreadSend proactivaBackboneNotification

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

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

Solo está disponible cuando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE está habilitado.

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

otThreadSetChildTimeout

void otThreadSetChildTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

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

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

otThreadSetDiscoveryRequestCallback

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

Configura una devolución de llamada para recibir los datos de la solicitud de descubrimiento de MLE.

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

otThreadSetDomainName;

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

Establece el nombre de dominio de Thread.

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

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aDomainName
Un puntero para el nombre de dominio de Thread.
Valores que se muestran
OT_ERROR_NONE
Se configuró correctamente el nombre de dominio de Thread.
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 al llamar a esta función.

Llamar a esta función con aEnabled establecido en FALSE detiene cualquier proceso en curso de desconexión iniciado por 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 Thread está habilitado; de lo contrario, FALSE.
Valores que se muestran
OT_ERROR_NONE
Se inició correctamente la operación del protocolo de Thread.
OT_ERROR_INVALID_STATE
La interfaz de red no estaba funcionando.

otThreadSetExtendedPanId

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

Configura el ID de PAN extendido IEEE 802.15.4.

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

oThreadThreadSetFixedDuaInterfaceIdentifier

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

Establece o borra el identificador de interfaz especificado manualmente para la dirección de Unicast de 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 al identificador de interfaz que se debe establecer o NULL para borrar.
Valores que se muestran
OT_ERROR_NONE
Se configuró correctamente el identificador de interfaz y se borró correctamente.
OT_ERROR_INVALID_ARGS
El identificador de interfaz especificado está reservado.
Consulta también:
otThreadGetFixedDuaInterfaceIdentifier

otThreadSetJoinerAdvertising

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

Establece el anuncio de Thread Joiner cuando se descubre una red de Thread.

El anuncio de la unión de subprocesos se utiliza para permitir que la carpintería publique su propia información específica de la aplicación (como el ID del proveedor, el ID del producto, el discriminador, etc.) mediante un TLV del anuncio de la unión recién propuesto, y para poner esta información a disposición de los comisionados o candidatos del comisionado sin interacción humana.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aOui
Es el valor del OUI del proveedor IEEE que se incluirá en el anuncio de unión. Solo se usarán los 3 bytes menos significativos, y se ignorará el más significativo.
[in] aAdvData
Un puntero para los datos de anuncios que se incluirán 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
Los datos del anuncio no son válidos.

otThreadSetKeySequenceCounter

void otThreadSetKeySequenceCounter(
  otInstance *aInstance,
  uint32_t aKeySequenceCounter
)

Configura el thrKeySequenceCounter.

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

otThreadSetKeySwitchGuardTime

void otThreadSetKeySwitchGuardTime(
  otInstance *aInstance,
  uint32_t aKeySwitchGuardTime
)

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 vinculación de MLE.

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

otThreadSetMeshLocalPrefix

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

Establece el prefijo local de malla.

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

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

otThreadSetNetworkKey

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

Configura la clave de red de Thread.

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

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aKey
Un puntero para un búfer que contiene la clave de red 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 del subproceso como otNetworkKeyRef.

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

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
)

Configura el nombre de red de Thread.

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

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

oThreadThreadVenVenModel

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

Establece la string del modelo de proveedor.

Requiere OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE.

aVendorModel debe ser UTF8 con 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 string del modelo de proveedor.
Valores que se muestran
OT_ERROR_NONE
Se configuró correctamente el modelo del proveedor.
OT_ERROR_INVALID_ARGS
aVendorModel no es válido (demasiado largo o no es UTF8).

otThreadSetVendorName

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

Establece la string del nombre del proveedor.

Requiere OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE.

aVendorName debe ser UTF8 con 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
Se configuró correctamente el nombre del proveedor.
OT_ERROR_INVALID_ARGS
aVendorName no es válido (demasiado largo o no es 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 con 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 de software del proveedor.
Valores que se muestran
OT_ERROR_NONE
Se configuró correctamente la versión de software del proveedor.
OT_ERROR_INVALID_ARGS
aVendorSwVersion no es válido (demasiado largo o no es UTF8).

Macros

TS_DURATION_STRING_SIZE

 OT_DURATION_STRING_SIZE 21

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

OT_JOINER_ADVDATA_MAX_LENGTH

 OT_JOINER_ADVDATA_MAX_LENGTH 64

Longitud máxima del anuncio de unión.

OT_NEIGHBOR_INFO_ITERATOR_INIT

 OT_NEIGHBOR_INFO_ITERATOR_INIT 0

Inicializador de otNeighborInfoIterator.

PO_RED_BASE_TLV_MAX_LENGTH_OT

 OT_NETWORK_BASE_TLV_MAX_LENGTH 254

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

OT_NETWORK_DATA_ITERATOR_INIT

 OT_NETWORK_DATA_ITERATOR_INIT 0

Valor para inicializar otNetworkDataIterator.

T_RED_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE

 OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE 3

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

DIAGNOSTIC_ITERATOR_INIT_DE_OT_NETWORK_DIAGNOSTIC

 OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT 0

Inicializador de otNetworkDiagIterator.

PO_RED_DIAGNOSTIC_MAX_Thread_STACK_VERSION_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_THREAD_STACK_VERSION_TLV_LENGTH 64

Longitud máxima de TLV de la pila de subprocesos.

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_MODEL_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_MODEL_TLV_LENGTH 32

Longitud máxima del modelo de proveedor de TLV.

PO_RED_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH de OT

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH 32

Longitud máxima de TLV del nombre del proveedor.

PO_RED_DIAGNOSTIC_MAX_VENDOR_SW_VERSION_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_SW_VERSION_TLV_LENGTH 16

Longitud máxima de TLV del proveedor de software.

PO_RED_DIAGNOSTIC_TYPELIST_MAX_ENTRIES

 OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19

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

PO_RED_MAX_ROUTER_ID

 OT_NETWORK_MAX_ROUTER_ID 62

ID máximo del router.

TS_SERVER_DATA_MAX_SIZE

 OT_SERVER_DATA_MAX_SIZE 248

Tamaño máx. de datos del servidor en bytes. Límite teórico, casi mucho más bajo.

TPO_SERVICIO_DEL_SERVICIO_AL_TAMAÑO

 OT_SERVICE_DATA_MAX_SIZE 252

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

Recursos

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