To display only the features present on a particular device, select one or more filters from the SmartDocs bar below.
Input fields accept ENGLISH ONLY.
Queries from MX are not supported on Zebra devices running Android 11 or later. See alternative method.
StageNow - 5.8
The "SmartDocs" bar can customize this page to show only the features present on a particular Zebra device.
OSX, MX and Android version information for a device can be found in the Android Settings panel or by querying the device through ADB, EMDK or the MX CSP. More info.
The Bluetooth Manager (BluetoothMgr) controls whether a device can pair with Bluetooth peripherals such as headsets, printers and scanners that come into range, and whether the device can be "discoverable," which would enable other Bluetooth devices to initiate pairing requests with it.
Bluetooth is a short-range wireless technology operating in the 2.4 GHz ISM band that was originally intended as a replacement for serial communications cables. It has since been adopted as a standard for hands-free headsets, stereo audio, networking to PCs and connections for barcode scanners, medical equipment and other devices formerly using RS-232.
IMPORTANT: For Zebra Professional-series devices, the following Bluetooth Manager parameters require purchase of a Mobility DNA Enterprise License:
Zebra devices running Android 8.x Oreo and later come with the Zebra Bluetooth Settings (ZBS) app preinstalled. When run on a device with Bluetooth enabled, this app scans discoverable devices in the vicinity and displays their Bluetooth name, MAC address and Upper Address Part (UAP) information similar to the image shown below.
Controls whether the device can be put into "discoverable" mode by the device user. When in this mode, the device can be discovered by other Bluetooth devices, which could then attempt to pair with it. This parameter has no effect on the device's own ability to discover other devices, to initiate pairing requests with them, or to reconnect with devices it had paired with previously.
Note: For Zebra Professional-series devices, this feature requires purchase of a Mobility DNA Enterprise License. See techdocs.zebra.com/licensing.
Parm Name: AllowDiscoverability
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | Do not change | This value (or the absence of this parm from the XML) causes no change to device settings; any previously selected setting is retained. |
MX: 6.1+ Android API: 23+ |
||
1 | Enable | Enables the user to set the device as "discoverable" by other Bluetooth devices. |
MX: 6.1+ Android API: 23+ |
||
2 | Disable | Prevents the user from setting the device as discoverable by other Bluetooth devices. |
MX: 6.1+ Android API: 23+ |
Controls whether the device will be permitted to pair with newly discovered Bluetooth peripherals that come into range or only with known ("trusted") peripherals. The settings of this parameter do not effect existing device pairings.
Note: For Zebra Professional-series devices, this feature requires purchase of a Mobility DNA Enterprise License. See techdocs.zebra.com/licensing.
Parm Name: AllowPairing
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | Do not change | This value (or the absence of this parm from the XML) causes no change to device settings; any previously selected setting is retained. |
MX: 5.1+ Android API: 22+ |
||
1 | Enable | Enables the device to pair with newly discovered Bluetooth peripherals. |
MX: 5.1+ Android API: 22+ |
||
2 | Disable | Disables pairing with newly discovered Bluetooth peripherals. |
MX: 5.1+ Android API: 22+ |
||
3 | Pair only trusted devices | Allows the device to pair ONLY with known Bluetooth peripherals. |
MX: 10.2+ Android API: 27+ |
Controls whether the device will be permitted to pair with remote Bluetooth devices without requiring user confirmation. This feature is not the same as auto-pairing; it simply removes the confirmation step after device pairing has been initiated by the device user. The settings of this parameter do not effect existing device pairings.
By default, Silent Pairing Rules are in place to allow some Zebra device models to pair without user confirmation (after pairing is initiated by the user). Note: Default pairing rules for the devices listed below match by device Name only. For improved security, Zebra recommends that default rules be replaced with rules matching by device Name, Upper Address Part and/or, if supported, Remote Device PIN and/or Remote Device MAC.
*Silent pairing with the RS5100 is supported on SDM660-platform devices running Android 8.x Oreo (and later) and 8956-platform devices with the Android 7.x N (or later) LifeGuard patch.
Note: For Zebra Professional-series devices, this feature requires purchase of a Mobility DNA Enterprise License. See techdocs.zebra.com/licensing.
Parm Name: AllowSilentPairing
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | Do not change | This value (or the absence of this parm from the XML) causes no change to device settings; any previously selected setting is retained. |
MX: 7.0+ Android API: 24+ |
||
1 | Enable | Enables the device to pair with known devices without user confirmation. |
MX: 7.0+ Android API: 24+ |
||
2 | Disable | Disables silent pairing with Bluetooth devices; requires confirmation for pairing. |
MX: 7.0+ Android API: 24+ |
Controls whether the device is permitted to pair freely with other devices or if pairing is limited to a single peripheral type at a time.
Note: For Zebra Professional-series devices, this feature requires purchase of a Mobility DNA Enterprise License. See techdocs.zebra.com/licensing.
Parm Name: SinglePairing
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | Do not change | This value (or the absence of this parm from the XML) causes no change to device settings; any previously selected setting is retained. |
MX: 10.2+ Android API: 27+ |
||
1 | Enable | Enables the device to pair only with a single peripheral of a certain category at a time. |
MX: 10.2+ Android API: 27+ |
||
2 | Disable | Disables pairing restrictions, allowing the device to pair with multiple peripherals of different types. |
MX: 10.2+ Android API: 27+ |
Used to administer the list of Silent Pairing Rules on the device during the pairing process for the following features:
Note: Known as 'Silent Pairing Action' prior to MX 10.2. For Zebra Professional-series devices, this feature requires purchase of a Mobility DNA Enterprise License. See techdocs.zebra.com/licensing.
Parm Name: SilentPairingAction
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | Do nothing | This value (or the absence of this parm from the XML) causes no change to device settings; any previously selected setting is retained. |
MX: 7.0+ Android API: 24+ |
||
1 | Add/Replace Remote Device Rule | Adds a rule to the list that applies to the remote device. |
MX: 7.0+ Android API: 24+ |
||
2 | Remove Remote Device Rule | Removes the specified rule. |
MX: 7.0+ Android API: 24+ |
||
3 | Remove all Remote Device Rules | Clears the list of devices previously specified rules for Silent Pairing, including the default rules. |
MX: 7.0+ Android API: 24+ |
Controls which Bluetooth parameter is used as the Mandatory Identifier for the device. Rules based on MAC address are generally intended for individual peripherals. Rules based on device name and upper address part (UAP) are meant for peripheral categories such as headsets, printers and scanners.
See the Examples section for usage examples of this parameter.
Note: On devices running versions prior to Android 9 Pie, only the Bluetooth device name can be used.
Shown if: Silent Pairing Action is "Add Remote Device Rule" OR "Remove Remote Device Rule"
Parm Name: MandatoryIdentifier
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | Bluetooth MAC Address | Uses the Bluetooth MAC address as the device mandatory identifier. |
MX: 9.3+ Android API: 27+ |
||
1 | Bluetooth Device Name | Uses the Bluetooth device name as the device mandatory identifier. |
MX: 9.3+ Android API: 27+ |
Used to enter the name of a Bluetooth device with which to allow device pairing without requiring user confirmation. Only the Name field is required to create a Silent Pairing Rule. Optionally, device Name can be combined with Class of Device and/or Upper Address Part (UAP) of the device's MAC address to create Silent Pairing Rules with more specificity than using the device Name alone.
Input value rules:
Shown if: Mandatory Identifier is "Bluetooth Device Name" AND Silent Pairing Action is "Add/Replace Remote Device Rule" OR "Remove Remote Device Rule"
Parm Name: SilentPairingName
Requires:
- MX: 7.0+
- Android API: 24+
Used to enter the Upper Address Part (UAP) of the remote Bluetooth device's MAC address with which to allow the target device to pair without requiring user confirmation. The UAP is generally the first three bytes of the Bluetooth MAC address. Can be combined with Silent Pairing Name and (optionally) a Class of Device (CoD) to create a complete Silent Pairing Rule.
Use the Zebra Bluetooth Settings app to expose UAP and other Bluetooth device information.
Input value rules:
Shown if: Mandatory Identifier is "Bluetooth Device Name" AND Silent Pairing Action is "Add/Replace Remote Device Rule" OR "Remove Remote Device Rule"
Parm Name: SilentPairingUAP
Requires:
- MX: 7.0+
- Android API: 24+
Used to enter the Bluetooth MAC address for identifying the device. NOTE: Only the MAC address is required to create a Silent Pairing Rule.
Input value rules:
Shown if: Mandatory Identifier is "Bluetooth MAC Address" AND Silent Pairing Action is "Add/Replace Remote Device Rule" OR "Remove Remote Device Rule"
Parm Name: RemoteDeviceMAC
Requires:
- MX: 9.3+
- Android API: 28+
Controls whether the rule allows a device to pair only with devices designated as "trusted" by the AllowPairing parameter.
Shown if: Silent Pairing Action is set to "Enable"
Parm Name: IsTrustedDeviceRule
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | (unchecked) | Sets the rule to allow the device to pair with any Bluetooth peripheral regardless of its "trusted" status. |
MX: 10.2+ |
||
1 | (checked) | Sets the rule to allow the device to pair ONLY with Bluetooth peripherals designated as "trusted" using the AllowPairing parameter. |
MX: 10.2+ |
Used to select the default set of peripherals to consider when the device evaluates Silent Pairing Rules created with the Remote Device Action parameter. When "Disable All" is selected (option 1), all Bluetooth peripherals are considered when the device evaluates a Silent Pairing Rule. Under option 2, the default set of devices permissable for silent pairing starts with Zebra peripherals only, and can be further limited by additional rules.
Parm Name: SilentPairingDefaultMethod
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | Do not change | This value (or the absence of this parm from the XML) causes no change to device settings; any previously selected setting is retained. |
MX: 11.5+ Android API: 30+ |
||
1 | Disable All | Disables all silent pairing methods previously created, resetting the default to allow silent pairing with any peripheral allowed by Silent Pairing Rules. |
MX: 11.5+ Android API: 30+ |
||
2 | Enable with Zebra-defined peripherals only | Sets the default universe of allowable silent pairing peripherals to those containing a Zebra device identifier. |
MX: 11.5+ Android API: 30+ |
Controls whether the rule initiates silent pairing, which allows a device to pair with a Bluetooth peripheral without the need for user interaction.
Shown if: Silent Pairing Action is set to "Enable"
Parm Name: IsSilentPairingRule
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | (unchecked) | Sets the rule to require interaction with the device user when pairing with a Bluetooth peripheral. |
MX: 10.2+ |
||
1 | (checked) | Sets the rule to allow the device to pair with Bluetooth peripherals without device-user interaction. |
MX: 10.2+ |
Used to enter a PIN for the remote device. Zebra recommends setting a PIN of at least four (4) digits for optimum security.
Input value rules
Shown if: Is Single Pairing Rule is "checked" AND Silent Pairing Action is "Add/Replace Remote Device Rule"
Parm Name: RemoteDevicePIN
Requires:
- MX: 9.3+
- Android API: 28+
Controls whether the rule allows a device to pair with only one device of a particular single-pairing category as set by the SinglePairingCategory parameter.
Shown if: Silent Pairing Action is set to "Enable"
Parm Name: IsSinglePairingRule
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | (unchecked) | Sets the rule to allow the device to pair with all devices regardless of their pairing category. |
MX: 10.2+ |
||
1 | (checked) | Allows the device to pair ONLY with devices of a particular single-pairing category. |
MX: 10.2+ |
Used to select a category for a single pairing rule, allowing the device to pair with one Bluetooth peripheral of a particular type.
Shown if: Is Single Pairing Rule is "checked" AND Silent Pairing Action is "Add/Replace Remote Device Rule"
Parm Name: SinglePairingCategory
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
1 | Headset | Sets the rule to allow the device to pair with a Bluetooth headset. |
MX: 10.2+ |
||
2 | Scanner | Sets the rule to allow the device to pair with a Bluetooth scanner. |
MX: 10.2+ |
||
3 | Printer | Sets the rule to allow the device to pair with a Bluetooth printer. |
MX: 10.2+ |
||
4 | Payment | Sets the rule to allow the device to pair with a Bluetooth payment device. |
MX: 10.2+ |
||
5 | Dex | Sets the rule to allow the device to pair with a Bluetooth DEX communication peripheral. |
MX: 10.2+ |
||
6 | Custom_1 | Reserved for future or custom use. |
MX: 10.2+ |
||
7 | Custom_2 | Reserved for future or custom use. |
MX: 10.2+ |
||
8 | Custom_3 | Reserved for future or custom use. |
MX: 10.2+ |
||
9 | Custom_4 | Reserved for future or custom use. |
MX: 10.2+ |
||
10 | Custom_5 | Reserved for future or custom use. |
MX: 10.2+ |
Used to select an action to perform relating to information on the device about Bluetooth peripherals previously paired with the device.
Note: Not supported on devices running Android 9.x (Pie).
Parm Name: PairedDeviceAction
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | Do nothing | This value (or the absence of this parm from the XML) causes no change to device settings; any previously selected setting is retained. |
MX: 10.3+ Android API: 27+ |
||
1 | Clear All Paired Devices | Erases all information on the device relating to Bluetooth peripherals previously paired with the device. |
MX: 10.3+ Android API: 27+ |
Used to select the Action to be performed on BLE channels used for BLE data connections that are initiated by the target device.
Parm Name: BleChannelAction
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | Do not change | This value (or the absence of this parm from the XML) causes no change to device settings; any previously selected setting is retained. |
MX: 11.1+ Android API: 30+ |
||
1 | Add Rule | Allows a BLE rule for data connections initiated by the device to be added. |
MX: 11.1+ Android API: 30+ |
||
2 | Remove All Rules | Erases all rules previously stored on the device. |
MX: 11.1+ Android API: 30+ |
Used to select a rule for blocking communications over BLE channels for data connections initiated by the target device. Selected rules are added to the current list of BLE channels already blocked by previous rules, if any.
Shown if: BLE Channel Action is "Add Rule"
Parm Name: BleChannelRule
Option | Name | Description | Note | Status | Requires |
---|---|---|---|---|---|
0 | Block BLE Channels | Allows a BLE rule for data connections initiated from the device. |
MX: 11.1+ Android API: 30+ |
||
1 | Block RF-Band Based BLE Channels | Allows a BLE rule for RF-based data connections initiated from the device. |
MX: 11.1+ Android API: 30+ |
Used to enter the BLE Channel Number(s) to block. Enter multiple channels separated by commas and/or as low/high pair(s) separated by a dash. See examples below.
Input value rules
Shown if: BLE Channel Rule is "Block BLE Channels" and BLE Channel Action is "Add Rule"
Parm Name: BleChannelBlocking
Requires:
- MX: 11.1+
- Android API: 30+
Used to enter the radio frequency (RF) band or range of bands that all BLE channels are to block. Enter multiple bands separated by commas and/or as low/high pair(s) separated by a dash. See examples below.
Input value rules
Shown if: BLE Channel Rule is "Block EF-Band Based BLE Channels" and BLE Channel Action is "Add Rule"
Parm Name: BleChannelRFBlocking
Requires:
- MX: 11.1+
- Android API: 30+
Add a rule to block BLE channels 5, 7 and 15 through 20:
<wap-provisioningdoc>
<characteristic type="BluetoothMgr" version="11.1" >
<parm name="BleChannelAction" value="1"/>
<parm name="BleChannelRule" value="0"/>
<parm name="BleChannelBlocking" value="5,7,15-20"/>
</characteristic>
</wap-provisioningdoc>
Add a rule to for BLE Channels to block one individual and one RF band and one RF range of bands:
<wap-provisioningdoc>
<characteristic type="BluetoothMgr" version="11.1" >
<parm name="BleChannelAction" value="1"/>
<parm name="BleChannelRule" value="1"/>
<parm name="BleChannelRfBlocking" value="2412,2456-2467"/>
</characteristic>
</wap-provisioningdoc>
Add a silent pairing rule with a PIN when the Mandatory Identifier is Bluetooth MAC address:
<wap-provisioningdoc>
<characteristic type="BluetoothMgr" version="10.0" >
<parm name="AllowPairing" value="1"/>
<parm name="AllowDiscoverability" value="1"/>
<parm name="AllowSilentPairing" value="1"/>
<parm name="SilentPairingAction" value="1"/>
<parm name="MandatoryIdentifier" value="0"/>
<characteristic type="SilentPairingDeviceDetails">
<parm name="RemoteDeviceMAC" value="12:AB:34:CD:56:EF"/>
<parm name="RemoteDevicePIN" value="12345"/>
</characteristic>
</characteristic>
</wap-provisioningdoc>
Add a silent pairing rule with a PIN when the Mandatory Identifier is Name:
<wap-provisioningdoc>
<characteristic type="BluetoothMgr" version="10.0" >
<parm name="AllowPairing" value="1"/>
<parm name="AllowDiscoverability" value="1"/>
<parm name="AllowSilentPairing" value="1"/>
<parm name="SilentPairingAction" value="1"/>
<parm name="MandatoryIdentifier" value="1"/>
<characteristic type="SilentPairingDeviceDetails">
<parm name="SilentPairingName" value="ZQ320"/>
<parm name="RemoteDevicePIN" value="0000"/>
</characteristic>
</characteristic>
</wap-provisioningdoc>
<wap-provisioningdoc>
<characteristic type="BluetoothMgr" version="5.0">
<parm name="AllowPairing" value="1"/>
</characteristic>
</wap-provisioningdoc>
<wap-provisioningdoc>
<characteristic type="BluetoothMgr" version="5.0">
<parm name="AllowPairing" value="1"/>
</characteristic>
</wap-provisioningdoc>
If the operation was successful, the Result XML (output) will be identical to the input XML, as above.
<wap-provisioningdoc>
<characteristic type="BluetoothMgr" version="5.0">
<parm name="AllowPairing" value="2"/>
</characteristic>
</wap-provisioningdoc>
<wap-provisioningdoc>
<characteristic type="BluetoothMgr" version="5.0">
<parm name="AllowPairing" value="2"/>
</characteristic>
</wap-provisioningdoc>
If the operation was successful, the Result XML (output) will be identical to the input XML, as above.
Queries are not supported on Zebra devices running Android 11 or later.
<wap-provisioningdoc>
<characteristic type="BluetoothMgr">
<parm-query name="AllowSilentPairing"/>
</characteristic>
</wap-provisioningdoc>
<wap-provisioningdoc>
<characteristic type="BluetoothMgr" version="7.1">
<parm name="AllowSilentPairing" value="1"/>
</characteristic>
</wap-provisioningdoc>
<wap-provisioningdoc>
<characteristic type="BluetoothMgr" version="7.0" >
<parm name="AllowPairing" value="1"/>
<parm name="AllowDiscoverability" value="1"/>
<parm name="AllowSilentPairing" value="1"/>
<parm name="SilentPairingAction" value="1"/>
<characteristic type="SilentPairingDeviceDetails">
<parm name="SilentPairingName" value="TC51"/>
<parm name="SilentPairingCoD" value="524"/>
<parm name="SilentPairingUAP" value="40:83:DE"/>
</characteristic>
</characteristic>
</wap-provisioningdoc>
<wap-provisioningdoc>
<characteristic type="BluetoothMgr">
<parm name="SilentPairingAction" value="3"/>
</characteristic>
</wap-provisioningdoc>
<wap-provisioningdoc>
<characteristic type="BluetoothMgr">
<parm name="SilentPairingAction" value="1"/>
<characteristic type="SilentPairingDeviceDetails">
<parm name="SilentPairingName" value="DS3578"/>
</characteristic>
</characteristic>
<characteristic type="BluetoothMgr">
<parm name="SilentPairingAction" value="1"/>
<characteristic type="SilentPairingDeviceDetails">
<parm name="SilentPairingName" value="DS3678"/>
</characteristic>
</characteristic>
<characteristic type="BluetoothMgr">
<parm name="SilentPairingAction" value="1"/>
<characteristic type="SilentPairingDeviceDetails">
<parm name="SilentPairingName" value="RS6000"/>
</characteristic>
</characteristic>
<characteristic type="BluetoothMgr">
<parm name="SilentPairingAction" value="1"/>
<characteristic type="SilentPairingDeviceDetails">
<parm name="SilentPairingName" value="RS507"/>
</characteristic>
</characteristic>
<characteristic type="BluetoothMgr">
<parm name="SilentPairingAction" value="1"/>
<characteristic type="SilentPairingDeviceDetails">
<parm name="SilentPairingName" value="HS3100"/>
</characteristic>
</characteristic>
<characteristic type="BluetoothMgr">
<parm name="SilentPairingAction" value="1"/>
<characteristic type="SilentPairingDeviceDetails">
<parm name="SilentPairingName" value="DX30"/>
</characteristic>
</characteristic>
<characteristic type="BluetoothMgr">
<parm name="SilentPairingAction" value="1"/>
<characteristic type="SilentPairingDeviceDetails">
<parm name="SilentPairingName" value="PAR-TMD"/>
</characteristic>
</characteristic>
<characteristic type="BluetoothMgr">
<parm name="SilentPairingAction" value="1"/>
<characteristic type="SilentPairingDeviceDetails">
<parm name="SilentPairingName" value="DS8178"/>
</characteristic>
</characteristic>
<characteristic type="BluetoothMgr">
<parm name="SilentPairingAction" value="1"/>
<characteristic type="SilentPairingDeviceDetails">
<parm name="SilentPairingName" value="LI3678"/>
</characteristic>
</characteristic>
<characteristic type="BluetoothMgr">
<parm name="SilentPairingAction" value="1"/>
<characteristic type="SilentPairingDeviceDetails">
<parm name="SilentPairingName" value="DS2278"/>
</characteristic>
</characteristic>
</wap-provisioningdoc>