feat: per-action haptic picker on HapticPage

Replaces the removed per-button haptic gate with a per-action allowlist.
HapticPage now shows a dual-column picker — Enabled (left) / Available
(right) — where clicking an action chip moves it between lists. Only
the 11 curated actions (cycle_dpi, switch_scroll_mode, volume_mute,
alt_tab, etc.) can ever fire haptic on button press. Gestures and
Actions Ring detents keep firing unconditionally when global haptic
is on. Config migrated to v12 with action_haptic: [] (empty = opt-in).

Author: TomBadash

core/config.py

@@ -112,6 +112,7 @@
         "language": "en",
         "haptic_level": 2,          # 0=subtle, 1=low, 2=medium, 3=high
         "haptic_enabled": True,     # global haptic on/off
+        "action_haptic": [],        # action IDs that fire haptic on press; empty = opt-in
     },
 }
 
@@ -232,21 +233,38 @@ def create_profile(cfg, name, label=None, copy_from="default", apps=None):
     return cfg
 
 
-def get_button_haptic(cfg, button, profile=None):
-    """Return True if haptic is enabled for this button in the given profile (default: True)."""
-    if profile is None:
-        profile = cfg.get("active_profile", "default")
-    profiles = cfg.get("profiles", {})
-    pdata = profiles.get(profile, profiles.get("default", {}))
-    return bool(pdata.get("button_haptic", {}).get(button, True))
-
-
-def set_button_haptic(cfg, button, enabled, profile=None):
-    """Set per-button haptic enabled flag in the given profile and save."""
-    if profile is None:
-        profile = cfg.get("active_profile", "default")
-    pdata = cfg.setdefault("profiles", {}).setdefault(profile, {})
-    pdata.setdefault("button_haptic", {})[button] = bool(enabled)
+# Curated list of actions that may fire haptic feedback on button press.
+# Other actions (text editing, raw scroll, mouse buttons, etc.) never trigger
+# haptic regardless of mapping. Order here is the order shown in the picker UI.
+HAPTIC_ELIGIBLE_ACTIONS = [
+    "switch_scroll_mode",
+    "toggle_smart_shift",
+    "cycle_dpi",
+    "volume_mute",
+    "play_pause",
+    "next_track",
+    "prev_track",
+    "task_view",
+    "alt_tab",
+    "alt_shift_tab",
+    "win_d",
+]
+
+
+def action_haptic_enabled(cfg, action_id):
+    """True if haptic should fire when action_id executes via a button press."""
+    return action_id in cfg.get("settings", {}).get("action_haptic", [])
+
+
+def set_action_haptic(cfg, action_id, enabled):
+    """Add or remove action_id from the global per-action haptic allowlist."""
+    lst = cfg.setdefault("settings", {}).setdefault("action_haptic", [])
+    if enabled:
+        if action_id not in lst:
+            lst.append(action_id)
+    else:
+        if action_id in lst:
+            lst.remove(action_id)
     save_config(cfg)
     return cfg
 
@@ -368,6 +386,11 @@ def _migrate(cfg):
         cfg.setdefault("settings", {}).setdefault("haptic_enabled", True)
         cfg["version"] = 11
 
+    if version < 12:
+        # v11 -> v12: add per-action haptic allowlist (empty = opt-in).
+        cfg.setdefault("settings", {}).setdefault("action_haptic", [])
+        cfg["version"] = 12
+
     cfg.setdefault("settings", {})
     cfg["settings"].setdefault("appearance_mode", "system")
     cfg["settings"].setdefault("debug_mode", False)

core/engine.py

@@ -14,7 +14,7 @@
 from core.config import (
     load_config, get_active_mappings, get_profile_for_app,
     BUTTON_TO_EVENTS, GESTURE_DIRECTION_BUTTONS, save_config,
-    get_button_haptic,
+    action_haptic_enabled,
 )
 from core.app_detector import AppDetector
 from core.logi_devices import clamp_dpi
@@ -159,12 +159,6 @@ def _setup_hooks(self):
                     else:
                         self.hook.register(evt_type, self._make_handler(action_id, btn_key))
 
-    def _button_haptic_enabled(self, btn_key):
-        """Return True if haptic feedback is enabled for this button in the active profile."""
-        if not btn_key:
-            return True
-        return get_button_haptic(self.cfg, btn_key, self._current_profile)
-
     def _make_handler(self, action_id, btn_key=""):
         def handler(event):
             try:
@@ -180,16 +174,14 @@ def handler(event):
                             "action_id": action_id,
                             "action_label": self._action_label(action_id),
                         })
-                        # Haptic confirmation when a gesture resolves to an action.
-                        if self._button_haptic_enabled(btn_key):
-                            self._play_haptic_async(7)  # COMPLETED
+                        # Gesture-resolved actions always confirm with a pulse.
+                        self._play_haptic_async(7)  # COMPLETED
                     elif event.event_type == "actions_ring_down":
-                        # Haptic detent feedback for each ring step.
-                        if self._button_haptic_enabled(btn_key):
-                            self._play_haptic_async(0)  # SHARP_STATE_CHANGE
+                        # Ring detents always click — discoverability feedback.
+                        self._play_haptic_async(0)  # SHARP_STATE_CHANGE
                     elif not event.event_type.endswith("_up"):
-                        # Regular button press — fire haptic immediately on down.
-                        if self._button_haptic_enabled(btn_key):
+                        # Regular button press — gated by per-action allowlist.
+                        if action_haptic_enabled(self.cfg, action_id):
                             wf = 3 if action_id == "cycle_dpi" else 1
                             self._play_haptic_async(wf)
                     if action_id == "toggle_smart_shift":

tests/test_config.py

@@ -31,7 +31,7 @@ def test_migrate_v1_config_adds_profile_apps_and_gesture_defaults(self):
 
         migrated = config._migrate(legacy)
 
-        self.assertEqual(migrated["version"], 10)
+        self.assertEqual(migrated["version"], 12)
         self.assertEqual(migrated["profiles"]["default"]["apps"], [])
         self.assertFalse(migrated["settings"]["invert_hscroll"])
         self.assertFalse(migrated["settings"]["invert_vscroll"])
@@ -73,7 +73,7 @@ def test_migrate_updates_media_player_profile_apps(self):
 
         migrated = config._migrate(cfg)
 
-        self.assertEqual(migrated["version"], 10)
+        self.assertEqual(migrated["version"], 12)
         self.assertEqual(
             migrated["profiles"]["media"]["apps"],
             ["Microsoft.Media.Player.exe", "VLC.exe"],
@@ -112,8 +112,10 @@ def test_load_config_merges_missing_defaults_from_disk(self):
             ):
                 loaded = config.load_config()
 
-        self.assertEqual(loaded["version"], 10)
+        self.assertEqual(loaded["version"], 12)
         self.assertEqual(loaded["settings"]["dpi"], 800)
+        self.assertEqual(loaded["settings"]["action_haptic"], [])
+        self.assertTrue(loaded["settings"]["haptic_enabled"])
         self.assertFalse(loaded["settings"]["start_at_login"])
         self.assertEqual(loaded["settings"]["gesture_threshold"], 50)
         self.assertEqual(loaded["settings"]["appearance_mode"], "system")
@@ -136,7 +138,7 @@ def test_migrate_renames_start_with_windows_to_start_at_login(self):
 
         migrated = config._migrate(legacy)
 
-        self.assertEqual(migrated["version"], 10)
+        self.assertEqual(migrated["version"], 12)
         self.assertTrue(migrated["settings"]["start_at_login"])
         self.assertEqual(
             migrated["profiles"]["default"]["mappings"]["mode_shift"],
@@ -162,7 +164,7 @@ def test_migrate_v8_to_v9_adds_actions_ring_and_haptic(self):
 
         migrated = config._migrate(v8_cfg)
 
-        self.assertEqual(migrated["version"], 10)
+        self.assertEqual(migrated["version"], 12)
         self.assertEqual(
             migrated["profiles"]["default"]["mappings"]["actions_ring"], "none"
         )
@@ -190,10 +192,60 @@ def test_migrate_v9_to_v10_adds_button_haptic(self):
 
         migrated = config._migrate(v9_cfg)
 
-        self.assertEqual(migrated["version"], 10)
+        self.assertEqual(migrated["version"], 12)
         self.assertEqual(migrated["profiles"]["default"]["button_haptic"], {})
         self.assertEqual(migrated["profiles"]["work"]["button_haptic"], {})
 
+    def test_migrate_v11_to_v12_adds_action_haptic_list(self):
+        v11_cfg = {
+            "version": 11,
+            "active_profile": "default",
+            "profiles": {
+                "default": {
+                    "label": "Default",
+                    "apps": [],
+                    "mappings": {"middle": "none", "actions_ring": "none"},
+                }
+            },
+            "settings": {"dpi": 1000, "haptic_level": 2, "haptic_enabled": True},
+        }
+
+        migrated = config._migrate(v11_cfg)
+
+        self.assertEqual(migrated["version"], 12)
+        self.assertEqual(migrated["settings"]["action_haptic"], [])
+        # existing haptic settings preserved
+        self.assertTrue(migrated["settings"]["haptic_enabled"])
+        self.assertEqual(migrated["settings"]["haptic_level"], 2)
+
+    def test_action_haptic_enabled_returns_false_when_missing(self):
+        cfg = {"settings": {"action_haptic": ["cycle_dpi"]}}
+        self.assertTrue(config.action_haptic_enabled(cfg, "cycle_dpi"))
+        self.assertFalse(config.action_haptic_enabled(cfg, "alt_tab"))
+
+    def test_set_action_haptic_adds_and_removes(self):
+        cfg = {"settings": {"action_haptic": []}}
+
+        with patch.object(config, "save_config", lambda c: c):
+            cfg = config.set_action_haptic(cfg, "cycle_dpi", True)
+            self.assertEqual(cfg["settings"]["action_haptic"], ["cycle_dpi"])
+
+            # Adding the same action twice is a no-op
+            cfg = config.set_action_haptic(cfg, "cycle_dpi", True)
+            self.assertEqual(cfg["settings"]["action_haptic"], ["cycle_dpi"])
+
+            cfg = config.set_action_haptic(cfg, "volume_mute", True)
+            self.assertEqual(
+                cfg["settings"]["action_haptic"], ["cycle_dpi", "volume_mute"]
+            )
+
+            cfg = config.set_action_haptic(cfg, "cycle_dpi", False)
+            self.assertEqual(cfg["settings"]["action_haptic"], ["volume_mute"])
+
+            # Removing a non-present action is a no-op
+            cfg = config.set_action_haptic(cfg, "cycle_dpi", False)
+            self.assertEqual(cfg["settings"]["action_haptic"], ["volume_mute"])
+
     def test_get_profile_for_app_matches_aliases(self):
         cfg = {
             "app_overrides": {},

tests/test_smart_shift.py

@@ -677,7 +677,7 @@ def test_multiple_profiles_all_migrated(self):
     def test_version_bumped_to_8(self):
         from core.config import _migrate
         migrated = _migrate(self._v6_config())
-        self.assertEqual(migrated["version"], 10)
+        self.assertEqual(migrated["version"], 12)
 
 
 # ──────────────────────────────────────────────────────────────────────────────
@@ -739,7 +739,7 @@ def test_multiple_profiles_all_migrated(self):
     def test_version_bumped_to_8(self):
         from core.config import _migrate
         migrated = _migrate(self._v7_config())
-        self.assertEqual(migrated["version"], 10)
+        self.assertEqual(migrated["version"], 12)
 
 
 class HidForceReconnectTests(unittest.TestCase):

ui/backend.py

@@ -14,7 +14,7 @@
 from core.config import (
     BUTTON_NAMES, load_config, save_config, get_active_mappings,
     PROFILE_BUTTON_NAMES, set_mapping, create_profile, delete_profile,
-    get_icon_for_exe, get_button_haptic, set_button_haptic,
+    get_icon_for_exe, HAPTIC_ELIGIBLE_ACTIONS, set_action_haptic,
 )
 from core import app_catalog
 from core.device_layouts import get_device_layout, get_manual_layout_choices
@@ -304,6 +304,30 @@ def hapticLevel(self):
     def hapticEnabled(self):
         return bool(self._cfg.get("settings", {}).get("haptic_enabled", True))
 
+    @Property(list, notify=hapticChanged)
+    def hapticEnabledActions(self):
+        """Actions in the user's haptic allowlist, in stored order."""
+        enabled = self._cfg.get("settings", {}).get("action_haptic", [])
+        result = []
+        for aid in enabled:
+            data = ACTIONS.get(aid)
+            if data:
+                result.append({"id": aid, "label": data["label"]})
+        return result
+
+    @Property(list, notify=hapticChanged)
+    def hapticAvailableActions(self):
+        """Eligible haptic actions the user has NOT yet enabled."""
+        enabled = set(self._cfg.get("settings", {}).get("action_haptic", []))
+        result = []
+        for aid in HAPTIC_ELIGIBLE_ACTIONS:
+            if aid in enabled:
+                continue
+            data = ACTIONS.get(aid)
+            if data:
+                result.append({"id": aid, "label": data["label"]})
+        return result
+
     @Property(bool, notify=settingsChanged)
     def startMinimized(self):
         return bool(self._cfg.get("settings", {}).get("start_minimized", True))
@@ -659,20 +683,13 @@ def playHapticTest(self):
                 daemon=True, name="HapticTest"
             ).start()
 
-    @Slot(str, str, result=bool)
-    def buttonHapticEnabled(self, profileName, button):
-        """Return whether haptic is enabled for the given button in the given profile."""
-        profile = profileName or self._cfg.get("active_profile", "default")
-        return get_button_haptic(self._cfg, button, profile)
-
-    @Slot(str, str, bool)
-    def setButtonHaptic(self, profileName, button, enabled):
-        """Set per-button haptic enabled flag in the given profile."""
-        profile = profileName or self._cfg.get("active_profile", "default")
-        self._cfg = set_button_haptic(self._cfg, button, enabled, profile)
+    @Slot(str, bool)
+    def setActionHaptic(self, action_id, enabled):
+        """Toggle whether an action fires haptic feedback on button press."""
+        self._cfg = set_action_haptic(self._cfg, action_id, bool(enabled))
         if self._engine:
             self._engine.cfg = self._cfg
-        self.mappingsChanged.emit()
+        self.hapticChanged.emit()
 
     @Slot(bool)
     def setInvertVScroll(self, value):

ui/locale_manager.py

@@ -25,6 +25,11 @@
         "haptic.test_title": "Test Haptic",
         "haptic.test_desc": "Play a brief haptic pulse to preview the current intensity.",
         "haptic.test": "Test",
+        "haptic.actions_title": "Haptic for Actions",
+        "haptic.actions_desc": "Pick which actions fire haptic feedback. Click an action to move it between Enabled and Available.",
+        "haptic.actions_enabled": "Enabled",
+        "haptic.actions_available": "Available",
+        "haptic.actions_empty": "No actions selected. Pick from Available.",
         "haptic.experimental_note": "Haptic feedback support is experimental. Some settings may not take effect until the protocol is fully documented.",
 
         # Mouse page — profile list
@@ -206,6 +211,11 @@
         "haptic.test_title": "\u6d4b\u8bd5\u89e6\u89c9",
         "haptic.test_desc": "\u64ad\u653e\u4e00\u6b21\u77ed\u6682\u7684\u89e6\u89c9\u8109\u51b2\u4ee5\u9884\u89c8\u5f53\u524d\u5f3a\u5ea6\u3002",
         "haptic.test": "\u6d4b\u8bd5",
+        "haptic.actions_title": "\u52a8\u4f5c\u89e6\u89c9\u53cd\u9988",
+        "haptic.actions_desc": "\u9009\u62e9\u54ea\u4e9b\u52a8\u4f5c\u89e6\u53d1\u89e6\u89c9\u53cd\u9988\u3002\u70b9\u51fb\u52a8\u4f5c\u53ef\u5728\u201c\u5df2\u542f\u7528\u201d\u548c\u201c\u53ef\u9009\u201d\u4e4b\u95f4\u79fb\u52a8\u3002",
+        "haptic.actions_enabled": "\u5df2\u542f\u7528",
+        "haptic.actions_available": "\u53ef\u9009",
+        "haptic.actions_empty": "\u672a\u9009\u62e9\u4efb\u4f55\u52a8\u4f5c\u3002\u8bf7\u4ece\u201c\u53ef\u9009\u201d\u4e2d\u6dfb\u52a0\u3002",
         "haptic.experimental_note": "\u89e6\u89c9\u53cd\u9988\u652f\u6301\u4e3a\u5b9e\u9a8c\u6027\u529f\u80fd\u3002\u90e8\u5206\u8bbe\u7f6e\u53ef\u80fd\u5728\u534f\u8bae\u5b8c\u5168\u6587\u6863\u5316\u540e\u624d\u751f\u6548\u3002",
 
         "mouse.profiles": "\u914d\u7f6e\u6587\u4ef6",
@@ -372,6 +382,11 @@
         "haptic.test_title": "\u6e2c\u8a66\u89f8\u89ba",
         "haptic.test_desc": "\u64ad\u653e\u4e00\u6b21\u77ed\u66ab\u7684\u89f8\u89ba\u8108\u885d\u4ee5\u9810\u89bd\u76ee\u524d\u5f37\u5ea6\u3002",
         "haptic.test": "\u6e2c\u8a66",
+        "haptic.actions_title": "\u52d5\u4f5c\u89f8\u89ba\u56de\u994b",
+        "haptic.actions_desc": "\u9078\u64c7\u54ea\u4e9b\u52d5\u4f5c\u89f8\u767c\u89f8\u89ba\u56de\u994b\u3002\u9ede\u64ca\u52d5\u4f5c\u53ef\u5728\u300c\u5df2\u555f\u7528\u300d\u548c\u300c\u53ef\u9078\u300d\u4e4b\u9593\u79fb\u52d5\u3002",
+        "haptic.actions_enabled": "\u5df2\u555f\u7528",
+        "haptic.actions_available": "\u53ef\u9078",
+        "haptic.actions_empty": "\u672a\u9078\u64c7\u4efb\u4f55\u52d5\u4f5c\u3002\u8acb\u5f9e\u300c\u53ef\u9078\u300d\u4e2d\u52a0\u5165\u3002",
         "haptic.experimental_note": "\u89f8\u89ba\u56de\u994b\u652f\u63f4\u70ba\u5be6\u9a57\u6027\u529f\u80fd\u3002\u90e8\u5206\u8a2d\u5b9a\u53ef\u80fd\u5728\u5354\u5b9a\u5b8c\u5168\u6587\u4ef6\u5316\u5f8c\u624d\u751f\u6548\u3002",
 
         "mouse.profiles": "\u8a2d\u5b9a\u6a94",