nRF Connect SDK API 2.8.99
Loading...
Searching...
No Matches

◆ lte_lc_psm_param_set()

int lte_lc_psm_param_set ( const char * rptau,
const char * rat )

#include <include/modem/lte_lc.h>

Set modem PSM parameters.

Requested periodic TAU (RPTAU) and requested active time (RAT) are used when PSM mode is subsequently enabled using lte_lc_psm_req(). These are the requested values and network determines the final values.

For encoding of the variables, see nRF AT Commands Reference Guide, 3GPP 27.007 Ch. 7.38., and 3GPP 24.008 Ch. 10.5.7.4a and Ch. 10.5.7.3.

Note
Requires
CONFIG_LTE_LC_PSM_MODULE 
to be enabled.
Parameters
[in]rptau

Requested periodic TAU as a null-terminated 8 character long bit field string. Set to NULL to use modem's default value. See 3GPP 24.008 Ch. 10.5.7.4a for data format.

For example, value of 32400 s is represented as '00101001'.

Bits 5 to 1 represent the binary coded timer value that is multiplied by timer unit.

Bits 8 to 6 define the timer unit as follows:

  • 000: 10 minutes
  • 001: 1 hour
  • 010: 10 hours
  • 011: 2 seconds
  • 100: 30 seconds
  • 101: 1 minute
  • 110: 320 hours
Parameters
[in]rat

Requested active time as a null-terminated string. Set to NULL to use modem's default value. See 3GPP 24.008 Ch. 10.5.7.3 for data format.

For example, value of 120 s is represented as '00100010'.

Bits 5 to 1 represent the binary coded timer value that is multiplied by timer unit.

Bits 8 to 6 define the timer unit as follows:

  • 000: 2 seconds
  • 001: 1 minute
  • 010: 6 minutes
  • 111: Timer is deactivated
Return values
0if successful.
-EINVALif an input parameter was invalid.