lte_lc_psm_req()

int lte_lc_psm_req

(

bool

enable

)

#include <include/modem/lte_lc.h>

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

PSM parameters can be set using

embed:rst:inline :kconfig:option:`CONFIG_LTE_PSM_REQ_FORMAT` 

,

embed:rst:inline :kconfig:option:`CONFIG_LTE_PSM_REQ_RPTAU` 

,

embed:rst:inline :kconfig:option:`CONFIG_LTE_PSM_REQ_RAT` 

,

embed:rst:inline :kconfig:option:`CONFIG_LTE_PSM_REQ_RPTAU_SECONDS` 

and

embed:rst:inline :kconfig:option:`CONFIG_LTE_PSM_REQ_RAT_SECONDS` 

, or by calling lte_lc_psm_param_set() or lte_lc_psm_param_set_seconds().

Note

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

can be set to enable PSM, which is generally sufficient. This option allows explicit disabling/enabling of PSM requesting 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_PSM_REQ` 

if it is called during modem initialization.

Parameters

[in]

enable

true to enable PSM, false to disable PSM.

Return values

0	if successful.
-EFAULT	if AT command failed.