Powerkey Manager

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.

EMDK For Android - 11.0

Overview

The Power Key Manager (PowerKeyMgr) controls the functions displayed on the "Power Off" Menu, which appears after long-pressing the power key on the device. Depending on the device, such power-related functions can include Power off, Restart, Airplane Mode, Touch Panel, Safe Mode and other choices. Some Zebra products and devices also support a bug reporting feature, which is controlled by the Bug Report Manager.

Zebra Android devices support a Screen Lock Timeout (controlled by the DevAdmin CSP), which controls how long the device screen must remain off before a screen lock will appear when the display screen is turned back on. When the Power Key is used to turn the device off (as opposed letting the screen time-out) a screen lock can be required when the display screen is turned back on, even if the timeout was not reached. The PowerKeyMgr can enable or disable this functionality and control whether the device user can change this functionality using the Android Settings panel.

Note: The PowerKeyMgr controls only those features supported on a given device. Behavior of some features disabled by PowerKeyMgr varies by device. For example, a disabled "Airplane Mode" control on some devices is hidden, on others it's "grayed out," and on the MC18, MC33, MC40 and MC67 devices it appears normally but has no effect.

Main Functionality

Enable/Disable the following Power-off Menu Options:
- Power-off button
- Airplane Mode
- Touch Panel
- Safe Mode
Enable/Disable Automatic Screen Lock Settings panel option
Enable/Disable "Lock screen instantly with power key" Settings panel option

Airplane Mode Show/Hide

Controls whether the Airplane Mode control is accessible from the Power Off menu. When a device enters Airplane Mode, its Bluetooth, cellular and Wi-Fi radios are disabled; Bluetooth and Wi-Fi radios can be turned back on if desired by the user.

Note: Not supported in devices running Android 8.x Oreo or later. Display of a disabled "Airplane Mode" control varies by device. On some devices the control is hidden, on others it's "grayed out," and on the MC18, MC33, MC40 and MC67 devices it appears normally but has no effect.

Parm Name: AirPlaneMode

Option	Name	Description	Requires
0	Do not change	This value (or the absence of this parm from the XML) causes no change to Power-off Menu settings; any previously selected setting is retained.	OSX: 4.3+ NOT IN OSX 8.0 OR LATER MX: 4.3+
1	Show Menu Option	Enables Airplane Mode to be controlled from the Power Off menu.	OSX: 4.3+ NOT IN OSX 8.0 OR LATER MX: 4.3+
2	Do not show Menu Option	Prevents Airplane Mode from being controlled from the Power Off menu (see NOTE, above).	OSX: 4.3+ NOT IN OSX 8.0 OR LATER MX: 4.3+

Option

Name

Description

Note

Status

Requires

Do not change

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

OSX: 4.3+

NOT IN OSX 8.0 OR LATER

MX: 4.3+

Show Menu Option

Enables Airplane Mode to be controlled from the Power Off menu.

OSX: 4.3+

NOT IN OSX 8.0 OR LATER

MX: 4.3+

Do not show Menu Option

Prevents Airplane Mode from being controlled from the Power Off menu (see NOTE, above).

OSX: 4.3+

NOT IN OSX 8.0 OR LATER

MX: 4.3+

Power-off Button Show/Hide

Controls whether the Power-off button is displayed in the menu that appears after long-pressing the device power button.

Parm Name: PowerOffState

Option	Name	Description	Requires
0	Do not change	This value (or the absence of this parm from the XML) causes no change to the Power-off Menu; any previously selected setting is retained.	MX: 11.4+ Android API: 30+
1	Show	Enables the Power-off button to be shown after the device power key is long-pressed.	MX: 11.4+ Android API: 30+
2	Hide	Prevents the Power-off button from being shown after the device power key is long-pressed.	MX: 11.4+ Android API: 30+

Option

Name

Description

Note

Status

Requires

Do not change

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

MX: 11.4+

Android API: 30+

Show

Enables the Power-off button to be shown after the device power key is long-pressed.

MX: 11.4+

Android API: 30+

Hide

Prevents the Power-off button from being shown after the device power key is long-pressed.

MX: 11.4+

Android API: 30+

Touch Panel Show/Hide

Controls whether the Touch Panel control is displayed in the Power-off Menu on devices that support this option.

Parm Name: TouchPanel

Option	Name	Description	Requires
0	Do not change	This value (or the absence of this parm from the XML) causes no change to the Power-off Menu; any previously selected setting is retained.	MX: 5.0+
1	Show Menu Option	Enables the Touch Panel to be controlled from the Power-off Menu (if the device supports this option).	MX: 5.0+
2	Do not show Menu Option	Prevents the Touch Panel from being controlled from the Power-off Menu (if the device supports this option).	MX: 5.0+

Touch Panel Mode Show/Hide

Controls whether the Touch Panel Mode option is displayed in the Power-off Menu on devices that support this option.

Parm Name: TouchPanelMode

Option	Name	Description	Requires
0	Do not change	This value (or the absence of this parm from the XML) causes no change to the Power-off Menu; any previously selected setting is retained.	MX: 10.2+
1	Show Menu Option	Enables the Touch Panel Mode option to be controlled from the Power-off Menu (if the device supports this option).	MX: 10.2+
2	Do not show Menu Option	Prevents the Touch Panel Mode option from being controlled from the Power-off Menu (if the device supports this option).	MX: 10.2+

Automatic Screen Lock Enable/Disable

This is the On/Off switch for the Android Automatic Screen Lock feature, which can be used to force activation of the screen lock whenever the screen is shut off using the power key. When turned off, the lock screen will not appear when turning the screen on after using the power key to turn it off unless the Screen-lock Timeout Interval was exceeded.

Parm Name: AutoScreenLockState

Option	Name	Description	Requires
0	Do not change	This value (or the absence of this parm from the XML) causes no change to screen lock settings; any previously selected setting is retained.	OSX: 4.3+ MX: 4.3+
1	Turn on	Forces the screen to lock whenever the screen is turned off using the power key.	OSX: 4.3+ MX: 4.3+
2	Turn off	Prevents the screen from locking when turned off using the power key unless the Screen-lock Timeout Interval was exceeded.	OSX: 4.3+ MX: 4.3+

Option

Name

Description

Note

Status

Requires

Do not change

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

OSX: 4.3+

MX: 4.3+

Turn on

Forces the screen to lock whenever the screen is turned off using the power key.

OSX: 4.3+

MX: 4.3+

Turn off

Prevents the screen from locking when turned off using the power key unless the Screen-lock Timeout Interval was exceeded.

OSX: 4.3+

MX: 4.3+

Automatic Screen Lock Show/Hide

Controls whether the device user is allowed to use the option in the Android Settings panel to determine whether the screen always locks when the device screen is turned off using the Power Key. When automatic screen lock is enabled, the lock screen will always appear when turning the screen on after using the power key to turn it off.

Parm Name: AutoScreenLockOption

Option	Name	Description	Requires
0	Do not change	This value (or the absence of this parm from the XML) causes no change to Power-off Menu settings; any previously selected setting is retained.	OSX: 4.3+ MX: 4.3+ Android API: 23+
1	Show Menu Option	Enables the Auto Screen Lock option to be controlled from the Android Settings panel.	OSX: 4.3+ MX: 4.3+ Android API: 23+
2	Do not show Menu Option	Prevents the Auto Screen Lock option from being controlled from the Android Settings panel.	OSX: 4.3+ MX: 4.3+ Android API: 23+

Option

Name

Description

Note

Status

Requires

Do not change

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

OSX: 4.3+

MX: 4.3+

Android API: 23+

Show Menu Option

Enables the Auto Screen Lock option to be controlled from the Android Settings panel.

OSX: 4.3+

MX: 4.3+

Android API: 23+

Do not show Menu Option

Prevents the Auto Screen Lock option from being controlled from the Android Settings panel.

OSX: 4.3+

MX: 4.3+

Android API: 23+

Safe Mode Show/Hide

Controls whether the Safe Mode control is available in the Power-off Menu on devices that support this option. Safe Mode is typically used to perform troubleshooting operations that might be impeded by certain applications or services that would normally start when booting the device normally. Since booting into Safe Mode could render the operation of the device insecure and likely would impact the ability of the device to perform its production functions, it desirable under most circumstances to prevent device users from booting into Safe Mode.

Note: On TC20/TC25 devices, available only when running Android 8.x Oreo and higher.

Parm Name: SafeMode

Option	Name	Description	Requires
0	Do not change	This value (or the absence of this parm from the XML) causes no change to the Power-off Menu; any previously selected setting is retained.	OSX: 4.3+ MX: 4.3+
1	Show Menu Option	Enables Safe Mode to be controlled from the Power-off Menu (if the device supports this option).	OSX: 4.3+ MX: 4.3+
2	Do not show Menu Option	Prevents Safe Mode from being controlled from the Power-off Menu (if the device supports this option).	OSX: 4.3+ MX: 4.3+

Option

Name

Description

Note

Status

Requires

Do not change

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

OSX: 4.3+

MX: 4.3+

Show Menu Option

Enables Safe Mode to be controlled from the Power-off Menu (if the device supports this option).

OSX: 4.3+

MX: 4.3+

Do not show Menu Option

Prevents Safe Mode from being controlled from the Power-off Menu (if the device supports this option).

OSX: 4.3+

MX: 4.3+

Examples

Queries

Queries are not supported on Zebra devices running Android 11 or later.

Get Air Plane Mode

Input


<wap-provisioningdoc>
    <characteristic type="PowerKeyMgr" >
        <parm-query name="AirPlaneMode"/>
    </characteristic>
</wap-provisioningdoc>

Output


<wap-provisioningdoc>
    <characteristic type="PowerKeyMgr" version="4.3" >
        <parm name="AirPlaneMode" value="1"/>
    </characteristic>
</wap-provisioningdoc>

Get Touch Panel

Input


<wap-provisioningdoc>
    <characteristic type="PowerKeyMgr" >
        <parm-query name="TouchPanel"/>
    </characteristic>
</wap-provisioningdoc>

Output


<wap-provisioningdoc>
    <characteristic type="PowerKeyMgr" version="4.3" >
        <parm name="TouchPanel" value="1"/>
    </characteristic>
</wap-provisioningdoc>

Get Safe Mode

Input


<wap-provisioningdoc>
    <characteristic type="PowerKeyMgr" >
        <parm-query name="SafeMode"/>
    </characteristic>
</wap-provisioningdoc>

Output


<wap-provisioningdoc>
    <characteristic type="PowerKeyMgr" version="4.3" >
        <parm name="SafeMode" value="1"/>
    </characteristic>
</wap-provisioningdoc>

Get Auto Screen Lock Option

Input


<wap-provisioningdoc>
    <characteristic type="PowerKeyMgr" >
        <parm-query name="AutoScreenLockOption"/>
    </characteristic>
</wap-provisioningdoc>

Output


<wap-provisioningdoc>
    <characteristic type="PowerKeyMgr" version="4.3" >
        <parm name="AutoScreenLockOption" value="1"/>
    </characteristic>
</wap-provisioningdoc>

Get Auto Screen Lock State

Input


<wap-provisioningdoc>
    <characteristic type="PowerKeyMgr" >
        <parm-query name="AutoScreenLockState"/>
    </characteristic>
</wap-provisioningdoc>

Output


<wap-provisioningdoc>
    <characteristic type="PowerKeyMgr" version="4.3" >
        <parm name="AutoScreenLockState" value="1"/>
    </characteristic>
</wap-provisioningdoc>