doc: Document DULT motion detector feature #18138

alstrzebonski · 2024-10-23T15:08:32Z

Jira: NCSDK-28984

NordicBuilder · 2024-10-23T15:10:09Z

CI Information

^{To view the history of this post, clich the 'edited' button above}
Build number: 7

Inputs:

Sources:

sdk-nrf: PR head: 9218c3d474cfd69a3938375a58951d8298dfae0e

more details

sdk-nrf:

PR head: 9218c3d474cfd69a3938375a58951d8298dfae0e
merge base: 4b32dada658b7c84a5a7b2e1d59a6a0eefb35419
target head (main): 857f1765ee652230fdfa97409a9989de1f815190
Diff

Github labels

Enabled	Name	Description
	ci-disabled	Disable the ci execution
	ci-all-test	Run all of ci, no test spec filtering will be done
	ci-force-downstream	Force execution of downstream even if twister fails
	ci-run-twister	Force run twister
	ci-run-zephyr-twister	Force run zephyr twister

List of changed files detected by CI (6)

doc
│  ├── nrf
│  │  ├── external_comp
│  │  │  ├── bt_fast_pair.rst
│  │  │  │ dult.rst
│  │  ├── libraries
│  │  │  ├── bluetooth_services
│  │  │  │  ├── services
│  │  │  │  │  │ fast_pair.rst
│  │  │  ├── others
│  │  │  │  │ dult.rst
│  │  │ links.txt
samples
│  ├── bluetooth
│  │  ├── fast_pair
│  │  │  ├── locator_tag
│  │  │  │  │ README.rst

Outputs:

Toolchain

Version:
Build docker image:

Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped; ⚠️ Quarantine

◻️ Toolchain
◻️ Build twister
◻️ Integration tests
- ◻️ test-fw-nrfconnect-ble_samples

Disabled integration tests

- desktop52_verification
- doc-internal
- test_ble_nrf_config
- test-fw-nrfconnect-apps
- test-fw-nrfconnect-ble_mesh
- test-fw-nrfconnect-boot
- test-fw-nrfconnect-chip
- test-fw-nrfconnect-fem
- test-fw-nrfconnect-nfc
- test-fw-nrfconnect-nrf-iot_cloud
- test-fw-nrfconnect-nrf-iot_libmodem-nrf
- test-fw-nrfconnect-nrf-iot_lwm2m
- test-fw-nrfconnect-nrf-iot_mosh
- test-fw-nrfconnect-nrf-iot_nrf_provisioning
- test-fw-nrfconnect-nrf-iot_positioning
- test-fw-nrfconnect-nrf-iot_samples
- test-fw-nrfconnect-nrf-iot_thingy91
- test-fw-nrfconnect-nrf-iot_zephyr_lwm2m
- test-fw-nrfconnect-nrf_crypto
- test-fw-nrfconnect-proprietary_esb
- test-fw-nrfconnect-rpc
- test-fw-nrfconnect-rs
- test-fw-nrfconnect-tfm
- test-fw-nrfconnect-thread
- test-fw-nrfconnect-zigbee
- test-low-level
- test-sdk-audio
- test-sdk-dfu
- test-sdk-find-my
- test-sdk-mcuboot
- test-sdk-pmic-samples
- test-sdk-sidewalk
- test-sdk-wifi

Note: This message is automatically posted and updated by the CI

NordicBuilder · 2024-10-23T15:25:35Z

You can find the documentation preview for this PR at this link. It will be updated about 10 minutes after the documentation build succeeds.

Note: This comment is automatically posted by the Documentation Publishing GitHub Action.

peknis · 2024-10-24T07:19:55Z

doc/nrf/external_comp/bt_fast_pair.rst

+
+* The motion detector start request is indicated by the :c:member:`bt_fast_pair_fmdn_motion_detector_cb.start` callback.
+  After this callback is called, the motion detector events are polled periodically with the :c:member:`bt_fast_pair_fmdn_motion_detector_cb.period_expired` callback.
+  Typical action after the motion detector start request is to power up the accelerometer and start collecting motion data.


Suggested change

Typical action after the motion detector start request is to power up the accelerometer and start collecting motion data.

A typical action after the motion detector start request is to power up the accelerometer and start collecting motion data.

peknis · 2024-10-24T07:23:26Z

doc/nrf/external_comp/bt_fast_pair.rst

+  This callback is called at the end of each motion detector period.
+  The :c:member:`bt_fast_pair_fmdn_motion_detector_cb.start` callback indicates the beginning of the first motion detector period.
+  The next period is started as soon as the previous period expires.
+  The user should notify the DULT module if motion was detected in the previous period.


If this is something that requires user action (not something that happens in the sw), use active voice like:
"You need to notify the DULT module, if..."

peknis · 2024-10-24T07:24:06Z

doc/nrf/external_comp/bt_fast_pair.rst

+  The next period is started as soon as the previous period expires.
+  The user should notify the DULT module if motion was detected in the previous period.
+  The return value of this callback is used to pass this information.
+  The motion must be considered as detected if it fulfills the requirements defined in the `DULT Motion detector`_ section of the DULT documentation.


must be or is considered?

it's the "must" requirement in the spec.

peknis · 2024-10-24T07:24:37Z

doc/nrf/external_comp/bt_fast_pair.rst

+  The motion must be considered as detected if it fulfills the requirements defined in the `DULT Motion detector`_ section of the DULT documentation.
+* The motion detector stop request is indicated by the :c:member:`bt_fast_pair_fmdn_motion_detector_cb.stop` callback.
+  It concludes the motion detector activity that was started by the :c:member:`bt_fast_pair_fmdn_motion_detector_cb.start` callback.
+  Typical action after the motion detector stop request is to power down the accelerometer.


Suggested change

Typical action after the motion detector stop request is to power down the accelerometer.

A typical action after the motion detector stop request is to power down the accelerometer.

peknis · 2024-10-24T07:33:01Z

doc/nrf/external_comp/bt_fast_pair.rst

+  It concludes the motion detector activity that was started by the :c:member:`bt_fast_pair_fmdn_motion_detector_cb.start` callback.
+  Typical action after the motion detector stop request is to power down the accelerometer.
+
+The motion detector is started by the DULT subsystem when the accessory is in the separated state for a sufficient amount of time.


Can we be more specific? What would be a sufficient time?

It's a random value. The ranges are defined in the kconfigs. By default they are set to 8 hours (min) and 24 hours (max). It is described in the doc/nrf/libraries/others/dult.rst.

Maybe:
"The motion detector is started by the DULT subsystem when the accessory is in the separated state for an amount of time controlled by the :kconfig:option:CONFIG_DULT_MOTION_DETECTOR_SEPARATED_UT_TIMEOUT_PERIOD_MIN and :kconfig:option:CONFIG_DULT_MOTION_DETECTOR_SEPARATED_UT_TIMEOUT_PERIOD_MAX Kconfig options.". What do you think?

peknis · 2024-10-24T08:16:18Z

samples/bluetooth/fast_pair/locator_tag/README.rst

+It is done to inform the non-owner that is moving the accessory, that the device might have been used to track the non-owner.
+On DKs the simulated motion can be generated by button action.
+On Thingy:53 the built-in accelerometer is used to detect the motion.
+The motion detector is deactivated for :kconfig:option:`CONFIG_DULT_MOTION_DETECTOR_SEPARATED_UT_BACKOFF_PERIOD` after the :kconfig:option:`CONFIG_DULT_MOTION_DETECTOR_SEPARATED_UT_MAX_SOUND_COUNT` number of sounds has been played or after the motion has been detected and :kconfig:option:`CONFIG_DULT_MOTION_DETECTOR_SEPARATED_UT_ACTIVE_POLL_DURATION` amount of time has passed.


Suggested change

The motion detector is deactivated for :kconfig:option:`CONFIG_DULT_MOTION_DETECTOR_SEPARATED_UT_BACKOFF_PERIOD` after the :kconfig:option:`CONFIG_DULT_MOTION_DETECTOR_SEPARATED_UT_MAX_SOUND_COUNT` number of sounds has been played or after the motion has been detected and :kconfig:option:`CONFIG_DULT_MOTION_DETECTOR_SEPARATED_UT_ACTIVE_POLL_DURATION` amount of time has passed.

The motion detector is deactivated for the period set in the :kconfig:option:`CONFIG_DULT_MOTION_DETECTOR_SEPARATED_UT_BACKOFF_PERIOD` Kconfig option after the :kconfig:option:`CONFIG_DULT_MOTION_DETECTOR_SEPARATED_UT_MAX_SOUND_COUNT` number of sounds has been played or after the motion has been detected and :kconfig:option:`CONFIG_DULT_MOTION_DETECTOR_SEPARATED_UT_ACTIVE_POLL_DURATION` amount of time has passed.

peknis · 2024-10-24T08:17:28Z

samples/bluetooth/fast_pair/locator_tag/README.rst

@@ -220,11 +232,13 @@ The user interface of the sample depends on the hardware platform you are using.
         * Blinks at a 0.25 second interval if the DFU mode is enabled.

      LED 2:
-         Indicates that the ringing action is in progress.
-         Depending on the ringing state:
+         Indicates that the ringing action is in progress, informs that the simulated motion has been detected, and informs that the motion detector is active.


Suggested change

Indicates that the ringing action is in progress, informs that the simulated motion has been detected, and informs that the motion detector is active.

Indicates that the ringing action is in progress, informing that the simulated motion has been detected and the motion detector is active.

peknis · 2024-10-24T08:19:07Z

samples/bluetooth/fast_pair/locator_tag/README.rst

-         * Lit if the device is ringing.
-         * Off if the device is not ringing.
+         * Blinks fast twice if the motion detected event appears.
+         * Lit if the device is ringing and motion detected event is not being signalized.


"signalized" sounds a bit odd, but cannot figure out what would be better.

Maybe:

Suggested change

* Lit if the device is ringing and motion detected event is not being signalized.

* Lit if the device is ringing and no motion detection event is being indicated.

? We could also stick to "signal", but then I think it should be "signaled", instead of "signalized"

Indicated sounds better. Thanks!

peknis · 2024-10-24T08:19:32Z

samples/bluetooth/fast_pair/locator_tag/README.rst

+         Stops the ongoing ringing action on single press.
+         Generates simulated motion event on double press.


Suggested change

Stops the ongoing ringing action on single press.

Generates simulated motion event on double press.

Stops the ongoing ringing action on a single press.

Generates simulated motion event on a double press.

peknis · 2024-10-24T08:20:21Z

samples/bluetooth/fast_pair/locator_tag/README.rst

@@ -303,11 +318,13 @@ The user interface of the sample depends on the hardware platform you are using.
         * Blinks at a 0.25 second interval if the DFU mode is enabled.

      LED 1:
-         Indicates that the ringing action is in progress.
-         Depending on the ringing state:
+         Indicates that the ringing action is in progress, informs that the simulated motion has been detected, and informs that the motion detector is active.


Same suggestions as above.

annwoj · 2024-10-24T14:39:56Z

doc/nrf/external_comp/bt_fast_pair.rst

+
+The motion detector is started by the DULT subsystem when the accessory is in the separated state for a sufficient amount of time.
+When the motion is detected during the motion detector active period, the :c:member:`bt_fast_pair_fmdn_ring_cb.start_request` callback is called to request the ringing action.
+It is done to inform the non-owner that is moving the accessory, that the device might have been used to track the non-owner.


What is "non-owner" in this context?

This is the person that is not owning the accessory. It describes a case where the accessory owner could e.g. throw the accessory into other person's (non-owner) backpack to track him.

Noted, thanks! :) If it's the person then we should indicate it with "who". I'd suggest the following change to simplify the meaning, let me know if it affects it:

Suggested change

It is done to inform the non-owner that is moving the accessory, that the device might have been used to track the non-owner.

It is done to inform the non-owner who is moving the accessory that a device might be tracking their movements.

There are also other occurrences of this sentence

annwoj · 2024-10-24T14:55:24Z

doc/nrf/external_comp/bt_fast_pair.rst

+
+The motion detector is an optional feature of the DULT subsystem that can be integrated into the FMDN extension.
+For more details about the feature, see the `DULT Motion detector`_ section of the DULT specification.
+You can enable the :kconfig:option:`CONFIG_BT_FAST_PAIR_FMDN_DULT_MOTION_DETECTOR` Kconfig option to support the DULT motion detector functionality in the FMDN extension.


Suggested change

You can enable the :kconfig:option:`CONFIG_BT_FAST_PAIR_FMDN_DULT_MOTION_DETECTOR` Kconfig option to support the DULT motion detector functionality in the FMDN extension.

To activate the DULT motion detector functionality in the FMDN extension, enable the :kconfig:option:`CONFIG_BT_FAST_PAIR_FMDN_DULT_MOTION_DETECTOR` Kconfig option.

annwoj · 2024-10-24T14:56:18Z

doc/nrf/external_comp/bt_fast_pair.rst

+It passes callbacks from the DULT motion detector module to the user application.
+
+To register the motion detector callbacks, use the :c:func:`bt_fast_pair_fmdn_motion_detector_cb_register` function.
+All motion detector callbacks defined in the :c:struct:`bt_fast_pair_fmdn_motion_detector_cb` structure are mandatory to register:


Suggested change

All motion detector callbacks defined in the :c:struct:`bt_fast_pair_fmdn_motion_detector_cb` structure are mandatory to register:

You must register all motion detector callbacks defined in the :c:struct:`bt_fast_pair_fmdn_motion_detector_cb` structure:

If it's the user doing this (same for line 265). If not, plz disregard

You're right

annwoj · 2024-10-24T15:00:39Z

doc/nrf/external_comp/dult.rst

-  The minimum duration for the DULT sound action is defined by the :c:macro:`DULT_SOUND_DURATION_MIN_MS`.
-  The upper layer determines the sound duration, and the duration must be greater than the value set in the :c:macro:`DULT_SOUND_DURATION_MIN_MS` macro.
+  The minimum duration for the DULT sound action originating from the Bluetooth ANOS is defined by the :c:macro:`DULT_SOUND_DURATION_BT_GATT_MIN_MS`.
+  The upper layer determines the sound duration, and, in case of the sound action originating from the Bluetooth ANOS, the duration must be greater than the value set in the :c:macro:`DULT_SOUND_DURATION_BT_GATT_MIN_MS` macro.


Suggested change

The upper layer determines the sound duration, and, in case of the sound action originating from the Bluetooth ANOS, the duration must be greater than the value set in the :c:macro:`DULT_SOUND_DURATION_BT_GATT_MIN_MS` macro.

The upper layer determines the sound duration, and for sound action originating from the Bluetooth ANOS, the duration must exceed the value set in the :c:macro:`DULT_SOUND_DURATION_BT_GATT_MIN_MS` macro.

to simplify a bit

annwoj · 2024-10-24T15:19:05Z

samples/bluetooth/fast_pair/locator_tag/README.rst

-         * Lit if the device is ringing.
-         * Off if the device is not ringing.
+         * Blinks fast twice if the motion detected event appears.
+         * Lit if the device is ringing and motion detected event is not being signalized.


Maybe:

Suggested change

* Lit if the device is ringing and motion detected event is not being signalized.

* Lit if the device is ringing and no motion detection event is being indicated.

? We could also stick to "signal", but then I think it should be "signaled", instead of "signalized"

alstrzebonski · 2024-10-25T09:27:06Z

Added testing steps for the motion detector feature in the separate commit.

alstrzebonski · 2024-10-25T10:04:23Z

Fixed doc build issue.

doc/nrf/libraries/others/dult.rst

doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst

doc/nrf/external_comp/dult.rst

samples/bluetooth/fast_pair/locator_tag/README.rst

alstrzebonski · 2024-10-25T13:10:30Z

Addressed review comments. Please rereview.

mkapala-nordic · 2024-10-25T13:36:53Z

samples/bluetooth/fast_pair/locator_tag/README.rst

+In this state, if motion is detected, the accessory starts the ringing action.
+Played sounds help a non-owner identify an accessory that is moving with them, as the device might have been used to track the non-owner location by its owner.
+On DKs, the simulated motion can be generated by button action.
+On the Thingy0:53, the built-in accelerometer is used to detect the motion.


doc/nrf/libraries/others/dult.rst

samples/bluetooth/fast_pair/locator_tag/README.rst

kapi-no · 2024-10-25T14:53:53Z

Please fix the documentation build so that we can view the updated documentation in the HTML-rendered form.

samples/bluetooth/fast_pair/locator_tag/README.rst

alstrzebonski · 2024-10-28T11:23:47Z

Addressed review comments.

samples/bluetooth/fast_pair/locator_tag/README.rst

doc/nrf/external_comp/dult.rst

peknis · 2024-10-29T07:12:51Z

doc/nrf/libraries/others/dult.rst

+    These values are defined in the DULT specification and should not be changed in the production code.
+    This option is disabled by default.
+
+    * :kconfig:option:`CONFIG_DULT_MOTION_DETECTOR_SEPARATED_UT_BACKOFF_PERIOD` - This option allows to configure the period in minutes to disable the motion detector if the accessory is in the separated state.


Take these three bullets back two steps. I guess they can be on the same level as the one above.

They have prompt only if the CONFIG_DULT_MOTION_DETECTOR_TEST_MODE is enabled so I wanted to group them under this kconfig description.

peknis · 2024-10-29T07:14:56Z

doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst

@@ -455,6 +455,9 @@ Bluetooth Fast Pair samples
    * An application versioning using the :file:`VERSION` file.
    * The DFU support which can be enabled using the ``SB_CONFIG_APP_DFU`` sysbuild Kconfig option.
      DFU is available for all supported targets except the ``debug`` configurations of :ref:`zephyr:nrf52dk_nrf52832` and :ref:`zephyr:nrf52833dk_nrf52833` due to size constraints.
+    * An application module for the DULT motion detector feature and the new UI for supported board targets to interact with this feature.


Remove the changelog from this PR and consult @divipillai . She will add the entries to her PR.

Yes, I just wanted to get approves here and later move it to Divya's PR.

Please remove DNM label when it's done, it could've been merged by accident.

peknis · 2024-10-29T07:32:54Z

samples/bluetooth/fast_pair/locator_tag/README.rst

+Motion detector mode
+--------------------
+
+In the provisioned state, the accessory can activate the motion detector mode from the DULT specification.


This sounds a bit strange, "activate the motion detector mode from the ... spec."
Should we rephrase?

maybe "... mode defined in the DULT specification"?

peknis · 2024-10-29T07:34:13Z

samples/bluetooth/fast_pair/locator_tag/README.rst

+--------------------
+
+In the provisioned state, the accessory can activate the motion detector mode from the DULT specification.
+It happens when the accessory is separated from the owner for a sufficient amount of time (see :kconfig:option:`CONFIG_DULT_MOTION_DETECTOR_SEPARATED_UT_TIMEOUT_PERIOD_MIN` and :kconfig:option:`CONFIG_DULT_MOTION_DETECTOR_SEPARATED_UT_TIMEOUT_PERIOD_MAX` Kconfig options).


What happens exactly? The motion detector mode is activated?

peknis · 2024-10-29T07:34:57Z

samples/bluetooth/fast_pair/locator_tag/README.rst

+It happens when the accessory is separated from the owner for a sufficient amount of time (see :kconfig:option:`CONFIG_DULT_MOTION_DETECTOR_SEPARATED_UT_TIMEOUT_PERIOD_MIN` and :kconfig:option:`CONFIG_DULT_MOTION_DETECTOR_SEPARATED_UT_TIMEOUT_PERIOD_MAX` Kconfig options).
+In this state, if motion is detected, the accessory starts the ringing action.
+Emitted sounds help to alert the non-owner that they are carrying an accessory that does not belong to them and might be used by the original owner to track their location.
+On DKs, the simulated motion can be generated by button action.


Suggested change

On DKs, the simulated motion can be generated by button action.

On DKs, you can generate the simulated motion by button action.

peknis · 2024-10-29T07:52:54Z

samples/bluetooth/fast_pair/locator_tag/README.rst

+         1. Open the Find My Device app.
+         #. Tap on your accessory in the list.
+            The accessory should have "Nearby" written under its name.
+         #. Tap on the gear icon next to the device name


Suggested change

#. Tap on the gear icon next to the device name

#. Tap the gear icon next to the device name

peknis · 2024-10-29T07:53:19Z

samples/bluetooth/fast_pair/locator_tag/README.rst

+            The other Android device can belong to anyone around you.
+            It is recommended to be in a crowded area.
+
+      #. Wait for 3 minutes (random value between the :kconfig:option:`CONFIG_DULT_MOTION_DETECTOR_SEPARATED_UT_TIMEOUT_PERIOD_MIN` and :kconfig:option:`CONFIG_DULT_MOTION_DETECTOR_SEPARATED_UT_TIMEOUT_PERIOD_MAX` Kconfig options) for the motion detector to be activated.


Suggested change

#. Wait for 3 minutes (random value between the :kconfig:option:`CONFIG_DULT_MOTION_DETECTOR_SEPARATED_UT_TIMEOUT_PERIOD_MIN` and :kconfig:option:`CONFIG_DULT_MOTION_DETECTOR_SEPARATED_UT_TIMEOUT_PERIOD_MAX` Kconfig options) for the motion detector to be activated.

#. Wait for three minutes (random value between the :kconfig:option:`CONFIG_DULT_MOTION_DETECTOR_SEPARATED_UT_TIMEOUT_PERIOD_MIN` and :kconfig:option:`CONFIG_DULT_MOTION_DETECTOR_SEPARATED_UT_TIMEOUT_PERIOD_MAX` Kconfig options) for the motion detector to be activated.

peknis · 2024-10-29T07:53:40Z

samples/bluetooth/fast_pair/locator_tag/README.rst

+      #. Double-click **Button 1** to simulate the motion event.
+      #. Observe that **LED 1** blinks fast twice, which indicates that the motion detected event appears.
+      #. Observe that after up to 10 seconds, the ringing action starts for 1 second which is indicated by **LED 1** being lit.
+      #. Observe that **LED 1** goes back to blinking at a 0.25 second interval which indicates that the motion detector is active.


Suggested change

#. Observe that **LED 1** goes back to blinking at a 0.25 second interval which indicates that the motion detector is active.

#. Observe that **LED 1** goes back to blinking at a 0.25 second interval, which indicates that the motion detector is active.

peknis · 2024-10-29T07:54:07Z

samples/bluetooth/fast_pair/locator_tag/README.rst

+      #. Observe that **LED 1** goes back to blinking at a 0.25 second interval which indicates that the motion detector is active.
+      #. Double-click **Button 1** to simulate the motion event.
+      #. Observe that **LED 1** blinks fast twice, which indicates that the motion detected event appears.
+      #. Observe that after up to 0.5 second, the ringing action starts which is indicated by **LED 1** being lit.


Suggested change

#. Observe that after up to 0.5 second, the ringing action starts which is indicated by **LED 1** being lit.

#. Observe that after up to 0.5 second, the ringing action starts, which is indicated by **LED 1** being lit.

peknis · 2024-10-29T07:54:27Z

samples/bluetooth/fast_pair/locator_tag/README.rst

+      #. Observe that after up to 0.5 second, the ringing action starts which is indicated by **LED 1** being lit.
+      #. Double-click **Button 1** to simulate the motion event while the **LED 1** is still lit (ringing action is still in progress).
+      #. Observe that **LED 1** blinks fast twice, which indicates that the motion detected event appears.
+      #. Observe that after 0.5 second, of not ringing, the ringing action starts again for 1 second which is indicated by **LED 1** being lit.


Suggested change

#. Observe that after 0.5 second, of not ringing, the ringing action starts again for 1 second which is indicated by **LED 1** being lit.

#. Observe that after 0.5 second, of not ringing, the ringing action starts again for one second, which is indicated by **LED 1** being lit.

alstrzebonski · 2024-10-29T11:32:19Z

Addressed review comments. Please rereview.

doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst

Jira: NCSDK-28984 Signed-off-by: Aleksander Strzebonski <[email protected]>

alstrzebonski · 2024-10-29T13:16:19Z

Removed changelog entry and added it here: #18192

alstrzebonski requested review from a team as code owners October 23, 2024 15:08

github-actions bot added the doc-required PR must not be merged without tech writer approval. label Oct 23, 2024

alstrzebonski added doc only and removed doc-required PR must not be merged without tech writer approval. labels Oct 23, 2024

alstrzebonski added this to the 2.8.0 milestone Oct 23, 2024

alstrzebonski added the doc-required PR must not be merged without tech writer approval. label Oct 23, 2024

peknis requested changes Oct 24, 2024

View reviewed changes

annwoj reviewed Oct 24, 2024

View reviewed changes

alstrzebonski requested a review from a team October 25, 2024 08:03

alstrzebonski added the backport v2.8-branch auto-create a PR with same commits to v2.8-branch label Oct 25, 2024

alstrzebonski force-pushed the dult_motion_doc branch from 60029c0 to 88782b8 Compare October 25, 2024 10:04

kapi-no reviewed Oct 25, 2024

View reviewed changes

alstrzebonski force-pushed the dult_motion_doc branch from 88782b8 to f1a7682 Compare October 25, 2024 13:10

alstrzebonski requested review from kapi-no, peknis and annwoj October 25, 2024 13:10

mkapala-nordic reviewed Oct 25, 2024

View reviewed changes

kapi-no reviewed Oct 25, 2024

View reviewed changes

doc/nrf/libraries/others/dult.rst Show resolved Hide resolved

samples/bluetooth/fast_pair/locator_tag/README.rst Outdated Show resolved Hide resolved

samples/bluetooth/fast_pair/locator_tag/README.rst Outdated Show resolved Hide resolved

kapi-no reviewed Oct 28, 2024

View reviewed changes

samples/bluetooth/fast_pair/locator_tag/README.rst Outdated Show resolved Hide resolved

alstrzebonski force-pushed the dult_motion_doc branch from f1a7682 to 72aff79 Compare October 28, 2024 11:21

alstrzebonski requested a review from kapi-no October 28, 2024 11:24

alstrzebonski requested a review from mkapala-nordic October 28, 2024 11:24

mkapala-nordic approved these changes Oct 28, 2024

View reviewed changes

kapi-no reviewed Oct 28, 2024

View reviewed changes

samples/bluetooth/fast_pair/locator_tag/README.rst Show resolved Hide resolved

samples/bluetooth/fast_pair/locator_tag/README.rst Outdated Show resolved Hide resolved

kapi-no reviewed Oct 28, 2024

View reviewed changes

doc/nrf/external_comp/dult.rst Show resolved Hide resolved

peknis requested changes Oct 29, 2024

View reviewed changes

alstrzebonski force-pushed the dult_motion_doc branch from 72aff79 to 7c29580 Compare October 29, 2024 11:32

alstrzebonski requested review from kapi-no and peknis October 29, 2024 11:32

kapi-no approved these changes Oct 29, 2024

View reviewed changes

peknis approved these changes Oct 29, 2024

View reviewed changes

annwoj approved these changes Oct 29, 2024

View reviewed changes

mkapala-nordic approved these changes Oct 29, 2024

View reviewed changes

kapi-no reviewed Oct 29, 2024

View reviewed changes

doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst Outdated Show resolved Hide resolved

rlubos added the DNM label Oct 29, 2024

alstrzebonski mentioned this pull request Oct 29, 2024

doc: Add release notes for 2.8 release #18192

Merged

5 tasks

alstrzebonski added 2 commits October 29, 2024 14:14

doc: Document DULT motion detector feature

e2d9361

Jira: NCSDK-28984 Signed-off-by: Aleksander Strzebonski <[email protected]>

doc: samples: locator_tag: Add motion detector testing steps

9218c3d

Jira: NCSDK-28984 Signed-off-by: Aleksander Strzebonski <[email protected]>

alstrzebonski force-pushed the dult_motion_doc branch from 7c29580 to 9218c3d Compare October 29, 2024 13:15

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

alstrzebonski removed the DNM label Oct 29, 2024

kapi-no approved these changes Oct 29, 2024

View reviewed changes

rlubos merged commit da3a123 into nrfconnect:main Oct 30, 2024
13 of 14 checks passed

NordicBuilder mentioned this pull request Oct 30, 2024

[Backport v2.8-branch] doc: Document DULT motion detector feature #18362

Merged

	Typical action after the motion detector start request is to power up the accelerometer and start collecting motion data.
	A typical action after the motion detector start request is to power up the accelerometer and start collecting motion data.

	Indicates that the ringing action is in progress, informs that the simulated motion has been detected, and informs that the motion detector is active.
	Indicates that the ringing action is in progress, informing that the simulated motion has been detected and the motion detector is active.

	* Lit if the device is ringing and motion detected event is not being signalized.
	* Lit if the device is ringing and no motion detection event is being indicated.

		Stops the ongoing ringing action on single press.
		Generates simulated motion event on double press.

	It is done to inform the non-owner that is moving the accessory, that the device might have been used to track the non-owner.
	It is done to inform the non-owner who is moving the accessory that a device might be tracking their movements.

	You can enable the :kconfig:option:`CONFIG_BT_FAST_PAIR_FMDN_DULT_MOTION_DETECTOR` Kconfig option to support the DULT motion detector functionality in the FMDN extension.
	To activate the DULT motion detector functionality in the FMDN extension, enable the :kconfig:option:`CONFIG_BT_FAST_PAIR_FMDN_DULT_MOTION_DETECTOR` Kconfig option.

	All motion detector callbacks defined in the :c:struct:`bt_fast_pair_fmdn_motion_detector_cb` structure are mandatory to register:
	You must register all motion detector callbacks defined in the :c:struct:`bt_fast_pair_fmdn_motion_detector_cb` structure:

	The upper layer determines the sound duration, and, in case of the sound action originating from the Bluetooth ANOS, the duration must be greater than the value set in the :c:macro:`DULT_SOUND_DURATION_BT_GATT_MIN_MS` macro.
	The upper layer determines the sound duration, and for sound action originating from the Bluetooth ANOS, the duration must exceed the value set in the :c:macro:`DULT_SOUND_DURATION_BT_GATT_MIN_MS` macro.

	On DKs, the simulated motion can be generated by button action.
	On DKs, you can generate the simulated motion by button action.

	#. Tap on the gear icon next to the device name
	#. Tap the gear icon next to the device name

	#. Wait for 3 minutes (random value between the :kconfig:option:`CONFIG_DULT_MOTION_DETECTOR_SEPARATED_UT_TIMEOUT_PERIOD_MIN` and :kconfig:option:`CONFIG_DULT_MOTION_DETECTOR_SEPARATED_UT_TIMEOUT_PERIOD_MAX` Kconfig options) for the motion detector to be activated.
	#. Wait for three minutes (random value between the :kconfig:option:`CONFIG_DULT_MOTION_DETECTOR_SEPARATED_UT_TIMEOUT_PERIOD_MIN` and :kconfig:option:`CONFIG_DULT_MOTION_DETECTOR_SEPARATED_UT_TIMEOUT_PERIOD_MAX` Kconfig options) for the motion detector to be activated.

	#. Observe that LED 1 goes back to blinking at a 0.25 second interval which indicates that the motion detector is active.
	#. Observe that LED 1 goes back to blinking at a 0.25 second interval, which indicates that the motion detector is active.

	#. Observe that after up to 0.5 second, the ringing action starts which is indicated by LED 1 being lit.
	#. Observe that after up to 0.5 second, the ringing action starts, which is indicated by LED 1 being lit.

	#. Observe that after 0.5 second, of not ringing, the ringing action starts again for 1 second which is indicated by LED 1 being lit.
	#. Observe that after 0.5 second, of not ringing, the ringing action starts again for one second, which is indicated by LED 1 being lit.

doc: Document DULT motion detector feature #18138

doc: Document DULT motion detector feature #18138

Conversation

alstrzebonski commented Oct 23, 2024

NordicBuilder commented Oct 23, 2024 • edited Loading

CI Information

Inputs:

Sources:

Github labels

Outputs:

Toolchain

Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped; ⚠️ Quarantine

NordicBuilder commented Oct 23, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alstrzebonski Oct 25, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alstrzebonski Oct 25, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

annwoj Oct 25, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alstrzebonski commented Oct 25, 2024

alstrzebonski commented Oct 25, 2024

alstrzebonski commented Oct 25, 2024

Choose a reason for hiding this comment

kapi-no commented Oct 25, 2024

alstrzebonski commented Oct 28, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alstrzebonski commented Oct 29, 2024

alstrzebonski commented Oct 29, 2024

NordicBuilder commented Oct 23, 2024 •

edited

Loading

alstrzebonski Oct 25, 2024 •

edited

Loading

alstrzebonski Oct 25, 2024 •

edited

Loading

annwoj Oct 25, 2024 •

edited

Loading