Skip to content

Commit 8ec1b21

Browse files
divipillaicarlescufi
authored andcommitted
doc: Reorganize the Google Fast Pair docs
Reorganize the Google Fast Pair integration and libray docs. NCSDK-34559 Signed-off-by: divya pillai <[email protected]>
1 parent f36a64d commit 8ec1b21

File tree

10 files changed

+51
-45
lines changed

10 files changed

+51
-45
lines changed

CODEOWNERS

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,6 @@
103103
/doc/nrf/drivers/wifi.rst @nrfconnect/ncs-wifi-doc
104104
/doc/nrf/drivers/uart_nrf_sw_lpuart.rst @nrfconnect/ncs-doc-leads
105105
/doc/nrf/external_comp/avsystem.rst @nrfconnect/ncs-iot-oulu-tampere-doc
106-
/doc/nrf/external_comp/bt_fast_pair.rst @nrfconnect/ncs-si-bluebagel-doc
107106
/doc/nrf/external_comp/bt_fast_pair/ @nrfconnect/ncs-si-bluebagel-doc
108107
/doc/nrf/external_comp/coremark.rst @nrfconnect/ncs-si-bluebagel-doc
109108
/doc/nrf/external_comp/dult.rst @nrfconnect/ncs-si-bluebagel-doc
@@ -121,7 +120,6 @@
121120
/doc/nrf/libraries/bluetooth/adv_prov.rst @nrfconnect/ncs-si-bluebagel-doc
122121
/doc/nrf/libraries/bluetooth/mesh.rst @nrfconnect/ncs-paladin-doc
123122
/doc/nrf/libraries/bluetooth/services/fast_pair/ @nrfconnect/ncs-si-bluebagel-doc
124-
/doc/nrf/libraries/bluetooth/services/fast_pair.rst @nrfconnect/ncs-si-bluebagel-doc
125123
/doc/nrf/libraries/bluetooth/services/wifi_prov_ble.rst @nrfconnect/ncs-wifi-doc
126124
/doc/nrf/libraries/caf/ @nrfconnect/ncs-si-muffin-doc @nrfconnect/ncs-si-bluebagel-doc
127125
/doc/nrf/libraries/debug/cpu_load.rst @nrfconnect/ncs-doc-leads

doc/_utils/redirects.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -527,7 +527,8 @@
527527
("libraries/bluetooth_services/services/cts_client", "libraries/bluetooth/services/cts_client"),
528528
("libraries/bluetooth_services/services/ddfs", "libraries/bluetooth/services/ddfs"),
529529
("libraries/bluetooth_services/services/dfu_smp", "libraries/bluetooth/services/dfu_smp"),
530-
("libraries/bluetooth_services/services/fast_pair", "libraries/bluetooth/services/fast_pair"),
530+
("libraries/bluetooth_services/services/fast_pair", "libraries/bluetooth/services/fast_pair/core"),
531+
("libraries/bluetooth/services/fast_pair", "libraries/bluetooth/services/fast_pair/core"),
531532
("libraries/bluetooth_services/services/gattp", "libraries/bluetooth/services/gattp"),
532533
("libraries/bluetooth_services/services/hids", "libraries/bluetooth/services/hids"),
533534
("libraries/bluetooth_services/services/hogp", "libraries/bluetooth/services/hogp"),
@@ -564,7 +565,8 @@
564565
("libraries/others/hw_unique_key", "libraries/security/hw_unique_key"), # Hardware unique key
565566
("libraries/others/identity_key", "libraries/security/identity_key"), # Identity key
566567
("ecosystems_integrations", "integrations"), # Integrations (landing)
567-
("ug_bt_fast_pair", "external_comp/bt_fast_pair"), # Google Fast Pair integration
568+
("ug_bt_fast_pair", "external_comp/bt_fast_pair/index"), # Google Fast Pair integration
569+
("external_comp/bt_fast_pair", "external_comp/bt_fast_pair/index"),
568570
("ug_edge_impulse", "external_comp/edge_impulse"), # Edge Impulse integration
569571
("ug_memfault", "external_comp/memfault"), # Memfault integration
570572
("ug_nrf_cloud", "external_comp/nrf_cloud"), # Using nRF Cloud with the nRF Connect SDK

doc/_zoomin/ncs.tags.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -397,7 +397,7 @@ mapping_topics:
397397
- nrf/libraries/others/esb.html: ["esb"]
398398
- nrf/libraries/others/fem_al.html: ["fem", "nrf21540"]
399399
- nrf/libraries/others/st25r3911b_nfc.html: ["nfc"]
400-
- nrf/external_comp/bt_fast_pair.html: ["ble"]
400+
- nrf/external_comp/bt_fast_pair/*.html: ["ble"]
401401
- nrf/external_comp/nrf_cloud.html: ["nrf-cloud"]
402402
- nrf/external_comp/avsystem.html: ["lte"]
403403
- nrf/releases_and_maturity/release_notes.html: ["release-notes"]

doc/nrf/external_comp/bt_fast_pair/adv_manager.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ This page provides guidelines on how to integrate this module in your applicatio
1212

1313
.. note::
1414
This page complements the main Fast Pair integration guide and covers only integration steps for the :ref:`bt_fast_pair_adv_manager_readme` module.
15-
For the complete Fast Pair integration guide, see :ref:`ug_bt_fast_pair`.
15+
For the complete Fast Pair integration guide, see :ref:`Google Fast Pair integration <ug_bt_fast_pair_integration>`.
1616

1717
Prerequisites
1818
*************
1919

2020
Before using the :ref:`bt_fast_pair_adv_manager_readme`, ensure to fulfill the following prerequisites:
2121

22-
* Read through the main :ref:`ug_bt_fast_pair` guide to understand the overall Fast Pair integration requirements and ensure you meet all the prerequisites listed in this document.
22+
* Read through the main :ref:`Google Fast Pair integration <ug_bt_fast_pair_integration>` guide to understand the overall Fast Pair integration requirements and ensure you meet all the prerequisites listed in this document.
2323
* Accept the usage of the Bluetooth® LE Extended Advertising feature (:kconfig:option:`CONFIG_BT_EXT_ADV`), which is a dependency for the :ref:`bt_fast_pair_adv_manager_readme` module.
2424

2525
.. note::

doc/nrf/external_comp/bt_fast_pair.rst renamed to doc/nrf/external_comp/bt_fast_pair/core.rst

Lines changed: 5 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,14 @@
1-
.. _ug_bt_fast_pair:
1+
.. _ug_bt_fast_pair_integration:
22

3-
Google Fast Pair integration
4-
############################
3+
Integration overview
4+
####################
55

66
.. contents::
77
:local:
88
:depth: 2
99

10-
Google Fast Pair is a standard for pairing *Bluetooth®* and Bluetooth Low Energy (LE) devices with as little user interaction required as possible.
11-
Google also provides additional features built upon the Fast Pair standard.
12-
For detailed information about supported functionalities, see the official `Fast Pair`_ documentation.
1310

14-
.. note::
15-
The software maturity level for the Fast Pair support in the |NCS| is indicated at the use case level in the :ref:`Google Fast Pair use case support <software_maturity_fast_pair_use_case>` table and at the feature level in the :ref:`Google Fast Pair feature support <software_maturity_fast_pair_feature>` table.
11+
The |NCS| integrates the Fast Pair Provider role, facilitating communication between the Fast Pair Seeker (typically a smartphone) and the Provider (your device).
1612

1713
Integration prerequisites
1814
*************************
@@ -31,7 +27,6 @@ Before you start the |NCS| integration with Fast Pair, make sure that the follow
3127
Solution architecture
3228
*********************
3329

34-
The |NCS| integrates the Fast Pair Provider role, facilitating communication between the Fast Pair Seeker (typically a smartphone) and the Provider (your device).
3530
The integration involves following the instructions outlined in the :ref:`ug_integrating_fast_pair` section.
3631
The SDK supports extensions such as Battery Notification and Personalized Name, which can be included based on the specific use case requirements.
3732

@@ -70,7 +65,7 @@ For more details on this extension, see the `Fast Pair Personalized Name extensi
7065
FMDN extension
7166
==============
7267

73-
The FMDN extension leverages the Find My Device network, which is a crowdsourced network consisting of millions of Android devices that use Bluetooth LE to detect missing devices and report their approximate locations back to their owners.
68+
The FMDN extension leverages the Find My Device network, which is a crowdsourced network consisting of millions of Android devices that use Bluetooth® LE to detect missing devices and report their approximate locations back to their owners.
7469
The entire process is end-to-end encrypted and anonymous, so no one else (including Google) can view device's location or information.
7570
The Find My Device network also includes features protecting the user against unwanted tracking.
7671

@@ -104,20 +99,6 @@ The FMDN Accessory specification integrates the Detecting Unwanted Location Trac
10499
Relevant FMDN sections of this guide describe the DULT integration with the FMDN extension.
105100
For more details on the DULT integration guidelines, see the `Fast Pair Unwanted Tracking Prevention Guidelines`_ documentation.
106101

107-
Integration guides for helper modules
108-
*************************************
109-
110-
This integration guide includes additional pages that discuss the Fast Pair helper modules.
111-
While these helper modules can provide additional functionality in your application, they are not strictly required for the Fast Pair integration.
112-
Each helper module is described on a dedicated page.
113-
114-
.. toctree::
115-
:maxdepth: 1
116-
:caption: Integration guides for helper modules:
117-
:glob:
118-
119-
bt_fast_pair/*
120-
121102
.. _ug_integrating_fast_pair:
122103

123104
Integration steps
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
.. _ug_bt_fast_pair:
2+
3+
Google Fast Pair integration
4+
############################
5+
6+
Google Fast Pair is a standard for pairing *Bluetooth®* and Bluetooth Low Energy (LE) devices with as little user interaction required as possible.
7+
Google also provides additional features built upon the Fast Pair standard.
8+
For detailed information about supported functionalities, see the official `Fast Pair`_ documentation.
9+
10+
.. note::
11+
The software maturity level for the Fast Pair support in the |NCS| is indicated at the use case level in the :ref:`Google Fast Pair use case support <software_maturity_fast_pair_use_case>` table and at the feature level in the :ref:`Google Fast Pair feature support <software_maturity_fast_pair_feature>` table.
12+
13+
The subpages include the :ref:`main integration guide <ug_bt_fast_pair_integration>` and an additional page that discusses the :ref:`Advertising Manager helper module <ug_bt_fast_pair_adv_manager>`.
14+
While this helper module can provide additional functionality in your application, it is not strictly required for the Fast Pair integration.
15+
16+
.. toctree::
17+
:maxdepth: 1
18+
:glob:
19+
20+
core
21+
adv_manager

doc/nrf/integrations.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The following user guides describe available integrations:
2121
:maxdepth: 1
2222
:caption: Subpages:
2323

24-
external_comp/bt_fast_pair
24+
external_comp/bt_fast_pair/index
2525
external_comp/edge_impulse
2626
external_comp/memfault
2727
external_comp/avsystem

doc/nrf/libraries/bluetooth/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,5 @@ Bluetooth libraries and services
1616
:caption: Bluetooth® services:
1717
:glob:
1818

19+
services/fast_pair/index
1920
services/*

doc/nrf/libraries/bluetooth/services/fast_pair.rst renamed to doc/nrf/libraries/bluetooth/services/fast_pair/core.rst

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,6 @@ Google Fast Pair Service (GFPS)
99

1010
The Google Fast Pair Service (Fast Pair for short) implements a Bluetooth® Low Energy (LE) GATT Service required for :ref:`ug_bt_fast_pair` with the |NCS|.
1111

12-
Helper modules
13-
**************
14-
15-
The Fast Pair service includes helper modules that may provide additional functionality during the implementation of the Fast Pair application.
16-
Each helper module is described in a dedicated subpage.
17-
18-
.. toctree::
19-
:maxdepth: 1
20-
:caption: Helper modules:
21-
:glob:
22-
23-
fast_pair/*
24-
2512
Service UUID
2613
************
2714

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.. _lib_bt_fast_pair:
2+
3+
Google Fast Pair libraries
4+
##########################
5+
6+
The Google Fast Pair Service (Fast Pair for short) implements a Bluetooth® Low Energy (LE) GATT Service required for :ref:`ug_bt_fast_pair` with the |NCS|.
7+
8+
The subpages include the :ref:`main library <bt_fast_pair_readme>` documentation and an additional page that discusses the :ref:`Advertising Manager helper module <bt_fast_pair_adv_manager_readme>`.
9+
The helper module provides additional functionality during the implementation of the Fast Pair application.
10+
11+
.. toctree::
12+
:maxdepth: 1
13+
:glob:
14+
15+
core
16+
adv_manager

0 commit comments

Comments
 (0)