Conjunto de datos operativo

Incluye funciones para la API de Operational Dataset.

Resumen

Solo para compilaciones de FTD, el Actualizador de conjuntos de datos incluye funciones para administrar las actualizaciones de los conjuntos de datos.

Para las compilaciones de FTD y MTD, la API de Operational Dataset incluye funciones para administrar conjuntos de datos activos y pendientes, y los TLV de conjuntos de datos.

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
Representa los tipos de TLV de Meshcop.

Typedefs
otChannelMask typedef
uint32_t
Representa la máscara del canal.
otDatasetMgmtSetCallback)(otError aResult, void *aContext) typedef
void(*
Se llama al puntero cuando se recibe una respuesta a una solicitud MGMT_SET o cuando 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, y se informa el estado de éxito o falla de la solicitud de actualización del conjunto de datos.
otExtendedPanId typedef
Representa un ID PAN extendido.
otMeshLocalPrefix typedef
Representa un prefijo local de malla.
otMeshcopTlvType typedef
Representa los tipos de TLV de Meshcop.
otNetworkKey typedef
struct otNetworkKey
Representa una clave de red de Thread.
otNetworkKeyRef typedef
Este tipo de datos representa KeyRef para NetworkKey.
otNetworkName typedef
struct otNetworkName
Representa un nombre de red.
otOperationalDataset typedef
Representa un conjunto de datos operativos activo o pendiente.
otOperationalDatasetComponents typedef
Representa la presencia de diferentes componentes en los conjuntos de datos operativos activos o pendientes.
otOperationalDatasetTlvs typedef
Representa un conjunto de datos operativos activo o pendiente.
otPskc typedef
struct otPskc
Representa una PSKc.
otPskcRef typedef
Este tipo de datos representa KeyRef a PSKc.
otSecurityPolicy typedef
Representar la política de seguridad
otTimestamp typedef
struct otTimestamp
Representa un componente de marca de tiempo del conjunto de datos de subprocesos.

Variables
OT_TOOL_PACKED_END

remotas
otDatasetConvertToTlvs(const otOperationalDataset *aDataset, otOperationalDatasetTlvs *aDatasetTlvs)
Convierte un conjunto de datos operativos determinado en otOperationalDatasetTlvs.
otDatasetCreateNewNetwork(otInstance *aInstance, otOperationalDataset *aDataset)
Solo para FTD, crea un nuevo conjunto de datos operativos para usarlo cuando se forme una red nueva.
otDatasetGeneratePskc(const char *aPassPhrase, const otNetworkName *aNetworkName, const otExtendedPanId *aExtPanId, otPskc *aPskc)
Genera PSKc a partir de una frase de contraseña, un nombre de red y un ID de número PAN extendidos.
otDatasetGetActive(otInstance *aInstance, otOperationalDataset *aDataset)
Obtiene el conjunto de datos operativos activo.
otDatasetGetActiveTlvs(otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
Obtiene el conjunto de datos operativos activo.
otDatasetGetDelayTimerMinimal(otInstance *aInstance)
uint32_t
Solo para FTD, obtiene un temporizador de retraso mínimo.
otDatasetGetPending(otInstance *aInstance, otOperationalDataset *aDataset)
Obtiene el conjunto de datos operativos pendiente.
otDatasetGetPendingTlvs(otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
Obtiene el conjunto de datos operativos pendiente.
otDatasetIsCommissioned(otInstance *aInstance)
bool
Indica si hay una red válida presente o no en el conjunto de datos operativos activo.
otDatasetParseTlvs(const otOperationalDatasetTlvs *aDatasetTlvs, otOperationalDataset *aDataset)
Analiza un conjunto de datos operativos de un otOperationalDatasetTlvs determinado.
otDatasetSendMgmtActiveGet(otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
Envía MGMT_ACTIVE_GET.
otDatasetSendMgmtActiveSet(otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
Envía MGMT_ACTIVE_SET.
otDatasetSendMgmtPendingGet(otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
Envía MGMT_PENDING_GET.
otDatasetSendMgmtPendingSet(otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
Envía MGMT_PENDING_SET.
otDatasetSetActive(otInstance *aInstance, const otOperationalDataset *aDataset)
Establece el conjunto de datos operativos activo.
otDatasetSetActiveTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
Establece el conjunto de datos operativos activo.
otDatasetSetDelayTimerMinimal(otInstance *aInstance, uint32_t aDelayTimerMinimal)
Solo para FTD, establece un temporizador de retraso mínimo.
otDatasetSetPending(otInstance *aInstance, const otOperationalDataset *aDataset)
Establece el conjunto de datos operativos pendiente.
otDatasetSetPendingTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
Establece el conjunto de datos operativos pendiente.
otDatasetUpdateTlvs(const otOperationalDataset *aDataset, otOperationalDatasetTlvs *aDatasetTlvs)
Actualiza un conjunto de datos operativos determinado.
otDatasetUpdaterCancelUpdate(otInstance *aInstance)
void
Cancela una solicitud de actualización del conjunto de datos operativos en curso (si existe).
otDatasetUpdaterIsUpdateOngoing(otInstance *aInstance)
bool
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)
Solicita una actualización del conjunto de datos operativo.
otNetworkNameFromString(otNetworkName *aNetworkName, const char *aNameString)
Configura una instancia otNetworkName a partir de una string C terminada en un valor nulo.

Structs
otExtendedPanId

Representa un ID PAN extendido.

otNetworkKey

Representa una clave de red de Thread.

otNetworkName

Representa un nombre de red.

otOperationalDataset

Representa un conjunto de datos operativos activo o pendiente.

otOperationalDatasetComponents

Representa la presencia de diferentes componentes en los conjuntos de datos operativos activos o pendientes.

otOperationalDatasetTlvs

Representa un conjunto de datos operativos activo o pendiente.

otPskc

Representa PSKc.

otSecurityPolicy

Representar la política de seguridad

otTimestamp

Representa un componente de marca de tiempo del conjunto de datos de subprocesos.

Enumeraciones

otMeshcopTlvType

 otMeshcopTlvType

Representa los tipos de TLV de Meshcop.

Propiedades
OT_MESHCOP_TLV_ACTIVETIMESTAMP

TLV de marca de tiempo activa de Meshcop

OT_MESHCOP_TLV_BORDER_AGENT_RLOC

TLV de localizador de agentes de borde de mallacop

OT_MESHCOP_TLV_CHANNEL

TLV de canal de Meshcop

OT_MESHCOP_TLV_CHANNELMASK

Máscara de canal de Meshcop TLV

OT_MESHCOP_TLV_COMMISSIONER_ID

ID de comisionado de Meshcop TLV

OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT

Puerto UDP del comisionado de Meshcop TLV

OT_MESHCOP_TLV_COMM_SESSION_ID

ID de sesión del comisionado de mallacop

OT_MESHCOP_TLV_COUNT

Cantidad de TLV de Meshcop

OT_MESHCOP_TLV_DELAYTIMER

TLV de retraso de mallacop

OT_MESHCOP_TLV_DISCOVERYREQUEST

TLV de solicitud de descubrimiento de Meshcop

OT_MESHCOP_TLV_DISCOVERYRESPONSE

TLV de respuesta de detección de mallacop

OT_MESHCOP_TLV_ENERGY_LIST

Lista de energía de mallacop para TLV

OT_MESHCOP_TLV_EXTPANID

ID de desplazamiento lateral extendido de Meshcop TLV

OT_MESHCOP_TLV_GET

Obtener TLV de Meshcop

OT_MESHCOP_TLV_IPV6_ADDRESS_TLV

TLV de dirección IPv6 de mallacop

OT_MESHCOP_TLV_JOINERADVERTISEMENT

TLV de anuncio de unión de mallacop

OT_MESHCOP_TLV_JOINER_DTLS

TLV de encapsulamiento DTLS de la unión de mallacop

OT_MESHCOP_TLV_JOINER_IID

TLV de IID de conector de mallacop

OT_MESHCOP_TLV_JOINER_RLOC

TLV de localizador de router de unión de mallacop

OT_MESHCOP_TLV_JOINER_ROUTER_KEK

KEK TLV de router de unión de mallacop

OT_MESHCOP_TLV_JOINER_UDP_PORT

Puerto UDP del conector de mallacop TLV

OT_MESHCOP_TLV_MESHLOCALPREFIX

TLV de prefijo local de la malla de Meshcop

OT_MESHCOP_TLV_NETWORKKEY

TLV de clave de red de Meshcop

OT_MESHCOP_TLV_NETWORKNAME

Nombre de red de Meshcop TLV

OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE

TLV de secuencia de claves de red de Meshcop

OT_MESHCOP_TLV_PANID

ID de desplazamiento lateral de Meshcop TLV

OT_MESHCOP_TLV_PENDINGTIMESTAMP

TLV de marca de tiempo pendiente de Meshcop

OT_MESHCOP_TLV_PERIOD

TLV del período de Meshcop

OT_MESHCOP_TLV_PROVISIONING_URL

TLV de la URL de aprovisionamiento de Meshcop

OT_MESHCOP_TLV_PSKC

TLV de PSKc de Meshcop

OT_MESHCOP_TLV_SCAN_DURATION

TLV de duración de análisis de Meshcop

OT_MESHCOP_TLV_SECURITYPOLICY

TLV de la política de seguridad de Meshcop

OT_MESHCOP_TLV_STATE

TLV de estado de Meshcop

OT_MESHCOP_TLV_STEERING_DATA

TLV de datos de dirección de Meshcop

OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV

TLV de encapsulamiento UDP de Meshcop

OT_MESHCOP_TLV_VENDOR_DATA_TLV

TLV de datos de proveedores de mallacop

OT_MESHCOP_TLV_VENDOR_MODEL_TLV

Modelo de proveedor de Meshcop TLV

OT_MESHCOP_TLV_VENDOR_NAME_TLV

Nombre del proveedor de Meshcop TLV

OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV

TLV de la versión de la pila del proveedor de mallacop

OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV

TLV de versión de SW del proveedor de mallacop

Typedefs

otChannelMask

uint32_t otChannelMask

Representa la máscara del canal.

otDatasetMgmtSetCallback

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

Se llama al puntero cuando se recibe una respuesta a una solicitud MGMT_SET o cuando se agota el tiempo de espera.

Detalles
Parámetros
[in] aResult
Es un 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 confirmación 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, y se informa el estado de éxito o falla de la solicitud de actualización del conjunto de datos.

Disponible cuando se habilita OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE.

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 que se produjo un error debido a un estado no válido (se inhabilitó el MLE). OT_ERROR_ALREADY indica que hubo un error debido a que otro dispositivo dentro de la red solicitó una actualización conflictiva del conjunto de datos.
[in] aContext
Un puntero al contexto arbitrario (proporcionado por el usuario en otDatasetUpdaterRequestUpdate()).

otExtendedPanId

struct otExtendedPanId otExtendedPanId

Representa un ID PAN extendido.

otMeshLocalPrefix

otIp6NetworkPrefix otMeshLocalPrefix

Representa un prefijo local de malla.

otMeshcopTlvType

enum otMeshcopTlvType otMeshcopTlvType

Representa los tipos de TLV de Meshcop.

otNetworkKey

struct otNetworkKey otNetworkKey

Representa una clave de red de Thread.

otNetworkKeyRef

otCryptoKeyRef otNetworkKeyRef

Este tipo de datos representa KeyRef para NetworkKey.

Referencia a claves

otNetworkName

struct otNetworkName otNetworkName

Representa un nombre de red.

El otNetworkName es una string C que termina en un valor nulo (es decir, El array de caracteres m8 DEBE terminar con el carácter nulo \0).

otOperationalDataset

struct otOperationalDataset otOperationalDataset

Representa un conjunto de datos operativos activo o pendiente.

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

otOperationalDatasetComponents

struct otOperationalDatasetComponents otOperationalDatasetComponents

Representa la presencia de diferentes componentes en los conjuntos de datos operativos activos o pendientes.

otOperationalDatasetTlvs

struct otOperationalDatasetTlvs otOperationalDatasetTlvs

Representa un conjunto de datos operativos activo o pendiente.

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

otPskc

struct otPskc otPskc

Representa una PSKc.

otPskcRef

otCryptoKeyRef otPskcRef

Este tipo de datos representa KeyRef a PSKc.

Referencia a claves

otSecurityPolicy

struct otSecurityPolicy otSecurityPolicy

Representar la política de seguridad

otTimestamp

struct otTimestamp otTimestamp

Representa un componente de marca de tiempo del conjunto de datos de subprocesos.

Variables

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otNetworkKey OT_TOOL_PACKED_END

remotas

otDatasetConvertToTlvs

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

Convierte un conjunto de datos operativos determinado en otOperationalDatasetTlvs.

Detalles
Parámetros
[in] aDataset
Un conjunto de datos operativos para convertir en TLV.
[out] aDatasetTlvs
Un puntero a los TLV del conjunto de datos para mostrar el resultado.
Valores que se muestran
OT_ERROR_NONE
Se convirtió aDataset y se actualizó aDatasetTlvs correctamente.
OT_ERROR_INVALID_ARGS
aDataset no es válido y no contiene marcas de tiempo activas ni pendientes.

otDatasetCreateNewNetwork

otError otDatasetCreateNewNetwork(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Solo para FTD, crea un nuevo conjunto de datos operativos para usarlo cuando se forme una red nueva.

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

otDatasetGeneratePskc

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

Genera PSKc a partir de una frase de contraseña, un nombre de red y un ID de número PAN extendidos.

La PSKc se usa para establecer la sesión del comisionado.

Detalles
Parámetros
[in] aPassPhrase
Es la frase de contraseña de comisión.
[in] aNetworkName
El nombre de la red para el cálculo de PSKc.
[in] aExtPanId
El ID del PAN extendido para el cálculo de PSKc.
[out] aPskc
Un puntero a una variable para obtener la PSKc generada.
Valores que se muestran
OT_ERROR_NONE
Se generó correctamente la PSKc.
OT_ERROR_INVALID_ARGS
Se muestra si alguno de los argumentos de entrada no es válido.

otDatasetGetActive

otError otDatasetGetActive(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Obtiene el conjunto de datos operativos activo.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aDataset
Un puntero hacia la ubicación en la que se ubicará el conjunto de datos operativos activo.
Valores que se muestran
OT_ERROR_NONE
Se recuperó correctamente el conjunto de datos operativos activo.
OT_ERROR_NOT_FOUND
No hay un valor correspondiente en la tienda de parámetros de configuración.

otDatasetGetActiveTlvs

otError otDatasetGetActiveTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

Obtiene el conjunto de datos operativos activo.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aDataset
Un puntero hacia la ubicación en la que se ubicará el conjunto de datos operativos activo.
Valores que se muestran
OT_ERROR_NONE
Se recuperó correctamente el conjunto de datos operativos activo.
OT_ERROR_NOT_FOUND
No hay un valor correspondiente en la tienda de parámetros de configuración.

otDatasetGetDelayTimerMinimal

uint32_t otDatasetGetDelayTimerMinimal(
  otInstance *aInstance
)

Solo para FTD, obtiene 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
)

Obtiene el conjunto de datos operativos pendiente.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aDataset
Un puntero hacia la ubicación en la que se colocará el conjunto de datos operativos pendiente.
Valores que se muestran
OT_ERROR_NONE
Se recuperó correctamente el conjunto de datos operativos pendiente.
OT_ERROR_NOT_FOUND
No hay un valor correspondiente en la tienda de parámetros de configuración.

otDatasetGetPendingTlvs

otError otDatasetGetPendingTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

Obtiene el conjunto de datos operativos pendiente.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aDataset
Un puntero hacia la ubicación en la que se colocará el conjunto de datos operativos pendiente.
Valores que se muestran
OT_ERROR_NONE
Se recuperó correctamente el conjunto de datos operativos pendiente.
OT_ERROR_NOT_FOUND
No hay un valor correspondiente en la tienda de parámetros de configuración.

otDatasetIsCommissioned

bool otDatasetIsCommissioned(
  otInstance *aInstance
)

Indica si hay una red válida presente o no en el conjunto de datos operativos activo.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
TRUE si hay una red válida presente en el Conjunto de datos operativos activo, de lo contrario, FALSE.

otDatasetParseTlvs

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

Analiza un conjunto de datos operativos de un otOperationalDatasetTlvs determinado.

Detalles
Parámetros
[in] aDatasetTlvs
Un puntero para los TLV de los conjuntos de datos.
[out] aDataset
Un puntero hacia dónde se colocará el conjunto de datos.
Valores que se muestran
OT_ERROR_NONE
Se configuró correctamente aDataset en 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
)

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 del conjunto de datos que especifica qué componentes solicitar.
[in] aTlvTypes
Un puntero para un array que contiene tipos de TLV sin procesar adicionales que se solicitarán.
[in] aLength
La longitud de aTlvTypes.
[in] aAddress
Un puntero al destino de IPv6, si es NULL, usará el ALOC líder de forma predeterminada.
Valores que se muestran
OT_ERROR_NONE
Se envió correctamente el comando del conjunto de datos de Meshcop.
OT_ERROR_NO_BUFS
No hay suficiente espacio de búfer para enviar.

otDatasetSendMgmtActiveSet

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

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 operativos.
[in] aTlvs
Un puntero para los TLV.
[in] aLength
Es la longitud de los TLV.
[in] aCallback
Un puntero a una función a la que se llama cuando se recibe una respuesta o cuando se agota 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
Se envió correctamente el comando del conjunto de datos de Meshcop.
OT_ERROR_NO_BUFS
No hay suficiente espacio de 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
)

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 del conjunto de datos que especifica qué componentes solicitar.
[in] aTlvTypes
Un puntero para un array que contiene tipos de TLV sin procesar adicionales que se solicitarán.
[in] aLength
La longitud de aTlvTypes.
[in] aAddress
Un puntero al destino de IPv6, si es NULL, usará el ALOC líder de forma predeterminada.
Valores que se muestran
OT_ERROR_NONE
Se envió correctamente el comando del conjunto de datos de Meshcop.
OT_ERROR_NO_BUFS
No hay suficiente espacio de búfer para enviar.

otDatasetSendMgmtPendingSet

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

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 operativos.
[in] aTlvs
Un puntero para los TLV.
[in] aLength
Es la longitud de los TLV.
[in] aCallback
Un puntero a una función a la que se llama cuando se recibe una respuesta o cuando se agota 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
Se envió correctamente el comando del conjunto de datos de Meshcop.
OT_ERROR_NO_BUFS
No hay suficiente espacio de búfer para enviar.
OT_ERROR_BUSY
Hay una solicitud anterior en curso.

otDatasetSetActive

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

Establece el conjunto de datos operativos activo.

Si el conjunto de datos no incluye una marca de tiempo activa, el conjunto de datos estará 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 Thread existente usando cualquier información existente en el conjunto de datos. Solo se necesita la clave de red de Thread para conectarse a una red.

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

Si el dispositivo se conecta correctamente a una red Thread, recuperará todo el conjunto de datos activo de su red superior. Ten en cuenta que un dispositivo compatible con routers no pasará a los roles de router o líder hasta que tenga un conjunto de datos activo completo.

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

otDatasetSetActiveTlvs

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

Establece el conjunto de datos operativos activo.

Si el conjunto de datos no incluye una marca de tiempo activa, el conjunto de datos estará 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 Thread existente usando cualquier información existente en el conjunto de datos. Solo se necesita la clave de red de Thread para conectarse a una red.

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

Si el dispositivo se conecta correctamente a una red Thread, recuperará todo el conjunto de datos activo de su red superior. Ten en cuenta que un dispositivo compatible con routers no pasará a los roles de router o líder hasta que tenga un conjunto de datos activo completo.

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

otDatasetSetDelayTimerMinimal

otError otDatasetSetDelayTimerMinimal(
  otInstance *aInstance,
  uint32_t aDelayTimerMinimal
)

Solo para FTD, 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
)

Establece el conjunto de datos operativos pendiente.

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

otDatasetSetPendingTlvs

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

Establece el conjunto de datos operativos pendiente.

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

otDatasetUpdateTlvs

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

Actualiza un conjunto de datos operativos determinado.

aDataset contiene los campos que se actualizarán y su valor nuevo.

Detalles
Parámetros
[in] aDataset
Especifica el conjunto de tipos y valores que se actualizarán.
[in,out] aDatasetTlvs
Un puntero a los TLV del conjunto de datos para actualizar.
Valores que se muestran
OT_ERROR_NONE
Se actualizó correctamente aDatasetTlvs.
OT_ERROR_INVALID_ARGS
aDataset contiene valores no válidos.
OT_ERROR_NO_BUFS
No hay espacio suficiente en aDatasetTlvs para aplicar la actualización.

otDatasetUpdaterCancelUpdate

void otDatasetUpdaterCancelUpdate(
  otInstance *aInstance
)

Cancela una solicitud de actualización del conjunto de datos operativos en curso (si existe).

Disponible cuando se habilita OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE.

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

otDatasetUpdaterIsUpdateOngoing

bool otDatasetUpdaterIsUpdateOngoing(
  otInstance *aInstance
)

Indica si hay una solicitud de actualización del conjunto de datos de operación en curso.

Disponible cuando se habilita OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE.

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 actualizaciones en curso.

otDatasetUpdaterRequestUpdate

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

Solicita una actualización del conjunto de datos operativo.

Disponible cuando se habilita OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE.

aDataset debe contener los campos que se actualizarán y su valor nuevo. No debe contener campos de marca de tiempo activa ni pendiente. El campo Retraso es opcional. Si no se proporciona, se usará 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 deben cambiar.
[in] aCallback
Es una devolución de llamada para indicar cuándo finaliza la solicitud de actualización del conjunto de datos.
[in] aContext
Un contexto arbitrario que se pasa a la devolución de llamada.
Valores que se muestran
OT_ERROR_NONE
La actualización del conjunto de datos se inició correctamente (se invocará aCallback cuando se complete).
OT_ERROR_INVALID_STATE
El dispositivo está inhabilitado (MLE está inhabilitado).
OT_ERROR_INVALID_ARGS
La aDataset no es válida (contiene la marca de tiempo activa o pendiente).
OT_ERROR_BUSY
No se puede iniciar la actualización porque hay una 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
)

Configura una instancia otNetworkName a partir de una string C terminada en un valor nulo.

aNameString debe seguir la codificación UTF-8, y la longitud del nombre de la red no debe ser superior a OT_NETWORK_NAME_MAX_SIZE.

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

Macros

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

OT_CHANNEL_14_MASK

 OT_CHANNEL_14_MASK (1 << 14)

Canal 14.

OT_CHANNEL_15_MASK

 OT_CHANNEL_15_MASK (1 << 15)

Canal 15.

OT_CHANNEL_16_MASK

 OT_CHANNEL_16_MASK (1 << 16)

Canal 16.

OT_CHANNEL_17_MASK

 OT_CHANNEL_17_MASK (1 << 17)

Canal 17.

OT_CHANNEL_18_MASK

 OT_CHANNEL_18_MASK (1 << 18)

Canal 18.

OT_CHANNEL_19_MASK

 OT_CHANNEL_19_MASK (1 << 19)

Canal 19.

OT_CHANNEL_1_MASK

 OT_CHANNEL_1_MASK (1 << 1)

Canal 1.

OT_CHANNEL_20_MASK

 OT_CHANNEL_20_MASK (1 << 20)

Canal 20.

OT_CHANNEL_21_MASK

 OT_CHANNEL_21_MASK (1 << 21)

Canal 21.

OT_CHANNEL_22_MASK

 OT_CHANNEL_22_MASK (1 << 22)

Canal 22.

OT_CHANNEL_23_MASK

 OT_CHANNEL_23_MASK (1 << 23)

Canal 23.

OT_CHANNEL_24_MASK

 OT_CHANNEL_24_MASK (1 << 24)

Canal 24.

OT_CHANNEL_25_MASK

 OT_CHANNEL_25_MASK (1 << 25)

Canal 25.

OT_CHANNEL_26_MASK

 OT_CHANNEL_26_MASK (1 << 26)

Canal 26.

OT_CHANNEL_2_MASK

 OT_CHANNEL_2_MASK (1 << 2)

Canal 2:

OT_CHANNEL_3_MASK

 OT_CHANNEL_3_MASK (1 << 3)

Canal 3.

OT_CHANNEL_4_MASK

 OT_CHANNEL_4_MASK (1 << 4)

Canal 4.

OT_CHANNEL_5_MASK

 OT_CHANNEL_5_MASK (1 << 5)

Canal 5.

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

OT_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 subprocesos (bytes)

OT_MESH_LOCAL_PREFIX_SIZE

 OT_MESH_LOCAL_PREFIX_SIZE OT_IP6_PREFIX_SIZE

Tamaño del prefijo local de la malla (bytes)

OT_NETWORK_KEY_SIZE

 OT_NETWORK_KEY_SIZE 16

Tamaño de la clave de red de Thread (bytes)

OT_NETWORK_NAME_MAX_SIZE

 OT_NETWORK_NAME_MAX_SIZE 16

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

OT_OPERATIONAL_DATASET_MAX_LENGTH

 OT_OPERATIONAL_DATASET_MAX_LENGTH 254

La longitud máxima del conjunto de datos operativos en bytes.

OT_PSKC_MAX_SIZE

 OT_PSKC_MAX_SIZE 16

Tamaño máximo del PSKc (bytes)

Recursos

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