Google se compromete a impulsar la igualdad racial para las comunidades afrodescendientes. Obtén información al respecto.

Conjunto de datos operativo

Este módulo incluye funciones para el actualizador de conjuntos de datos.

Resumen

Las funciones de este módulo están disponibles cuando la función Actualizador del conjunto de datos está habilitada (es decir, OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE está configurado en 1). Además, esta función solo está disponible en una compilación de FTD.

Enumeraciones

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_NETWORKKEY = 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
}
enum
Esta enumeración representa los tipos de TLV de Meshcop.

Typedefs

otChannelMask typedef
uint32_t
Este tipo representa la máscara del canal.
otDatasetMgmtSetCallback)(otError aResult, void *aContext) typedef
void(*
Se llama a este puntero de función cuando se recibe una respuesta a una solicitud de MGMT_SET o se agota el tiempo de espera.
otDatasetUpdaterCallback)(otError aError, void *aContext) typedef
void(*
Se llama a este puntero de función de devolución de llamada cuando finaliza una solicitud de actualización del conjunto de datos, que informa el estado de ejecución correcta o error de la solicitud de la actualización del conjunto de datos.
otExtendedPanId typedef
Esta estructura representa un ID del PAN extendido.
otMeshLocalPrefix typedef
Esta estructura representa un prefijo local de la malla.
otMeshcopTlvType typedef
Esta enumeración representa los tipos de TLV de Meshcop.
otNetworkKey typedef
struct otNetworkKey
Esta estructura representa una clave de red de subprocesos.
otNetworkKeyRef typedef
Este tipo de datos representa KeyRef a NetworkKey.
otNetworkName typedef
struct otNetworkName
Esta estructura representa un nombre de red.
otOperationalDataset typedef
Esta estructura representa un conjunto de datos operativo activo o pendiente.
otOperationalDatasetComponents typedef
Esta estructura representa la presencia de diferentes componentes en el conjunto de datos operativo activo o pendiente.
otOperationalDatasetTlvs typedef
Esta estructura representa un conjunto de datos operativo activo o pendiente.
otPskc typedef
struct otPskc
Esta estructura representa una PSKc.
otPskcRef typedef
Este tipo de datos representa KeyRef a PSKc.
otSecurityPolicy typedef
Esta estructura representa la política de seguridad.
otTimestamp typedef
struct otTimestamp
Esta estructura representa un componente de marca de tiempo del conjunto de datos de Thread.

Variables

OT_TOOL_PACKED_END

Funciones

otDatasetCreateNewNetwork(otInstance *aInstance, otOperationalDataset *aDataset)
Este método crea un nuevo conjunto de datos operativo que puede usarse cuando se forma una red nueva.
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 PAN extendidos.
otDatasetGetActive(otInstance *aInstance, otOperationalDataset *aDataset)
Esta función obtiene el conjunto de datos operativo activo.
otDatasetGetActiveTlvs(otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
Esta función obtiene el conjunto de datos operativo activo.
otDatasetGetDelayTimerMinimal(otInstance *aInstance)
uint32_t
Obtén un temporizador de retraso mínimo.
otDatasetGetPending(otInstance *aInstance, otOperationalDataset *aDataset)
Esta función obtiene el conjunto de datos operativo pendiente.
otDatasetGetPendingTlvs(otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
Esta función obtiene el conjunto de datos operativo pendiente.
otDatasetIsCommissioned(otInstance *aInstance)
bool
Esta función indica si hay una red válida presente en el conjunto de datos operativo activo o no.
otDatasetParseTlvs(const otOperationalDatasetTlvs *aDatasetTlvs, otOperationalDataset *aDataset)
Esta función analiza un conjunto de datos operativo de un otOperationalDatasetTlvs.
otDatasetSendMgmtActiveGet(otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
Esta función envía MGMT_ACTIVE_GET.
otDatasetSendMgmtActiveSet(otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
Esta función envía MGMT_ACTIVE_SET.
otDatasetSendMgmtPendingGet(otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
Esta función envía MGMT_PENDING_GET.
otDatasetSendMgmtPendingSet(otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
Esta función envía MGMT_PENDING_SET.
otDatasetSetActive(otInstance *aInstance, const otOperationalDataset *aDataset)
Esta función establece el conjunto de datos operativo activo.
otDatasetSetActiveTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
Esta función establece el conjunto de datos operativo activo.
otDatasetSetDelayTimerMinimal(otInstance *aInstance, uint32_t aDelayTimerMinimal)
Establece un temporizador de retraso mínimo.
otDatasetSetPending(otInstance *aInstance, const otOperationalDataset *aDataset)
Esta función establece el conjunto de datos operativo pendiente.
otDatasetSetPendingTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
Esta función establece el conjunto de datos operativo pendiente.
otDatasetUpdaterCancelUpdate(otInstance *aInstance)
void
Esta función cancela una solicitud de actualización operativa del conjunto de datos (si existe).
otDatasetUpdaterIsUpdateOngoing(otInstance *aInstance)
bool
Esta función indica si hay una solicitud de actualización del conjunto de datos de operación en curso.
otDatasetUpdaterRequestUpdate(otInstance *aInstance, const otOperationalDataset *aDataset, otDatasetUpdaterCallback aCallback, void *aContext)
Esta función solicita una actualización del conjunto de datos operativo.
otNetworkNameFromString(otNetworkName *aNetworkName, const char *aNameString)
Esta función establece una instancia otNetworkName a partir de una string C terminada en un valor nulo.

Structs

otExtendedPanId

Esta estructura representa un ID del PAN extendido.

otNetworkKey

Esta estructura representa una clave de red de subprocesos.

NombreDeRedDeOt

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.

otSecurityPolicy

Esta estructura representa la política de seguridad.

otTimestamp

Esta estructura representa un componente de marca de tiempo del conjunto de datos de Thread.

Enumeraciones

otMeshcopTlvType

 otMeshcopTlvType

Esta enumeración representa los tipos de TLV de Meshcop.

Propiedades
OT_MESHCOP_TLV_ACTIVETIMESTAMP

mallacop Active Timestamp TLV

OT_MESHCOP_TLV_BORDER_AGENT_RLOC

mallacop Agent Agent Locator TLV

OT_MESHCOP_TLV_CHANNEL

Meshcop Channel TLV

OT_MESHCOP_TLV_CHANNELMASK

TLV de la máscara de canal de mallacop

OT_MESHCOP_TLV_COMMISSIONER_ID

Meshcop, ID de comisionado de TLV

OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT

Puerto UDP del encargado comisionado de Meshcop

OT_MESHCOP_TLV_COMM_SESSION_ID

ID de sesión del comisionado de mallacop TLV

OT_MESHCOP_TLV_COUNT

Recuento de mallas (TLV)

OT_MESHCOP_TLV_DELAYTIMER

TLV: temporizador de retraso en malla

OT_MESHCOP_TLV_DISCOVERYREQUEST

Meshcop Discovery Request TLV

OT_MESHCOP_TLV_DISCOVERYRESPONSE

TLV de respuesta de Meshcop Discovery

OT_MESHCOP_TLV_ENERGY_LIST

mallacop Energy TLV

OT_MESHCOP_TLV_EXTPANID

ID de panorámica extendido de mallacop TLV

OT_MESHCOP_TLV_GET

MeshCo, obtener TLV

OT_MESHCOP_TLV_IPV6_ADDRESS_TLV

TLV de la dirección IPv6 de MeshCop

OT_MESHCOP_TLV_JOINERADVERTISEMENT

TLV: anuncio de unión de mallacop

OT_MESHCOP_TLV_JOINER_DTLS

TSV de encapsulamiento DTLS de la unión de mallacop

OT_MESHCOP_TLV_JOINER_IID

TLV de unión de mallacop

OT_MESHCOP_TLV_JOINER_RLOC

Localizador de TLV del router de la malla de malla

OT_MESHCOP_TLV_JOINER_ROUTER_KEK

Router Joiner NGINX TLV

OT_MESHCOP_TLV_JOINER_UDP_PORT

Puerto UDP del conector de mallacop UDP

OT_MESHCOP_TLV_MESHLOCALPREFIX

Prefijo de malla local TLV: mallas

OT_MESHCOP_TLV_NETWORKKEY

TLV de la clave de red Meshcop

OT_MESHCOP_TLV_NETWORKNAME

Nombre de red de TLV de mallacop

OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE

TLV de la secuencia de claves de red de Meshcop

OT_MESHCOP_TLV_PANID

mallacop Id TLV

OT_MESHCOP_TLV_PENDINGTIMESTAMP

TLV de marca de tiempo pendiente de mallacop

OT_MESHCOP_TLV_PERIOD

TLV de punto de malla

OT_MESHCOP_TLV_PROVISIONING_URL

TLV de la URL de aprovisionamiento de Meshcop

OT_MESHCOP_TLV_PSKC

mallacop PSKc TLV

OT_MESHCOP_TLV_SCAN_DURATION

TLV de la duración de la malla de malla

OT_MESHCOP_TLV_SECURITYPOLICY

Política de seguridad de mallacop TLV

OT_MESHCOP_TLV_STATE

mallacop State TLV

OT_MESHCOP_TLV_STEERING_DATA

Meshcop, TLV, datos de dirección

OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV

TLV de encapsulamiento UDP de Meshcop

OT_MESHCOP_TLV_VENDOR_DATA_TLV

TLV de datos del proveedor de MeshCop

OT_MESHCOP_TLV_VENDOR_MODEL_TLV

Modelo TLV de la malla de malla

OT_MESHCOP_TLV_VENDOR_NAME_TLV

Nombre del proveedor de MeshCop TLV

OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV

Versión de TLV de la pila de proveedores de Meshcop

OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV

Proveedor de malla de la versión de SW de proveedor TLV

Typedefs

OtChannelMask

uint32_t otChannelMask

Este tipo representa la máscara del canal.

otDatasetMgmtSetCallback

void(* otDatasetMgmtSetCallback)(otError aResult, void *aContext)

Se llama a este puntero de función cuando se recibe una respuesta a una solicitud de MGMT_SET o se agota el tiempo de espera.

Detalles
Parámetros
[in] aResult
Es el resultado de la operación.
[in] aContext
Un puntero para el contexto específico de la aplicación.
Valores que se muestran
OT_ERROR_NONE
El líder aceptó la solicitud.
OT_ERROR_REJECTED
El líder rechazó la solicitud.
OT_ERROR_PARSE
Se produjo un error durante el análisis de la respuesta.
OT_ERROR_ABORT
Un par restableció la solicitud.
OT_ERROR_RESPONSE_TIMEOUT
No se recibió ninguna respuesta ni reconocimiento durante el tiempo de espera.

otDatasetUpdaterCallback

void(* otDatasetUpdaterCallback)(otError aError, void *aContext)

Se llama a este puntero de función de devolución de llamada cuando finaliza una solicitud de actualización del conjunto de datos, que informa el estado de ejecución correcta o error de la solicitud de la actualización del conjunto de datos.

Detalles
Parámetros
[in] aError
El estado del error. OT_ERROR_NONE indica que el conjunto de datos se actualizó correctamente. OT_ERROR_INVALID_STATE indica un error porque el estado no es válido (MLE está inhabilitado). OT_ERROR_ALREADY indica un error porque otro dispositivo dentro de la red solicita una actualización del conjunto de datos en conflicto.
[in] aContext
Un puntero al contexto arbitrario (proporcionado por el usuario en otDatasetUpdaterRequestUpdate()).

ID extendido de otExtended

struct otExtendedPanId otExtendedPanId

Esta estructura representa un ID del PAN extendido.

OtMeshLocalPrefix

otIp6NetworkPrefix otMeshLocalPrefix

Esta estructura representa un prefijo local de la malla.

otMeshcopTlvType

enum otMeshcopTlvType otMeshcopTlvType

Esta enumeración representa los tipos de TLV de Meshcop.

otNetworkKey

struct otNetworkKey otNetworkKey

Esta estructura representa una clave de red de subprocesos.

otNetworkKeyRef

otCryptoKeyRef otNetworkKeyRef

Este tipo de datos representa KeyRef a NetworkKey.

Referencia a clave

otNetworkName

struct otNetworkName otNetworkName

Esta estructura representa un nombre de red.

otNetworkName es una string de C nula (es decir, El array de m8 caracteres DEBE terminar con un carácter nulo \0.

otOperationalDataset

struct otOperationalDataset otOperationalDataset

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

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

oOperationOperationalDatasets

struct otOperationalDatasetComponents otOperationalDatasetComponents

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

oOperationOperationalDatasetTlv

struct otOperationalDatasetTlvs otOperationalDatasetTlvs

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

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

OTSKSP

struct otPskc otPskc

Esta estructura representa una PSKc.

otPskcRef

otCryptoKeyRef otPskcRef

Este tipo de datos representa KeyRef a PSKc.

Referencia a clave

Política de seguridad ot

struct otSecurityPolicy otSecurityPolicy

Esta estructura representa la política de seguridad.

Marca de tiempo de ot

struct otTimestamp otTimestamp

Esta estructura representa un componente de marca de tiempo del conjunto de datos de Thread.

Variables

TS_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otNetworkKey OT_TOOL_PACKED_END

Funciones

otDatasetCreateNewNetwork

otError otDatasetCreateNewNetwork(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Este método crea un nuevo conjunto de datos operativo que puede usarse cuando se forma una red nueva.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aDataset
El conjunto de datos operativo
Valores que se muestran
OT_ERROR_NONE
Se creó correctamente un nuevo conjunto de datos operativo.
OT_ERROR_FAILED
No se pudieron generar valores aleatorios para parámetros nuevos.

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 PAN extendidos.

El PSKc se utiliza para establecer la sesión de comisión.

Detalles
Parámetros
[in] aPassPhrase
La frase de aprobación para la comisión
[in] aNetworkName
El nombre de red para el cálculo de PSKc.
[in] aExtPanId
El ID PAN extendido para el cálculo de PSKc.
[out] aPskc
Un puntero para variable que genera el PSKc generado.
Valores que se muestran
OT_ERROR_NONE
Se generó correctamente el 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 para una instancia de OpenThread.
[out] aDataset
Un puntero sobre dónde se ubicará el conjunto de datos operativo activo.
Valores que se muestran
OT_ERROR_NONE
Se recuperó correctamente el conjunto de datos operativo activo.
OT_ERROR_NOT_FOUND
No hay un 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 para una instancia de OpenThread.
[out] aDataset
Un puntero sobre dónde se ubicará el conjunto de datos operativo activo.
Valores que se muestran
OT_ERROR_NONE
Se recuperó correctamente el conjunto de datos operativo activo.
OT_ERROR_NOT_FOUND
No hay un valor correspondiente en la tienda de configuración.

otDatasetGetDelayTimerMinimum

uint32_t otDatasetGetDelayTimerMinimal(
  otInstance *aInstance
)

Obtén un temporizador de retraso mínimo.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Valores que se muestran
the
valor del temporizador de retraso 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 para una instancia de OpenThread.
[out] aDataset
Un puntero sobre dónde se colocará el conjunto de datos operativo pendiente.
Valores que se muestran
OT_ERROR_NONE
Se recuperó correctamente el conjunto de datos operativo pendiente.
OT_ERROR_NOT_FOUND
No hay un 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 para una instancia de OpenThread.
[out] aDataset
Un puntero sobre dónde se colocará el conjunto de datos operativo pendiente.
Valores que se muestran
OT_ERROR_NONE
Se recuperó correctamente el conjunto de datos operativo pendiente.
OT_ERROR_NOT_FOUND
No hay un valor correspondiente en la tienda de configuración.

otDatasetIsCommissioned

bool otDatasetIsCommissioned(
  otInstance *aInstance
)

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

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
Se le asigna el valor TRUE si hay una red válida presente en el conjunto de datos operativos activos. De lo contrario, aparecerá el valor FALSE.

otDatasetParseTlvs

otError otDatasetParseTlvs(
  const otOperationalDatasetTlvs *aDatasetTlvs,
  otOperationalDataset *aDataset
)

Esta función analiza un conjunto de datos operativo de un otOperationalDatasetTlvs.

Detalles
Parámetros
[in] aDatasetTlvs
Un puntero para los TLV de los conjuntos de datos.
[out] aDataset
Un puntero sobre dónde se colocará el conjunto de datos.
Valores que se muestran
OT_ERROR_NONE
Se configuró correctamente aDataset desde aDatasetTlvs.
OT_ERROR_INVALID_ARGS
aDatasetTlvs no es válido.

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 para una instancia de OpenThread.
[in] aDatasetComponents
Un puntero para una estructura de componentes de conjunto de datos que especifica qué componentes solicitar.
[in] aTlvTypes
Un puntero para un arreglo 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 NULO, usará el ALOC líder como opción predeterminada.
Valores que se muestran
OT_ERROR_NONE
El comando del conjunto de datos Meshcop se envió de forma correcta.
OT_ERROR_NO_BUFS
No hay suficiente espacio en el búfer para enviar.

otDatasetSendMgmtActiveSet

otError otDatasetSendMgmtActiveSet(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength,
  otDatasetMgmtSetCallback aCallback,
  void *aContext
)

Esta función envía MGMT_ACTIVE_SET.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aDataset
Un puntero para el conjunto de datos operativo.
[in] aTlvs
Un puntero para los TLV.
[in] aLength
La longitud de los TLV.
[in] aCallback
Un puntero para una función que se llama durante la recepción de respuesta o el tiempo de espera.
[in] aContext
Un puntero al contexto específico de la aplicación para aCallback.
Valores que se muestran
OT_ERROR_NONE
El comando del conjunto de datos Meshcop se envió de forma correcta.
OT_ERROR_NO_BUFS
No hay suficiente espacio en el búfer para enviar.
OT_ERROR_BUSY
Hay una solicitud anterior en curso.

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 para una instancia de OpenThread.
[in] aDatasetComponents
Un puntero para una estructura de componentes de conjunto de datos que especifica qué componentes solicitar.
[in] aTlvTypes
Un puntero para un arreglo 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 NULO, usará el ALOC líder como opción predeterminada.
Valores que se muestran
OT_ERROR_NONE
El comando del conjunto de datos Meshcop se envió de forma correcta.
OT_ERROR_NO_BUFS
No hay suficiente espacio en el búfer para enviar.

otDatasetSendMgmtPendingSet

otError otDatasetSendMgmtPendingSet(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength,
  otDatasetMgmtSetCallback aCallback,
  void *aContext
)

Esta función envía MGMT_PENDING_SET.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aDataset
Un puntero para el conjunto de datos operativo.
[in] aTlvs
Un puntero para los TLV.
[in] aLength
La longitud de los TLV.
[in] aCallback
Un puntero para una función que se llama durante la recepción de respuesta o el tiempo de espera.
[in] aContext
Un puntero al contexto específico de la aplicación para aCallback.
Valores que se muestran
OT_ERROR_NONE
El comando del conjunto de datos Meshcop se envió de forma correcta.
OT_ERROR_NO_BUFS
No hay suficiente espacio en el búfer para enviar.
OT_ERROR_BUSY
Hay una solicitud anterior en curso.

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, solo se completará de forma parcial.

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

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

Si el dispositivo se conecta correctamente a una red Thread, el dispositivo recuperará todo el conjunto de datos activo de su red superior. Tenga en cuenta que los dispositivos compatibles con routers no realizarán la transición a las funciones de router o líder hasta que tengan un conjunto de datos activo completo.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aDataset
Un puntero para el conjunto de datos operativo activo.
Valores que se muestran
OT_ERROR_NONE
Se configuró correctamente el conjunto de datos operativo activo.
OT_ERROR_NO_BUFS
No hay suficiente espacio de búfer 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, solo se completará de forma parcial.

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

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

Si el dispositivo se conecta correctamente a una red Thread, el dispositivo recuperará todo el conjunto de datos activo de su red superior. Tenga en cuenta que los dispositivos compatibles con routers no realizarán la transición a las funciones de router o líder hasta que tengan un conjunto de datos activo completo.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aDataset
Un puntero para el conjunto de datos operativo activo.
Valores que se muestran
OT_ERROR_NONE
Se configuró correctamente el conjunto de datos operativo activo.
OT_ERROR_NO_BUFS
No hay suficiente espacio de búfer para configurar el conjunto de datos operativo activo.
OT_ERROR_NOT_IMPLEMENTED
La plataforma no implementa la funcionalidad de configuración.

otDatasetSetDelayTimerMinimum

otError otDatasetSetDelayTimerMinimal(
  otInstance *aInstance,
  uint32_t aDelayTimerMinimal
)

Establece un temporizador de retraso mínimo.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aDelayTimerMinimal
El valor del temporizador de retraso mínimo (en ms).
Valores que se muestran
OT_ERROR_NONE
Se estableció correctamente el temporizador de retraso 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 operativo pendiente.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aDataset
Un puntero para el conjunto de datos operativo pendiente.
Valores que se muestran
OT_ERROR_NONE
Se configuró correctamente el conjunto de datos operativo pendiente.
OT_ERROR_NO_BUFS
No hay suficiente espacio en el búfer para configurar 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 operativo pendiente.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aDataset
Un puntero para el conjunto de datos operativo pendiente.
Valores que se muestran
OT_ERROR_NONE
Se configuró correctamente el conjunto de datos operativo pendiente.
OT_ERROR_NO_BUFS
No hay suficiente espacio en el búfer para configurar el conjunto de datos operativo pendiente.
OT_ERROR_NOT_IMPLEMENTED
La plataforma no implementa la funcionalidad de configuración.

otDatasetUpdaterCancelUpdate

void otDatasetUpdaterCancelUpdate(
  otInstance *aInstance
)

Esta función cancela una solicitud de actualización operativa del conjunto de datos (si existe).

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

otDatasetUpdaterIsUpdateOngoing

bool otDatasetUpdaterIsUpdateOngoing(
  otInstance *aInstance
)

Esta función indica si hay una solicitud de actualización del conjunto de datos de operación en curso.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Valores que se muestran
TRUE
Hay una actualización en curso.
FALSE
No hay ninguna actualización en curso.

Actualización de solicitud de conjunto de datos de otDataset

otError otDatasetUpdaterRequestUpdate(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  otDatasetUpdaterCallback aCallback,
  void *aContext
)

Esta función solicita una actualización del conjunto de datos operativo.

aDataset debe contener los campos que se actualizarán y su nuevo valor. No debe contener campos activos ni de marca de tiempo pendientes. El campo Delay es opcional si no se proporciona un valor predeterminado (1, 000 ms).

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aDataset
Un puntero al conjunto de datos que contiene los campos que se cambiarán.
[in] aCallback
Una devolución de llamada para indicar cuándo finaliza la solicitud de actualización del conjunto de datos.
[in] aContext
Un contexto arbitrario pasado a la devolución de llamada
Valores que se muestran
OT_ERROR_NONE
La actualización del conjunto de datos comenzó correctamente (se invocará aCallback cuando se complete el proceso).
OT_ERROR_INVALID_STATE
El dispositivo está inhabilitado (MLE está inhabilitado).
OT_ERROR_INVALID_ARGS
El aDataset no es válido (contiene una marca de tiempo activa o pendiente).
OT_ERROR_BUSY
No se puede iniciar la actualización porque hay una actualización anterior en curso.
OT_ERROR_NO_BUFS
No se pudo asignar el búfer para guardar el conjunto de datos.

otNetworkNameFromString

otError otNetworkNameFromString(
  otNetworkName *aNetworkName,
  const char *aNameString
)

Esta función establece una instancia otNetworkName a partir de una string C terminada en un valor nulo.

Esta función también valida que el aNameString dado siga la codificación UTF-8 y que su longitud no sea mayor que OT_NETWORK_NAME_MAX_SIZE.

Detalles
Parámetros
[out] aNetworkName
Un puntero para establecer otNetworkName.
[in] aNameString
Una string de nombre C.
Valores que se muestran
OT_ERROR_NONE
Se configuró correctamente aNetworkName desde aNameString.
OT_ERROR_INVALID_ARGS
aNameStrng no es válido (es demasiado largo o no sigue la codificación UTF-8).

Macros

MAS_CHANNEL_10_MASK

 OT_CHANNEL_10_MASK (1 << 10)

Canal 10:

OT_CHANNEL_11_MASK

 OT_CHANNEL_11_MASK (1 << 11)

Canal 11:

OT_CHANNEL_12_MASK

 OT_CHANNEL_12_MASK (1 << 12)

Canal 12:

OT_CHANNEL_13_MASK

 OT_CHANNEL_13_MASK (1 << 13)

Canal 13

MAS_CHANNEL_14_MASK

 OT_CHANNEL_14_MASK (1 << 14)

Canal 14

MAS_CHANNEL_15_MASK

 OT_CHANNEL_15_MASK (1 << 15)

Canal 15

MAS_CHANNEL_16_MASK

 OT_CHANNEL_16_MASK (1 << 16)

Canal 16:

MAS_CHANNEL_17_MASK

 OT_CHANNEL_17_MASK (1 << 17)

Canal 17:

OT_CHANNEL_18_MASK

 OT_CHANNEL_18_MASK (1 << 18)

Canal 18.

MAS_CHANNEL_19_MASK

 OT_CHANNEL_19_MASK (1 << 19)

Canal 19:

MAS_CHANNEL_1_MASK

 OT_CHANNEL_1_MASK (1 << 1)

Canal 1:

MAS_CHANNEL_20_MASK

 OT_CHANNEL_20_MASK (1 << 20)

Canal 20.

MAS_CHANNEL_21_MASK

 OT_CHANNEL_21_MASK (1 << 21)

Canal 21.

MAS_CHANNEL_22_MASK

 OT_CHANNEL_22_MASK (1 << 22)

Canal 22.

MAS_CHANNEL_23_MASK

 OT_CHANNEL_23_MASK (1 << 23)

Canal 23.

MAS_CHANNEL_24_MASK

 OT_CHANNEL_24_MASK (1 << 24)

Canal 24.

MAS_CHANNEL_25_MASK

 OT_CHANNEL_25_MASK (1 << 25)

Canal 25.

MAS_CHANNEL_26_MASK

 OT_CHANNEL_26_MASK (1 << 26)

Canal 26.

MAS_CHANNEL_2_MASK

 OT_CHANNEL_2_MASK (1 << 2)

Canal 2:

MAS_CHANNEL_3_MASK

 OT_CHANNEL_3_MASK (1 << 3)

Canal 3:

MAS_CHANNEL_4_MASK

 OT_CHANNEL_4_MASK (1 << 4)

Canal 4.

MAS_CHANNEL_5_MASK

 OT_CHANNEL_5_MASK (1 << 5)

Canal 5:

MAS_CHANNEL_6_MASK

 OT_CHANNEL_6_MASK (1 << 6)

Canal 6.

OT_CHANNEL_7_MASK

 OT_CHANNEL_7_MASK (1 << 7)

Canal 7.

OT_CHANNEL_8_MASK

 OT_CHANNEL_8_MASK (1 << 8)

Canal 8.

MAS_CHANNEL_9_MASK

 OT_CHANNEL_9_MASK (1 << 9)

Canal 9:

OT_EXT_PAN_ID_SIZE

 OT_EXT_PAN_ID_SIZE 8

Tamaño del ID del PAN de un subproceso (bytes)

OT_MESH_LOCAL_PREFIX_SIZE

 OT_MESH_LOCAL_PREFIX_SIZE OT_IP6_PREFIX_SIZE

Tamaño del prefijo local de malla (bytes)

OT_NETWORK_KEY_SIZE

 OT_NETWORK_KEY_SIZE 16

Tamaño de la clave de red de los subprocesos (bytes)

OT_NETWORK_NAME_MAX_SIZE

 OT_NETWORK_NAME_MAX_SIZE 16

Tamaño máximo del campo Nombre de la red del subproceso (bytes)

TS_OPERATIONAL_DATASET_MAX_LENGTH

 OT_OPERATIONAL_DATASET_MAX_LENGTH 254

Longitud máxima del conjunto de datos operativo en bytes.

TS_PSKC_MAX_SIZE

 OT_PSKC_MAX_SIZE 16

Tamaño máximo de la PSKc (bytes)

Recursos

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