doc: Add set-api

This adds set-api.rst which documents DeviceSet interface.

diff --git a/doc/set-api.rst b/doc/set-api.rst
new file mode 100644 (file)
index 0000000..c49be1a
--- /dev/null
+++ b/doc/set-api.rst
@@ -0,0 +1,53 @@
+=====================================
+BlueZ D-Bus DeviceSet API description
+=====================================
+
+
+DeviceSet interface
+===================
+
+Service                org.bluez
+Interface      org.bluez.DeviceSet1
+Object path    [variable prefix]/{hci0,hci1,...}/set_{sirk}
+
+Methods
+=======
+
+**void Connect() [experimental]**
+
+       Connects all **devices** members of the set, each member is
+       connected in sequence as they were added/loaded following the
+       same proceedure as described in **Device1.Connect**.
+
+       Possible errors: org.bluez.Error.NotReady
+                        org.bluez.Error.Failed
+                        org.bluez.Error.InProgress
+                        org.bluez.Error.AlreadyConnected
+
+**void Disconnect() [experimental]**
+
+       Disconnects all **devices** members of the set, each member is
+       disconnected in sequence as they were connected following the
+       same proceedure as described in **Device1.Disconnect**.
+
+       Possible errors: org.bluez.Error.NotConnected
+
+Properties
+==========
+
+**object Adapter [readonly]**
+
+       The object path of the adapter the set belongs to.
+
+**bool AutoConnect [read-write, experimental]**
+
+       Indicates if the **devices** members of the set shall be automatically
+       connected once any of its members is connected.
+
+**array(object) Devices [ready-only, experimental]**
+
+       List of devices objects that are members of the set.
+
+**byte Size [read-only, experimental]**
+
+       Set members size.