Skip to content

Commit b77f7b1

Browse files
nordic-haninordic-hani
committed
add changelog and update metadata
Added the changelog from previous location and updated it for 2.8.0. Signed-off-by: Håvard Vermeer <havard.vermeer@nordicsemi.no>
1 parent 98d80df commit b77f7b1

File tree

4 files changed

+187
-2
lines changed

4 files changed

+187
-2
lines changed

‎README.md

+41-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,41 @@
1-
# sdk-softbank-fota
2-
NCS Softbank FOTA add-on
1+
# Softbank FOTA add-on for nRF Connect SDK
2+
3+
<a href="https://github.com/nrfconnect/sdk-softbank-fota/actions/workflows/build-using-docker.yml?query=branch%3Amain">
4+
<img src="https://github.com/nrfconnect/sdk-softbank-fota/actions/workflows/build-using-docker.yml/badge.svg?event=push">
5+
</a>
6+
<a href="https://github.com/nrfconnect/ncs-example-application/actions/workflows/docs.yml?query=branch%3Amain">
7+
<img src="https://github.com/nrfconnect/ncs-example-application/actions/workflows/docs.yml/badge.svg?event=push">
8+
</a>
9+
<a href="https://nrfconnect.github.io/sdk-softbank-fota">
10+
<img alt="Documentation" src="https://img.shields.io/badge/documentation-3D578C?logo=sphinx&logoColor=white">
11+
</a>
12+
<a href="https://nrfconnect.github.io/sdk-softbank-fota/doxygen">
13+
<img alt="API Documentation" src="https://img.shields.io/badge/API-documentation-3D578C?logo=c&logoColor=white">
14+
</a>
15+
16+
This repository contains the Softbank FOTA [add-on for NCS](https://nrfconnect.github.io/ncs-app-index/).
17+
18+
## Documentation
19+
20+
Pre-build documentation is available [here](https://nrfconnect.github.io/sdk-softbank-fota).
21+
22+
A minimal documentation setup is provided for Sphinx. To build the
23+
documentation first change to the ``docs`` folder:
24+
25+
```shell
26+
cd docs
27+
```
28+
To install Sphinx, make sure you have a Python installation in place and run:
29+
30+
```shell
31+
pip install -r requirements.txt
32+
```
33+
34+
The Sphinx documentation (HTML) can be built using the following command:
35+
36+
```shell
37+
make html
38+
```
39+
40+
The output will be stored in the ``_build_sphinx`` folder. You may check for
41+
other output formats other than HTML by running ``make help``.

‎doc/CHANGELOG.rst

+144
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,144 @@
1+
.. _libsb_fota_changelog:
2+
3+
Changelog
4+
#########
5+
6+
FOTA library and sample applications for SoftBank.
7+
All notable changes to this project are documented in this file.
8+
9+
Version 2.8.0
10+
*************
11+
12+
Changes
13+
=======
14+
* SDK: ported to |NCS| v2.8.0
15+
* There are now two versions of the binary: default (``CONFIG_SB_FOTA``) and verbose (``CONFIG_SB_FOTA_LOG``).
16+
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
27+
28+
Supported modem firmware
29+
************************
30+
* mfw_nrf9160_1.3.7
31+
* mfw_nrf9160_2.0.2
32+
* mfw_nrf9160_2.0.3
33+
34+
Version 2.7.0
35+
*************
36+
37+
Changes
38+
=======
39+
* SDK: ported to |NCS| 2.7.0
40+
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
49+
50+
Version 2.6.0
51+
*************
52+
53+
Changes
54+
=======
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
59+
60+
Version 2.6-pre-release
61+
***********************
62+
63+
Changes
64+
=======
65+
* SDK: ported to |NCS| 2.6.0
66+
67+
Supported SDK version
68+
*********************
69+
* nRF Connect SDK v2.6.0
70+
71+
Supported modem firmware
72+
========================
73+
* mfw_nrf9160_1.3.5
74+
* mfw_nrf9160_1.3.6
75+
76+
Version 2.0-pre-release
77+
***********************
78+
79+
Changes
80+
=======
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
98+
99+
Version 1.1
100+
***********
101+
102+
Changes
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 IP address instead of FQDN hostname
107+
108+
APN configuration
109+
=================
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
125+
126+
127+
Version 1.0
128+
***********
129+
130+
Changes
131+
=======
132+
* First release that is used to complete SBM IOT certification test
133+
134+
Supported SDK version
135+
=====================
136+
* |NCS| v1.3.0
137+
138+
Supported modem firmware
139+
========================
140+
* mfw_nrf9160_1.2.2
141+
142+
Supported REST API Host
143+
=======================
144+
* https://api.beta.nrfcloud.com/v1

‎doc/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ In addition to the library itself, this NCS add-on contains a :ref:`sample <sb_f
2929
integration
3030
sample
3131
API_documentation
32+
CHANGELOG
3233

3334
Indices and tables
3435
==================

‎doc/sample.rst

+1
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@ After programming the sample and all prerequisites to the development kit, test
9090
<inf> sb_fota: Next update check in 14 days, 09:20:10
9191

9292
#. Use ``sb_fota_clock_set()`` to set the modem time to trick the update to happen. (Or wait simply wait ~14 days).
93+
9394
For example, if ``AT+CCLK`` returns ``25/03/04,01:30:40+4``, then use ``app clock`` shell command to set the clock::
9495

9596
uart:~$ app clock 25/03/18,10:50:40+4

0 commit comments

Comments
 (0)