From 93dc859f7d6dc6c905337b102c030cc399b47b90 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Guido=20G=C3=BCnther?= <agx@sigxcpu.org>
Date: Wed, 11 Dec 2024 12:46:51 +0100
Subject: [PATCH] data: Add vibration API
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

The API is meant to trigger the given vibration pattern on the haptic
device. The pattern is sequence of relative amplitude and duration
pairs. A magnitude of 0.0 indicates a pause.

Signed-off-by: Guido Günther <agx@sigxcpu.org>
---
 data/meson.build                     |  5 ++++-
 data/org.sigxcpu.Feedback.Haptic.xml | 32 ++++++++++++++++++++++++++++
 2 files changed, 36 insertions(+), 1 deletion(-)
 create mode 100644 data/org.sigxcpu.Feedback.Haptic.xml

diff --git a/data/meson.build b/data/meson.build
index 7ff25cc..728989d 100644
--- a/data/meson.build
+++ b/data/meson.build
@@ -4,7 +4,10 @@ namespace = 'LfbGdbus'
 
 generated_dbus_sources = []
 
-dbus_interfaces = [ 'org.sigxcpu.Feedback.xml' ]
+dbus_interfaces = [
+  'org.sigxcpu.Feedback.xml',
+  'org.sigxcpu.Feedback.Haptic.xml',
+]
 
 generated_dbus_sources += gnome.gdbus_codegen('lfb-gdbus',
       sources          : dbus_interfaces,
diff --git a/data/org.sigxcpu.Feedback.Haptic.xml b/data/org.sigxcpu.Feedback.Haptic.xml
new file mode 100644
index 0000000..ea6c4ee
--- /dev/null
+++ b/data/org.sigxcpu.Feedback.Haptic.xml
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<node>
+  <!-- org.sigxcpu.Feedback.Haptic
+       @short_description: Interface to make a device vibrate
+
+       This D-Bus interface is used to make a device's haptic motor
+       vibrate. This is can be useful e.g. for games.
+
+       To provider user feedback the event based interface should be
+       preferred.
+   -->
+  <interface name="org.sigxcpu.Feedback.Haptic">
+    <!--
+        Vibrate:
+        @app_id: The application id usually in "reverse DNS" format
+        @pattern: The vibration pattern.
+        @success: Whether vibration was triggered
+
+        Triggers the given vibration pattern on the haptic device. The
+        pattern is a sequence of relative amplitude and duration pairs.
+        The amplitude must be between 0.0 and 1.0.
+    -->
+    <method name="Vibrate">
+      <arg direction="in" name="app_id" type="s"/>
+      <arg direction="in" name="pattern" type="a(du)"/>
+      <arg direction="out" name="success" type="b"/>
+    </method>
+
+  </interface>
+
+</node>