Instância
Este módulo inclui funções que controlam a instância do OpenThread.
Resumo
Typedefs |
|
---|---|
otChangedFlags
|
typedefuint32_t
Esse tipo representa um campo de bits que indica o estado/configuração específico que foi alterado. |
otInstance
|
typedefstruct otInstance
Essa estrutura representa a estrutura de instâncias do OpenThread. |
otStateChangedCallback)(otChangedFlags aFlags, void *aContext)
|
typedefvoid(*
Esse ponteiro de função é chamado para notificar determinadas configurações ou mudanças de estado no OpenThread. |
Functions |
|
---|---|
otGetRadioVersionString(otInstance *aInstance)
|
const char *
Essa função recebe a string de versão do rádio OpenThread.
|
otGetVersionString(void)
|
const char *
Essa função recebe a string de versão do OpenThread.
|
otInstanceErasePersistentInfo(otInstance *aInstance)
|
Essa 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
Esse método exclui todas as configurações armazenadas na memória não volátil e aciona a redefinição da plataforma.
|
otInstanceFinalize(otInstance *aInstance)
|
void
Essa função desativa a biblioteca OpenThread.
|
otInstanceGetUptime(otInstance *aInstance)
|
uint64_t
Essa função retorna o tempo de atividade da instância atual (em segundos).
|
otInstanceGetUptimeAsString(otInstance *aInstance, char *aBuffer, uint16_t aSize)
|
void
Essa função retorna o tempo de atividade da instância atual como uma string legível.
|
otInstanceInit(void *aInstanceBuffer, size_t *aInstanceBufferSize)
|
Essa função inicializa a biblioteca OpenThread.
|
otInstanceInitSingle(void)
|
Essa função inicializa a instância única estática da biblioteca OpenThread.
|
otInstanceIsInitialized(otInstance *aInstance)
|
bool
Essa função indica se a instância é válida ou inicializada.
|
otInstanceReset(otInstance *aInstance)
|
void
Esse método aciona uma redefinição da plataforma.
|
otInstanceResetRadioStack(otInstance *aInstance)
|
void
Esse método redefine os estados internos da pilha de rádio do OpenThread.
|
otRemoveStateChangeCallback(otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)
|
void
Essa função remove um callback para indicar quando determinadas configurações ou estados mudam no OpenThread.
|
otSetStateChangedCallback(otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)
|
Essa função registra um callback para indicar quando determinadas configurações ou estados mudam no OpenThread.
|
Enumerações
enumeração anônima
anonymous enum
Essa enumeração define sinalizações que são transmitidas como parte de otStateChangedCallback
.
Propriedades | |
---|---|
OT_CHANGED_ACTIVE_DATASET
|
O conjunto de dados operacional ativo foi alterado. |
OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL
|
O novo canal pendente da conversa do Gerenciador de canais mudou. |
OT_CHANGED_COMMISSIONER_STATE
|
Estado do comissário alterado. |
OT_CHANGED_IP6_ADDRESS_ADDED
|
O endereço IPv6 foi adicionado. |
OT_CHANGED_IP6_ADDRESS_REMOVED
|
O endereço IPv6 foi removido. |
OT_CHANGED_IP6_MULTICAST_SUBSCRIBED
|
Você assinou um endereço multicast IPv6. |
OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED
|
Cancelar a inscrição de um endereço multicast IPv6. |
OT_CHANGED_JOINER_STATE
|
Estado de mesclagem alterado. |
OT_CHANGED_NETWORK_KEY
|
Chave de rede alterada. |
OT_CHANGED_PENDING_DATASET
|
Conjunto operacional de dados pendente alterado. |
OT_CHANGED_PSKC
|
PSKc alterado. |
OT_CHANGED_SECURITY_POLICY
|
Política de segurança alterada. |
OT_CHANGED_SUPPORTED_CHANNEL_MASK
|
A máscara de canal compatível foi alterada. |
OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL
|
Configuração do roteador de backbone local alterada. |
OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE
|
Estado do roteador de backbone alterado. |
OT_CHANGED_THREAD_CHANNEL
|
O canal da rede da conversa foi alterado. |
OT_CHANGED_THREAD_CHILD_ADDED
|
O filho foi adicionado. |
OT_CHANGED_THREAD_CHILD_REMOVED
|
O filho foi removido. |
OT_CHANGED_THREAD_EXT_PANID
|
O ID do PAN estendido da rede de linhas de execução foi alterado. |
OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER
|
Sequência de chaves de linha de execução alterada. |
OT_CHANGED_THREAD_LL_ADDR
|
O endereço link-local foi alterado. |
OT_CHANGED_THREAD_ML_ADDR
|
O endereço mesh-local foi alterado. |
OT_CHANGED_THREAD_NETDATA
|
Dados da rede da conversa alterados. |
OT_CHANGED_THREAD_NETIF_STATE
|
Estado da interface de rede da linha de execução alterado. |
OT_CHANGED_THREAD_NETWORK_NAME
|
Nome da rede da conversa alterado. |
OT_CHANGED_THREAD_PANID
|
O PAN da rede de linhas de execução foi alterado. |
OT_CHANGED_THREAD_PARTITION_ID
|
O ID da partição foi alterado. |
OT_CHANGED_THREAD_RLOC_ADDED
|
RLOC adicionado. |
OT_CHANGED_THREAD_RLOC_REMOVED
|
O RLOC foi removido. |
OT_CHANGED_THREAD_ROLE
|
Função (desativada, desconectada, filha, roteador, líder) alterada. |
Typedefs
otChangedFlags
uint32_t otChangedFlags
Esse tipo representa um campo de bits que indica o estado/configuração específico que foi alterado.
Consulte as definições de OT_CHANGED_*
.
OtInstance
struct otInstance otInstance
Essa estrutura representa a estrutura de instâncias do OpenThread.
OtStateChangedCallback
void(* otStateChangedCallback)(otChangedFlags aFlags, void *aContext)
Esse ponteiro de função é chamado para notificar determinadas configurações ou mudanças de estado no OpenThread.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
Functions
OtGetRadioVersionString
const char * otGetRadioVersionString( otInstance *aInstance )
Essa função recebe a string de versão do rádio OpenThread.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
Um ponteiro para a versão de rádio do OpenThread.
|
OtGetVersionString
const char * otGetVersionString( void )
Essa função recebe a string de versão do OpenThread.
Detalhes | |
---|---|
Retorna |
Um ponteiro para a versão do OpenThread.
|
OtInstanceApagarPersistentInfo
otError otInstanceErasePersistentInfo( otInstance *aInstance )
Essa função apaga todas as informações persistentes do OpenThread (configurações de rede) armazenadas na memória não volátil.
A limpeza só será bem-sucedida se o dispositivo estiver no estado/papel disabled
.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Valores de retorno |
|
OtInstanceFactoryReset
void otInstanceFactoryReset( otInstance *aInstance )
Esse método exclui todas as configurações armazenadas na memória não volátil e aciona a redefinição da plataforma.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
OtInstanceFinal
void otInstanceFinalize( otInstance *aInstance )
Essa função desativa a biblioteca OpenThread.
Chame essa função quando OpenThread não estiver mais em uso.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
OtInstanceGetUptime
uint64_t otInstanceGetUptime( otInstance *aInstance )
Essa função retorna o tempo de atividade da instância atual (em segundos).
Esta função requer a ativação de OPENTHREAD_CONFIG_UPTIME_ENABLE
.
O tempo de atividade é fornecido como um número em milésimos de segundo desde que a instância de OpenThread foi inicializada.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
Tempo de atividade (número de milissegundos).
|
OtInstanceGetUptimeAsString
void otInstanceGetUptimeAsString( otInstance *aInstance, char *aBuffer, uint16_t aSize )
Essa função retorna o tempo de atividade da instância atual como uma string legível.
Esta função requer a ativação de OPENTHREAD_CONFIG_UPTIME_ENABLE
.
A string segue o formato "
Se a string resultante não couber no aBuffer
(dentro de caracteres aSize
), ela será truncada, mas a string resultante sempre será nula.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
OtInstanceInit
otInstance * otInstanceInit( void *aInstanceBuffer, size_t *aInstanceBufferSize )
Essa função inicializa a biblioteca OpenThread.
Essa função inicializa o OpenThread e o prepara para as próximas chamadas da API OpenThread. Essa função precisa ser chamada antes de qualquer outra chamada para o OpenThread.
Essa função está disponível e só pode ser usada quando a compatibilidade com várias instâncias do OpenThread está ativada.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Retorna |
Um ponteiro para a nova instância do OpenThread.
|
otInstanceFinalize
OtInstanceInitSingle
otInstance * otInstanceInitSingle( void )
Essa função inicializa a instância única estática da biblioteca OpenThread.
Essa função inicializa o OpenThread e o prepara para as próximas chamadas da API OpenThread. Essa função precisa ser chamada antes de qualquer outra chamada para o OpenThread.
Essa função está disponível e só pode ser usada quando o suporte para várias instâncias do OpenThread está desativado.
Detalhes | |
---|---|
Retorna |
Um ponteiro para a única instância do OpenThread.
|
OtInstanceIsInitialized
bool otInstanceIsInitialized( otInstance *aInstance )
Essa função indica se a instância é válida ou inicializada.
A instância será considerada válida se for adquirida e inicializada usando otInstanceInitSingle()
(no caso de instância única) ou otInstanceInit()
(em casos de várias instâncias). Uma chamada subsequente para otInstanceFinalize()
faz com que a instância não seja inicializada.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
TRUE se a instância especificada for válida/inicializada. Caso contrário, será FALSE.
|
OtInstanceReset
void otInstanceReset( otInstance *aInstance )
Esse método aciona uma redefinição da plataforma.
O processo de redefinição garante que todo o estado/informação do OpenThread (armazenado em memória volátil) seja apagado. O otPlatformReset
não apaga nenhum estado ou informação permanente salvo em memória não volátil.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
OtInstanceResetRadioStack
void otInstanceResetRadioStack( otInstance *aInstance )
Esse método redefine os estados internos da pilha de rádio do OpenThread.
Os callbacks e as configurações são preservados.
Essa API está disponível apenas em builds de rádio (OPENTHREAD_RADIO = 1
).
Detalhes | |||
---|---|---|---|
Parâmetros |
|
OtRemoveStateChangeCallback
void otRemoveStateChangeCallback( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext )
Essa função remove um callback para indicar quando determinadas configurações ou estados mudam no OpenThread.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
OtSetStateChangedCallback
otError otSetStateChangedCallback( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext )
Essa função registra um callback para indicar quando determinadas configurações ou estados mudam no OpenThread.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||
Valores de retorno |
|
Macros
OT_UPTIME_STRING_SIZE
OT_UPTIME_STRING_SIZE 24
Tamanho recomendado para representação de string do tempo de atividade.
Recursos
Os tópicos de referência da API OpenThread são originados do código-fonte, disponível no GitHub. Para saber mais ou contribuir com nossa documentação, consulte Recursos.