Se usó la API de Cloud Translation para traducir esta página.

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_NETWORK_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 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_NETWORK_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 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.
`otInstanceGetUptime ( otInstance *aInstance)`	`uint64_t` Esta función devuelve el tiempo de actividad actual de la instancia (en mseg).
`otInstanceGetUptimeAsString ( otInstance aInstance, char aBuffer, uint16_t aSize)`	`void` Esta función devuelve el tiempo de actividad actual de la instancia como una cadena legible por humanos.
`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 desencadena un reinicio de la plataforma.
`otInstanceResetRadioStack ( otInstance *aInstance)`	`void` Este método restablece los estados internos de la pila de radio OpenThread.
`otRemoveStateChangeCallback ( otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`void` Esta función elimina una devolución de llamada para indicar cuando cierta configuración o estado cambia 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 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_NETWORK_KEY`	Se cambió la clave de red.
`OT_CHANGED_PENDING_DATASET`	El conjunto de datos operativos pendiente ha cambiado.
`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`	Niño fue agregado.
`OT_CHANGED_THREAD_CHILD_REMOVED`	El niño fue retirado.
`OT_CHANGED_THREAD_EXT_PANID`	El ID de PAN extendido de la red de subprocesos 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`	Se cambió el nombre de la red del hilo.
`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.

Ver OT_CHANGED_* definiciones.

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. Ver `OT_CHANGED_*` definiciones.
`[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.

Erase tiene éxito sólo si el dispositivo está en disabled Estado / papel.

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 `disabled` Estado / papel.

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.

otInstanceGetUptime

uint64_t otInstanceGetUptime(
  otInstance *aInstance
)

Esta función devuelve el tiempo de actividad actual de la instancia (en mseg).

Esta función requiere OPENTHREAD_CONFIG_UPTIME_ENABLE esté habilitado.

El tiempo de actividad se indica como el número de milisegundos desde que se inicializó la instancia de OpenThread.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

El tiempo de actividad (cantidad de milisegundos).

otInstanceGetUptimeAsString

void otInstanceGetUptimeAsString(
  otInstance *aInstance,
  char *aBuffer,
  uint16_t aSize
)

Esta función devuelve el tiempo de actividad actual de la instancia como una cadena legible por humanos.

Esta función requiere OPENTHREAD_CONFIG_UPTIME_ENABLE esté habilitado.

La cadena sigue el formato " : : . "por horas, minutos, segundos y milisegundos (si el tiempo de actividad es inferior a un día) o"

D. : : . "(si es más de un día).

Si la cadena resultante no encaja en aBuffer (dentro de sus aSize caracteres), se truncará la cadena pero la cadena emite siempre es terminada en nulo.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[out] aBuffer`	Un puntero a una matriz de caracteres para generar la cadena.
`[in] aSize`	El tamaño de `aBuffer` (en bytes). Recomienda el uso de `OT_UPTIME_STRING_SIZE` .

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 se habilita la compatibilidad con varias instancias de OpenThread.

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álido si se adquiere y se inicializa utilizando otInstanceInitSingle() (en caso de instancia única) o otInstanceInit() (en el caso de múltiples ejemplo). Una llamada posterior a otInstanceFinalize() hace que la instancia de considerarse como no inicializado.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

VERDADERO si la instancia dada es válida / inicializada, FALSO 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 la otPlatformReset no borra cualquier estado / información persistente guardado en la memoria no volátil.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

otInstanceResetRadioStack

void otInstanceResetRadioStack(
  otInstance *aInstance
)

Este método restablece los estados internos de la pila de radio OpenThread.

Se conservan las devoluciones de llamada y las configuraciones.

Esta API sólo está disponible bajo la radio construye ( OPENTHREAD_RADIO = 1 ).

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

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.

Macros

OT_UPTIME_STRING_SIZE

 OT_UPTIME_STRING_SIZE 24

Tamaño recomendado para la representación en cadena del tiempo de actividad.

Recursos

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