Ejemplo

Este módulo incluye funciones que controlan el OpenThread Instancia.

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 }	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_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 
 }

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ífica que ha cambiado.
`otInstance`	typedef `struct otInstance` Esta estructura representa la estructura ejemplo OpenThread.
`otStateChangedCallback )(otChangedFlags aFlags, void *aContext)`	typedef `void(*` Este puntero es llamada para notificar a ciertos cambios de configuración o estado dentro OpenThread.

funciones
`otGetRadioVersionString ( otInstance *aInstance)`	`const char *` Esta función obtiene la cadena versión de radio OpenThread.
`otGetVersionString (void)`	`const char *` Esta función obtiene la cadena de versión OpenThread.
`otInstanceErasePersistentInfo ( otInstance *aInstance)`	`otError` Esta función borra toda la información persistente del OpenThread (configuración de red) almacenado en la memoria no volátil.
`otInstanceFactoryReset ( otInstance *aInstance)`	`void` Este método elimina todos los ajustes almacenados en la memoria no volátil, y luego desencadena reinicio 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 única instancia estática de la biblioteca OpenThread.
`otInstanceIsInitialized ( otInstance *aInstance)`	`bool` Esta función indica si la instancia se inicializa / válida.
`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 cuando ciertos cambios de 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 ciertos cambios de configuración o estado dentro de OpenThread.

enumeraciones

la enumeración anónima

 anonymous enum

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

propiedades
`OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL`	Gestor de canales nueva pendiente de canal de rosca cambió.
`OT_CHANGED_COMMISSIONER_STATE`	comisión del estado cambió.
`OT_CHANGED_IP6_ADDRESS_ADDED`	se añadió dirección IPv6.
`OT_CHANGED_IP6_ADDRESS_REMOVED`	Se eliminó dirección IPv6.
`OT_CHANGED_IP6_MULTICAST_SUBSCRIBED`	Suscrito a una dirección de multidifusión IPv6.
`OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED`	De estar inscrita en una dirección de multidifusión IPv6.
`OT_CHANGED_JOINER_STATE`	Estado Joiner cambió.
`OT_CHANGED_MASTER_KEY`	llave maestra cambió.
`OT_CHANGED_PSKC`	PSKc cambió.
`OT_CHANGED_SECURITY_POLICY`	Política de Seguridad cambió.
`OT_CHANGED_SUPPORTED_CHANNEL_MASK`	máscara de canal apoyado cambió.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL`	Backbone local de configuración del router cambió.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE`	Backbone Router estado cambió.
`OT_CHANGED_THREAD_CHANNEL`	canal de la red de hilo cambió.
`OT_CHANGED_THREAD_CHILD_ADDED`	se añadió niño.
`OT_CHANGED_THREAD_CHILD_REMOVED`	Niño fue retirado.
`OT_CHANGED_THREAD_EXT_PANID`	red de hilo extendido cambió PAN ID.
`OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER`	Discussion Secuencia de teclas cambió.
`OT_CHANGED_THREAD_LL_ADDR`	La dirección de enlace local cambió.
`OT_CHANGED_THREAD_ML_ADDR`	La dirección-malla local cambió.
`OT_CHANGED_THREAD_NETDATA`	Discussion cambió de datos de red.
`OT_CHANGED_THREAD_NETIF_STATE`	Estado de interfaz de red de hilo cambió.
`OT_CHANGED_THREAD_NETWORK_NAME`	Hilo nombre de la red cambió.
`OT_CHANGED_THREAD_PANID`	red de hilo PAN ha cambiado el ID.
`OT_CHANGED_THREAD_PARTITION_ID`	ID de partición cambió.
`OT_CHANGED_THREAD_RLOC_ADDED`	se añadió RLOC.
`OT_CHANGED_THREAD_RLOC_REMOVED`	RLOC se eliminó.
`OT_CHANGED_THREAD_ROLE`	Rol (discapacitados, individual, niño, router, líder) cambiado.

typedefs

otChangedFlags

uint32_t otChangedFlags

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

Ver OT_CHANGED_* definiciones.

otInstance

struct otInstance otInstance

Esta estructura representa la estructura ejemplo OpenThread.

otStateChangedCallback

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

Este puntero es llamada para notificar a ciertos cambios de configuración o estado dentro OpenThread.

detalles

parámetros

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

funciones

otGetRadioVersionString

const char * otGetRadioVersionString(
  otInstance *aInstance
)

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

detalles

parámetros

[in] aInstance

Un puntero a una instancia 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 OpenThread.

detalles
Devoluciones	Un puntero a la versión OpenThread.

otInstanceErasePersistentInfo

 otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

Esta función borra toda la información persistente del OpenThread (configuración de red) almacenado 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 OpenThread.

Valores devueltos

`OT_ERROR_NONE`	Todo persistente información / estado se borró con éxito.
`OT_ERROR_INVALID_STATE`	El dispositivo no está en `disabled` Estado / papel.

otInstanceFactoryReset

void otInstanceFactoryReset(
  otInstance *aInstance
)

Este método elimina todos los ajustes almacenados en la memoria no volátil, y luego desencadena reinicio plataforma.

detalles

parámetros

[in] aInstance

Un puntero a una instancia OpenThread.

otInstanceFinalize

void otInstanceFinalize(
  otInstance *aInstance
)

Esta función desactiva la biblioteca OpenThread.

Llamar a esta función cuando OpenThread ya no está en uso.

detalles

parámetros

[in] aInstance

Un puntero a una instancia 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 posteriores llamadas a la API OpenThread. Esta función debe ser llamada antes de cualquier otra llamada a OpenThread.

Esta función está disponible y sólo se puede utilizar cuando está habilitado el soporte para múltiples instancias OpenThread.

detalles

parámetros

`[in] aInstanceBuffer`	El tampón para OpenThread a utilizar para la asignación de 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 OpenThread.

Ver también:
otInstanceFinalize

otInstanceInitSingle

 otInstance * otInstanceInitSingle(
  void
)

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

Esta función inicializa OpenThread y lo prepara para posteriores llamadas a la API OpenThread. Esta función debe ser llamada antes de cualquier otra llamada a OpenThread.

Esta función está disponible y sólo se puede utilizar cuando el soporte para múltiples instancias OpenThread está desactivada.

detalles
Devoluciones	Un puntero a la instancia OpenThread sola.

otInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

Esta función indica si la instancia se inicializa / válida.

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

Devoluciones

TRUE si la instancia dada es válida / inicializado, de lo contrario.

otInstanceReset

void otInstanceReset(
  otInstance *aInstance
)

Este método activa un reinicio de la plataforma.

Garantiza el proceso de restablecimiento de que todo el estado / información OpenThread (almacenada en la memoria volátil) se borran. 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 OpenThread.

otRemoveStateChangeCallback

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

Esta función elimina una devolución de llamada para indicar cuando ciertos cambios de configuración o estado dentro de OpenThread.

detalles

parámetros

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

otSetStateChangedCallback

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

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

detalles

parámetros

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

Valores devueltos

`OT_ERROR_NONE`	Se ha añadido la devolución de llamada de la lista de rellamadas.
`OT_ERROR_ALREADY`	La devolución de llamada ya estaba registrado.
`OT_ERROR_NO_BUFS`	No se pudo añadir la devolución de llamada, debido a las limitaciones de recursos.