 |
WINC1500 IoT Software APIs
19.5.2
WINC Software API Reference Manual
|
Functions | |
| NMI_API sint8 | m2m_wifi_set_sleep_mode (uint8 PsTyp, uint8 BcastEn) |
Detailed Description
This is one of the two synchronous power-save setting functions that allow the host MCU application to tweak the system power consumption. Such tweaking can be done through one of two ways: 1) Changing the power save mode, to one of the allowed power save modes tenuPowerSaveModes. This is done by setting the first parameter 2) Configuring DTIM monitoring: Configuring beacon monitoring parameters by enabling or disabling the reception of broadcast/multicast data. this is done by setting the second parameter.
Function Documentation
◆ m2m_wifi_set_sleep_mode()
- Parameters
-
[in] PsTyp Desired power saving mode. Supported types are enumerated in tenuPowerSaveModes. [in] BcastEn Broadcast reception enable flag. If it is 1, the WINC1500 will be awake each DTIM beacon for receiving broadcast traffic. If it is 0, the WINC1500: disable broadcast traffic. Through this flag the WINC1500 will not wakeup at the DTIM beacon, but it will wakeup depends only on the the configured Listen Interval.
- Warning
- The function called once after initialization.
- 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
1.8.13