m2m_wifi_request_sleep

Functions
NMI_API sint8	m2m_wifi_request_sleep (uint32 u32SlpReqTime)

Detailed Description

Synchronous power-save sleep request function, which requests from the WINC1500 device to sleep in the currenlty configured power save mode as defined by the m2m_wifi_set_sleep_mode, for a specific time as defined by the passed in parameter. This function should be used in the M2M_PS_MANUAL power save mode only. A wake up request is automatically performed by the WINC1500 device when any host driver API function, e.g. Wi-Fi or socket operation is called.

Function Documentation

m2m_wifi_request_sleep()

NMI_API sint8 m2m_wifi_request_sleep

(

uint32

u32SlpReqTime

)

Parameters

[in]

u32SlpReqTime

Request sleep time in ms The best recommended sleep duration is left to be determined by the application. Taking into account that if the application sends notifications very rarely, sleeping for a long time can be a power-efficient decision. In contrast applications that are senstive for long periods of absence can experience performance degradation in the connection if long sleeping times are used.

Warning

The function should be called in M2M_PS_MANUAL power save mode only. As enumerated in tenuPowerSaveModes It's also important to note that during the sleeping time while in the M2M_PS_MANUAL mode, AP beacon monitoring is bypassed and the wifi-connection may drop if the sleep period is enlongated.

See also

tenuPowerSaveModes m2m_wifi_set_sleep_mode

Returns

The function returns M2M_SUCCESS for successful operations and a negative value otherwise.