lte_lc_proprietary_psm_req()

int lte_lc_proprietary_psm_req

(

bool

enable

)

#include <include/modem/lte_lc.h>

Request modem to enable or disable proprietary Power Saving Mode (PSM).

The purpose of the proprietary PSM feature is to perform a PSM-like sleep when network does not allow normal PSM usage. During proprietary PSM, modem will fall to sleep in the same way than it would do if network allowed to use PSM. Sending of MO data or MO SMS will automatically wake up the modem just like if modem was in normal PSM sleep.

To use the feature, also PSM request must be enabled using

embed:rst:inline :kconfig:option:`CONFIG_LTE_PSM_REQ` 

or lte_lc_psm_req().

Refer to the AT command guide for guidance and limitations of this feature.

Note

embed:rst:inline :kconfig:option:`CONFIG_LTE_PROPRIETARY_PSM_REQ` 

can be set to enable proprietary PSM, which is generally sufficient. This option allows to enable or disable proprietary PSM after modem initialization. Calling this function for run-time control is possible, but it should be noted that conflicts may arise with the value set by

embed:rst:inline :kconfig:option:`CONFIG_LTE_PROPRIETARY_PSM_REQ` 

if it is called during modem initialization.

This feature is only supported by modem firmware versions >= v2.0.0.

Return values

0	if successful.
-EFAULT	if AT command failed.