README.rst
1Bluetooth Tester application
2############################
3
4The Tester application uses binary protocol to control Zephyr stack and is aimed at
5automated testing. It requires two serial ports to operate.
6The first serial is used by Bluetooth Testing Protocol (BTP) to drive Bluetooth
7stack. BTP commands and events are received and buffered for further processing
8over the same serial.
9
10BTP specification can be found in auto-pts project repository:
11https://github.com/intel/auto-pts
12The auto-pts is an automation framework for PTS Bluetooth testing tool provided
13by Bluetooth SIG.
14
15See https://docs.zephyrproject.org/latest/guides/bluetooth/index.html for full
16documentation about how to use this test.
17
18
19Supported Profiles and Services
20*******************************
21
22Host/Core
23=========
24
25* GAP
26* GATT
27* IAS
28* L2CAP
29* OTS
30* SM
31
32LE Audio
33========
34
35* AICS
36* ASCS
37* BAP
38* CAP
39* CAS
40* CCP
41* CSIP
42* CSIS
43* HAP
44* HAS
45* MCP
46* MCS
47* MCIP
48* MICS
49* PACS
50* PBP
51* TBS
52* TMAP
53* VCP
54* VCS
55* VOCS
56
57Mesh
58====
59
60* Mesh Node
61* Mesh Model
62
63Building and running on QEMU
64****************************
65
66QEMU should have connection with the external host Bluetooth hardware.
67The btproxy tool from BlueZ can be used to give access to a Bluetooth controller
68attached to the Linux host OS:
69
70$ sudo tools/btproxy -u
71Listening on /tmp/bt-server-bredr
72
73/tmp/bt-server-bredr option is already set in Makefile through QEMU_EXTRA_FLAGS.
74
75To build tester application for QEMU use BOARD=qemu_cortex_m3 and
76CONF_FILE=qemu.conf. After this qemu can be started through the "run"
77build target.
78
79Note: Target board have to support enough UARTs for BTP and controller.
80 We recommend using qemu_cortex_m3.
81
82'bt-stack-tester' UNIX socket (previously set in Makefile) can be used for now
83to control tester application.
84
85Next, build and flash tester application by employing the "flash" build
86target.
87
88Use serial client, e.g. PUTTY to communicate over the serial port
89(typically /dev/ttyUSBx) with the tester using BTP.
90
91Building for LE Audio
92*********************
93
94The tester application can be built with support for BT LE Audio by applying the
95the ``overlay-le-audio.conf`` and ``hci_ipc.conf`` with ``--sysbuild`` for the supported boards,
96e.g.:
97
98 west build -b nrf5340dk/nrf5340/cpuapp --sysbuild \
99 -- -DEXTRA_CONF_FILE=overlay-le-audio.conf;hci_ipc.conf
100
101Building with support for btsnoop and rtt logs
102**********************************************
103
104Add following options in desired configuration file:
105
106CONFIG_LOG=n
107CONFIG_LOG_BACKEND_RTT=y
108CONFIG_LOG_BACKEND_RTT_BUFFER=1
109CONFIG_LOG_BACKEND_RTT_MODE_DROP=n
110
111CONFIG_USE_SEGGER_RTT=y
112CONFIG_SEGGER_RTT_SECTION_CUSTOM=y
113
114CONFIG_BT_DEBUG_MONITOR_RTT=y
115CONFIG_BT_DEBUG_MONITOR_RTT_BUFFER=2
116