Google se compromete a impulsar la igualdad racial para las comunidades afrodescendientes. Obtén información al respecto.
Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

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 Datasets operativo incluye funciones para administrar conjuntos de datos y TLV de conjuntos de datos activos y pendientes.

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

Typedefs

otChannelMask typedef
uint32_t
Este tipo representa la máscara de canal.
otDatasetMgmtSetCallback)(otError aResult, void *aContext) typedef
void(*
Se llama a este puntero de función cuando se recibe una respuesta a una solicitud 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 éxito o fracaso de la solicitud de actualización del conjunto de datos.
otExtendedPanId typedef
Esta estructura representa un ID de PAN extendido.
otMeshLocalPrefix typedef
Esta estructura representa un prefijo local de la malla.
otMeshcopTlvType typedef
Esta enumeración representa los tipos de TLV de mallacopa.
otNetworkKey typedef
struct otNetworkKey
Esta estructura representa una clave de red del subproceso.
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 subprocesos.

Variables

OT_TOOL_PACKED_END

Funciones

otDatasetCreateNewNetwork(otInstance *aInstance, otOperationalDataset *aDataset)
Solo para FTD, crea un nuevo conjunto de datos operativos para usar cuando se forma una red nueva.
otDatasetGeneratePskc(const char *aPassPhrase, const otNetworkName *aNetworkName, const otExtendedPanId *aExtPanId, otPskc *aPskc)
Esta función genera el PSKc a partir de una frase de contraseña, un nombre de red y un ID de PAN extendido.
otDatasetGetActive(otInstance *aInstance, otOperationalDataset *aDataset)
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
Solo para FTD, obtiene un temporizador de retraso mínimo.
otDatasetGetPending(otInstance *aInstance, otOperationalDataset *aDataset)
Esta función obtiene el conjunto de datos operativos pendiente.
otDatasetGetPendingTlvs(otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
Esta función obtiene el conjunto de datos operativos pendiente.
otDatasetIsCommissioned(otInstance *aInstance)
bool
Esta función indica si hay una red válida presente en el conjunto de datos operativos activos.
otDatasetParseTlvs(const otOperationalDatasetTlvs *aDatasetTlvs, otOperationalDataset *aDataset)
Esta función analiza un conjunto de datos operativo desde un otOperationalDatasetTlvs.
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)
Configura 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)
Solo para FTD, establece un temporizador de retraso mínimo.
otDatasetSetPending(otInstance *aInstance, const otOperationalDataset *aDataset)
Establece el conjunto de datos operativo pendiente.
otDatasetSetPendingTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
Esta función establece el conjunto de datos operativos pendiente.
otDatasetUpdaterCancelUpdate(otInstance *aInstance)
void
Esta función cancela una solicitud de actualización de conjunto de datos operativos en curso (si existe).
otDatasetUpdaterIsUpdateOngoing(otInstance *aInstance)
bool
Esta función indica si hay una solicitud de actualización de 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 operativos.
otNetworkNameFromString(otNetworkName *aNetworkName, const char *aNameString)
Establece una instancia de otNetworkName a partir de una string C dada nula.

Structs

otExtendedPanId

Esta estructura representa un ID de PAN extendido.

otNetworkKey

Esta estructura representa una clave de red del subproceso.

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 la 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 subprocesos.

Enumeraciones

otMeshcopTlvType

 otMeshcopTlvType

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

Propiedades
OT_MESHCOP_TLV_ACTIVETIMESTAMP

Mallcop Active Timestamp TLV

OT_MESHCOP_TLV_BORDER_AGENT_RLOC

mallacop Border Agent Locator TLV

OT_MESHCOP_TLV_CHANNEL

TLV de canal de Meshcop

OT_MESHCOP_TLV_CHANNELMASK

TLV de máscara de canal de mallacop

OT_MESHCOP_TLV_COMMISSIONER_ID

mallacop ID de comisionado TLV

OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT

Mallcop Commissioner UDP Port TLV

OT_MESHCOP_TLV_COMM_SESSION_ID

ID de sesión del comisario de mallacop TLV

OT_MESHCOP_TLV_COUNT

Recuento de malla de TLV

OT_MESHCOP_TLV_DELAYTIMER

mallacop Delay Timer TLV

OT_MESHCOP_TLV_DISCOVERYREQUEST

TLV de la solicitud de detección de mallacop

OT_MESHCOP_TLV_DISCOVERYRESPONSE

TLV de respuesta de mallacop discovery

OT_MESHCOP_TLV_ENERGY_LIST

mallacop Energy List TLV

OT_MESHCOP_TLV_EXTPANID

ID de panorámica extendido de mallacop TLV

OT_MESHCOP_TLV_GET

mallacop Obtener TLV

OT_MESHCOP_TLV_IPV6_ADDRESS_TLV

TLV de la dirección IPv6 de mallacop

OT_MESHCOP_TLV_JOINERADVERTISEMENT

TLV del anuncio de la unión de mallacop

OT_MESHCOP_TLV_JOINER_DTLS

mallacop Joiner DTLS Encapsulation TLV

OT_MESHCOP_TLV_JOINER_IID

mallacop Joiner IID TLV

OT_MESHCOP_TLV_JOINER_RLOC

Locator TLV Localizador de routers de mallacop

OT_MESHCOP_TLV_JOINER_ROUTER_KEK

Router de unión de mallacop TLV de la KEK

OT_MESHCOP_TLV_JOINER_UDP_PORT

TLV del puerto UDP de la unión de mallacop

OT_MESHCOP_TLV_MESHLOCALPREFIX

TLV de prefijo local de malla de malla

OT_MESHCOP_TLV_NETWORKKEY

TLV de la red de 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 mallacop

OT_MESHCOP_TLV_PANID

TLV de desplazamiento de la malla

OT_MESHCOP_TLV_PENDINGTIMESTAMP

Mallcop Pending Timestamp TLV

OT_MESHCOP_TLV_PERIOD

TLV del período de Meshcop

OT_MESHCOP_TLV_PROVISIONING_URL

mallacop Provisioning URL TLV

OT_MESHCOP_TLV_PSKC

mallacop PSKc TLV

OT_MESHCOP_TLV_SCAN_DURATION

TLV de la duración del escaneo de mallacopa

OT_MESHCOP_TLV_SECURITYPOLICY

TLV de la política de seguridad de mallacop

OT_MESHCOP_TLV_STATE

mallacop State TLV

OT_MESHCOP_TLV_STEERING_DATA

mallacop Steering Data TLV

OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV

TLV de encapsulación UDP en malla

OT_MESHCOP_TLV_VENDOR_DATA_TLV

TLV de datos de proveedores de Meshcop

OT_MESHCOP_TLV_VENDOR_MODEL_TLV

mallacop Vendor Model TLV

OT_MESHCOP_TLV_VENDOR_NAME_TLV

Nombre del proveedor de TLV de mallacop

OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV

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

OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV

Proveedor de malla del software de versiones de SW

Typedefs

MáscaradeCanal

uint32_t otChannelMask

Este tipo representa la máscara de canal.

otDatasetMgmtSetCallback

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

Se llama a este puntero de función cuando se recibe una respuesta a una solicitud 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 al contexto específico de la aplicación.
Valores de retorno
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 al analizar 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 que informa el estado de éxito o fracaso de la solicitud de actualización del conjunto de datos.

Disponible cuando OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE está habilitado.

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

ID de otExtendedPan

struct otExtendedPanId otExtendedPanId

Esta estructura representa un ID de 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 mallacopa.

otNetworkKey

struct otNetworkKey otNetworkKey

Esta estructura representa una clave de red del subproceso.

otNetworkKeyRef

otCryptoKeyRef otNetworkKeyRef

Este tipo de datos representa KeyRef a NetworkKey.

Referencia a la clave

otNetworkName

struct otNetworkName otNetworkName

Esta estructura representa un nombre de red.

otNetworkName es una string C terminada en nulo (es decir, El arreglo de caracteres m8 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.

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 operativo está TLV codificado según lo especificado por Thread.

Ptskc de otsc

struct otPskc otPskc

Esta estructura representa una PSKc.

otPskcRef

otCryptoKeyRef otPskcRef

Este tipo de datos representa KeyRef a PSKc.

Referencia a la clave

Política de seguridad de 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 subprocesos.

Variables

TS_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otNetworkKey OT_TOOL_PACKED_END

Funciones

otDatasetCreateNewNetwork

otError otDatasetCreateNewNetwork(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Solo para FTD, crea un nuevo conjunto de datos operativos para usar 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 de retorno
OT_ERROR_NONE
Se creó correctamente un nuevo conjunto de datos operativo.
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
)

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

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

Detalles
Parámetros
[in] aPassPhrase
La frase de aprobación para la puesta en marcha.
[in] aNetworkName
El nombre de red para el cálculo de PSKc.
[in] aExtPanId
El ID de número PAN extendido para el cálculo de PSKc.
[out] aPskc
Un puntero para modificar la salida del PSKc generado.
Valores de retorno
OT_ERROR_NONE
Se generó correctamente la PSKc.
OT_ERROR_INVALID_ARGS
Si alguno de los argumentos de entrada no es válido.

otDatasetGetActive

otError otDatasetGetActive(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Obtiene el conjunto de datos operativo activo.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aDataset
Un puntero para ubicar el conjunto de datos operativo activo.
Valores de retorno
OT_ERROR_NONE
Se recuperó correctamente el conjunto de datos operativo activo.
OT_ERROR_NOT_FOUND
No hay un valor correspondiente en el almacén 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 para ubicar el conjunto de datos operativo activo.
Valores de retorno
OT_ERROR_NONE
Se recuperó correctamente el conjunto de datos operativo activo.
OT_ERROR_NOT_FOUND
No hay un valor correspondiente en el almacén 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 de retorno
the
valor de un temporizador de retraso mínimo (en ms).

otDatasetGetPending

otError otDatasetGetPending(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

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

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aDataset
Un puntero para ubicar el conjunto de datos operativos pendiente.
Valores de retorno
OT_ERROR_NONE
Se recuperó correctamente el conjunto de datos operativo pendiente.
OT_ERROR_NOT_FOUND
No hay un valor correspondiente en el almacén de configuración.

otDatasetGetPendingTlvs

otError otDatasetGetPendingTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

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

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[out] aDataset
Un puntero para ubicar el conjunto de datos operativos pendiente.
Valores de retorno
OT_ERROR_NONE
Se recuperó correctamente el conjunto de datos operativo pendiente.
OT_ERROR_NOT_FOUND
No hay un valor correspondiente en el almacén de configuración.

otDatasetIsCommissioned

bool otDatasetIsCommissioned(
  otInstance *aInstance
)

Esta función indica si hay una red válida presente en el conjunto de datos operativos activos.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Qué muestra
TRUE si existe una red válida en el conjunto de datos operativos activos; de lo contrario, se establece en FALSE.

otDatasetParseTlvs

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

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

Detalles
Parámetros
[in] aDatasetTlvs
Un puntero para los TLV del conjunto de datos.
[out] aDataset
Un puntero a la ubicación del conjunto de datos.
Valores de retorno
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
)

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 conjuntos de datos que especifica qué componentes solicitar.
[in] aTlvTypes
Un puntero para 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 NULO, usará el ALOC líder de forma predeterminada.
Valores de retorno
OT_ERROR_NONE
Se envió correctamente el comando del conjunto de datos mallacop.
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 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 en tiempo de espera o recepción de respuesta.
[in] aContext
Un puntero al contexto específico de la aplicación para aCallback.
Valores de retorno
OT_ERROR_NONE
Se envió correctamente el comando del conjunto de datos mallacop.
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 de conjuntos de datos que especifica qué componentes solicitar.
[in] aTlvTypes
Un puntero para 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 NULO, usará el ALOC líder de forma predeterminada.
Valores de retorno
OT_ERROR_NONE
Se envió correctamente el comando del conjunto de datos mallacop.
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 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 en tiempo de espera o recepción de respuesta.
[in] aContext
Un puntero al contexto específico de la aplicación para aCallback.
Valores de retorno
OT_ERROR_NONE
Se envió correctamente el comando del conjunto de datos mallacop.
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
)

Configura el conjunto de datos operativo activo.

Si el conjunto de datos no incluye una marca de tiempo activa, este solo se completó de forma parcial.

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

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

Si el dispositivo se conecta correctamente a una red Thread, el dispositivo recuperará el conjunto de datos activo completo de su superior. Ten en cuenta que un dispositivo compatible con el router no cambiará 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 para el conjunto de datos operativo activo.
Valores de retorno
OT_ERROR_NONE
Se configuró correctamente el conjunto de datos operativo activo.
OT_ERROR_NO_BUFS
No hay suficiente espacio de búfer para establecer 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, este solo se completó de forma parcial.

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

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

Si el dispositivo se conecta correctamente a una red Thread, el dispositivo recuperará el conjunto de datos activo completo de su superior. Ten en cuenta que un dispositivo compatible con el router no cambiará 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 para el conjunto de datos operativo activo.
Valores de retorno
OT_ERROR_NONE
Se configuró correctamente el conjunto de datos operativo activo.
OT_ERROR_NO_BUFS
No hay suficiente espacio de búfer para establecer 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
)

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 de retorno
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 operativo pendiente.

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

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

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aDataset
Un puntero para el conjunto de datos operativos pendiente.
Valores de retorno
OT_ERROR_NONE
Se configuró correctamente el conjunto de datos operativos pendiente.
OT_ERROR_NO_BUFS
No hay suficiente espacio de búfer para establecer el conjunto de datos operativos 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 de conjunto de datos operativos en curso (si existe).

Disponible cuando OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE está habilitado.

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 de conjunto de datos de operación en curso.

Disponible cuando OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE está habilitado.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Valores de retorno
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
)

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

Disponible cuando OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE está habilitado.

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

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 que se pasa a la devolución de llamada.
Valores de retorno
OT_ERROR_NONE
La actualización del conjunto de datos comenzó correctamente (se invocará aCallback al finalizar).
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 anterior en curso.
OT_ERROR_NO_BUFS
No se pudo asignar un búfer para guardar el conjunto de datos.

otNetworkNameFromString

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

Establece una instancia de otNetworkName a partir de una string C dada nula.

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

Detalles
Parámetros
[out] aNetworkName
Un puntero para establecer otNetworkName
[in] aNameString
Una string de nombre C.
Valores de retorno
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.

TS_CHANNEL_11_MASK

 OT_CHANNEL_11_MASK (1 << 11)

Canal 11.

MAS_CHANNEL_12_MASK

 OT_CHANNEL_12_MASK (1 << 12)

Canal 12.

MAS_CHANNEL_13_MASK

 OT_CHANNEL_13_MASK (1 << 13)

Canal 13.

TS_CHANNEL_14_MASK

 OT_CHANNEL_14_MASK (1 << 14)

Canal 14.

MAS_CHANNEL_15_MASK

 OT_CHANNEL_15_MASK (1 << 15)

Canal 15.

TS_CHANNEL_16_MASK

 OT_CHANNEL_16_MASK (1 << 16)

Canal 16.

TS_CHANNEL_17_MASK

 OT_CHANNEL_17_MASK (1 << 17)

Canal 17.

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

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

TS_CHANNEL_7_MASK

 OT_CHANNEL_7_MASK (1 << 7)

Canal 7.

TS_CHANNEL_8_MASK

 OT_CHANNEL_8_MASK (1 << 8)

Canal 8.

TS_CHANNEL_9_MASK

 OT_CHANNEL_9_MASK (1 << 9)

Canal 9.

TS_EXT_PAN_ID_SIZE

 OT_EXT_PAN_ID_SIZE 8

Tamaño de un ID de PAN de subprocesos (bytes)

TS_MESH_LOCAL_PREFIX_SIZE

 OT_MESH_LOCAL_PREFIX_SIZE OT_IP6_PREFIX_SIZE

Tamaño del prefijo local de malla (bytes)

TS_NETWORK_KEY_SIZE

 OT_NETWORK_KEY_SIZE 16

Tamaño de la clave de red del subproceso (bytes)

TS_NETWORK_NAME_MAX_SIZE

 OT_NETWORK_NAME_MAX_SIZE 16

Tamaño máximo del campo Thread Network Name (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 a partir del código fuente, disponible en GitHub. Para obtener más información o contribuir con nuestra documentación, consulta Recursos.