From 3b49e8ad6693922c9ea47d810072edaa93ec4db8 Mon Sep 17 00:00:00 2001
From: William Edwards <shadowapex@gmail.com>
Date: Fri, 23 Feb 2024 21:05:17 -0800
Subject: [PATCH] chore(docs): add xml spec and docs for dbus target device

---
 Cargo.lock                                    |  2 +-
 Makefile                                      |  2 +
 .../org.shadowblip.Input.DBusDevice.xml       | 55 +++++++++++
 docs/target_dbus_device.md                    | 97 +++++++++++++++++++
 4 files changed, 155 insertions(+), 1 deletion(-)
 create mode 100644 bindings/dbus-xml/org.shadowblip.Input.DBusDevice.xml
 create mode 100644 docs/target_dbus_device.md

diff --git a/Cargo.lock b/Cargo.lock
index 211a070..95458a0 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -604,7 +604,7 @@ dependencies = [
 
 [[package]]
 name = "inputplumber"
-version = "0.3.2"
+version = "0.3.3"
 dependencies = [
  "evdev",
  "glob-match",
diff --git a/Makefile b/Makefile
index 517e71c..d956042 100644
--- a/Makefile
+++ b/Makefile
@@ -150,6 +150,8 @@ docs: ## Generate markdown docs for DBus interfaces
 	sed -i 's/DBus Interface API/Source HIDRaw DBus Interface API/g' ./docs/source_hidraw_device.md
 	xsltproc --novalid -o docs/keyboard.md $(XSL_TEMPLATE) ./bindings/dbus-xml/org.shadowblip.Input.Keyboard
 	sed -i 's/DBus Interface API/Keyboard DBus Interface API/g' ./docs/keyboard.md
+	xsltproc --novalid -o docs/target_dbus_device.md $(XSL_TEMPLATE) ./bindings/dbus-xml/org.shadowblip.Input.DBusDevice.xml
+	sed -i 's/DBus Interface API/Target DBus Device Interface API/g' ./docs/target_dbus_device.md
 
 # Refer to .releaserc.yaml for release configuration
 .PHONY: sem-release 
diff --git a/bindings/dbus-xml/org.shadowblip.Input.DBusDevice.xml b/bindings/dbus-xml/org.shadowblip.Input.DBusDevice.xml
new file mode 100644
index 0000000..3a6bd5d
--- /dev/null
+++ b/bindings/dbus-xml/org.shadowblip.Input.DBusDevice.xml
@@ -0,0 +1,55 @@
+
+<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
+ "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
+<node>
+  <interface name="org.freedesktop.DBus.Peer">
+    <method name="Ping">
+    </method>
+    <method name="GetMachineId">
+      <arg type="s" direction="out"/>
+    </method>
+  </interface>
+  <interface name="org.freedesktop.DBus.Introspectable">
+    <method name="Introspect">
+      <arg type="s" direction="out"/>
+    </method>
+  </interface>
+  <interface name="org.shadowblip.Input.DBusDevice">
+    <!--
+     Emitted when an input event occurs
+     -->
+    <signal name="InputEvent">
+      <arg name="event" type="s"/>
+      <arg name="value" type="d"/>
+    </signal>
+    <!--
+     Name of the DBus device
+     -->
+    <property name="Name" type="s" access="read"/>
+  </interface>
+  <interface name="org.freedesktop.DBus.Properties">
+    <method name="Get">
+      <arg name="interface_name" type="s" direction="in"/>
+      <arg name="property_name" type="s" direction="in"/>
+      <arg type="v" direction="out"/>
+    </method>
+    <method name="Set">
+      <arg name="interface_name" type="s" direction="in"/>
+      <arg name="property_name" type="s" direction="in"/>
+      <arg name="value" type="v" direction="in"/>
+    </method>
+    <method name="GetAll">
+      <arg name="interface_name" type="s" direction="in"/>
+      <arg type="a{sv}" direction="out"/>
+    </method>
+    <!--
+     Emits the `org.freedesktop.DBus.Properties.PropertiesChanged` signal.
+     -->
+    <signal name="PropertiesChanged">
+      <arg name="interface_name" type="s"/>
+      <arg name="changed_properties" type="a{sv}"/>
+      <arg name="invalidated_properties" type="as"/>
+    </signal>
+  </interface>
+</node>
+
diff --git a/docs/target_dbus_device.md b/docs/target_dbus_device.md
new file mode 100644
index 0000000..c06cf3c
--- /dev/null
+++ b/docs/target_dbus_device.md
@@ -0,0 +1,97 @@
+# Target DBus Device Interface API
+
+## org.freedesktop.DBus.Peer
+
+### Methods
+
+#### Ping
+
+#### GetMachineId
+
+##### Arguments
+
+| Name | Direction | Type | Description |
+| --- | :---: | :---: | --- |
+| \*\*\*\* | *out* | *s* |  |
+
+### Signals
+
+## org.freedesktop.DBus.Introspectable
+
+### Methods
+
+#### Introspect
+
+##### Arguments
+
+| Name | Direction | Type | Description |
+| --- | :---: | :---: | --- |
+| \*\*\*\* | *out* | *s* |  |
+
+### Signals
+
+## org.shadowblip.Input.DBusDevice
+
+### Properties
+
+| Name | Access | Type | Description |
+| --- | :---: | :---: | --- |
+| **Name** | *read* | *s* |  |
+
+### Methods
+
+### Signals
+
+#### InputEvent
+
+##### Arguments
+
+| Name | Direction | Type | Description |
+| --- | :---: | :---: | --- |
+| **event** | \*\* | *s* |  |
+| **value** | \*\* | *d* |  |
+
+## org.freedesktop.DBus.Properties
+
+### Methods
+
+#### Get
+
+##### Arguments
+
+| Name | Direction | Type | Description |
+| --- | :---: | :---: | --- |
+| **interface_name** | *in* | *s* |  |
+| **property_name** | *in* | *s* |  |
+| \*\*\*\* | *out* | *v* |  |
+
+#### Set
+
+##### Arguments
+
+| Name | Direction | Type | Description |
+| --- | :---: | :---: | --- |
+| **interface_name** | *in* | *s* |  |
+| **property_name** | *in* | *s* |  |
+| **value** | *in* | *v* |  |
+
+#### GetAll
+
+##### Arguments
+
+| Name | Direction | Type | Description |
+| --- | :---: | :---: | --- |
+| **interface_name** | *in* | *s* |  |
+| \*\*\*\* | *out* | *a{sv}* |  |
+
+### Signals
+
+#### PropertiesChanged
+
+##### Arguments
+
+| Name | Direction | Type | Description |
+| --- | :---: | :---: | --- |
+| **interface_name** | \*\* | *s* |  |
+| **changed_properties** | \*\* | *a{sv}* |  |
+| **invalidated_properties** | \*\* | *as* |  |