From: Luiz Augusto von Dentz <luiz.dentz@gmail.com>
To: linux-bluetooth@vger.kernel.org
Subject: [RFC v2 03/12] doc: Add set-api
Date: Tue, 7 Mar 2023 14:24:13 -0800 [thread overview]
Message-ID: <20230307222422.2608483-3-luiz.dentz@gmail.com> (raw)
In-Reply-To: <20230307222422.2608483-1-luiz.dentz@gmail.com>
From: Luiz Augusto von Dentz <luiz.von.dentz@intel.com>
This adds set-api.rst which documents DeviceSet interface.
---
doc/set-api.rst | 53 +++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 53 insertions(+)
create mode 100644 doc/set-api.rst
diff --git a/doc/set-api.rst b/doc/set-api.rst
new file mode 100644
index 000000000000..c49be1ae0514
--- /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.
--
2.39.2
next prev parent reply other threads:[~2023-03-07 22:25 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-03-07 22:24 [RFC v2 01/12] shared/crypto: Add bt_crypto_sirk Luiz Augusto von Dentz
2023-03-07 22:24 ` [RFC v2 02/12] shared/ad: Add RSI data type Luiz Augusto von Dentz
2023-03-07 22:24 ` Luiz Augusto von Dentz [this message]
2023-03-07 22:24 ` [RFC v2 04/12] device-api: Add Set property Luiz Augusto von Dentz
2023-03-07 22:24 ` [RFC v2 05/12] core: Add initial implementation of DeviceSet interface Luiz Augusto von Dentz
2023-03-07 22:24 ` [RFC v2 06/12] core: Check if device has RSI Luiz Augusto von Dentz
2023-03-07 22:24 ` [RFC v2 07/12] main.conf: Add CSIP profile configurable options Luiz Augusto von Dentz
2023-03-07 22:24 ` [RFC v2 08/12] shared/csip: Add initial code for handling CSIP Luiz Augusto von Dentz
2023-03-07 22:24 ` [RFC v2 09/12] profiles: Add initial code for csip plugin Luiz Augusto von Dentz
2023-03-07 22:24 ` [RFC v2 10/12] tools: Add support to generate RSI using SIRK Luiz Augusto von Dentz
2023-03-07 22:24 ` [RFC v2 11/12] client: Add support for DeviceSet proxy Luiz Augusto von Dentz
2023-03-07 22:24 ` [RFC v2 12/12] client: Use AdvertisingFlags when available Luiz Augusto von Dentz
2023-03-08 2:12 ` [RFC,v2,01/12] shared/crypto: Add bt_crypto_sirk bluez.test.bot
2023-03-11 0:40 ` [RFC v2 01/12] " patchwork-bot+bluetooth
2023-03-13 5:36 ` Luiz Augusto von Dentz
2023-03-13 23:29 ` Pauli Virtanen
2023-03-14 0:18 ` Luiz Augusto von Dentz
2023-03-14 0:57 ` Pauli Virtanen
2023-04-06 0:16 ` Luiz Augusto von Dentz
2023-04-06 18:08 ` Pauli Virtanen
2023-04-06 20:14 ` Luiz Augusto von Dentz
2023-04-13 18:48 ` Luiz Augusto von Dentz
2023-04-13 21:14 ` Pauli Virtanen
2023-04-14 21:56 ` Luiz Augusto von Dentz
2023-04-15 14:57 ` Pauli Virtanen
2023-04-13 20:11 ` Pauli Virtanen
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230307222422.2608483-3-luiz.dentz@gmail.com \
--to=luiz.dentz@gmail.com \
--cc=linux-bluetooth@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox