From: Naga Bhavani Akella <naga.akella@oss.qualcomm.com>
To: linux-bluetooth@vger.kernel.org
Cc: luiz.dentz@gmail.com, quic_mohamull@quicinc.com,
quic_hbandi@quicinc.com, quic_anubhavg@quicinc.com,
Naga Bhavani Akella <naga.akella@oss.qualcomm.com>
Subject: [PATCH BlueZ v2 1/5] doc: Add org.bluez.CSDistance1 documentation
Date: Wed, 12 Aug 2026 15:33:41 +0530 [thread overview]
Message-ID: <20260812100345.2956271-2-naga.akella@oss.qualcomm.com> (raw)
In-Reply-To: <20260812100345.2956271-1-naga.akella@oss.qualcomm.com>
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.
--
next prev parent reply other threads:[~2026-08-12 10:04 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-08-12 10:03 [PATCH BlueZ v2 0/5] Add CS distance provider implementation Naga Bhavani Akella
2026-08-12 10:03 ` Naga Bhavani Akella [this message]
2026-08-12 11:33 ` bluez.test.bot
2026-08-12 10:03 ` [PATCH BlueZ v2 2/5] doc: Add org.bluez.CSDistanceProvider documentation Naga Bhavani Akella
2026-08-12 10:03 ` [PATCH BlueZ v2 3/5] doc: Add org.bluez.CSDistanceProviderManager documentation Naga Bhavani Akella
2026-08-12 10:03 ` [PATCH BlueZ v2 4/5] rap: Add CS Distance provider D-Bus API Naga Bhavani Akella
2026-08-12 10:03 ` [PATCH BlueZ v2 5/5] client: Add CS distance display support to bluetoothctl Naga Bhavani Akella
2026-08-18 19:54 ` [PATCH BlueZ v2 0/5] Add CS distance provider implementation Luiz Augusto von Dentz
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=20260812100345.2956271-2-naga.akella@oss.qualcomm.com \
--to=naga.akella@oss.qualcomm.com \
--cc=linux-bluetooth@vger.kernel.org \
--cc=luiz.dentz@gmail.com \
--cc=quic_anubhavg@quicinc.com \
--cc=quic_hbandi@quicinc.com \
--cc=quic_mohamull@quicinc.com \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.