General

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

Resumen

Nota: Las funciones de este módulo requieren OPENTHREAD_FTD=1 o OPENTHREAD_MTD=1 .

Enumeraciones
`anonymous enum { OT_SECURITY_POLICY_OBTAIN_MASTER_KEY = 1 << 7, OT_SECURITY_POLICY_NATIVE_COMMISSIONING = 1 << 6, OT_SECURITY_POLICY_ROUTERS = 1 << 5, OT_SECURITY_POLICY_EXTERNAL_COMMISSIONER = 1 << 4, OT_SECURITY_POLICY_BEACONS = 1 << 3 }`	enumeración Esta enumeración define los indicadores TLV de la política de seguridad.
anonymous enum { OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS = 0, OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS = 1, OT_NETWORK_DIAGNOSTIC_TLV_MODE = 2, OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT = 3, OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY = 4, OT_NETWORK_DIAGNOSTIC_TLV_ROUTE = 5, OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA = 6, OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA = 7, OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST = 8, OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS = 9, OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL = 14, OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE = 15, OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE = 16, OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES = 17, OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST = 18, OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT = 19 }	enumeración
`otDeviceRole { OT_DEVICE_ROLE_DISABLED = 0, OT_DEVICE_ROLE_DETACHED = 1, OT_DEVICE_ROLE_CHILD = 2, OT_DEVICE_ROLE_ROUTER = 3, OT_DEVICE_ROLE_LEADER = 4 }`	enumeración Representa una función de dispositivo Thread.
otMeshcopTlvType { OT_MESHCOP_TLV_CHANNEL = 0, OT_MESHCOP_TLV_PANID = 1, OT_MESHCOP_TLV_EXTPANID = 2, OT_MESHCOP_TLV_NETWORKNAME = 3, OT_MESHCOP_TLV_PSKC = 4, OT_MESHCOP_TLV_MASTERKEY = 5, OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE = 6, OT_MESHCOP_TLV_MESHLOCALPREFIX = 7, OT_MESHCOP_TLV_STEERING_DATA = 8, OT_MESHCOP_TLV_BORDER_AGENT_RLOC = 9, OT_MESHCOP_TLV_COMMISSIONER_ID = 10, OT_MESHCOP_TLV_COMM_SESSION_ID = 11, OT_MESHCOP_TLV_SECURITYPOLICY = 12, OT_MESHCOP_TLV_GET = 13, OT_MESHCOP_TLV_ACTIVETIMESTAMP = 14, OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT = 15, OT_MESHCOP_TLV_STATE = 16, OT_MESHCOP_TLV_JOINER_DTLS = 17, OT_MESHCOP_TLV_JOINER_UDP_PORT = 18, OT_MESHCOP_TLV_JOINER_IID = 19, OT_MESHCOP_TLV_JOINER_RLOC = 20, OT_MESHCOP_TLV_JOINER_ROUTER_KEK = 21, OT_MESHCOP_TLV_PROVISIONING_URL = 32, OT_MESHCOP_TLV_VENDOR_NAME_TLV = 33, OT_MESHCOP_TLV_VENDOR_MODEL_TLV = 34, OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV = 35, OT_MESHCOP_TLV_VENDOR_DATA_TLV = 36, OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV = 37, OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV = 48, OT_MESHCOP_TLV_IPV6_ADDRESS_TLV = 49, OT_MESHCOP_TLV_PENDINGTIMESTAMP = 51, OT_MESHCOP_TLV_DELAYTIMER = 52, OT_MESHCOP_TLV_CHANNELMASK = 53, OT_MESHCOP_TLV_COUNT = 54, OT_MESHCOP_TLV_PERIOD = 55, OT_MESHCOP_TLV_SCAN_DURATION = 56, OT_MESHCOP_TLV_ENERGY_LIST = 57, OT_MESHCOP_TLV_DISCOVERYREQUEST = 128, OT_MESHCOP_TLV_DISCOVERYRESPONSE = 129, OT_MESHCOP_TLV_JOINERADVERTISEMENT = 241 }	enumeración Esta enumeración representa los tipos de TLV meshcop.
`otRoutePreference { OT_ROUTE_PREFERENCE_LOW = -1, OT_ROUTE_PREFERENCE_MED = 0, OT_ROUTE_PREFERENCE_HIGH = 1 }`	enumeración Define valores válidos para el miembro mPreference en otExternalRouteConfig y otBorderRouterConfig .

Typedefs
`otBorderRouterConfig`	typedef `struct otBorderRouterConfig` Esta estructura representa una configuración de Border Router.
`otChannelMask`	typedef `uint32_t` Este tipo representa la máscara de canal.
`otExtendedPanId`	typedef `struct otExtendedPanId` Esta estructura representa un ID PAN extendido.
`otExternalRouteConfig`	typedef `struct otExternalRouteConfig` Esta estructura representa una configuración de ruta externa.
`otIpCounters`	typedef `struct otIpCounters` Esta estructura representa los contadores de nivel de IP.
`otLeaderData`	typedef `struct otLeaderData` Esta estructura representa los datos del líder del hilo.
`otLinkModeConfig`	typedef `struct otLinkModeConfig` Esta estructura representa una configuración del modo de enlace MLE.
`otMasterKey`	typedef `struct otMasterKey` Esta estructura representa una clave maestra de subprocesos.
`otMeshLocalPrefix`	typedef `otIp6NetworkPrefix` Esta estructura representa un prefijo local de malla.
`otMeshcopTlvType`	typedef `enum otMeshcopTlvType` Esta enumeración representa los tipos de TLV meshcop.
`otMleCounters`	typedef `struct otMleCounters` Esta estructura representa los contadores de Thread MLE.
`otNeighborInfoIterator`	typedef `int16_t` Se usa para iterar a través de la tabla vecina.
`otNetworkDataIterator`	typedef `uint32_t` Se utiliza para iterar a través de la información de datos de red.
`otNetworkDiagChildEntry`	typedef `struct otNetworkDiagChildEntry` Esta estructura representa una entrada de tabla secundaria de diagnóstico de red.
`otNetworkDiagConnectivity`	typedef `struct otNetworkDiagConnectivity` Esta estructura representa un valor de conectividad de diagnóstico de red.
`otNetworkDiagIterator`	typedef `uint16_t` Se utiliza para iterar a través del TLV de diagnóstico de red.
`otNetworkDiagMacCounters`	typedef `struct otNetworkDiagMacCounters` Esta estructura representa un valor de Contadores Mac de diagnóstico de red.
`otNetworkDiagRoute`	typedef `struct otNetworkDiagRoute` Esta estructura representa un valor TLV de ruta de diagnóstico de red.
`otNetworkDiagRouteData`	typedef `struct otNetworkDiagRouteData` Esta estructura representa los datos de una ruta de diagnóstico de red.
`otNetworkDiagTlv`	typedef `struct otNetworkDiagTlv` Esta estructura representa un TLV de diagnóstico de red.
`otNetworkName`	typedef `struct otNetworkName` Esta estructura representa un nombre de red.
`otOperationalDataset`	typedef `struct otOperationalDataset` Esta estructura representa un conjunto de datos operativo activo o pendiente.
`otOperationalDatasetComponents`	typedef `struct otOperationalDatasetComponents` Esta estructura representa la presencia de diferentes componentes en el conjunto de datos operativo activo o pendiente.
`otOperationalDatasetTlvs`	typedef `struct otOperationalDatasetTlvs` Esta estructura representa un conjunto de datos operativo activo o pendiente.
`otPskc`	typedef `struct otPskc` Esta estructura representa un PSKc.
`otReceiveDiagnosticGetCallback )(otMessage aMessage, const otMessageInfo aMessageInfo, void *aContext)`	typedef `void(*` Este puntero de función se llama cuando se recibe una respuesta de obtención de diagnóstico de red.
`otRoutePreference`	typedef `enum otRoutePreference` Define valores válidos para el miembro mPreference en otExternalRouteConfig y otBorderRouterConfig .
`otSecurityPolicy`	typedef `struct otSecurityPolicy` Esta estructura representa la Política de seguridad.
`otServerConfig`	typedef `struct otServerConfig` Esta estructura representa una configuración de servidor.
`otServiceConfig`	typedef `struct otServiceConfig` Esta estructura representa una configuración de servicio.
`otThreadDiscoveryRequestCallback )(const otThreadDiscoveryRequestInfo aInfo, void aContext)`	typedef `void(*` Este puntero de función se llama cada vez que se recibe un mensaje de solicitud de descubrimiento de MLE.
`otThreadDiscoveryRequestInfo`	typedef `struct otThreadDiscoveryRequestInfo` Esta estructura representa los datos de la solicitud de descubrimiento de subprocesos.
`otThreadParentResponseCallback )(otThreadParentResponseInfo aInfo, void aContext)`	typedef `void(*` Este puntero de función se llama cada vez que se recibe un mensaje de respuesta de los padres de MLE.
`otThreadParentResponseInfo`	typedef `struct otThreadParentResponseInfo` Esta estructura representa los datos de Respuesta de los padres de MLE.

Variables
`OT_TOOL_PACKED_END`	`OT_TOOL_PACKED_BEGIN struct otMasterKey`

Funciones
`otDatasetCreateNewNetwork ( otInstance aInstance, otOperationalDataset aDataset)`	`otError` Este método crea un nuevo conjunto de datos operativos para usar al formar una nueva red.
`otDatasetGeneratePskc (const char aPassPhrase, const otNetworkName aNetworkName, const otExtendedPanId aExtPanId, otPskc aPskc)`	`otError` Esta función genera PSKc a partir de una frase de contraseña, un nombre de red y un ID de PAN extendido determinados.
`otDatasetGetActive ( otInstance aInstance, otOperationalDataset aDataset)`	`otError` Esta función obtiene el conjunto de datos operativo activo.
`otDatasetGetActiveTlvs ( otInstance aInstance, otOperationalDatasetTlvs aDataset)`	`otError` Esta función obtiene el conjunto de datos operativo activo.
`otDatasetGetDelayTimerMinimal ( otInstance *aInstance)`	`uint32_t` Obtenga un temporizador de retardo mínimo.
`otDatasetGetPending ( otInstance aInstance, otOperationalDataset aDataset)`	`otError` Esta función obtiene el conjunto de datos operativo pendiente.
`otDatasetGetPendingTlvs ( otInstance aInstance, otOperationalDatasetTlvs aDataset)`	`otError` Esta función obtiene el conjunto de datos operativo pendiente.
`otDatasetIsCommissioned ( otInstance *aInstance)`	`bool` Esta función indica si una red válida está presente en el conjunto de datos operativos activo o no.
`otDatasetSendMgmtActiveGet ( otInstance aInstance, const otOperationalDatasetComponents aDatasetComponents, const uint8_t aTlvTypes, uint8_t aLength, const otIp6Address aAddress)`	`otError` Esta función envía MGMT_ACTIVE_GET.
`otDatasetSendMgmtActiveSet ( otInstance aInstance, const otOperationalDataset aDataset, const uint8_t *aTlvs, uint8_t aLength)`	`otError` Esta función envía MGMT_ACTIVE_SET.
`otDatasetSendMgmtPendingGet ( otInstance aInstance, const otOperationalDatasetComponents aDatasetComponents, const uint8_t aTlvTypes, uint8_t aLength, const otIp6Address aAddress)`	`otError` Esta función envía MGMT_PENDING_GET.
`otDatasetSendMgmtPendingSet ( otInstance aInstance, const otOperationalDataset aDataset, const uint8_t *aTlvs, uint8_t aLength)`	`otError` Esta función envía MGMT_PENDING_SET.
`otDatasetSetActive ( otInstance aInstance, const otOperationalDataset aDataset)`	`otError` Esta función establece el conjunto de datos operativo activo.
`otDatasetSetActiveTlvs ( otInstance aInstance, const otOperationalDatasetTlvs aDataset)`	`otError` Esta función establece el conjunto de datos operativo activo.
`otDatasetSetDelayTimerMinimal ( otInstance *aInstance, uint32_t aDelayTimerMinimal)`	`otError` Configure el temporizador de retardo mínimo.
`otDatasetSetPending ( otInstance aInstance, const otOperationalDataset aDataset)`	`otError` Esta función establece el conjunto de datos operativos pendientes.
`otDatasetSetPendingTlvs ( otInstance aInstance, const otOperationalDatasetTlvs aDataset)`	`otError` Esta función establece el conjunto de datos operativos pendientes.
`otNetDataGet ( otInstance aInstance, bool aStable, uint8_t aData, uint8_t *aDataLength)`	`otError` Este método proporciona una copia completa o estable de los datos de red de subprocesos de la partición.
`otNetDataGetNextOnMeshPrefix ( otInstance aInstance, otNetworkDataIterator aIterator, otBorderRouterConfig *aConfig)`	`otError` Esta función obtiene el siguiente Prefijo On Mesh en los Datos de Red de la partición.
`otNetDataGetNextRoute ( otInstance aInstance, otNetworkDataIterator aIterator, otExternalRouteConfig *aConfig)`	`otError` Esta función obtiene la siguiente ruta externa en los datos de red de la partición.
`otNetDataGetNextService ( otInstance aInstance, otNetworkDataIterator aIterator, otServiceConfig *aConfig)`	`otError` Esta función obtiene el siguiente servicio en los datos de red de la partición.
`otNetDataGetStableVersion ( otInstance *aInstance)`	`uint8_t` Obtenga la versión de datos de red estable.
`otNetDataGetVersion ( otInstance *aInstance)`	`uint8_t` Obtenga la versión de datos de red.
`otNetDataSteeringDataCheckJoiner ( otInstance aInstance, const otExtAddress aEui64)`	`otError` Compruebe si los datos de dirección incluyen un Joiner.
`otNetDataSteeringDataCheckJoinerWithDiscerner ( otInstance aInstance, const struct otJoinerDiscerner aDiscerner)`	`otError` Compruebe si los datos de dirección incluyen un Joiner con un valor de discernimiento determinado.
`otThreadBecomeChild ( otInstance *aInstance)`	`otError` Intenta volver a unirte como un niño.
`otThreadBecomeDetached ( otInstance *aInstance)`	`otError` Desconectarse de la red Thread.
`otThreadDiscover ( otInstance aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void aCallbackContext)`	`otError` Esta función inicia un análisis de Thread Discovery.
`otThreadGetChildTimeout ( otInstance *aInstance)`	`uint32_t` Obtenga el Thread Child Timeout usado cuando se opera en el rol Child.
`otThreadGetDeviceRole ( otInstance *aInstance)`	`otDeviceRole` Obtén el rol del dispositivo.
`otThreadGetDomainName ( otInstance *aInstance)`	`const char *` Obtenga el nombre de dominio del hilo.
`otThreadGetExtendedPanId ( otInstance *aInstance)`	`const otExtendedPanId *` Obtenga el ID de PAN extendido IEEE 802.15.4.
`otThreadGetFixedDuaInterfaceIdentifier ( otInstance *aInstance)`	`const otIp6InterfaceIdentifier *` Obtenga el identificador de interfaz especificado manualmente para la dirección unidifusión de dominio de subprocesos.
`otThreadGetIp6Counters ( otInstance *aInstance)`	`const otIpCounters *` Obtenga los contadores de IPv6.
`otThreadGetKeySequenceCounter ( otInstance *aInstance)`	`uint32_t` Obtenga thrKeySequenceCounter.
`otThreadGetKeySwitchGuardTime ( otInstance *aInstance)`	`uint32_t` Obtenga thrKeySwitchGuardTime.
`otThreadGetLeaderData ( otInstance aInstance, otLeaderData aLeaderData)`	`otError` Esta función obtiene los datos del líder del hilo.
`otThreadGetLeaderRloc ( otInstance aInstance, otIp6Address aLeaderRloc)`	`otError` Esta función devuelve un puntero al RLOC del líder.
`otThreadGetLeaderRouterId ( otInstance *aInstance)`	`uint8_t` Obtenga la identificación del enrutador del líder.
`otThreadGetLeaderWeight ( otInstance *aInstance)`	`uint8_t` Obtenga el peso del líder.
`otThreadGetLinkLocalIp6Address ( otInstance *aInstance)`	`const otIp6Address *` Esta función devuelve la dirección IPv6 local de enlace de subproceso.
`otThreadGetLinkMode ( otInstance *aInstance)`	`otLinkModeConfig` Obtenga la configuración del modo de enlace MLE.
`otThreadGetMasterKey ( otInstance *aInstance)`	`const otMasterKey *` Obtenga thrMasterKey.
`otThreadGetMeshLocalEid ( otInstance *aInstance)`	`const otIp6Address *` Esta función devuelve un puntero a la dirección EID local de malla.
`otThreadGetMeshLocalPrefix ( otInstance *aInstance)`	`const otMeshLocalPrefix *` Esta función devuelve un puntero al Prefijo local de malla.
`otThreadGetMleCounters ( otInstance *aInstance)`	`const otMleCounters *` Obtenga los contadores de Thread MLE.
`otThreadGetNetworkName ( otInstance *aInstance)`	`const char *` Obtenga el nombre de la red de subprocesos.
`otThreadGetNextDiagnosticTlv (const otMessage aMessage, otNetworkDiagIterator aIterator, otNetworkDiagTlv *aNetworkDiagTlv)`	`otError` Esta función obtiene el siguiente TLV de diagnóstico de red en el mensaje.
`otThreadGetNextNeighborInfo ( otInstance aInstance, otNeighborInfoIterator aIterator, otNeighborInfo *aInfo)`	`otError` Esta función obtiene la siguiente información del vecino.
`otThreadGetParentAverageRssi ( otInstance aInstance, int8_t aParentRssi)`	`otError` La función recupera el RSSI promedio para el Thread Parent.
`otThreadGetParentInfo ( otInstance aInstance, otRouterInfo aParentInfo)`	`otError` La función recupera información de diagnóstico para un Thread Router como padre.
`otThreadGetParentLastRssi ( otInstance aInstance, int8_t aLastRssi)`	`otError` La función recupera el RSSI del último paquete del Thread Parent.
`otThreadGetPartitionId ( otInstance *aInstance)`	`uint32_t` Obtenga el ID de partición.
`otThreadGetRloc ( otInstance *aInstance)`	`const otIp6Address *` Esta función devuelve un puntero a la dirección del localizador de enrutamiento de subprocesos (RLOC).
`otThreadGetRloc16 ( otInstance *aInstance)`	`uint16_t` Obtenga el RLOC16.
`otThreadGetVersion (void)`	`uint16_t` Esta función obtiene la versión del protocolo Thread.
`otThreadIsDiscoverInProgress ( otInstance *aInstance)`	`bool` Esta función determina si un descubrimiento de subprocesos MLE está actualmente en curso.
`otThreadIsSingleton ( otInstance *aInstance)`	`bool` Esta función indica si un nodo es el único enrutador en la red.
`otThreadRegisterParentResponseCallback ( otInstance aInstance, otThreadParentResponseCallback aCallback, void aContext)`	`void` Esta función registra una devolución de llamada para recibir datos de Respuesta de los padres de MLE.
`otThreadResetIp6Counters ( otInstance *aInstance)`	`void` Reinicie los contadores de IPv6.
`otThreadResetMleCounters ( otInstance *aInstance)`	`void` Restablezca los contadores de Thread MLE.
`otThreadSendDiagnosticGet ( otInstance aInstance, const otIp6Address aDestination, const uint8_t aTlvTypes[], uint8_t aCount)`	`otError` Envíe una solicitud de obtención de diagnóstico de red.
`otThreadSendDiagnosticReset ( otInstance aInstance, const otIp6Address aDestination, const uint8_t aTlvTypes[], uint8_t aCount)`	`otError` Envíe una solicitud de restablecimiento de diagnóstico de red.
`otThreadSetChildTimeout ( otInstance *aInstance, uint32_t aTimeout)`	`void` Establezca el tiempo de espera de subproceso secundario que se usa cuando se opera en el rol secundario.
`otThreadSetDiscoveryRequestCallback ( otInstance aInstnace, otThreadDiscoveryRequestCallback aCallback, void aContext)`	`void` Esta función establece una devolución de llamada para recibir datos de solicitud de descubrimiento de MLE.
`otThreadSetDomainName ( otInstance aInstance, const char aDomainName)`	`otError` Establezca el nombre de dominio del hilo.
`otThreadSetEnabled ( otInstance *aInstance, bool aEnabled)`	`otError` Esta función inicia la operación del protocolo Thread.
`otThreadSetExtendedPanId ( otInstance aInstance, const otExtendedPanId aExtendedPanId)`	`otError` Configure el ID de PAN extendido IEEE 802.15.4.
`otThreadSetFixedDuaInterfaceIdentifier ( otInstance aInstance, const otIp6InterfaceIdentifier aIid)`	`otError` Establezca / borre el identificador de interfaz especificado manualmente para la dirección de unidifusión del dominio de subprocesos.
`otThreadSetJoinerAdvertisement ( otInstance aInstance, uint32_t aOui, const uint8_t aAdvData, uint8_t aAdvDataLength)`	`otError` Este método establece el anuncio de Thread Joiner al descubrir la red de Thread.
`otThreadSetKeySequenceCounter ( otInstance *aInstance, uint32_t aKeySequenceCounter)`	`void` Establezca thrKeySequenceCounter.
`otThreadSetKeySwitchGuardTime ( otInstance *aInstance, uint32_t aKeySwitchGuardTime)`	`void` Establezca thrKeySwitchGuardTime.
`otThreadSetLinkMode ( otInstance *aInstance, otLinkModeConfig aConfig)`	`otError` Establezca la configuración del modo de enlace MLE.
`otThreadSetMasterKey ( otInstance aInstance, const otMasterKey aKey)`	`otError` Establezca thrMasterKey.
`otThreadSetMeshLocalPrefix ( otInstance aInstance, const otMeshLocalPrefix aMeshLocalPrefix)`	`otError` Esta función establece el prefijo local de malla.
`otThreadSetNetworkName ( otInstance aInstance, const char aNetworkName)`	`otError` Establezca el nombre de la red de subprocesos.
`otThreadSetReceiveDiagnosticGetCallback ( otInstance aInstance, otReceiveDiagnosticGetCallback aCallback, void aCallbackContext)`	`void` Esta función registra una devolución de llamada para proporcionar la carga útil de respuesta de obtención de diagnóstico de red sin procesar.

Estructuras
otBorderRouterConfig	Esta estructura representa una configuración de Border Router.
otExtendedPanId	Esta estructura representa un ID PAN extendido.
otExternalRouteConfig	Esta estructura representa una configuración de ruta externa.
otIpCounters	Esta estructura representa los contadores de nivel de IP.
otLeaderData	Esta estructura representa los datos del líder del hilo.
otLinkModeConfig	Esta estructura representa una configuración del modo de enlace MLE.
otMasterKey	Esta estructura representa una clave maestra de subprocesos.
otMleCounters	Esta estructura representa los contadores de Thread MLE.
otNeighborInfo	Esta estructura contiene información de diagnóstico para un nodo Thread vecino.
otNetworkDiagChildEntry	Esta estructura representa una entrada de tabla secundaria de diagnóstico de red.
otNetworkDiagConnectivity	Esta estructura representa un valor de conectividad de diagnóstico de red.
otNetworkDiagMacCounters	Esta estructura representa un valor de Contadores Mac de diagnóstico de red.
otNetworkDiagRoute	Esta estructura representa un valor TLV de ruta de diagnóstico de red.
otNetworkDiagRouteData	Esta estructura representa los datos de una ruta de diagnóstico de red.
otNetworkDiagTlv	Esta estructura representa un TLV de diagnóstico de red.
otNetworkName	Esta estructura representa un nombre de red.
otOperationalDataset	Esta estructura representa un conjunto de datos operativo activo o pendiente.
otOperationalDatasetComponents	Esta estructura representa la presencia de diferentes componentes en el conjunto de datos operativo activo o pendiente.
otOperationalDatasetTlvs	Esta estructura representa un conjunto de datos operativo activo o pendiente.
otPskc	Esta estructura representa PSKc.
otRouterInfo	Esta estructura contiene información de diagnóstico para un enrutador de subprocesos.
otSecurityPolicy	Esta estructura representa la Política de seguridad.
otServerConfig	Esta estructura representa una configuración de servidor.
otServiceConfig	Esta estructura representa una configuración de servicio.
otThreadDiscoveryRequestInfo	Esta estructura representa los datos de la solicitud de descubrimiento de subprocesos.
otThreadParentResponseInfo	Esta estructura representa los datos de Respuesta de los padres de MLE.

Enumeraciones

enumeración anónima

 anonymous enum

Esta enumeración define los indicadores TLV de la política de seguridad.

Propiedades
`OT_SECURITY_POLICY_BEACONS`	Balizas habilitadas.
`OT_SECURITY_POLICY_EXTERNAL_COMMISSIONER`	Comisionado externo permitido.
`OT_SECURITY_POLICY_NATIVE_COMMISSIONING`	Puesta en servicio nativa.
`OT_SECURITY_POLICY_OBTAIN_MASTER_KEY`	Obtención de la llave maestra.
`OT_SECURITY_POLICY_ROUTERS`	Enrutadores habilitados.

enumeración anónima

 anonymous enum

Propiedades
`OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL`	TLV de nivel de batería.
`OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES`	TLV de las páginas del canal.
`OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE`	Tabla secundaria TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY`	TLV de conectividad.
`OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS`	TLV de dirección extendida MAC.
`OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST`	TLV de lista de direcciones IPv6.
`OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA`	TLV de datos de líder.
`OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS`	Contadores MAC TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT`	TLV de tiempo de espera máximo para niños.
`OT_NETWORK_DIAGNOSTIC_TLV_MODE`	Modo TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA`	TLV de datos de red.
`OT_NETWORK_DIAGNOSTIC_TLV_ROUTE`	Route64 TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS`	Dirección16 TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE`	Voltaje de suministro TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT`	TLV de tiempo de espera (el período de tiempo máximo de sondeo para SED)
`OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST`	Tipo de lista TLV.

otDeviceRole

 otDeviceRole

Representa una función de dispositivo Thread.

Propiedades
`OT_DEVICE_ROLE_CHILD`	El papel de Thread Child.
`OT_DEVICE_ROLE_DETACHED`	Actualmente no participa en una red / partición de Thread.
`OT_DEVICE_ROLE_DISABLED`	La pila de subprocesos está deshabilitada.
`OT_DEVICE_ROLE_LEADER`	El rol del líder del hilo.
`OT_DEVICE_ROLE_ROUTER`	El rol de Thread Router.

otMeshcopTlvType

 otMeshcopTlvType

Esta enumeración representa los tipos de TLV meshcop.

Propiedades
`OT_MESHCOP_TLV_ACTIVETIMESTAMP`	TLV de marca de tiempo activa de meshcop
`OT_MESHCOP_TLV_BORDER_AGENT_RLOC`	TLV del localizador de agentes fronterizos meshcop
`OT_MESHCOP_TLV_CHANNEL`	TLV del canal meshcop
`OT_MESHCOP_TLV_CHANNELMASK`	Máscara de canal meshcop TLV
`OT_MESHCOP_TLV_COMMISSIONER_ID`	ID de comisionado de meshcop TLV
`OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT`	Comisionado meshcop Puerto UDP TLV
`OT_MESHCOP_TLV_COMM_SESSION_ID`	ID de sesión del comisionado de meshcop TLV
`OT_MESHCOP_TLV_COUNT`	meshcop Count TLV
`OT_MESHCOP_TLV_DELAYTIMER`	Temporizador de retardo meshcop TLV
`OT_MESHCOP_TLV_DISCOVERYREQUEST`	TLV de solicitud de descubrimiento de meshcop
`OT_MESHCOP_TLV_DISCOVERYRESPONSE`	TLV de respuesta de descubrimiento de meshcop
`OT_MESHCOP_TLV_ENERGY_LIST`	Lista de energía meshcop TLV
`OT_MESHCOP_TLV_EXTPANID`	meshcop Extended Pan Id TLV
`OT_MESHCOP_TLV_GET`	meshcop Obtener TLV
`OT_MESHCOP_TLV_IPV6_ADDRESS_TLV`	dirección IPv6 meshcop TLV
`OT_MESHCOP_TLV_JOINERADVERTISEMENT`	Anuncio de unión de meshcop TLV
`OT_MESHCOP_TLV_JOINER_DTLS`	meshcop Joiner DTLS Encapsulación TLV
`OT_MESHCOP_TLV_JOINER_IID`	Carpintero meshcop IID TLV
`OT_MESHCOP_TLV_JOINER_RLOC`	Meshcop Joiner Router Locator TLV
`OT_MESHCOP_TLV_JOINER_ROUTER_KEK`	Enrutador de carpintero meshcop KEK TLV
`OT_MESHCOP_TLV_JOINER_UDP_PORT`	Meshcop Joiner Puerto UDP TLV
`OT_MESHCOP_TLV_MASTERKEY`	TLV de clave maestra de red meshcop
`OT_MESHCOP_TLV_MESHLOCALPREFIX`	TLV de prefijo local de malla meshcop
`OT_MESHCOP_TLV_NETWORKNAME`	meshcop Nombre de red TLV
`OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE`	TLV de secuencia de claves de red meshcop
`OT_MESHCOP_TLV_PANID`	meshcop Pan Id TLV
`OT_MESHCOP_TLV_PENDINGTIMESTAMP`	TLV de marca de tiempo pendiente de meshcop
`OT_MESHCOP_TLV_PERIOD`	TLV del período meshcop
`OT_MESHCOP_TLV_PROVISIONING_URL`	TLV de URL de aprovisionamiento meshcop
`OT_MESHCOP_TLV_PSKC`	meshcop PSKc TLV
`OT_MESHCOP_TLV_SCAN_DURATION`	TLV de duración de escaneo de meshcop
`OT_MESHCOP_TLV_SECURITYPOLICY`	TLV de la política de seguridad de meshcop
`OT_MESHCOP_TLV_STATE`	TLV del estado de meshcop
`OT_MESHCOP_TLV_STEERING_DATA`	TLV de datos de dirección meshcop
`OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV`	TLV de encapsulación UDP meshcop
`OT_MESHCOP_TLV_VENDOR_DATA_TLV`	TLV de datos de proveedor de meshcop
`OT_MESHCOP_TLV_VENDOR_MODEL_TLV`	Modelo TLV de proveedor meshcop
`OT_MESHCOP_TLV_VENDOR_NAME_TLV`	Nombre del proveedor meshcop TLV
`OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV`	TLV de la pila de proveedores de meshcop
`OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV`	meshcop Proveedor SW Versión TLV

otRoutePreference

 otRoutePreference

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

Propiedades
`OT_ROUTE_PREFERENCE_HIGH`	Preferencia de ruta alta.
`OT_ROUTE_PREFERENCE_LOW`	Preferencia de ruta baja.
`OT_ROUTE_PREFERENCE_MED`	Preferencia de ruta media.

Typedefs

otBorderRouterConfig

struct otBorderRouterConfig otBorderRouterConfig

Esta estructura representa una configuración de Border Router.

otChannelMask

uint32_t otChannelMask

Este tipo representa la máscara de canal.

otExtendedPanId

struct otExtendedPanId otExtendedPanId

Esta estructura representa un ID PAN extendido.

otExternalRouteConfig

struct otExternalRouteConfig otExternalRouteConfig

Esta estructura representa una configuración de ruta externa.

otIpCounters

struct otIpCounters otIpCounters

Esta estructura representa los contadores de nivel de IP.

otLeaderData

struct otLeaderData otLeaderData

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

otLinkModeConfig

struct otLinkModeConfig otLinkModeConfig

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

otMasterKey

struct otMasterKey otMasterKey

Esta estructura representa una clave maestra de subprocesos.

otMeshLocalPrefix

otIp6NetworkPrefix otMeshLocalPrefix

Esta estructura representa un prefijo local de malla.

otMeshcopTlvType

enum otMeshcopTlvType otMeshcopTlvType

Esta enumeración representa los tipos de TLV meshcop.

otMleCounters

struct otMleCounters otMleCounters

Esta estructura representa los contadores de Thread MLE.

otNeighborInfoIterator

int16_t otNeighborInfoIterator

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

otNetworkDataIterator

uint32_t otNetworkDataIterator

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

otNetworkDiagChildEntry

struct otNetworkDiagChildEntry otNetworkDiagChildEntry

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

otNetworkDiagConnectivity

struct otNetworkDiagConnectivity otNetworkDiagConnectivity

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

otNetworkDiagIterator

uint16_t otNetworkDiagIterator

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

otNetworkDiagMacCounters

struct otNetworkDiagMacCounters otNetworkDiagMacCounters

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

Consulte RFC 2863 para obtener definiciones de campos de miembros.

otNetworkDiagRoute

struct otNetworkDiagRoute otNetworkDiagRoute

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

otNetworkDiagRouteData

struct otNetworkDiagRouteData otNetworkDiagRouteData

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

otNetworkDiagTlv

struct otNetworkDiagTlv otNetworkDiagTlv

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

otNetworkName

struct otNetworkName otNetworkName

Esta estructura representa un nombre de red.

otOperationalDataset

struct otOperationalDataset otOperationalDataset

Esta estructura representa un conjunto de datos operativo activo o pendiente.

Los componentes del conjunto de datos son opcionales. mComponets estructura mComponets especifica qué componentes están presentes en el conjunto de datos.

otOperationalDatasetComponents

struct otOperationalDatasetComponents otOperationalDatasetComponents

Esta estructura representa la presencia de diferentes componentes en el conjunto de datos operativo activo o pendiente.

otOperationalDatasetTlvs

struct otOperationalDatasetTlvs otOperationalDatasetTlvs

Esta estructura representa un conjunto de datos operativo activo o pendiente.

El conjunto de datos operativos está codificado en TLV según lo especificado por Thread.

otPskc

struct otPskc otPskc

Esta estructura representa un PSKc.

otReceiveDiagnosticGetCallback

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

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

Detalles

Parámetros

`[in] aMessage`	Un puntero al búfer de mensajes que contiene la carga útil de respuesta de obtención de diagnóstico de red recibida.
`[in] aMessageInfo`	Un puntero a la información del mensaje para `aMessage` .
`[in] aContext`	Un puntero al contexto específico de la aplicación.

otRoutePreference

enum otRoutePreference otRoutePreference

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

otSecurityPolicy

struct otSecurityPolicy otSecurityPolicy

Esta estructura representa la Política de seguridad.

otServerConfig

struct otServerConfig otServerConfig

Esta estructura representa una configuración de servidor.

otServiceConfig

struct otServiceConfig otServiceConfig

Esta estructura representa una configuración de servicio.

otThreadDiscoveryRequestCallback

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

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

Detalles

Parámetros

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

otThreadDiscoveryRequestInfo

struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo

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

otThreadParentResponseCallback

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

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

Detalles

Parámetros

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

otThreadParentResponseInfo

struct otThreadParentResponseInfo otThreadParentResponseInfo

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

Variables

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otMasterKey OT_TOOL_PACKED_END

Funciones

otDatasetCreateNewNetwork

otError otDatasetCreateNewNetwork(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Este método crea un nuevo conjunto de datos operativos para usar al formar una nueva red.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[out] aDataset`	El conjunto de datos operativos.

Valores devueltos

`OT_ERROR_NONE`	Se creó con éxito un nuevo conjunto de datos operativos.
`OT_ERROR_FAILED`	No se pudieron generar valores aleatorios para los nuevos parámetros.

otDatasetGeneratePskc

otError otDatasetGeneratePskc(
  const char *aPassPhrase,
  const otNetworkName *aNetworkName,
  const otExtendedPanId *aExtPanId,
  otPskc *aPskc
)

Esta función genera PSKc a partir de una frase de contraseña, un nombre de red y un ID de PAN extendido determinados.

PSKc se utiliza para establecer la Sesión del Comisionado.

Detalles

Parámetros

`[in] aPassPhrase`	La contraseña de puesta en servicio.
`[in] aNetworkName`	El nombre de la red para el cálculo de PSKc.
`[in] aExtPanId`	El ID PAN extendido para el cálculo de PSKc.
`[out] aPskc`	Un puntero a la variable para generar el PSKc generado.

Valores devueltos

`OT_ERROR_NONE`	Genere con éxito PSKc.
`OT_ERROR_INVALID_ARGS`	Si alguno de los argumentos de entrada no es válido.

otDatasetGetActive

otError otDatasetGetActive(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Esta función obtiene el conjunto de datos operativo activo.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[out] aDataset`	Un puntero al lugar donde se colocará el conjunto de datos operativo activo.

Valores devueltos

`OT_ERROR_NONE`	Se recuperó con éxito el conjunto de datos operativo activo.
`OT_ERROR_NOT_FOUND`	No hay valor correspondiente en la tienda de configuración.

otDatasetGetActiveTlvs

otError otDatasetGetActiveTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

Esta función obtiene el conjunto de datos operativo activo.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[out] aDataset`	Un puntero al lugar donde se colocará el conjunto de datos operativo activo.

Valores devueltos

`OT_ERROR_NONE`	Se recuperó con éxito el conjunto de datos operativo activo.
`OT_ERROR_NOT_FOUND`	No hay valor correspondiente en la tienda de configuración.

otDatasetGetDelayTimerMinimal

uint32_t otDatasetGetDelayTimerMinimal(
  otInstance *aInstance
)

Obtenga un temporizador de retardo mínimo.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Valores devueltos

the

valor del temporizador de retardo mínimo (en ms).

otDatasetGetPending

otError otDatasetGetPending(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Esta función obtiene el conjunto de datos operativo pendiente.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[out] aDataset`	Un puntero al lugar donde se colocará el conjunto de datos operativo pendiente.

Valores devueltos

`OT_ERROR_NONE`	Se recuperó con éxito el conjunto de datos operativos pendiente.
`OT_ERROR_NOT_FOUND`	No hay valor correspondiente en la tienda de configuración.

otDatasetGetPendingTlvs

otError otDatasetGetPendingTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

Esta función obtiene el conjunto de datos operativo pendiente.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[out] aDataset`	Un puntero al lugar donde se colocará el conjunto de datos operativo pendiente.

Valores devueltos

`OT_ERROR_NONE`	Se recuperó con éxito el conjunto de datos operativos pendiente.
`OT_ERROR_NOT_FOUND`	No hay valor correspondiente en la tienda de configuración.

otDatasetIsCommissioned

bool otDatasetIsCommissioned(
  otInstance *aInstance
)

Esta función indica si una red válida está presente en el conjunto de datos operativos activo o no.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

VERDADERO si una red válida está presente en el conjunto de datos operativos activo, FALSO en caso contrario.

otDatasetSendMgmtActiveGet

otError otDatasetSendMgmtActiveGet(
  otInstance *aInstance,
  const otOperationalDatasetComponents *aDatasetComponents,
  const uint8_t *aTlvTypes,
  uint8_t aLength,
  const otIp6Address *aAddress
)

Esta función envía MGMT_ACTIVE_GET.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aDatasetComponents`	Un puntero a una estructura de componentes de conjunto de datos que especifica qué componentes solicitar.
`[in] aTlvTypes`	Un puntero a una matriz que contiene tipos de TLV sin procesar adicionales que se solicitarán.
`[in] aLength`	La longitud de `aTlvTypes` .
`[in] aAddress`	Un puntero al destino IPv6, si es NULL, usará Leader ALOC como predeterminado.

Valores devueltos

`OT_ERROR_NONE`	Envíe correctamente el comando del conjunto de datos meshcop.
`OT_ERROR_NO_BUFS`	Espacio de búfer insuficiente para enviar.

otDatasetSendMgmtActiveSet

otError otDatasetSendMgmtActiveSet(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength
)

Esta función envía MGMT_ACTIVE_SET.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aDataset`	Un puntero al conjunto de datos operativos.
`[in] aTlvs`	Un puntero a los TLV.
`[in] aLength`	La longitud de los TLV.

Valores devueltos

`OT_ERROR_NONE`	Envíe correctamente el comando del conjunto de datos meshcop.
`OT_ERROR_NO_BUFS`	Espacio de búfer insuficiente para enviar.

otDatasetSendMgmtPendingGet

otError otDatasetSendMgmtPendingGet(
  otInstance *aInstance,
  const otOperationalDatasetComponents *aDatasetComponents,
  const uint8_t *aTlvTypes,
  uint8_t aLength,
  const otIp6Address *aAddress
)

Esta función envía MGMT_PENDING_GET.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aDatasetComponents`	Un puntero a una estructura de componentes de conjunto de datos que especifica qué componentes solicitar.
`[in] aTlvTypes`	Un puntero a una matriz que contiene tipos de TLV sin procesar adicionales que se solicitarán
`[in] aLength`	La longitud de `aTlvTypes` .
`[in] aAddress`	Un puntero al destino IPv6, si es NULL, usará Leader ALOC como predeterminado.

Valores devueltos

`OT_ERROR_NONE`	Envíe correctamente el comando del conjunto de datos meshcop.
`OT_ERROR_NO_BUFS`	Espacio de búfer insuficiente para enviar.

otDatasetSendMgmtPendingSet

otError otDatasetSendMgmtPendingSet(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength
)

Esta función envía MGMT_PENDING_SET.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aDataset`	Un puntero al conjunto de datos operativos.
`[in] aTlvs`	Un puntero a los TLV.
`[in] aLength`	La longitud de los TLV.

Valores devueltos

`OT_ERROR_NONE`	Envíe correctamente el comando del conjunto de datos meshcop.
`OT_ERROR_NO_BUFS`	Espacio de búfer insuficiente para enviar.

otDatasetSetActive

otError otDatasetSetActive(
  otInstance *aInstance,
  const otOperationalDataset *aDataset
)

Esta función establece el conjunto de datos operativo activo.

Si el conjunto de datos no incluye una marca de tiempo activa, el conjunto de datos está solo parcialmente completo.

Si Thread está habilitado en un dispositivo que tiene un conjunto de datos activo parcialmente completo, el dispositivo intentará conectarse a una red de Thread existente utilizando cualquier información existente en el conjunto de datos. Solo se necesita la clave maestra de subprocesos para conectarse a una red.

Si el canal no está incluido en el conjunto de datos, el dispositivo enviará mensajes de anuncio MLE a través de diferentes canales para encontrar vecinos en otros canales.

Si el dispositivo se conecta correctamente a una red de subprocesos, el dispositivo recuperará el conjunto de datos activo completo de su padre. Tenga en cuenta que un dispositivo con capacidad de enrutador no pasará a las funciones de enrutador o líder hasta que tenga un conjunto de datos activo completo.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aDataset`	Un puntero al conjunto de datos operativo activo.

Valores devueltos

`OT_ERROR_NONE`	Establezca correctamente el conjunto de datos operativo activo.
`OT_ERROR_NO_BUFS`	Espacio de búfer insuficiente para configurar el conjunto de datos operativo activo.
`OT_ERROR_NOT_IMPLEMENTED`	La plataforma no implementa la funcionalidad de configuración.

otDatasetSetActiveTlvs

otError otDatasetSetActiveTlvs(
  otInstance *aInstance,
  const otOperationalDatasetTlvs *aDataset
)

Esta función establece el conjunto de datos operativo activo.

Si el conjunto de datos no incluye una marca de tiempo activa, el conjunto de datos está solo parcialmente completo.

Si el canal no está incluido en el conjunto de datos, el dispositivo enviará mensajes de anuncio MLE a través de diferentes canales para encontrar vecinos en otros canales.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aDataset`	Un puntero al conjunto de datos operativo activo.

Valores devueltos

`OT_ERROR_NONE`	Establezca correctamente el conjunto de datos operativo activo.
`OT_ERROR_NO_BUFS`	Espacio de búfer insuficiente para configurar el conjunto de datos operativo activo.
`OT_ERROR_NOT_IMPLEMENTED`	La plataforma no implementa la funcionalidad de configuración.

otDatasetSetDelayTimerMinimal

otError otDatasetSetDelayTimerMinimal(
  otInstance *aInstance,
  uint32_t aDelayTimerMinimal
)

Configure el temporizador de retardo mínimo.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aDelayTimerMinimal`	El valor del temporizador de retardo mínimo (en ms).

Valores devueltos

`OT_ERROR_NONE`	Configurar correctamente el temporizador de retardo mínimo.
`OT_ERROR_INVALID_ARGS`	Si `aDelayTimerMinimal` no es válido.

otDatasetSetPending

otError otDatasetSetPending(
  otInstance *aInstance,
  const otOperationalDataset *aDataset
)

Esta función establece el conjunto de datos operativos pendientes.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aDataset`	Un puntero al conjunto de datos operativo pendiente.

Valores devueltos

`OT_ERROR_NONE`	Establecer correctamente el conjunto de datos operativos pendiente.
`OT_ERROR_NO_BUFS`	Espacio de búfer insuficiente para establecer el conjunto de datos operativo pendiente.
`OT_ERROR_NOT_IMPLEMENTED`	La plataforma no implementa la funcionalidad de configuración.

otDatasetSetPendingTlvs

otError otDatasetSetPendingTlvs(
  otInstance *aInstance,
  const otOperationalDatasetTlvs *aDataset
)

Esta función establece el conjunto de datos operativos pendientes.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aDataset`	Un puntero al conjunto de datos operativo pendiente.

Valores devueltos

`OT_ERROR_NONE`	Establecer correctamente el conjunto de datos operativos pendiente.
`OT_ERROR_NO_BUFS`	Espacio de búfer insuficiente para establecer el conjunto de datos operativo pendiente.
`OT_ERROR_NOT_IMPLEMENTED`	La plataforma no implementa la funcionalidad de configuración.

otNetDataGet

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

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

Detalles

Parámetros

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

otNetDataGetNextOnMeshPrefix

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

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

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in,out] aIterator`	Un puntero al contexto del iterador de datos de red. Para obtener la primera entrada en malla, debe establecerse en OT_NETWORK_DATA_ITERATOR_INIT.
`[out] aConfig`	Un puntero al lugar donde se colocará la información del prefijo On Mesh.

Valores devueltos

`OT_ERROR_NONE`	Encontré con éxito el siguiente prefijo de On Mesh.
`OT_ERROR_NOT_FOUND`	No existe ningún prefijo On Mesh subsiguiente en los datos de la red de subprocesos.

otNetDataGetNextRoute

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

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

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in,out] aIterator`	Un puntero al contexto del iterador de datos de red. Para obtener la primera entrada de ruta externa, debe establecerse en OT_NETWORK_DATA_ITERATOR_INIT.
`[out] aConfig`	Un puntero al lugar donde se colocará la información de la ruta externa.

Valores devueltos

`OT_ERROR_NONE`	Encontré con éxito la siguiente ruta externa.
`OT_ERROR_NOT_FOUND`	No existe ninguna entrada de ruta externa posterior en los datos de la red de subprocesos.

otNetDataGetNextService

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

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

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in,out] aIterator`	Un puntero al contexto del iterador de datos de red. Para obtener la primera entrada de servicio, debe establecerse en OT_NETWORK_DATA_ITERATOR_INIT.
`[out] aConfig`	Un puntero al lugar donde se colocará la información del servicio.

Valores devueltos

`OT_ERROR_NONE`	Encontré con éxito el siguiente servicio.
`OT_ERROR_NOT_FOUND`	No existe ningún servicio posterior en los datos de red de la partición.

otNetDataGetStableVersion

uint8_t otNetDataGetStableVersion(
  otInstance *aInstance
)

Obtenga la versión de datos de red estable.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

La versión de datos de red estable.

otNetDataGetVersion

uint8_t otNetDataGetVersion(
  otInstance *aInstance
)

Obtenga la versión de datos de red.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

La versión de datos de red.

otNetDataSteeringDataCheckJoiner

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

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

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aEui64`	Un puntero al IEEE EUI-64 de Joiner.

Valores devueltos

`OT_ERROR_NONE`	`aEui64` está incluido en los datos de dirección.
`OT_ERROR_INVALID_STATE`	No hay datos de dirección presentes.
`OT_ERROR_NOT_FOUND`	`aEui64` no está incluido en los datos de dirección.

otNetDataSteeringDataCheckJoinerWithDiscerner

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

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

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aDiscerner`	Un puntero para el Joiner Discerner.

Valores devueltos

`OT_ERROR_NONE`	`aDiscerner` está incluido en los datos de dirección.
`OT_ERROR_INVALID_STATE`	No hay datos de dirección presentes.
`OT_ERROR_NOT_FOUND`	`aDiscerner` no está incluido en los datos de dirección.

otThreadBecomeChild

otError otThreadBecomeChild(
  otInstance *aInstance
)

Intenta volver a unirte como un niño.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Valores devueltos

`OT_ERROR_NONE`	Comience con éxito el intento de convertirse en un niño.
`OT_ERROR_INVALID_STATE`	El hilo está deshabilitado.

otThreadBecomeDetached

otError otThreadBecomeDetached(
  otInstance *aInstance
)

Desconectarse de la red Thread.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Valores devueltos

`OT_ERROR_NONE`	Se separó con éxito de la red Thread.
`OT_ERROR_INVALID_STATE`	El hilo está deshabilitado.

otThreadDiscover

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

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

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aScanChannels`	Un vector de bits que indica qué canales escanear (por ejemplo, OT_CHANNEL_11_MASK).
`[in] aPanId`	El filtro PAN ID (configurado en Broadcast PAN para deshabilitar el filtro).
`[in] aJoiner`	Valor del indicador de incorporación en el TLV de solicitud de descubrimiento.
`[in] aEnableEui64Filtering`	TRUE para filtrar respuestas en EUI-64, FALSE en caso contrario.
`[in] aCallback`	Un puntero a una función llamada al recibir una respuesta de descubrimiento de MLE o se completa el escaneo.
`[in] aCallbackContext`	Un puntero al contexto específico de la aplicación.

Valores devueltos

`OT_ERROR_NONE`	Se aceptó la solicitud de Thread Discovery.
`OT_ERROR_BUSY`	Ya estoy realizando un Thread Discovery.

otThreadGetChildTimeout

uint32_t otThreadGetChildTimeout(
  otInstance *aInstance
)

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

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

El valor de Thread Child Timeout en segundos.

Ver también:
otThreadSetChildTimeout

otThreadGetDeviceRole

otDeviceRole otThreadGetDeviceRole(
  otInstance *aInstance
)

Obtén el rol del dispositivo.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Valores devueltos

`OT_DEVICE_ROLE_DISABLED`	La pila de subprocesos está deshabilitada.
`OT_DEVICE_ROLE_DETACHED`	El dispositivo no participa actualmente en una red / partición de subprocesos.
`OT_DEVICE_ROLE_CHILD`	El dispositivo funciona actualmente como Thread Child.
`OT_DEVICE_ROLE_ROUTER`	El dispositivo está funcionando actualmente como un enrutador de subprocesos.
`OT_DEVICE_ROLE_LEADER`	El dispositivo funciona actualmente como líder de subprocesos.

otThreadGetDomainName

const char * otThreadGetDomainName(
  otInstance *aInstance
)

Obtenga el nombre de dominio del hilo.

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

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

Un puntero al nombre de dominio del subproceso.

Ver también:
otThreadSetDomainName

otThreadGetExtendedPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

Obtenga el ID de PAN extendido IEEE 802.15.4.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

Un puntero al IEEE 802.15.4 Extended PAN ID.

Ver también:
otThreadSetExtendedPanId

otThreadGetFixedDuaInterfaceIdentifier

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
  otInstance *aInstance
)

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

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

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

Un puntero al identificador de interfaz que se estableció manualmente, o NULL si no se estableció ninguno.

Ver también:
otThreadSetFixedDuaInterfaceIdentifier

otThreadGetIp6Counters

const otIpCounters * otThreadGetIp6Counters(
  otInstance *aInstance
)

Obtenga los contadores de IPv6.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

Un puntero a los contadores de IPv6.

otThreadGetKeySequenceCounter

uint32_t otThreadGetKeySequenceCounter(
  otInstance *aInstance
)

Obtenga thrKeySequenceCounter.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

El valor de thrKeySequenceCounter.

Ver también:
otThreadSetKeySequenceCounter

otThreadGetKeySwitchGuardTime

uint32_t otThreadGetKeySwitchGuardTime(
  otInstance *aInstance
)

Obtenga thrKeySwitchGuardTime.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

El valor de thrKeySwitchGuardTime (en horas).

Ver también:
otThreadSetKeySwitchGuardTime

otThreadGetLeaderData

otError otThreadGetLeaderData(
  otInstance *aInstance,
  otLeaderData *aLeaderData
)

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

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[out] aLeaderData`	Un puntero al lugar donde se colocan los datos del líder.

Valores devueltos

`OT_ERROR_NONE`	Recuperado con éxito los datos del líder.
`OT_ERROR_DETACHED`	Actualmente no adjunto.

otThreadGetLeaderRloc

otError otThreadGetLeaderRloc(
  otInstance *aInstance,
  otIp6Address *aLeaderRloc
)

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

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[out] aLeaderRloc`	Un puntero al RLOC del líder.

Valores devueltos

`OT_ERROR_NONE`	El RLOC del líder se escribió correctamente en `aLeaderRloc` .
`OT_ERROR_INVALID_ARGS`	`aLeaderRloc` era NULL.
`OT_ERROR_DETACHED`	No adjunto actualmente a una partición de subproceso.

otThreadGetLeaderRouterId

uint8_t otThreadGetLeaderRouterId(
  otInstance *aInstance
)

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

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

ID de enrutador del líder.

otThreadGetLeaderWeight

uint8_t otThreadGetLeaderWeight(
  otInstance *aInstance
)

Obtenga el peso del líder.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

El peso del líder.

otThreadGetLinkLocalIp6Address

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

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

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

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

Un puntero a la dirección IPv6 local de enlace de subproceso.

otThreadGetLinkMode

otLinkModeConfig otThreadGetLinkMode(
  otInstance *aInstance
)

Obtenga la configuración del modo de enlace MLE.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

La configuración del modo de enlace MLE.

Ver también:
otThreadSetLinkMode

otThreadGetMasterKey

const otMasterKey * otThreadGetMasterKey(
  otInstance *aInstance
)

Obtenga thrMasterKey.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

Un puntero a un búfer que contiene thrMasterKey.

Ver también:
otThreadSetMasterKey

otThreadGetMeshLocalEid

const otIp6Address * otThreadGetMeshLocalEid(
  otInstance *aInstance
)

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

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

Un puntero a la dirección EID local de malla.

otThreadGetMeshLocalPrefix

const otMeshLocalPrefix * otThreadGetMeshLocalPrefix(
  otInstance *aInstance
)

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

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

Un puntero al prefijo local de malla.

otThreadGetMleCounters

const otMleCounters * otThreadGetMleCounters(
  otInstance *aInstance
)

Obtenga los contadores de Thread MLE.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

Un puntero a los contadores de Thread MLE.

otThreadGetNetworkName

const char * otThreadGetNetworkName(
  otInstance *aInstance
)

Obtenga el nombre de la red de subprocesos.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

Un puntero al nombre de la red de subprocesos.

Ver también:
otThreadSetNetworkName

otThreadGetNextDiagnosticTlv

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

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

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

Detalles

Parámetros

`[in] aMessage`	Un puntero a un mensaje.
`[in,out] aIterator`	Un puntero al contexto del iterador de diagnóstico de red. Para obtener el primer TLV de diagnóstico de red, debe establecerse en OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT.
`[out] aNetworkDiagTlv`	Un puntero al lugar donde se colocará la información del TLV de diagnóstico de red.

Valores devueltos

`OT_ERROR_NONE`	Encontré con éxito el próximo TLV de diagnóstico de red.
`OT_ERROR_NOT_FOUND`	No existe ningún TLV de diagnóstico de red posterior en el mensaje.
`OT_ERROR_PARSE`	Error al analizar el siguiente diagnóstico de red.

otThreadGetNextNeighborInfo

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

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

Se utiliza para revisar las entradas de la tabla vecina.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in,out] aIterator`	Un puntero al contexto del iterador. Para obtener la primera entrada de vecino, debe establecerse en OT_NEIGHBOR_INFO_ITERATOR_INIT.
`[out] aInfo`	Un puntero a la información del vecino.

Valores devueltos

`OT_ERROR_NONE`	Se encontró con éxito la siguiente entrada de vecino en la tabla.
`OT_ERROR_NOT_FOUND`	No existe ninguna entrada de vecino posterior en la tabla.
`OT_ERROR_INVALID_ARGS`	`aIterator` o `aInfo` era NULL.

otThreadGetParentAverageRssi

otError otThreadGetParentAverageRssi(
  otInstance *aInstance,
  int8_t *aParentRssi
)

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

Detalles

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[out] aParentRssi`	A pointer to where the parent RSSI should be placed.

otThreadGetParentInfo

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

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

Details

Parameters

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

otThreadGetParentLastRssi

otError otThreadGetParentLastRssi(
  otInstance *aInstance,
  int8_t *aLastRssi
)

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

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[out] aLastRssi`	A pointer to where the last RSSI should be placed.

Return Values

`OT_ERROR_NONE`	Successfully retrieved the RSSI data.
`OT_ERROR_FAILED`	Unable to get RSSI data.
`OT_ERROR_INVALID_ARGS`	`aLastRssi` is NULL.

otThreadGetPartitionId

uint32_t otThreadGetPartitionId(
  otInstance *aInstance
)

Get the Partition ID.

Details

Parameters

[in] aInstance

A pointer to an OpenThread instance.

Returns

The Partition ID.

otThreadGetRloc

const otIp6Address * otThreadGetRloc(
  otInstance *aInstance
)

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

Details

Parameters

[in] aInstance

A pointer to an OpenThread instance.

Returns

A pointer to the Thread Routing Locator (RLOC) address.

otThreadGetRloc16

uint16_t otThreadGetRloc16(
  otInstance *aInstance
)

Get the RLOC16.

Details

Parameters

[in] aInstance

A pointer to an OpenThread instance.

Returns

The RLOC16.

otThreadGetVersion

uint16_t otThreadGetVersion(
  void
)

This function gets the Thread protocol version.

Details
Returns	the Thread protocol version.

otThreadIsDiscoverInProgress

bool otThreadIsDiscoverInProgress(
  otInstance *aInstance
)

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

Details

Parameters

[in] aInstance

A pointer to an OpenThread instance.

otThreadIsSingleton

bool otThreadIsSingleton(
  otInstance *aInstance
)

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

Details

Parameters

[in] aInstance

A pointer to an OpenThread instance.

Return Values

`TRUE`	It is the only router in the network.
`FALSE`	It is a child or is not a single router in the network.

otThreadRegisterParentResponseCallback

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

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

Details

Parameters

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

otThreadResetIp6Counters

void otThreadResetIp6Counters(
  otInstance *aInstance
)

Reset the IPv6 counters.

Details

Parameters

[in] aInstance

A pointer to an OpenThread instance.

otThreadResetMleCounters

void otThreadResetMleCounters(
  otInstance *aInstance
)

Reset the Thread MLE counters.

Details

Parameters

[in] aInstance

A pointer to an OpenThread instance.

otThreadSendDiagnosticGet

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

Send a Network Diagnostic Get request.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aDestination`	A pointer to destination address.
`[in] aTlvTypes`	An array of Network Diagnostic TLV types.
`[in] aCount`	Number of types in aTlvTypes.

Return Values

`OT_ERROR_NONE`	Successfully queued the DIAG_GET.req.
`OT_ERROR_NO_BUFS`	Insufficient message buffers available to send DIAG_GET.req.

otThreadSendDiagnosticReset

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

Send a Network Diagnostic Reset request.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aDestination`	A pointer to destination address.
`[in] aTlvTypes`	An array of Network Diagnostic TLV types. Currently only Type 9 is allowed.
`[in] aCount`	Number of types in aTlvTypes

Return Values

`OT_ERROR_NONE`	Successfully queued the DIAG_RST.ntf.
`OT_ERROR_NO_BUFS`	Insufficient message buffers available to send DIAG_RST.ntf.

otThreadSetChildTimeout

void otThreadSetChildTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

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

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aTimeout`	The timeout value in seconds.

See also:
otThreadGetChildTimeout

otThreadSetDiscoveryRequestCallback

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

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

Details

Parameters

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

otThreadSetDomainName

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

Set the Thread Domain Name.

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

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aDomainName`	A pointer to the Thread Domain Name.

Return Values

`OT_ERROR_NONE`	Successfully set the Thread Domain Name.
`OT_ERROR_INVALID_STATE`	Thread protocols are enabled.

See also:
otThreadGetDomainName

otThreadSetEnabled

otError otThreadSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

This function starts Thread protocol operation.

The interface must be up when calling this function.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aEnabled`	TRUE if Thread is enabled, FALSE otherwise.

Return Values

`OT_ERROR_NONE`	Successfully started Thread protocol operation.
`OT_ERROR_INVALID_STATE`	The network interface was not not up.

otThreadSetExtendedPanId

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

Set the IEEE 802.15.4 Extended PAN ID.

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

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aExtendedPanId`	A pointer to the IEEE 802.15.4 Extended PAN ID.

Return Values

`OT_ERROR_NONE`	Successfully set the Extended PAN ID.
`OT_ERROR_INVALID_STATE`	Thread protocols are enabled.

See also:
otThreadGetExtendedPanId

otThreadSetFixedDuaInterfaceIdentifier

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

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

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

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aIid`	A pointer to the Interface Identifier to set or NULL to clear.

Return Values

`OT_ERROR_NONE`	Successfully set/cleared the Interface Identifier.
`OT_ERROR_INVALID_ARGS`	The specified Interface Identifier is reserved.

See also:
otThreadGetFixedDuaInterfaceIdentifier

otThreadSetJoinerAdvertisement

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

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

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

Details

Parameters

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

Return Values

`OT_ERROR_NONE`	Successfully set Joiner Advertisement.
`OT_ERROR_INVALID_ARGS`	Invalid AdvData.

otThreadSetKeySequenceCounter

void otThreadSetKeySequenceCounter(
  otInstance *aInstance,
  uint32_t aKeySequenceCounter
)

Set the thrKeySequenceCounter.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aKeySequenceCounter`	The thrKeySequenceCounter value.

See also:
otThreadGetKeySequenceCounter

otThreadSetKeySwitchGuardTime

void otThreadSetKeySwitchGuardTime(
  otInstance *aInstance,
  uint32_t aKeySwitchGuardTime
)

Set the thrKeySwitchGuardTime.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aKeySwitchGuardTime`	The thrKeySwitchGuardTime value (in hours).

See also:
otThreadGetKeySwitchGuardTime

otThreadSetLinkMode

otError otThreadSetLinkMode(
  otInstance *aInstance,
  otLinkModeConfig aConfig
)

Set the MLE Link Mode configuration.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aConfig`	A pointer to the Link Mode configuration.

Return Values

OT_ERROR_NONE

Successfully set the MLE Link Mode configuration.

See also:
otThreadGetLinkMode

otThreadSetMasterKey

otError otThreadSetMasterKey(
  otInstance *aInstance,
  const otMasterKey *aKey
)

Set the thrMasterKey.

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

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aKey`	A pointer to a buffer containing the thrMasterKey.

Return Values

`OT_ERROR_NONE`	Successfully set the thrMasterKey.
`OT_ERROR_INVALID_ARGS`	If aKeyLength is larger than 16.
`OT_ERROR_INVALID_STATE`	Thread protocols are enabled.

See also:
otThreadGetMasterKey

otThreadSetMeshLocalPrefix

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

This function sets the Mesh Local Prefix.

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

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aMeshLocalPrefix`	A pointer to the Mesh Local Prefix.

Return Values

`OT_ERROR_NONE`	Successfully set the Mesh Local Prefix.
`OT_ERROR_INVALID_STATE`	Thread protocols are enabled.

otThreadSetNetworkName

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

Set the Thread Network Name.

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

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aNetworkName`	A pointer to the Thread Network Name.

Return Values

`OT_ERROR_NONE`	Successfully set the Thread Network Name.
`OT_ERROR_INVALID_STATE`	Thread protocols are enabled.

See also:
otThreadGetNetworkName

otThreadSetReceiveDiagnosticGetCallback

void otThreadSetReceiveDiagnosticGetCallback(
  otInstance *aInstance,
  otReceiveDiagnosticGetCallback aCallback,
  void *aCallbackContext
)

This function registers a callback to provide received raw Network Diagnostic Get response payload.

Details

Parameters

`[in] aInstance`	A pointer to an OpenThread instance.
`[in] aCallback`	A pointer to a function that is called when Network Diagnostic Get response is received or NULL to disable the callback.
`[in] aCallbackContext`	A pointer to application-specific context.

Macros

OT_CHANNEL_10_MASK

 OT_CHANNEL_10_MASK (1 << 10)

Channel 10.

OT_CHANNEL_11_MASK

 OT_CHANNEL_11_MASK (1 << 11)

Channel 11.

OT_CHANNEL_12_MASK

 OT_CHANNEL_12_MASK (1 << 12)

Channel 12.

OT_CHANNEL_13_MASK

 OT_CHANNEL_13_MASK (1 << 13)

Channel 13.

OT_CHANNEL_14_MASK

 OT_CHANNEL_14_MASK (1 << 14)

Channel 14.

OT_CHANNEL_15_MASK

 OT_CHANNEL_15_MASK (1 << 15)

Channel 15.

OT_CHANNEL_16_MASK

 OT_CHANNEL_16_MASK (1 << 16)

Channel 16.

OT_CHANNEL_17_MASK

 OT_CHANNEL_17_MASK (1 << 17)

Channel 17.

OT_CHANNEL_18_MASK

 OT_CHANNEL_18_MASK (1 << 18)

Channel 18.

OT_CHANNEL_19_MASK

 OT_CHANNEL_19_MASK (1 << 19)

Channel 19.

OT_CHANNEL_1_MASK

 OT_CHANNEL_1_MASK (1 << 1)

Channel 1.

OT_CHANNEL_20_MASK

 OT_CHANNEL_20_MASK (1 << 20)

Channel 20.

OT_CHANNEL_21_MASK

 OT_CHANNEL_21_MASK (1 << 21)

Channel 21.

OT_CHANNEL_22_MASK

 OT_CHANNEL_22_MASK (1 << 22)

Channel 22.

OT_CHANNEL_23_MASK

 OT_CHANNEL_23_MASK (1 << 23)

Channel 23.

OT_CHANNEL_24_MASK

 OT_CHANNEL_24_MASK (1 << 24)

Channel 24.

OT_CHANNEL_25_MASK

 OT_CHANNEL_25_MASK (1 << 25)

Channel 25.

OT_CHANNEL_26_MASK

 OT_CHANNEL_26_MASK (1 << 26)

Channel 26.

OT_CHANNEL_2_MASK

 OT_CHANNEL_2_MASK (1 << 2)

Channel 2.

OT_CHANNEL_3_MASK

 OT_CHANNEL_3_MASK (1 << 3)

Channel 3.

OT_CHANNEL_4_MASK

 OT_CHANNEL_4_MASK (1 << 4)

Channel 4.

OT_CHANNEL_5_MASK

 OT_CHANNEL_5_MASK (1 << 5)

Channel 5.

OT_CHANNEL_6_MASK

 OT_CHANNEL_6_MASK (1 << 6)

Channel 6.

OT_CHANNEL_7_MASK

 OT_CHANNEL_7_MASK (1 << 7)

Channel 7.

OT_CHANNEL_8_MASK

 OT_CHANNEL_8_MASK (1 << 8)

Channel 8.

OT_CHANNEL_9_MASK

 OT_CHANNEL_9_MASK (1 << 9)

Channel 9.

OT_EXT_PAN_ID_SIZE

 OT_EXT_PAN_ID_SIZE 8

Size of a Thread PAN ID (bytes)

OT_JOINER_ADVDATA_MAX_LENGTH

 OT_JOINER_ADVDATA_MAX_LENGTH 64

Maximum AdvData Length of Joiner Advertisement.

OT_MASTER_KEY_SIZE

 OT_MASTER_KEY_SIZE 16

Size of the Thread Master Key (bytes)

OT_MESH_LOCAL_PREFIX_SIZE

 OT_MESH_LOCAL_PREFIX_SIZE OT_IP6_PREFIX_SIZE

Size of the Mesh Local Prefix (bytes)

OT_NEIGHBOR_INFO_ITERATOR_INIT

 OT_NEIGHBOR_INFO_ITERATOR_INIT 0

Initializer for otNeighborInfoIterator.

OT_NETWORK_BASE_TLV_MAX_LENGTH

 OT_NETWORK_BASE_TLV_MAX_LENGTH 254

Maximum value length of Thread Base TLV.

OT_NETWORK_DATA_ITERATOR_INIT

 OT_NETWORK_DATA_ITERATOR_INIT 0

Initializer for otNetworkDataIterator.

OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE

 OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE 3

Size of Network Diagnostic Child Table entry.

OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT

 OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT 0

Initializer for otNetworkDiagIterator.

OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES

 OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19

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

OT_NETWORK_MAX_ROUTER_ID

 OT_NETWORK_MAX_ROUTER_ID 62

Maximum Router ID.

OT_NETWORK_NAME_MAX_SIZE

 OT_NETWORK_NAME_MAX_SIZE 16

Maximum size of the Thread Network Name field (bytes)

OT_OPERATIONAL_DATASET_MAX_LENGTH

 OT_OPERATIONAL_DATASET_MAX_LENGTH 254

Maximum length of Operational Dataset in bytes.

OT_PSKC_MAX_SIZE

 OT_PSKC_MAX_SIZE 16

Maximum size of the PSKc (bytes)

OT_SERVER_DATA_MAX_SIZE

 OT_SERVER_DATA_MAX_SIZE 248

Maximum size of Server Data in bytes. This is theoretical limit, practical one is much lower.

OT_SERVICE_DATA_MAX_SIZE

 OT_SERVICE_DATA_MAX_SIZE 252

Maximum size of Service Data in bytes.

General

Resumen

Enumeraciones

Typedefs

Variables

Funciones

Estructuras

Enumeraciones

enumeración anónima

enumeración anónima

otDeviceRole

otMeshcopTlvType

otRoutePreference

Typedefs

otBorderRouterConfig

otChannelMask

otExtendedPanId

otExternalRouteConfig

otIpCounters

otLeaderData

otLinkModeConfig

otMasterKey

otMeshLocalPrefix

otMeshcopTlvType

otMleCounters

otNeighborInfoIterator

otNetworkDataIterator

otNetworkDiagChildEntry

otNetworkDiagConnectivity

otNetworkDiagIterator

otNetworkDiagMacCounters

otNetworkDiagRoute

otNetworkDiagRouteData

otNetworkDiagTlv

otNetworkName

otOperationalDataset

otOperationalDatasetComponents

otOperationalDatasetTlvs

otPskc

otReceiveDiagnosticGetCallback

otRoutePreference

otSecurityPolicy

otServerConfig

otServiceConfig

otThreadDiscoveryRequestCallback

otThreadDiscoveryRequestInfo

otThreadParentResponseCallback

otThreadParentResponseInfo

Variables

OT_TOOL_PACKED_END

Funciones

otDatasetCreateNewNetwork

otDatasetGeneratePskc

otDatasetGetActive

otDatasetGetActiveTlvs

otDatasetGetDelayTimerMinimal

otDatasetGetPending

otDatasetGetPendingTlvs

otDatasetIsCommissioned

otDatasetSendMgmtActiveGet

otDatasetSendMgmtActiveSet

otDatasetSendMgmtPendingGet

otDatasetSendMgmtPendingSet

otDatasetSetActive

otDatasetSetActiveTlvs

otDatasetSetDelayTimerMinimal

otDatasetSetPending

otDatasetSetPendingTlvs

otNetDataGet

otNetDataGetNextOnMeshPrefix

otNetDataGetNextRoute

otNetDataGetNextService

otNetDataGetStableVersion

otNetDataGetVersion

otNetDataSteeringDataCheckJoiner

otNetDataSteeringDataCheckJoinerWithDiscerner

otThreadBecomeChild

otThreadBecomeDetached

otThreadDiscover

otThreadGetChildTimeout