From 32b6d7394e9466d1769ad6a9b9fc65c6943a9b1d Mon Sep 17 00:00:00 2001 From: Luiz Augusto von Dentz Date: Thu, 28 Sep 2023 17:51:07 -0700 Subject: [PATCH] doc/set-api: Rename to org.bluez.DeviceSet This renames set-api.rst to org.bluez.DeviceSet.rst and generate a manpage org.bluez.DeviceSet.5. --- Makefile.am | 4 +++ doc/org.bluez.DeviceSet.rst | 71 +++++++++++++++++++++++++++++++++++++ doc/set-api.rst | 53 --------------------------- 3 files changed, 75 insertions(+), 53 deletions(-) create mode 100644 doc/org.bluez.DeviceSet.rst delete mode 100644 doc/set-api.rst diff --git a/Makefile.am b/Makefile.am index a17841b06..cc2e454f7 100644 --- a/Makefile.am +++ b/Makefile.am @@ -357,12 +357,14 @@ CLEANFILES += $(builtin_files) src/bluetooth.service if MANPAGES man_MANS += src/bluetoothd.8 +man_MANS += doc/org.bluez.DeviceSet.5 man_MANS += doc/org.bluez.Media.5 doc/org.bluez.MediaControl.5 \ doc/org.bluez.MediaPlayer.5 doc/org.bluez.MediaFolder.5 \ doc/org.bluez.MediaItem.5 doc/org.bluez.MediaEndpoint.5 \ doc/org.bluez.MediaTransport.5 endif manual_pages += src/bluetoothd.8 +manual_pages += doc/org.bluez.DeviceSet.5 manual_pages += doc/org.bluez.Media.5 doc/org.bluez.MediaControl.5 \ doc/org.bluez.MediaPlayer.5 doc/org.bluez.MediaFolder.5 \ doc/org.bluez.MediaItem.5 doc/org.bluez.MediaEndpoint.5 \ @@ -408,6 +410,8 @@ EXTRA_DIST += doc/mgmt-api.txt \ doc/network-api.txt doc/health-api.txt \ doc/sap-api.txt doc/input-api.txt +EXTRA_DIST += doc/org.bluez.DeviceSet.rst + EXTRA_DIST += doc/org.bluez.Media.rst doc/org.bluez.MediaControl.rst \ doc/org.bluez.MediaPlayer.rst doc/org.bluez.MediaFolder.rst \ doc/org.bluez.MediaItem.rst doc/org.bluez.MediaEndpoint.rst \ diff --git a/doc/org.bluez.DeviceSet.rst b/doc/org.bluez.DeviceSet.rst new file mode 100644 index 000000000..c6dc8b075 --- /dev/null +++ b/doc/org.bluez.DeviceSet.rst @@ -0,0 +1,71 @@ +=================== +org.bluez.DeviceSet +=================== + +--------------------------------------- +BlueZ D-Bus DeviceSet API documentation +--------------------------------------- + +:Version: BlueZ +:Date: September 2023 +:Manual section: 5 +:Manual group: Linux System Administration + +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, experimental] +``````````````````````````````````````` + + 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. diff --git a/doc/set-api.rst b/doc/set-api.rst deleted file mode 100644 index c49be1ae0..000000000 --- a/doc/set-api.rst +++ /dev/null @@ -1,53 +0,0 @@ -===================================== -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.47.3