1.. _bluetooth_bsim_test_sample:
2
3Bluetooth: Example BabbleSim test
4#################################
5
6Abstract
7********
8
9This test's purpose is to serve as template for implementing a new BabbleSim Bluetooth test.
10
11BabbleSim_ is :ref:`integrated in zephyr <bsim>` and used for testing the Bluetooth stack.
12The tests are implemented in ``tests/bsim/bluetooth``.
13They can only be run on Linux.
14
15This sample test uses the ``testlib`` (:zephyr_file:`tests/bluetooth/common/testlib/CMakeLists.txt`)
16test library, in order to de-duplicate code that is not relevant to the test in question. Things
17like setting up a connection, getting the GATT handle of a characteristic, etc..
18
19Please don't use the ``bs_`` prefix in files or identifiers. It's meant to
20namespace the babblesim simulator code.
21
22Reading guide
23*************
24
25Read in order:
26
271. The :ref:`Bsim test documentation <bsim>`.
28#. ``test_scripts/run.sh``
29#. ``CMakeLists.txt``
30#. ``src/dut.c`` and ``src/peer.c``
31#. ``src/main.c``
32
33.. _BabbleSim:
34   https://BabbleSim.github.io
35