[PATCH BlueZ v1 2/3] doc: Add org.bluez.ChannelSoundingDistanceProvider documentation
Naga Bhavani Akella <[email protected]> Thu, 30 Jul 2026 17:13:39 +0530
| Newsgroups | org.kernel.vger.linux-bluetooth |
|---|---|
| Message-ID | <[email protected]> |
Document the org.bluez.ChannelSoundingDistanceProvider1 interface,
implemented by external clients to expose per-device Channel Sounding
distance estimates that BlueZ reflects onto the corresponding device
object.
---
Makefile.am | 7 ++--
....bluez.ChannelSoundingDistanceProvider.rst | 32 +++++++++++++++++++
2 files changed, 37 insertions(+), 2 deletions(-)
create mode 100644 doc/org.bluez.ChannelSoundingDistanceProvider.rst
diff --git a/Makefile.am b/Makefile.am
index a5a3c0d30..e5ecf232f 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -406,7 +406,8 @@ man_MANS += doc/org.bluez.ThermometerManager.5 \
doc/org.bluez.Thermometer.5 \
doc/org.bluez.ThermometerWatcher.5
man_MANS += doc/org.bluez.ChannelSounding1.5 \
- doc/org.bluez.ChannelSoundingDistance1.5
+ doc/org.bluez.ChannelSoundingDistance1.5 \
+ doc/org.bluez.ChannelSoundingDistanceProvider.5
endif
manual_pages += doc/bluetoothd.8
manual_pages += doc/hci.7 doc/mgmt.7 doc/l2cap.7 doc/rfcomm.7 doc/sco.7 \
@@ -448,7 +449,8 @@ manual_pages += doc/org.bluez.ThermometerManager.5 \
doc/org.bluez.Thermometer.5 \
doc/org.bluez.ThermometerWatcher.5
manual_pages += doc/org.bluez.ChannelSounding1.5 \
- doc/org.bluez.ChannelSoundingDistance1.5
+ doc/org.bluez.ChannelSoundingDistance1.5 \
+ doc/org.bluez.ChannelSoundingDistanceProvider.5
EXTRA_DIST += src/genbuiltin src/bluetooth.conf \
src/main.conf profiles/network/network.conf \
@@ -539,6 +541,7 @@ EXTRA_DIST += doc/org.bluez.ThermometerManager.rst \
EXTRA_DIST += doc/org.bluez.ChannelSounding1.rst \
doc/org.bluez.ChannelSoundingDistance1.rst \
+ doc/org.bluez.ChannelSoundingDistanceProvider.rst
EXTRA_DIST += doc/pics-opp.txt doc/pixit-opp.txt \
doc/pts-opp.txt
diff --git a/doc/org.bluez.ChannelSoundingDistanceProvider.rst b/doc/org.bluez.ChannelSoundingDistanceProvider.rst
new file mode 100644
index 000000000..9a7a390bf
--- /dev/null
+++ b/doc/org.bluez.ChannelSoundingDistanceProvider.rst
@@ -0,0 +1,32 @@
+=========================================
+org.bluez.ChannelSoundingDistanceProvider
+=========================================
+
+-------------------------------------------------------------
+BlueZ D-Bus ChannelSoundingDistanceProvider API documentation
+-------------------------------------------------------------
+
+:Version: BlueZ
+:Date: July 2026
+:Manual section: 5
+:Manual group: Linux System Administration
+
+Interface
+=========
+
+:Service: <client D-Bus address>
+:Interface: org.bluez.ChannelSoundingDistanceProvider1
+:Object path: {provider_root}/{unique distance object path}
+
+Properties
+----------
+
+Objects provided on this interface contain the same properties as
+**org.bluez.ChannelSounding1(5)** interface. Additionally, this interface
+needs to have the Device property indicating the object path of the
+device this distance estimate provides.
+
+object Device [readonly]
+````````````````````````
+
+The object path of the device that this distance estimate applies to.
--