Skip to content

Commit d76788e

Browse files
docs: config with rest api
Add docs for configuring update interval with rest. Signed-off-by: Giacomo Dematteis <giacomo.dematteis@nordicsemi.no>
1 parent 8da6ab8 commit d76788e

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The application is built on nRF Connect SDK and uses a combination of state mach
1414
It is intended to be a framework for developing asset tracking applications, but can be customized for other use cases as well.
1515
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.
1616
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.
17+
This is also the natural place to start when customizing the application for a specific use-case.
1818

1919
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.
2020

docs/common/configurability.md

+6
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,12 @@ The Asset Tracker can be configured remotely through nRF Cloud's device shadow m
2020

2121
The device will receive the new configuration through its shadow and adjust its update interval accordingly.
2222

23+
### Configuration through REST API
24+
25+
Update interval using nrfcloud rest api [nRF Cloud REST API](https://api.nrfcloud.com/#tag/IP-Devices/operation/UpdateDeviceState)
26+
```
27+
curl -X PATCH "https://api.nrfcloud.com/v1/devices/$DEVICE_ID/state" -H "Authorization: Bearer $API_KEY" -H "Content-Type: application/json" -d '{ "desired": { "config": { "update_interval": <your_value> } } }'
28+
```
2329

2430
### Configuration Flow
2531
1. **Initial Setup**

0 commit comments

Comments
 (0)