korg/bluez
0
0
Fork 0
mirror of https://git.kernel.org/pub/scm/bluetooth/bluez.git synced 2024-11-15 00:04:29 +08:00
Code Issues Packages Projects Releases Wiki Activity

bluetoothctl-endpoint.1: Update documentation

Browse Source 
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.
This commit is contained in:
Luiz Augusto von Dentz 2024-08-20 12:26:07 -04:00
parent 2f3f63467d
commit 9746e59d11
1 changed files with 70 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
client/bluetoothctl-endpoint.rst
View File

@ -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
=========