[PATCH BlueZ v2 0/3] doc: Add CS distance provider documentation

[PATCH BlueZ v2 0/3] doc: Add CS distance provider documentation

[Naga Bhavani Akella]

This series documents the D-Bus API that lets an external ranging
daemon compute Channel Sounding distance estimates from the raw
procedure data BlueZ reports, and feed them back for reflection on
the device's Channel Sounding interface

Patch 1 documents CSDistance1, the BlueZ-owned interface
that reflects the provider's DistanceMeters estimate for consumption
by desktop clients.

Patch 2 documents CSDistanceProvider, the interface the
registered provider implements to expose per-device distance
estimates.

Patch 3 documents CSDistanceProviderManager, which a
ranging daemon uses to register/unregister itself as a distance
provider.

Changes in v2:
- Rename doc/org.bluez.ChannelSoundingDistance1.rst
to doc/org.bluez.CSDistance1.rst
- Rename doc/org.bluez.ChannelSoundingDistanceProvider.rst
to doc/org.bluez.CSDistanceProvider.rst
- Rename doc/org.bluez.ChannelSoundingDistanceProviderManager.rst
to doc/org.bluez.CSDistanceProviderManager.rst

Naga Bhavani Akella (3):
  doc: Add org.bluez.CSDistance1 documentation
  doc: Add org.bluez.CSDistanceProvider documentation
  doc: Add org.bluez.CSDistanceProviderManager documentation

 Makefile.am                                 | 15 +++++-
 doc/org.bluez.CSDistance1.rst               | 36 ++++++++++++++
 doc/org.bluez.CSDistanceProvider.rst        | 32 +++++++++++++
 doc/org.bluez.CSDistanceProviderManager.rst | 53 +++++++++++++++++++++
 4 files changed, 134 insertions(+), 2 deletions(-)
 create mode 100644 doc/org.bluez.CSDistance1.rst
 create mode 100644 doc/org.bluez.CSDistanceProvider.rst
 create mode 100644 doc/org.bluez.CSDistanceProviderManager.rst

-- 

[PATCH BlueZ v2 1/3] doc: Add org.bluez.CSDistance1 documentation

[Naga Bhavani Akella]

Document the org.bluez.CSDistance1 interface, which
exposes the DistanceMeters estimate computed by an
external ranging provider registered via
CSDistanceProviderManager.
---
 Makefile.am                   |  9 +++++++--
 doc/org.bluez.CSDistance1.rst | 36 +++++++++++++++++++++++++++++++++++
 2 files changed, 43 insertions(+), 2 deletions(-)
 create mode 100644 doc/org.bluez.CSDistance1.rst

diff --git a/Makefile.am b/Makefile.am
index 19c468d3a..00b4ac2b1 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -405,7 +405,8 @@ man_MANS += doc/org.bluez.Telephony.5 doc/org.bluez.Call.5
 man_MANS += doc/org.bluez.ThermometerManager.5 \
 		doc/org.bluez.Thermometer.5 \
 		doc/org.bluez.ThermometerWatcher.5
-man_MANS += doc/org.bluez.ChannelSounding1.5
+man_MANS += doc/org.bluez.ChannelSounding1.5 \
+	    doc/org.bluez.CSDistance1.5
 endif
 manual_pages += doc/bluetoothd.8
 manual_pages += doc/hci.7 doc/mgmt.7 doc/l2cap.7 doc/rfcomm.7 doc/sco.7 \
@@ -446,7 +447,8 @@ manual_pages += doc/org.bluez.Telephony.5 doc/org.bluez.Call.5
 manual_pages += doc/org.bluez.ThermometerManager.5 \
 		doc/org.bluez.Thermometer.5 \
 		doc/org.bluez.ThermometerWatcher.5
-manual_pages += doc/org.bluez.ChannelSounding1.5
+manual_pages += doc/org.bluez.ChannelSounding1.5 \
+	        doc/org.bluez.CSDistance1.5
 
 EXTRA_DIST += src/genbuiltin src/bluetooth.conf \
 			src/main.conf profiles/network/network.conf \
@@ -535,6 +537,9 @@ EXTRA_DIST += doc/org.bluez.ThermometerManager.rst \
 	      doc/org.bluez.Thermometer.rst \
 	      doc/org.bluez.ThermometerWatcher.rst
 
+EXTRA_DIST += doc/org.bluez.ChannelSounding1.rst \
+	      doc/org.bluez.CSDistance1.rst
+
 EXTRA_DIST += doc/pics-opp.txt doc/pixit-opp.txt \
 		doc/pts-opp.txt
 
diff --git a/doc/org.bluez.CSDistance1.rst b/doc/org.bluez.CSDistance1.rst
new file mode 100644
index 000000000..6ee70596e
--- /dev/null
+++ b/doc/org.bluez.CSDistance1.rst
@@ -0,0 +1,36 @@
+======================
+org.bluez.CSDistance1
+======================
+
+-----------------------------------------
+BlueZ D-Bus CSDistance API documentation
+-----------------------------------------
+
+:Version: BlueZ
+:Date: July 2026
+:Manual section: 5
+:Manual group: Linux System Administration
+
+Interface
+=========
+
+:Service:	org.bluez
+:Interface:	org.bluez.CSDistance1
+:Object path:	[variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX
+
+Properties
+----------
+
+double DistanceMeters [readonly]
+`````````````````````````````````
+
+Estimated distance to the remote device, in meters, as last computed
+from Channel Sounding measurement data.
+
+Providers from **org.bluez.CSDistanceProvider(5)** compute
+this value from the raw procedure data reported via the **ProcedureData**
+signal on **org.bluez.ChannelSounding1(5)**, and report it back to
+**bluetoothd(8)** for reflection here.
+
+This property emits ``PropertiesChanged`` whenever a new estimate is
+reported.
-- 

[PATCH BlueZ v2 2/3] doc: Add org.bluez.CSDistanceProvider documentation

[Naga Bhavani Akella]

Document the org.bluez.CSDistanceProvider interface,
implemented by external clients to expose per-device Channel Sounding
distance estimates that BlueZ reflects onto the corresponding device
object.
---
 Makefile.am                          |  9 +++++---
 doc/org.bluez.CSDistanceProvider.rst | 32 ++++++++++++++++++++++++++++
 2 files changed, 38 insertions(+), 3 deletions(-)
 create mode 100644 doc/org.bluez.CSDistanceProvider.rst

diff --git a/Makefile.am b/Makefile.am
index 00b4ac2b1..53bbfd0d2 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.CSDistance1.5
+	    doc/org.bluez.CSDistance1.5 \
+	    doc/org.bluez.CSDistanceProvider.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.CSDistance1.5
+	        doc/org.bluez.CSDistance1.5 \
+	        doc/org.bluez.CSDistanceProvider.5
 
 EXTRA_DIST += src/genbuiltin src/bluetooth.conf \
 			src/main.conf profiles/network/network.conf \
@@ -538,7 +540,8 @@ EXTRA_DIST += doc/org.bluez.ThermometerManager.rst \
 	      doc/org.bluez.ThermometerWatcher.rst
 
 EXTRA_DIST += doc/org.bluez.ChannelSounding1.rst \
-	      doc/org.bluez.CSDistance1.rst
+	      doc/org.bluez.CSDistance1.rst \
+	      doc/org.bluez.CSDistanceProvider.rst
 
 EXTRA_DIST += doc/pics-opp.txt doc/pixit-opp.txt \
 		doc/pts-opp.txt
diff --git a/doc/org.bluez.CSDistanceProvider.rst b/doc/org.bluez.CSDistanceProvider.rst
new file mode 100644
index 000000000..2d57dc8bd
--- /dev/null
+++ b/doc/org.bluez.CSDistanceProvider.rst
@@ -0,0 +1,32 @@
+============================
+org.bluez.CSDistanceProvider
+============================
+
+------------------------------------------------
+BlueZ D-Bus CSDistanceProvider API documentation
+------------------------------------------------
+
+:Version: BlueZ
+:Date: July 2026
+:Manual section: 5
+:Manual group: Linux System Administration
+
+Interface
+=========
+
+:Service:	<client D-Bus address>
+:Interface:	org.bluez.CSDistanceProvider1
+: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.
-- 

[PATCH BlueZ v2 3/3] doc: Add org.bluez.CSDistanceProviderManager documentation

[Naga Bhavani Akella]

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)**.
-- 

RE: doc: Add CS distance provider documentation

[bluez.test.bot]

[-- Attachment #1: Type: text/plain, Size: 988 bytes --]

This is automated email and please do not reply to this email!

Dear submitter,

Thank you for submitting the patches to the linux bluetooth mailing list.
This is a CI test results with your patch series:
PW Link:https://patchwork.kernel.org/project/bluetooth/list/?series=1137931

---Test result---

Test Summary:
CheckPatch                    PASS      0.87 seconds
GitLint                       PASS      0.64 seconds
BuildEll                      PASS      15.40 seconds
BluezMake                     PASS      398.30 seconds
MakeCheck                     PASS      17.66 seconds
MakeDistcheck                 PASS      127.87 seconds
CheckValgrind                 PASS      181.44 seconds
CheckSmatch                   PASS      211.07 seconds
bluezmakeextell               PASS      76.64 seconds
IncrementalBuild              PASS      428.77 seconds
ScanBuild                     PASS      680.83 seconds



https://github.com/bluez/bluez/pull/2365

---
Regards,
Linux Bluetooth