Skip to content

Commit 12a1c1c

Browse files
divipillainordic-hani
divipillai
authored and
nordic-hani
committed
doc: SoftBank FOTA doc updates
Updates to SoftBank FOTA documentation. Signed-off-by: divya pillai <divya.pillai@nordicsemi.no>
1 parent 80ed815 commit 12a1c1c

10 files changed

+156
-166
lines changed

‎doc/API_documentation.rst

+9-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _liblwm2m_api:
1+
.. _sb_fota_api:
22

33
API documentation
44
#################
@@ -13,15 +13,21 @@ Following are the API elements used by the SoftBank FOTA library:
1313
| Source files: :file:`lib/bin/sb_fota`
1414
1515
SoftBank FOTA library API
16-
=========================
16+
*************************
1717

1818
.. doxygengroup:: sb_fota
1919
:members:
2020

2121
.. _sb_fota_os:
2222

2323
SoftBank FOTA OS layer
24-
======================
24+
**********************
2525

2626
.. doxygengroup:: sb_fota_os
2727
:members:
28+
29+
Softbank FOTA build-time settings
30+
*********************************
31+
32+
.. doxygengroup:: sb_fota_settings
33+
:members:

‎doc/CHANGELOG.rst

+60-84
Original file line numberDiff line numberDiff line change
@@ -1,144 +1,120 @@
1-
.. _libsb_fota_changelog:
1+
.. _sb_fota_changelog:
22

33
Changelog
44
#########
55

66
FOTA library and sample applications for SoftBank.
77
All notable changes to this project are documented in this file.
88

9+
For a full list of Softbank FOTA add-on releases, related nRF Connect SDK, modem firmware versions, and supported REST API host, view the following table:
10+
11+
+-------------------+------------------+--------------------------+------------------------------------+
12+
| |addon| version | |NCS| version | Modem firmware version | REST API host |
13+
+===================+==================+==========================+====================================+
14+
| 2.8.0 | 2.8.0 | * mfw_nrf9160_1.3.7 | |
15+
| | | * mfw_nrf9160_2.0.2 | |
16+
| | | * mfw_nrf9160_2.0.3 | |
17+
+-------------------+------------------+--------------------------+------------------------------------+
18+
| 2.7.0 | 2.7.0 | * mfw_nrf9160_1.3.5 | |
19+
| | | * mfw_nrf9160_1.3.6 | |
20+
+-------------------+------------------+--------------------------+------------------------------------+
21+
| 2.6.0 | 2.6.0 | * mfw_nrf9160_1.3.5 | |
22+
| | | * mfw_nrf9160_1.3.6 | |
23+
+-------------------+------------------+--------------------------+------------------------------------+
24+
| 2.0.0 | 2.0.0 | * mfw_nrf9160_1.3.1 | |
25+
+-------------------+------------------+--------------------------+------------------------------------+
26+
| 1.1.0 | 1.4.0 | * mfw_nrf9160_1.2.2 | * https://api.nrfcloud.com/v1 |
27+
| | | * mfw_nrf9160_1.2.3 | |
28+
+-------------------+------------------+--------------------------+------------------------------------+
29+
| 1.0.0 | 1.3.0 | * mfw_nrf9160_1.2.2 | * https://api.beta.nrfcloud.com/v1 |
30+
+-------------------+------------------+--------------------------+------------------------------------+
31+
932
Version 2.8.0
1033
*************
1134

1235
Changes
1336
=======
37+
1438
* SDK: ported to |NCS| v2.8.0
1539
* There are now two versions of the binary: default (``CONFIG_SB_FOTA``) and verbose (``CONFIG_SB_FOTA_LOG``).
1640

17-
* Logs are no longer compiled into the default library. This saves some memory.
18-
* The verbose library can be used during development phase to ensure that the library is integrated correctly into your application.
19-
20-
* More consistent use of ``SoftBank FOTA`` (as opposed to modem FOTA). Renamed events such as ``FOTA_EVENT_DOWNLOADING`` -> ``SB_FOTA_EVENT_DOWNLOADING``
21-
* The library now schedules work on it's internal queue instead of the syswork queue (this avoids potential blocking of the syswork queue).
22-
* Removed ``SB_FOTA_EVENT_REBOOT_PENDING``. Reboot is not needed to apply modem update.
23-
24-
Supported SDK version
25-
=====================
26-
* |NCS| v2.8.0
41+
* Logs are no longer compiled into the default library.
42+
This saves some memory.
43+
* The verbose library can be used during the development phase to ensure that the library is integrated correctly into your application.
2744

28-
Supported modem firmware
29-
************************
30-
* mfw_nrf9160_1.3.7
31-
* mfw_nrf9160_2.0.2
32-
* mfw_nrf9160_2.0.3
45+
* More consistent use of ``SoftBank FOTA`` (as opposed to modem FOTA).
46+
Renamed events such as ``FOTA_EVENT_DOWNLOADING`` to ``SB_FOTA_EVENT_DOWNLOADING``
47+
* The library now schedules work on its internal queue instead of the syswork queue (this avoids potential blocking of the syswork queue).
48+
* Removed ``SB_FOTA_EVENT_REBOOT_PENDING``.
49+
Reboot is not needed to apply the modem update.
50+
* Removed the dependency on the `LTE Link Control`_ library.
51+
This makes it simpler to integrate the SoftBank FOTA library into applications that do not use the Link Controller library by default, such as the `Serial LTE modem`_ application.
3352

3453
Version 2.7.0
3554
*************
3655

3756
Changes
3857
=======
39-
* SDK: ported to |NCS| 2.7.0
4058

41-
Supported SDK version
42-
=====================
43-
* nRF Connect SDK v2.7.0
44-
45-
Supported modem firmware
46-
************************
47-
* mfw_nrf9160_1.3.5
48-
* mfw_nrf9160_1.3.6
59+
* SDK: ported to |NCS| 2.7.0.
4960

5061
Version 2.6.0
5162
*************
5263

5364
Changes
5465
=======
55-
* Fix potential segfault on settings handling
56-
* Allow updating modem FW without reboot
57-
* Fix Kconfig menu name
58-
* Fix CME error when reading disabled APNs
66+
67+
* Allow updating modem firmware without reboot.
68+
* Fix potential segfault on settings handling.
69+
* Fix Kconfig menu name.
70+
* Fix CME error when reading disabled APNs.
5971

6072
Version 2.6-pre-release
6173
***********************
6274

6375
Changes
6476
=======
65-
* SDK: ported to |NCS| 2.6.0
66-
67-
Supported SDK version
68-
*********************
69-
* nRF Connect SDK v2.6.0
7077

71-
Supported modem firmware
72-
========================
73-
* mfw_nrf9160_1.3.5
74-
* mfw_nrf9160_1.3.6
78+
* SDK: ported to |NCS| 2.6.0.
7579

7680
Version 2.0-pre-release
7781
***********************
7882

7983
Changes
8084
=======
81-
* SDK: ported to nRF Connect SDK 2.0
82-
* Limit FOTA to devices attached to SoftBank home network only
83-
* Cloud: Update nRF Cloud endpoint to current REST API
84-
* Cloud: Use JWT tokens to authenticate. Requires provisioning. Requires modem FW 1.3.
85-
* SDK: Add glue layer to SDK porting
86-
* Allow library to autoinit
87-
* Apply the modem update before rebooting
88-
* Rename MODEM_FOTA to SB_FOTA
89-
* Refactor application events
90-
91-
Supported SDK version
92-
=====================
93-
* |NCS| v2.0.0
94-
95-
Supported modem firmware
96-
========================
97-
* mfw_nrf9160_1.3.1
85+
86+
* SDK: ported to |NCS| v2.0.0.
87+
* Limit FOTA to devices attached to the SoftBank home network only.
88+
* Add a glue layer to SDK porting.
89+
* Allow library to auto-init.
90+
* Apply the modem update before rebooting.
91+
* Rename ``MODEM_FOTA`` to ``SB_FOTA``.
92+
* Refactor application events.
93+
* Cloud: Update nRF Cloud endpoint to current REST API.
94+
* Cloud: Use JWT tokens to authenticate.
95+
Requires provisioning.
96+
Requires modem firmware v1.3.
9897

9998
Version 1.1
10099
***********
101100

102101
Changes
103102
=======
104-
* SDK: Ported to |NCS| v1.4.0
105-
* Cloud: Adapted to commercial FOTA server in nRF Connect for Cloud
106-
* FOTA Server is assigned with IP address instead of FQDN hostname
103+
104+
* SDK: Ported to |NCS| v1.4.0.
105+
* Cloud: Adapted to commercial FOTA server in nRF Connect for Cloud.
106+
* FOTA server is assigned with an IP address instead of an FQDN hostname.
107107

108108
APN configuration
109109
=================
110-
Same as 1.0
111-
112-
Supported SDK version
113-
=====================
114-
* |NCS| v1.4.0
115-
116-
Supported modem firmware
117-
========================
118-
119-
* mfw_nrf9160_1.2.2
120-
* mfw_nrf9160_1.2.3
121-
122-
Supported REST API Host
123-
=======================
124-
* https://api.nrfcloud.com/v1
125110

111+
Same as v1.0
126112

127113
Version 1.0
128114
***********
129115

130116
Changes
131117
=======
132-
* First release that is used to complete SBM IOT certification test
133-
134-
Supported SDK version
135-
=====================
136-
* |NCS| v1.3.0
137118

138-
Supported modem firmware
139-
========================
140-
* mfw_nrf9160_1.2.2
119+
* First release that is used to complete SBM IOT certification test.
141120

142-
Supported REST API Host
143-
=======================
144-
* https://api.beta.nrfcloud.com/v1

‎doc/conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
project = 'Softbank FOTA'
1313
copyright = '2025, Nordic Semiconductor'
1414
author = 'Nordic Semiconductor'
15-
release = '0.0.1'
15+
release = '2.8.0'
1616

1717
# Paths
1818

‎doc/index.rst

+7-14
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,17 @@
77
:local:
88
:depth: 2
99

10-
Welcome to the SoftBank FOTA library NCS Add-on.
11-
The SoftBank FOTA library is a binary library that will periodically check `nRF Connect for Cloud`_ for modem firmware updates.
12-
If there is an applicable update, the SoftBank FOTA library will download and install it.
13-
14-
In addition to the library itself, this NCS add-on contains a :ref:`sample <sb_fota_sample>` for testing, and instructions for correctly :ref:`provisioning with nRF Cloud <libsb_fota_provisioning>`.
10+
SoftBank FOTA library is a binary library that has been developed as an |NCS| add-on.
11+
This library periodically checks `nRF Connect for Cloud`_ for modem firmware updates.
12+
If there is an applicable update, the SoftBank FOTA library downloads and installs it.
1513

14+
In addition to the library itself, this |NCS| add-on contains a :ref:`sample <sb_fota_sample>` for testing and instructions for correctly :ref:`provisioning with nRF Cloud <libsb_fota_provisioning>`.
1615

1716
.. note::
18-
This library is not intended to be a general purpose FOTA library.
19-
17+
This library is not intended to be a general-purpose FOTA library.
2018

2119
.. important::
22-
To conform with the SoftBank certification, this library **must** be integrated with your application, unless otherwise agreed with your local Nordic or SoftBank representatives.
20+
To conform with the SoftBank certification, this library must be integrated with your application, unless agreed upon with your local Nordic or SoftBank representatives.
2321

2422
.. toctree::
2523
:maxdepth: 1
@@ -30,9 +28,4 @@ In addition to the library itself, this NCS add-on contains a :ref:`sample <sb_f
3028
sample
3129
API_documentation
3230
CHANGELOG
33-
34-
Indices and tables
35-
==================
36-
37-
* :ref:`genindex`
38-
* :ref:`search`
31+
genindex

0 commit comments

Comments
 (0)