michaelh/zephyr
1
0
Fork 0
Code Releases Activity

docs: Bluetooth: Additional broadcast assistant shell documentation

Browse source 
Improves the broadcast assistant shell documentation
which updates the existing documentation and adds
documentation to commands not yet documented.

Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
This commit is contained in:
Emil Gydesen 2024-02-01 14:45:22 +01:00 • committed by Maureen Helm
commit 97f7cdac84
1 changed files with 57 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

69
doc/connectivity/bluetooth/api/shell/bap_broadcast_assistant.rst
View file

@ -25,20 +25,26 @@ subscribe to all notifications.
.. code-block:: console
bap_broadcast_assistant - Bluetooth BAP Broadcast Assistant shell commands
uart:~$ bap_broadcast_assistant --help
bap_broadcast_assistant - Bluetooth BAP broadcast assistant client shell
commands
Subcommands:
discover :Discover BASS on the server
scan_start :Start scanning for broadcasters
scan_stop :Stop scanning for BISs
add_src :Add a source <address: XX:XX:XX:XX:XX:XX> <type:
discover : Discover BASS on the server
scan_start : Start scanning for broadcasters
scan_stop : Stop scanning for BISs
add_src : Add a source <address: XX:XX:XX:XX:XX:XX> <type:
public/random> <adv_sid> <sync_pa> <broadcast_id>
[<pa_interval>] [<sync_bis>] [<metadata>]
mod_src :Set sync <src_id> <sync_pa> [<pa_interval>] [<sync_bis>]
add_broadcast_id : Add a source by broadcast ID <broadcast_id> <sync_pa>
[<sync_bis>] [<metadata>]
add_pa_sync : Add a PA sync as a source <sync_pa> <broadcast_id>
[bis_index [bis_index [bix_index [...]]]]>
mod_src : Set sync <src_id> <sync_pa> [<pa_interval>] [<sync_bis>]
[<metadata>]
broadcast_code :Send a space separated broadcast code of up to 16 bytes
<src_id> [broadcast code]
rem_src :Remove a source <src_id>
read_state :Remove a source <index>
broadcast_code : Send a space separated broadcast code of up to 16 bytes
<src_id> <broadcast code>
rem_src : Remove a source <src_id>
read_state : Remove a source <index>
Example usage
*************
@ -49,12 +55,14 @@ Setup
.. code-block:: console
uart:~$ bt init
uart:~$ bap init
uart:~$ bt connect xx:xx:xx:xx:xx:xx public
When connected
==============
Start scanning for periodic advertisements for a server:
--------------------------------------------------------
.. note::
The Broadcast Assistant will not actually start scanning for periodic
@ -64,15 +72,46 @@ Start scanning for periodic advertisements for a server:
.. code-block:: console
uart:~$ bap_broadcast_assistant discover
<dbg> bt_bap_broadcast_assistant.char_discover_func: Found 1 BASS receive states
<dbg> bt_bap_broadcast_assistant.read_recv_state_cb: src_id 0, PA 0, BIS 0, encrypt 0, addr 00:00:00:00:00:00 (public), sid 0, metadata_len 0
uart:~$ bap_broadcast_assistant scan_start
<dbg> bt_bap_broadcast_assistant.write_func: err: 0x00, handle 0x001e
BASS discover done with 1 recv states
uart:~$ bap_broadcast_assistant scan_start true
BASS scan start successful
Found broadcaster with ID 0x05BD38 and addr 1E:4D:0A:AA:6E:49 (random) and sid 0x00
Adding a source to the receive state:
Adding a source to the receive state with add_src:
--------------------------------------------------
.. code-block:: console
uart:~$ bap_broadcast_assistant add_src 11:22:33:44:55:66 public 5 1 1
BASS recv state: src_id 0, addr 11:22:33:44:55:66 (public), sid 5, sync_state 1, encrypt_state 000000000000000000000000000000000
[0]: BIS sync 0, metadata_len 0
Adding a source to the receive state with add_broadcast_id (recommended):
-------------------------------------------------------------------------
.. code-block:: console
uart:~$ bap_broadcast_assistant add_broadcast_id 0x05BD38 true
[DEVICE]: 1E:4D:0A:AA:6E:49 (random), AD evt type 5, RSSI -28 Broadcast Audio Source C:0 S:0 D:0 SR:0 E:1 Prim: LE 1M, Secn: LE 2M, Interval: 0x03c0 (1200000 us), SID: 0x0
Found BAP broadcast source with address 1E:4D:0A:AA:6E:49 (random) and ID 0x05BD38
BASS recv state: src_id 0, addr 1E:4D:0A:AA:6E:49 (random), sid 0, sync_state 0, encrypt_state 0
[0]: BIS sync 0x0000, metadata_len 0
BASS add source successful
BASS recv state: src_id 0, addr 1E:4D:0A:AA:6E:49 (random), sid 0, sync_state 2, encrypt_state 0
[0]: BIS sync 0x0000, metadata_len 0
BASS recv state: src_id 0, addr 1E:4D:0A:AA:6E:49 (random), sid 0, sync_state 2, encrypt_state 0
[0]: BIS sync 0x0000, metadata_len 4
Metadata length 2, type 2, data: 0100
Modifying a receive state:
--------------------------
.. code-block:: console
uart:~$ bap_broadcast_assistant mod_src 0 true 0x03c0 0x02
BASS modify source successful
BASS recv state: src_id 0, addr 1E:4D:0A:AA:6E:49 (random), sid 0, sync_state 2, encrypt_state 0
[0]: BIS sync 0x0001, metadata_len 4
Metadata length 2, type 2, data: 0100