#1947 feat: show tip to use expert mode where the old option for screen off remapping used to be

Author: sds100

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 #### TO BE RELEASED
 
+## Added
+- #1947 show tip to use expert mode where the old option for screen off remapping used to be
+
 ## Bug fixes
 
 - #1955 step forward and step backward media actions support more apps.

base/src/main/java/io/github/sds100/keymapper/base/keymaps/ConfigKeyMapOptionsViewModel.kt

@@ -6,7 +6,11 @@ import io.github.sds100.keymapper.base.R
 import io.github.sds100.keymapper.base.actions.ActionUiHelper
 import io.github.sds100.keymapper.base.shortcuts.CreateKeyMapShortcutUseCase
 import io.github.sds100.keymapper.base.trigger.ConfigTriggerUseCase
+import io.github.sds100.keymapper.base.trigger.EvdevTriggerKey
 import io.github.sds100.keymapper.base.utils.getFullMessage
+import io.github.sds100.keymapper.base.utils.navigation.NavDestination
+import io.github.sds100.keymapper.base.utils.navigation.NavigationProvider
+import io.github.sds100.keymapper.base.utils.navigation.navigate
 import io.github.sds100.keymapper.base.utils.ui.DialogModel
 import io.github.sds100.keymapper.base.utils.ui.DialogProvider
 import io.github.sds100.keymapper.base.utils.ui.ResourceProvider
@@ -16,12 +20,14 @@ import io.github.sds100.keymapper.common.utils.State
 import io.github.sds100.keymapper.common.utils.dataOrNull
 import io.github.sds100.keymapper.common.utils.mapData
 import io.github.sds100.keymapper.common.utils.onFailure
+import io.github.sds100.keymapper.sysbridge.manager.SystemBridgeConnectionManager
+import io.github.sds100.keymapper.sysbridge.manager.SystemBridgeConnectionState
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.flow.SharingStarted
 import kotlinx.coroutines.flow.StateFlow
+import kotlinx.coroutines.flow.combine
 import kotlinx.coroutines.flow.first
 import kotlinx.coroutines.flow.firstOrNull
-import kotlinx.coroutines.flow.map
 import kotlinx.coroutines.flow.stateIn
 import kotlinx.coroutines.launch
 
@@ -30,16 +36,22 @@ class ConfigKeyMapOptionsViewModel(
     private val config: ConfigTriggerUseCase,
     private val displayUseCase: DisplayKeyMapUseCase,
     private val createKeyMapShortcut: CreateKeyMapShortcutUseCase,
+    private val systemBridgeConnectionManager: SystemBridgeConnectionManager,
     private val dialogProvider: DialogProvider,
+    navigationProvider: NavigationProvider,
     resourceProvider: ResourceProvider,
 ) : ResourceProvider by resourceProvider,
     DialogProvider by dialogProvider,
+    NavigationProvider by navigationProvider,
     KeyMapOptionsCallback {
 
     private val actionUiHelper = ActionUiHelper(displayUseCase, resourceProvider)
 
-    val state: StateFlow<State<KeyMapOptionsState>> = config.keyMap.map { keyMapState ->
-        keyMapState.mapData { keyMap -> buildState(keyMap) }
+    val state: StateFlow<State<KeyMapOptionsState>> = combine(
+        config.keyMap,
+        systemBridgeConnectionManager.connectionState,
+    ) { keyMapState, systemBridgeConnectionState ->
+        keyMapState.mapData { keyMap -> buildState(keyMap, systemBridgeConnectionState) }
     }.stateIn(coroutineScope, SharingStarted.Eagerly, State.Loading)
 
     override fun onLongPressDelayChanged(delay: Int) {
@@ -74,6 +86,12 @@ class ConfigKeyMapOptionsViewModel(
         config.setTriggerFromOtherAppsEnabled(checked)
     }
 
+    override fun onOpenExpertModeSettings() {
+        coroutineScope.launch {
+            navigate("screen_off_trigger_tip", NavDestination.ExpertMode)
+        }
+    }
+
     override fun onCreateShortcutClick() {
         coroutineScope.launch {
             val mapping = config.keyMap.firstOrNull()?.dataOrNull() ?: return@launch
@@ -100,7 +118,9 @@ class ConfigKeyMapOptionsViewModel(
                         // background is white. Also, getting the colorOnSurface attribute
                         // from the application context doesn't seem to work correctly.
                         TintType.OnSurface -> iconInfo.drawable.setTint(Color.BLACK)
+
                         is TintType.Color -> iconInfo.drawable.setTint(iconInfo.tintType.color)
+
                         else -> {}
                     }
 
@@ -132,7 +152,10 @@ class ConfigKeyMapOptionsViewModel(
         }
     }
 
-    private suspend fun buildState(keyMap: KeyMap): KeyMapOptionsState {
+    private suspend fun buildState(
+        keyMap: KeyMap,
+        systemBridgeConnectionState: SystemBridgeConnectionState,
+    ): KeyMapOptionsState {
         val defaultLongPressDelay = config.defaultLongPressDelay.first()
         val defaultDoublePressDelay = config.defaultDoublePressDelay.first()
         val defaultSequenceTriggerTimeout = config.defaultSequenceTriggerTimeout.first()
@@ -167,6 +190,9 @@ class ConfigKeyMapOptionsViewModel(
             isLauncherShortcutButtonEnabled = createKeyMapShortcut.isSupported,
 
             showToast = keyMap.trigger.showToast,
+            showScreenOffTip = keyMap.trigger.keys.none { it is EvdevTriggerKey },
+            isExpertModeStarted =
+            systemBridgeConnectionState is SystemBridgeConnectionState.Connected,
         )
     }
 }
@@ -199,4 +225,7 @@ data class KeyMapOptionsState(
     val isLauncherShortcutButtonEnabled: Boolean,
 
     val showToast: Boolean,
+
+    val showScreenOffTip: Boolean,
+    val isExpertModeStarted: Boolean,
 )

base/src/main/java/io/github/sds100/keymapper/base/keymaps/KeyMapOptionsScreen.kt

@@ -43,6 +43,7 @@ import androidx.compose.ui.unit.dp
 import androidx.lifecycle.compose.collectAsStateWithLifecycle
 import io.github.sds100.keymapper.base.R
 import io.github.sds100.keymapper.base.compose.KeyMapperTheme
+import io.github.sds100.keymapper.base.onboarding.TipCard
 import io.github.sds100.keymapper.base.utils.ui.SliderMaximums
 import io.github.sds100.keymapper.base.utils.ui.SliderMinimums
 import io.github.sds100.keymapper.base.utils.ui.SliderStepSizes
@@ -98,9 +99,27 @@ private fun Loaded(
         modifier = modifier
             .verticalScroll(rememberScrollState())
             .fillMaxWidth(),
+        verticalArrangement = Arrangement.spacedBy(8.dp),
     ) {
         Spacer(modifier = Modifier.height(8.dp))
 
+        if (state.showScreenOffTip) {
+            TipCard(
+                modifier = Modifier
+                    .fillMaxWidth()
+                    .padding(horizontal = 8.dp),
+                title = stringResource(R.string.tip_screen_off_trigger_title),
+                message = stringResource(R.string.tip_screen_off_trigger_message),
+                isDismissable = false,
+                buttonText = if (state.isExpertModeStarted) {
+                    null
+                } else {
+                    stringResource(R.string.button_enable_expert_mode)
+                },
+                onButtonClick = callback::onOpenExpertModeSettings,
+            )
+        }
+
         TriggerFromOtherAppsSection(
             modifier = Modifier
                 .fillMaxWidth()
@@ -112,8 +131,6 @@ private fun Loaded(
             onCreateShortcutClick = callback::onCreateShortcutClick,
         )
 
-        Spacer(Modifier.height(8.dp))
-
         CheckBoxText(
             modifier = Modifier
                 .padding(horizontal = 8.dp)
@@ -122,7 +139,6 @@ private fun Loaded(
             isChecked = state.showToast,
             onCheckedChange = callback::onShowToastChanged,
         )
-        Spacer(Modifier.height(8.dp))
 
         if (state.showVibrate) {
             CheckBoxText(
@@ -133,7 +149,6 @@ private fun Loaded(
                 isChecked = state.vibrate,
                 onCheckedChange = callback::onVibrateChanged,
             )
-            Spacer(Modifier.height(8.dp))
         }
 
         if (state.showVibrateDuration) {
@@ -151,7 +166,6 @@ private fun Loaded(
                 valueRange = vibrateDurationMin.toFloat()..vibrateDurationMax.toFloat(),
                 stepSize = SliderStepSizes.VIBRATION_DURATION,
             )
-            Spacer(Modifier.height(8.dp))
         }
 
         if (state.showLongPressDoubleVibration) {
@@ -163,7 +177,6 @@ private fun Loaded(
                 isChecked = state.longPressDoubleVibration,
                 onCheckedChange = callback::onLongPressDoubleVibrationChanged,
             )
-            Spacer(Modifier.height(8.dp))
         }
 
         if (state.showLongPressDelay) {
@@ -181,7 +194,6 @@ private fun Loaded(
                 valueRange = longPressDelayMin.toFloat()..longPressDelayMax.toFloat(),
                 stepSize = SliderStepSizes.TRIGGER_LONG_PRESS_DELAY,
             )
-            Spacer(Modifier.height(8.dp))
         }
 
         if (state.showDoublePressDelay) {
@@ -199,7 +211,6 @@ private fun Loaded(
                 valueRange = doublePressDelayMin.toFloat()..doublePressDelayMax.toFloat(),
                 stepSize = SliderStepSizes.TRIGGER_DOUBLE_PRESS_DELAY,
             )
-            Spacer(Modifier.height(8.dp))
         }
 
         if (state.showSequenceTriggerTimeout) {
@@ -219,7 +230,6 @@ private fun Loaded(
                 valueRange = sequenceTriggerTimeoutMin..sequenceTriggerTimeoutMax,
                 stepSize = SliderStepSizes.TRIGGER_SEQUENCE_TRIGGER_TIMEOUT,
             )
-            Spacer(Modifier.height(8.dp))
         }
 
         Spacer(Modifier.height(8.dp))
@@ -359,6 +369,7 @@ interface KeyMapOptionsCallback {
     fun onShowToastChanged(checked: Boolean) = run { }
     fun onTriggerFromOtherAppsChanged(checked: Boolean) = run {}
     fun onCreateShortcutClick() = run { }
+    fun onOpenExpertModeSettings() = run {}
 }
 
 @Preview
@@ -396,6 +407,8 @@ private fun Preview() {
                         isLauncherShortcutButtonEnabled = false,
 
                         showToast = true,
+                        showScreenOffTip = true,
+                        isExpertModeStarted = false,
                     ),
                 ),
                 callback = object : KeyMapOptionsCallback {},

base/src/main/java/io/github/sds100/keymapper/base/trigger/BaseConfigTriggerViewModel.kt

@@ -98,7 +98,9 @@ abstract class BaseConfigTriggerViewModel(
         config,
         displayKeyMap,
         createKeyMapShortcut,
+        systemBridgeConnectionManager,
         dialogProvider,
+        navigationProvider,
         resourceProvider,
     )
 
@@ -256,11 +258,9 @@ abstract class BaseConfigTriggerViewModel(
 
             val clickTypeButtons = mutableSetOf<ClickType>()
 
-            /**
-             * The click type radio buttons are only visible if there is one key
-             * or there are only key code keys in the trigger. It is not possible to do a long press of
-             * non-key code keys in a parallel trigger.
-             */
+            // The click type radio buttons are only visible if there is one key
+            // or there are only key code keys in the trigger. It is not possible to do a long press of
+            // non-key code keys in a parallel trigger.
             if (trigger.keys.size == 1 && trigger.keys.all { it.allowedDoublePress }) {
                 clickTypeButtons.add(ClickType.SHORT_PRESS)
                 clickTypeButtons.add(ClickType.DOUBLE_PRESS)

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

@@ -408,6 +408,7 @@
     <string name="button_add_action">Add action</string>
     <string name="button_record_trigger">Tap to record trigger</string>
     <string name="button_record_trigger_expert_mode">Record with Expert Mode</string>
+    <string name="button_enable_expert_mode">Enable Expert Mode</string>
     <string name="button_advanced_triggers_badge">NEW!</string>
     <string name="button_done">Done</string>
     <string name="button_fix">Fix</string>
@@ -444,6 +445,8 @@
     <string name="dialog_message_sequence_trigger_explanation">There is a timeout to input this trigger. You can change this timeout in the "Options" tab.</string>
     <string name="tip_parallel_trigger_title">How to use this trigger</string>
     <string name="tip_sequence_trigger_title">Sequence triggers</string>
+    <string name="tip_screen_off_trigger_title">Trigger when screen is off</string>
+    <string name="tip_screen_off_trigger_message">This key map cannot be detected when the screen is off because the trigger was not recorded with Expert Mode. Re-record the trigger with Expert Mode to enable screen-off remapping.</string>
     <string name="dialog_message_bt_constraint_limitation">Android doesn\'t allow apps to get a list of connected (not paired) Bluetooth devices. Apps can only detect when they are connected and disconnected. So if your Bluetooth device is already connected to your device when the accessibility service starts, you will have to reconnect it for the app to know it is connected.</string>
     <string name="dialog_title_change_location_or_disable">Automatic backup</string>
     <string name="dialog_message_change_location_or_disable">Change location or turn off automatic back up?</string>

sysbridge/src/main/java/io/github/sds100/keymapper/sysbridge/manager/SystemBridgeConnectionManager.kt

@@ -257,16 +257,26 @@ class SystemBridgeConnectionManagerImpl @Inject constructor(
 }
 
 @SuppressLint("ObsoleteSdkInt")
-@RequiresApi(Constants.SYSTEM_BRIDGE_MIN_API)
 interface SystemBridgeConnectionManager {
+    // Do not require min API to check the state.
     val connectionState: StateFlow<SystemBridgeConnectionState>
 
+    @RequiresApi(Constants.SYSTEM_BRIDGE_MIN_API)
     fun <T> run(block: (ISystemBridge) -> T): KMResult<T>
+
+    @RequiresApi(Constants.SYSTEM_BRIDGE_MIN_API)
     fun stopSystemBridge()
+
+    @RequiresApi(Constants.SYSTEM_BRIDGE_MIN_API)
     fun restartSystemBridge()
 
+    @RequiresApi(Constants.SYSTEM_BRIDGE_MIN_API)
     suspend fun startWithRoot()
+
+    @RequiresApi(Constants.SYSTEM_BRIDGE_MIN_API)
     fun startWithShizuku()
+
+    @RequiresApi(Constants.SYSTEM_BRIDGE_MIN_API)
     suspend fun startWithAdb()
 }