WINC1500 IoT Software APIs: m2m_wifi_enable_sntp

WINC1500 IoT Software API

WINC1500 IoT Software APIs  19.5.2
WINC Software API Reference Manual
m2m_wifi_enable_sntp

Functions

NMI_API sint8 m2m_wifi_enable_sntp (uint8 bEnable)
 

Detailed Description

Synchronous function to enable/disable the native Simple Network Time Protocol(SNTP) client in the WINC1500 firmware.
The SNTP is enabled by default at start-up.The SNTP client at firmware is used to synchronize the system clock to the UTC time from the well known time servers (e.g. "time-c.nist.gov"). The SNTP client uses a default update cycle of 1 day. The UTC is important for checking the expiration date of X509 certificates used while establishing TLS (Transport Layer Security) connections. It is highly recommended to use it if there is no other means to get the UTC time. If there is a RTC on the host MCU, the SNTP could be disabled and the host should set the system time to the firmware using the m2m_wifi_set_system_time function.

Function Documentation

◆ m2m_wifi_enable_sntp()

NMI_API sint8 m2m_wifi_enable_sntp ( uint8  bEnable)
Parameters
[in]bEnableEnabling/Disabling flag '0' :disable SNTP '1' :enable SNTP
See also
m2m_wifi_set_sytem_time
Returns
The function returns M2M_SUCCESS for successful operations and a negative value otherwise.
Generated on Thu Jan 26 2017 22:15:21 for WINC1500 IoT Software APIs by   doxygen 1.8.13