Time client APIs

Collaboration diagram for Time client APIs:

Functions
void	tr_time_client_second_tick (void)
	app should call this once per second to help the time client know when to sync time or rediscover a time master server
zb_bool_t	tr_time_client_is_time_synced (void)
	has the time been synced to a Time Master Server
zb_bool_t	tr_time_client_set_server_rediscovery_time (zb_uint16_t rediscovery_time_in_minutes)
	set the rate of Time Master Server re-discovery time, in minutes
zb_bool_t	tr_time_client_set_resync_time (zb_uint16_t resync_time_in_minutes)
	set the rate of re-synchronization with the Time Master Server, in minutes
zb_bool_t	tr_time_client_sync_time_now (void)
	cause a time re-synchronization to happen immediately
zb_bool_t	tr_time_client_discover_server_now (void)
	cause a server discovery to happen immediately
zb_bool_t	tr_time_client_set_server_addr (zb_uint16_t new_address, zb_uint8_t endpoint)
	as an alternative to discovery, the Time Master Server address can be set
zb_uint16_t	tr_time_client_get_server_addr (void)
	the current Time Master Server address can be read

Detailed Description

---

---

Function Documentation

tr_time_client_discover_server_now()

zb_bool_t tr_time_client_discover_server_now

(

void

)

cause a server discovery to happen immediately

tr_time_client_get_server_addr()

zb_uint16_t tr_time_client_get_server_addr

(

void

)

the current Time Master Server address can be read

tr_time_client_is_time_synced()

zb_bool_t tr_time_client_is_time_synced

(

void

)

has the time been synced to a Time Master Server

Returns

ZB_FALSE time is not synced

ZB_TRUE time has been synced

tr_time_client_second_tick()

void tr_time_client_second_tick

(

void

)

app should call this once per second to help the time client know when to sync time or rediscover a time master server

tr_time_client_set_resync_time()

zb_bool_t tr_time_client_set_resync_time

(

zb_uint16_t

resync_time_in_minutes

)

set the rate of re-synchronization with the Time Master Server, in minutes

Parameters

resync_time_in_minutes

the number of minutes in between a time re-sync

tr_time_client_set_server_addr()

zb_bool_t tr_time_client_set_server_addr	(	zb_uint16_t	new_address,
		zb_uint8_t	endpoint )

as an alternative to discovery, the Time Master Server address can be set

Parameters

new_address	the address to use for the Time Master Server
endpoint	the endpoint to use for the Time Master Server

tr_time_client_set_server_rediscovery_time()

zb_bool_t tr_time_client_set_server_rediscovery_time

(

zb_uint16_t

rediscovery_time_in_minutes

)

set the rate of Time Master Server re-discovery time, in minutes

Parameters

rediscovery_time_in_minutes

the number of minutes in between a rediscovery

tr_time_client_sync_time_now()

zb_bool_t tr_time_client_sync_time_now

(

void

)

cause a time re-synchronization to happen immediately