Instancia
Este módulo incluye funciones que controlan la instancia de OpenThread.
Resumen
Typedefs |
|
---|---|
otChangedFlags
|
typedefuint32_t
Este tipo representa un campo de bits que indica un estado o una configuración específicos que cambiaron. |
otInstance
|
typedefstruct otInstance
Esta estructura representa la estructura de la instancia de OpenThread. |
otStateChangedCallback)(otChangedFlags aFlags, void *aContext)
|
typedefvoid(*
Se llama a este puntero de función para notificar ciertos cambios de configuración o estado dentro de 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)
|
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 borra todos los parámetros de configuración almacenados 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)
|
Esta función inicializa la biblioteca de OpenThread.
|
otInstanceInitSingle(void)
|
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 inicializa.
|
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 quita una devolución de llamada para indicar cuándo cambian ciertos parámetros de configuración o estados dentro de OpenThread.
|
otSetStateChangedCallback(otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)
|
Esta función registra una devolución de llamada para indicar cuándo cambian ciertos parámetros de configuración o estados en OpenThread.
|
Enumeraciones
enumeración anónima
anonymous enum
En esta enumeración, se definen las 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
|
Cambió el nuevo canal pendiente de Thread Manager. |
OT_CHANGED_COMMISSIONER_STATE
|
El estado de comisión 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 multidifusión IPv6. |
OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED
|
Se anuló la suscripción a una dirección multidifusión IPv6. |
OT_CHANGED_JOINER_STATE
|
Cambió el estado de la unión. |
OT_CHANGED_NETWORK_KEY
|
Se cambió la clave de red. |
OT_CHANGED_PENDING_DATASET
|
El conjunto de datos operativo pendiente cambió. |
OT_CHANGED_PSKC
|
Se cambió la PSK. |
OT_CHANGED_SECURITY_POLICY
|
Se modificó la política de seguridad. |
OT_CHANGED_SUPPORTED_CHANNEL_MASK
|
Se modificó la máscara de canal admitida. |
OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL
|
Se modificó 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ó al niño. |
OT_CHANGED_THREAD_CHILD_REMOVED
|
Se quitó al niño. |
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
|
Cambió la dirección de 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 Thread. |
OT_CHANGED_THREAD_NETIF_STATE
|
Se cambió el estado de la interfaz de red del subproceso. |
OT_CHANGED_THREAD_NETWORK_NAME
|
Se cambió el nombre de la red del subproceso. |
OT_CHANGED_THREAD_PANID
|
Se modificó el ID del PAN de la red de la conversación. |
OT_CHANGED_THREAD_PARTITION_ID
|
Se modificó el ID de partición. |
OT_CHANGED_THREAD_RLOC_ADDED
|
Se agregó RLOC. |
OT_CHANGED_THREAD_RLOC_REMOVED
|
Se quitó el RLOC. |
OT_CHANGED_THREAD_ROLE
|
Se cambió la función (inhabilitada, desconectada, secundaria, de router, líder). |
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 dentro de OpenThread.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
Funciones
otGetRadioVersionString
const char * otGetRadioVersionString( otInstance *aInstance )
Esta función obtiene la string de versión de radio de OpenThread.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
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 de borrar solo se realiza correctamente si el dispositivo tiene el estado o la función disabled
.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Valores que se muestran |
|
otInstanceFactoryReset
void otInstanceFactoryReset( otInstance *aInstance )
Este método borra todos los parámetros de configuración almacenados en la memoria no volátil y, luego, activa el restablecimiento de la plataforma.
Detalles | |||
---|---|---|---|
Parámetros |
|
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 |
|
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 muestra como una cantidad de milisegundos desde la inicialización de la instancia de OpenThread.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
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 string tiene el siguiente formato:
Si la string resultante no cabe en aBuffer
(dentro de sus caracteres aSize
), la string se truncará, pero la string resultante siempre será nula.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
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 |
|
||||
Qué muestra |
Un puntero para la nueva instancia de OpenThread.
|
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 inicializa.
La instancia se considera válida si se obtiene e inicializa con otInstanceInitSingle()
(en un caso único) o otInstanceInit()
(en casos múltiples). Una llamada posterior a otInstanceFinalize()
hace que la instancia se considere como no inicializada.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
VERDADERO si la instancia determinada es válida o inicializada, en caso contrario, es FALSO.
|
OtInstanceReset
void otInstanceReset( otInstance *aInstance )
Este método activa el restablecimiento de la plataforma.
El proceso de restablecimiento garantiza que se borre toda la información o el estado de OpenThread (almacenado en memoria volátil). Ten en cuenta que otPlatformReset
no borra ningún estado o información persistente guardado en la memoria no volátil.
Detalles | |||
---|---|---|---|
Parámetros |
|
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 |
|
otRemoveStateChangeCallback
void otRemoveStateChangeCallback( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext )
Esta función quita una devolución de llamada para indicar cuándo cambian ciertos parámetros de configuración o estados dentro de OpenThread.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
otSetStateChangedCallback
otError otSetStateChangedCallback( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext )
Esta función registra una devolución de llamada para indicar cuándo cambian ciertos parámetros de configuración o estados en OpenThread.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Valores que se muestran |
|
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 en el código fuente, disponible en GitHub. Para obtener más información o colaborar con nuestra documentación, consulta Recursos.