#1857 feat: show a tip to use pro mode for volume button screen off remapping

sds100 · sds100 · commit 4c3cfb0aa71b · 2025-10-26T16:41:44.000+01:00
diff --git a/base/src/main/java/io/github/sds100/keymapper/base/onboarding/OnboardingTipDelegate.kt b/base/src/main/java/io/github/sds100/keymapper/base/onboarding/OnboardingTipDelegate.kt
@@ -1,6 +1,7 @@
 package io.github.sds100.keymapper.base.onboarding
 
 import android.os.Build
+import android.view.KeyEvent
 import dagger.hilt.android.scopes.ViewModelScoped
 import io.github.sds100.keymapper.base.R
 import io.github.sds100.keymapper.base.actions.Action
@@ -49,6 +50,7 @@ class OnboardingTipDelegateImpl @Inject constructor(
         private const val SEQUENCE_TRIGGER_TIP_ID = "sequence_trigger_tip"
         private const val TRIGGER_CONSTRAINTS_TIP_ID = "trigger_constraints_tip"
         const val CAPS_LOCK_PRO_MODE_COMPATIBILITY_TIP_ID = "caps_lock_pro_mode_compatibility_tip"
+        const val VOLUME_BUTTONS_PRO_MODE_TIP_ID = "volume_buttons_pro_mode_tip"
         const val SCREEN_PINNING_TIP_ID = "screen_pinning_tip"
         const val IME_DETECTION_TIP_ID = "ime_detection_tip"
         const val RINGER_MODE_TIP_ID = "ringer_mode_tip"
@@ -77,6 +79,11 @@ class OnboardingTipDelegateImpl @Inject constructor(
         false,
     )
 
+    private var shownVolumeButtonsProModeTip: Boolean by PrefDelegate(
+        Keys.shownVolumeButtonsProModeTip,
+        false,
+    )
+
     private var shownScreenPinningTip: Boolean by PrefDelegate(
         Keys.shownScreenPinningTip,
         false,
@@ -113,33 +120,7 @@ class OnboardingTipDelegateImpl @Inject constructor(
     override fun onTriggerTipDismissClick() {
         val currentTip = triggerTip.value
 
-        when (currentTip?.id) {
-            PARALLEL_TRIGGER_TIP_ID -> {
-                shownParallelTriggerOrderExplanation = true
-            }
-
-            SEQUENCE_TRIGGER_TIP_ID -> {
-                shownSequenceTriggerExplanation = true
-            }
-
-            TRIGGER_CONSTRAINTS_TIP_ID -> {
-                shownTriggerConstraintsTip = true
-            }
-
-            CAPS_LOCK_PRO_MODE_COMPATIBILITY_TIP_ID -> {
-                shownCapsLockProModeTip = true
-            }
-
-            SCREEN_PINNING_TIP_ID -> {
-                shownScreenPinningTip = true
-            }
-
-            IME_DETECTION_TIP_ID -> {
-                shownImeDetectionTip = true
-            }
-
-            // POWER_BUTTON_EMERGENCY_TIP_ID doesn't need preference setting as it's non-dismissable
-        }
+        currentTip?.let { neverShowTipAgain(it.id) }
 
         triggerTip.value = null
     }
@@ -163,6 +144,12 @@ class OnboardingTipDelegateImpl @Inject constructor(
                     navigate("ringer_mode_tip_pro_mode", NavDestination.ProMode)
                 }
             }
+
+            VOLUME_BUTTONS_PRO_MODE_TIP_ID -> {
+                viewModelScope.launch {
+                    navigate("volume_buttons_pro_mode_tip", NavDestination.ProMode)
+                }
+            }
         }
     }
 
@@ -175,9 +162,14 @@ class OnboardingTipDelegateImpl @Inject constructor(
         }
 
         val hasCapsLockKey =
-            trigger.keys.any { it is KeyEventTriggerKey && it.keyCode == android.view.KeyEvent.KEYCODE_CAPS_LOCK }
+            trigger.keys.any { it is KeyEventTriggerKey && it.keyCode == KeyEvent.KEYCODE_CAPS_LOCK }
+        trigger.keys.any {
+            it is KeyEventTriggerKey &&
+                (it.keyCode == KeyEvent.KEYCODE_VOLUME_UP || it.keyCode == KeyEvent.KEYCODE_VOLUME_DOWN)
+        }
+
         val hasBackKey =
-            trigger.keys.any { it is KeyEventTriggerKey && it.keyCode == android.view.KeyEvent.KEYCODE_BACK }
+            trigger.keys.any { it is KeyEventTriggerKey && it.keyCode == KeyEvent.KEYCODE_BACK }
         val hasImeKey = trigger.keys.any { it is KeyEventTriggerKey && it.requiresIme }
 
         when {
@@ -214,16 +206,17 @@ class OnboardingTipDelegateImpl @Inject constructor(
                 triggerTip.value = tipModel
             }
 
-            trigger.keys.isNotEmpty() && !shownTriggerConstraintsTip -> {
-                val tipModel = OnboardingTipModel(
-                    id = TRIGGER_CONSTRAINTS_TIP_ID,
-                    title = getString(R.string.trigger_constraints_tip_title),
-                    message = getString(R.string.trigger_constraints_tip_text),
-                    isDismissable = true,
-                )
-
-                triggerTip.value = tipModel
-            }
+            // DISABLE UNTIL PRO MODE IS STABLE
+//            hasVolumeKey && !shownVolumeButtonsProModeTip -> {
+//                val tip = OnboardingTipModel(
+//                    id = VOLUME_BUTTONS_PRO_MODE_TIP_ID,
+//                    title = getString(R.string.tip_volume_buttons_pro_mode_title),
+//                    message = getString(R.string.tip_volume_buttons_pro_mode_text),
+//                    isDismissable = true,
+//                    buttonText = getString(R.string.tip_volume_buttons_pro_mode_button),
+//                )
+//                triggerTip.value = tip
+//            }
 
             hasCapsLockKey && !shownCapsLockProModeTip -> {
                 val tip = OnboardingTipModel(
@@ -256,12 +249,58 @@ class OnboardingTipDelegateImpl @Inject constructor(
                 triggerTip.value = tip
             }
 
+            // Adding a constraint should be the lowest priority
+            trigger.keys.isNotEmpty() && !shownTriggerConstraintsTip -> {
+                val tipModel = OnboardingTipModel(
+                    id = TRIGGER_CONSTRAINTS_TIP_ID,
+                    title = getString(R.string.trigger_constraints_tip_title),
+                    message = getString(R.string.trigger_constraints_tip_text),
+                    isDismissable = true,
+                )
+
+                triggerTip.value = tipModel
+            }
+
             else -> {
                 triggerTip.value = null
             }
         }
     }
 
+    override fun neverShowTipAgain(tipId: String) {
+        when (tipId) {
+            PARALLEL_TRIGGER_TIP_ID -> {
+                shownParallelTriggerOrderExplanation = true
+            }
+
+            SEQUENCE_TRIGGER_TIP_ID -> {
+                shownSequenceTriggerExplanation = true
+            }
+
+            TRIGGER_CONSTRAINTS_TIP_ID -> {
+                shownTriggerConstraintsTip = true
+            }
+
+            CAPS_LOCK_PRO_MODE_COMPATIBILITY_TIP_ID -> {
+                shownCapsLockProModeTip = true
+            }
+
+            VOLUME_BUTTONS_PRO_MODE_TIP_ID -> {
+                shownVolumeButtonsProModeTip = true
+            }
+
+            SCREEN_PINNING_TIP_ID -> {
+                shownScreenPinningTip = true
+            }
+
+            IME_DETECTION_TIP_ID -> {
+                shownImeDetectionTip = true
+            }
+
+            // POWER_BUTTON_EMERGENCY_TIP_ID doesn't need preference setting as it's non-dismissable
+        }
+    }
+
     private fun onCollectActions(actionList: List<Action>) {
         val hasRingerModeAction = actionList.any { action ->
             when (action.data) {
@@ -294,4 +333,5 @@ interface OnboardingTipDelegate {
     fun onTriggerTipDismissClick()
     fun onActionTipDismissClick()
     fun onTipButtonClick(tipId: String)
+    fun neverShowTipAgain(tipId: String)
 }
diff --git a/base/src/main/java/io/github/sds100/keymapper/base/trigger/BaseConfigTriggerViewModel.kt b/base/src/main/java/io/github/sds100/keymapper/base/trigger/BaseConfigTriggerViewModel.kt
@@ -1,5 +1,6 @@
 package io.github.sds100.keymapper.base.trigger
 
+import android.view.KeyEvent
 import androidx.compose.runtime.getValue
 import androidx.compose.runtime.mutableStateOf
 import androidx.compose.runtime.setValue
@@ -381,6 +382,10 @@ abstract class BaseConfigTriggerViewModel(
                 product = key.device.product,
             ),
         )
+
+        if (key.keyCode == KeyEvent.KEYCODE_VOLUME_DOWN || key.keyCode == KeyEvent.KEYCODE_VOLUME_UP) {
+            neverShowTipAgain(OnboardingTipDelegateImpl.VOLUME_BUTTONS_PRO_MODE_TIP_ID)
+        }
     }
 
     fun onParallelRadioButtonChecked() {
@@ -488,8 +493,14 @@ abstract class BaseConfigTriggerViewModel(
     }
 
     override fun onTipButtonClick(tipId: String) {
-        if (tipId == OnboardingTipDelegateImpl.CAPS_LOCK_PRO_MODE_COMPATIBILITY_TIP_ID) {
-            showTriggerSetup(TriggerSetupShortcut.KEYBOARD, forceProMode = true)
+        when (tipId) {
+            OnboardingTipDelegateImpl.CAPS_LOCK_PRO_MODE_COMPATIBILITY_TIP_ID -> {
+                showTriggerSetup(TriggerSetupShortcut.KEYBOARD, forceProMode = true)
+            }
+
+            OnboardingTipDelegateImpl.VOLUME_BUTTONS_PRO_MODE_TIP_ID -> {
+                showTriggerSetup(TriggerSetupShortcut.VOLUME, forceProMode = true)
+            }
         }
     }
 
diff --git a/base/src/main/res/values/strings.xml b/base/src/main/res/values/strings.xml
@@ -1349,8 +1349,11 @@
     <string name="floating_button_text_key_map_list_item">Floating button %s (%s)</string>
     <string name="deleted_floating_button_text_key_map_list_item">Deleted floating button</string>
     <string name="tip_caps_lock_pro_mode_title">Better Caps Lock compatibility</string>
-    <string name="tip_caps_lock_pro_mode_text">PRO mode provides better compatibility for Caps Lock remapping. Please record the trigger again with PRO mode.</string>
-    <string name="tip_caps_lock_pro_mode_button">Record again</string>
+    <string name="tip_caps_lock_pro_mode_text">PRO mode provides better compatibility for Caps Lock remapping. Tap \'Use PRO mode\' and record it again.</string>
+    <string name="tip_caps_lock_pro_mode_button">Use PRO mode</string>
+    <string name="tip_volume_buttons_pro_mode_title">Screen off remapping?</string>
+    <string name="tip_volume_buttons_pro_mode_text">Use PRO mode if you want your trigger to work when the screen is off. Tap \'Use PRO mode\' and record it again.</string>
+    <string name="tip_volume_buttons_pro_mode_button">Use PRO mode</string>
     <string name="tip_screen_pinning_title">App pinning warning</string>
     <string name="tip_screen_pinning_text">Using the back button as a trigger may conflict with app pinning, causing a black screen on unlock. A reboot will fix it.</string>
     <string name="tip_ime_detection_title">Keyboard icon</string>
diff --git a/data/src/main/java/io/github/sds100/keymapper/data/Keys.kt b/data/src/main/java/io/github/sds100/keymapper/data/Keys.kt
@@ -57,6 +57,8 @@ object Keys {
         booleanPreferencesKey("key_shown_trigger_constraints_tip")
     val shownCapsLockProModeTip =
         booleanPreferencesKey("key_shown_caps_lock_pro_mode_compatibility_tip")
+    val shownVolumeButtonsProModeTip =
+        booleanPreferencesKey("key_shown_volume_buttons_pro_mode_tip")
     val shownScreenPinningTip =
         booleanPreferencesKey("key_shown_screen_pinning_tip")
     val shownRingerModeTip =

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`package io.github.sds100.keymapper.base.trigger`
`2`	`2`
	`3`	`+import android.view.KeyEvent`
`3`	`4`	`import androidx.compose.runtime.getValue`
`4`	`5`	`import androidx.compose.runtime.mutableStateOf`
`5`	`6`	`import androidx.compose.runtime.setValue`
`@@ -381,6 +382,10 @@ abstract class BaseConfigTriggerViewModel(`
`381`	`382`	`product = key.device.product,`
`382`	`383`	`),`
`383`	`384`	`)`
	`385`	`+`
	`386`	`+ if (key.keyCode == KeyEvent.KEYCODE_VOLUME_DOWN \|\| key.keyCode == KeyEvent.KEYCODE_VOLUME_UP) {`
	`387`	`+ neverShowTipAgain(OnboardingTipDelegateImpl.VOLUME_BUTTONS_PRO_MODE_TIP_ID)`
	`388`	`+ }`
`384`	`389`	`}`
`385`	`390`
`386`	`391`	`fun onParallelRadioButtonChecked() {`
`@@ -488,8 +493,14 @@ abstract class BaseConfigTriggerViewModel(`
`488`	`493`	`}`
`489`	`494`
`490`	`495`	`override fun onTipButtonClick(tipId: String) {`
`491`		`- if (tipId == OnboardingTipDelegateImpl.CAPS_LOCK_PRO_MODE_COMPATIBILITY_TIP_ID) {`
`492`		`- showTriggerSetup(TriggerSetupShortcut.KEYBOARD, forceProMode = true)`
	`496`	`+ when (tipId) {`
	`497`	`+ OnboardingTipDelegateImpl.CAPS_LOCK_PRO_MODE_COMPATIBILITY_TIP_ID -> {`
	`498`	`+ showTriggerSetup(TriggerSetupShortcut.KEYBOARD, forceProMode = true)`
	`499`	`+ }`
	`500`	`+`
	`501`	`+ OnboardingTipDelegateImpl.VOLUME_BUTTONS_PRO_MODE_TIP_ID -> {`
	`502`	`+ showTriggerSetup(TriggerSetupShortcut.VOLUME, forceProMode = true)`
	`503`	`+ }`
`493`	`504`	`}`
`494`	`505`	`}`
`495`	`506`