[PATCH BlueZ v2 3/3] doc: Add org.bluez.CSDistanceProviderManager documentation
Naga Bhavani Akella <[email protected]> Fri, 31 Jul 2026 12:31:59 +0530
| Newsgroups | org.kernel.vger.linux-bluetooth |
|---|---|
| Message-ID | <[email protected]> |
Document the org.bluez.CSDistanceProviderManager
interface, used by external clients to register and unregister
themselves as Channel Sounding distance providers via
RegisterDistanceProvider/UnregisterDistanceProvider.
---
Makefile.am | 9 ++--
doc/org.bluez.CSDistanceProviderManager.rst | 53 +++++++++++++++++++++
2 files changed, 59 insertions(+), 3 deletions(-)
create mode 100644 doc/org.bluez.CSDistanceProviderManager.rst
diff --git a/Makefile.am b/Makefile.am
index 53bbfd0d2..f003b041c 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -407,7 +407,8 @@ man_MANS += doc/org.bluez.ThermometerManager.5 \
doc/org.bluez.ThermometerWatcher.5
man_MANS += doc/org.bluez.ChannelSounding1.5 \
doc/org.bluez.CSDistance1.5 \
- doc/org.bluez.CSDistanceProvider.5
+ doc/org.bluez.CSDistanceProvider.5 \
+ doc/org.bluez.CSDistanceProviderManager.5
endif
manual_pages += doc/bluetoothd.8
manual_pages += doc/hci.7 doc/mgmt.7 doc/l2cap.7 doc/rfcomm.7 doc/sco.7 \
@@ -450,7 +451,8 @@ manual_pages += doc/org.bluez.ThermometerManager.5 \
doc/org.bluez.ThermometerWatcher.5
manual_pages += doc/org.bluez.ChannelSounding1.5 \
doc/org.bluez.CSDistance1.5 \
- doc/org.bluez.CSDistanceProvider.5
+ doc/org.bluez.CSDistanceProvider.5 \
+ doc/org.bluez.CSDistanceProviderManager.5
EXTRA_DIST += src/genbuiltin src/bluetooth.conf \
src/main.conf profiles/network/network.conf \
@@ -541,7 +543,8 @@ EXTRA_DIST += doc/org.bluez.ThermometerManager.rst \
EXTRA_DIST += doc/org.bluez.ChannelSounding1.rst \
doc/org.bluez.CSDistance1.rst \
- doc/org.bluez.CSDistanceProvider.rst
+ doc/org.bluez.CSDistanceProvider.rst \
+ doc/org.bluez.CSDistanceProviderManager.rst
EXTRA_DIST += doc/pics-opp.txt doc/pixit-opp.txt \
doc/pts-opp.txt
diff --git a/doc/org.bluez.CSDistanceProviderManager.rst b/doc/org.bluez.CSDistanceProviderManager.rst
new file mode 100644
index 000000000..efc01800d
--- /dev/null
+++ b/doc/org.bluez.CSDistanceProviderManager.rst
@@ -0,0 +1,53 @@
+====================================
+org.bluez.CSDistanceProviderManager
+====================================
+
+--------------------------------------------------------
+BlueZ D-Bus CSDistanceProviderManager API documentation
+--------------------------------------------------------
+
+:Version: BlueZ
+:Date: July 2026
+:Manual section: 5
+:Manual group: Linux System Administration
+
+Description
+===========
+
+A Channel Sounding distance provider starts by registering itself as a
+distance provider with the **RegisterDistanceProvider()** method passing
+an object path as the provider ID. Then, it can start exposing
+**org.bluez.CSDistanceProvider(5)** objects having the path
+starting with the given provider ID. It can also remove objects at any
+time.
+The objects and their properties exposed by distance providers will be
+reflected on the matching **org.bluez.CSDistance1(5)**
+interface.
+
+**bluetoothd(8)** will stop monitoring these exposed and removed objects
+after UnregisterDistanceProvider is called for that provider ID.
+
+Interface
+=========
+
+:Service: org.bluez
+:Interface: org.bluez.CSDistanceProviderManager1
+:Object path: /org/bluez/{hci0,hci1,...}
+
+Methods
+-------
+
+void RegisterDistanceProvider(object provider)
+``````````````````````````````````````````````
+
+Registers a distance provider. A registered distance provider can then
+expose objects with **org.bluez.CSDistanceProvider(5)**
+interface.
+
+void UnregisterDistanceProvider(object provider)
+````````````````````````````````````````````````
+
+Unregisters a distance provider previously registered with
+**RegisterDistanceProvider()**. After unregistration, the
+**org.bluez.CSDistanceProvider(5)** objects provided by this
+client are ignored by **bluetoothd(8)**.
--