Skip to content
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.

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

Fast Pair: FMDN provisioning state APIs: documentation update #21118

Merged

Conversation

kapi-no
Copy link
Contributor

@kapi-no kapi-no commented Mar 24, 2025

The documentation update follows the code changes done in the following PR:

#20970

@kapi-no kapi-no requested review from a team as code owners March 24, 2025 13:00
@github-actions github-actions bot added the doc-required PR must not be merged without tech writer approval. label Mar 24, 2025
@NordicBuilder
Copy link
Contributor

NordicBuilder commented Mar 24, 2025

CI Information

To view the history of this post, clich the 'edited' button above
Build number: 2

Inputs:

Sources:

sdk-nrf: PR head: c56a744aeb130b9716e6e0aff8d8cd84c3cb5343

more details

sdk-nrf:

PR head: c56a744aeb130b9716e6e0aff8d8cd84c3cb5343
merge base: 9590302f99bbb220ee2f9ed748ca2020f3f63230
target head (main): 831d14c8a32905b89d6cadb9f01b94facb403865
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 (3)
doc
│  ├── nrf
│  │  ├── external_comp
│  │  │  │ bt_fast_pair.rst
│  │  ├── releases_and_maturity
│  │  │  ├── migration
│  │  │  │  │ migration_guide_3.0.rst
│  │  │  ├── releases
│  │  │  │  │ release-notes-changelog.rst

Outputs:

Toolchain

Version:
Build docker image:

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

  • ◻️ Toolchain
  • ◻️ Build twister
  • ◻️ Integration tests
Disabled integration tests
    • desktop52_verification
    • doc-internal
    • test-fw-nrfconnect-apps
    • test-fw-nrfconnect-ble_samples
    • 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_mosh
    • test-fw-nrfconnect-nrf-iot_positioning
    • test-fw-nrfconnect-nrf-iot_samples
    • test-fw-nrfconnect-nrf-iot_serial_lte_modem
    • 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-ps
    • test-fw-nrfconnect-rpc
    • test-fw-nrfconnect-rs
    • test-fw-nrfconnect-tfm
    • test-fw-nrfconnect-thread
    • test-low-level
    • test-sdk-audio
    • test-sdk-dfu
    • test-sdk-find-my
    • test-sdk-mcuboot
    • test-sdk-pmic-samples
    • test-sdk-wifi
    • test-secdom-samples-public

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

kapi-no added 4 commits March 25, 2025 09:28
Updated the Fast Pair integration guide to document changes in the FMDN
APIs that are used to track the provisioning state. The callback API -
bt_fast_pair_fmdn_info_cb.provisioning_state_changed - has been changed
and no longer reports the initial provisioning state after the Fast Pair
subsystem is enabled with the bt_fast_pair_enable API. Added the new
FMDN API - bt_fast_pair_fmdn_is_provisioned. The API can be used to
check the device provisioning state synchronously.

Ref: NCSDK-30856

Signed-off-by: Kamil Piszczek <Kamil.Piszczek@nordicsemi.no>
Added new content to the NCS v3.0 migration guide. The new
documentation describes how to align your Fast Pair application with
support for the Find My Device Network (FMDN) extension with the
recent changes to the FMDN API elements that are used to track the
FMDN provisioning state.

Ref: NCSDK-30856

Signed-off-by: Kamil Piszczek <Kamil.Piszczek@nordicsemi.no>
Updated the release changelog to describe the changes to the FMDN API
elements that are used to track the Find My Device Network (FMDN)
provisioning state.

Described the addition of the new FMDN API:
bt_fast_pair_fmdn_is_provisioned. The API can be used to check the
device provisioning state synchronously.

Described the change in the behavior of the
bt_fast_pair_fmdn_info_cb.provisioning_state_changed callback.
The callback no longer reports the initial provisioning state after
the Fast Pair subsystem is enabled with the bt_fast_pair_enable API.

Ref: NCSDK-30856

Signed-off-by: Kamil Piszczek <Kamil.Piszczek@nordicsemi.no>
Updated the release changelog to remove the duplicated sections for the
Fast Pair library changelog.

Signed-off-by: Kamil Piszczek <Kamil.Piszczek@nordicsemi.no>
@kapi-no kapi-no force-pushed the fast_pair_fmdn_is_provisioned_api_doc branch from bb0a253 to c56a744 Compare March 25, 2025 08:29
@kapi-no kapi-no requested a review from divipillai March 25, 2025 08:29
@kapi-no kapi-no merged commit 2a782f4 into nrfconnect:main Mar 25, 2025
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc only doc-required PR must not be merged without tech writer approval.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants