History

StevenCellist f7f0b62e7f [LoRaWAN] Major rework (#1204 ) * [LoRaWAN] Major rework * [LoRaWAN] Some CI fixes, add retransmission timeout * [LoRaWAN] CI fixes * [LoRaWAN] Add missing initializers * [LoRaWAN] Return Rx window number, fix casing * [LoRaWAN] Un-static functions to fix overriding * [LoRaWAN] Integrate feedback, fix session save/restore * [LoRaWAN] Add const * [LoRaWAN] Do not accept invalid Rx2 datarate * [LoRaWAN] Integrate feedback * [LoRaWAN] Fix retransmission, ADR backoff, setDatarate; reject out-of-band frequencies * Update keywords.txt * [LoRaWAN] Fix initial datarate, misc cleanup * [LoRaWAN] Update examples * [LoRaWAN] Update README * [LoRaWAN] Reject oversized downlinks * [LoRaWAN] Remove VLAs * [LoRaWAN] CI fixes * [LoRaWAN] More CI * [LoRaWAN] Fix getMaxPayloadLen * [LoRaWAN] Rename some status codes * [CI] Skip LoRaWAN on XMega48 * [CI] Skip FW update for LR11x0 --------- Co-authored-by: jgromes <jan.gromes@gmail.com>		2024-09-10 21:11:16 +02:00
..
LoRaWAN_ABP	[LoRaWAN] Major rework (#1204 )	2024-09-10 21:11:16 +02:00
LoRaWAN_Reference	[LoRaWAN] Major rework (#1204 )	2024-09-10 21:11:16 +02:00
LoRaWAN_Starter	[LoRaWAN] Major rework (#1204 )	2024-09-10 21:11:16 +02:00
README.md	[LoRaWAN] Major rework (#1204 )	2024-09-10 21:11:16 +02:00

README.md

LoRaWAN examples

RadioLib LoRaWAN examples.

LoRaWAN_Starter: this is the recommended entry point for new users. Please read the notes that come with this example to learn more about LoRaWAN and how to use it in RadioLib!
LoRaWAN_Reference: this sketch showcases most of the available API for LoRaWAN in RadioLib. Be frightened by the possibilities! It is recommended you have read all the notes for the Starter sketch first, as well as the Learn section on The Things Network!
LoRaWAN_ABP: if you wish to use ABP instead of OTAA (but why?), this example shows how you can do this using RadioLib.

LoRaWAN versions & regional parameters

RadioLib implements both LoRaWAN v1.1 and v1.0.4. Confusingly, v1.0.4 is newer than v1.1, but v1.1 includes more security checks and as such LoRaWAN v1.1 is preferred.
The catch is in the Regional Parameters: as v1.0.4 is newer, it is more up to date regarding local laws & regulations. Therefore, RadioLib implements 1.0.4 as baseline and 1.1 as fallback, but Regional Parameters v1.0.4 is preferred.
Note: the CN500 band is implemented as specified in RP v1.1, as the RP v1.0.4 version is much too complex.

To activate a LoRaWAN v1.1 session, supply all the required keys:

node.beginOTAA(joinEUI, devEUI, nwkKey, appKey);
node.beginABP(devAddr, fNwkSIntKey, sNwkSIntKey, nwkSEncKey, appSKey);

To activate a LoRaWAN v1.0.4 session, set the keys that are not available to NULL:

node.beginOTAA(joinEUI, devEUI, NULL, appKey);
node.beginABP(devAddr, NULL, NULL, nwkSEncKey, appSKey);

The device doesn't need to know the Regional Parameters version - that is of importance on the console.

LoRaWAN persistence

Warning

These examples do not actually comply with LoRaWAN v1.0.4/v1.1: for that, persistent storage is necessary. As the implementation of persistent storage differs between different platforms, these are not given here, but in a separate repository, see below:

In this repository, examples are provided that do comply with the required persistence of certain parameters for LoRaWAN v1.1. Examples are (or will become) available for some of the most popular platforms. These examples assume you have successfully used the Starter sketch and understood (most of) the accompanying notes! Currently, examples are available for the following platforms:

This list is last updated at 30/03/2024.