Cellular Manager

EMDK For Android - 5.0

Overview

The Cellular Manager controls the way a device's cellular data connection is used, and is supported only on Zebra Android devices equipped with a Wireless Wide Area Network (WWAN) adapter that can 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 at will. The term "Usage" would be like a cover over the switch, usurping all access. When Usage of an option has been Disabled, the cover is closed, and the position of the switch cannot be changed programmatically or by the user. Enabling Usage lifts the cover, and lets the user (or an app) make Cellular features active or inactive.

Main Functionality

Enable/Disable (control Usage of):
- Data Roaming
- Background Data
- SIM Slot Selection
Turn On/Off (control State of):
- Data Roaming
- Background Data
Select SIM Slot

Select SIM Socket

Used to select which SIM card will be used to connect the device to the carrier network.

Parm Name: SimSocketSelect

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

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 programmatically or by the device user.

Parm Name: SimSocketUsage

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

Option

Name

Description

Requires

Do not change

This value (or the absence of this parm from the XML) will cause no change to user control over SIM Socket selection; any previously selected setting will be retained.

OSX: 6.2+

MX: 6.2+

Enable

Enables the device user to control which SIM Socket is used.

OSX: 6.2+

MX: 6.2+

Disable

Prevents the user from changing the selected SIM Socket.

OSX: 6.2+

MX: 6.2+

Data Roaming Enable/Disable

Used to control whether the device user has access to the Data Roaming option on the device. When Disabled, Data Roaming cannot be turned on or off programmatically or by the device user.

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, which can be significant.

Parm Name: DataRoamingUsage

Option	Name	Description	Requires
0	Do not change	This value (or the absence of this parm from the XML) will cause no change to usage of the Data Roaming Option; any previously selected setting will be retained.	OSX: 4.4+ MX: 4.4+
1	Enable	Enables Data Roaming to be used on the device and its state (active/inactive) to be controlled programmatically or by the device user.	OSX: 4.4+ MX: 4.4+
2	Disable	Disables Data Roaming on the device, preventing its state (active/inactive) from being controlled programmatically or by the device user.	OSX: 4.4+ MX: 4.4+

Option

Name

Description

Requires

Do not change

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

OSX: 4.4+

MX: 4.4+

Enable

Enables Data Roaming to be used on the device and its state (active/inactive) to be controlled programmatically or by the device user.

OSX: 4.4+

MX: 4.4+

Disable

Disables Data Roaming on the device, preventing its state (active/inactive) from being controlled programmatically or by the device user.

OSX: 4.4+

MX: 4.4+

Data Roaming Turn 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.

Parm Name: DataRoamingState

Option	Name	Description	Requires
0	Do not change	This value (or the absence of this parm from the XML) will cause no change to the current state of the Data Roaming; any previously selected setting will be retained.	MX: 4.3+ Android API Level: 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 Level: 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 Level: 17+

Option

Name

Description

Requires

Do not change

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

MX: 4.3+

Android API Level: 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 Level: 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 Level: 17+

Background Data Enable/Disable

Used to control whether the device user has access to the Background Data option on the device. When Disabled, Background Data cannot be turned on or off programmatically or by the device user.

The Background Data Option determines whether applications that are not in the foreground should be 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. The convenience of having data ready "when it's asked for" must be considered when planning for cellular bandwidth utilization and weighed against the potential for data overage and roaming costs.

Parm Name: BackgroundDataUsage

Option	Name	Description	Requires
0	Do not change	This value (or the absence of this parm from the XML) will cause no change to user control over usage of the Background Data Option; any previously selected setting will be retained.	OSX: 4.4+ MX: 4.4+
1	Enable	Enables Background Data to be used on the device and its state (active/inactive) to be controlled programmatically or by the device user.	OSX: 4.4+ MX: 4.4+
2	Disable	Disables Background Data from being used on the device and prevents its state (active/inactive) from being controlled programmatically or by the device user.	OSX: 4.4+ MX: 4.4+

Option

Name

Description

Requires

Do not change

This value (or the absence of this parm from the XML) will cause no change to user control over usage of the Background Data Option; any previously selected setting will be retained.

OSX: 4.4+

MX: 4.4+

Enable

Enables Background Data to be used on the device and its state (active/inactive) to be controlled programmatically or by the device user.

OSX: 4.4+

MX: 4.4+

Disable

Disables Background Data from being used on the device and prevents its state (active/inactive) from being controlled programmatically or by the device user.

OSX: 4.4+

MX: 4.4+

Background Data Blocking On/Off

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

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) will cause no change to the state of Background Data blocking; any previously selected setting will be 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

Requires

Do not change

This value (or the absence of this parm from the XML) will cause no change to the state of Background Data blocking; any previously selected setting will be 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+

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>