[PATCH BlueZ v1] bluetoothctl-endpoint.1: Update documentation

[PATCH BlueZ v1] bluetoothctl-endpoint.1: Update documentation

[Luiz Augusto von Dentz]

From: Luiz Augusto von Dentz <luiz.von.dentz@intel.com>

This updates the documentation for endpoint.presets command and also add
some examples of how to enter extra capabilities/configuration and
how to setup custom presets.
---
 client/bluetoothctl-endpoint.rst | 72 +++++++++++++++++++++++++++++++-
 1 file changed, 70 insertions(+), 2 deletions(-)

diff --git a/client/bluetoothctl-endpoint.rst b/client/bluetoothctl-endpoint.rst
index 91409943a32d..d7865486e2a2 100644
--- a/client/bluetoothctl-endpoint.rst
+++ b/client/bluetoothctl-endpoint.rst
@@ -40,7 +40,26 @@ register
 
 Register Endpoint.
 
-:Usage: **# register <UUID> <codec> [capabilities...]**
+:Usage: **# register <UUID> <codec[:company]> [capabilities...]**
+:Example LC3 source:
+	 | **#endpoint.register 00002bcb-0000-1000-8000-00805f9b34fb 0x06**
+	 | **#Auto Accept (yes/no):** y
+	 | **#Max Transports (auto/value):** a
+	 | **#Locations:** a
+	 | **#Supported Context (value):** 3
+	 | **#Context (value):** 3
+	 | **#CIG (auto/value):** a
+	 | **#CIS (auto/value):** a
+:Example LC3 since 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
+	 | **#Max Transports (auto/value):** a
+	 | **#Locations:** a
+	 | **#Supported Context (value):** 3
+	 | **#Context (value):** 3
+	 | **#CIG (auto/value):** a
+	 | **#CIS (auto/value):** a
 
 unregister
 ----------
@@ -61,7 +80,56 @@ presets
 
 List available presets.
 
-:Usage: **# presets <UUID> [default]**
+:Usage: **# presets <endpoint>/<UUID> [codec[:company]] [preset] [codec config] [metadata]**
+:Example using endpoint:
+	  | **#presets /local/endpoint/ep0 32_1_1**
+	  | **#presets /local/endpoint/ep0**
+	  | Preset 32_1_1
+	  | Configuration.#0: len 0x02 type 0x01
+          | Configuration.Sampling Frequency: 32 Khz (0x06)
+          | Configuration.#1: len 0x02 type 0x02
+          | Configuration.Frame Duration: 7.5 ms (0x00)
+          | Configuration.#2: len 0x03 type 0x04
+          | Configuration.Frame Length: 60 (0x003c)
+:Example using UUID:
+	  | **#presets 00002bc9-0000-1000-8000-00805f9b34fb 0x06 32_1_1**
+	  | **#presets 00002bc9-0000-1000-8000-00805f9b34fb 0x06**
+	  | ...
+	  | ***32_1_1**
+:Example setting up LC3 custom preset:
+	  | **#presets 00002bc9-0000-1000-8000-00805f9b34fb 0x06 custom**
+	  | **#[Codec] Enter frequency (Khz):** 48
+	  | **#[Codec] Enter frame duration (ms):** 10
+	  | **#[Codec] Enter channel allocation:** 3
+	  | **#[Codec] Enter frame length:** 100
+	  | **#[QoS] Enter Target Latency (Low, Balance, High):** Low
+	  | **#[QoS] Enter SDU Interval (us):** 1000
+	  | **#[QoS] Enter Framing (Unframed, Framed):** Unframed
+	  | **#[QoS] Enter PHY (1M, 2M):** 2M
+	  | **#[QoS] Enter Max SDU:** 200
+	  | **#[QoS] Enter RTN:** 3
+	  | **#[QoS] Enter Max Transport Latency (ms):** 10
+	  | **#[QoS] Enter Presentation Delay (us):** 20000
+	  | **#presets 00002bc9-0000-1000-8000-00805f9b34fb 0x06**
+	  | ...
+	  | ***custom**
+:Example setting up LC3 custom preset with extra configuration:
+	  | **#presets 00002bc9-0000-1000-8000-00805f9b34fb 0x06 custom "0x03 0xe8 0x00 0x00 0x02 0xe9 0x00"**
+	  | **#[Codec] Enter frequency (Khz):** 48
+	  | **#[Codec] Enter frame duration (ms):** 10
+	  | **#[Codec] Enter channel allocation:** 3
+	  | **#[Codec] Enter frame length:** 100
+	  | **#[QoS] Enter Target Latency (Low, Balance, High):** Low
+	  | **#[QoS] Enter SDU Interval (us):** 1000
+	  | **#[QoS] Enter Framing (Unframed, Framed):** Unframed
+	  | **#[QoS] Enter PHY (1M, 2M):** 2M
+	  | **#[QoS] Enter Max SDU:** 200
+	  | **#[QoS] Enter RTN:** 3
+	  | **#[QoS] Enter Max Transport Latency (ms):** 10
+	  | **#[QoS] Enter Presentation Delay (us):** 20000
+	  | **#presets 00002bc9-0000-1000-8000-00805f9b34fb 0x06**
+	  | ...
+	  | ***custom**
 
 RESOURCES
 =========
-- 
2.46.0

RE: [BlueZ,v1] bluetoothctl-endpoint.1: Update documentation

[bluez.test.bot]

[-- Attachment #1: Type: text/plain, Size: 2303 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=881434

---Test result---

Test Summary:
CheckPatch                    PASS      0.66 seconds
GitLint                       PASS      0.33 seconds
BuildEll                      PASS      25.06 seconds
BluezMake                     PASS      1709.65 seconds
MakeCheck                     FAIL      13.11 seconds
MakeDistcheck                 FAIL      160.32 seconds
CheckValgrind                 FAIL      252.99 seconds
CheckSmatch                   PASS      358.47 seconds
bluezmakeextell               PASS      120.39 seconds
IncrementalBuild              PASS      1638.21 seconds
ScanBuild                     PASS      1002.44 seconds

Details
##############################
Test: MakeCheck - FAIL
Desc: Run Bluez Make Check
Output:

make[3]: *** [Makefile:11766: test-suite.log] Error 1
make[2]: *** [Makefile:11874: check-TESTS] Error 2
make[1]: *** [Makefile:12303: check-am] Error 2
make: *** [Makefile:12305: check] Error 2
##############################
Test: MakeDistcheck - FAIL
Desc: Run Bluez Make Distcheck
Output:

Package cups was not found in the pkg-config search path.
Perhaps you should add the directory containing `cups.pc'
to the PKG_CONFIG_PATH environment variable
No package 'cups' found
make[4]: *** [Makefile:11766: test-suite.log] Error 1
make[3]: *** [Makefile:11874: check-TESTS] Error 2
make[2]: *** [Makefile:12303: check-am] Error 2
make[1]: *** [Makefile:12305: check] Error 2
make: *** [Makefile:12226: distcheck] Error 1
##############################
Test: CheckValgrind - FAIL
Desc: Run Bluez Make Check with Valgrind
Output:

tools/mgmt-tester.c: In function ‘main’:
tools/mgmt-tester.c:12725:5: note: variable tracking size limit exceeded with ‘-fvar-tracking-assignments’, retrying without
12725 | int main(int argc, char *argv[])
      |     ^~~~
make[3]: *** [Makefile:11766: test-suite.log] Error 1
make[2]: *** [Makefile:11874: check-TESTS] Error 2
make[1]: *** [Makefile:12303: check-am] Error 2
make: *** [Makefile:12305: check] Error 2


---
Regards,
Linux Bluetooth

Re: [PATCH BlueZ v1] bluetoothctl-endpoint.1: Update documentation

[patchwork-bot+bluetooth]

Hello:

This patch was applied to bluetooth/bluez.git (master)
by Luiz Augusto von Dentz <luiz.von.dentz@intel.com>:

On Tue, 20 Aug 2024 12:28:17 -0400 you wrote:
> From: Luiz Augusto von Dentz <luiz.von.dentz@intel.com>
> 
> This updates the documentation for endpoint.presets command and also add
> some examples of how to enter extra capabilities/configuration and
> how to setup custom presets.
> ---
>  client/bluetoothctl-endpoint.rst | 72 +++++++++++++++++++++++++++++++-
>  1 file changed, 70 insertions(+), 2 deletions(-)

Here is the summary with links:
  - [BlueZ,v1] bluetoothctl-endpoint.1: Update documentation
    https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=9746e59d1149

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html