RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

pkg/semtech-loramac: add documentation about ztimer

Browse Source
This commit is contained in:
Alexandre Abadie 2020-08-20 14:08:03 +02:00
parent f1d5e98c81
commit abfbc8a813
No known key found for this signature in database
GPG Key ID: 1C919A403CAE1405
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
pkg/semtech-loramac/doc.txt
View File

@ -152,6 +152,23 @@
* This mechanism is especially useful when using deep sleep power modes that
* don't preserve RAM.
*
* # Low power considerations
*
* The internal implementation of the required LoRaWAN timings (delay before
* opening RX windows, duty-cycle delays) automatically achieves the lowest
* possible power consumption while remaining usable when RIOT's low power modes
* are not blocked. All timings are managed by the @ref sys_ztimer
* running on the low-level @ref drivers_periph_rtt peripheral which
* allows for:
* - going to a deep-sleep mode with RAM retention (no reboot) between TX and
* RX1 and between RX1 and RX2 windows, and as a result reduces the power
* consumption
* - using deep-sleep mode with RAM retention and have the duty-cycle
* restriction still usable between each active cycle (wake-up, measure, send,
* receive, sleep).
* As a result, this package can only be used on boards that provide the
* `periph_rtt` feature.
*
* @warning It is not possible to directly call the original LoRaMAC-node API
* using this package. This package should only be considered as a
* wrapper around the original LoRaMAC-node API and only the API