#2016 feat: show a warning when repeating a key code action less than 20 ms with expert mode triggers

Author: sds100

CHANGELOG.md

@@ -7,6 +7,7 @@
 - #2024 support Expert mode on all Android versions supported by Key Mapper (8.0+).
 - #2025 add report bug button to home screen menu.
 - #2027 Make the key map sorting feature easier to understand.
+- #2016 Show a warning when repeating a key code action less than 20 ms with expert mode triggers.
 
 ## Fixed
 

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

@@ -14,6 +14,7 @@ import androidx.compose.foundation.rememberScrollState
 import androidx.compose.foundation.verticalScroll
 import androidx.compose.material.icons.Icons
 import androidx.compose.material.icons.automirrored.rounded.HelpOutline
+import androidx.compose.material.icons.rounded.Warning
 import androidx.compose.material3.ButtonDefaults
 import androidx.compose.material3.ExperimentalMaterial3Api
 import androidx.compose.material3.FilledTonalButton
@@ -126,6 +127,29 @@ fun ActionOptionsBottomSheet(
                 )
             }
 
+            if (state.showRepeatRateWarning) {
+                Spacer(Modifier.height(8.dp))
+
+                Row(
+                    verticalAlignment = Alignment.CenterVertically,
+                ) {
+                    Spacer(Modifier.width(16.dp))
+                    Icon(
+                        Icons.Rounded.Warning,
+                        contentDescription = null,
+                        tint = MaterialTheme.colorScheme.error,
+                    )
+                    Spacer(Modifier.width(8.dp))
+                    Text(
+                        modifier = Modifier.weight(1f),
+                        text = stringResource(R.string.action_repeat_rate_warning),
+                        color = MaterialTheme.colorScheme.error,
+                        style = MaterialTheme.typography.labelLarge,
+                    )
+                    Spacer(Modifier.width(16.dp))
+                }
+            }
+
             if (state.showRepeatRate) {
                 Spacer(Modifier.height(8.dp))
 
@@ -421,6 +445,7 @@ private fun Preview() {
                 showEditButton = true,
                 showRepeat = true,
                 isRepeatChecked = true,
+                showRepeatRateWarning = true,
 
                 showRepeatRate = true,
                 repeatRate = 400,
@@ -480,6 +505,7 @@ private fun PreviewNoEditButton() {
                 showEditButton = false,
                 showRepeat = true,
                 isRepeatChecked = true,
+                showRepeatRateWarning = true,
 
                 showRepeatRate = true,
                 repeatRate = 400,

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

@@ -11,6 +11,7 @@ import io.github.sds100.keymapper.base.onboarding.OnboardingTapTarget
 import io.github.sds100.keymapper.base.onboarding.OnboardingTipDelegate
 import io.github.sds100.keymapper.base.onboarding.OnboardingUseCase
 import io.github.sds100.keymapper.base.onboarding.SetupAccessibilityServiceDelegate
+import io.github.sds100.keymapper.base.trigger.EvdevTriggerKey
 import io.github.sds100.keymapper.base.utils.getFullMessage
 import io.github.sds100.keymapper.base.utils.isFixable
 import io.github.sds100.keymapper.base.utils.navigation.NavDestination
@@ -29,7 +30,6 @@ import io.github.sds100.keymapper.common.utils.mapData
 import io.github.sds100.keymapper.common.utils.onFailure
 import io.github.sds100.keymapper.system.SystemError
 import io.github.sds100.keymapper.system.permissions.Permission
-import javax.inject.Inject
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.SharingStarted
 import kotlinx.coroutines.flow.StateFlow
@@ -42,6 +42,7 @@ import kotlinx.coroutines.flow.map
 import kotlinx.coroutines.flow.stateIn
 import kotlinx.coroutines.flow.update
 import kotlinx.coroutines.launch
+import javax.inject.Inject
 
 @HiltViewModel
 class ConfigActionsViewModel @Inject constructor(
@@ -261,6 +262,7 @@ class ConfigActionsViewModel @Inject constructor(
                 )
 
                 RepeatMode.LIMIT_REACHED -> config.setActionStopRepeatingWhenLimitReached(uid)
+
                 RepeatMode.TRIGGER_PRESSED_AGAIN ->
                     config.setActionStopRepeatingWhenTriggerPressedAgain(uid)
             }
@@ -395,10 +397,17 @@ class ConfigActionsViewModel @Inject constructor(
             Int.MAX_VALUE
         }
 
+        val showRepeatRateWarning =
+            keyMap.isRepeatingActionsAllowed() &&
+                action.data is ActionData.InputKeyEvent &&
+                (action.repeatRate ?: defaultRepeatRate) < 20 &&
+                keyMap.trigger.keys.any { it is EvdevTriggerKey }
+
         return ActionOptionsState(
             showEditButton = action.data.isEditable(),
 
             showRepeat = keyMap.isRepeatingActionsAllowed(),
+            showRepeatRateWarning = showRepeatRateWarning,
             isRepeatChecked = action.repeat,
 
             showRepeatRate = keyMap.isChangingActionRepeatRateAllowed(action),
@@ -470,6 +479,7 @@ data class ActionOptionsState(
     val isRepeatChecked: Boolean,
 
     val showRepeatRate: Boolean,
+    val showRepeatRateWarning: Boolean,
     val repeatRate: Int,
     val defaultRepeatRate: Int,
 

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

@@ -1615,6 +1615,7 @@
     <string name="action_list_delete_yes">Yes, delete</string>
     <string name="action_list_delete_cancel">Cancel</string>
     <string name="action_list_explanation_header">Run these actions when you trigger the key map:</string>
+    <string name="action_repeat_rate_warning">Repeating under 20 ms can lag! Adjust for your device and game.</string>
 
     <string name="action_config_flashlight_choose_side">Choose side</string>
     <string name="action_config_flashlight_brightness">Brightness</string>