Cellular Manager

Note: To display only the features present on a particular device, select one or more filters from the SmartDocs bar below.

EMDK For Xamarin - 3.0

Overview

The Cellular Manager (CellularMgr) controls the way a device's cellular data connection is used. This CSP is supported only on Zebra Android devices equipped with a Wireless Wide Area Network (WWAN) adapter with access a cellular data network. Attempts to use the CellularMgr on unsupported devices will return an error in the Result XML document.

The CellularMgr provides the ability to control the State (active/inactive) and Usage (enabled/disabled) of features. An option's "State" can be thought of as an "On/Off" switch; the feature is available to programs or the device user to make active or inactive as desired. The term "Usage" would be like a cover over the switch, locking it in its current position. When Usage of an option has been Disabled, the cover is closed, and the position of the switch cannot be changed by the user. Enabling Usage lifts the cover, and lets the user make Cellular features active or inactive.

Main Functionality

Enable/Disable (control Usage of):
- Data Roaming
- Background Data
- SIM Slot(s)
- Change the public land mobile network (PLMN)
Turn On/Off (control State of):
- Data Roaming
- Background Data
Select SIM Slot
Enter a custom cellular data limit and warning threshold

SIM Socket Selection Enable/Disable

Controls whether the device user can change the selected SIM Socket using the Select SIM Socket parameter. When Disabled, the SIM Socket cannot be selected by the device user. Supported on specific Zebra devices only.

Note: Supported only on WWAN-enabled devices with more than one SIM socket

Parm Name: SimSocketUsage

Option	Name	Description	Requires
0	Do not change	This value (or the absence of this parm from the XML) causes no change to user control over SIM Socket selection; any previously selected setting is retained.	MX: 6.2+
1	Enable	Enables the device user to control which SIM Socket is used.	MX: 6.2+
2	Disable	Prevents the user from changing the selected SIM Socket.	MX: 6.2+

Select SIM Socket

Used to select which SIM card is used to connect the device to the carrier network. Supported on specific Zebra devices only.

Note: Supported only on WWAN-enabled devices with more than one SIM socket

Parm Name: SimSocketSelect

Option	Name	Description	Requires
0	Do not change	This value (or the absence of this parm from the XML) causes no change; the previously selected SIM socket is used.	MX: 6.2+
1	SIM1	Uses SIM1 to connect the device to the carrier network.	MX: 6.2+
2	SIM2	Uses SIM2 to connect the device to the carrier network.	MX: 6.2+
3	SIM3	Uses SIM3 to connect the device to the carrier network.	MX: 6.2+
4	SIM4	Uses SIM4 to connect the device to the carrier network.	MX: 6.2+

Dual-SIM Dual Standby Enable/Disable

Controls Dual-SIM Dual Standby (DSDS) mode. When enabled, both SIMs can make or receive calls and/or be designated primary/secondary or dedicated to voice/data, etc. Disabled by default (one SIM active a time).

NOTE: Supported on SD660-platform devices with dual SIM slot. Reboot required to change setting.

Note: Supported only on WWAN-enabled SD660-platform devices with dual SIM slot. Settings changes require reboot.

Parm Name: DsdsUsage

Option	Name	Description	Requires
0	Do not change	This value (or the absence of this parm from the XML) causes no change to cellular settings; any previously selected setting is retained.	MX: 8.1+
1	Enable	Sets device to Dual-SIM, Dual Standby mode, enabling both SIMs to be active simultaneously.	MX: 8.1+
2	Disable	Sets device to Dual-SIM, Single Standby mode, which allows only one active SIM at a time (default).	MX: 8.1+

Data Roaming Enable/Disable

Controls whether the device user is permitted to change the state (active/inactive) of Data Roaming on the device. When Enabled, Data Roaming can be made active or inactive by the device user. When Disabled, the device user can view the state but cannot change it.

The Data Roaming option determines whether a device can communicate over cellular data networks other than the "home" network provided by the mobile operator with which the active SIM card is affiliated. The convenience of communicating over "foreign" networks while roaming must be weighed against the roaming charges imposed by foreign carriers.

Note: WWAN-enabled devices only

Parm Name: DataRoamingUsage

Option	Name	Description	Requires
0	Do not change	This value (or the absence of this parm from the XML) causes no change to usage of the Data Roaming Option; any previously selected setting is retained.	OSX: 4.4+ MX: 4.4+
1	Enable	Enables the device user to control the state of Data Roaming (active/inactive) on the device.	OSX: 4.4+ MX: 4.4+
2	Disable	Prevents the device user from changing the state (active/inactive) of Data Roaming on the device; state can still be controlled programmatically.	OSX: 4.4+ MX: 4.4+

Option

Name

Description

Note

Requires

Do not change

This value (or the absence of this parm from the XML) causes no change to usage of the Data Roaming Option; any previously selected setting is retained.

OSX: 4.4+

MX: 4.4+

Enable

Enables the device user to control the state of Data Roaming (active/inactive) on the device.

OSX: 4.4+

MX: 4.4+

Disable

Prevents the device user from changing the state (active/inactive) of Data Roaming on the device; state can still be controlled programmatically.

OSX: 4.4+

MX: 4.4+

Data Roaming On/Off

This is the On/Off switch for Data Roaming, which gives a device user the option of allowing cellular data connections to be established while a device is outside its "home" network.

Note: WWAN-enabled devices only

Parm Name: DataRoamingState

Option	Name	Description	Requires
0	Do not change	This value (or the absence of this parm from the XML) causes no change to the current state of the Data Roaming; any previously selected setting is retained.	MX: 4.3+ Android API: 17+
1	Turn On	Turns On Data Roaming, allowing cellular data connections while a device is outside the carrier's home network.	MX: 4.3+ Android API: 17+
2	Turn Off	Turns Off Data Roaming, preventing cellular data connections while a device is outside the carrier's home network.	MX: 4.3+ Android API: 17+

Option

Name

Description

Note

Requires

Do not change

This value (or the absence of this parm from the XML) causes no change to the current state of the Data Roaming; any previously selected setting is retained.

MX: 4.3+

Android API: 17+

Turn On

Turns On Data Roaming, allowing cellular data connections while a device is outside the carrier's home network.

MX: 4.3+

Android API: 17+

Turn Off

Turns Off Data Roaming, preventing cellular data connections while a device is outside the carrier's home network.

MX: 4.3+

Android API: 17+

Cellular Data Enable/Disable

Controls whether the device user is permitted to change the state (active/inactive) of cellular data on the device. When Enabled, cellular data can be made active or inactive by the device user. When Disabled, the device user can view the state but cannot change it.

Note: WWAN-enabled devices only

Parm Name: CellularDataUsage

Option	Name	Description	Requires
0	Do not change	This value (or the absence of this parm from the XML) causes no change to CellularMgr settings; any previously selected setting is retained.	MX: 6.3+
1	Enable	Allows the device user to change the state (active/inactive) of cellular data on the device.	MX: 6.3+
2	Disable	Prevents the device user from changing the state (active/inactive) of cellular data on the device; state can still be controlled programmatically.	MX: 6.3+

Cellular Data On/Off

This is the On/Off switch for device users or apps to control the ability to establish a cellular data connection on the device. This parameter controls only cellular data; voice and SMS messaging apps are uneffected by this setting.

Note: WWAN-enabled devices only

Parm Name: CellularDataState

Option	Name	Description	Requires
0	Do not change	This value (or the absence of this parm from the XML) causes no change to CellularMgr settings; any previously selected setting is retained.	MX: 6.3+
1	Turn On	Allows a cellular data connection to be established on the device.	MX: 6.3+
2	Turn Off	Prevents a cellular data connection from being established on the device.	MX: 6.3+

Cellular Data Limit Enable/Disable

Controls whether a limit can be placed on cellular data usage on the device. When Enabled, the device user or an app running on the device can access other parameters that turn data limiting on and off and that control the limit value (in MB per month) and the warning message displayed when the limit is reached. If this parameter is Disabled and cellular data is Enabled on the device, there is no means of limiting data usage over the cellular network, and all related parameters are inaccessible by apps or the device user.

Note: WWAN-enabled devices only

Parm Name: CellularDataLimitUsage

Option	Name	Description	Requires
0	Do not change	This value (or the absence of this parm from the XML) causes no change to CellularMgr settings; any previously selected setting is retained.	MX: 6.3+
1	Enable	Enables a limit to be set on cellular data usage and the state (active/inactive) of the limit to be controlled by the device user.	MX: 6.3+
2	Disable	Prevents a limit on cellular data usage from being set on the device.	MX: 6.3+

Cellular Data Limit On/Off

This is the On/Off switch for limiting cellular data (in MB per month) on the device, and the selector for applying the Android-default or a custom limitation. When Enabled using the Android default limit, the limit is the greater of 5GB or 1.2 times the value specified in the Cellular Data Warning Value parameter, to a maximum of 1TB. If the custom limit is selected, the limit is the value specified in the Cellular Data Limit Value parameter. Once the limit is reached, the cellular data connection is terminated until a new month begins or the restriction is lifted. If no value is specified with the Cellular Data Limit Value parameter, this parameter is ignored and the previously selected Cellular Data Limit State is retained.

Note: WWAN-enabled devices only

Shown if: Cellular Data State is set to "Enable"

Parm Name: CellularDataLimitState

Option	Name	Description	Requires
0	Do not change	This value (or the absence of this parm from the XML) causes no change to CellularMgr settings; any previously selected setting is retained.	MX: 6.3+
1	Enable and set default limit	Limits cellular data usage to the Android default value.	MX: 6.3+
2	Enable and set custom limit	Limits cellular data usage to the amount set in the Cellular Data Limit Value parameter.	MX: 6.3+
3	Disable	Prevents a limit on cellular data usage from being imposed on the device.	MX: 6.3+

Cellular Data Limit Value

Used to specify the limit (in MB per month) of cellular data usage by the device. Once the limit is reached, the cellular data connection is terminated until a new month begins or the restriction is lifted.

Parm value input rules:

Integer from 5-1048576 (5MB-1TB) corresponding to the data usage monthly limit

Note: WWAN-enabled devices only

Shown if: Cellular Data State is set to "Enable" and Cellular Data Limit State is set to "Enable and set custom limit"

Parm Name: CellularDataLimitValue

Requires:

MX: 6.3+

Cellular Data Warning

Controls whether the device user or an app running on the device can specify a threshold for cellular data usage that triggers a warning.

Note: WWAN-enabled devices only

Shown if: Cellular Data State is set to "Turn On"

Parm Name: CellularDataWarning

Option	Name	Description	Note	Requires
0	Do not change	This value (or the absence of this parm from the XML) causes no change to CellularMgr settings; any previously selected setting is retained.		MX: 6.3+
1	Set new warning	Enables a data limit warning threshold (in MB) to be specified.		MX: 6.3+

Set Cellular Data Warning

Used to specify a threshold (in MB per month) for cellular data usage after which a warning is displayed on the device.

Parm value input rules:

Integer from 5-1048576 (5MB-1TB) corresponding to the data usage limit

Note: WWAN-enabled devices only

Shown if: Cellular Data State is set to "Turn On" and Cellular Data Warning is set to "Set new warning"

Parm Name: CellularDataWarningValue

Requires:

MX: 6.3+

Background Data Enable/Disable

Controls whether the device user is permitted to change the state (active/inactive) of the background data usage on the device. When Enabled, background data can be made active or inactive by the device user. When Disabled, the device user can view the state but cannot change it.

Background data enablement determines whether applications that are not in the foreground are permitted to maintain a data connection over the cellular network (if they are capable of doing so). For example, some email applications continue to download messages while other apps are active or when the device's screen is turned off. When planning for cellular costs and bandwidth utilization, the convenience of having data ready "when it's asked for" must be weighed against the potential for data overage and roaming costs.

Note: WWAN-enabled devices only

Parm Name: BackgroundDataUsage

Option	Name	Description	Requires
0	Do not change	This value (or the absence of this parm from the XML) causes no change to CellularMgr settings; any previously selected setting is retained.	OSX: 4.4+ MX: 4.4+
1	Enable	Enables the background data state (active/inactive) to be controlled by the device user.	OSX: 4.4+ MX: 4.4+
2	Disable	Prevents the background data state (active/inactive) from being controlled by the device user; state can still be controlled programmatically.	OSX: 4.4+ MX: 4.4+

Option

Name

Description

Note

Requires

Do not change

This value (or the absence of this parm from the XML) causes no change to CellularMgr settings; any previously selected setting is retained.

OSX: 4.4+

MX: 4.4+

Enable

Enables the background data state (active/inactive) to be controlled by the device user.

OSX: 4.4+

MX: 4.4+

Disable

Prevents the background data state (active/inactive) from being controlled by the device user; state can still be controlled programmatically.

OSX: 4.4+

MX: 4.4+

Background Data Blocking On/Off

This is the On/Off switch for background data communication blocking. When On, apps are allowed to use the cellular data connection only when in the foreground, and blocked at all other times. When Off, all background-capable apps are allowed to maintain a data connection whenever they're running, even if they're not in the foreground.

Note: WWAN-enabled devices only

Shown if: Background Data Usage is set to "Enable"

Parm Name: BackgroundDataState

Option	Name	Description	Requires
0	Do not change	This value (or the absence of this parm from the XML) causes no change to CellularMgr settings; any previously selected setting is retained.	OSX: 1.3+ MX: 4.3+
1	Turn On	Prevents background-capable apps from using the cellular data connection when the app is not in the foreground.	OSX: 1.3+ MX: 4.3+
2	Turn Off	Allows background-capable apps to use the cellular data connection when in the background or the foreground.	OSX: 1.3+ MX: 4.3+

Option

Name

Description

Note

Requires

Do not change

This value (or the absence of this parm from the XML) causes no change to CellularMgr settings; any previously selected setting is retained.

OSX: 1.3+

MX: 4.3+

Turn On

Prevents background-capable apps from using the cellular data connection when the app is not in the foreground.

OSX: 1.3+

MX: 4.3+

Turn Off

Allows background-capable apps to use the cellular data connection when in the background or the foreground.

OSX: 1.3+

MX: 4.3+

Manual PLMN Enable/Disable

Controls whether the device user can change the selected public land mobile network (PLMN), such as that of a carrier network.

Note: WWAN-enabled devices only

Parm Name: ManualPlmnLock

Option	Name	Description	Requires
0	Do not change	This value (or the absence of this parm from the XML) causes no change to celular settings; any previously selected setting is retained.	MX: 8.1+
1	Enable	Enables the device user to change the selected PLMN.	MX: 8.1+
2	Disable	Prevents the user from chaging the selected PLMN.	MX: 8.1+

Manual PLMN LockSet

Used to specify the PLMN LockSet, which consists of the mobile country code (MCC) and mobile network code (MNC) numbers for use on the device. Expressed as a single five- or six-digit number (MCCMNC i.e. XXXYYY or XXXYY).

Parm value input rules:

String of 5 or 6 numerical characters

Note: WWAN-enabled devices only

Shown if: Manual PLMN Lock is set to "Enable"

Parm Name: ManualPlmnLockSet

Requires:

MX: 8.1+

PLMN Lock UI Show/Hide

Controls whether the PLMN locking switch appears in the Android Network Settings panel on the device.

Note: WWAN-enabled devices only

Parm Name: ShowPlmnLock

Option	Name	Description	Requires
0	Do not change	This value (or the absence of this parm from the XML) causes no change to cellular settings; any previously selected setting is retained.	MX: 8.1+
1	Enable	Displays the PLMN locking switch in the Android Network Settings panel.	MX: 8.1+
2	Disable	Hides the PLMN locking switch in the Android Network Settings panel.	MX: 8.1+

Examples

Turn Off Data Roaming and Background Data


<wap-provisioningdoc>
    <characteristic type="CellularMgr" version="4.3" >
        <parm name="DataRoamingState" value="2"/>
        <parm name="BackgroundDataState" value="2"/>
    </characteristic>
</wap-provisioningdoc>