SNTP client configuration structure.

This structure holds the configuration parameters for the SNTP client, including server details, synchronization methods, timeouts, and various flags.

Public Attributes#

uint8_t *
server_host_name

SNTP server host name or address.

uint8_t
sntp_method

SNTP method. One of the defines from SNTP Methods.

uint16_t
sntp_timeout

SNTP operation timeout in milliseconds (ms).

uint8_t
flags

SNTP flags.

bool
smooth_sync

Set to true if smooth synchronization is required.

bool
server_from_dhcp

Set to true to request NTP server configuration from DHCP.

bool
renew_servers_after_new_ip

Set to true to refresh the server list if NTP is provided by DHCP.

Public Attribute Documentation#

server_host_name#

uint8_t* sl_sntp_client_config_t::server_host_name

SNTP server host name or address.


Definition at line 200 of file components/service/sntp/inc/sl_sntp.h

sntp_method#

uint8_t sl_sntp_client_config_t::sntp_method

SNTP method. One of the defines from SNTP Methods.


Definition at line 201 of file components/service/sntp/inc/sl_sntp.h

sntp_timeout#

uint16_t sl_sntp_client_config_t::sntp_timeout

SNTP operation timeout in milliseconds (ms).


Definition at line 202 of file components/service/sntp/inc/sl_sntp.h

flags#

uint8_t sl_sntp_client_config_t::flags

SNTP flags.

Combination of values from SNTP Flags. Note

  • Bits 1-7 are reserved. User must set them to 0.


Definition at line 203 of file components/service/sntp/inc/sl_sntp.h

event_handler#

sl_sntp_client_event_handler_t sl_sntp_client_config_t::event_handler

SNTP response handler of type sl_sntp_client_event_handler_t.


Definition at line 205 of file components/service/sntp/inc/sl_sntp.h

time_sync_notifiication_handler#

sl_sntp_set_time_sync_notification_handler_t sl_sntp_client_config_t::time_sync_notifiication_handler

Time synchronization notification handler of type sl_sntp_set_time_sync_notification_handler_t.

Note

  • This feature is currently not supported in Si917 chipsets.


Definition at line 207 of file components/service/sntp/inc/sl_sntp.h

smooth_sync#

bool sl_sntp_client_config_t::smooth_sync

Set to true if smooth synchronization is required.

Note

  • This feature is currently not supported in Si917 chipsets.


Definition at line 209 of file components/service/sntp/inc/sl_sntp.h

server_from_dhcp#

bool sl_sntp_client_config_t::server_from_dhcp

Set to true to request NTP server configuration from DHCP.

Note

  • This feature is currently not supported in Si917 chipsets.


Definition at line 211 of file components/service/sntp/inc/sl_sntp.h

renew_servers_after_new_ip#

bool sl_sntp_client_config_t::renew_servers_after_new_ip

Set to true to refresh the server list if NTP is provided by DHCP.

Note

  • This feature is currently not supported in Si917 chipsets.


Definition at line 213 of file components/service/sntp/inc/sl_sntp.h