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

Instancia

Este módulo incluye funciones que controlan la instancia de 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 }	Enum En esta enumeración, se definen marcas 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
}

Enum

En esta enumeración, se definen marcas que se pasan como parte de otStateChangedCallback.

Typedefs
`otChangedFlags`	typedef `uint32_t` Este tipo representa un campo de bits que indica un estado o una configuración específicos que cambiaron.
`otInstance`	typedef `struct otInstance` Esta estructura representa la estructura de la instancia de OpenThread.
`otStateChangedCallback)(otChangedFlags aFlags, void *aContext)`	typedef `void(*` Se llama a este puntero de función para notificar ciertos cambios de configuración o estado en OpenThread.

Funciones
`otGetRadioVersionString(otInstance *aInstance)`	`const char *` Esta función obtiene la string de versión de radio de OpenThread.
`otGetVersionString(void)`	`const char *` Esta función obtiene la string de la 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` Borra toda la configuración almacenada en la memoria no volátil y, luego, activa el restablecimiento de la plataforma.
`otInstanceFinalize(otInstance *aInstance)`	`void` Esta función inhabilita la biblioteca de OpenThread.
`otInstanceGetUptime(otInstance *aInstance)`	`uint64_t` Esta función muestra el tiempo de actividad actual de la instancia (en ms).
`otInstanceGetUptimeAsString(otInstance aInstance, char aBuffer, uint16_t aSize)`	`void` Esta función muestra el tiempo de actividad actual de la instancia como una string legible.
`otInstanceInit(void aInstanceBuffer, size_t aInstanceBufferSize)`	`otInstance *` Esta función inicializa la biblioteca de OpenThread.
`otInstanceInitSingle(void)`	`otInstance *` Esta función inicializa la instancia única estática de la biblioteca de OpenThread.
`otInstanceIsInitialized(otInstance *aInstance)`	`bool` Esta función indica si la instancia es válida o inicializada.
`otInstanceReset(otInstance *aInstance)`	`void` Este método activa el restablecimiento de la plataforma.
`otInstanceResetRadioStack(otInstance *aInstance)`	`void` Este método restablece los estados internos de la pila de radio de OpenThread.
`otRemoveStateChangeCallback(otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`void` Esta función elimina una devolución de llamada para indicar cuándo cambia determinada 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 cuándo cambia determinada configuración o estado dentro de OpenThread.

Enumeraciones

enumeración anónima

 anonymous enum

En esta enumeración, se definen marcas que se pasan como parte de otStateChangedCallback.

Propiedades
`OT_CHANGED_ACTIVE_DATASET`	El conjunto de datos operativo activo cambió.
`OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL`	Se cambió el nuevo canal pendiente de Thread Manager.
`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 quitó la dirección IPv6.
`OT_CHANGED_IP6_MULTICAST_SUBSCRIBED`	Te suscribiste a una dirección de multidifusión IPv6.
`OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED`	Se anuló la suscripción a una dirección de multidifusión IPv6.
`OT_CHANGED_JOINER_STATE`	El estado de la unión cambió.
`OT_CHANGED_NETWORK_KEY`	Se cambió la clave de red.
`OT_CHANGED_PENDING_DATASET`	El conjunto de datos operativo pendiente cambió.
`OT_CHANGED_PSKC`	PSKc cambió.
`OT_CHANGED_SECURITY_POLICY`	Se modificó la política de seguridad.
`OT_CHANGED_SUPPORTED_CHANNEL_MASK`	Se modificó la máscara de canal compatible.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL`	Se cambió la configuración del router troncal local.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE`	Se cambió el estado del router troncal.
`OT_CHANGED_THREAD_CHANNEL`	Se cambió el canal de la red Thread.
`OT_CHANGED_THREAD_CHILD_ADDED`	Se agregó el elemento secundario.
`OT_CHANGED_THREAD_CHILD_REMOVED`	Se quitó el elemento secundario.
`OT_CHANGED_THREAD_EXT_PANID`	Se modificó el ID del PAN extendido de la red de la conversación.
`OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER`	Se modificó la secuencia de claves del subproceso.
`OT_CHANGED_THREAD_LL_ADDR`	Se modificó la dirección del vínculo local.
`OT_CHANGED_THREAD_ML_ADDR`	Se cambió la dirección de la malla local.
`OT_CHANGED_THREAD_NETDATA`	Se modificaron los datos de red de la conversación.
`OT_CHANGED_THREAD_NETIF_STATE`	Se cambió el estado de la interfaz de red de la conversación.
`OT_CHANGED_THREAD_NETWORK_NAME`	Se cambió el nombre de la red del subproceso.
`OT_CHANGED_THREAD_PANID`	El ID PAN de la red de subprocesos cambió.
`OT_CHANGED_THREAD_PARTITION_ID`	Se modificó el ID de partición.
`OT_CHANGED_THREAD_RLOC_ADDED`	Se agregó el RLOC.
`OT_CHANGED_THREAD_RLOC_REMOVED`	Se quitó el RLOC.
`OT_CHANGED_THREAD_ROLE`	El rol (inhabilitado, desconectado, secundario, router, líder) cambió.

Typedefs

otChangedFlags

uint32_t otChangedFlags

Este tipo representa un campo de bits que indica un estado o una configuración específicos que cambiaron.

Consulta las definiciones de OT_CHANGED_*.

instancia de ot

struct otInstance otInstance

Esta estructura representa la estructura de la instancia de OpenThread.

otStateChangedCallback

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

Se llama a este puntero de función para notificar ciertos cambios de configuración o estado en OpenThread.

Detalles

Parámetros

`[in] aFlags`	Un campo de bits que indica un estado específico que cambió. Consulta 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 string de versión de radio de OpenThread.

Detalles

Parámetros

[in] aInstance

Un puntero para una instancia de OpenThread.

Qué muestra

Un puntero para la versión de radio de OpenThread.

otGetVersionString

const char * otGetVersionString(
  void
)

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

Detalles
Qué muestra	Un puntero para la versión de OpenThread.

otInstanceClearPersistentInfo

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.

La acción Borrar solo se realiza correctamente si el dispositivo tiene el estado o la función disabled.

Detalles

Parámetros

[in] aInstance

Un puntero para una instancia de OpenThread.

Valores de retorno

`OT_ERROR_NONE`	Se borró correctamente la información o el estado persistente.
`OT_ERROR_INVALID_STATE`	El dispositivo no tiene el estado o la función `disabled`.

otInstanceFactoryReset

void otInstanceFactoryReset(
  otInstance *aInstance
)

Borra toda la configuración almacenada en la memoria no volátil y, luego, activa el restablecimiento de la plataforma.

Detalles

Parámetros

[in] aInstance

Un puntero para una instancia de OpenThread.

otInstanceFinalize

void otInstanceFinalize(
  otInstance *aInstance
)

Esta función inhabilita la biblioteca de OpenThread.

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

Detalles

Parámetros

[in] aInstance

Un puntero para una instancia de OpenThread.

otInstanceGetUptime

uint64_t otInstanceGetUptime(
  otInstance *aInstance
)

Esta función muestra el tiempo de actividad actual de la instancia (en ms).

Esta función requiere que se habilite OPENTHREAD_CONFIG_UPTIME_ENABLE.

El tiempo de actividad se indica en milisegundos desde la inicialización de la instancia de OpenThread.

Detalles

Parámetros

[in] aInstance

Un puntero para una instancia de OpenThread.

Qué muestra

El tiempo de actividad (cantidad de milisegundos)

otInstanceGetUptimeAsString

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

Esta función muestra el tiempo de actividad actual de la instancia como una string legible.

Esta función requiere que se habilite OPENTHREAD_CONFIG_UPTIME_ENABLE.

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

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

Si la string resultante no cabe en aBuffer (dentro de sus aSize caracteres), la string se truncará, pero la string resultante siempre será nula.

Detalles

Parámetros

`[in] aInstance`	Un puntero para una instancia de OpenThread.
`[out] aBuffer`	Un puntero para un arreglo de caracteres a fin de generar la string.
`[in] aSize`	El tamaño de `aBuffer` (en bytes). Se recomienda usar `OT_UPTIME_STRING_SIZE`.

otInstanceInit

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

Esta función inicializa la biblioteca de OpenThread.

Esta función inicializa OpenThread y la prepara para las llamadas posteriores a la API de OpenThread. Se debe llamar a esta función antes que cualquier otra llamada a OpenThread.

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

Detalles

Parámetros

`[in] aInstanceBuffer`	El búfer de OpenThread que se usará para asignar la estructura otInstance.
`[in,out] aInstanceBufferSize`	En la entrada, el tamaño de aInstanceBuffer. En el resultado, si no hay suficiente espacio para otInstance, es la cantidad de bytes necesarios para otInstance.

Qué muestra

Un puntero para la nueva instancia de OpenThread.

Consulta también:
otInstanceFinalize

otInstanceInitSingle

otInstance * otInstanceInitSingle(
  void
)

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

Esta función inicializa OpenThread y la prepara para las llamadas posteriores a la API de OpenThread. Se debe llamar a esta función antes que cualquier otra llamada a OpenThread.

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

Detalles
Qué muestra	Un puntero para la única instancia de OpenThread.

otInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

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

La instancia se considera válida si se adquiere y se inicializa mediante otInstanceInitSingle() (en el caso único) o otInstanceInit() (en el caso de instancias múltiples). Una llamada posterior a otInstanceFinalize() hace que la instancia se considere no inicializada.

Detalles

Parámetros

[in] aInstance

Un puntero para una instancia de OpenThread.

Qué muestra

VERDADERO si la instancia determinada es válida o inicializada, de lo contrario, FALSO.

otInstanceReset

void otInstanceReset(
  otInstance *aInstance
)

Este método activa el restablecimiento de la plataforma.

El proceso de restablecimiento garantiza que se borre todo el estado o la información de OpenThread (almacenado en la memoria volátil). Ten en cuenta que otPlatformReset no borra ningún estado persistente o información guardada en la memoria no volátil.

Detalles

Parámetros

[in] aInstance

Un puntero para una instancia de OpenThread.

otInstanceResetRadioStack

void otInstanceResetRadioStack(
  otInstance *aInstance
)

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

Las devoluciones de llamada y las configuraciones se conservan.

Esta API solo está disponible en compilaciones de radio (OPENTHREAD_RADIO = 1).

Detalles

Parámetros

[in] aInstance

Un puntero para 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 determinada configuración o estado dentro de OpenThread.

Detalles

Parámetros

`[in] aInstance`	Un puntero para una instancia de OpenThread.
`[in] aCallback`	Un puntero para una función que se llama con ciertos cambios de configuración o 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 cuándo cambia determinada configuración o estado dentro de OpenThread.

Detalles

Parámetros

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

Valores de retorno

`OT_ERROR_NONE`	Se agregó la devolución de llamada a la lista de devoluciones de llamada.
`OT_ERROR_ALREADY`	Ya se registró la devolución de llamada.
`OT_ERROR_NO_BUFS`	No se pudo agregar la devolución de llamada debido a restricciones de recursos.

Macros

TS_UPTIME_STRING_SIZE

 OT_UPTIME_STRING_SIZE 24

Tamaño recomendado para la representación de string de tiempo de actividad.

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.