m2m_wifi_set_sleep_mode

Synchronous power-save mode setting function for the NMC1500.

Functions
NMI_API sint8	m2m_wifi_set_sleep_mode (uint8 PsTyp, uint8 BcastEn)
	Set the power saving mode for the WILC1000. More...

NMI_API sint8 m2m_wifi_set_sleep_mode	(	uint8	PsTyp,
		uint8	BcastEn
	)

Set the power saving mode for the WILC1000.

Synchronous API to set the power-save mode of the WINC.

Set the power saving mode for the WINC3400.

Synchronous API to set the power-save mode of the WINC IC.

Set the power saving mode for the WINC1500.

Parameters

[in]	PsTyp	Desired power saving mode. Supported types are defined in tenuPowerSaveModes.
[in]	BcastEn	Broadcast reception enable flag. If it is 1, the WILC1000 must be awake each DTIM Beacon for receiving Broadcast traffic. If it is 0, the WILC1000 will not wakeup at the DTIM Beacon, but its wakeup depends only on the the configured Listen Interval.

Returns

The function SHALL return 0 for success and a negative value otherwise.

See Also

tenuPowerSaveModes

Warning

The function called once after initialization.

Parameters

[in]	PsTyp	Desired power saving mode. Supported types are defined in tenuPowerSaveModes.
[in]	BcastEn	Broadcast reception enable flag. If it is 1, the WILC1000 must be awake each DTIM beacon for receiving broadcast traffic. If it is 0, the WILC1000 will not wakeup at the DTIM beacon, but its wakeup depends only on the the configured Listen Interval.

See Also

tenuPowerSaveModes m2m_wifi_get_sleep_mode

Returns

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

Parameters

[in]	PsTyp	Desired power saving mode. Supported types are defined in tenuPowerSaveModes.
[in]	BcastEn	Broadcast reception enable flag. If it is 1, the WINC1500 must be awake each DTIM Beacon for receiving Broadcast traffic. If it is 0, the WINC1500 will not wakeup at the DTIM Beacon, but its wakeup depends only on the the configured Listen Interval.

Returns

The function SHALL return 0 for success and a negative value otherwise.

See Also

tenuPowerSaveModes

Warning

The function called once after initialization.

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 (see @ref 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.

Parameters

[in]	PsTyp	Desired power saving mode. Supported types are enumerated in tenuPowerSaveModes.
[in]	BcastEn	Broadcast reception enable flag. If it is 1, the WINC will be awake for each DTIM beacon in order to check for and receive broadcast traffic. If it is 0, the WINC will ignore broadcast traffic. Through this flag the WINC will not wakeup at the DTIM beacon, but instead it will wakeup only based on the configured Listen Interval.

Warning

The function called once after initialization.

Returns

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

See Also

tenuPowerSaveModes m2m_wifi_get_sleep_mode m2m_wifi_set_lsn_int

Parameters

[in]	PsTyp	Desired power saving mode. Supported types are defined in tenuPowerSaveModes.
[in]	BcastEn	Broadcast reception enable flag. If it is 1, the WINC3400 must be awake each DTIM Beacon for receiving Broadcast traffic. If it is 0, the WINC3400 will not wakeup at the DTIM Beacon, but its wakeup depends only on the the configured Listen Interval.

Returns

The function SHALL return 0 for success and a negative value otherwise.

See Also

tenuPowerSaveModes

Warning

The function called once after initialization.

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 (see @ref 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.

Parameters

[in]	PsTyp	Desired power saving mode. Supported types are enumerated in tenuPowerSaveModes.
[in]	BcastEn	Broadcast reception enable flag. If set to 1, the WINC will wake for each DTIM beacon to ensure broadcast traffic can be received. If set to 0, the WINC will not wakeup at the DTIM beacon, ignoring broadcast traffic, instead it will wake every N beacon periods, as per the negotiated Listen Interval.

Warning

The function called once after initialization.

Returns

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

See Also

tenuPowerSaveModes m2m_wifi_get_sleep_mode m2m_wifi_set_lsn_int