Skip to content

samples: Bluetooth: Classic: Add guide on how to build/run samples #97447

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+68 −0
Open

samples: Bluetooth: Classic: Add guide on how to build/run samples #97447

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 68 additions & 0 deletions samples/bluetooth/classic/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,71 @@
:glob: **/*

These samples demonstrate the use of Bluetooth Classic in Zephyr.

Prerequisites
*************

* A board with Bluetooth Classic support
* Recommended boards:

* :zephyr:board:`mimxrt1170_evk@B/mimxrt1176/cm7 <mimxrt1170_evk>`

Building the Samples
*********************

To build any Bluetooth Classic sample, use the following commands:

.. code-block:: bash

west build -p auto -b <board> samples/bluetooth/classic/<sample_name>

For example, to build for :zephyr:board:`mimxrt1170_evk@B/mimxrt1176/cm7 <mimxrt1170_evk>`:

.. code-block:: bash

west build -p auto -b mimxrt1170_evk@B/mimxrt1176/cm7 samples/bluetooth/classic/<sample_name>

Refer to :ref:`bluetooth-dev` for more information.

Configuration
*************

The following Kconfig options must be enabled for Bluetooth Classic functionality:

.. code-block:: kconfig

CONFIG_BT=y
CONFIG_BT_CLASSIC=y

Enable verbose Bluetooth logging:

.. code-block:: kconfig

CONFIG_LOG=y
CONFIG_LOG_DEFAULT_LEVEL=<log level>

Running the Samples
*******************

Flashing
========

Flash the built sample to your target board:

.. code-block:: bash

west flash

Monitoring Output
=================

Monitor the sample output using a serial terminal.

.. note::
If you want to run any bluetooth sample on the mimxrt1170_evk@B device (build using
``-DBOARD=mimxrt1170_evk@B/mimxrt1176/cm7``), the extended Bluetooth module needs to be
installed on the M.2 interface.
Comment on lines +67 to +70
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it seems a bit too specific to mention the special case of that one particular board in the generic listing?

Copy link
Contributor Author

@lylezhu2012 lylezhu2012 Oct 13, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure about it. I added it based on the following reference,

zephyr/samples/bluetooth/bluetooth.rst

Lines 18 to 24 in 4b3cb73

.. note::
If you want to run any bluetooth sample on the nRF5340 device (build using
``-DBOARD=nrf5340dk/nrf5340/cpuapp`` or
``-DBOARD=nrf5340dk/nrf5340/cpuapp/ns``) you must also build
and program the corresponding sample for the nRF5340 network core
:zephyr:code-sample:`bluetooth_hci_ipc` which implements the Bluetooth
Low Energy controller.


.. zephyr:code-sample-listing::
:categories: bluetooth_classic
:live-search: