Skip to content

Commit 9c97c43

Browse files
committed
docs: Add introduction doc landing page
Add a brief introduction to the template in README.md. Signed-off-by: Jan Tore Guggedal <jantore.guggedal@nordicsemi.no>
1 parent fc93fd6 commit 9c97c43

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

README.md

+17-3
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,25 @@
77
[![Target_tests](https://github.com/nrfconnect/Asset-Tracker-Template/actions/workflows/build-and-target-test.yml/badge.svg?event=schedule)](https://github.com/nrfconnect/Asset-Tracker-Template/actions/workflows/build-and-target-test.yml?query=branch%3Amain+event%3Aschedule)
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

10-
The Asset Tracker Template is under development.
11-
1210
## Overview
1311

14-
Template for Cellular IoT development on Nordic Semiconductor nRF91 Series LTE devices
12+
The Asset Tracker Template implements a modular application framework for nRF91-based IoT devices.
13+
The application is built on nRF Connect SDK and uses a combination of state machines and message-based inter-module communication.
14+
It is intended to be a framework for developing asset tracking applications, but can be customized for other use cases as well.
15+
We have not targeted a specific use-case with this template, but rather a set of features that are common in asset tracking applications, and left it up to the user to decide how to use, modify, or extend the template to fit their needs.
16+
The ``main.c`` file contains the main module of the application, where the business logic and control over the other modules is implemented, and is a good starting point for understanding how the application works.
17+
This is also the naural place to start when customizing the application for a specific use-case.
18+
19+
The template is open-source for a reason, and we encourage users to contribute back to the project with improvements, bug fixes, or new features.
20+
21+
## Key concepts
22+
23+
* **Modular design**: The application is divided into modules, each responsible for a specific feature or functionality.
24+
* **State machines**: Each module, where applicable, has its own state machine, which defines the behavior of the module. The state machines are implemented using Zephyr's [State Machine Framework](https://docs.nordicsemi.com/bundle/ncs-3.0.0-preview1/page/zephyr/services/smf/index.html).
25+
* **Message-based communication**: Modules communicate with each other by sending messages using [zbus](https://docs.nordicsemi.com/bundle/ncs-latest/page/zephyr/services/zbus/index.html), a message bus library for Zephyr.
26+
* **Configuration options**: The application can be configured using Kconfig options to enable or disable features, set parameters, and more.
27+
* **Designed for low-power operation**: The application is designed to be power-efficient, with features like LTE Power Saving Mode (PSM) enabled by default.
28+
1529

1630
## Table of Contents
1731

0 commit comments

Comments
 (0)