Instância
Este módulo inclui funções que controlam a instância OpenThread.
Resumo
Typedefs | |
---|---|
otChangedFlags | typedefuint32_t Este tipo representa um campo de bits que indica o estado / configuração específica que mudou. |
otInstance | typedefstruct otInstance Esta estrutura representa a estrutura da instância OpenThread. |
otStateChangedCallback )(otChangedFlags aFlags, void *aContext) | typedefvoid(* Este ponteiro de função é chamado para notificar certas configurações ou mudanças de estado no OpenThread. |
Funções | |
---|---|
otGetRadioVersionString ( otInstance *aInstance) | const char * Esta função obtém a string de versão de rádio OpenThread. |
otGetVersionString (void) | const char * Esta função obtém a string de versão do OpenThread. |
otInstanceErasePersistentInfo ( otInstance *aInstance) | Esta função apaga todas as informações persistentes do OpenThread (configurações de rede) armazenadas na memória não volátil. |
otInstanceFactoryReset ( otInstance *aInstance) | void Este método exclui todas as configurações armazenadas na memória não volátil e, a seguir, dispara a redefinição da plataforma. |
otInstanceFinalize ( otInstance *aInstance) | void Esta função desativa a biblioteca OpenThread. |
otInstanceGetUptime ( otInstance *aInstance) | uint64_t Esta função retorna o tempo de atividade da instância atual (em ms). |
otInstanceGetUptimeAsString ( otInstance *aInstance, char *aBuffer, uint16_t aSize) | void Esta função retorna o tempo de atividade da instância atual como uma string legível por humanos. |
otInstanceInit (void *aInstanceBuffer, size_t *aInstanceBufferSize) | Esta função inicializa a biblioteca OpenThread. |
otInstanceInitSingle (void) | Esta função inicializa a única instância estática da biblioteca OpenThread. |
otInstanceIsInitialized ( otInstance *aInstance) | bool Esta função indica se a instância é válida / inicializada ou não. |
otInstanceReset ( otInstance *aInstance) | void Este método aciona uma reinicialização da plataforma. |
otInstanceResetRadioStack ( otInstance *aInstance) | void Este método redefine os estados internos da pilha de rádio OpenThread. |
otRemoveStateChangeCallback ( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext) | void Esta função remove um retorno de chamada para indicar quando determinada configuração ou estado muda no OpenThread. |
otSetStateChangedCallback ( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext) | Esta função registra um retorno de chamada para indicar quando certa configuração ou estado muda dentro do OpenThread. |
Enumerações
enum anônimo
anonymous enum
Essa enumeração define sinalizadores que são passados como parte de otStateChangedCallback
.
Typedefs
otChangedFlags
uint32_t otChangedFlags
Este tipo representa um campo de bits que indica o estado / configuração específica que mudou.
Veja OT_CHANGED_*
definições.
otInstance
struct otInstance otInstance
Esta estrutura representa a estrutura da instância OpenThread.
otStateChangedCallback
void(* otStateChangedCallback)(otChangedFlags aFlags, void *aContext)
Este ponteiro de função é chamado para notificar certas configurações ou mudanças de estado no OpenThread.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
Funções
otGetRadioVersionString
const char * otGetRadioVersionString( otInstance *aInstance )
Esta função obtém a string de versão de rádio OpenThread.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Devoluções | Um ponteiro para a versão de rádio OpenThread. |
otGetVersionString
const char * otGetVersionString( void )
Esta função obtém a string de versão do OpenThread.
Detalhes | |
---|---|
Devoluções | Um ponteiro para a versão OpenThread. |
otInstanceErasePersistentInfo
otError otInstanceErasePersistentInfo( otInstance *aInstance )
Esta função apaga todas as informações persistentes do OpenThread (configurações de rede) armazenadas na memória não volátil.
Erase é bem sucedida somente se o dispositivo está em disabled
estado / papel.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
| ||||
Valores Retornados |
|
otInstanceFactoryReset
void otInstanceFactoryReset( otInstance *aInstance )
Este método exclui todas as configurações armazenadas na memória não volátil e, a seguir, dispara a redefinição da plataforma.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
otInstanceFinalize
void otInstanceFinalize( otInstance *aInstance )
Esta função desativa a biblioteca OpenThread.
Chame esta função quando o OpenThread não estiver mais em uso.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
otInstanceGetUptime
uint64_t otInstanceGetUptime( otInstance *aInstance )
Esta função retorna o tempo de atividade da instância atual (em ms).
Esta função requer OPENTHREAD_CONFIG_UPTIME_ENABLE
para ser ativado.
O tempo de atividade é fornecido em milissegundos desde que a instância OpenThread foi inicializada.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Devoluções | O tempo de atividade (número de milissegundos). |
otInstanceGetUptimeAsString
void otInstanceGetUptimeAsString( otInstance *aInstance, char *aBuffer, uint16_t aSize )
Esta função retorna o tempo de atividade da instância atual como uma string legível por humanos.
Esta função requer OPENTHREAD_CONFIG_UPTIME_ENABLE
para ser ativado.
A string segue o formato "
Se a string resultante não se encaixa em aBuffer
(dentro de seus aSize
caracteres), o texto será truncado, mas a corda outputted é sempre terminada em null.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
otInstanceInit
otInstance * otInstanceInit( void *aInstanceBuffer, size_t *aInstanceBufferSize )
Esta função inicializa a biblioteca OpenThread.
Esta função inicializa OpenThread e o prepara para chamadas subsequentes de API OpenThread. Esta função deve ser chamada antes de qualquer outra chamada para OpenThread.
Esta função está disponível e só pode ser usada quando o suporte para várias instâncias do OpenThread está ativado.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
| ||||
Devoluções | Um ponteiro para a nova instância OpenThread. |
otInstanceFinalize
otInstanceInitSingle
otInstance * otInstanceInitSingle( void )
Esta função inicializa a única instância estática da biblioteca OpenThread.
Esta função inicializa OpenThread e o prepara para chamadas subsequentes de API OpenThread. Esta função deve ser chamada antes de qualquer outra chamada para OpenThread.
Esta função está disponível e só pode ser usada quando o suporte para várias instâncias do OpenThread está desabilitado.
Detalhes | |
---|---|
Devoluções | Um ponteiro para a única instância OpenThread. |
otInstanceIsInitialized
bool otInstanceIsInitialized( otInstance *aInstance )
Esta função indica se a instância é válida / inicializada ou não.
A instância é considerada válida se for adquirido e inicializado usando otInstanceInitSingle()
(caso em instância única) ou otInstanceInit()
(em vários casos exemplo). Uma chamada subsequente para otInstanceFinalize()
faz com que o exemplo deve ser considerado como não inicializada.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Devoluções | TRUE se a instância fornecida é válida / inicializada, FALSE caso contrário. |
otInstanceReset
void otInstanceReset( otInstance *aInstance )
Este método aciona uma reinicialização da plataforma.
O processo de reinicialização garante que todo o estado / informação do OpenThread (armazenado na memória volátil) seja apagado. Note que o otPlatformReset
não apaga qualquer persistente estado / info salvos na memória não-volátil.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
otInstanceResetRadioStack
void otInstanceResetRadioStack( otInstance *aInstance )
Este método redefine os estados internos da pilha de rádio OpenThread.
Retornos de chamada e configurações são preservados.
Esta API só está disponível sob rádio constrói ( OPENTHREAD_RADIO = 1
).
Detalhes | |||
---|---|---|---|
Parâmetros |
|
otRemoveStateChangeCallback
void otRemoveStateChangeCallback( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext )
Esta função remove um retorno de chamada para indicar quando determinada configuração ou estado muda no OpenThread.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
otSetStateChangedCallback
otError otSetStateChangedCallback( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext )
Esta função registra um retorno de chamada para indicar quando certa configuração ou estado muda dentro do OpenThread.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||
Valores Retornados |
|
Macros
OT_UPTIME_STRING_SIZE
OT_UPTIME_STRING_SIZE 24
Tamanho recomendado para representação de string de tempo de atividade.
Recursos
Tópicos OpenThread API Referência originam a partir do código fonte, disponível no GitHub . Para mais informações, ou para contribuir para a nossa documentação, consulte Recursos .