#1996 fix: check if Night Shift is supported on a device before activating to prevent the screen going black when activated

Author: sds100

CHANGELOG.md

@@ -6,7 +6,8 @@
 - #2007 Volume up/down action bottom sheet is cut off on some devices.
 - #2004 Do not crash when launching wireless debugging screen on some devices.
 - #2005 NPE in onSaveInstanceState.
-- #2000 tell the user to tap OS version or build number
+- #2000 tell the user to tap OS version or build number.
+- #1996 Check if Night Shift is supported on a device before activating to prevent the screen going black when activated.
 
 ## [4.0.0](https://github.com/sds100/KeyMapper/releases/tag/v4.0.0)
 

base/src/main/java/io/github/sds100/keymapper/base/actions/IsActionSupportedUseCase.kt

@@ -1,6 +1,7 @@
 package io.github.sds100.keymapper.base.actions
 
 import android.content.pm.PackageManager
+import android.content.res.Resources
 import android.os.Build
 import io.github.sds100.keymapper.common.utils.KMError
 import io.github.sds100.keymapper.system.SystemError
@@ -56,6 +57,18 @@ class IsActionSupportedUseCaseImpl(
             }
         }
 
+        if (id == ActionId.TOGGLE_NIGHT_SHIFT ||
+            id == ActionId.ENABLE_NIGHT_SHIFT ||
+            id == ActionId.DISABLE_NIGHT_SHIFT
+        ) {
+            // See https://cs.android.com/android/platform/superproject/+/android-latest-release:frameworks/base/core/java/android/hardware/display/ColorDisplayManager.java;l=498;drc=787314ed22d859e510163327dd6c58b215c2f7f9
+            val res = Resources.getSystem()
+            val resId = res.getIdentifier("config_nightDisplayAvailable", "bool", "android")
+            if (resId == 0 || !res.getBoolean(resId)) {
+                return KMError.NightDisplayNotSupported
+            }
+        }
+
         if (ActionUtils.getRequiredPermissions(id).contains(Permission.ROOT) &&
             !permissionAdapter.isGranted(Permission.ROOT)
         ) {

base/src/main/java/io/github/sds100/keymapper/base/utils/ErrorUtils.kt

@@ -362,6 +362,9 @@ fun KMError.getFullMessage(resourceProvider: ResourceProvider): String {
                 R.string.error_variable_flashlight_strength_unsupported,
             )
 
+        KMError.NightDisplayNotSupported ->
+            resourceProvider.getString(R.string.error_night_display_not_supported)
+
         is KMError.FailedToModifySystemSetting ->
             resourceProvider.getString(
                 R.string.error_failed_to_modify_system_setting,

base/src/main/res/values/strings.xml

@@ -817,6 +817,7 @@
     <string name="error_front_flash_not_found">No front flash</string>
     <string name="error_back_flash_not_found">No back flash</string>
     <string name="error_variable_flashlight_strength_unsupported">Variable flashlight strength unsupported</string>
+    <string name="error_night_display_not_supported">Your device doesn\'t support night display.</string>
 
     <string name="error_accessibility_service_disabled">Accessibility service needs to be enabled!</string>
     <string name="error_accessibility_service_crashed">The accessibility service needs to be restarted!</string>

common/src/main/java/io/github/sds100/keymapper/common/utils/KMResult.kt

@@ -53,6 +53,7 @@ abstract class KMError : KMResult<Nothing>() {
     data object MaxCamerasInUse : KMError()
     data object CameraError : KMError()
     data object CameraVariableFlashlightStrengthUnsupported : KMError()
+    data object NightDisplayNotSupported : KMError()
 
     data class FailedToModifySystemSetting(val setting: String) : KMError()
     data object SwitchImeFailed : KMError()