Skip to content

Commit 6ee3743

Browse files
simensrostadsimensrostad
committed
docs: Add initial documentation structure
Add initial files and some rough content in the files. Signed-off-by: Simen S. Røstad <simen.rostad@nordicsemi.no>
1 parent 2f31ce5 commit 6ee3743

22 files changed

+280
-69
lines changed

‎README.md

+28
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,31 @@
88
[![Power Consumption Badge](https://img.shields.io/endpoint?url=https://nrfconnect.github.io/Asset-Tracker-Template/power_badge.json)](https://nrfconnect.github.io/Asset-Tracker-Template/power_measurements_plot.html)
99

1010
The Asset Tracker Template is under development.
11+
12+
## Overview
13+
14+
Template for Cellular IoT development on Nordic Semiconductor nRF91 Series LTE devices
15+
16+
## Table of Contents
17+
18+
### Common
19+
- [Business Logic](docs/common/business_logic.md)
20+
- [Configurability](docs/common/configurability.md)
21+
- [Customization](docs/common/customization.md)
22+
- [Location Services](docs/common/location_services.md)
23+
- [Test and CI Setup](docs/common/test_and_ci_setup.md)
24+
- [Tooling](docs/common/tooling.md)
25+
- [Optimizations](docs/common/optimizations.md)
26+
- [Advanced](docs/common/advanced.md)
27+
28+
### Modules
29+
- [Main](docs/modules/main.md)
30+
- [Location]((docs/modules/location.md))
31+
- [LED]((docs/modules/led.md))
32+
- [FOTA](docs/modules/fota.md)
33+
- [Button](docs/modules/button.md)
34+
- [Cloud](docs/modules/cloud.md)
35+
- [Environmental](docs/modules/environmental.md)
36+
- [Main](docs/modules/main.md)
37+
- [Network](docs/modules/network.md)
38+
- [Power](docs/modules/power.md)

‎docs/ARCHITECTURE.md

-69
This file was deleted.

‎docs/common/advanced.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Advanced
2+
3+
## Material for dev academy lesson?
4+
5+
### Common principles for modules - active object concept
6+
- Explanation of common principles for modules and active object concept.
7+
8+
### Run to completion, event driven, Miro Samek, smallest possible variable scopes, self-contained, independent modules
9+
- Explanation of run to completion, event driven, Miro Samek, smallest possible variable scopes, self-contained, independent modules.
10+
11+
### Introduce Zbus and SMF?
12+
- Explanation of Zbus and SMF.
13+
14+
### Fault handling, check return codes, assertions on by default
15+
- Explanation of fault handling, checking return codes, and enabling assertions by default.
16+
17+
### Keep it simple - small functions, pass by reference, readability and maintainability
18+
- Explanation of keeping it simple with small functions, passing by reference, readability, and maintainability.
19+
20+
## Useful links
21+
22+
[nRF Cloud CoAP](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/libraries/networking/nrf_cloud_coap.html)
23+
[ZBUS Documentation](https://docs.zephyrproject.org/latest/services/zbus/index.html)
24+
[Connection Manager](https://docs.nordicsemi.com/bundle/ncs-latest/page/zephyr/connectivity/networking/conn_mgr/main.html)
25+
[Date Time Library](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/libraries/others/date_time.html)
26+
[Memfault](https://memfault.com/)
27+
[Fuel Gauge Subsystem](https://docs.nordicsemi.com/bundle/ncs-latest/page/zephyr/hardware/peripherals/fuel_gauge.html)
28+
[BME68x IAQ Driver](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/drivers/bme68x_iaq.html)
29+
[Location Library](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/libraries/modem/location.html)

‎docs/common/business_logic.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Business Logic
2+
General description on how stuff works.
3+
4+
## Diagram of all modules
5+
- Description of the diagram of all modules.
6+
7+
## LED pattern
8+
- Description of the LED pattern.

‎docs/common/configurability.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Configurability
2+
3+
## Set sampling interval and logic from cloud
4+
- Instructions on setting sampling interval and logic from the cloud.
5+
6+
## Set location method priorities
7+
- Instructions on setting location method priorities.
8+
9+
## Network configuration
10+
### NB-IoT vs M1
11+
- Explanation of NB-IoT vs M1.
12+
13+
### PSM
14+
- Explanation of PSM.
15+
16+
### APN
17+
- Explanation of APN.

‎docs/common/customization.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Customization
2+
3+
## Add your own module
4+
- Instructions on adding your own module.
5+
6+
## Adjust logic
7+
- Instructions on adjusting logic.
8+
9+
## Dummy module?
10+
- Explanation of dummy module.
11+
12+
## Disable modules
13+
- Instructions on disabling modules.
14+
15+
## Add sensor - patch file
16+
- Instructions on adding a sensor using a patch file.

‎docs/common/fota.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# FOTA
2+
3+
## How to test
4+
- Instructions on how to test FOTA.
5+
- Using CI
6+
7+
## nRF Cloud UI walkthrough
8+
- Walkthrough of the nRF Cloud UI.

‎docs/common/location_services.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Location Services
2+
3+
- Description of location services.

‎docs/common/nrf_cloud.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# nRF Cloud
2+
3+
## Set up your own account
4+
- Instructions on setting up your own account.
5+
6+
## Connect to your own account
7+
- Instructions on connecting to your own account.
8+
9+
## Message Routing Service
10+
- Explanation of the Message Routing Service.

‎docs/common/optimizations.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Optimizations
2+
3+
## Use case specific
4+
- Explanation of use case specific optimizations.
5+
6+
### We have not done this - left for the customer
7+
- Explanation of what is left for the customer.
8+
9+
### Data format
10+
- Explanation of data format.
11+
12+
### Compression
13+
- Explanation of compression.
14+
15+
### Network searching optimizations
16+
- Explanation of network searching optimizations.
17+
18+
## Explain pipelines that are in place
19+
- Explanation of pipelines that are in place.

‎docs/common/test_and_ci_setup.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Test and CI Setup
2+
3+
## On-commit tests - fast
4+
- Explanation of on-commit tests.
5+
6+
## Nightly - speed not that important, run on target
7+
- Explanation of nightly tests.

‎docs/common/tooling.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Tooling
2+
3+
## Shell
4+
- Description of the shell.
5+
6+
## Low power profiling
7+
- Description of low power profiling.
8+
- PPK etc using CI and app
9+
10+
## Modem trace
11+
### RTT
12+
- Explanation of RTT.
13+
- Using CLI capture
14+
15+
### Pcap
16+
- Explanation of Pcap.
17+
18+
### CLI capture - nrfutil
19+
- Explanation of CLI capture using nrfutil.
20+
21+
## Memfault
22+
- Description of Memfault.

‎docs/common/troubleshooting.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Troubleshooting
2+
General tips for certain scenarios that goes wrong, can be in the following format:
3+
4+
# Issue 1
5+
- problem (description, UART/trace output) -
6+
- suggested tooling/debuggin to find the source of the issue - (modem trace / memfault)
7+
- Suggested fixes -
8+
- Link to similar devzone cases -
9+
10+
# Issuen 2
11+
- problem (description, UART/trace output) -
12+
- suggested tooling/debuggin to find the source of the issue - (modem trace / memfault)
13+
- Suggested fixes -
14+
- Link to similar devzone cases -

‎docs/modules/button.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Button module
2+
3+
What does this module do
4+
5+
## Messages
6+
7+
## Configurations
8+
9+
Kconfig and device tree
10+
11+
## State diagram

‎docs/modules/cloud.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Cloud module
2+
3+
What does this module do
4+
5+
## Messages
6+
7+
## Configurations
8+
9+
Kconfig and device tree
10+
11+
## State diagram

‎docs/modules/environmental.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Environmental module
2+
3+
What does this module do
4+
5+
## Messages
6+
7+
## Configurations
8+
9+
Kconfig and device tree
10+
11+
## State diagram

‎docs/modules/fota.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# FOTA module
2+
3+
What does this module do
4+
5+
## Messages
6+
7+
## Configurations
8+
9+
Kconfig and device tree
10+
11+
## State diagram

‎docs/modules/led.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# LED module
2+
3+
What does this module do
4+
5+
## Messages
6+
7+
## Configurations
8+
9+
Kconfig and device tree
10+
11+
## State diagram

‎docs/modules/location.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Location module
2+
3+
What does this module do
4+
5+
## Messages
6+
7+
## Configurations
8+
9+
Kconfig and device tree
10+
11+
## State diagram

‎docs/modules/main.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Main module
2+
3+
What does this module do
4+
5+
## Messages
6+
7+
## Configurations
8+
9+
Kconfig and device tree
10+
11+
## State diagram

‎docs/modules/network.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Network module
2+
3+
What does this module do
4+
5+
## Messages
6+
7+
## Configurations
8+
9+
Kconfig and device tree
10+
11+
## State diagram

‎docs/modules/power.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Power module
2+
3+
What does this module do
4+
5+
## Messages
6+
7+
## Configurations
8+
9+
Kconfig and device tree
10+
11+
## State diagram

0 commit comments

Comments
 (0)