REST API

Asset Tracker Template

tags: Asset Tracker Template

Asset Tracker Template
Get started
System Overview
Key Features
Getting started
Option 1: nRF Connect for VS Code (recommended)
Option 2: Command line
Install prerequisites
Initialize the workspace
Build the application
Flash the device
Testing
Next steps
Architecture
System overview
Module design
Module threads
Message passing with zbus
Channels
Message types and the message structure
Sending messages
Receiving messages
Message subscribers
Listeners
Private channels
State machines
State machine definition
State object
State machine initialization
Run functions
State transitions
State machine execution
Configuration
Runtime configurations
Behavior
Remote configuration from cloud
Configuration through nRF Cloud UI
Configuration through REST API
Sending commands through REST API
Configuration flow
Set location method priorities
Available location methods
Configuration examples
Storage configuration
Basic configuration in prj.conf
Network configuration
NB-IoT vs. LTE-M
Network mode selection
Network mode preference
Power Saving Mode (PSM)
PSM parameters
Access Point Name (APN)
Modifying the template
Add a new zbus event
Instructions
Add a new environmental sensor
Instructions
Add your own module
Instructions
Add shell support
Test the module using the shell
Enable support for MQTT
Configuration
How to use the MQTT cloud example
Module state machine
Limitations
Connecting
Connecting a device
Step 1: Obtain the device attestation token
Step 2: Onboard the device in nRF Cloud
Step 3: Trigger provisioning on the device
API alternative
Reprovisioning
Manual
Removing a device
Location services
Location Methods
Integration with nRF Cloud
Power Considerations
Achieving low power
Prerequisites
Measuring power consumption
Online Power Profiler for LTE
Power Profiler Kit 2 (PPK2)
Application power configuration
Power Saving Mode (PSM)
Extended Discontinuous Reception (eDRX)
Sampling and send behavior
UART power management
Automatic UART disable on Thingy:91 X
Manual UART control using shell
Wi-Fi scanning optimization (Thingy:91 X using the nRF7002)
2.4 GHz band scanning (default)
Optimization best practices
Additional resources
Firmware updates (FOTA)
Firmware versioning
Version components
Preparing firmware
Version verification
Performing FOTA updates
REST API
Setup
Complete update workflow
API reference
Testing and CI setup
CI Pipeline Structure
Hardware Tests
Emulated Target Tests
SonarCloud Analysis
Compliance Testing
Documentation Sync
Key Features
Test Results and Artifacts
Tooling and Troubleshooting
Shell Commands
Available Commands
Shell Command Examples
Cloud Publishing
Perform cloud provisioning
Poll for FOTA updates
Network disconnect
AT Command Execution
Debugging Tools
Low Power Profiling
GDB Debugging
SEGGER SystemView
Configuration
Thread Analysis
Hardfaults
State Inspection Script
Memory Section Placement for State Objects
Memfault Remote Debugging
When to Use Memfault
How to use Memfault
Test shell commands
Modem Tracing
UART Tracing
RTT Tracing
Decrypting DTLS traffic in modem traces
Requirements
Building with the developer security tag
Capturing and inspecting decrypted traffic
Decrypted traces uploaded to Memfault
Provisioning the CoAP CA certificate on the nRF9151 DK
Dumping modem traces over UART after capture
Application logs and modem traces over RTT - Parallel capture
Common Issues and Solutions
Known Issues
Modules
Main module
Architecture
State diagram
Messages
Firmware updates (FOTA)
LED status indicators
Configuration
Button module
Messages
Output messages
Message types
Cloud module
Architecture
State diagram
Integration with storage module
Messages
Input messages
Output messages
Configurations
Shell commands
Environmental module
Architecture
State diagram
Messages
Input messages
Output messages
Configuration
FOTA module
Architecture
State diagram
Messages
Input messages
Output messages
Configuration
Shell commands
LED module
Messages
Operation
Configuration
Example: Setting LED colors
Location module
Architecture
State diagram
Messages
Input messages
Output messages
Configurations
Location method priority
Default method order
Wi-Fi and cellular combining
Changing the method order
nRF Cloud location service usage
Network module
Architecture
State diagram
Messages
Input messages
Output messages
Message structure
Configurations
Power module
Architecture
State diagram
States
Messages
Input messages
Output messages
Configurations
Kconfig and device tree
Storage module
Architecture
State diagram
Backend
RAM backend (Default)
LittleFS flash backend
Data flow
Batch session protocol
Memory management
How to reduce RAM
Minimal RAM example
Flash management (LittleFS backend)
Partition sizing
Target-specific defaults
LittleFS built-in wear leveling
Application-level ring buffer wear leveling
Block-level distribution
Combined wear protection
Minimizing flash wear
Configuration examples
Basic LittleFS configuration
Optimized for data persistence with minimal flash wear
Messages
Input messages (Commands)
Output messages (Responses)
Message structure
Configurations
Storage backend
Memory configuration
Flash configuration (LittleFS backend)
Threshold configuration
Thread configuration
Development features
Message handling
API documentation
Channels
storage channel
storage data channel
Data type registration
Backend interface
Batch read helper
Usage
Data retrieval
Processing STORAGE_DATA
Admin commands
Shell commands
Adding backends
Dependencies
UART Power Control module
Architecture
Configuration
Devicetree
Notes
Related
Release artifacts
Downloading releases
Firmware deliverables
Primary release artifacts
Standard firmware variants
Debug variant
Specialized configuration variants
Configuration overlays
Hardware platform support
Thingy:91 X (Primary platform)
nRF9151 DK
Release notes

Back to home page