NCSDK-34445: Added Bluetooth LE samples testing application

rafpelc · nordicjm · commit c238ffed5e4b · 2025-09-05T09:55:30.000+01:00
Application provides central function to test basic BLE functionality.
Application to be used in Bluetooth Samples tests.
Sample yaml added for twister build.

Signed-off-by: Rafal Pelc &lt;rafal.pelc@nordicsemi.no&gt;
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -976,6 +976,10 @@
 /tests/bluetooth/bsim/nrf_auraconfig/*.rst @nrfconnect/ncs-audio-doc
 
 /tests/samples/bluetooth/io_adapter/      @rafpelc @jema-nordic
+/tests/samples/bluetooth/samples_test_app/ @rafpelc
+/tests/samples/bluetooth/samples_test_app/README.rst  @nrfconnect/ncs-doc-leads
+
+
 # CI specific west
 /test-manifests/99-default-test-nrf.yml   @nrfconnect/ncs-ci
 
diff --git a/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst b/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst
@@ -265,6 +265,8 @@ Amazon Sidewalk samples
 Bluetooth samples
 -----------------
 
+* Added the :ref:`samples_test_app` application to demonstrate how to use the Bluetooth LE Test GATT Server and test Bluetooth LE functionality in peripheral samples.
+
 * Updated the network core image applications for the following samples from the :zephyr:code-sample:`bluetooth_hci_ipc` sample to the :ref:`ipc_radio` application for multicore builds:
 
   * :ref:`bluetooth_conn_time_synchronization`
diff --git a/doc/nrf/samples/bl.rst b/doc/nrf/samples/bl.rst
@@ -19,3 +19,4 @@ This section lists the available |NCS| samples for the :ref:`Bluetooth® <ug_bt>
    ../../../samples/bluetooth/*/README
    ../../tests/bluetooth/bsim/nrf_auraconfig/README
    ../../tests/bluetooth/bsim/nrf_auraconfig/tester/README
+   ../../tests/samples/bluetooth/*/README
diff --git a/tests/samples/bluetooth/samples_test_app/CMakeLists.txt b/tests/samples/bluetooth/samples_test_app/CMakeLists.txt
@@ -0,0 +1,8 @@
+cmake_minimum_required(VERSION 3.8.2)
+
+find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
+
+target_sources(app PRIVATE src/main.c)
+zephyr_library_include_directories(${CMAKE_CURRENT_SOURCE_DIR})
+
+project(bluetooth_sample_test_app)
diff --git a/tests/samples/bluetooth/samples_test_app/Kconfig.sysbuild b/tests/samples/bluetooth/samples_test_app/Kconfig.sysbuild
@@ -0,0 +1,10 @@
+#
+# Copyright (c) 2023 Nordic Semiconductor
+#
+# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+#
+
+source "${ZEPHYR_BASE}/share/sysbuild/Kconfig"
+
+config NRF_DEFAULT_IPC_RADIO
+	default y
diff --git a/tests/samples/bluetooth/samples_test_app/README.rst b/tests/samples/bluetooth/samples_test_app/README.rst
@@ -0,0 +1,231 @@
+.. _samples_test_app:
+
+Bluetooth: Bluetooth LE master test app
+#######################################
+
+.. contents::
+   :local:
+   :depth: 2
+
+The Bluetooth LE master test app is a Bluetooth® Low Energy (LE) central application designed to test basic Bluetooth functionality in peripheral samples.
+This application acts as a tester in the central role to validate Bluetooth LE peripheral applications in the |NCS|.
+
+Requirements
+************
+
+The sample supports the following development kits:
+
+.. table-from-sample-yaml::
+
+.. include:: /includes/tfm.txt
+
+The sample requires a Bluetooth LE peripheral device for testing.
+You can use any of the following peripheral samples:
+
+* :ref:`peripheral_uart`
+* :ref:`peripheral_hids_keyboard`
+* :ref:`peripheral_hids_mouse`
+* :ref:`peripheral_lbs`
+
+Overview
+********
+
+The Bluetooth LE master test app implements a Bluetooth LE central device that can discover and connect to peripheral devices.
+It performs automatic device discovery, service discovery, connection management, and supports security features.
+
+The application follows a specific test sequence:
+
+1. Initialization - Initializes the Bluetooth stack and sets up required modules.
+#. Scanning - Actively scans for supported peripheral devices.
+#. Connection - Automatically connects to discovered devices.
+#. Service discovery - Discovers and logs GATT services.
+#. Connection maintenance - Maintains the connection for five seconds.
+#. Disconnection - Disconnects gracefully.
+#. Reconnection - Waits three seconds, then reconnects.
+#. Extended test - Maintains the connection for 10 seconds.
+#. Final disconnection - Completes the test cycle.
+#. Success indication - Prints ``SUCCESS`` when all steps are completed.
+
+Supported device types
+======================
+
+The application is configured to discover and test the following Bluetooth LE peripheral devices:
+
+* Nordic UART Service
+* Nordic Throughput
+* NCS HIDS Keyboard
+* NCS HIDS Mouse
+* Nordic Lightweight Battery Service (LBS)
+* Test Beacon
+* HID devices (through UUID filtering)
+
+Debugging
+*********
+
+In this sample, the UART console is used to display test progress and results.
+Debug messages are not displayed in the UART console, instead, they are printed by the RTT logger.
+
+To view debug messages, follow the procedure described in :ref:`testing_rtt_connect`.
+
+FEM support
+***********
+
+.. include:: /includes/sample_fem_support.txt
+
+Configuration
+*************
+
+|config|
+
+Configuration options
+=====================
+
+Check and configure the following configuration options for the sample:
+
+* :kconfig:option:`CONFIG_BT_CENTRAL`
+* :kconfig:option:`CONFIG_BT_SCAN`
+* :kconfig:option:`CONFIG_BT_GATT_DM`
+* :kconfig:option:`CONFIG_BT_SMP`
+
+Building and running
+********************
+
+.. |sample path| replace:: :file:`tests/samples/bluetooth/samples_test_app`
+
+.. include:: /includes/build_and_run_ns.txt
+
+.. |sample_or_app| replace:: sample
+.. |ipc_radio_dir| replace:: :file:`sysbuild/ipc_radio`
+
+.. include:: /includes/ipc_radio_conf.txt
+
+.. include:: /includes/nRF54H20_erase_UICR.txt
+
+Testing
+=======
+
+After programming the sample to your development kit, complete the following steps to test the basic functionality:
+
+.. tabs::
+
+   .. group-tab:: nRF21, nRF52 and nRF53 DKs
+
+      1. Connect the device to the computer to access UART 0.
+         If you use a development kit, UART 0 is forwarded as a serial port.
+         |serial_port_number_list|
+      #. |connect_terminal|
+      #. Reset the kit.
+      #. Observe that the text ``Starting Bluetooth LE test application`` is printed on the COM listener.
+      #. Power on a Bluetooth LE peripheral device that matches one of the supported device types.
+      #. Observe that the application discovers and connects to the peripheral device.
+      #. Monitor the console output for successful connection and service discovery.
+      #. Verify that the application completes the full test cycle and prints ``SUCCESS``.
+
+   .. group-tab:: nRF54 DKs
+
+      .. note::
+          |nrf54_buttons_leds_numbering|
+
+      1. Connect the device to the computer to access UART 0.
+         If you use a development kit, UART 0 is forwarded as a serial port.
+         |serial_port_number_list|
+      #. |connect_terminal|
+      #. Reset the kit.
+      #. Observe that the text ``Starting Bluetooth LE test application`` is printed on the COM listener.
+      #. Power on a Bluetooth LE peripheral device that matches one of the supported device types.
+      #. Observe that the application discovers and connects to the peripheral device.
+      #. Monitor the console output for successful connection and service discovery.
+      #. Verify that the application completes the full test cycle and prints ``SUCCESS``.
+
+Sample output
+=============
+
+The application provides detailed console output, including:
+
+* Bluetooth initialization status
+* Device discovery information
+* Connection establishment details
+* Service discovery results
+* Security pairing information
+* Test progress and results
+
+The following is an example of the output:
+
+.. code-block:: console
+
+   Starting BLE test application
+   Bluetooth initialized
+   UART initialized
+   Scan module initialized
+   Scanning successfully started
+   Filters matched. Address: AA:BB:CC:DD:EE:FF connectable: 1
+   Connected
+   Service discovery completed
+   Disconnect successful
+   SUCCESS
+
+Testing workflow
+================
+
+The application supports both manual and automated testing.
+
+Manual testing
+--------------
+
+To test the sample manually, complete the following steps:
+
+1. Build and flash the application to a development kit.
+#. Power on a Bluetooth LE peripheral device (for example, Nordic UART Service sample).
+#. Monitor the console output for successful connection and service discovery.
+#. Verify that the application completes the full test cycle.
+
+Automated testing
+-----------------
+
+The application is designed for integration with automated test frameworks, providing:
+
+* Seamless CI/CD pipeline support.
+* Structured test results.
+* Comprehensive documentation of test procedures.
+* Full compatibility with Nordic Semiconductor's test infrastructure.
+
+Troubleshooting
+===============
+
+If you have issues while using the sample, consider the following potential causes and recommended checks:
+
+1. No devices discovered - Ensure the peripheral device is advertising with the correct name.
+#. Connection failures - Check device compatibility and verify the Bluetooth stack configuration.
+#. Service discovery errors - Verify that the peripheral device implements the expected services.
+#. Build errors - Ensure all required dependencies are properly installed.
+
+Dependencies
+************
+
+This sample uses the following |NCS| libraries:
+
+* :ref:`gatt_dm_readme`
+* :ref:`nrf_bt_scan_readme`
+
+In addition, it uses the following Zephyr libraries:
+
+* :file:`include/zephyr/types.h`
+* :file:`boards/arm/nrf*/board.h`
+* :ref:`zephyr:kernel_api`:
+
+  * :file:`include/kernel.h`
+
+* :ref:`zephyr:api_peripherals`:
+
+   * :file:`include/uart.h`
+
+* :ref:`zephyr:bluetooth_api`:
+
+  * :file:`include/bluetooth/bluetooth.h`
+  * :file:`include/bluetooth/gatt.h`
+  * :file:`include/bluetooth/hci.h`
+  * :file:`include/bluetooth/uuid.h`
+
+The sample also uses the following secure firmware component:
+
+* :ref:`Trusted Firmware-M <ug_tfm>`
diff --git a/tests/samples/bluetooth/samples_test_app/prj.conf b/tests/samples/bluetooth/samples_test_app/prj.conf
@@ -0,0 +1,30 @@
+# Enable the UART driver
+CONFIG_UART_INTERRUPT_DRIVEN=y
+CONFIG_SERIAL=y
+CONFIG_CONSOLE=y
+CONFIG_UART_CONSOLE=y
+
+# Enable the BLE stack with GATT Client configuration
+CONFIG_BT=y
+CONFIG_BT_CENTRAL=y
+CONFIG_BT_SMP=y
+CONFIG_BT_GATT_CLIENT=y
+
+# Enable the BLE modules from NCS
+CONFIG_BT_SCAN=y
+CONFIG_BT_SCAN_FILTER_ENABLE=y
+CONFIG_BT_SCAN_UUID_CNT=1
+CONFIG_BT_GATT_DM=y
+CONFIG_HEAP_MEM_POOL_SIZE=2048
+CONFIG_BT_SCAN_NAME_CNT=6
+CONFIG_BT_GATT_DM_DATA_PRINT=y
+
+CONFIG_BT_SETTINGS=y
+CONFIG_FLASH=y
+CONFIG_FLASH_PAGE_LAYOUT=y
+CONFIG_FLASH_MAP=y
+CONFIG_FCB=y
+CONFIG_SETTINGS=y
+CONFIG_SETTINGS_FCB=y
+
+CONFIG_SYSTEM_WORKQUEUE_STACK_SIZE=2048
diff --git a/tests/samples/bluetooth/samples_test_app/sample.yaml b/tests/samples/bluetooth/samples_test_app/sample.yaml
@@ -0,0 +1,25 @@
+sample:
+  description: Appl with central role for testing basic Bluetooth functionality in BLE samples
+  name: BLE Samples Test App
+tests:
+  sample.bluetooth.ble_samples_test_app:
+    sysbuild: true
+    harness: bluetooth
+    integration_platforms:
+      - nrf52dk/nrf52832
+      - nrf52833dk/nrf52833
+      - nrf52840dk/nrf52840
+      - nrf5340dk/nrf5340/cpuapp
+      - nrf54h20dk/nrf54h20/cpuapp
+      - nrf54l15dk/nrf54l15/cpuapp
+    platform_allow:
+      - nrf52dk/nrf52832
+      - nrf52833dk/nrf52833
+      - nrf52840dk/nrf52840
+      - nrf5340dk/nrf5340/cpuapp
+      - nrf54h20dk/nrf54h20/cpuapp
+      - nrf54l15dk/nrf54l15/cpuapp
+    tags:
+      - bluetooth
+      - ci_build
+      - sysbuild
diff --git a/tests/samples/bluetooth/samples_test_app/src/main.c b/tests/samples/bluetooth/samples_test_app/src/main.c
diff --git a/tests/samples/bluetooth/samples_test_app/sysbuild/ipc_radio/prj.conf b/tests/samples/bluetooth/samples_test_app/sysbuild/ipc_radio/prj.conf
