Sincronização de horário da rede

Este módulo inclui funções que controlam o serviço de sincronização de tempo de rede.

Resumo

Enumerações

otNetworkTimeStatus{
  OT_NETWORK_TIME_UNSYNCHRONIZED = -1,
  OT_NETWORK_TIME_RESYNC_NEEDED = 0,
  OT_NETWORK_TIME_SYNCHRONIZED = 1
}
enum
Representa o status de sincronização de tempo do OpenThread.

Typedefs

otNetworkTimeStatus typedef
Representa o status de sincronização de tempo do OpenThread.
otNetworkTimeSyncCallbackFn)(void *aCallbackContext) typedef
void(*
O ponteiro é chamado quando ocorre uma sincronização de horário ou uma mudança de status da rede.

remotas

otNetworkTimeGet(otInstance *aInstance, uint64_t *aNetworkTime)
Extrai o horário da rede Thread.
otNetworkTimeGetSyncPeriod(otInstance *aInstance)
uint16_t
Mostra o período de sincronização de tempo.
otNetworkTimeGetXtalThreshold(otInstance *aInstance)
uint16_t
Acessa o limite de precisão de XTAL da sincronização de tempo para o roteador.
otNetworkTimeSetSyncPeriod(otInstance *aInstance, uint16_t aTimeSyncPeriod)
Defina o período de sincronização de tempo.
otNetworkTimeSetXtalThreshold(otInstance *aInstance, uint16_t aXTALThreshold)
Define o limite de precisão de XTAL da sincronização de tempo para dispositivo compatível com roteador.
otNetworkTimeSyncSetCallback(otInstance *aInstance, otNetworkTimeSyncCallbackFn aCallbackFn, void *aCallbackContext)
void
Defina um callback que será chamado quando ocorrer uma sincronização de horário ou uma mudança de status da rede.

Enumerações

otNetworkTimeStatus

 otNetworkTimeStatus

Representa o status de sincronização de tempo do OpenThread.

Propriedades
OT_NETWORK_TIME_RESYNC_NEEDED

O dispositivo não recebe a sincronização de tempo por mais de dois períodos.

OT_NETWORK_TIME_SYNCHRONIZED

O horário da rede do dispositivo é sincronizado.

OT_NETWORK_TIME_UNSYNCHRONIZED

O dispositivo não está conectado a uma rede.

Typedefs

otNetworkTimeStatus

enum otNetworkTimeStatus otNetworkTimeStatus

Representa o status de sincronização de tempo do OpenThread.

otNetworkTimeSyncCallbackFn

void(* otNetworkTimeSyncCallbackFn)(void *aCallbackContext)

O ponteiro é chamado quando ocorre uma sincronização de horário ou uma mudança de status da rede.

remotas

otNetworkTimeGet

otNetworkTimeStatus otNetworkTimeGet(
  otInstance *aInstance,
  uint64_t *aNetworkTime
)

Extrai o horário da rede Thread.

Detalhes
Parâmetros
[in] aInstance
A estrutura da instância do OpenThread.
[in,out] aNetworkTime
Tempo da rede Thread em microssegundos.
Retorna
O status da sincronização de tempo.

otNetworkTimeGetSyncPeriod

uint16_t otNetworkTimeGetSyncPeriod(
  otInstance *aInstance
)

Mostra o período de sincronização de tempo.

Detalhes
Parâmetros
[in] aInstance
A estrutura da instância do OpenThread.
Retorna
O período de sincronização de tempo.

otNetworkTimeGetXtalThreshold

uint16_t otNetworkTimeGetXtalThreshold(
  otInstance *aInstance
)

Acessa o limite de precisão de XTAL da sincronização de tempo para o roteador.

Detalhes
Parâmetros
[in] aInstance
A estrutura da instância do OpenThread.
Retorna
O limite de precisão XTAL para o roteador, em PPM.

otNetworkTimeSetSyncPeriod

otError otNetworkTimeSetSyncPeriod(
  otInstance *aInstance,
  uint16_t aTimeSyncPeriod
)

Defina o período de sincronização de tempo.

Só pode ser chamado enquanto os protocolos Thread estão desativados.

Detalhes
Parâmetros
[in] aInstance
A estrutura da instância do OpenThread.
[in] aTimeSyncPeriod
O período de sincronização de tempo, em segundos.
Valores de retorno
OT_ERROR_NONE
O período de sincronização de tempo foi definido.
OT_ERROR_INVALID_STATE
Os protocolos de Thread estão ativados.

otNetworkTimeSetXtalThreshold

otError otNetworkTimeSetXtalThreshold(
  otInstance *aInstance,
  uint16_t aXTALThreshold
)

Define o limite de precisão de XTAL da sincronização de tempo para dispositivo compatível com roteador.

Só pode ser chamado enquanto os protocolos Thread estão desativados.

Detalhes
Parâmetros
[in] aInstance
A estrutura da instância do OpenThread.
[in] aXTALThreshold
O limite de precisão XTAL para o roteador, em PPM.
Valores de retorno
OT_ERROR_NONE
O período de sincronização de tempo foi definido.
OT_ERROR_INVALID_STATE
Os protocolos de Thread estão ativados.

otNetworkTimeSyncSetCallback

void otNetworkTimeSyncSetCallback(
  otInstance *aInstance,
  otNetworkTimeSyncCallbackFn aCallbackFn,
  void *aCallbackContext
)

Defina um callback que será chamado quando ocorrer uma sincronização de horário ou uma mudança de status da rede.

Esse retorno de chamada será chamado apenas quando o deslocamento de horário da rede saltar em OPENTHREAD_CONFIG_TIME_SYNC_JUMP_NOTIF_MIN_US ou quando o status for alterado.

Detalhes
Parâmetros
[in] aInstance
A estrutura da instância do OpenThread.
[in] aCallbackFn
A função de callback a ser chamada
[in] aCallbackContext
O contexto a ser transmitido para a função de callback na invocação

Macros

OT_TIME_SYNC_INVALID_SEQ

 OT_TIME_SYNC_INVALID_SEQ 0

zero é considerado uma sequência de sincronização de tempo inválida.

Recursos

Os tópicos de Referência da API OpenThread são originados do código-fonte, disponível no GitHub. Para mais informações ou para contribuir com nossa documentação, consulte Recursos.