bg77::qpsmextcfg

Public Member Functions
String	set ()
String	set (int)
String	set (int, int)
String	set (int, int, unsigned int)
String	set (int, int, unsigned int, int)
String	set (int, int, unsigned int, int, int)
String	set (int, int, unsigned int, int, int, int)
String	get ()

Member Function Documentation

set() [1/7]

String set

(

)

Description

This api configures PSM, and it is mainly used to set extended parameters for modem optimizations.

Syntax

bg77.qpsmextcfg.set()

Returns

String response

set() [2/7]

String set

(

int

)

Description

This api configures PSM, and it is mainly used to set extended parameters for modem optimizations.

Syntax

bg77.qpsmextcfg.set(mask)

Parameters

mask

int Integer type. Range: 0–15. Default value: 14. 1st bit of the parameter is used to enable/disable (0: disable; 1: enable) PSM ENTER request without sending PSM_READY_REQ to NAS. This is a quick PSM operation. 2nd bit of the parameter is used to enable/disable (0: disable; 1: enable) Out of Service (OoS) status indication from Modem to AP. 3rd bit of the parameter is used to enable/disable (0: disable; 1: enable) limited service status indication from Modem to AP. 4th bit the parameter is used to enable/disable (0: disable; 1: enable) deep-sleep mode if PSM cycle is less than the threshold value. If enabled, it puts the device in deep-sleep mode, if PSM is not entered due to not meeting threshold value.

Returns

String response

set() [3/7]

String set	(	int	,
		int
	)

Description

This api configures PSM, and it is mainly used to set extended parameters for modem optimizations.

Syntax

bg77.qpsmextcfg.set(mask,max_scans)

Parameters

mask

int Integer type. Range: 0–15. Default value: 14. 1st bit of the parameter is used to enable/disable (0: disable; 1: enable) PSM ENTER request without sending PSM_READY_REQ to NAS. This is a quick PSM operation. 2nd bit of the parameter is used to enable/disable (0: disable; 1: enable) Out of Service (OoS) status indication from Modem to AP. 3rd bit of the parameter is used to enable/disable (0: disable; 1: enable) limited service status indication from Modem to AP. 4th bit the parameter is used to enable/disable (0: disable; 1: enable) deep-sleep mode if PSM cycle is less than the threshold value. If enabled, it puts the device in deep-sleep mode, if PSM is not entered due to not meeting threshold value.

max_scans

int Integer type. Maximum number of full scans to wait before modem declares SYS_PSM_STATUS_OOS to clients. Range: 1–100. Default value: 2.

Returns

String response

set() [4/7]

String set	(	int	,
		int	,
		unsigned	int
	)

Description

This api configures PSM, and it is mainly used to set extended parameters for modem optimizations.

Syntax

bg77.qpsmextcfg.set(mask,max_scans,duration)

Parameters

mask	int Integer type. Range: 0–15. Default value: 14. 1st bit of the parameter is used to enable/disable (0: disable; 1: enable) PSM ENTER request without sending PSM_READY_REQ to NAS. This is a quick PSM operation. 2nd bit of the parameter is used to enable/disable (0: disable; 1: enable) Out of Service (OoS) status indication from Modem to AP. 3rd bit of the parameter is used to enable/disable (0: disable; 1: enable) limited service status indication from Modem to AP. 4th bit the parameter is used to enable/disable (0: disable; 1: enable) deep-sleep mode if PSM cycle is less than the threshold value. If enabled, it puts the device in deep-sleep mode, if PSM is not entered due to not meeting threshold value.
max_scans	int Integer type. Maximum number of full scans to wait before modem declares SYS_PSM_STATUS_OOS to clients. Range: 1–100. Default value: 2.
duration	int Integer type. PSM cycle used by PSM daemon upon OOS/Limited Service indication, due to service outage. Range: 120–4294967295. Default value: 120. Unit: second.

Returns

String response

set() [5/7]

String set	(	int	,
		int	,
		unsigned	int,
		int
	)

Description

This api configures PSM, and it is mainly used to set extended parameters for modem optimizations.

Syntax

bg77.qpsmextcfg.set(mask,max_scans,duration,window)

Parameters

mask	int Integer type. Range: 0–15. Default value: 14. 1st bit of the parameter is used to enable/disable (0: disable; 1: enable) PSM ENTER request without sending PSM_READY_REQ to NAS. This is a quick PSM operation. 2nd bit of the parameter is used to enable/disable (0: disable; 1: enable) Out of Service (OoS) status indication from Modem to AP. 3rd bit of the parameter is used to enable/disable (0: disable; 1: enable) limited service status indication from Modem to AP. 4th bit the parameter is used to enable/disable (0: disable; 1: enable) deep-sleep mode if PSM cycle is less than the threshold value. If enabled, it puts the device in deep-sleep mode, if PSM is not entered due to not meeting threshold value.
max_scans	int Integer type. Maximum number of full scans to wait before modem declares SYS_PSM_STATUS_OOS to clients. Range: 1–100. Default value: 2.
duration	int Integer type. PSM cycle used by PSM daemon upon OOS/Limited Service indication, due to service outage. Range: 120–4294967295. Default value: 120. Unit: second.
window	int Integer type. PSM wakeup randomization window to avoid network congestion due to all the PSM devices waking up at the same time. Range: 1–1000. Default value: 5. Unit: second.

Returns

String response

set() [6/7]

String set	(	int	,
		int	,
		unsigned	int,
		int	,
		int
	)

Description

This api configures PSM, and it is mainly used to set extended parameters for modem optimizations.

Syntax

bg77.qpsmextcfg.set(mask,max_scans,duration,window,max_time)

Parameters

mask	int Integer type. Range: 0–15. Default value: 14. 1st bit of the parameter is used to enable/disable (0: disable; 1: enable) PSM ENTER request without sending PSM_READY_REQ to NAS. This is a quick PSM operation. 2nd bit of the parameter is used to enable/disable (0: disable; 1: enable) Out of Service (OoS) status indication from Modem to AP. 3rd bit of the parameter is used to enable/disable (0: disable; 1: enable) limited service status indication from Modem to AP. 4th bit the parameter is used to enable/disable (0: disable; 1: enable) deep-sleep mode if PSM cycle is less than the threshold value. If enabled, it puts the device in deep-sleep mode, if PSM is not entered due to not meeting threshold value.
max_scans	int Integer type. Maximum number of full scans to wait before modem declares SYS_PSM_STATUS_OOS to clients. Range: 1–100. Default value: 2.
duration	int Integer type. PSM cycle used by PSM daemon upon OOS/Limited Service indication, due to service outage. Range: 120–4294967295. Default value: 120. Unit: second.
window	int Integer type. PSM wakeup randomization window to avoid network congestion due to all the PSM devices waking up at the same time. Range: 1–1000. Default value: 5. Unit: second.
max_time	int Integer type. Maximum time in seconds to wait before declaring SYS_PSM_STATUS_OOS to clients. Range: 1–65535. Default value: 120. Unit: second.

Returns

String response

set() [7/7]

String set	(	int	,
		int	,
		unsigned	int,
		int	,
		int	,
		int
	)

Description

This api configures PSM, and it is mainly used to set extended parameters for modem optimizations.

Syntax

bg77.qpsmextcfg.set(mask,max_scans,duration,window,max_time,wakeup_time)

Parameters

mask	int Integer type. Range: 0–15. Default value: 14. 1st bit of the parameter is used to enable/disable (0: disable; 1: enable) PSM ENTER request without sending PSM_READY_REQ to NAS. This is a quick PSM operation. 2nd bit of the parameter is used to enable/disable (0: disable; 1: enable) Out of Service (OoS) status indication from Modem to AP. 3rd bit of the parameter is used to enable/disable (0: disable; 1: enable) limited service status indication from Modem to AP. 4th bit the parameter is used to enable/disable (0: disable; 1: enable) deep-sleep mode if PSM cycle is less than the threshold value. If enabled, it puts the device in deep-sleep mode, if PSM is not entered due to not meeting threshold value.
max_scans	int Integer type. Maximum number of full scans to wait before modem declares SYS_PSM_STATUS_OOS to clients. Range: 1–100. Default value: 2.
duration	int Integer type. PSM cycle used by PSM daemon upon OOS/Limited Service indication, due to service outage. Range: 120–4294967295. Default value: 120. Unit: second.
window	int Integer type. PSM wakeup randomization window to avoid network congestion due to all the PSM devices waking up at the same time. Range: 1–1000. Default value: 5. Unit: second.
max_time	int Integer type. Maximum time in seconds to wait before declaring SYS_PSM_STATUS_OOS to clients. Range: 1–65535. Default value: 120. Unit: second.
wakeup_time	int Integer type. Device wakes up early to account for boot-up and acquisition delay. While programming PMIC, PSM daemon reduces PSM cycle by this duration. Range: 1–1000. Default value: 3. Unit: second.

Returns

String response

get()

String get

(

)

Description

This api configures PSM, and it is mainly used to set extended parameters for modem optimizations.

Syntax

bg77.qpsmextcfg.get()

Returns

String response