Skip to content

Commit 1fef2d4

Browse files
b-genteivindj-nordic
authored andcommitted
doc: update BM doc for 0.9.0
Release notes and other release-related doc updates. Signed-off-by: Bartosz Gentkowski <[email protected]>
1 parent e881d9d commit 1fef2d4

File tree

18 files changed

+334
-136
lines changed

18 files changed

+334
-136
lines changed

doc/nrf-bm/api/api.rst

Lines changed: 68 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -12,110 +12,125 @@ API documentation
1212
Libraries
1313
*********
1414

15-
Bluetooth LE Connection Parameter library
16-
=========================================
17-
18-
.. doxygengroup:: ble_conn_params
19-
:inner:
20-
21-
Bluetooth LE MCUmgr Service library
22-
===================================
23-
24-
.. doxygengroup:: ble_mcumgr
25-
:inner:
26-
27-
Bluetooth LE Nordic UART Service library
28-
========================================
29-
30-
.. doxygengroup:: ble_nus
31-
:inner:
32-
33-
Bluetooth LE advertising library
15+
Bluetooth LE Advertising library
3416
================================
3517

3618
.. doxygengroup:: ble_adv
3719
:inner:
20+
:members:
3821

3922
Advertising and Scan Response Data Encoder
4023
------------------------------------------
4124

4225
.. doxygengroup:: ble_sdk_lib_advdata
4326
:inner:
27+
:members:
4428

45-
.. _api_peer_manager:
29+
.. _api_ble_conn_params:
4630

47-
Peer Manager
48-
============
31+
Bluetooth LE Connection Parameter library
32+
=========================================
4933

50-
.. doxygengroup:: peer_manager
34+
.. doxygengroup:: ble_conn_params
5135
:inner:
5236
:members:
5337

54-
Bare Metal Zephyr Memory Storage (ZMS)
55-
======================================
38+
.. _api_ble_conn_state:
5639

57-
.. doxygengroup:: bm_zms
40+
Bluetooth LE Connection State library
41+
=====================================
42+
43+
.. doxygengroup:: ble_conn_state
5844
:inner:
45+
:members:
5946

6047
Bare Metal Buttons library
6148
==========================
6249

6350
.. doxygengroup:: bm_buttons
6451
:inner:
52+
:members:
53+
54+
Bare Metal Event Scheduler library
55+
==================================
56+
57+
.. doxygengroup:: event_scheduler
58+
:inner:
59+
:members:
60+
61+
Bare Metal Low Power UART with EasyDMA driver
62+
=============================================
63+
64+
.. doxygengroup:: bm_lpuarte
65+
:inner:
66+
:members:
6567

6668
Bare Metal Storage library
6769
==========================
6870

6971
.. doxygengroup:: bm_storage
7072
:inner:
73+
:members:
7174

7275
Bare Metal Storage library backend
7376
----------------------------------
7477

7578
.. doxygengroup:: bm_storage_backend
7679
:inner:
80+
:members:
7781

7882
Bare Metal Timer library
7983
========================
8084

8185
.. doxygengroup:: bm_timer
8286
:inner:
87+
:members:
8388

84-
Bare Metal Low Power UART with EasyDMA driver
85-
=============================================
89+
.. _api_ble_bm_zms:
8690

87-
.. doxygengroup:: bm_lpuarte
91+
Bare Metal Zephyr Memory Storage (ZMS)
92+
======================================
93+
94+
.. doxygengroup:: bm_zms
8895
:inner:
96+
:members:
8997

90-
Bare Metal Event Scheduler library
91-
==================================
98+
GATT Queue
99+
==========
92100

93-
.. doxygengroup:: event_scheduler
101+
.. doxygengroup:: ble_gq
94102
:inner:
103+
:members:
95104

96-
Queued Writes module
105+
.. _api_peer_manager:
106+
107+
Peer Manager library
97108
====================
98109

99-
.. doxygengroup:: ble_qwr
110+
.. doxygengroup:: peer_manager
100111
:inner:
112+
:members:
101113

102-
Sensor data simulator library
103-
=============================
114+
Queued Writes module
115+
====================
104116

105-
.. doxygengroup:: sensorsim
117+
.. doxygengroup:: ble_qwr
106118
:inner:
119+
:members:
107120

108121
Record Access Control Point
109122
===========================
110123

111124
.. doxygengroup:: ble_racp
112125
:inner:
126+
:members:
113127

114-
GATT Queue
115-
==========
128+
Sensor data simulator library
129+
=============================
116130

117-
.. doxygengroup:: ble_gq
131+
.. doxygengroup:: sensorsim
118132
:inner:
133+
:members:
119134

120135
Services
121136
********
@@ -174,21 +189,21 @@ LED Button Service
174189
:inner:
175190
:members:
176191

177-
.. _api_ble_nus:
192+
.. _api_mcu_manager_service:
178193

179-
Nordic UART Service (NUS)
180-
=========================
194+
MCU manager Service (MCUmgr)
195+
============================
181196

182-
.. doxygengroup:: ble_nus
197+
.. doxygengroup:: ble_mcumgr
183198
:inner:
184199
:members:
185200

186-
.. _api_mcu_manager_service:
201+
.. _api_ble_nus:
187202

188-
MCU manager Service (MCUmgr)
189-
============================
203+
Nordic UART Service (NUS)
204+
=========================
190205

191-
.. doxygengroup:: ble_mcumgr
206+
.. doxygengroup:: ble_nus
192207
:inner:
193208
:members:
194209

@@ -197,6 +212,7 @@ SoftDevice Handler
197212

198213
.. doxygengroup:: nrf_sdh
199214
:inner:
215+
:members:
200216

201217
Utils
202218
*****
@@ -206,21 +222,25 @@ nRF Error Codes
206222

207223
.. doxygengroup:: nrf_error
208224
:inner:
225+
:members:
209226

210227
Service UUID definitions
211228
========================
212229

213230
.. doxygengroup:: UUID_SERVICES
214231
:inner:
232+
:members:
215233

216234
Characteristic UUID definitions
217235
===============================
218236

219237
.. doxygengroup:: UUID_CHARACTERISTICS
220238
:inner:
239+
:members:
221240

222241
Bluetooth LE Date Time characteristic type
223242
==========================================
224243

225244
.. doxygengroup:: ble_sdk_srv_date_time
226245
:inner:
246+
:members:

doc/nrf-bm/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
# -- Project information -----------------------------------------------------
1919

20-
project = 'nRF Connect SDK Bare Metal option - 0.8.99'
20+
project = 'nRF Connect SDK Bare Metal option - 0.9.0'
2121
copyright = '2025, Nordic Semiconductor'
2222
author = 'Nordic Semiconductor'
2323

doc/nrf-bm/includes/softdevice_flash.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,19 @@ To flash the S115 SoftDevice binary to your device:
1717

1818
.. code-block:: console
1919

20-
cd C:/ncs/nrf-bm/v0.8.0/nrf-bm
20+
cd C:/ncs/nrf-bm/v0.9.0/nrf-bm
2121

2222
.. group-tab:: Linux
2323

2424
.. code-block:: console
2525

26-
cd ~/ncs/nrf-bm/v0.8.0/nrf-bm
26+
cd ~/ncs/nrf-bm/v0.9.0/nrf-bm
2727

2828
.. group-tab:: macOS
2929

3030
.. code-block:: console
3131

32-
cd /opt/nordic/ncs/nrf-bm/v0.8.0/nrf-bm
32+
cd /opt/nordic/ncs/nrf-bm/v0.9.0/nrf-bm
3333

3434
#. Then, make sure that your device is erased:
3535

doc/nrf-bm/install_nrf_bm.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Every |BMlong| release consists of:
7373

7474
#. In the next page you will be prompted to **Select SDK type**, click :guilabel:`nRF Connect SDK Bare Metal`.
7575

76-
#. In the next page you will be prompted to **Select an SDK version (or enter the branch, tag or commit SHA) to install...**, click :guilabel:`v0.8.0` marked on the right by the label :guilabel:`Pre-packaged SDKs & Toolchains`.
76+
#. In the next page you will be prompted to **Select an SDK version (or enter the branch, tag or commit SHA) to install...**, click :guilabel:`v0.9.0` marked on the right by the label :guilabel:`Pre-packaged SDKs & Toolchains`.
7777

7878
#. In the next page you will be prompted to select a destination for the SDK. The default suggestion is recommended. Then press **Enter**.
7979
This will proceed by installing |BMshort| and the respective Toolchain it requires.
@@ -119,7 +119,7 @@ Every |BMlong| release consists of:
119119

120120
#. In the next page you will be prompted to **Select SDK type**, click :guilabel:`nRF Connect SDK Bare Metal`.
121121

122-
#. In the next page you will be prompted to **Select an SDK version (or enter the branch, tag or commit SHA) to install...**, click :guilabel:`v0.8.0` marked on the right by the label :guilabel:`GitHub`.
122+
#. In the next page you will be prompted to **Select an SDK version (or enter the branch, tag or commit SHA) to install...**, click :guilabel:`v0.9.0` marked on the right by the label :guilabel:`GitHub`.
123123

124124
#. In the next page you will be prompted to select a destination for the SDK. The default suggestion is recommended. Then press **Enter**.
125125
This will proceed by installing |BMshort|.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,4 +146,4 @@ API documentation
146146
| Header file: :file:`include/ble_conn_params.h`
147147
| Source files: :file:`lib/ble_conn_params/`
148148
149-
.. doxygengroup:: ble_conn_params
149+
:ref:`Bluetooth LE Connection Parameter library API reference <api_ble_conn_params>`

doc/nrf-bm/libraries/bluetooth/services/ble_dis.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _lib_ble_service_dis:
22

3-
Bluetooth: Device Information Service (DIS)
4-
###########################################
3+
Device Information Service (DIS)
4+
################################
55

66
.. contents::
77
:local:

doc/nrf-bm/libraries/bluetooth/services/ble_hids.rst

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _lib_ble_service_hids:
22

3-
Bluetooth: Human Interface Device Service (HIDS)
4-
################################################
3+
Human Interface Device Service (HIDS)
4+
#####################################
55

66
.. contents::
77
:local:
@@ -10,10 +10,14 @@ Bluetooth: Human Interface Device Service (HIDS)
1010
Overview
1111
********
1212

13-
This module implements the ``Human Interface Device Service`` with the corresponding set of characteristics.
14-
During initialization it adds the Human Interface Device Service and a set of characteristics as per the Human Interface Device Service specification and the user requirements to the BLE stack database.
13+
This module implements the Human Interface Device Service with the corresponding set of characteristics.
14+
During initialization, it adds the Human Interface Device Service and a set of characteristics as per the Human Interface Device Service specification and the user requirements to the Bluetooth LE stack database.
1515

16-
If enabled, notification of Input Report characteristics is performed when the application calls the corresponding ``ble_hids_xx_input_report_send()`` function.
16+
If enabled, notification of Input Report characteristics is performed when the application calls one of the corresponding functions:
17+
18+
* :c:func:`ble_hids_inp_rep_send`
19+
* :c:func:`ble_hids_boot_kb_inp_rep_send`
20+
* :c:func:`ble_hids_boot_mouse_inp_rep_send`
1721

1822
Configuration
1923
*************
@@ -50,7 +54,12 @@ For a full list of events see the :c:enum:`ble_hids_evt_type` enum.
5054
The application can send input reports by calling the :c:func:`ble_hids_inp_rep_send` function.
5155
Separate functions exist for sending boot keyboard and boot mouse input reports.
5256
See the :c:func:`ble_hids_boot_kb_inp_rep_send` and :c:func:`ble_hids_boot_mouse_inp_rep_send` functions, respectively.
53-
The application can get the current output reports by calling the :c:func:`ble_hids_outp_rep_send` function.
57+
The application can get the current output reports by calling the :c:func:`ble_hids_outp_rep_get` function.
58+
59+
Usage of this service is demonstrated in the following samples:
60+
61+
* :ref:`ble_hids_keyboard_sample`
62+
* :ref:`ble_hids_mouse_sample`
5463

5564
Dependencies
5665
************
@@ -66,4 +75,4 @@ API documentation
6675
| Header file: :file:`include/bluetooth/services/ble_hids.h`
6776
| Source files: :file:`subsys/bluetooth/services/ble_hids/`
6877
69-
:ref:`Human Interface Device Service (HIDS) API reference <api_human_interface_device_service>`
78+
:ref:`Human Interface Device Service (HIDS) API reference <api_human_interface_device_service>`

doc/nrf-bm/libraries/bluetooth/services/ble_mcumgr.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,9 @@ MCU manager Service (MCUmgr)
77
:local:
88
:depth: 2
99

10-
Overview
11-
********
12-
1310
The MCU manager service allows for remote management of the device over Bluetooth.
14-
This is based on the Simple Management Protocol (SMP) provided by `MCUmgr`_, an open source project that provides a management subsystem that is portable across multiple real-time operating systems.
11+
12+
It is based on the Simple Management Protocol (SMP) provided by `MCUmgr`_, an open source project that provides a management subsystem that is portable across multiple real-time operating systems.
1513

1614
Configuration
1715
*************

doc/nrf-bm/libraries/bm_zms.rst

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -339,11 +339,7 @@ Cache size
339339
API Reference
340340
*************
341341

342-
The BM_ZMS API is provided by the :file:`bm_zms.h`.
342+
| Header file: :file:`include/bm_zms.h`
343+
| Source files: :file:`lib/bm_zms/`
343344
344-
.. doxygengroup:: bm_zms_data_structures
345-
346-
.. doxygengroup:: bm_zms_high_level_api
347-
348-
.. comment
349-
not documenting .. doxygengroup:: bm_zms
345+
:ref:`Bare Metal Zephyr Memory Storage API reference <api_ble_bm_zms>`

doc/nrf-bm/libraries/index.rst

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,15 @@ Nordic Semiconductor provides a variety of libraries and services that are used
88
Here you can find documentation for these libraries, including API documentation.
99

1010
.. toctree::
11-
:maxdepth: 1
11+
:maxdepth: 2
1212
:glob:
13-
:caption: Subpages:
13+
:caption: Bluetooth® libraries and services:
1414

1515
bluetooth/index.rst
16+
17+
.. toctree::
18+
:maxdepth: 1
19+
:glob:
20+
:caption: Other libraries:
21+
1622
*

0 commit comments

Comments
 (0)