Skip to content

Commit 9536d88

Browse files
nordic-marenordic-hani
authored andcommitted
Various fixes and improvements to documentation
Also require a less ancient version of CMake to prevent a warning Signed-off-by: Markus Rekdal <markus.rekdal@nordicsemi.no>
1 parent b77f7b1 commit 9536d88

24 files changed

+135
-418
lines changed

.github/workflows/build-using-docker.yml

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Copyright (c) 2025, Nordic Semiconductor ASA
2+
# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
13
name: Build and test app in NCS docker container
24

35
on:
@@ -34,4 +36,3 @@ jobs:
3436
with:
3537
name: built-applications
3638
path: sb_fota/twister-out/**/zephyr/zephyr.hex
37-

.github/workflows/docs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Copyright (c) 2024, Nordic Semiconductor ASA
2-
# SPDX-License-Identifier: Apache-2.0
2+
# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
33

44
name: Documentation
55

CMakeLists.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Copyright (c) 2025 Nordic Semiconductor ASA
2-
# SPDX-License-Identifier: Apache-2.0
2+
# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
33
#
44
# This CMake file is picked by the Zephyr build system because it is defined
55
# as the module CMake entry point (see zephyr/module.yml).

Kconfig

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Copyright (c) 2025 Nordic Semiconductor ASA
2-
# SPDX-License-Identifier: Apache-2.0
2+
# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
33
#
44
# This Kconfig file is picked by the Zephyr build system because it is defined
55
# as the module Kconfig entry point (see zephyr/module.yml). You can browse

LICENSE

+40-201
Original file line numberDiff line numberDiff line change
@@ -1,201 +1,40 @@
1-
Apache License
2-
Version 2.0, January 2004
3-
http://www.apache.org/licenses/
4-
5-
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6-
7-
1. Definitions.
8-
9-
"License" shall mean the terms and conditions for use, reproduction,
10-
and distribution as defined by Sections 1 through 9 of this document.
11-
12-
"Licensor" shall mean the copyright owner or entity authorized by
13-
the copyright owner that is granting the License.
14-
15-
"Legal Entity" shall mean the union of the acting entity and all
16-
other entities that control, are controlled by, or are under common
17-
control with that entity. For the purposes of this definition,
18-
"control" means (i) the power, direct or indirect, to cause the
19-
direction or management of such entity, whether by contract or
20-
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21-
outstanding shares, or (iii) beneficial ownership of such entity.
22-
23-
"You" (or "Your") shall mean an individual or Legal Entity
24-
exercising permissions granted by this License.
25-
26-
"Source" form shall mean the preferred form for making modifications,
27-
including but not limited to software source code, documentation
28-
source, and configuration files.
29-
30-
"Object" form shall mean any form resulting from mechanical
31-
transformation or translation of a Source form, including but
32-
not limited to compiled object code, generated documentation,
33-
and conversions to other media types.
34-
35-
"Work" shall mean the work of authorship, whether in Source or
36-
Object form, made available under the License, as indicated by a
37-
copyright notice that is included in or attached to the work
38-
(an example is provided in the Appendix below).
39-
40-
"Derivative Works" shall mean any work, whether in Source or Object
41-
form, that is based on (or derived from) the Work and for which the
42-
editorial revisions, annotations, elaborations, or other modifications
43-
represent, as a whole, an original work of authorship. For the purposes
44-
of this License, Derivative Works shall not include works that remain
45-
separable from, or merely link (or bind by name) to the interfaces of,
46-
the Work and Derivative Works thereof.
47-
48-
"Contribution" shall mean any work of authorship, including
49-
the original version of the Work and any modifications or additions
50-
to that Work or Derivative Works thereof, that is intentionally
51-
submitted to Licensor for inclusion in the Work by the copyright owner
52-
or by an individual or Legal Entity authorized to submit on behalf of
53-
the copyright owner. For the purposes of this definition, "submitted"
54-
means any form of electronic, verbal, or written communication sent
55-
to the Licensor or its representatives, including but not limited to
56-
communication on electronic mailing lists, source code control systems,
57-
and issue tracking systems that are managed by, or on behalf of, the
58-
Licensor for the purpose of discussing and improving the Work, but
59-
excluding communication that is conspicuously marked or otherwise
60-
designated in writing by the copyright owner as "Not a Contribution."
61-
62-
"Contributor" shall mean Licensor and any individual or Legal Entity
63-
on behalf of whom a Contribution has been received by Licensor and
64-
subsequently incorporated within the Work.
65-
66-
2. Grant of Copyright License. Subject to the terms and conditions of
67-
this License, each Contributor hereby grants to You a perpetual,
68-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69-
copyright license to reproduce, prepare Derivative Works of,
70-
publicly display, publicly perform, sublicense, and distribute the
71-
Work and such Derivative Works in Source or Object form.
72-
73-
3. Grant of Patent License. Subject to the terms and conditions of
74-
this License, each Contributor hereby grants to You a perpetual,
75-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76-
(except as stated in this section) patent license to make, have made,
77-
use, offer to sell, sell, import, and otherwise transfer the Work,
78-
where such license applies only to those patent claims licensable
79-
by such Contributor that are necessarily infringed by their
80-
Contribution(s) alone or by combination of their Contribution(s)
81-
with the Work to which such Contribution(s) was submitted. If You
82-
institute patent litigation against any entity (including a
83-
cross-claim or counterclaim in a lawsuit) alleging that the Work
84-
or a Contribution incorporated within the Work constitutes direct
85-
or contributory patent infringement, then any patent licenses
86-
granted to You under this License for that Work shall terminate
87-
as of the date such litigation is filed.
88-
89-
4. Redistribution. You may reproduce and distribute copies of the
90-
Work or Derivative Works thereof in any medium, with or without
91-
modifications, and in Source or Object form, provided that You
92-
meet the following conditions:
93-
94-
(a) You must give any other recipients of the Work or
95-
Derivative Works a copy of this License; and
96-
97-
(b) You must cause any modified files to carry prominent notices
98-
stating that You changed the files; and
99-
100-
(c) You must retain, in the Source form of any Derivative Works
101-
that You distribute, all copyright, patent, trademark, and
102-
attribution notices from the Source form of the Work,
103-
excluding those notices that do not pertain to any part of
104-
the Derivative Works; and
105-
106-
(d) If the Work includes a "NOTICE" text file as part of its
107-
distribution, then any Derivative Works that You distribute must
108-
include a readable copy of the attribution notices contained
109-
within such NOTICE file, excluding those notices that do not
110-
pertain to any part of the Derivative Works, in at least one
111-
of the following places: within a NOTICE text file distributed
112-
as part of the Derivative Works; within the Source form or
113-
documentation, if provided along with the Derivative Works; or,
114-
within a display generated by the Derivative Works, if and
115-
wherever such third-party notices normally appear. The contents
116-
of the NOTICE file are for informational purposes only and
117-
do not modify the License. You may add Your own attribution
118-
notices within Derivative Works that You distribute, alongside
119-
or as an addendum to the NOTICE text from the Work, provided
120-
that such additional attribution notices cannot be construed
121-
as modifying the License.
122-
123-
You may add Your own copyright statement to Your modifications and
124-
may provide additional or different license terms and conditions
125-
for use, reproduction, or distribution of Your modifications, or
126-
for any such Derivative Works as a whole, provided Your use,
127-
reproduction, and distribution of the Work otherwise complies with
128-
the conditions stated in this License.
129-
130-
5. Submission of Contributions. Unless You explicitly state otherwise,
131-
any Contribution intentionally submitted for inclusion in the Work
132-
by You to the Licensor shall be under the terms and conditions of
133-
this License, without any additional terms or conditions.
134-
Notwithstanding the above, nothing herein shall supersede or modify
135-
the terms of any separate license agreement you may have executed
136-
with Licensor regarding such Contributions.
137-
138-
6. Trademarks. This License does not grant permission to use the trade
139-
names, trademarks, service marks, or product names of the Licensor,
140-
except as required for reasonable and customary use in describing the
141-
origin of the Work and reproducing the content of the NOTICE file.
142-
143-
7. Disclaimer of Warranty. Unless required by applicable law or
144-
agreed to in writing, Licensor provides the Work (and each
145-
Contributor provides its Contributions) on an "AS IS" BASIS,
146-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147-
implied, including, without limitation, any warranties or conditions
148-
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149-
PARTICULAR PURPOSE. You are solely responsible for determining the
150-
appropriateness of using or redistributing the Work and assume any
151-
risks associated with Your exercise of permissions under this License.
152-
153-
8. Limitation of Liability. In no event and under no legal theory,
154-
whether in tort (including negligence), contract, or otherwise,
155-
unless required by applicable law (such as deliberate and grossly
156-
negligent acts) or agreed to in writing, shall any Contributor be
157-
liable to You for damages, including any direct, indirect, special,
158-
incidental, or consequential damages of any character arising as a
159-
result of this License or out of the use or inability to use the
160-
Work (including but not limited to damages for loss of goodwill,
161-
work stoppage, computer failure or malfunction, or any and all
162-
other commercial damages or losses), even if such Contributor
163-
has been advised of the possibility of such damages.
164-
165-
9. Accepting Warranty or Additional Liability. While redistributing
166-
the Work or Derivative Works thereof, You may choose to offer,
167-
and charge a fee for, acceptance of support, warranty, indemnity,
168-
or other liability obligations and/or rights consistent with this
169-
License. However, in accepting such obligations, You may act only
170-
on Your own behalf and on Your sole responsibility, not on behalf
171-
of any other Contributor, and only if You agree to indemnify,
172-
defend, and hold each Contributor harmless for any liability
173-
incurred by, or claims asserted against, such Contributor by reason
174-
of your accepting any such warranty or additional liability.
175-
176-
END OF TERMS AND CONDITIONS
177-
178-
APPENDIX: How to apply the Apache License to your work.
179-
180-
To apply the Apache License to your work, attach the following
181-
boilerplate notice, with the fields enclosed by brackets "[]"
182-
replaced with your own identifying information. (Don't include
183-
the brackets!) The text should be enclosed in the appropriate
184-
comment syntax for the file format. We also recommend that a
185-
file or class name and description of purpose be included on the
186-
same "printed page" as the copyright notice for easier
187-
identification within third-party archives.
188-
189-
Copyright [yyyy] [name of copyright owner]
190-
191-
Licensed under the Apache License, Version 2.0 (the "License");
192-
you may not use this file except in compliance with the License.
193-
You may obtain a copy of the License at
194-
195-
http://www.apache.org/licenses/LICENSE-2.0
196-
197-
Unless required by applicable law or agreed to in writing, software
198-
distributed under the License is distributed on an "AS IS" BASIS,
199-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200-
See the License for the specific language governing permissions and
201-
limitations under the License.
1+
LicenseID: LicenseRef-Nordic-5-Clause
2+
3+
ExtractedText: <text>
4+
Copyright (c) 2018, Nordic Semiconductor ASA
5+
6+
All rights reserved.
7+
8+
Redistribution and use in source and binary forms, with or without modification,
9+
are permitted provided that the following conditions are met:
10+
11+
1. Redistributions of source code must retain the above copyright notice, this
12+
list of conditions and the following disclaimer.
13+
14+
2. Redistributions in binary form, except as embedded into a Nordic
15+
Semiconductor ASA integrated circuit in a product or a software update for
16+
such product, must reproduce the above copyright notice, this list of
17+
conditions and the following disclaimer in the documentation and/or other
18+
materials provided with the distribution.
19+
20+
3. Neither the name of Nordic Semiconductor ASA nor the names of its
21+
contributors may be used to endorse or promote products derived from this
22+
software without specific prior written permission.
23+
24+
4. This software, with or without modification, must only be used with a
25+
Nordic Semiconductor ASA integrated circuit.
26+
27+
5. Any software provided in binary form under this license must not be reverse
28+
engineered, decompiled, modified and/or disassembled.
29+
30+
THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
31+
OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32+
OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
33+
DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
34+
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
35+
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
36+
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
37+
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
38+
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
39+
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40+
</text>

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Softbank FOTA add-on for nRF Connect SDK
1+
# SoftBank FOTA add-on for nRF Connect SDK
22

33
<a href="https://github.com/nrfconnect/sdk-softbank-fota/actions/workflows/build-using-docker.yml?query=branch%3Amain">
44
<img src="https://github.com/nrfconnect/sdk-softbank-fota/actions/workflows/build-using-docker.yml/badge.svg?event=push">
@@ -13,17 +13,17 @@
1313
<img alt="API Documentation" src="https://img.shields.io/badge/API-documentation-3D578C?logo=c&logoColor=white">
1414
</a>
1515

16-
This repository contains the Softbank FOTA [add-on for NCS](https://nrfconnect.github.io/ncs-app-index/).
16+
This repository contains the SoftBank FOTA [add-on for NCS](https://nrfconnect.github.io/ncs-app-index/).
1717

1818
## Documentation
1919

20-
Pre-build documentation is available [here](https://nrfconnect.github.io/sdk-softbank-fota).
20+
Pre-built documentation is available [here](https://nrfconnect.github.io/sdk-softbank-fota).
2121

2222
A minimal documentation setup is provided for Sphinx. To build the
23-
documentation first change to the ``docs`` folder:
23+
documentation first change to the ``doc`` folder:
2424

2525
```shell
26-
cd docs
26+
cd doc
2727
```
2828
To install Sphinx, make sure you have a Python installation in place and run:
2929

@@ -38,4 +38,4 @@ make html
3838
```
3939

4040
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``.
41+
output formats other than HTML by running ``make help``.

doc/API_documentation.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,20 @@ API documentation
77
:local:
88
:depth: 2
99

10-
Following are the API elements used by the Softbank FOTA library:
10+
Following are the API elements used by the SoftBank FOTA library:
1111

1212
| Header files: :file:`lib/bin/sb_fota/include`
1313
| Source files: :file:`lib/bin/sb_fota`
1414
15-
Softbank FOTA library API
15+
SoftBank FOTA library API
1616
=========================
1717

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

2121
.. _sb_fota_os:
2222

23-
Softbank FOTA OS layer
23+
SoftBank FOTA OS layer
2424
======================
2525

2626
.. doxygengroup:: sb_fota_os

doc/CHANGELOG.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Changes
1717
* Logs are no longer compiled into the default library. This saves some memory.
1818
* The verbose library can be used during development phase to ensure that the library is integrated correctly into your application.
1919

20-
* More consistent use of ``Softbank FOTA`` (as opposed to modem FOTA). Renamed events such as ``FOTA_EVENT_DOWNLOADING`` -> ``SB_FOTA_EVENT_DOWNLOADING``
20+
* More consistent use of ``SoftBank FOTA`` (as opposed to modem FOTA). Renamed events such as ``FOTA_EVENT_DOWNLOADING`` -> ``SB_FOTA_EVENT_DOWNLOADING``
2121
* The library now schedules work on it's internal queue instead of the syswork queue (this avoids potential blocking of the syswork queue).
2222
* Removed ``SB_FOTA_EVENT_REBOOT_PENDING``. Reboot is not needed to apply modem update.
2323

doc/images/softbank_fota_summary.svg

+2-2
Loading

doc/index.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
:depth: 2
99

1010
Welcome to the SoftBank FOTA library NCS Add-on.
11-
The Softbank FOTA library is a small binary library that will periodically the `nRF Connect for Cloud`_ for modem firmware updates.
12-
If there is an applicable update, the Softbank FOTA library will download and install it.
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.
1313

1414
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>`.
1515

@@ -19,7 +19,7 @@ In addition to the library itself, this NCS add-on contains a :ref:`sample <sb_f
1919

2020

2121
.. important::
22-
As part of Nordics certification with SoftBank Mobile, this Softbank FOTA library **must** be integrated with your application, unless otherwise agreed with you local Nordic or Softbank representatives.
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.
2323

2424
.. toctree::
2525
:maxdepth: 1

0 commit comments

Comments
 (0)