Ejemplo

Este módulo incluye funciones que controlan la instancia OpenThread.

Resumen

Enumeraciones
anonymous enum { OT_CHANGED_IP6_ADDRESS_ADDED = 1 << 0, OT_CHANGED_IP6_ADDRESS_REMOVED = 1 << 1, OT_CHANGED_THREAD_ROLE = 1 << 2, OT_CHANGED_THREAD_LL_ADDR = 1 << 3, OT_CHANGED_THREAD_ML_ADDR = 1 << 4, OT_CHANGED_THREAD_RLOC_ADDED = 1 << 5, OT_CHANGED_THREAD_RLOC_REMOVED = 1 << 6, OT_CHANGED_THREAD_PARTITION_ID = 1 << 7, OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER = 1 << 8, OT_CHANGED_THREAD_NETDATA = 1 << 9, OT_CHANGED_THREAD_CHILD_ADDED = 1 << 10, OT_CHANGED_THREAD_CHILD_REMOVED = 1 << 11, OT_CHANGED_IP6_MULTICAST_SUBSCRIBED = 1 << 12, OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED = 1 << 13, OT_CHANGED_THREAD_CHANNEL = 1 << 14, OT_CHANGED_THREAD_PANID = 1 << 15, OT_CHANGED_THREAD_NETWORK_NAME = 1 << 16, OT_CHANGED_THREAD_EXT_PANID = 1 << 17, OT_CHANGED_MASTER_KEY = 1 << 18, OT_CHANGED_PSKC = 1 << 19, OT_CHANGED_SECURITY_POLICY = 1 << 20, OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL = 1 << 21, OT_CHANGED_SUPPORTED_CHANNEL_MASK = 1 << 22, OT_CHANGED_COMMISSIONER_STATE = 1 << 23, OT_CHANGED_THREAD_NETIF_STATE = 1 << 24, OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE = 1 << 25, OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL = 1 << 26, OT_CHANGED_JOINER_STATE = 1 << 27, OT_CHANGED_ACTIVE_DATASET = 1 << 28, OT_CHANGED_PENDING_DATASET = 1 << 29 }	enumeración Esta enumeración define los indicadores que se pasan como parte de `otStateChangedCallback` .

Enumeraciones

anonymous enum {
 OT_CHANGED_IP6_ADDRESS_ADDED = 1 << 0,
 OT_CHANGED_IP6_ADDRESS_REMOVED = 1 << 1,
 OT_CHANGED_THREAD_ROLE = 1 << 2,
 OT_CHANGED_THREAD_LL_ADDR = 1 << 3,
 OT_CHANGED_THREAD_ML_ADDR = 1 << 4,
 OT_CHANGED_THREAD_RLOC_ADDED = 1 << 5,
 OT_CHANGED_THREAD_RLOC_REMOVED = 1 << 6,
 OT_CHANGED_THREAD_PARTITION_ID = 1 << 7,
 OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER = 1 << 8,
 OT_CHANGED_THREAD_NETDATA = 1 << 9,
 OT_CHANGED_THREAD_CHILD_ADDED = 1 << 10,
 OT_CHANGED_THREAD_CHILD_REMOVED = 1 << 11,
 OT_CHANGED_IP6_MULTICAST_SUBSCRIBED = 1 << 12,
 OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED = 1 << 13,
 OT_CHANGED_THREAD_CHANNEL = 1 << 14,
 OT_CHANGED_THREAD_PANID = 1 << 15,
 OT_CHANGED_THREAD_NETWORK_NAME = 1 << 16,
 OT_CHANGED_THREAD_EXT_PANID = 1 << 17,
 OT_CHANGED_MASTER_KEY = 1 << 18,
 OT_CHANGED_PSKC = 1 << 19,
 OT_CHANGED_SECURITY_POLICY = 1 << 20,
 OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL = 1 << 21,
 OT_CHANGED_SUPPORTED_CHANNEL_MASK = 1 << 22,
 OT_CHANGED_COMMISSIONER_STATE = 1 << 23,
 OT_CHANGED_THREAD_NETIF_STATE = 1 << 24,
 OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE = 1 << 25,
 OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL = 1 << 26,
 OT_CHANGED_JOINER_STATE = 1 << 27,
 OT_CHANGED_ACTIVE_DATASET = 1 << 28,
 OT_CHANGED_PENDING_DATASET = 1 << 29
 }

enumeración

Esta enumeración define los indicadores que se pasan como parte de otStateChangedCallback .

Typedefs
`otChangedFlags`	typedef `uint32_t` Este tipo representa un campo de bits que indica el estado / configuración específicos que ha cambiado.
`otInstance`	typedef `struct otInstance` Esta estructura representa la estructura de instancia de OpenThread.
`otStateChangedCallback )(otChangedFlags aFlags, void *aContext)`	typedef `void(*` Este puntero de función se llama para notificar ciertos cambios de configuración o estado dentro de OpenThread.

Funciones
`otGetRadioVersionString ( otInstance *aInstance)`	`const char *` Esta función obtiene la cadena de versión de radio de OpenThread.
`otGetVersionString (void)`	`const char *` Esta función obtiene la cadena de versión de OpenThread.
`otInstanceErasePersistentInfo ( otInstance *aInstance)`	`otError` Esta función borra toda la información persistente de OpenThread (configuración de red) almacenada en la memoria no volátil.
`otInstanceFactoryReset ( otInstance *aInstance)`	`void` Este método elimina todas las configuraciones almacenadas en la memoria no volátil y luego activa el restablecimiento de la plataforma.
`otInstanceFinalize ( otInstance *aInstance)`	`void` Esta función desactiva la biblioteca OpenThread.
`otInstanceInit (void aInstanceBuffer, size_t aInstanceBufferSize)`	`otInstance *` Esta función inicializa la biblioteca OpenThread.
`otInstanceInitSingle (void)`	`otInstance *` Esta función inicializa la instancia única estática de la biblioteca OpenThread.
`otInstanceIsInitialized ( otInstance *aInstance)`	`bool` Esta función indica si la instancia es válida / inicializada.
`otInstanceReset ( otInstance *aInstance)`	`void` Este método activa un reinicio de la plataforma.
`otRemoveStateChangeCallback ( otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`void` Esta función elimina una devolución de llamada para indicar cuándo cambia cierta configuración o estado dentro de OpenThread.
`otSetStateChangedCallback ( otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`otError` Esta función registra una devolución de llamada para indicar cuando cierta configuración o estado cambia dentro de OpenThread.

Enumeraciones

enumeración anónima

 anonymous enum

Esta enumeración define los indicadores que se pasan como parte de otStateChangedCallback .

Propiedades
`OT_CHANGED_ACTIVE_DATASET`	El conjunto de datos operativos activo cambió.
`OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL`	Channel Manager nuevo canal de hilo pendiente cambiado.
`OT_CHANGED_COMMISSIONER_STATE`	El estado del comisionado cambió.
`OT_CHANGED_IP6_ADDRESS_ADDED`	Se agregó la dirección IPv6.
`OT_CHANGED_IP6_ADDRESS_REMOVED`	Se eliminó la dirección IPv6.
`OT_CHANGED_IP6_MULTICAST_SUBSCRIBED`	Suscrito a una dirección de multidifusión IPv6.
`OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED`	Darse de baja de una dirección de multidifusión IPv6.
`OT_CHANGED_JOINER_STATE`	El estado de incorporación cambió.
`OT_CHANGED_MASTER_KEY`	Se cambió la llave maestra.
`OT_CHANGED_PENDING_DATASET`	El conjunto de datos operativos pendientes cambió.
`OT_CHANGED_PSKC`	PSKc cambió.
`OT_CHANGED_SECURITY_POLICY`	La política de seguridad cambió.
`OT_CHANGED_SUPPORTED_CHANNEL_MASK`	Se cambió la máscara de canal compatible.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL`	Se modificó la configuración del enrutador troncal local.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE`	El estado del enrutador troncal ha cambiado.
`OT_CHANGED_THREAD_CHANNEL`	El canal de la red de hilos cambió.
`OT_CHANGED_THREAD_CHILD_ADDED`	Se agregó niño.
`OT_CHANGED_THREAD_CHILD_REMOVED`	El niño fue retirado.
`OT_CHANGED_THREAD_EXT_PANID`	El ID de PAN extendido de la red de hilos cambió.
`OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER`	Se ha modificado la secuencia de teclas del hilo.
`OT_CHANGED_THREAD_LL_ADDR`	La dirección de enlace local cambió.
`OT_CHANGED_THREAD_ML_ADDR`	La dirección de la malla local cambió.
`OT_CHANGED_THREAD_NETDATA`	Los datos de la red del hilo cambiaron.
`OT_CHANGED_THREAD_NETIF_STATE`	El estado de la interfaz de red del subproceso cambió.
`OT_CHANGED_THREAD_NETWORK_NAME`	El nombre de la red del hilo cambió.
`OT_CHANGED_THREAD_PANID`	El ID de PAN de la red de subprocesos cambió.
`OT_CHANGED_THREAD_PARTITION_ID`	El ID de la partición cambió.
`OT_CHANGED_THREAD_RLOC_ADDED`	Se agregó RLOC.
`OT_CHANGED_THREAD_RLOC_REMOVED`	Se eliminó RLOC.
`OT_CHANGED_THREAD_ROLE`	El rol (discapacitado, separado, secundario, enrutador, líder) cambió.

Typedefs

otChangedFlags

uint32_t otChangedFlags

Este tipo representa un campo de bits que indica el estado / configuración específicos que ha cambiado.

Consulte las definiciones de OT_CHANGED_* .

otInstance

struct otInstance otInstance

Esta estructura representa la estructura de instancia de OpenThread.

otStateChangedCallback

void(* otStateChangedCallback)(otChangedFlags aFlags, void *aContext)

Este puntero de función se llama para notificar ciertos cambios de configuración o estado dentro de OpenThread.

Detalles

Parámetros

`[in] aFlags`	Un campo de bits que indica el estado específico que ha cambiado. Consulte las definiciones de `OT_CHANGED_*` .
`[in] aContext`	Un puntero al contexto específico de la aplicación.

Funciones

otGetRadioVersionString

const char * otGetRadioVersionString(
  otInstance *aInstance
)

Esta función obtiene la cadena de versión de radio de OpenThread.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

Un puntero a la versión de radio OpenThread.

otGetVersionString

const char * otGetVersionString(
  void
)

Esta función obtiene la cadena de versión de OpenThread.

Detalles
Devoluciones	Un puntero a la versión OpenThread.

otInstanceErasePersistentInfo

otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

Esta función borra toda la información persistente de OpenThread (configuración de red) almacenada en la memoria no volátil.

El borrado es exitoso solo si el dispositivo está en estado / función disabled .

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Valores devueltos

`OT_ERROR_NONE`	Toda la información / estado persistente se borró correctamente.
`OT_ERROR_INVALID_STATE`	El dispositivo no está en estado / rol `disabled` .

otInstanceFactoryReset

void otInstanceFactoryReset(
  otInstance *aInstance
)

Este método elimina todas las configuraciones almacenadas en la memoria no volátil y luego activa el restablecimiento de la plataforma.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

otInstanceFinalize

void otInstanceFinalize(
  otInstance *aInstance
)

Esta función desactiva la biblioteca OpenThread.

Llame a esta función cuando OpenThread ya no esté en uso.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

otInstanceInit

otInstance * otInstanceInit(
  void *aInstanceBuffer,
  size_t *aInstanceBufferSize
)

Esta función inicializa la biblioteca OpenThread.

Esta función inicializa OpenThread y lo prepara para las siguientes llamadas a la API de OpenThread. Esta función debe llamarse antes que cualquier otra llamada a OpenThread.

Esta función está disponible y solo se puede utilizar cuando la compatibilidad con varias instancias de OpenThread está habilitada.

Detalles

Parámetros

`[in] aInstanceBuffer`	El búfer para que OpenThread lo use para asignar la estructura otInstance.
`[in,out] aInstanceBufferSize`	En la entrada, el tamaño de aInstanceBuffer. En la salida, si no hay suficiente espacio para otInstance, el número de bytes necesarios para otInstance.

Devoluciones

Un puntero a la nueva instancia de OpenThread.

Ver también:
otInstanceFinalize

otInstanceInitSingle

otInstance * otInstanceInitSingle(
  void
)

Esta función inicializa la instancia única estática de la biblioteca OpenThread.

Esta función inicializa OpenThread y lo prepara para las siguientes llamadas a la API de OpenThread. Esta función debe llamarse antes que cualquier otra llamada a OpenThread.

Esta función está disponible y solo se puede utilizar cuando la compatibilidad con varias instancias de OpenThread está deshabilitada.

Detalles
Devoluciones	Un puntero a la única instancia de OpenThread.

otInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

Esta función indica si la instancia es válida / inicializada.

La instancia se considera válida si se adquiere e inicializa utilizando otInstanceInitSingle() (en el caso de una sola instancia) u otInstanceInit() (en el caso de múltiples instancias). Una llamada posterior a otInstanceFinalize() hace que la instancia se considere no inicializada.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

TRUE si la instancia dada es válida / inicializada, FALSE en caso contrario.

otInstanceReset

void otInstanceReset(
  otInstance *aInstance
)

Este método desencadena un reinicio de la plataforma.

El proceso de reinicio garantiza que se borre todo el estado / información de OpenThread (almacenado en la memoria volátil). Tenga en cuenta que otPlatformReset no borra ningún estado / información persistente guardado en la memoria no volátil.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

otRemoveStateChangeCallback

void otRemoveStateChangeCallback(
  otInstance *aInstance,
  otStateChangedCallback aCallback,
  void *aContext
)

Esta función elimina una devolución de llamada para indicar cuándo cambia cierta configuración o estado dentro de OpenThread.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aCallback`	Un puntero a una función que se llama con cierta configuración o cambios de estado.
`[in] aContext`	Un puntero al contexto específico de la aplicación.

otSetStateChangedCallback

otError otSetStateChangedCallback(
  otInstance *aInstance,
  otStateChangedCallback aCallback,
  void *aContext
)

Esta función registra una devolución de llamada para indicar cuando cierta configuración o estado cambia dentro de OpenThread.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aCallback`	Un puntero a una función que se llama con cierta configuración o cambios de estado.
`[in] aContext`	Un puntero al contexto específico de la aplicación.

Valores devueltos

`OT_ERROR_NONE`	Se agregó la devolución de llamada a la lista de devoluciones de llamada.
`OT_ERROR_ALREADY`	La devolución de llamada ya estaba registrada.
`OT_ERROR_NO_BUFS`	No se pudo agregar la devolución de llamada debido a limitaciones de recursos.