Add scan library #446

sondrep · 2025-10-28T09:15:46Z

No description provided.

github-actions · 2025-10-28T11:26:58Z

You can find the documentation preview for this PR here.

doc/nrf-bm/api/api.rst

doc/nrf-bm/libraries/bluetooth/ble_scan.rst

include/bm/bluetooth/ble_scan.h

tejlmand · 2025-11-27T08:36:30Z

tests/lib/bluetooth/ble_scan/CMakeLists.txt

+  CONFIG_BLE_SCAN_BUFFER_SIZE=31
+  CONFIG_BLE_SCAN_NAME_MAX_LEN=32
+  CONFIG_BLE_SCAN_SHORT_NAME_MAX_LEN=32
+  CONFIG_BLE_SCAN_NAME_COUNT=1
+  CONFIG_BLE_SCAN_APPEARANCE_COUNT=1
+  CONFIG_BLE_SCAN_ADDRESS_COUNT=1
+  CONFIG_BLE_SCAN_SHORT_NAME_COUNT=2
+  CONFIG_BLE_SCAN_UUID_COUNT=1
+  CONFIG_BLE_SCAN_INTERVAL=160
+  CONFIG_BLE_SCAN_DURATION=0
+  CONFIG_BLE_SCAN_WINDOW=80
+  CONFIG_BLE_SCAN_SLAVE_LATENCY=0
+  CONFIG_BLE_SCAN_MIN_CONNECTION_INTERVAL=6
+  CONFIG_BLE_SCAN_MAX_CONNECTION_INTERVAL=24
+  CONFIG_BLE_SCAN_SUPERVISION_TIMEOUT=3200
+  CONFIG_BLE_SCAN_FILTER=1


why are those added as compile definitions when Kconfig is available ?

We are not enabling the libraries (and all its dependencies) in the unit tests, only adding the target sources itself.

that still doesn't explain why you're not using Kconfig.

You shouldn't be using compile definitions for Kconfig settings.

Instead, use the proper prj.conf, and if you need to loosen dependencies on a given Kconfig symbol for test purposes, then you can do this in the Kconfig file for the test.

For example like this:

# tests/lib/bluetooth/ble_scan/Kconfig # Clear dependencies for BLE_SCAN and enable it to allow # testing the features without enabling the library. config BLE_SCAN default y source "Kconfig.zephyr"

If you copied this principle from elsewhere, then please create a jira and requesting the wrong principle to be cleaned up because other people might copy a bad example.

Kconfigs are added as compile options in many other unit tests, both this repo, sdk-nrf and sdk-zephyr (search for -DCONFIG_ or add_compile_definitions(CONFIG_ in CMakeLists.txt).

I've updated this test, and will try to apply the same changes to the rest of the tests in this repository.

Opened #519 to address comment in other tests.

tejlmand · 2025-11-27T08:37:30Z

tests/lib/bluetooth/ble_scan/CMakeLists.txt

+  "__STATIC_INLINE")
+cmock_handle(${SOFTDEVICE_INCLUDE_DIR}/ble_gatts.h
+  WORD_EXCLUDE
+  "__STATIC_INLINE")


if line wrapping the function then the end ) goes on its own line.

Suggested change

"__STATIC_INLINE")

"__STATIC_INLINE"

)

These could be removed with SUPPRESS_INLINE_IMPLEMENTATION in the compile definitions.

tejlmand · 2025-11-27T09:35:33Z

tests/lib/bluetooth/ble_scan/CMakeLists.txt

+)
+
+set(SOFTDEVICE_VARIANT "s145")
+set(SOFTDEVICE_INCLUDE_DIR "${ZEPHYR_NRF_BM_MODULE_DIR}/components/softdevice/${SOFTDEVICE_VARIANT}/${SOFTDEVICE_VARIANT}_API/include")


please line wrap. Line exceeds 100 chars/

tejlmand

Please fix Kconfig.

anhmolt

Some nits before I approve.

doc/nrf-bm/libraries/bluetooth/ble_scan.rst

include/bm/bluetooth/ble_scan.h

tests/lib/bluetooth/ble_scan/CMakeLists.txt

tests/lib/bluetooth/ble_scan/src/unity_test.c

doc/nrf-bm/libraries/bluetooth/ble_scan.rst

include/bm/bluetooth/ble_scan.h

MirkoCovizzi · 2025-11-27T14:06:29Z

include/bm/bluetooth/ble_scan.h

+/**
+ * @brief Initialize the Scan library.
+ *
+ * @param[out] scan Scan library instance. This structure must be supplied


Formatting. Also elsewhere.

include/bm/bluetooth/ble_scan.h

lib/bluetooth/ble_scan/ble_scan.c

lib/bluetooth/ble_scan/Kconfig

doc/nrf-bm/libraries/bluetooth/ble_scan.rst

include/bm/bluetooth/ble_scan.h

doc/nrf-bm/libraries/bluetooth/ble_scan.rst

Add scan library. Co-authored-by: Sondre Pettersen <[email protected]> Co-authored-by: Asil Zogby <[email protected]> Signed-off-by: Eivind Jølsgard <[email protected]>

nordicjm · 2025-12-01T07:48:59Z

doc/nrf-bm/doxygen/nrf-bm.doxyfile


 PREDEFINED             = __DOXYGEN__ \
                         CONFIG_BLE_QWR_MAX_ATTR=1 \
+                         CONFIG_BLE_SCAN_FILTER=1 \


why are these needed?

nordicjm · 2025-12-01T07:49:38Z

doc/nrf-bm/libraries/bluetooth/ble_scan.rst

+
+You can configure this library in one of the following modes:
+
+* Simple mode without using filters or the whitelist.


*allow list, whitelist is a non-inclusive term https://docs.zephyrproject.org/latest/contribute/coding_guidelines/index.html#rule-a-2-inclusive-language

nordicjm · 2025-12-01T07:53:21Z

include/bm/bluetooth/ble_scan.h

+
+#if defined(CONFIG_BLE_SCAN_FILTER)
+
+#if (CONFIG_BLE_SCAN_NAME_COUNT > 0)


the brackets here are not needed

nordicjm · 2025-12-01T07:53:40Z

include/bm/bluetooth/ble_scan.h

+ *
+ * @return true if whitelist is used.
+ */
+bool is_whitelist_used(struct ble_scan const *const scan_ctx);


nordicjm · 2025-12-01T07:55:31Z

include/bm/bluetooth/ble_scan.h

+ *                                 @ref ble_scan_filter_type_t.
+ * @retval BLE_ERROR_GAP_INVALID_BLE_ADDR If the BLE address type is invalid.
+ */
+int ble_scan_filter_set(struct ble_scan *const scan_ctx, uint8_t type,


why would you name this set if it adds one, name it add? Then it works with remove as well? Set means "this replaces the existing configuration" it does not mean to append

This is the naming from nRF5 API. Will rename to _add.

nordicjm · 2025-12-01T07:56:18Z

lib/bluetooth/ble_scan/Kconfig

+#
+
+menuconfig BLE_SCAN
+	bool "BLE Scan"


Suggested change

bool "BLE Scan"

bool "BLE Scan [EXPERIMENTAL]"

please ensure all experimental/deprecated symbols have this style with EXPERIMENTAL/DEPRECATED in the text

Ok, @anhmolt we need to do this for other libraries as well.

nordicjm · 2025-12-01T07:57:37Z

tests/lib/bluetooth/ble_scan/Kconfig

@@ -0,0 +1,6 @@
+# Clear dependencies for BLE_SCAN and enable it to allow
+# testing the features without enabling the library.
+config BLE_SCAN


as per other PR

eivindj-nordic · 2025-12-01T08:27:27Z

Closing in favor of #514 that combines this with db discovery and hrs c.

github-actions bot added the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Oct 28, 2025

asilz assigned asilz and sondrep Oct 28, 2025

sondrep force-pushed the scan branch from f7b6bcf to ca547c4 Compare October 28, 2025 11:25

sondrep force-pushed the scan branch 3 times, most recently from 87751eb to 02a21e4 Compare October 28, 2025 13:07

asilz force-pushed the scan branch from 02a21e4 to ca547c4 Compare October 28, 2025 13:32

sondrep force-pushed the scan branch 5 times, most recently from 76f656c to ced7dac Compare November 4, 2025 07:52

github-actions bot removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Nov 4, 2025

sondrep force-pushed the scan branch 2 times, most recently from af74266 to 8fcd041 Compare November 11, 2025 12:24

sondrep force-pushed the scan branch from 8fcd041 to 68613be Compare November 18, 2025 15:00

github-actions bot added the doc-required PR must not be merged without tech writer approval. label Nov 18, 2025

sondrep force-pushed the scan branch from 68613be to fdf32ad Compare November 18, 2025 15:05

eivindj-nordic added this to the v1.0.0 milestone Nov 19, 2025

eivindj-nordic force-pushed the scan branch from fdf32ad to b789a87 Compare November 21, 2025 09:58

eivindj-nordic marked this pull request as ready for review November 21, 2025 09:58

eivindj-nordic requested review from a team as code owners November 21, 2025 09:58

eivindj-nordic force-pushed the scan branch from b789a87 to 455f1a4 Compare November 21, 2025 10:01

peknis requested changes Nov 21, 2025

View reviewed changes

eivindj-nordic force-pushed the scan branch from 455f1a4 to d1f5b74 Compare November 21, 2025 11:04

eivindj-nordic self-assigned this Nov 26, 2025

tejlmand reviewed Nov 27, 2025

View reviewed changes

eivindj-nordic force-pushed the scan branch from bff2627 to d4e763b Compare November 27, 2025 09:08

tejlmand reviewed Nov 27, 2025

View reviewed changes

tejlmand requested changes Nov 27, 2025

View reviewed changes

eivindj-nordic force-pushed the scan branch 2 times, most recently from 8ed58d0 to fe132b5 Compare November 27, 2025 11:59

anhmolt reviewed Nov 27, 2025

View reviewed changes

MirkoCovizzi reviewed Nov 27, 2025

View reviewed changes

eivindj-nordic force-pushed the scan branch from fe132b5 to 95b36a3 Compare November 27, 2025 13:56

MirkoCovizzi reviewed Nov 27, 2025

View reviewed changes

include/bm/bluetooth/ble_scan.h Outdated Show resolved Hide resolved

include/bm/bluetooth/ble_scan.h Outdated Show resolved Hide resolved

MirkoCovizzi reviewed Nov 27, 2025

View reviewed changes

eivindj-nordic force-pushed the scan branch from 95b36a3 to aac3e05 Compare November 27, 2025 14:15

MirkoCovizzi reviewed Nov 27, 2025

View reviewed changes

lib/bluetooth/ble_scan/ble_scan.c Outdated Show resolved Hide resolved

lib/bluetooth/ble_scan/ble_scan.c Outdated Show resolved Hide resolved

lib/bluetooth/ble_scan/Kconfig Outdated Show resolved Hide resolved

eivindj-nordic force-pushed the scan branch from aac3e05 to c495bd2 Compare November 27, 2025 15:17

eivindj-nordic requested review from MirkoCovizzi, anhmolt and tejlmand November 27, 2025 15:18

eivindj-nordic force-pushed the scan branch from c495bd2 to 3ba580d Compare November 28, 2025 08:56

anhmolt reviewed Nov 28, 2025

View reviewed changes

doc/nrf-bm/libraries/bluetooth/ble_scan.rst Outdated Show resolved Hide resolved

eivindj-nordic force-pushed the scan branch 2 times, most recently from 86b38bc to 2a60858 Compare November 28, 2025 09:46

anhmolt reviewed Nov 28, 2025

View reviewed changes

include/bm/bluetooth/ble_scan.h Show resolved Hide resolved

doc/nrf-bm/libraries/bluetooth/ble_scan.rst Outdated Show resolved Hide resolved

lib: scan: add scan library

13aa7ac

Add scan library. Co-authored-by: Sondre Pettersen <[email protected]> Co-authored-by: Asil Zogby <[email protected]> Signed-off-by: Eivind Jølsgard <[email protected]>

eivindj-nordic force-pushed the scan branch from 2a60858 to 13aa7ac Compare November 28, 2025 15:11

anhmolt approved these changes Nov 28, 2025

View reviewed changes

eivindj-nordic mentioned this pull request Dec 1, 2025

services: add ble_bms #280

Merged

nordicjm reviewed Dec 1, 2025

View reviewed changes

eivindj-nordic closed this Dec 1, 2025


		You can configure this library in one of the following modes:

		* Simple mode without using filters or the whitelist.


		#if defined(CONFIG_BLE_SCAN_FILTER)

		#if (CONFIG_BLE_SCAN_NAME_COUNT > 0)

Add scan library #446

Add scan library #446

Uh oh!

Conversation

sondrep commented Oct 28, 2025

Uh oh!

github-actions bot commented Oct 28, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tejlmand left a comment

Choose a reason for hiding this comment

Uh oh!

anhmolt left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

eivindj-nordic commented Dec 1, 2025 •

edited

Loading