switch to using tags for the settings universally

Author: antheas

docs/http.md

@@ -28,7 +28,7 @@ may not check if they exist.
 Each setting has a title which is meant to be shown in the UI and an optional 
 hint meant to be shown under a hover hint or `?` button.
 
-Each setting may include a family, which has a number of tags that work like classes. 
+Each setting may include a set of tags, that work like classes. 
 For example, a keyboard mapping setting may have the tags 
 `[razer_lycosa_123, razer_kbd, keyboard, advanced]`, which would allow the UI
 to customize the presentation based on the specific device make, manufacturer,

readme.md

@@ -218,6 +218,7 @@ Currently, there is a bug with the Nobara kernels that adds 2 extra random
 Steam Controllers.
 These controllers appear in the system as X-BOX/Xpad controllers.
 This is unrelated to HHD.
+You can verify by running ``
 
 ### Steam reports a Legion Controller and a Shortcuts controller instead of a DS5
 The Legion controllers have multiple modes (namely x-input, d-input, dual d-input,
@@ -270,10 +271,10 @@ if you are missing the xpad rule.
 ### I can see the original controller and that is causing issues in X
 Hiding the original controller is a complex process, so it was skipped for the
 v0.1.* versions of HHD.
-However, it is implemented properly in v0.2 which will be released soon.
-Some emulators select the original controller as controller 1, which might
-cause issues.
-If this is the case, wait for version 2.
+However, it is implemented properly in v0.2.
+Some emulators select the original controller as controller 1, which caused 
+issues.
+This is not the case anymore.
 
 ### Yuzu does not work with the DS5 controller
 See above.
@@ -324,7 +325,8 @@ The gyro will freeze and will be unusable after that.
 HHD remaps the touchpad of the legion go to the DS5 touchpad.
 The playstation driver does not support right clicking.
 Switch to d-input to enable the touchpad when you're in the desktop.
-You can also disable touchpad emulation in the config.
+You can also disable touchpad emulation in the config or use evdev emulation
+which does not use the touchpad.
 
 ### HandyGCCS
 HHD replicates all functionality of HandyGCCS for the Legion Go, so it is not

src/hhd/__main__.py

@@ -199,8 +199,8 @@ def main():
         for plugs in plugins.values():
             sorted_plugins.extend(plugs)
         sorted_plugins.sort(key=lambda x: x.priority)
-        validator: Validator = lambda family, config, value: any(
-            p.validate(family, config, value) for p in sorted_plugins
+        validator: Validator = lambda tags, config, value: any(
+            p.validate(tags, config, value) for p in sorted_plugins
         )
 
         if not sorted_plugins:

src/hhd/plugins/plugin.py

@@ -75,7 +75,7 @@ def open(
     def settings(self) -> HHDSettings:
         return {}
 
-    def validate(self, family: Sequence[str], config: Any, value: Any):
+    def validate(self, tags: Sequence[str], config: Any, value: Any):
         return False
 
     def prepare(self, conf: Config):

src/hhd/plugins/settings.py

@@ -24,7 +24,7 @@ class ButtonSetting(TypedDict):
     """Just a button, emits an event. Used for resets, etc."""
 
     type: Literal["event"]
-    family: Sequence[str]
+    tags: Sequence[str]
     title: str
     hint: str | None
 
@@ -35,7 +35,7 @@ class BooleanSetting(TypedDict):
     """Checkbox container."""
 
     type: Literal["bool"]
-    family: Sequence[str]
+    tags: Sequence[str]
     title: str
     hint: str | None
 
@@ -46,7 +46,7 @@ class MultipleSetting(TypedDict):
     """Select one container."""
 
     type: Literal["multiple"]
-    family: Sequence[str]
+    tags: Sequence[str]
     title: str
     hint: str | None
 
@@ -58,7 +58,7 @@ class DiscreteSetting(TypedDict):
     """Ordered and fixed numerical options (etc. tdp)."""
 
     type: Literal["discrete"]
-    family: Sequence[str]
+    tags: Sequence[str]
     title: str
     hint: str | None
 
@@ -70,7 +70,7 @@ class NumericalSetting(TypedDict):
     """Floating numerical option."""
 
     type: Literal["float"]
-    family: Sequence[str]
+    tags: Sequence[str]
     title: str
     hint: str | None
 
@@ -83,7 +83,7 @@ class IntegerSetting(TypedDict):
     """Floating numerical option."""
 
     type: Literal["int"]
-    family: Sequence[str]
+    tags: Sequence[str]
     title: str
     hint: str | None
 
@@ -102,7 +102,7 @@ class ColorSetting(TypedDict):
     """RGB color setting."""
 
     type: Literal["color"]
-    family: Sequence[str]
+    tags: Sequence[str]
     title: str
     hint: str | None
 
@@ -115,15 +115,15 @@ class CustomSetting(TypedDict):
     Can be used for any required custom setting that is not covered by the
     default ones (e.g., fan curves, deadzones).
 
-    The setting type is defined by family.
+    The setting type is defined by tags.
     Then, the config variable can be used to supply option specific information
     (e.g., for fan curves how many temperature points are available).
 
     To validate this setting, each loaded plugin's validate function is called,
-    with the family, config data, and the supplied value."""
+    with the tags, config data, and the supplied value."""
 
     type: Literal["custom"]
-    family: Sequence[str]
+    tags: Sequence[str]
     title: str
     hint: str | None
 
@@ -151,7 +151,7 @@ class Container(TypedDict):
     """Holds a variety of settings."""
 
     type: Literal["container"]
-    family: Sequence[str]
+    tags: Sequence[str]
     title: str
     hint: str | None
 
@@ -162,7 +162,7 @@ class Mode(TypedDict):
     """Holds a number of containers, only one of whih can be active at a time."""
 
     type: Literal["mode"]
-    family: Sequence[str]
+    tags: Sequence[str]
     title: str
     hint: str | None
 
@@ -221,7 +221,7 @@ class Mode(TypedDict):
 )
 
 
-Section = MutableMapping[str, Container]
+Section = Mapping[str, Container]
 
 HHDSettings = Mapping[str, Section]
 
@@ -251,7 +251,7 @@ def parse_defaults(sets: HHDSettings):
 
 def fill_in_defaults(s: Setting | Container | Mode):
     s = copy(s)
-    s["family"] = s.get("family", [])
+    s["tags"] = s.get("tags", [])
     s["title"] = s.get("title", "")
     s["hint"] = s.get("hint", None)
     if s["type"] != "container":
@@ -658,7 +658,7 @@ def unravel_options(settings: HHDSettings):
 
 
 class Validator(Protocol):
-    def __call__(self, family: Sequence[str], config: Any, value: Any) -> bool:
+    def __call__(self, tags: Sequence[str], config: Any, value: Any) -> bool:
         return False
 
 
@@ -723,7 +723,7 @@ def validate_config(
                     else:
                         del conf[k]
             case "custom":
-                if not validator(d["family"], d["config"], v):
+                if not validator(d["tags"], d["config"], v):
                     if use_defaults:
                         conf[k] = default
                     else: