RadioLib
Universal wireless communication library for Arduino
Loading...
Searching...
No Matches
LoRaWAN.h
1#if !defined(_RADIOLIB_LORAWAN_H) && !RADIOLIB_EXCLUDE_LORAWAN
2#define _RADIOLIB_LORAWAN_H
3
4#include "../../TypeDef.h"
5#include "../PhysicalLayer/PhysicalLayer.h"
6#include "../../utils/Cryptography.h"
7
8// activation mode
9#define RADIOLIB_LORAWAN_MODE_OTAA (0x07AA)
10#define RADIOLIB_LORAWAN_MODE_ABP (0x0AB9)
11#define RADIOLIB_LORAWAN_MODE_NONE (0x0000)
12
13// operation mode
14#define RADIOLIB_LORAWAN_CLASS_A (0x00)
15#define RADIOLIB_LORAWAN_CLASS_B (0x01)
16#define RADIOLIB_LORAWAN_CLASS_C (0x02)
17
18// preamble format
19#define RADIOLIB_LORAWAN_LORA_SYNC_WORD (0x34)
20#define RADIOLIB_LORAWAN_LORA_PREAMBLE_LEN (8)
21#define RADIOLIB_LORAWAN_GFSK_SYNC_WORD (0xC194C1)
22#define RADIOLIB_LORAWAN_GFSK_PREAMBLE_LEN (5)
23#define RADIOLIB_LORAWAN_LR_FHSS_SYNC_WORD (0x2C0F7995)
24
25// MAC header field encoding MSB LSB DESCRIPTION
26#define RADIOLIB_LORAWAN_MHDR_MTYPE_JOIN_REQUEST (0x00 << 5) // 7 5 message type: join request
27#define RADIOLIB_LORAWAN_MHDR_MTYPE_JOIN_ACCEPT (0x01 << 5) // 7 5 join accept
28#define RADIOLIB_LORAWAN_MHDR_MTYPE_UNCONF_DATA_UP (0x02 << 5) // 7 5 unconfirmed data up
29#define RADIOLIB_LORAWAN_MHDR_MTYPE_UNCONF_DATA_DOWN (0x03 << 5) // 7 5 unconfirmed data down
30#define RADIOLIB_LORAWAN_MHDR_MTYPE_CONF_DATA_UP (0x04 << 5) // 7 5 confirmed data up
31#define RADIOLIB_LORAWAN_MHDR_MTYPE_CONF_DATA_DOWN (0x05 << 5) // 7 5 confirmed data down
32#define RADIOLIB_LORAWAN_MHDR_MTYPE_PROPRIETARY (0x07 << 5) // 7 5 proprietary
33#define RADIOLIB_LORAWAN_MHDR_MTYPE_MASK (0x07 << 5) // 7 5 bitmask of all possible options
34#define RADIOLIB_LORAWAN_MHDR_MAJOR_R1 (0x00 << 0) // 1 0 major version: LoRaWAN R1
35
36// frame control field encoding
37#define RADIOLIB_LORAWAN_FCTRL_ADR_ENABLED (0x01 << 7) // 7 7 adaptive data rate: enabled
38#define RADIOLIB_LORAWAN_FCTRL_ADR_DISABLED (0x00 << 7) // 7 7 disabled
39#define RADIOLIB_LORAWAN_FCTRL_ADR_ACK_REQ (0x01 << 6) // 6 6 adaptive data rate ACK request
40#define RADIOLIB_LORAWAN_FCTRL_ACK (0x01 << 5) // 5 5 confirmed message acknowledge
41#define RADIOLIB_LORAWAN_FCTRL_FRAME_PENDING (0x01 << 4) // 4 4 downlink frame is pending
42
43// fPort field
44#define RADIOLIB_LORAWAN_FPORT_MAC_COMMAND (0x00 << 0) // 7 0 payload contains MAC commands only
45#define RADIOLIB_LORAWAN_FPORT_PAYLOAD_MIN (0x01 << 0) // 7 0 start of user-allowed fPort range
46#define RADIOLIB_LORAWAN_FPORT_PAYLOAD_MAX (0xDF << 0) // 7 0 end of user-allowed fPort range
47#define RADIOLIB_LORAWAN_FPORT_RESERVED (0xE0 << 0) // 7 0 fPort values equal to and larger than this are reserved
48
49// data rate encoding
50#define RADIOLIB_LORAWAN_DATA_RATE_UNUSED (0x0F << 0) // reserved / unused data rate
51#define RADIOLIB_LORAWAN_TX_POWER_UNUSED (0x0F << 0) // reserved / unused Tx power
52
53// channels and channel plans
54#define RADIOLIB_LORAWAN_UPLINK (0x00 << 0)
55#define RADIOLIB_LORAWAN_DOWNLINK (0x01 << 0)
56#define RADIOLIB_LORAWAN_RX1 (0x01 << 0)
57#define RADIOLIB_LORAWAN_RX2 (0x02 << 0)
58#define RADIOLIB_LORAWAN_RX_BC (0x03 << 0)
59#define RADIOLIB_LORAWAN_BAND_DYNAMIC (0)
60#define RADIOLIB_LORAWAN_BAND_FIXED (1)
61#define RADIOLIB_LORAWAN_CHANNEL_NUM_DATARATES (15)
62
63// recommended default settings
64#define RADIOLIB_LORAWAN_RECEIVE_DELAY_1_MS (1000)
65#define RADIOLIB_LORAWAN_RECEIVE_DELAY_2_MS ((RADIOLIB_LORAWAN_RECEIVE_DELAY_1_MS) + 1000)
66#define RADIOLIB_LORAWAN_RX1_DR_OFFSET (0)
67#define RADIOLIB_LORAWAN_JOIN_ACCEPT_DELAY_1_MS (5000)
68#define RADIOLIB_LORAWAN_JOIN_ACCEPT_DELAY_2_MS (6000)
69#define RADIOLIB_LORAWAN_ADR_ACK_LIMIT_EXP (0x06)
70#define RADIOLIB_LORAWAN_ADR_ACK_DELAY_EXP (0x05)
71#define RADIOLIB_LORAWAN_RETRANSMIT_TIMEOUT_MIN_MS (1000)
72#define RADIOLIB_LORAWAN_RETRANSMIT_TIMEOUT_MAX_MS (3000)
73#define RADIOLIB_LORAWAN_POWER_STEP_SIZE_DBM (-2)
74#define RADIOLIB_LORAWAN_REJOIN_MAX_COUNT_N (10) // send rejoin request 16384 uplinks
75#define RADIOLIB_LORAWAN_REJOIN_MAX_TIME_N (15) // once every year, not actually implemented
76
77// join request message layout
78#define RADIOLIB_LORAWAN_JOIN_REQUEST_LEN (23)
79#define RADIOLIB_LORAWAN_JOIN_REQUEST_JOIN_EUI_POS (1)
80#define RADIOLIB_LORAWAN_JOIN_REQUEST_DEV_EUI_POS (9)
81#define RADIOLIB_LORAWAN_JOIN_REQUEST_DEV_NONCE_POS (17)
82#define RADIOLIB_LORAWAN_JOIN_REQUEST_TYPE (0xFF)
83#define RADIOLIB_LORAWAN_JOIN_REQUEST_TYPE_0 (0x00)
84#define RADIOLIB_LORAWAN_JOIN_REQUEST_TYPE_1 (0x01)
85#define RADIOLIB_LORAWAN_JOIN_REQUEST_TYPE_2 (0x02)
86
87// join accept message layout
88#define RADIOLIB_LORAWAN_JOIN_ACCEPT_MAX_LEN (33)
89#define RADIOLIB_LORAWAN_JOIN_ACCEPT_JOIN_NONCE_POS (1)
90#define RADIOLIB_LORAWAN_JOIN_ACCEPT_HOME_NET_ID_POS (4)
91#define RADIOLIB_LORAWAN_JOIN_ACCEPT_DEV_ADDR_POS (7)
92#define RADIOLIB_LORAWAN_JOIN_ACCEPT_DL_SETTINGS_POS (11)
93#define RADIOLIB_LORAWAN_JOIN_ACCEPT_RX_DELAY_POS (12)
94#define RADIOLIB_LORAWAN_JOIN_ACCEPT_CFLIST_POS (13)
95#define RADIOLIB_LORAWAN_JOIN_ACCEPT_CFLIST_LEN (16)
96#define RADIOLIB_LORAWAN_JOIN_ACCEPT_CFLIST_TYPE_POS (RADIOLIB_LORAWAN_JOIN_ACCEPT_CFLIST_POS + RADIOLIB_LORAWAN_JOIN_ACCEPT_CFLIST_LEN - 1)
97
98// join accept key derivation layout
99#define RADIOLIB_LORAWAN_JOIN_ACCEPT_AES_JOIN_NONCE_POS (1) // regular keys
100#define RADIOLIB_LORAWAN_JOIN_ACCEPT_AES_JOIN_EUI_POS (4)
101#define RADIOLIB_LORAWAN_JOIN_ACCEPT_AES_DEV_NONCE_POS (12)
102#define RADIOLIB_LORAWAN_JOIN_ACCEPT_AES_DEV_ADDR_POS (1) // relay keys
103
104// join accept message variables
105#define RADIOLIB_LORAWAN_JOIN_ACCEPT_R_1_0 (0x00 << 7) // 7 7 LoRaWAN revision: 1.0
106#define RADIOLIB_LORAWAN_JOIN_ACCEPT_R_1_1 (0x01 << 7) // 7 7 1.1
107#define RADIOLIB_LORAWAN_JOIN_ACCEPT_F_NWK_S_INT_KEY (0x01)
108#define RADIOLIB_LORAWAN_JOIN_ACCEPT_APP_S_KEY (0x02)
109#define RADIOLIB_LORAWAN_JOIN_ACCEPT_S_NWK_S_INT_KEY (0x03)
110#define RADIOLIB_LORAWAN_JOIN_ACCEPT_NWK_S_ENC_KEY (0x04)
111#define RADIOLIB_LORAWAN_JOIN_ACCEPT_JS_ENC_KEY (0x05)
112#define RADIOLIB_LORAWAN_JOIN_ACCEPT_JS_INT_KEY (0x06)
113#define RADIOLIB_LORAWAN_JOIN_ACCEPT_ROOT_WOR_S_KEY (0x01)
114#define RADIOLIB_LORAWAN_JOIN_ACCEPT_WOR_S_INT_KEY (0x01)
115#define RADIOLIB_LORAWAN_JOIN_ACCEPT_WOR_S_ENC_KEY (0x02)
116
117// frame header layout
118#define RADIOLIB_LORAWAN_FHDR_LEN_START_OFFS (16)
119#define RADIOLIB_LORAWAN_FHDR_DEV_ADDR_POS (RADIOLIB_LORAWAN_FHDR_LEN_START_OFFS + 1)
120#define RADIOLIB_LORAWAN_FHDR_FCTRL_POS (RADIOLIB_LORAWAN_FHDR_LEN_START_OFFS + 5)
121#define RADIOLIB_LORAWAN_FHDR_FCNT_POS (RADIOLIB_LORAWAN_FHDR_LEN_START_OFFS + 6)
122#define RADIOLIB_LORAWAN_FHDR_FOPTS_POS (RADIOLIB_LORAWAN_FHDR_LEN_START_OFFS + 8)
123#define RADIOLIB_LORAWAN_FHDR_FOPTS_LEN_MASK (0x0F)
124#define RADIOLIB_LORAWAN_FHDR_FOPTS_MAX_LEN (15)
125#define RADIOLIB_LORAWAN_FHDR_FPORT_POS(FOPTS) (RADIOLIB_LORAWAN_FHDR_LEN_START_OFFS + 8 + (FOPTS))
126#define RADIOLIB_LORAWAN_FRAME_PAYLOAD_POS(FOPTS) (RADIOLIB_LORAWAN_FHDR_LEN_START_OFFS + 9 + (FOPTS))
127#define RADIOLIB_LORAWAN_FRAME_LEN(PAYLOAD, FOPTS) (16 + 13 + (PAYLOAD) + (FOPTS))
128
129// payload encryption/MIC blocks common layout
130#define RADIOLIB_LORAWAN_BLOCK_MAGIC_POS (0)
131#define RADIOLIB_LORAWAN_BLOCK_CONF_FCNT_POS (1)
132#define RADIOLIB_LORAWAN_BLOCK_DIR_POS (5)
133#define RADIOLIB_LORAWAN_BLOCK_DEV_ADDR_POS (6)
134#define RADIOLIB_LORAWAN_BLOCK_FCNT_POS (10)
135
136// payload encryption block layout
137#define RADIOLIB_LORAWAN_ENC_BLOCK_MAGIC (0x01)
138#define RADIOLIB_LORAWAN_ENC_BLOCK_COUNTER_ID_POS (4)
139#define RADIOLIB_LORAWAN_ENC_BLOCK_COUNTER_POS (15)
140
141// payload MIC blocks layout
142#define RADIOLIB_LORAWAN_MIC_BLOCK_MAGIC (0x49)
143#define RADIOLIB_LORAWAN_MIC_BLOCK_LEN_POS (15)
144#define RADIOLIB_LORAWAN_MIC_DATA_RATE_POS (3)
145#define RADIOLIB_LORAWAN_MIC_CH_INDEX_POS (4)
146
147// maximum allowed dwell time on bands that implement dwell time limitations
148#define RADIOLIB_LORAWAN_DWELL_TIME (400)
149
150// unused frame counter value
151#define RADIOLIB_LORAWAN_FCNT_NONE (0xFFFFFFFF)
152
153// TR013 CSMA recommended values
154#define RADIOLIB_LORAWAN_DIFS_DEFAULT (2)
155#define RADIOLIB_LORAWAN_BACKOFF_MAX_DEFAULT (6)
156#define RADIOLIB_LORAWAN_MAX_CHANGES_DEFAULT (4)
157
158// MAC commands
159#define RADIOLIB_LORAWAN_NUM_MAC_COMMANDS (24)
160
161#define RADIOLIB_LORAWAN_MAC_RESET (0x01)
162#define RADIOLIB_LORAWAN_MAC_LINK_CHECK (0x02)
163#define RADIOLIB_LORAWAN_MAC_LINK_ADR (0x03)
164#define RADIOLIB_LORAWAN_MAC_DUTY_CYCLE (0x04)
165#define RADIOLIB_LORAWAN_MAC_RX_PARAM_SETUP (0x05)
166#define RADIOLIB_LORAWAN_MAC_DEV_STATUS (0x06)
167#define RADIOLIB_LORAWAN_MAC_NEW_CHANNEL (0x07)
168#define RADIOLIB_LORAWAN_MAC_RX_TIMING_SETUP (0x08)
169#define RADIOLIB_LORAWAN_MAC_TX_PARAM_SETUP (0x09)
170#define RADIOLIB_LORAWAN_MAC_DL_CHANNEL (0x0A)
171#define RADIOLIB_LORAWAN_MAC_REKEY (0x0B)
172#define RADIOLIB_LORAWAN_MAC_ADR_PARAM_SETUP (0x0C)
173#define RADIOLIB_LORAWAN_MAC_DEVICE_TIME (0x0D)
174#define RADIOLIB_LORAWAN_MAC_FORCE_REJOIN (0x0E)
175#define RADIOLIB_LORAWAN_MAC_REJOIN_PARAM_SETUP (0x0F)
176#define RADIOLIB_LORAWAN_MAC_DEVICE_MODE (0x20)
177#define RADIOLIB_LORAWAN_MAC_PROPRIETARY (0x80)
178
179// the maximum number of simultaneously available channels
180#define RADIOLIB_LORAWAN_MAX_NUM_DYNAMIC_CHANNELS (16)
181#define RADIOLIB_LORAWAN_MAX_NUM_SUBBANDS (12)
182#define RADIOLIB_LORAWAN_MAX_NUM_FIXED_CHANNELS (96)
183
184// maximum MAC command sizes
185#define RADIOLIB_LORAWAN_MAX_MAC_COMMAND_LEN_DOWN (5)
186#define RADIOLIB_LORAWAN_MAX_MAC_COMMAND_LEN_UP (2)
187#define RADIOLIB_LORAWAN_MAX_NUM_ADR_COMMANDS (8)
188
189#define RADIOLIB_LORAWAN_MAX_PAYLOAD_SIZE (242)
190
191// session states
192#define RADIOLIB_LORAWAN_SESSION_NONE (0x00)
193#define RADIOLIB_LORAWAN_SESSION_ACTIVATING (0x01)
194#define RADIOLIB_LORAWAN_SESSION_PENDING (0x02)
195#define RADIOLIB_LORAWAN_SESSION_ACTIVE (0x03)
196
197// threshold at which sleeping via user callback enabled, in ms
198#define RADIOLIB_LORAWAN_DELAY_SLEEP_THRESHOLD (50)
199
206 const uint8_t cid;
207
209 const uint8_t lenDn;
210
212 const uint8_t lenUp;
213
215 const bool persist;
216
218 const bool user;
219};
220
221#define RADIOLIB_LORAWAN_MAC_COMMAND_NONE { .cid = 0, .lenDn = 0, .lenUp = 0, .persist = false, .user = false }
222
223// maximum number of simultaneously available multicast groups
224#define RADIOLIB_LORAWAN_MAX_NUM_MC_GROUPS (4)
225
228 uint8_t cls;
229
231 uint32_t mcAddr;
232
234 uint8_t mcAppSKey[RADIOLIB_AES128_KEY_SIZE];
235
237 uint8_t mcNwkSKey[RADIOLIB_AES128_KEY_SIZE];
238
240 uint32_t mcFCnt;
241
243 uint32_t mcFCntMax;
244
246 uint32_t rxFCnt;
247
249 uint32_t mcFreq;
250
252 uint8_t mcDr;
253};
254
255#define RADIOLIB_MULTICAST_GROUP_NONE \
256 { .cls = RADIOLIB_LORAWAN_CLASS_A, .mcAddr = 0, .mcAppSKey = { 0 }, .mcNwkSKey = { 0 }, \
257 .mcFCnt = 0, .mcFCntMax = 0xFFFFFFFF, .rxFCnt = 0, .mcFreq = 0, .mcDr = RADIOLIB_LORAWAN_DATA_RATE_UNUSED }
258
259// currently known packages with reserved FPorts:
260// TS007 (MultiPackage), TS009 (Certification), TS011 (Relay)
261#define RADIOLIB_LORAWAN_NUM_RESERVED_PACKAGES (3)
262
270
273};
274
275#define RADIOLIB_LORAWAN_NONCES_VERSION_VAL (0x0003)
276
277enum LoRaWANSchemeBase_t {
278 RADIOLIB_LORAWAN_NONCES_START = 0x00,
279 RADIOLIB_LORAWAN_NONCES_VERSION = RADIOLIB_LORAWAN_NONCES_START, // 2 bytes
280 RADIOLIB_LORAWAN_NONCES_MODE = RADIOLIB_LORAWAN_NONCES_VERSION + sizeof(uint16_t), // 2 bytes
281 RADIOLIB_LORAWAN_NONCES_PLAN = RADIOLIB_LORAWAN_NONCES_MODE + sizeof(uint16_t), // 1 byte
282 RADIOLIB_LORAWAN_NONCES_CHECKSUM = RADIOLIB_LORAWAN_NONCES_PLAN + sizeof(uint8_t), // 2 bytes
283 RADIOLIB_LORAWAN_NONCES_DEV_NONCE = RADIOLIB_LORAWAN_NONCES_CHECKSUM + sizeof(uint16_t), // 2 bytes
284 RADIOLIB_LORAWAN_NONCES_JOIN_NONCE = RADIOLIB_LORAWAN_NONCES_DEV_NONCE + sizeof(uint16_t), // 3 bytes
285 RADIOLIB_LORAWAN_NONCES_SIGNATURE = RADIOLIB_LORAWAN_NONCES_JOIN_NONCE + 3, // 2 bytes
286 RADIOLIB_LORAWAN_NONCES_BUF_SIZE = RADIOLIB_LORAWAN_NONCES_SIGNATURE + sizeof(uint16_t) // Nonces buffer size
287};
288
289enum LoRaWANSchemeSession_t {
290 RADIOLIB_LORAWAN_SESSION_START = 0x00,
291 RADIOLIB_LORAWAN_SESSION_STATUS = RADIOLIB_LORAWAN_SESSION_START, // 1 byte
292 RADIOLIB_LORAWAN_SESSION_NWK_SENC_KEY = RADIOLIB_LORAWAN_SESSION_STATUS + 1, // 16 bytes
293 RADIOLIB_LORAWAN_SESSION_APP_SKEY = RADIOLIB_LORAWAN_SESSION_NWK_SENC_KEY + RADIOLIB_AES128_KEY_SIZE, // 16 bytes
294 RADIOLIB_LORAWAN_SESSION_FNWK_SINT_KEY = RADIOLIB_LORAWAN_SESSION_APP_SKEY + RADIOLIB_AES128_KEY_SIZE, // 16 bytes
295 RADIOLIB_LORAWAN_SESSION_SNWK_SINT_KEY = RADIOLIB_LORAWAN_SESSION_FNWK_SINT_KEY + RADIOLIB_AES128_KEY_SIZE, // 16 bytes
296 RADIOLIB_LORAWAN_SESSION_DEV_ADDR = RADIOLIB_LORAWAN_SESSION_SNWK_SINT_KEY + RADIOLIB_AES128_KEY_SIZE, // 4 bytes
297 RADIOLIB_LORAWAN_SESSION_NONCES_SIGNATURE = RADIOLIB_LORAWAN_SESSION_DEV_ADDR + sizeof(uint32_t), // 2 bytes
298 RADIOLIB_LORAWAN_SESSION_FCNT_UP = RADIOLIB_LORAWAN_SESSION_NONCES_SIGNATURE + sizeof(uint16_t), // 4 bytes
299 RADIOLIB_LORAWAN_SESSION_N_FCNT_DOWN = RADIOLIB_LORAWAN_SESSION_FCNT_UP + sizeof(uint32_t), // 4 bytes
300 RADIOLIB_LORAWAN_SESSION_A_FCNT_DOWN = RADIOLIB_LORAWAN_SESSION_N_FCNT_DOWN + sizeof(uint32_t), // 4 bytes
301 RADIOLIB_LORAWAN_SESSION_ADR_FCNT = RADIOLIB_LORAWAN_SESSION_A_FCNT_DOWN + sizeof(uint32_t), // 4 bytes
302 RADIOLIB_LORAWAN_SESSION_CONF_FCNT_UP = RADIOLIB_LORAWAN_SESSION_ADR_FCNT + sizeof(uint32_t), // 4 bytes
303 RADIOLIB_LORAWAN_SESSION_CONF_FCNT_DOWN = RADIOLIB_LORAWAN_SESSION_CONF_FCNT_UP + sizeof(uint32_t), // 4 bytes
304 RADIOLIB_LORAWAN_SESSION_RJ_COUNT0 = RADIOLIB_LORAWAN_SESSION_CONF_FCNT_DOWN + sizeof(uint32_t), // 2 bytes
305 RADIOLIB_LORAWAN_SESSION_RJ_COUNT1 = RADIOLIB_LORAWAN_SESSION_RJ_COUNT0 + sizeof(uint16_t), // 2 bytes
306 RADIOLIB_LORAWAN_SESSION_RX_A_FCNT = RADIOLIB_LORAWAN_SESSION_RJ_COUNT1 + sizeof(uint16_t), // 4 bytes
307 RADIOLIB_LORAWAN_SESSION_VERSION = RADIOLIB_LORAWAN_SESSION_RX_A_FCNT + sizeof(uint32_t), // 1 byte
308 RADIOLIB_LORAWAN_SESSION_CLASS = RADIOLIB_LORAWAN_SESSION_VERSION + 1, // 1 byte
309 RADIOLIB_LORAWAN_SESSION_LINK_ADR = RADIOLIB_LORAWAN_SESSION_CLASS + sizeof(uint8_t), // 14 bytes
310 RADIOLIB_LORAWAN_SESSION_DUTY_CYCLE = RADIOLIB_LORAWAN_SESSION_LINK_ADR + 14, // 1 byte
311 RADIOLIB_LORAWAN_SESSION_RX_PARAM_SETUP = RADIOLIB_LORAWAN_SESSION_DUTY_CYCLE + 1, // 4 bytes
312 RADIOLIB_LORAWAN_SESSION_RX_TIMING_SETUP = RADIOLIB_LORAWAN_SESSION_RX_PARAM_SETUP + 4, // 1 byte
313 RADIOLIB_LORAWAN_SESSION_TX_PARAM_SETUP = RADIOLIB_LORAWAN_SESSION_RX_TIMING_SETUP + 1, // 1 byte
314 RADIOLIB_LORAWAN_SESSION_ADR_PARAM_SETUP = RADIOLIB_LORAWAN_SESSION_TX_PARAM_SETUP + 1, // 1 byte
315 RADIOLIB_LORAWAN_SESSION_REJOIN_PARAM_SETUP = RADIOLIB_LORAWAN_SESSION_ADR_PARAM_SETUP + 1, // 1 byte
316 RADIOLIB_LORAWAN_SESSION_UL_CHANNELS = RADIOLIB_LORAWAN_SESSION_REJOIN_PARAM_SETUP + 1, // 16*5 bytes
317 RADIOLIB_LORAWAN_SESSION_DL_CHANNELS = RADIOLIB_LORAWAN_SESSION_UL_CHANNELS + RADIOLIB_LORAWAN_MAX_NUM_DYNAMIC_CHANNELS*5, // 16*4 bytes
318 RADIOLIB_LORAWAN_SESSION_AVAILABLE_CHANNELS = RADIOLIB_LORAWAN_SESSION_DL_CHANNELS + RADIOLIB_LORAWAN_MAX_NUM_DYNAMIC_CHANNELS*4, // 2 bytes
319 RADIOLIB_LORAWAN_SESSION_MAC_QUEUE = RADIOLIB_LORAWAN_SESSION_AVAILABLE_CHANNELS + RADIOLIB_LORAWAN_MAX_NUM_SUBBANDS, // 12 bytes // 15 bytes
320 RADIOLIB_LORAWAN_SESSION_MAC_QUEUE_LEN = RADIOLIB_LORAWAN_SESSION_MAC_QUEUE + RADIOLIB_LORAWAN_FHDR_FOPTS_MAX_LEN, // 1 byte
321 RADIOLIB_LORAWAN_SESSION_SIGNATURE = RADIOLIB_LORAWAN_SESSION_MAC_QUEUE_LEN + sizeof(uint8_t), // 2 bytes
322 RADIOLIB_LORAWAN_SESSION_BUF_SIZE = RADIOLIB_LORAWAN_SESSION_SIGNATURE + sizeof(uint16_t) // Session buffer size
323};
324
332 uint8_t idx;
333
335 uint32_t freq;
336
338 uint8_t drMin;
339
341 uint8_t drMax;
342
344 uint8_t dr;
345};
346
347// alias for unused channel
348#define RADIOLIB_LORAWAN_CHANNEL_NONE { .idx = 0, .freq = 0, .drMin = 0, .drMax = 0, \
349 .dr = RADIOLIB_LORAWAN_DATA_RATE_UNUSED }
350
358 uint8_t numChannels;
359
361 uint32_t freqStart;
362
364 uint32_t freqStep;
365
367 uint8_t drMin;
368
370 uint8_t drMax;
371
374};
375
376// alias for unused channel span
377#define RADIOLIB_LORAWAN_CHANNEL_SPAN_NONE { .numChannels = 0, .freqStart = 0, .freqStep = 0, .drMin = 0, .drMax = 0, .drJoinRequest = RADIOLIB_LORAWAN_DATA_RATE_UNUSED }
378
380 ModemType_t modem;
381 DataRate_t dr;
383};
384
385#define RADIOLIB_DATARATE_NONE { .modem = RADIOLIB_MODEM_NONE, .dr = {.lora = {0, 0, 0}}, .pc = {.lora = { 8, 0, 0, 0}}}
386
393 uint8_t bandNum;
394
396 uint8_t bandType;
397
399 uint32_t freqMin;
400
402 uint32_t freqMax;
403
405 uint8_t payloadLenMax[RADIOLIB_LORAWAN_CHANNEL_NUM_DATARATES];
406
408 int8_t powerMax;
409
412
415
418
421
424
427
429 uint8_t numTxSpans;
430
433
436
437 uint8_t rx1DrTable[RADIOLIB_LORAWAN_CHANNEL_NUM_DATARATES][8];
438
441
444
447
449 LoRaWANDataRate_t dataRates[RADIOLIB_LORAWAN_CHANNEL_NUM_DATARATES];
450};
451
452// supported bands
453extern const LoRaWANBand_t EU868;
454extern const LoRaWANBand_t US915;
455extern const LoRaWANBand_t EU433;
456extern const LoRaWANBand_t AU915;
457extern const LoRaWANBand_t CN470;
458extern const LoRaWANBand_t AS923;
459extern const LoRaWANBand_t AS923_2;
460extern const LoRaWANBand_t AS923_3;
461extern const LoRaWANBand_t AS923_4;
462extern const LoRaWANBand_t KR920;
463extern const LoRaWANBand_t IN865;
464
469enum LoRaWANBandNum_t {
470 BandEU868,
471 BandUS915,
472 BandEU433,
473 BandAU915,
474 BandCN470,
475 BandAS923,
476 BandAS923_2,
477 BandAS923_3,
478 BandAS923_4,
479 BandKR920,
480 BandIN865,
481 BandLast
482};
483
484// provide easy access to the number of currently supported bands
485#define RADIOLIB_LORAWAN_NUM_SUPPORTED_BANDS (BandLast - BandEU868)
486
487// array of currently supported bands
488extern const LoRaWANBand_t* LoRaWANBands[];
489
496 bool newSession = false;
497
499 uint16_t devNonce = 0;
500
502 uint32_t joinNonce = 0;
503};
504
511 uint8_t dir;
512
515
519
522
524 uint8_t datarate;
525
527 float freq;
528
530 int16_t power;
531
533 uint32_t fCnt;
534
536 uint8_t fPort;
537
539 uint8_t nbTrans;
540
543
545 uint8_t mcGroupId;
546};
547
553 public:
554
561 LoRaWANNode(PhysicalLayer* phy, const LoRaWANBand_t* band, uint8_t subBand = 0);
562
567 uint8_t* getBufferNonces();
568
574 int16_t setBufferNonces(const uint8_t* persistentBuffer);
575
579 void clearSession();
580
585 uint8_t* getBufferSession();
586
592 int16_t setBufferSession(const uint8_t* persistentBuffer);
593
602 int16_t beginOTAA(uint64_t joinEUI, uint64_t devEUI, const uint8_t* nwkKey, const uint8_t* appKey);
603
614 int16_t beginABP(uint32_t addr, const uint8_t* fNwkSIntKey, const uint8_t* sNwkSIntKey, const uint8_t* nwkSEncKey, const uint8_t* appSKey);
615
621 virtual int16_t activateOTAA(LoRaWANJoinEvent_t *joinEvent = NULL);
622
628 virtual int16_t activateABP();
629
631 bool isActivated();
632
634 int16_t setClass(uint8_t cls);
635
648 int16_t startMulticastSession(uint8_t cls, uint32_t mcAddr, const uint8_t* mcAppSKey, const uint8_t* mcNwkSKey,
649 uint32_t mcFCntMin = 0, uint32_t mcFCntMax = 0xFFFFFFFF, uint32_t mcFreq = 0,
650 uint8_t mcDr = RADIOLIB_LORAWAN_DATA_RATE_UNUSED);
651
659 int16_t startMulticastSession(uint8_t id, MulticastGroup_t* mcGroup);
660
667 bool stopMulticastSession(uint8_t id, bool addRxFCnt = false);
668
669 #if defined(RADIOLIB_BUILD_ARDUINO)
682 virtual int16_t sendReceive(const String& strUp, uint8_t fPort, String& strDown, bool isConfirmed = false, LoRaWANEvent_t* eventUp = NULL, LoRaWANEvent_t* eventDown = NULL);
683 #endif
684
696 virtual int16_t sendReceive(const char* strUp, uint8_t fPort, bool isConfirmed = false, LoRaWANEvent_t* eventUp = NULL, LoRaWANEvent_t* eventDown = NULL);
697
711 virtual int16_t sendReceive(const char* strUp, uint8_t fPort, uint8_t* dataDown, size_t* lenDown, bool isConfirmed = false, LoRaWANEvent_t* eventUp = NULL, LoRaWANEvent_t* eventDown = NULL);
712
725 virtual int16_t sendReceive(const uint8_t* dataUp, size_t lenUp, uint8_t fPort = 1, bool isConfirmed = false, LoRaWANEvent_t* eventUp = NULL, LoRaWANEvent_t* eventDown = NULL);
726
741 virtual int16_t sendReceive(const uint8_t* dataUp, size_t lenUp, uint8_t fPort, uint8_t* dataDown, size_t* lenDown, bool isConfirmed = false, LoRaWANEvent_t* eventUp = NULL, LoRaWANEvent_t* eventDown = NULL);
742
751 int16_t getDownlinkClassC(uint8_t* dataDown, size_t* lenDown, LoRaWANEvent_t* eventDown = NULL);
752
760 int16_t sendMacCommandReq(uint8_t cid);
761
768 int16_t getMacLinkCheckAns(uint8_t* margin, uint8_t* gwCnt);
769
780 int16_t getMacDeviceTimeAns(uint32_t* timestamp, uint16_t* milliseconds, bool returnUnix = true);
781
787 int16_t setDatarate(uint8_t drUp);
788
794 int16_t setTxPower(int8_t txPower);
795
802 int16_t setRx2Dr(uint8_t dr);
803
808 void setADR(bool enable = true);
809
816 void setDutyCycle(bool enable = true, RadioLibTime_t msPerHour = 0);
817
824 void setDwellTime(bool enable, RadioLibTime_t msPerUplink = 0);
825
833 void setCSMA(bool csmaEnabled, uint8_t maxChanges = 4, uint8_t backoffMax = 0, uint8_t difsSlots = 2);
834
840 void setDeviceStatus(uint8_t battLevel);
841
847 void setActivityLeds(const uint32_t pins[4]);
848
857
862 const LoRaWANBand_t* getBand();
863
868 uint8_t getClass();
869
874 uint8_t getVersionMajor();
875
880 uint32_t getFCntUp();
881
886 uint32_t getNFCntDown();
887
892 uint32_t getAFCntDown();
893
897 uint32_t getRxFCnt();
898
902 uint32_t getRxFCntMulticast(uint8_t mcGroupId);
903
908 uint32_t getDevAddr();
909
915
920 uint8_t getMacUplinkLen();
921
930
933
938 virtual uint8_t getMaxPayloadLen();
939
944 uint8_t getMulticastClass();
945
947 typedef void (*SleepCb_t)(RadioLibTime_t ms);
948
956 void setSleepFunction(SleepCb_t cb);
957
963 int16_t addAppPackage(uint8_t fPort);
964
970 int16_t addNwkPackage(uint8_t fPort);
971
976 void removePackage(uint8_t fPort);
977
991
992#if !RADIOLIB_GODMODE
993 protected:
994#endif
995 PhysicalLayer* phyLayer = NULL;
996 const LoRaWANBand_t* band = NULL;
997
998 // a buffer that holds all LW base parameters that should persist at all times!
999 uint8_t bufferNonces[RADIOLIB_LORAWAN_NONCES_BUF_SIZE] = { 0 };
1000
1001 // a buffer that holds all LW session parameters that preferably persist, but can be afforded to get lost
1002 uint8_t bufferSession[RADIOLIB_LORAWAN_SESSION_BUF_SIZE] = { 0 };
1003
1004 uint8_t fOptsUp[RADIOLIB_LORAWAN_FHDR_FOPTS_MAX_LEN] = { 0 };
1005 uint8_t fOptsDown[RADIOLIB_LORAWAN_FHDR_FOPTS_MAX_LEN] = { 0 };
1006 uint8_t fOptsUpLen = 0;
1007 uint8_t fOptsDownLen = 0;
1008
1009 uint16_t lwMode = RADIOLIB_LORAWAN_MODE_NONE;
1010 uint8_t lwClass = RADIOLIB_LORAWAN_CLASS_A;
1011 uint8_t sessionStatus = RADIOLIB_LORAWAN_SESSION_NONE;
1012
1013 uint64_t joinEUI = 0;
1014 uint64_t devEUI = 0;
1015 uint8_t nwkKey[RADIOLIB_AES128_KEY_SIZE] = { 0 };
1016 uint8_t appKey[RADIOLIB_AES128_KEY_SIZE] = { 0 };
1017
1018 // the following is either provided by the network server (OTAA)
1019 // or directly entered by the user (ABP)
1020 uint32_t devAddr = 0;
1021 uint8_t appSKey[RADIOLIB_AES128_KEY_SIZE] = { 0 };
1022 uint8_t fNwkSIntKey[RADIOLIB_AES128_KEY_SIZE] = { 0 };
1023 uint8_t sNwkSIntKey[RADIOLIB_AES128_KEY_SIZE] = { 0 };
1024 uint8_t nwkSEncKey[RADIOLIB_AES128_KEY_SIZE] = { 0 };
1025 uint8_t jSIntKey[RADIOLIB_AES128_KEY_SIZE] = { 0 };
1026
1027 uint16_t keyCheckSum = 0;
1028
1029 // device-specific parameters, persistent through sessions
1030 uint16_t devNonce = 0;
1031 uint32_t joinNonce = 0;
1032
1033 // session-specific parameters
1034 uint8_t adrLimitExp = RADIOLIB_LORAWAN_ADR_ACK_LIMIT_EXP;
1035 uint8_t adrDelayExp = RADIOLIB_LORAWAN_ADR_ACK_DELAY_EXP;
1036 uint8_t nbTrans = 1; // Number of allowed frame retransmissions
1037 uint8_t txPowerSteps = 0;
1038 uint8_t txPowerMax = 0;
1039 uint32_t fCntUp = 0;
1040 uint32_t aFCntDown = 0;
1041 uint32_t nFCntDown = 0;
1042 uint32_t confFCntUp = RADIOLIB_LORAWAN_FCNT_NONE;
1043 uint32_t confFCntDown = RADIOLIB_LORAWAN_FCNT_NONE;
1044 uint32_t adrFCnt = 0;
1045 uint32_t rxAFCnt = 0; // Number of received downlinks
1046
1047 // ADR is enabled by default
1048 bool adrEnabled = true;
1049
1050 // duty cycle is set upon initialization and activated in regions that impose this
1051 bool dutyCycleEnabled = false;
1052 uint32_t dutyCycle = 0;
1053
1054 // dwell time is set upon initialization and activated in regions that impose this
1055 uint16_t dwellTimeUp = 0;
1056 uint16_t dwellTimeDn = 0;
1057
1058 RadioLibTime_t tUplink = 0; // scheduled uplink transmission time (internal clock)
1059 RadioLibTime_t tDownlink = 0; // time at end of downlink reception
1060
1061 // multicast groups
1062 MulticastGroup_t mcGroups[RADIOLIB_LORAWAN_MAX_NUM_MC_GROUPS];
1063
1064 // enabled app/nwk packages in the Reserved FPort range
1065 LoRaWANPackage_t packages[RADIOLIB_LORAWAN_NUM_RESERVED_PACKAGES];
1066
1067 // enable/disable CSMA for LoRaWAN
1068 bool csmaEnabled = false;
1069
1070 // maximum number of channel hops during CSMA
1071 uint8_t maxChanges = RADIOLIB_LORAWAN_MAX_CHANGES_DEFAULT;
1072
1073 // number of backoff slots to be checked after DIFS phase.
1074 // A random BO avoids collisions in the case where two or more nodes start the CSMA
1075 // process at the same time.
1076 uint8_t backoffMax = RADIOLIB_LORAWAN_BACKOFF_MAX_DEFAULT;
1077
1078 // number of CADs to estimate a clear channel
1079 uint8_t difsSlots = RADIOLIB_LORAWAN_DIFS_DEFAULT;
1080
1081 // dynamic channels
1082 LoRaWANChannel_t dynamicChannels[2][RADIOLIB_LORAWAN_MAX_NUM_DYNAMIC_CHANNELS];
1083
1084 // masks: which channels are defined/active; flags: which should be used next
1085 uint16_t channelMasks[RADIOLIB_LORAWAN_MAX_NUM_FIXED_CHANNELS / 16] = { 0 };
1086 uint16_t channelFlags[RADIOLIB_LORAWAN_MAX_NUM_FIXED_CHANNELS / 16] = { 0 };
1087
1088 // currently configured channels for Tx, Rx1, Rx2, RxBC
1089 LoRaWANChannel_t channels[4] = { RADIOLIB_LORAWAN_CHANNEL_NONE, RADIOLIB_LORAWAN_CHANNEL_NONE,
1090 RADIOLIB_LORAWAN_CHANNEL_NONE, RADIOLIB_LORAWAN_CHANNEL_NONE };
1091
1092 // delays between the uplink and Rx windows
1093 // the first field is meaningless, but is used for offsetting the Rx windows
1094 RadioLibTime_t rxDelays[4] = { 0,
1095 RADIOLIB_LORAWAN_RECEIVE_DELAY_1_MS,
1096 RADIOLIB_LORAWAN_RECEIVE_DELAY_2_MS,
1097 0 };
1098
1099 uint32_t ledPins[4] = { RADIOLIB_NC, RADIOLIB_NC, RADIOLIB_NC, RADIOLIB_NC };
1100
1101 // offset between Tx and Rx1 (such that Rx1 has equal or lower DR)
1102 uint8_t rx1DrOffset = 0;
1103
1104 // LoRaWAN revision (1.0 vs 1.1)
1105 uint8_t rev = 0;
1106
1107 // Time on Air of last uplink
1108 RadioLibTime_t lastToA = 0;
1109
1110 // timestamp to measure the Rx1/2 delay (from uplink end)
1111 RadioLibTime_t tUplinkEnd = 0;
1112
1113 // duration of SPI transaction for phyLayer->launchMode()
1114 RadioLibTime_t launchDuration = 0;
1115
1116 // device status - battery level
1117 uint8_t battLevel = 0xFF;
1118
1119 // indicates whether an uplink has MAC commands as payload
1120 bool isMACPayload = false;
1121
1122 // save the selected sub-band in case this must be restored in ADR control
1123 uint8_t subBand = 0;
1124
1125 // user-provided sleep callback
1126 SleepCb_t sleepCb = nullptr;
1127
1128 // this will reset the device credentials, so the device starts completely new
1129 void clearNonces();
1130
1131 // setup an empty session with default parameters
1132 void createSession();
1133
1134 // setup Join-Request payload
1135 void composeJoinRequest(uint8_t* joinRequestMsg);
1136
1137 // extract Join-Accept payload and start a new session
1138 int16_t processJoinAccept(LoRaWANJoinEvent_t *joinEvent);
1139
1140 // a join-accept can piggy-back a set of channels or channel masks
1141 void processCFList(const uint8_t* cfList);
1142
1143 // check whether payload length and fport are allowed
1144 int16_t isValidUplink(size_t len, uint8_t fPort);
1145
1146 // perform ADR backoff
1147 void adrBackoff();
1148
1149 // create an encrypted uplink buffer, composing metadata, user data and MAC data
1150 void composeUplink(const uint8_t* in, uint8_t lenIn, uint8_t* out, uint8_t fPort, bool isConfirmed);
1151
1152 // generate and set the MIC of an uplink buffer (depends on selected channels)
1153 void micUplink(uint8_t* inOut, size_t lenInOut);
1154
1155 // transmit uplink buffer on a specified channel
1156 int16_t transmitUplink(const LoRaWANChannel_t* chnl, uint8_t* in, uint8_t len);
1157
1158 // handle one of the Class A receive windows with a given channel and certain timestamps
1159 int16_t receiveClassA(uint8_t dir, const LoRaWANChannel_t* dlChannel, uint8_t window, const RadioLibTime_t dlDelay, RadioLibTime_t tReference);
1160
1161 // handle a Class C receive window with timeout (between Class A windows) or without (between uplinks)
1162 int16_t receiveClassC(RadioLibTime_t timeout = 0);
1163
1164 // open a series of Class A (and C) downlinks
1165 virtual int16_t receiveDownlink();
1166
1167 // extract downlink payload and process MAC commands
1168 int16_t parseDownlink(uint8_t* data, size_t* len, uint8_t window, LoRaWANEvent_t* event = NULL);
1169
1170 // execute mac command, return the number of processed bytes for sequential processing
1171 bool execMacCommand(uint8_t cid, uint8_t* optIn, uint8_t lenIn);
1172 bool execMacCommand(uint8_t cid, uint8_t* optIn, uint8_t lenIn, uint8_t* optOut);
1173
1174 // possible override for additional MAC commands that are not in the base specification
1175 virtual bool derivedMacHandler(uint8_t cid, uint8_t* optIn, uint8_t lenIn, uint8_t* optOut);
1176
1177 // pre-process a (set of) LinkAdrReq commands into one super-channel-mask + Tx/Dr/NbTrans fields
1178 void preprocessMacLinkAdr(uint8_t* mPtr, uint8_t cLen, uint8_t* mAdrOpt);
1179
1180 // post-process a (set of) LinkAdrAns commands depending on LoRaWAN version
1181 void postprocessMacLinkAdr(uint8_t* ack, uint8_t cLen);
1182
1183 // get the properties of a MAC command given a certain command ID
1184 int16_t getMacCommand(uint8_t cid, LoRaWANMacCommand_t* cmd);
1185
1186 // possible override for additional MAC commands that are not in the base specification
1187 virtual int16_t derivedMacFinder(uint8_t cid, LoRaWANMacCommand_t* cmd);
1188
1189 // get the length of a certain MAC command in a specific direction (up/down)
1190 // if inclusive is true, add one for the CID byte
1191 // include payload in case the MAC command has a dynamic length
1192 virtual int16_t getMacLen(uint8_t cid, uint8_t* len, uint8_t dir, bool inclusive = false, uint8_t* payload = NULL);
1193
1194 // find out of a MAC command should persist destruction
1195 // in uplink direction, some commands must persist if no downlink is received
1196 // in downlink direction, the user-accessible MAC commands remain available for retrieval
1197 bool isPersistentMacCommand(uint8_t cid, uint8_t dir);
1198
1199 // push MAC command to queue, done by copy
1200 int16_t pushMacCommand(uint8_t cid, const uint8_t* cOcts, uint8_t* out, uint8_t* lenOut, uint8_t dir);
1201
1202 // retrieve the payload of a certain MAC command, if present in the buffer
1203 int16_t getMacPayload(uint8_t cid, const uint8_t* in, uint8_t lenIn, uint8_t* out, uint8_t dir);
1204
1205 // delete a specific MAC command from queue, indicated by the command ID
1206 int16_t deleteMacCommand(uint8_t cid, uint8_t* inOut, uint8_t* lenInOut, uint8_t dir);
1207
1208 // clear a MAC buffer, possible retaining persistent MAC commands
1209 void clearMacCommands(uint8_t* inOut, uint8_t* lenInOut, uint8_t dir);
1210
1211 // configure the common physical layer properties (frequency, sync word etc.)
1212 int16_t setPhyProperties(const LoRaWANChannel_t* chnl, uint8_t dir, int8_t pwr, size_t pre = 0);
1213
1214 // Performs CSMA as per LoRa Alliance Technical Recommendation 13 (TR-013).
1215 bool csmaChannelClear(uint8_t difs, uint8_t numBackoff);
1216
1217 // perform a single CAD operation for the under SF/CH combination. Returns either busy or otherwise.
1218 bool cadChannelClear();
1219
1220 // enable all default channels on top of the current channels
1221 void enableDefaultChannels(bool addDynamic = false);
1222
1223 // calculate which channels are available given the current datarate
1224 // returns true if there is any such channel, false otherwise
1225 bool calculateChannelFlags();
1226
1227 // select a set of random TX/RX channels for up- and downlink
1228 int16_t selectChannels();
1229
1230 // get the properties of the first active multicast session, if any
1231 uint32_t getMulticastFrequency();
1232 uint8_t getMulticastDatarate();
1233 bool isMulticastDevAddr(uint32_t devAddr, uint8_t* mcGroupId);
1234
1235 // method to generate message integrity code
1236 uint32_t generateMIC(const uint8_t* msg, size_t len, uint8_t* key);
1237
1238 // method to verify message integrity code
1239 // it assumes that the MIC is the last 4 bytes of the message
1240 bool verifyMIC(uint8_t* msg, size_t len, uint8_t* key);
1241
1242 // function to encrypt and decrypt payloads (regular uplink/downlink)
1243 void processAES(const uint8_t* in, size_t len, uint8_t* key, uint8_t* out, uint32_t addr, uint32_t fCnt, uint8_t dir, uint8_t ctrId, bool counter);
1244
1245 // common function add an app/nwk package, used by both addAppPackage and addNwkPackage
1246 int16_t addPackage(uint8_t fPort, bool isApp);
1247
1248 // function that allows sleeping via user-provided callback
1249 void sleepDelay(RadioLibTime_t ms, bool radioOff = true);
1250
1251 // 16-bit checksum method that takes a uint8_t array of even length and calculates the checksum
1252 static uint16_t checkSum16(const uint8_t *key, uint16_t keyLen);
1253
1254 // check the integrity of a buffer using a 16-bit checksum located in the last two bytes of the buffer
1255 static int16_t checkBufferCommon(const uint8_t *buffer, uint16_t size);
1256
1257 // network-to-host conversion method - takes data from network packet and converts it to the host endians
1258 template<typename T>
1259 static T ntoh(const uint8_t* buff, size_t size = 0);
1260
1261 // host-to-network conversion method - takes data from host variable and and converts it to network packet endians
1262 template<typename T>
1263 static void hton(uint8_t* buff, T val, size_t size = 0);
1264};
1265
1266template<typename T>
1267T LoRaWANNode::ntoh(const uint8_t* buff, size_t size) {
1268 const uint8_t* buffPtr = buff;
1269 size_t targetSize = sizeof(T);
1270 if(size != 0) {
1271 targetSize = size;
1272 }
1273 T res = 0;
1274 for(size_t i = 0; i < targetSize; i++) {
1275 res |= (uint32_t)(*(buffPtr++)) << 8*i;
1276 }
1277 return(res);
1278}
1279
1280template<typename T>
1281void LoRaWANNode::hton(uint8_t* buff, T val, size_t size) {
1282 uint8_t* buffPtr = buff;
1283 size_t targetSize = sizeof(T);
1284 if(size != 0) {
1285 targetSize = size;
1286 }
1287 for(size_t i = 0; i < targetSize; i++) {
1288 *(buffPtr++) = val >> 8*i;
1289 }
1290}
1291
1292#endif
LoRaWAN-compatible node (class A device).
Definition LoRaWAN.h:552
void clearSession()
Clear an active session. This requires the device to rejoin the network.
Definition LoRaWAN.cpp:354
virtual int16_t sendReceive(const char *strUp, uint8_t fPort, bool isConfirmed=false, LoRaWANEvent_t *eventUp=NULL, LoRaWANEvent_t *eventDown=NULL)
Send a message to the server and wait for a downlink during Rx1 and/or Rx2 window.
Definition LoRaWAN.cpp:74
void setSleepFunction(SleepCb_t cb)
Set custom delay/sleep function callback. If set, LoRaWAN node will call this function to wait for pe...
Definition LoRaWAN.cpp:3822
int16_t startMulticastSession(uint8_t cls, uint32_t mcAddr, const uint8_t *mcAppSKey, const uint8_t *mcNwkSKey, uint32_t mcFCntMin=0, uint32_t mcFCntMax=0xFFFFFFFF, uint32_t mcFreq=0, uint8_t mcDr=RADIOLIB_LORAWAN_DATA_RATE_UNUSED)
Start a Multicast session.
Definition LoRaWAN.cpp:1164
int16_t setDatarate(uint8_t drUp)
Set uplink datarate. This should not be used when ADR is enabled.
Definition LoRaWAN.cpp:3160
void scheduleTransmission(RadioLibTime_t tUplink)
Set the exact time a transmission should occur. Note: this is the internal clock time....
Definition LoRaWAN.cpp:3303
RadioLibTime_t scanGuard
Rx window padding in milliseconds according to the spec, the Rx window must be at least enough time t...
Definition LoRaWAN.h:990
uint8_t getClass()
Get the LoRaWAN class of this node.
Definition LoRaWAN.cpp:3311
void setCSMA(bool csmaEnabled, uint8_t maxChanges=4, uint8_t backoffMax=0, uint8_t difsSlots=2)
Configures CSMA for LoRaWAN as per TR013, LoRa Alliance.
Definition LoRaWAN.cpp:3274
uint32_t getRxFCnt()
Returns the number of received application downlinks.
Definition LoRaWAN.cpp:3335
const LoRaWANBand_t * getBand()
Get the LoRaWAN band used by this node.
Definition LoRaWAN.cpp:3307
void(* SleepCb_t)(RadioLibTime_t ms)
Callback to a user-provided sleep function.
Definition LoRaWAN.h:947
void setDutyCycle(bool enable=true, RadioLibTime_t msPerHour=0)
Toggle adherence to dutyCycle limits to on or off.
Definition LoRaWAN.cpp:3248
uint8_t getMulticastClass()
Request the currently configured class for Multicast.
Definition LoRaWAN.cpp:3691
int16_t beginABP(uint32_t addr, const uint8_t *fNwkSIntKey, const uint8_t *sNwkSIntKey, const uint8_t *nwkSEncKey, const uint8_t *appSKey)
Set the device credentials and activation configuration.
Definition LoRaWAN.cpp:693
RadioLibTime_t timeUntilUplink()
Returns time in milliseconds until next uplink is available under dutyCycle limits.
Definition LoRaWAN.cpp:3776
int16_t getDownlinkClassC(uint8_t *dataDown, size_t *lenDown, LoRaWANEvent_t *eventDown=NULL)
Check if there is an RxC downlink and parse it if available.
Definition LoRaWAN.cpp:2314
void setDeviceStatus(uint8_t battLevel)
Set device status.
Definition LoRaWAN.cpp:3288
RadioLibTime_t dutyCycleInterval(RadioLibTime_t msPerHour, RadioLibTime_t airtime)
Calculate the minimum interval to adhere to a certain dutyCycle. This interval is based on the ToA of...
Definition LoRaWAN.cpp:3766
uint8_t getVersionMajor()
Get the LoRaWAN version of this node.
Definition LoRaWAN.cpp:3315
void removePackage(uint8_t fPort)
Disable a package that was previously added.
Definition LoRaWAN.cpp:3844
void setDwellTime(bool enable, RadioLibTime_t msPerUplink=0)
Set or disable uplink dwell time limitation; enabled by default if mandatory.
Definition LoRaWAN.cpp:3261
uint32_t getAFCntDown()
Returns the last application downlink's frame counter; also 0 if no application downlink occured yet.
Definition LoRaWAN.cpp:3331
RadioLibTime_t getLastToA()
Get the Time-on-air of the last uplink message (in milliseconds).
Definition LoRaWAN.cpp:3350
virtual int16_t activateOTAA(LoRaWANJoinEvent_t *joinEvent=NULL)
Join network by restoring OTAA session or performing over-the-air activation. By this procedure,...
Definition LoRaWAN.cpp:933
uint8_t * getBufferNonces()
Returns the pointer to the internal buffer that holds the LW base parameters.
Definition LoRaWAN.cpp:303
uint8_t * getBufferSession()
Returns the pointer to the internal buffer that holds the LW session parameters.
Definition LoRaWAN.cpp:507
bool isActivated()
Whether there is an ongoing session active.
Definition LoRaWAN.cpp:1123
int16_t setTxPower(int8_t txPower)
Configure TX power of the radio module.
Definition LoRaWAN.cpp:3182
int16_t addNwkPackage(uint8_t fPort)
Enable a reserved FPort that can be used for network traffic.
Definition LoRaWAN.cpp:3830
uint32_t getNFCntDown()
Returns the last network downlink's frame counter; also 0 if no network downlink occured yet.
Definition LoRaWAN.cpp:3327
uint32_t getRxFCntMulticast(uint8_t mcGroupId)
Returns the number of received downlinks for a certain multicast group.
Definition LoRaWAN.cpp:3339
int16_t setClass(uint8_t cls)
Configure class (RADIOLIB_LORAWAN_CLASS_A or RADIOLIB_LORAWAN_CLASS_C)
Definition LoRaWAN.cpp:1127
int16_t beginOTAA(uint64_t joinEUI, uint64_t devEUI, const uint8_t *nwkKey, const uint8_t *appKey)
Set the device credentials and activation configuration.
Definition LoRaWAN.cpp:664
virtual uint8_t getMaxPayloadLen()
Returns the maximum allowed uplink payload size given the current MAC state. Most importantly,...
Definition LoRaWAN.cpp:3785
virtual int16_t activateABP()
Join network by restoring ABP session or performing over-the-air activation. In this procedure,...
Definition LoRaWAN.cpp:1030
int16_t addAppPackage(uint8_t fPort)
Enable a reserved FPort that can be used for application traffic.
Definition LoRaWAN.cpp:3826
bool stopMulticastSession(uint8_t id, bool addRxFCnt=false)
Stop an ongoing multicast session.
Definition LoRaWAN.cpp:1237
uint32_t getFCntUp()
Returns the last uplink's frame counter; also 0 if no uplink occured yet.
Definition LoRaWAN.cpp:3320
int16_t setBufferNonces(const uint8_t *persistentBuffer)
Fill the internal buffer that holds the LW base parameters with a supplied buffer.
Definition LoRaWAN.cpp:317
int16_t setRx2Dr(uint8_t dr)
Configure the Rx2 datarate for ABP mode. This should not be needed for LoRaWAN 1.1 as it is configure...
Definition LoRaWAN.cpp:3212
int16_t sendMacCommandReq(uint8_t cid)
Add a MAC command to the uplink queue. Only LinkCheck and DeviceTime are available to the user....
Definition LoRaWAN.cpp:2962
int16_t getMacLinkCheckAns(uint8_t *margin, uint8_t *gwCnt)
Returns the quality of connectivity after requesting a LinkCheck MAC command.
Definition LoRaWAN.cpp:2986
void setADR(bool enable=true)
Toggle ADR to on or off.
Definition LoRaWAN.cpp:3244
void setActivityLeds(const uint32_t pins[4])
Set pins for activity LEDs that will indicate when the radio is transmitting (Tx) or receiving (Rx).
Definition LoRaWAN.cpp:3292
int16_t getMacDeviceTimeAns(uint32_t *timestamp, uint16_t *milliseconds, bool returnUnix=true)
Returns the network time after requesting a DeviceTime MAC command. Note: the network returns the tim...
Definition LoRaWAN.cpp:2997
int16_t setBufferSession(const uint8_t *persistentBuffer)
Fill the internal buffer that holds the LW session parameters with a supplied buffer.
Definition LoRaWAN.cpp:536
uint32_t getDevAddr()
Returns the DevAddr of the device, regardless of OTAA or ABP mode.
Definition LoRaWAN.cpp:3346
uint8_t getMacUplinkLen()
Get the length of the pending MAC uplink payload.
Definition LoRaWAN.cpp:3354
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition PhysicalLayer.h:390
unsigned long RadioLibTime_t
Type used for durations in RadioLib.
Definition TypeDef.h:679
Structure to save information about LoRaWAN band.
Definition LoRaWAN.h:391
LoRaWANDataRate_t dataRates[RADIOLIB_LORAWAN_CHANNEL_NUM_DATARATES]
The corresponding datarates, bandwidths and coding rates for DR index.
Definition LoRaWAN.h:449
int8_t powerMax
Maximum allowed output power in this band in dBm.
Definition LoRaWAN.h:408
bool txParamSupported
Whether this band implements the MAC command TxParamSetupReq.
Definition LoRaWAN.h:423
LoRaWANChannel_t txAck[2]
Relay channels for ACK downlink.
Definition LoRaWAN.h:446
RadioLibTime_t dutyCycle
Number of milliseconds per hour of allowed Time-on-Air.
Definition LoRaWAN.h:414
RadioLibTime_t dwellTimeUp
Maximum dwell time per uplink message in milliseconds.
Definition LoRaWAN.h:417
LoRaWANChannel_t txWoR[2]
Relay channels for WoR uplink.
Definition LoRaWAN.h:443
uint32_t freqMin
Minimum allowed frequency (coded in 100 Hz steps)
Definition LoRaWAN.h:399
uint8_t payloadLenMax[RADIOLIB_LORAWAN_CHANNEL_NUM_DATARATES]
Array of allowed maximum application payload lengths for each data rate (N-value)
Definition LoRaWAN.h:405
LoRaWANChannel_t txFreqs[3]
A set of default uplink (TX) channels for dynamic bands.
Definition LoRaWAN.h:426
int8_t powerNumSteps
Number of power steps in this band.
Definition LoRaWAN.h:411
LoRaWANChannelSpan_t txSpans[2]
Default uplink (TX) channel spans for fixed bands, including Join-Request parameters.
Definition LoRaWAN.h:432
uint8_t bandNum
Identier for this band.
Definition LoRaWAN.h:393
uint32_t freqMax
Maximum allowed frequency (coded in 100 Hz steps)
Definition LoRaWAN.h:402
uint8_t bandType
Whether the channels are fixed per specification, or dynamically allocated through the network (plus ...
Definition LoRaWAN.h:396
LoRaWANChannel_t rx2
Backup channel for downlink (RX2) window.
Definition LoRaWAN.h:440
uint8_t numTxSpans
The number of TX channel spans for fixed bands.
Definition LoRaWAN.h:429
RadioLibTime_t dwellTimeDn
Maximum dwell time per downlink message in milliseconds.
Definition LoRaWAN.h:420
LoRaWANChannelSpan_t rx1Span
Default downlink (RX1) channel span for fixed bands.
Definition LoRaWAN.h:435
IDs of all currently supported bands.
Structure to save information about LoRaWAN channels. To save space, adjacent channels are saved in "...
Definition LoRaWAN.h:330
uint8_t dr
Datarate currently in use on this channel.
Definition LoRaWAN.h:344
uint32_t freq
The channel frequency (coded in 100 Hz steps)
Definition LoRaWAN.h:335
uint8_t idx
The channel number, as specified by defaults or the network.
Definition LoRaWAN.h:332
uint8_t drMin
Minimum allowed datarate for this channel.
Definition LoRaWAN.h:338
uint8_t drMax
Maximum allowed datarate for this channel (inclusive)
Definition LoRaWAN.h:341
Structure to save information about LoRaWAN channels. To save space, adjacent channels are saved in "...
Definition LoRaWAN.h:356
uint8_t drJoinRequest
Allowed data rates for a join request message.
Definition LoRaWAN.h:373
uint32_t freqStart
Center frequency of the first channel in span (coded in 100 Hz steps)
Definition LoRaWAN.h:361
uint8_t numChannels
Total number of channels in the span.
Definition LoRaWAN.h:358
uint8_t drMax
Maximum allowed datarate for all channels in this span (inclusive)
Definition LoRaWAN.h:370
uint32_t freqStep
Frequency step between adjacent channels (coded in 100 Hz steps)
Definition LoRaWAN.h:364
uint8_t drMin
Minimum allowed datarate for all channels in this span.
Definition LoRaWAN.h:367
Definition LoRaWAN.h:379
Structure to save extra information about uplink/downlink event.
Definition LoRaWAN.h:509
float freq
Frequency in MHz.
Definition LoRaWAN.h:527
bool confirmed
Whether the event is confirmed or not (e.g., confirmed uplink sent by user application)
Definition LoRaWAN.h:514
uint8_t fPort
Port number.
Definition LoRaWAN.h:536
int16_t power
Transmit power in dBm for uplink, or RSSI for downlink.
Definition LoRaWAN.h:530
bool confirming
Whether the event is confirming a previous request (e.g., server downlink reply to confirmed uplink s...
Definition LoRaWAN.h:518
uint8_t datarate
Datarate.
Definition LoRaWAN.h:524
uint8_t dir
Event direction, one of RADIOLIB_LORAWAN_CHANNEL_DIR_*.
Definition LoRaWAN.h:511
uint8_t nbTrans
Number of times this uplink was transmitted (ADR)
Definition LoRaWAN.h:539
uint32_t fCnt
The appropriate frame counter - for different events, different frame counters will be reported!
Definition LoRaWAN.h:533
bool multicast
Multicast or unicast.
Definition LoRaWAN.h:542
uint8_t mcGroupId
Multicast Group ID if this was a multicast downlink.
Definition LoRaWAN.h:545
bool frmPending
Whether further downlink messages are pending on the server side.
Definition LoRaWAN.h:521
Structure to save extra information about activation event.
Definition LoRaWAN.h:494
bool newSession
Whether a new session was started.
Definition LoRaWAN.h:496
uint32_t joinNonce
The received Join-Request JoinNonce value.
Definition LoRaWAN.h:502
uint16_t devNonce
The transmitted Join-Request DevNonce value.
Definition LoRaWAN.h:499
MAC command specification structure.
Definition LoRaWAN.h:204
const uint8_t lenDn
Uplink message length.
Definition LoRaWAN.h:209
const bool user
Whether this MAC command can be issued by the user or not.
Definition LoRaWAN.h:218
const uint8_t cid
Command ID.
Definition LoRaWAN.h:206
const uint8_t lenUp
Downlink message length.
Definition LoRaWAN.h:212
const bool persist
Some commands must be resent until Class A downlink received.
Definition LoRaWAN.h:215
LoRaWAN Packages structure (for TSxxx documents).
Definition LoRaWAN.h:267
bool isAppPack
Whether the package runs through the Application layer.
Definition LoRaWAN.h:272
bool enabled
Whether the package is currently in use.
Definition LoRaWAN.h:269
Definition LoRaWAN.h:226
uint8_t mcDr
The datarate used for the Multicast downlinks.
Definition LoRaWAN.h:252
uint32_t mcFreq
The frequency used for the Multicast downlinks (in Hz).
Definition LoRaWAN.h:249
uint32_t mcAddr
The Multicast address.
Definition LoRaWAN.h:231
uint8_t cls
The LoRaWAN Class used for this session (only C is supported)
Definition LoRaWAN.h:228
uint32_t mcFCntMax
The maximum allowed Multicast frame counter.
Definition LoRaWAN.h:243
uint32_t rxFCnt
The number of received Multicast frames in this group.
Definition LoRaWAN.h:246
uint32_t mcFCnt
The minimum (next) expected Multicast frame counter.
Definition LoRaWAN.h:240
uint8_t mcAppSKey[RADIOLIB_AES128_KEY_SIZE]
The Multicast payload session key.
Definition LoRaWAN.h:234
uint8_t mcNwkSKey[RADIOLIB_AES128_KEY_SIZE]
The Multicast network session key.
Definition LoRaWAN.h:237
Common data rate structure.
Definition PhysicalLayer.h:74
Common packet configuration structure.
Definition PhysicalLayer.h:119