Config glossary (Mason OS 6)
phone
config_enableDataRoaming
os.configuration.phone.config_enableDataRoaming
Flag indicating whether or not to enable data roaming. NOTE: This configuration is enabled by default. You should be aware of pricing and policies related to data roaming for your connectivity plan.
Types: boolean
Default: true
system
config_boot_on_power
os.configuration.system.config_boot_on_power
Allows the device to boot to Mason OS on power instead of staying at charger mode. The device will boot after a safe battery threshold. This threshold is device dependent. If disabled, the device will boot to charger mode.
Types: boolean
config_usb_host_enabled
os.configuration.system.config_usb_host_enabled
Sets the device to enable or disable the USB host. 0 - Disables the USB host from connecting to external devices. The USB port will serve as a charge-only port 1 - Enables the USB host to connect to external devices. Note: adb connection to PC is not controlled by this config. By default adb connection is disabled and the access can be prevented by disabling access to it in Settings
Types: integer, string (0[xX][0-9a-fA-F]8)
Default: 1
config_recovery_factory_reset_enabled
os.configuration.system.config_recovery_factory_reset_enabled
Sets the device to enable or disable the "Wipe cache partition" and "Wipe Data/Factory reset" options on the recovery menu. If disabled, the options will not be visible or executable. By default it is enabled, showing the options on the recovery menu and allowing their execution.
Types: integer, string (0[xX][0-9a-fA-F]8)
Default: 1
config_btstack_ble_local_privacy_enabled
os.configuration.system.config_btstack_ble_local_privacy_enabled
Enables(1) or disables(0) support for BLE local privacy. If enabled, resolvable private address (Bluetooth Core Specification Version 4.2, Volume 6, Part B, Section 1.3.2.2) will be used. If disabled, public device address (Bluetooth Core Specification Version 4.2, Volume 6, Part B, Section 1.3.1) will be used.
Types: integer, string (0[xX][0-9a-fA-F]8)
Default: 1
android
config_wifiOnly
os.configuration.android.config_wifiOnly
Controls whether the device should only use wifi connectivity. If set to true the device will ignore cellular network and use only wifi. If set to false and cellular conectivity is avaiable, the device will be able to use both.
Types: boolean
config_sms_capable
os.configuration.android.config_sms_capable
Flag indicating whether the current device allows sms service. If true, this means that the device supports both sending and receiving sms via the telephony network. This can be overridden to false for "data only" devices which can't send and receive sms message. Note: Disable SMS also disable voicemail waiting sms, cell broadcasting sms, and MMS. Note: This configuration is not applicable when using Mason's connectivity, but would be if you use your own data/SIMs with this support.
Types: boolean
config_noHomeScreen
os.configuration.android.config_noHomeScreen
True if the device has no home screen. That is a launcher activity where the user can launch other applications from.
Types: boolean
config_single_volume
os.configuration.android.config_single_volume
Flag indicating whether all audio streams should be mapped to one single stream. If true, all audio streams are mapped to STREAM_MUSIC as if it's on TV platform.
Types: boolean
config_voice_capable
os.configuration.android.config_voice_capable
Flag indicating whether the current device is voice capable. If true, this means that the device supports circuit-switched(i.e. voice) phone calls over the telephony network, and is allowed to display the in-call UI while a cellular voice call is active. This can be overridden to false for data only devices which can't make voice calls and don't support any in-call UI. Setting this flag to false also disable Mobile network settings menu and AGPS location service.
Types: boolean
Default: true
config_useFixedVolume
os.configuration.android.config_useFixedVolume
If True all media stream volume levels will be set to a fixed maximum value and the volume up and volume button presses will be ignored (you will not see the volume panel). If False all media stream volume streams are adjustable individually and the volume up and volume down buttons control the master volume. Today, we do not have the option to set the fixed volume level to something other than the maximum.
Types: boolean
config_max_pan_devices
os.configuration.android.config_max_pan_devices
Max number of Bluetooth tethering connections allowed. If this is updated config_tether_dhcp_range has to be updated appropriately.
Types: integer, string (0[xX][0-9a-fA-F]8)
Default: 5
config_showDefaultHome
os.configuration.android.config_showDefaultHome
Whether the default home settings should be shown.
Types: boolean
Default: true
config_attentiveTimeout
os.configuration.android.config_attentiveTimeout
The time in milliseconds of prolonged user inactivity after which device goes to sleep, even if wakelocks are held.
Types: integer, string (0[xX][0-9a-fA-F]8)
Default: -1
config_allowAllRotations
os.configuration.android.config_allowAllRotations
If true, and auto-rotation is enabled, the screen can be rotated via the accelerometer in all 4 rotations as the default behavior. If false, and auto-rotation is enabled, the screen can be rotated via the accelerometer in 3 directions except vertical rotation in the portrait mode. This config works effectively when auto-rotation is enabled. If auto-rotation is disabled, this config will no have effect.
Types: boolean
config_globalActionsList
os.configuration.android.config_globalActionsList
Defines the default set of global actions. Actions may still be disabled or hidden based on the current state of the device. Each item must be one of the following strings: "power" = Power off "settings" = An action to launch settings "airplane" = Airplane mode toggle "bugreport" = Take bug report, if available "silent" = silent mode "users" = list of users "restart" = restart device "emergency" = Launch emergency dialer "lockdown" = Lock down device until the user authenticates "logout" = Logout the current user
Types: array
config_lockSoundVolumeDb
os.configuration.android.config_lockSoundVolumeDb
The attenuation in dB applied to the lock/unlock sounds.
Types: integer, string (0[xX][0-9a-fA-F]8)
Default: -6
config_showNavigationBar
os.configuration.android.config_showNavigationBar
Whether a software navigation bar should be shown. NOTE: in the future this may be autodetected from the Configuration.
Types: boolean
Default: true
config_useAttentionLight
os.configuration.android.config_useAttentionLight
Set this true only if the device has separate attention and notification lights.
Types: boolean
config_built_in_sip_phone
os.configuration.android.config_built_in_sip_phone
Enables built-in SIP phone capability
Types: boolean
Default: true
config_default_dns_server
os.configuration.android.config_default_dns_server
IP address of the dns server to use if nobody else suggests one
Types: string
Default: "8.8.8.8"
config_camera_sound_forced
os.configuration.android.config_camera_sound_forced
Whether camera shutter sound is forced or not (country specific).
Types: boolean
config_dozeAlwaysOnEnabled
os.configuration.android.config_dozeAlwaysOnEnabled
Control whether the always on display mode is enabled by default. This value will be used during initialization when the setting is still null.
Types: boolean
Default: true
config_screenBrightnessDim
os.configuration.android.config_screenBrightnessDim
By default, when the user inactivity timeout elapses (per config_minimumScreenOffTimeout), the display will dim to 10% before transitioning to sleep mode. Setting this configuration defines the dim level of this low-power mode, as a percentage. For example, to set the display to dim to 50% of max value, you can use config_screenBrightnessDim: 50
Types: integer, string (0[xX][0-9a-fA-F]8)
Default: 10
config_supportAutoRotation
os.configuration.android.config_supportAutoRotation
If true, enables auto-rotation features using the accelerometer. Otherwise, auto-rotation is disabled. Applications may still request to use specific orientations but the sensor is ignored and sensor-based orientations are not available. Furthermore, all auto-rotation related settings are omitted from the system UI. In certain situations we may still use the accelerometer to determine the orientation, such as when docked if the dock is configured to enable the accelerometer.
Types: boolean
Default: true
config_deskDockKeepsScreenOn
os.configuration.android.config_deskDockKeepsScreenOn
Control whether being in the desk dock (and powered) always keeps the screen on. By default it stays on when plugged in to AC. 0 will not keep it on; or together 1 to stay on when plugged in to AC and 2 to stay on when plugged in to USB. (So 3 for both.)
Types: integer, string (0[xX][0-9a-fA-F]8)
Default: 1
config_emergency_call_number
os.configuration.android.config_emergency_call_number
The phone number that is automatically dialed when the emergency call is initiated. To make emergency calls, Twilios Programmable Voice product are required
Types: string
Default: "112"
config_enableScreenshotChord
os.configuration.android.config_enableScreenshotChord
If this is true, key chords can be used to take a screenshot on the device.
Types: boolean
Default: true
config_navBarInteractionMode
os.configuration.android.config_navBarInteractionMode
Controls the navigation bar interaction mode: 0: 3 button mode (back, home, overview buttons) 1: 2 button mode (back, home buttons + swipe up for overview) 2: gestures only for back, home and overview
Types: integer, string (0[xX][0-9a-fA-F]8)0
config_lowBatteryWarningLevel
os.configuration.android.config_lowBatteryWarningLevel
Display low battery warning when battery level dips to this value
Types: integer, string (0[xX][0-9a-fA-F]8)
Default: 15
config_quickSettingsSupported
os.configuration.android.config_quickSettingsSupported
Whether the device supports quick settings and its associated APIs
Types: boolean
Default: true
config_sendAudioBecomingNoisy
os.configuration.android.config_sendAudioBecomingNoisy
Flag indicating whether the AUDIO_BECOMING_NOISY notification should be sent during a change to the audio output device.
Types: boolean
Default: true
config_minimumScreenOffTimeout
os.configuration.android.config_minimumScreenOffTimeout
Sets the minimum user inactivity timeout, in milliseconds. It will determine how soon the device will go to sleep when there is no user activity. You can change this user inactivity timeout period by passing an integer value (representing ms). For example, config_minimumScreenOffTimeout: 3600000 will keep the display on for 60 minutes. The entire range of values that can be passed with this configuration is 60000-2147483647. The maximum value that can be set is 2147483647 (~597 hours), which effectively is indefinite.
Types: integer, string (0[xX][0-9a-fA-F]8)
Default: 10000
config_defaultNotificationLedOn
os.configuration.android.config_defaultNotificationLedOn
Default LED on time for notification LED in milliseconds.
Types: integer, string (0[xX][0-9a-fA-F]8)
Default: 500
config_enableLockScreenRotation
os.configuration.android.config_enableLockScreenRotation
Disable lockscreen rotation by default
Types: boolean
config_intrusiveNotificationLed
os.configuration.android.config_intrusiveNotificationLed
Is the notification LED intrusive? Used to decide if there should be a disable option
Types: boolean
config_longPressOnPowerBehavior
os.configuration.android.config_longPressOnPowerBehavior
Control the behavior when the user long presses the power button. A long power press event is defined to be 500ms. 0 - Nothing 1 - Global actions menu (define the global action menu using config_globalActionsList) 2 - Power off (with confirmation) 3 - Power off (without confirmation) 4 - Go to voice assist 5 - Go to assistant (Settings.Secure.ASSISTANT) 100 - Send a broadcast with action "com.bymason.platform.LONG_PRESS_POWER" To disable the power button, use the configuration config_longPressOnPowerBehavior: 0
Types: integer, string (0[xX][0-9a-fA-F]8)
Default: 1
config_supportMicNearUltrasound
os.configuration.android.config_supportMicNearUltrasound
Whether the default microphone audio source supports near-ultrasound frequencies (range of 18 - 21 kHz).
Types: boolean
Default: true
config_safe_media_volume_enabled
os.configuration.android.config_safe_media_volume_enabled
Whether safe headphone volume is enabled or not (country specific).
Types: boolean
Default: true
config_shortPressOnPowerBehavior
os.configuration.android.config_shortPressOnPowerBehavior
Controls the behavior when the user short presses the power button.
Value | Behavior when the power button is pressed |
0 | Do nothing; presses are completely ignored. The device does not go to sleep or into doze mode. |
1 (default) | This is the system default. This will cause the device to go to sleep, but not before going through a doze mode phase. |
2 | This will cause the device to skip Android's doze mode and go directly to sleep. |
3 | This will cause the device to skip Android's doze more and go directly to sleep. This will also cause the launcher application to be brought to the foreground. |
100 | Do nothing and send a broadcast with action "com.bymason.platform.SHORT_PRESS_POWER". |
Types: integer, string (0[xX][0-9a-fA-F]8)
Default: 1
config_disableLockscreenByDefault
os.configuration.android.config_disableLockscreenByDefault
Is the lock-screen disabled for new users by default
Types: boolean
config_criticalBatteryWarningLevel
os.configuration.android.config_criticalBatteryWarningLevel
Display low battery warning when battery level dips to this value. Valid values are in the interval from [0,99].
Types: integer, string (0[xX][0-9a-fA-F]8)
Default: 5
config_enableNewAutoSelectNetworkUI
os.configuration.android.config_enableNewAutoSelectNetworkUI
Whether the new Auto Selection Network UI should be shown
Types: boolean
config_useDevInputEventForAudioJack
os.configuration.android.config_useDevInputEventForAudioJack
When true use the linux /dev/input/event subsystem to detect the switch changes on the headphone/microphone jack. When false use the older uevent framework.
Types: boolean
Default: true
config_screenBrightnessSettingDefault
os.configuration.android.config_screenBrightnessSettingDefault
Note: This setting is deprecated, please use config_screenBrightnessSettingDefaultFloat instead
Types: integer, string (0[xX][0-9a-fA-F]8)
Default: 102
config_screenBrightnessSettingMaximum
os.configuration.android.config_screenBrightnessSettingMaximum
Note: This setting is deprecated, please use config_screenBrightnessSettingMaximumFloat instead
Types: integer, string (0[xX][0-9a-fA-F]8)
Default: 255
config_screenBrightnessSettingMinimum
os.configuration.android.config_screenBrightnessSettingMinimum
Note: This setting is deprecated, please use config_screenBrightnessSettingMinimumFloat instead
Types: integer, string (0[xX][0-9a-fA-F]8)
Default: 10
config_supportBluetoothPersistedState
os.configuration.android.config_supportBluetoothPersistedState
If True, on device boot, the Bluetooth radio will be set to its state before powering down. If False, on any device boot, the Bluetooth radio will be disabled, requiring user/app intervention to turn it on. The BT radio can be toggled on/off in either scenario by a user/app after its initial state.
Types: boolean
Default: true
config_handleVolumeKeysInWindowManager
os.configuration.android.config_handleVolumeKeysInWindowManager
Handle volume keys directly in Window Manager without passing them to the foreground app
Types: boolean
config_nonBlockableNotificationPackages
os.configuration.android.config_nonBlockableNotificationPackages
An array of packages for which notifications cannot be blocked. Should only be used for core device functionality that must not be rendered inoperative for safety reasons, like the phone dialer and SMS handler.
Types: array
config_cameraDoubleTapPowerGestureEnabled
os.configuration.android.config_cameraDoubleTapPowerGestureEnabled
If True double click on the power button is used as a shortcut to launch the camera application. If False double click the power button is ignored and the shortcut is disabled.
Types: boolean
Default: true
config_supportLongPressPowerWhenNonInteractive
os.configuration.android.config_supportLongPressPowerWhenNonInteractive
If this is true, long press on power button will be available from the non-interactive state
Types: boolean
settings
config_screen_timeout
os.configuration.settings.config_screen_timeout
User activity timeout: Screen off timeout in milliseconds. Sets a value for the Settings.System#SCREEN_OFF_TIMEOUT
setting which determines how soon the device will go to sleep when there is no user activity. This value must be greater than zero, otherwise the device will use Settings.System#SCREEN_OFF_TIMEOUT
default setting 1 min (60000 milliseconds). If the value is shorter than config_minimumScreenOffTimeout, the device will use config_minimumScreenOffTimeout, default 10 seconds(10000 milliseconds). If the value is longer than 3 hours, the device will use max 3 hours (10800000 milliseconds).
Types: integer, string (0[xX][0-9a-fA-F]8)
Default: -1
config_default_tile_list
os.configuration.settings.config_default_tile_list
A listing of all the default dashboard tiles, overlay this resource to remove the tiles. Allowed values are: "about", "accessibility", "accounts", "apps_and_notifications", "battery", "connected_devices", "display", "location", "network", "privacy", "security", "sounds", "storage", "system", "support", "airplane", "bluetooth", "cellular", and "wifi". By default, config_default_tile_list contains all the default tiles, meaning that none of the system settings are hidden from the end user. Passing specific parameters with this configuration will whitelist these system settings and they will be accessible by the device. For example, using config_default_tile_list: [about, wifi] will enable the two system settings "About" and "WiFi" and all other system settings will be grayed out. Quick Settings tiles, when the status bar tray is expanded by pulling down from the top of the device, is also controlled by this config. This config controls the access to the tiles and not the state of the resource. As an example, if GPS/location is on by default, then it can only be turned off if you allow end users into location settings that can disable it.
Types: array
config_disableAndroidStartTitle
os.configuration.settings.config_disableAndroidStartTitle
Enable/disable the android start title. The default value is "false". If "true", the android start title is hidden.
Types: boolean
config_customizeAndroidStartTitle
os.configuration.settings.config_customizeAndroidStartTitle
Customize the android start title. If the config is set to any other string, the android start title is shown as the set string. The maximum visible size of the input string is 32 characters. So the input string should not exceed 32 characters including spaces. If the input string exceeds 32 characters, it will be only shown up to 32 characters.
Types: string
systemui
config_showEmergencyButton
os.configuration.systemui.config_showEmergencyButton
If True the emergency call button will be visible from the keyguard. If False the emergency call button will be removed from the keyguard. To make emergency calls, Twilios Programmable Voice product are required
Types: boolean
Default: true
config_keyguardShowLeftAffordance
os.configuration.systemui.config_keyguardShowLeftAffordance
Show mic or phone affordance on Keyguard
Types: boolean
config_quickSettingsTilesEditable
os.configuration.systemui.config_quickSettingsTilesEditable
Whether or not to enable QuickSettings options deletion, addition or rearrange.
Types: boolean
Default: true
config_showDeviceMonitoredWarning
os.configuration.systemui.config_showDeviceMonitoredWarning
Whether or not to show the device monitored warning in QuickSettings and Keyguard.
Types: boolean
Default: true
config_lockScreenShowNotifications
os.configuration.systemui.config_lockScreenShowNotifications
Whether to show notifications on the lock scren at all, overrides all other settings
Types: boolean
Default: true
config_keyguardShowCameraAffordance
os.configuration.systemui.config_keyguardShowCameraAffordance
Show camera affordance on Keyguard
Types: boolean
mason-core
config_xray_notify
os.configuration.mason-core.config_xray_notify
Whether to show a persistent notification while an X-Ray session is active
Types: boolean
Default: true
config_xray_enabled
os.configuration.mason-core.config_xray_enabled
Whether to enable the Mason X-Ray remote access feature. Can be turned off by using: config_xray_enabled: false
Types: boolean
Default: true
config_log_tag_silent
os.configuration.mason-core.config_log_tag_silent
List of <tag>s that will be invisible in the log output. Where <tag> is a log component tag. For example: [mm-camera, CAM_PhotoModule]
Types: array
config_log_buffer_size
os.configuration.mason-core.config_log_buffer_size
If specified, will set the size of the log buffer in KB. By default use system value. Min value: 64. Max value: 256.
Types: integer, string (0[xX][0-9a-fA-F]8)
Default: -1
config_location_polling
os.configuration.mason-core.config_location_polling
If True the device will report device location (if available) to the Mason platform with a frequency defined by config_locate_check_frequency. If False the device will never report device location to the Mason platform and location will be unavailable in the Mason Controller.
Types: boolean
Default: true
config_locate_check_frequency
os.configuration.mason-core.config_locate_check_frequency
By default, the device reports its location to the Mason platform after the device boots, and every 24 hours when continuously powered on. You can change the frequency of this by passing an integer value (representing hours) to this configuration. For example, config_locate_check_frequency: 5 will report its location after the device boots and every 5 hours afterwards when continuously powered on. Reporting device location can be turned off by setting config_location_polling: false
Types: integer, string (0[xX][0-9a-fA-F]8)
Default: 24
config_destructive_commands_package
os.configuration.mason-core.config_destructive_commands_package
If specified, this package will be notified of destructive commands sent from the platform. Destructive commands include: REFURBISH, WIPE
Types: string
config_update_install_time
os.configuration.mason-fota.config_update_install_time
Target 24-hour install time for OS updates that have been downloaded to the device. This must be in a 24-hour format, "hh:mm", where hh = 0-23 and mm = 0-60. Passing a value of -1 (default) instructs the device to attempt a system update install as soon as it is downloaded. For example, if you want the device to attempt a system update install at 8:00 AM (device time), use config_update_install_time: 08:00.
Types: string
Default: "-1"
mason-fota
config_prompt_timeout_count
os.configuration.mason-fota.config_prompt_timeout_count
The time (in seconds) a user has before the pending update runs automatically from the update prompt.
Types: integer, string (0[xX][0-9a-fA-F]8)
Default: 60
config_install_prompt_package
os.configuration.mason-fota.config_install_prompt_package
Normally, OTA updates (for both project configurations as well as the operating system itself) are installed automatically by the system based upon the rules specified in the mason-fota
section of the project configuration YML. When the OTA is about to be installed, the device displays a dialog box with a countdown indicating as such. There may be instances where such a prompt may be inappropriate or undesirable (for instance, a tablet used in a healthcare setting should not reboot and update itself while in use). This configuration allows you to specify the package name of an application that will instead be responsible for being notified of and subsequently initiating OTA installations. If the package name represents a valid application currently on the device, that application will receive an intent broadcast from the system when it is time for an OTA installation. The broadcast action will be com.bymason.platform.INSTALL_UPDATE and the intent will contain a string extra named target_uuid
which must be saved for later use. It is then up to the application specified to communicate when it is ready to do the installation by using the Mason Framework SDK FotaManagerPrivileged class method, requestInstall(target_uuid). Notes: - The intent is sent just prior to when the system would have normally attempted an automatic installation. Hence, any install times or check frequencies specified in the 'mason-fota' section of the YML will still be in effect. - If this package name does not resolve to a valid application, the system will default to the usually configured behavior defined by 'mason-fota' section. - There should only ever be a single system update, so whenever a new target_uuid is provided via broadcast action, any previous one may be discarded. - Once requestInstall(target_uuid) is called, the target_uuid should be discarded.
- If target_uuid is empty or omitted, the system reverts to the default OTA installation behavior.
Types: string
config_update_check_frequency
os.configuration.mason-fota.config_update_check_frequency
The frequency for which to check for updates from boot, default is 24 hours
Types: integer, string (0[xX][0-9a-fA-F]8)
Default: 24
config_update_check_when_idle
os.configuration.mason-fota.config_update_check_when_idle
When true, only performs update checks when the device is idle. Note that this is incompatible with and will override config_update_check_backoff_period.
Types: boolean
config_update_check_network_type
os.configuration.mason-fota.config_update_check_network_type
NETWORK_TYPE_ANY The default update check network type, allows checks over any network Constant Value: 1 (0x00000001) NETWORK_TYPE_UNMETERED The update check requires network connectivity that is unmetered. Constant Value: 2 (0x00000002) NETWORK_TYPE_NOT_ROAMING The update check requires network connectivity that is not roaming. Constant Value: 3 (0x00000003)
Types: integer, string (0[xX][0-9a-fA-F]8)
Default: 1
config_default_connection_timeout
os.configuration.mason-fota.config_default_connection_timeout
The default connection timeout for the mason endpoint
Types: integer, string (0[xX][0-9a-fA-F]8)
Default: 60
config_update_check_when_charging
os.configuration.mason-fota.config_update_check_when_charging
When true, only performs update checks when the device is charging
Types: boolean
config_allow_download_over_metered
os.configuration.mason-fota.config_allow_download_over_metered
When true, performs application downloads over a metered network
Types: boolean
Default: true
config_update_check_backoff_period
os.configuration.mason-fota.config_update_check_backoff_period
The exponential backoff period in hours for a failed update check. Defaults to 5 hours. This configuration has no effect when config_update_check_when_idle is set to true.
Types: integer, string (0[xX][0-9a-fA-F]8)
Default: 5
config_show_download_in_downloads_ui
os.configuration.mason-fota.config_show_download_in_downloads_ui
When true, shows the applications downloads in the downloads ui of the OS
Types: boolean
config_update_prompt_prior_to_install
os.configuration.mason-fota.config_update_prompt_prior_to_install
If True,the user will be prompted with a countdown dialog box prior to a system install. The timeout is defined by config_prompt_timeout_count (default 60 seconds). If False, the user will not be prompt with a countdown dialog box. System update installation will start immediately once available.
Types: boolean
Default: true
config_update_install_battery_threshold
os.configuration.mason-fota.config_update_install_battery_threshold
Minimum battery level (as percentage) required for an update to be installed.
Types: integer, string (0[xX][0-9a-fA-F]8)
Default: 20
config_show_download_progress_as_notification
os.configuration.mason-fota.config_show_download_progress_as_notification
When true, shows the application download progress as a persistent notification
Types: boolean
mason-management
disable_camera
os.configuration.mason-management.disable_camera
If True, access to the system camera is disabled. The action will be blocked if the user attempts to open the camera application. If False, access to the system camera is enabled. If set to True, you should also set config_cameraDoubleTapPowergestureEnabled: false
Types: boolean
hidden_packages
os.configuration.mason-management.hidden_packages
When a package is hidden it is unavailable for use, but the data and actual package file remain.
Types: array
disable_keyguard
os.configuration.mason-management.disable_keyguard
If set to True, the default lockscreen (swipe to unlock) will be disabled. Upon first boot after deploying the config, the device will still display the swipe lock screen only once. However, the lock screen will be no longer displayed subsequently after it was dismissed. When used in conjunction with 'direct_boot_package' and 'disable_keyguard,' the specified application will open directly after a device reboot, eliminating the need for an intermediate screen (keyguard/lock screen). If set to 'False,' upon device boot or wake-up, the keyguard (default lock screen) will be displayed first, requiring the user to swipe up before accessing the Mason OS. Note: If the user set a pin or pattern or password and fingerprint, this config will not disable that type of keyguard.
Types: boolean
disable_status_bar
os.configuration.mason-management.disable_status_bar
If True, the status will not be accessible system-wide. Pulling down from the top of the device will not render the status bar. If False, the status bar will be accessible by pulling down from the top of the device.
Types: boolean
lock_task_packages
os.configuration.mason-management.lock_task_packages
A white-list of package names of applications that can be pinned to the screen via context.setLockTaskMode() or via lockTaskMode in the manifest. For use by customers.
Types: array
config_global_proxy
os.configuration.mason-management.config_global_proxy
Value indicating the network-independent global HTTP proxy of the type specified config_global_proxy_type
. See the documentation for config_global_proxy_type
for more information.
Types: string
direct_boot_package
os.configuration.mason-management.direct_boot_package
The package name of the application to directly launch upon boot.
NOTES:
- The package name must refer to a valid Android application that follows the standard Android mechanism to mark a single "launchable" activity in its manifest.
- If this package is allowlisted in
lock_task_packages
, the application will run in lock task mode.
Types: string
cert_installer_package
os.configuration.mason-management.cert_installer_package
The package name of the app to be set as a certificate installer.
Types: string
config_adb_public_keys
os.configuration.mason-management.config_adb_public_keys
List of ADB public keys that should be added to the system. This can be used to pre-authorize keys for known users. Removing a value here does not remove it from Android automatically.
Types: array
disable_screen_capture
os.configuration.mason-management.disable_screen_capture
If True, all device screen capture actions will be blocked locally and remotely, including using Mason Xray remote control and screen capture features. If False, sreen capture and screen sharing capabilities are enabled on the device.
Types: boolean
enable_ble_peripherals
os.configuration.mason-management.enable_ble_peripherals
Flag indicating third party bluetooth peripheral support state. Default state would be 'true'. To disable this feature, set this flag to 'false'.
Types: boolean
Default: true
config_global_proxy_type
os.configuration.mason-management.config_global_proxy_type
Sets a network-independent global HTTP proxy of a given type. This is useful for general internal/corporation-wide filtering scenarios. On a private network where the proxy is NOT accessible for any reason, this could break HTTP on a device. This value is ignored if config_global_proxy
is not set. Allowed values are: 'direct' - Specifies a direct proxy via host and port. It requires specification of config_global_proxy
and parses the latter as host[:port]
'pac' - This is used to specify proxy auto-config (PAC). It requires specification of config_global_proxy
and parses the latter as a URL to a PAC file. 'none' - This is the same as not specifying this configuration at all. The value of config_global_proxy
, if set, is ignored. This is the default. NOTE: Typical HTTP proxies are generally network dependent. This setting is not on a per-network basis, but rather has a global effect. NOTE 2: This proxy is only a recommendation and it is possible that some apps, especially native apps or those that use custom HTTP client implementations will ignore it. @see https://developer.android.com/reference/android/app/admin/DevicePolicyManager#setRecommendedGlobalProxy(android.content.ComponentName,%20android.net.ProxyInfo)
@see https://developer.mozilla.org/en-US/docs/Web/HTTP/Proxy_servers_and_tunneling/Proxy_Auto-Configuration_(PAC)_file
Types: string
Default: "none"
default_keyboard_package
os.configuration.mason-management.default_keyboard_package
The package name of the keyboard to set as the default keyboard.
NOTES:
- The package name must refer to a valid Android application that follows the standard Android mechanism for declaring input methods.
- The package must be included in the app section as part of the config. See apps for how an Android application is included into the software build.
Types: string
enable_ime_with_hard_keyboard
os.configuration.mason-management.enable_ime_with_hard_keyboard
Flag indicating whether the soft input keyboard must be shown when a text input field is in focus even when an external keyboard is connected (such as an external Bluetooth hardware keyboard or a Bluetooth barcode scanner that uses the input device profile.)
Types: boolean
config_auto_date_time_auto_time_zone
os.configuration.mason-management.config_auto_date_time_auto_time_zone
Set this value to 1 to enable auto Date and auto TimeZone or 0 for manual set up in the Provisioning Wizard or Settings. If this config is not set, it will keep the default system behavior. While this config is set, it still can be overwritten by manual operation from Settings.
Types: integer, string (0[xX][0-9a-fA-F]8)
Default: -1
autogrant_runtime_permissions_packages
os.configuration.mason-management.autogrant_runtime_permissions_packages
Android does not always grant all permissions requested by an application in its Android manifest. For instance, runtime permissions (or permissions marked as "development") are never granted automatically. A common development-time workaround is to assign such permissions to applications via adb shell pm grant <pkg> <perm>
. This configuration value specifies an array of package names of apps that wish to be granted such permissions automatically without requiring the use of adb
. Note that each of the applications corresponding to the packages indicated below must specify each of these permissions also within their manifest (AndroidManifest.xml) for this to work correctly. Use with care as this allows for privilege escalation.
Types: array
default_runtime_permissions_grant_policy
os.configuration.mason-management.default_runtime_permissions_grant_policy
Sets the default permission grant policy for future runtime permission requests by apps that are installed either via config deployments, app deployments or adb
. Allowed values are: 'autogrant': Permission policy to always grant new permission requests for runtime permissions (without restricted runtime permissions). Already granted or denied permissions are not affected. 'autodeny' : Permission policy to always deny new permission requests for runtime permissions (without restricted runtime permissions). Already granted or denied permissions are not affected. 'prompt' : Permission policy to always prompt the user for new permission requests for runtime permissions. Already granted or denied permissions are not affected. NOTE: If this configuration key is omitted or has an invalid value, it defaults to 'prompt'. See also: autogrant_runtime_permissions_packages
Types: string
Default: "prompt"
config_allow_install_from_unknown_sources
os.configuration.mason-management.config_allow_install_from_unknown_sources
Flag indicating whether or not to allow installation of apps from unknown sources
Types: boolean
mason-app-updater
config_update_install_time
os.configuration.mason-app-updater.config_update_install_time
Target 24 hour install time for application updates that have been downloaded. (needs to be between 0-23 for the hour and 0-60 for the minute, delimited with a colon or -1 for immediate install after update check)
Types: string
Default: "-1"
config_update_check_at_boot
os.configuration.mason-app-updater.config_update_check_at_boot
When true, performs an update check for all the packages at boot up regardless of other policies.
Types: boolean
Default: true
config_update_check_polling
os.configuration.mason-app-updater.config_update_check_polling
When true, performs polling update checks as defined by the config_update_check_frequency
Types: boolean
Default: true
config_update_check_frequency
os.configuration.mason-app-updater.config_update_check_frequency
The frequency for which to check for updates from boot, default is 24 hours
Types: integer, string (0[xX][0-9a-fA-F]8)
Default: 24
config_update_check_when_idle
os.configuration.mason-app-updater.config_update_check_when_idle
When true, only performs update checks when the device is idle. Note that this is incompatible with and will override config_update_check_backoff_period.
Types: boolean
config_update_check_network_type
os.configuration.mason-app-updater.config_update_check_network_type
NETWORK_TYPE_ANY The default update check network type, allows checks over any network Constant Value: 1 (0x00000001) NETWORK_TYPE_UNMETERED The update check requires network connectivity that is unmetered. Constant Value: 2 (0x00000002) NETWORK_TYPE_NOT_ROAMING The update check requires network connectivity that is not roaming. Constant Value: 3 (0x00000003)
Types: integer, string (0[xX][0-9a-fA-F]8)
Default: 1
config_default_connection_timeout
os.configuration.mason-app-updater.config_default_connection_timeout
The default connection timeout for the mason endpoint
Types: integer, string (0[xX][0-9a-fA-F]8)
Default: 60
config_update_check_when_charging
os.configuration.mason-app-updater.config_update_check_when_charging
When true, only performs update checks when the device is charging
Types: boolean
config_allow_download_over_metered
os.configuration.mason-app-updater.config_allow_download_over_metered
When true, performs application downloads over a metered network
Types: boolean
Default: true
config_update_check_backoff_period
os.configuration.mason-app-updater.config_update_check_backoff_period
The exponential backoff period in hours for a failed update check. Defaults to 5 hours. This configuration has no effect when config_update_check_when_idle is set to true.
Types: integer, string (0[xX][0-9a-fA-F]8)
Default: 5
config_show_download_in_downloads_ui
os.configuration.mason-app-updater.config_show_download_in_downloads_ui
When true, shows the applications downloads in the downloads ui of the OS
Types: boolean
config_update_install_battery_threshold
os.configuration.mason-app-updater.config_update_install_battery_threshold
Minimum battery level (as percentage) required for an update to be installed when the device is not plugged to a power source.
Types: integer, string (0[xX][0-9a-fA-F]8)
Default: 20
config_show_download_progress_as_notification
os.configuration.mason-app-updater.config_show_download_progress_as_notification
When true, shows the application download progress as a persistent notification
Types: boolean
cellbroadcastreceiver
config_disable_all_cell_broadcast_alerts
os.configuration.cellbroadcastreceiver.config_disable_all_cell_broadcast_alerts
This configuration allows control over the default behavior of cell broadcast messages. If set to true
, these alerts (such as "presidential" or "storm warning" alerts) will be suppressed. The default is true
. This configuration is appropriate for devices that are not intended to be used as primary communication devices.
Types: boolean
Default: true