Skip to content

Commit 94d09aa

Browse files
committed
docs: Add introduction
Add introduction section to the documentation. Signed-off-by: Jan Tore Guggedal <[email protected]>
1 parent eb61063 commit 94d09aa

File tree

3 files changed

+18
-5
lines changed

3 files changed

+18
-5
lines changed

docs/index.rst

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,22 @@
33
Thingy:91 X: Hello nRF Cloud firmware
44
#####################################
55

6-
.. contents::
7-
:local:
8-
:depth: 2
6+
The Hello nRF Cloud firmware is the official, factory-programmed firmware for the nRF9151 SiP on the Thingy:91 X device.
97

10-
This project is based on the `NCS Example Application`_.
8+
The application search for and connects to an LTE network and sends network and sensor data to nRF Cloud, using CoAP over UDP as transport protocol.
9+
Sampled data that is sent from the application, can be viewed in the `hello.nrfcloud.com`_ web interface.
10+
11+
Some of the key features of the firmware include:
12+
13+
* LTE network connection management
14+
* Secure and efficient communication with nRF Cloud using CoAP with DTLS connection ID over UDP
15+
* Sensor data collection and transmission
16+
* Firmware-Over-the-Air (FOTA) capability for application and modem updates
17+
* Modem tracing capability
18+
* LED indication for visualizing the operating state of the application
19+
20+
The project repository is based on the `NCS Example Application`_ and customized to the needs of the application.
21+
Read more about the various aspects of the firmware in the following sections.
1122

1223
.. toctree::
1324
:maxdepth: 2

docs/links.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,5 @@
3232
.. _`Interactive BOM PCA20065 1.0.0.`: https://htmlpreview.github.io/?https://github.com/hello-nrfcloud/firmware/blob/main/docs/pca20065_1_0_0.html
3333

3434
.. _`pyOCD`: https://github.com/pyocd/pyOCD
35+
36+
.. _`hello.nrfcloud.com`: https://hello.nrfcloud.com/

docs/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Sphinx==5.3.0
22
breathe==4.35.0
3-
sphinx-ncs-theme<=0.7.4
3+
sphinx-ncs-theme==0.7.4
44
sphinx-tabs>=3.4
55
sphinx-togglebutton>=0.3.2
66
Pillow>=9.0.1

0 commit comments

Comments
 (0)