client: Update endpoint and trasport doc

This updates the documentation for the use of endpoints and
transports according to the latest changes in their design.

Signed-off-by: Anuj Jain <anuj01.jain@samsung.com>

diff --git a/client/bluetoothctl-endpoint.rst b/client/bluetoothctl-endpoint.rst
index d7865486e2a230522c450040df4f52ce7742744f..907dbde34014d123106f348030b26158d33b5f55 100644 (file)
--- a/client/bluetoothctl-endpoint.rst
+++ b/client/bluetoothctl-endpoint.rst
@@ -41,7 +41,7 @@ register
 Register Endpoint.
 
 :Usage: **# register <UUID> <codec[:company]> [capabilities...]**
-:Example LC3 source:
+:Example LC3 BAP source:
         | **#endpoint.register 00002bcb-0000-1000-8000-00805f9b34fb 0x06**
         | **#Auto Accept (yes/no):** y
         | **#Max Transports (auto/value):** a
@@ -50,7 +50,7 @@ Register Endpoint.
         | **#Context (value):** 3
         | **#CIG (auto/value):** a
         | **#CIS (auto/value):** a
-:Example LC3 since with extra capabilities:
+:Example LC3 BAP sink with extra capabilities:
         | **#endpoint.register 00002bc9-0000-1000-8000-00805f9b34fb 0x06 "0x03 0xe5 0x03 0x00 0x02 0xe6 0x07"**
         | **#Enter Metadata (value/no):** n
         | **#Auto Accept (yes/no):** y
@@ -60,6 +60,25 @@ Register Endpoint.
         | **#Context (value):** 3
         | **#CIG (auto/value):** a
         | **#CIS (auto/value):** a
+:Example LC3 BAP Broadcast source:
+        | **#endpoint.register 00001852-0000-1000-8000-00805f9b34fb 0x06**
+        | **#Auto Accept (yes/no):** y
+        | **#Max Transports (auto/value):** a
+        | **#Locations:** 3
+        | **#Supported Context (value):** 1
+:Example LC3 BAP Broadcast sink:
+        | **#endpoint.register 00001851-0000-1000-8000-00805f9b34fb 0x06**
+        | **#Auto Accept (yes/no):** y
+        | **#Max Transports (auto/value):** a
+        | **#Locations:** 3
+        | **#Supported Context (value):** 1
+
+Note:
+
+If running the setup with an audio server that has LE Audio support (such as PipeWire) it will
+automatically register endpoints according to the configured roles. For more details
+about configuring a Broadcast Source with PipeWire check:
+https://gitlab.freedesktop.org/pipewire/pipewire/-/blob/master/doc/dox/config/pipewire-props.7.md
 
 unregister
 ----------
@@ -68,6 +87,11 @@ Unregister Endpoint.
 
 :Usage: **# unregister <UUID/object>**
 
+Note:
+
+If the endpoint was registered by an audio server, it can't be unregistered from bluetoothctl.
+This must be done by the audio server as well.
+
 config
 ------
 
@@ -75,6 +99,11 @@ Configure Endpoint.
 
 :Usage: **# config <endpoint> <local endpoint> [preset]**
 
+Note:
+
+If the endpoint was registered by an audio server, it can't be configured from bluetoothctl.
+This must be done by the audio server as well.
+
 presets
 -------
 

diff --git a/client/bluetoothctl-transport.rst b/client/bluetoothctl-transport.rst
index 21ba2f7012e9dc97a2fee5d79048d3e4030fa4c6..f92621affe0d5870051efbaf97ffbaba69f4fe37 100644 (file)
--- a/client/bluetoothctl-transport.rst
+++ b/client/bluetoothctl-transport.rst
@@ -42,6 +42,37 @@ Acquire transport.
 
 :Usage: **# acquire <transport> [transport1...]**
 
+Note:
+
+If running the setup with an audio server that has LE Audio support (such as PipeWire) it will
+automatically acquire transports according to the configured roles.
+
+select
+-------
+
+Select transport. For transports created on a Broadcast Sink device only. This moves
+the transport to the "broadcasting" state, pending acquire.
+
+:Usage: **# select <transport> [transport1...]**
+
+Note:
+If running the setup with an audio server that has LE Audio support (such as PipeWire), it will
+prompt it to automatically acquire the transport.
+
+unselect
+--------
+
+Unelect transport. For transports created on a Broadcast Sink device only. This moves
+the transport to the "idle" state, pending release by the audio server. If the transport
+was acquired by bluetoothctl it can be released straight away, without having to be
+unselected.
+
+:Usage: **# unselect <transport> [transport1...]**
+
+Note:
+If running the setup with an audio server that has LE Audio support (such as PipeWire), it will
+prompt it to automatically release the transport.
+
 release
 -------
 
@@ -49,6 +80,10 @@ Release transport.
 
 :Usage: **# release <transport> [transport1...]**
 
+Note:
+
+Transports acquired by an audio server, can only be released by said audio server.
+
 send
 ----