Test addition of dial capability

Signed-off-by: Luke Jones <[email protected]>

Author: flukejones

rootfs/usr/share/inputplumber/capability_maps/zone_type1.yaml

@@ -67,6 +67,43 @@ mapping:
     target_event:
       gamepad:
         button: RightPaddle1
+  - name: Left Dial Counter-clockwise
+    source_events:
+      - evdev:
+          event_type: REL
+          event_code: REL_HWHEEL
+          value_type: joystick_x
+    target_event:
+      keyboard: KeyVolumeDown
+  - name: Left Dial Clockwise
+    source_events:
+      - evdev:
+          event_type: REL
+          event_code: REL_HWHEEL
+          value_type: joystick_x
+    target_event:
+      keyboard: KeyVolumeUp
+  - name: Right Dial Counter-clockwise
+    source_events:
+      - evdev:
+          event_code: REL_WHEEL
+          event_type: REL
+          value_type: joystick_x
+    target_event:
+      gamepad:
+        dial:
+          name: RightStickDial
+          direction: clockwise
+  - name: Right Dial Clockwise
+    source_events:
+      - evdev:
+          event_code: REL_WHEEL
+          event_type: REL
+          value_type: joystick_x
+    target_event:
+      dial:
+        name: RightStickDial
+        direction: counter_clockwise
 
 # List of events to filter from the source devices
 filtered_events: []

rootfs/usr/share/inputplumber/devices/50-zotac-zone.yaml

@@ -53,6 +53,7 @@ source_devices:
       vendor_id: "1ee9"
       product_id: "1590"
       handler: event*
+    capability_map_id: zone1
   - group: imu
     iio:
       name: i2c-BMI0160:00

rootfs/usr/share/inputplumber/profiles/default.yaml

@@ -46,3 +46,38 @@ mapping:
     target_events:
       - gamepad:
           button: Screenshot
+  - name: Left Dial Counter-clockwise
+    source_event:
+      gamepad:
+        dial:
+          name: LeftStick
+          direction: counter-clockwise
+    target_events:
+      - mouse:
+          button: "WheelLeft"
+  - name: Left Dial Clockwise
+    source_event:
+      gamepad:
+        dial:
+          name: LeftStick
+          direction: clockwise
+    target_events:
+      - mouse:
+          button: "WheelRight"
+  - name: Right Dial Counter-clockwise
+    source_event:
+      gamepad:
+        dial:
+          name: RightStick
+          direction: counter-clockwise
+    target_events:
+      - mouse:
+          button: "WheelUp"
+  - name: Right Dial Clockwise
+    source_event:
+      dial:
+          name: RightStick
+          direction: clockwise
+    target_events:
+      - mouse:
+          button: "WheelDown"

rootfs/usr/share/inputplumber/schema/capability_map_v2.json

@@ -186,6 +186,25 @@
         }
       }
     },
+    "DialCapability": {
+      "description": "The Dial direction can be used to map clockwise or counter-clockwise turns.",
+      "type": "object",
+      "required": [
+        "name",
+        "direction"
+      ],
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "direction": {
+          "enum": [
+            "clockwise",
+            "counter_clockwise"
+          ]
+        }
+      }
+    },
     "EvdevConfig": {
       "description": "An [EvdevConfig] defines a matching evdev input event",
       "type": "object",
@@ -1121,7 +1140,17 @@
               "type": "null"
             }
           ]
-        }
+        },
+        "dial": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/DialCapability"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
       }
     },
     "GyroCapability": {
@@ -1362,4 +1391,4 @@
       ]
     }
   }
-}
+}

rootfs/usr/share/inputplumber/schema/device_profile_v1.json

@@ -421,6 +421,9 @@
         "trigger": {
           "$ref": "#/definitions/TriggerEvent"
         },
+        "dial": {
+          "$ref": "#/definitions/DialEvent"
+        },
         "button": {
           "type": "string",
           "enum": [
@@ -567,6 +570,32 @@
       "required": [
         "name"
       ]
+    },
+    "DialEvent": {
+      "title": "DialEvent",
+      "type": "object",
+      "description": "Dial or Wheel events such as LeftStick, RightStick, etc.",
+      "additionalProperties": false,
+      "properties": {
+        "name": {
+          "type": "string",
+          "enum": [
+            "LeftStick",
+            "RightStick"
+          ]
+        },
+        "direction": {
+          "type": "string",
+          "description": "Optional direction of the axis. Used when converting axis events into button events.",
+          "enum": [
+            "clockwise",
+            "counter-clockwise"
+          ]
+        }
+      },
+      "required": [
+        "name"
+      ]
     }
   }
 }

src/config/capability_map.rs

@@ -218,6 +218,7 @@ pub struct GamepadCapability {
     pub trigger: Option<TriggerCapability>,
     pub gyro: Option<GyroCapability>,
     pub accelerometer: Option<AccelerometerCapability>,
+    pub dial: Option<DialCapability>,
 }
 
 #[derive(Debug, Deserialize, Serialize, Clone, JsonSchema, PartialEq)]
@@ -253,6 +254,13 @@ pub struct AccelerometerCapability {
     pub axis: Option<String>,
 }
 
+#[derive(Debug, Deserialize, Serialize, Clone, JsonSchema, PartialEq)]
+#[serde(rename_all = "snake_case")]
+pub struct DialCapability {
+    pub name: String,
+    pub direction: Option<String>,
+}
+
 #[derive(Debug, Deserialize, Serialize, Clone, JsonSchema, PartialEq)]
 #[serde(rename_all = "snake_case")]
 pub struct MouseCapability {

src/dbus/interface/composite_device.rs

@@ -275,6 +275,7 @@ impl CompositeDeviceInterface {
                     Gamepad::Trigger(trigger) => format!("Gamepad:Trigger:{}", trigger),
                     Gamepad::Accelerometer => "Gamepad:Accelerometer".to_string(),
                     Gamepad::Gyro => "Gamepad:Gyro".to_string(),
+                    Gamepad::Dial(dial) => format!("Gamepad:Dial:{dial}"),
                 },
                 Capability::Mouse(mouse) => match mouse {
                     Mouse::Motion => "Mouse:Motion".to_string(),
@@ -307,6 +308,7 @@ impl CompositeDeviceInterface {
                     Gamepad::Trigger(trigger) => format!("Gamepad:Trigger:{}", trigger),
                     Gamepad::Accelerometer => "Gamepad:Accelerometer".to_string(),
                     Gamepad::Gyro => "Gamepad:Gyro".to_string(),
+                    Gamepad::Dial(dial) => format!("Gamepad:Dial:{dial}"),
                 },
                 Capability::Mouse(mouse) => match mouse {
                     Mouse::Motion => "Mouse:Motion".to_string(),

src/drivers/unified_gamepad/capability.rs

@@ -686,6 +686,11 @@ pub enum InputCapability {
     /// Right analog stick force sensor, Steam Deck right stick force
     GamepadTriggerRightStickForce = 0x505,
 
+    /// Left dial/wheel, Zotac Zone left dial
+    GamepadDialLeft = 0x550,
+    /// Right dial/wheel, Zotac Zone right dial
+    GamepadDialRight = 0x551,
+
     /// Center or main gyro sensor
     GamepadGyroCenter = 0x600,
     /// Left side gamepad gyro

src/input/capability.rs

@@ -139,6 +139,17 @@ impl From<CapabilityConfig> for Capability {
 
                 return Capability::Gamepad(Gamepad::Accelerometer);
             }
+
+            // Dials/wheels
+            if let Some(dial_config) = gamepad.dial.as_ref() {
+                let dial = GamepadDial::from_str(&dial_config.name);
+                if dial.is_err() {
+                    log::error!("Invalid or unimplemented dial: {}", dial_config.name);
+                    return Capability::NotImplemented;
+                }
+                let dial = dial.unwrap();
+                return Capability::Gamepad(Gamepad::Dial(dial));
+            }
         }
 
         // Keyboard
@@ -251,6 +262,8 @@ pub enum Gamepad {
     /// Gyro events measure the angular velocity of a device measured
     /// with (x, y, z) values normalized to degrees per second.
     Gyro,
+    /// Dials and wheels
+    Dial(GamepadDial),
 }
 
 impl fmt::Display for Gamepad {
@@ -261,6 +274,7 @@ impl fmt::Display for Gamepad {
             Gamepad::Trigger(_) => write!(f, "Trigger"),
             Gamepad::Accelerometer => write!(f, "Accelerometer"),
             Gamepad::Gyro => write!(f, "Gyro"),
+            Gamepad::Dial(_) => write!(f, "Dial"),
         }
     }
 }
@@ -284,6 +298,9 @@ impl FromStr for Gamepad {
             )?)),
             "Accelerometer" => Ok(Gamepad::Accelerometer),
             "Gyro" => Ok(Gamepad::Gyro),
+            "Dial" => Ok(Gamepad::Dial(GamepadDial::from_str(
+                parts.join(":").as_str(),
+            )?)),
             _ => Err(()),
         }
     }
@@ -609,6 +626,33 @@ impl FromStr for GamepadTrigger {
     }
 }
 
+#[derive(Clone, Debug, PartialEq, Eq, Hash)]
+pub enum GamepadDial {
+    LeftStickDial,
+    RightStickDial,
+}
+
+impl fmt::Display for GamepadDial {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        match self {
+            GamepadDial::LeftStickDial => write!(f, "LeftStickDial"),
+            GamepadDial::RightStickDial => write!(f, "RightStickDial"),
+        }
+    }
+}
+
+impl FromStr for GamepadDial {
+    type Err = ();
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        match s {
+            "LeftStickDial" => Ok(GamepadDial::LeftStickDial),
+            "RightStickDial" => Ok(GamepadDial::RightStickDial),
+            _ => Err(()),
+        }
+    }
+}
+
 #[derive(Clone, Debug, PartialEq, Eq, Hash)]
 pub enum Keyboard {
     Key0,

src/input/composite_device/mod.rs

@@ -928,7 +928,8 @@ impl CompositeDevice {
                     Gamepad::Axis(_)
                     | Gamepad::Trigger(_)
                     | Gamepad::Accelerometer
-                    | Gamepad::Gyro => {}
+                    | Gamepad::Gyro
+                    | Gamepad::Dial(_) => {}
                 },
                 Capability::Mouse(ref t) => match t {
                     Mouse::Motion => {}

src/input/event/evdev.rs

@@ -573,6 +573,7 @@ fn event_type_from_capability(capability: Capability) -> Option<EventType> {
             },
             Gamepad::Axis(_) => Some(EventType::ABSOLUTE),
             Gamepad::Trigger(_) => Some(EventType::ABSOLUTE),
+            Gamepad::Dial(_) => Some(EventType::ABSOLUTE),
             Gamepad::Accelerometer => None,
             Gamepad::Gyro => None,
         },
@@ -678,6 +679,14 @@ fn event_codes_from_capability(capability: Capability) -> Vec<u16> {
             },
             Gamepad::Accelerometer => vec![],
             Gamepad::Gyro => vec![],
+            Gamepad::Dial(dial) => match dial {
+                crate::input::capability::GamepadDial::LeftStickDial => {
+                    vec![RelativeAxisCode::REL_HWHEEL.0]
+                }
+                crate::input::capability::GamepadDial::RightStickDial => {
+                    vec![RelativeAxisCode::REL_WHEEL.0]
+                }
+            },
         },
         Capability::Mouse(mouse) => match mouse {
             Mouse::Motion => vec![RelativeAxisCode::REL_X.0, RelativeAxisCode::REL_Y.0],