/
modlora.c
2382 lines (2097 loc) · 92 KB
/
modlora.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (c) 2018, Pycom Limited.
*
* This software is licensed under the GNU GPL version 3 or any
* later version, with permitted additional terms. For more information
* see the Pycom Licence v1.0 document supplied with this file, or
* available at https://www.pycom.io/opensource/licensing
*/
#include <stdint.h>
#include <stdio.h>
#include <stdbool.h>
#include <string.h>
#include "py/mpconfig.h"
#include "py/mpstate.h"
#include "py/obj.h"
#include "py/nlr.h"
#include "py/runtime.h"
#include "py/mphal.h"
#include "py/stream.h"
#include "py/mperrno.h"
#include "bufhelper.h"
#include "mpexception.h"
#include "radio.h"
#include "modnetwork.h"
#include "pybioctl.h"
#include "modusocket.h"
#include "pycom_config.h"
#include "mpirq.h"
#include "modlora.h"
#include "esp_heap_caps.h"
#include "sdkconfig.h"
#include "esp_system.h"
#include "esp_spi_flash.h"
#include "nvs_flash.h"
#include "esp_event.h"
#include "nvs.h"
#include "lwip/sockets.h" // for the socket error codes
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include "freertos/queue.h"
#include "freertos/event_groups.h"
#include "lora/mac/LoRaMacTest.h"
#include "lora/mac/region/Region.h"
#include "lora/mac/region/RegionAS923.h"
#include "lora/mac/region/RegionAU915.h"
#include "lora/mac/region/RegionUS915.h"
#include "lora/mac/region/RegionUS915-Hybrid.h"
#include "lora/mac/region/RegionEU868.h"
/******************************************************************************
DEFINE PRIVATE CONSTANTS
******************************************************************************/
#define TX_OUTPUT_POWER_MAX 20 // dBm
#define TX_OUTPUT_POWER_MIN 2 // dBm
#define LORA_FIX_LENGTH_PAYLOAD_ON (true)
#define LORA_FIX_LENGTH_PAYLOAD_OFF (false)
#define LORA_TX_TIMEOUT_MAX (9000) // 9 seconds
#define LORA_RX_TIMEOUT (0) // No timeout
// [SF6..SF12]
#define LORA_SPREADING_FACTOR_MIN (6)
#define LORA_SPREADING_FACTOR_MAX (12)
#define LORA_CHECK_SOCKET(s) if (s->sock_base.u.sd < 0) { \
*_errno = MP_EBADF; \
return -1; \
}
#define OVER_THE_AIR_ACTIVATION_DUTYCYCLE 10000 // 10 [s] value in ms
#define DEF_LORAWAN_NETWORK_ID 0
#define DEF_LORAWAN_APP_PORT 2
#define LORA_JOIN_WAIT_MS (50)
#define LORAWAN_SOCKET_GET_FD(sd) (sd & 0xFF)
#define LORAWAN_SOCKET_IS_CONFIRMED(sd) ((sd & 0x40000000) == 0x40000000)
#define LORAWAN_SOCKET_SET_CONFIRMED(sd) (sd |= 0x40000000)
#define LORAWAN_SOCKET_CLR_CONFIRMED(sd) (sd &= ~0x40000000)
#define LORAWAN_SOCKET_SET_PORT(sd, port) (sd &= 0xFFFF00FF); \
(sd |= (port << 8))
#define LORAWAN_SOCKET_GET_PORT(sd) ((sd >> 8) & 0xFF)
#define LORAWAN_SOCKET_SET_DR(sd, dr) (sd &= 0xFF00FFFF); \
(sd |= (dr << 16))
#define LORAWAN_SOCKET_GET_DR(sd) ((sd >> 16) & 0xFF)
// callback events
#define MODLORA_RX_EVENT (0x01)
#define MODLORA_TX_EVENT (0x02)
#define MODLORA_TX_FAILED_EVENT (0x04)
#define MODLORA_NVS_NAMESPACE "LORA_NVM"
/******************************************************************************
DEFINE PRIVATE TYPES
******************************************************************************/
typedef enum {
E_LORA_STACK_MODE_LORA = 0,
E_LORA_STACK_MODE_LORAWAN
} lora_stack_mode_t;
typedef enum {
E_LORA_STATE_NOINIT = 0,
E_LORA_STATE_IDLE,
E_LORA_STATE_JOIN,
E_LORA_STATE_LINK_CHECK,
E_LORA_STATE_RX,
E_LORA_STATE_RX_DONE,
E_LORA_STATE_RX_TIMEOUT,
E_LORA_STATE_RX_ERROR,
E_LORA_STATE_TX,
E_LORA_STATE_TX_DONE,
E_LORA_STATE_TX_TIMEOUT,
E_LORA_STATE_SLEEP
} lora_state_t;
typedef enum {
E_LORA_MODE_ALWAYS_ON = 0,
E_LORA_MODE_TX_ONLY,
E_LORA_MODE_SLEEP
} lora_mode_t;
typedef enum {
E_LORA_BW_125_KHZ = 0,
E_LORA_BW_250_KHZ = 1,
E_LORA_BW_500_KHZ = 2
} lora_bandwidth_t;
typedef enum {
E_LORA_CODING_4_5 = 1,
E_LORA_CODING_4_6 = 2,
E_LORA_CODING_4_7 = 3,
E_LORA_CODING_4_8 = 4
} lora_coding_rate_t;
typedef enum {
E_LORA_ACTIVATION_OTAA = 0,
E_LORA_ACTIVATION_ABP
} lora_activation_t;
typedef struct {
mp_obj_base_t base;
mp_obj_t handler;
mp_obj_t handler_arg;
LoRaMacRegion_t region;
lora_stack_mode_t stack_mode;
DeviceClass_t device_class;
lora_state_t state;
uint32_t frequency;
uint32_t rx_timestamp;
uint32_t net_id;
uint32_t tx_time_on_air;
uint32_t tx_counter;
uint32_t tx_frequency;
int16_t rssi;
int8_t snr;
uint8_t sfrx;
uint8_t sftx;
uint8_t preamble;
uint8_t bandwidth;
uint8_t coding_rate;
uint8_t sf;
int8_t tx_power;
uint8_t pwr_mode;
struct {
bool Enabled;
bool Running;
uint8_t State;
bool IsTxConfirmed;
uint16_t DownLinkCounter;
bool LinkCheck;
uint8_t DemodMargin;
uint8_t NbGateways;
} ComplianceTest;
uint8_t activation;
uint8_t tx_retries;
uint8_t otaa_dr;
union {
struct {
// for OTAA
uint8_t DevEui[8];
uint8_t AppEui[8];
uint8_t AppKey[16];
} otaa;
struct {
// for ABP
uint32_t DevAddr;
uint8_t NwkSKey[16];
uint8_t AppSKey[16];
} abp;
} u;
bool txiq;
bool rxiq;
bool adr;
bool public;
bool joined;
uint8_t events;
uint8_t trigger;
uint8_t tx_trials;
} lora_obj_t;
typedef struct {
uint32_t index;
uint32_t size;
uint8_t data[LORA_PAYLOAD_SIZE_MAX];
uint8_t port;
} lora_partial_rx_packet_t;
/******************************************************************************
DECLARE PRIVATE DATA
******************************************************************************/
static QueueHandle_t xCmdQueue;
static QueueHandle_t xRxQueue;
static QueueHandle_t xCbQueue;
static EventGroupHandle_t LoRaEvents;
static RadioEvents_t RadioEvents;
static lora_cmd_data_t task_cmd_data;
static LoRaMacPrimitives_t LoRaMacPrimitives;
static LoRaMacCallback_t LoRaMacCallbacks;
static lora_obj_t lora_obj;
static lora_partial_rx_packet_t lora_partial_rx_packet;
static lora_rx_data_t rx_data_isr;
static TimerEvent_t TxNextActReqTimer;
static nvs_handle modlora_nvs_handle;
static const char *modlora_nvs_data_key[E_LORA_NVS_NUM_KEYS] = { "JOINED", "UPLNK", "DWLNK", "DEVADDR",
"NWSKEY", "APPSKEY", "NETID", "ADRACK",
"MACPARAMS", "CHANNELS", "SRVACK", "MACNXTTX",
"MACBUFIDX", "MACRPTIDX", "MACBUF", "MACRPTBUF",
"REGION", "CHANMASK", "CHANMASKREM" };
DRAM_ATTR static modlora_timerCallback modlora_timer_cb;
/******************************************************************************
DECLARE PUBLIC DATA
******************************************************************************/
extern TaskHandle_t xLoRaTaskHndl;
/******************************************************************************
DECLARE PRIVATE FUNCTIONS
******************************************************************************/
static void TASK_LoRa (void *pvParameters);
static void TASK_LoRa_Timer (void *pvParameters);
static void OnTxDone (void);
static void OnRxDone (uint8_t *payload, uint32_t timestamp, uint16_t size, int16_t rssi, int8_t snr, uint8_t sf);
static void OnTxTimeout (void);
static void OnRxTimeout (void);
static void OnRxError (void);
static void lora_radio_setup (lora_init_cmd_data_t *init_data);
static void lora_validate_mode (uint32_t mode);
static void lora_validate_frequency (uint32_t frequency);
static void lora_validate_power (uint8_t tx_power);
static void lora_validate_bandwidth (uint8_t bandwidth);
static void lora_validate_sf (uint8_t sf);
static void lora_validate_coding_rate (uint8_t coding_rate);
static void lora_set_config (lora_cmd_data_t *cmd_data);
static void lora_get_config (lora_cmd_data_t *cmd_data);
static void lora_send_cmd (lora_cmd_data_t *cmd_data);
static int32_t lora_send (const byte *buf, uint32_t len, uint32_t timeout_ms);
static int32_t lora_recv (byte *buf, uint32_t len, int32_t timeout_ms, uint32_t *port);
static bool lora_rx_any (void);
static bool lora_tx_space (void);
static void lora_callback_handler (void *arg);
static bool lorawan_nvs_open (void);
static int lora_socket_socket (mod_network_socket_obj_t *s, int *_errno);
static void lora_socket_close (mod_network_socket_obj_t *s);
static int lora_socket_send (mod_network_socket_obj_t *s, const byte *buf, mp_uint_t len, int *_errno);
static int lora_socket_recvfrom (mod_network_socket_obj_t *s, byte *buf, mp_uint_t len, byte *ip, mp_uint_t *port, int *_errno);
static int lora_socket_recv (mod_network_socket_obj_t *s, byte *buf, mp_uint_t len, int *_errno);
static int lora_socket_settimeout (mod_network_socket_obj_t *s, mp_int_t timeout_ms, int *_errno);
static int lora_socket_bind (mod_network_socket_obj_t *s, byte *ip, mp_uint_t port, int *_errno);
static int lora_socket_setsockopt (mod_network_socket_obj_t *s, mp_uint_t level, mp_uint_t opt, const void *optval, mp_uint_t optlen, int *_errno);
static int lora_socket_ioctl (mod_network_socket_obj_t *s, mp_uint_t request, mp_uint_t arg, int *_errno);
STATIC mp_obj_t lora_nvram_erase (mp_obj_t self_in);
/******************************************************************************
DECLARE PUBLIC DATA
******************************************************************************/
#if defined(FIPY) || defined(LOPY4)
SemaphoreHandle_t xLoRaSigfoxSem;
#endif
/******************************************************************************
DEFINE PUBLIC FUNCTIONS
******************************************************************************/
void modlora_init0(void) {
xCmdQueue = xQueueCreate(LORA_CMD_QUEUE_SIZE_MAX, sizeof(lora_cmd_data_t));
xRxQueue = xQueueCreate(LORA_DATA_QUEUE_SIZE_MAX, sizeof(lora_rx_data_t));
xCbQueue = xQueueCreate(LORA_CB_QUEUE_SIZE_MAX, sizeof(modlora_timerCallback));
LoRaEvents = xEventGroupCreate();
#if defined(FIPY) || defined(LOPY4)
xLoRaSigfoxSem = xSemaphoreCreateMutex();
#endif
if (!lorawan_nvs_open()) {
mp_printf(&mp_plat_print, "Error opening LoRa NVS namespace!\n");
}
// target board initialisation
BoardInitMcu();
BoardInitPeriph();
xTaskCreatePinnedToCore(TASK_LoRa, "LoRa", LORA_STACK_SIZE / sizeof(StackType_t), NULL, LORA_TASK_PRIORITY, &xLoRaTaskHndl, 1);
xTaskCreatePinnedToCore(TASK_LoRa_Timer, "LoRa_Timer_callback", LORA_TIMER_STACK_SIZE / sizeof(StackType_t), NULL, LORA_TIMER_TASK_PRIORITY, &xLoRaTimerTaskHndl, 1);
}
bool modlora_nvs_set_uint(uint32_t key_idx, uint32_t value) {
if (ESP_OK == nvs_set_u32(modlora_nvs_handle, modlora_nvs_data_key[key_idx], value)) {
return true;
}
return false;
}
bool modlora_nvs_set_blob(uint32_t key_idx, const void *value, uint32_t length) {
if (ESP_OK == nvs_set_blob(modlora_nvs_handle, modlora_nvs_data_key[key_idx], value, length)) {
return true;
}
return false;
}
bool modlora_nvs_get_uint(uint32_t key_idx, uint32_t *value) {
esp_err_t err;
if (ESP_OK == (err = nvs_get_u32(modlora_nvs_handle, modlora_nvs_data_key[key_idx], value))) {
return true;
}
return false;
}
bool modlora_nvs_get_blob(uint32_t key_idx, void *value, uint32_t *length) {
esp_err_t err;
if (ESP_OK == (err = nvs_get_blob(modlora_nvs_handle, modlora_nvs_data_key[key_idx], value, length))) {
return true;
}
return false;
}
IRAM_ATTR void modlora_set_timer_callback(modlora_timerCallback cb)
{
modlora_timer_cb = cb;
{
if(cb != NULL)
xQueueSendFromISR(xCbQueue, &cb, NULL);
}
}
/******************************************************************************
DEFINE PRIVATE FUNCTIONS
******************************************************************************/
static bool lorawan_nvs_open (void) {
if (nvs_open(MODLORA_NVS_NAMESPACE, NVS_READWRITE, &modlora_nvs_handle) != ESP_OK) {
return false;
}
uint32_t data;
if (ESP_ERR_NVS_NOT_FOUND == nvs_get_u32(modlora_nvs_handle, "JOINED", &data)) {
// initialize the value to 0
nvs_set_u32(modlora_nvs_handle, "JOINED", false);
if (ESP_OK != nvs_commit(modlora_nvs_handle)) {
return false;
}
}
return true;
}
static int32_t lorawan_send (const byte *buf, uint32_t len, uint32_t timeout_ms, bool confirmed, uint32_t dr, uint32_t port) {
lora_cmd_data_t cmd_data;
cmd_data.cmd = E_LORA_CMD_LORAWAN_TX;
memcpy (cmd_data.info.tx.data, buf, len);
cmd_data.info.tx.len = len;
cmd_data.info.tx.dr = dr;
if (lora_obj.ComplianceTest.Enabled && lora_obj.ComplianceTest.Running) {
cmd_data.info.tx.port = 224; // MAC commands port
if (lora_obj.ComplianceTest.IsTxConfirmed) {
cmd_data.info.tx.confirmed = true;
} else {
cmd_data.info.tx.confirmed = false;
}
} else {
cmd_data.info.tx.confirmed = confirmed;
cmd_data.info.tx.port = port; // data port
}
if (timeout_ms < 0) {
// blocking mode
timeout_ms = portMAX_DELAY;
}
xEventGroupClearBits(LoRaEvents, LORA_STATUS_COMPLETED | LORA_STATUS_ERROR | LORA_STATUS_MSG_SIZE);
// just pass to the LoRa queue
if (!xQueueSend(xCmdQueue, (void *)&cmd_data, (TickType_t)(timeout_ms / portTICK_PERIOD_MS))) {
return 0;
}
// validate the message size with the requested data rate
if (false == ValidatePayloadLength(len, dr, 0)) {
// message too long
return -1;
}
if (timeout_ms != 0) {
uint32_t result = xEventGroupWaitBits(LoRaEvents,
LORA_STATUS_COMPLETED | LORA_STATUS_ERROR | LORA_STATUS_MSG_SIZE,
pdTRUE, // clear on exit
pdFALSE, // do not wait for all bits
(TickType_t)portMAX_DELAY);
if (result & LORA_STATUS_MSG_SIZE) {
return -1;
} else if (result & LORA_STATUS_ERROR) {
return 0;
}
}
// return the number of bytes sent
return len;
}
static void McpsConfirm (McpsConfirm_t *McpsConfirm) {
uint32_t status = LORA_STATUS_COMPLETED;
if (McpsConfirm->Status == LORAMAC_EVENT_INFO_STATUS_OK) {
// save the values before calling the event handler
lora_obj.sftx = McpsConfirm->Datarate;
lora_obj.tx_trials = McpsConfirm->NbRetries;
lora_obj.tx_time_on_air = McpsConfirm->TxTimeOnAir;
lora_obj.tx_power = McpsConfirm->TxPower;
lora_obj.tx_frequency = McpsConfirm->UpLinkFrequency;
lora_obj.tx_counter = McpsConfirm->UpLinkCounter;
switch (McpsConfirm->McpsRequest) {
case MCPS_UNCONFIRMED: {
lora_obj.events |= MODLORA_TX_EVENT;
if (lora_obj.trigger & MODLORA_TX_EVENT) {
mp_irq_queue_interrupt(lora_callback_handler, (void *)&lora_obj);
}
lora_obj.state = E_LORA_STATE_IDLE;
xEventGroupSetBits(LoRaEvents, status);
break;
}
case MCPS_CONFIRMED:
lora_obj.tx_trials = McpsConfirm->NbRetries;
if (McpsConfirm->AckReceived) {
lora_obj.events |= MODLORA_TX_EVENT;
if (lora_obj.trigger & MODLORA_TX_EVENT) {
mp_irq_queue_interrupt(lora_callback_handler, (void *)&lora_obj);
}
lora_obj.state = E_LORA_STATE_IDLE;
xEventGroupSetBits(LoRaEvents, status);
} else {
// the ack wasn't received, so the stack will re-transmit
}
break;
case MCPS_PROPRIETARY:
break;
default:
break;
}
} else {
lora_obj.events |= MODLORA_TX_FAILED_EVENT;
if (lora_obj.trigger & MODLORA_TX_FAILED_EVENT) {
mp_irq_queue_interrupt(lora_callback_handler, (void *)&lora_obj);
}
lora_obj.state = E_LORA_STATE_IDLE;
status |= LORA_STATUS_ERROR;
xEventGroupSetBits(LoRaEvents, status);
}
#if defined(FIPY) || defined(LOPY4)
xSemaphoreGive(xLoRaSigfoxSem);
#endif
}
static void McpsIndication (McpsIndication_t *mcpsIndication) {
if (mcpsIndication->Status != LORAMAC_EVENT_INFO_STATUS_OK) {
return;
}
switch (mcpsIndication->McpsIndication) {
case MCPS_UNCONFIRMED:
break;
case MCPS_CONFIRMED:
break;
case MCPS_PROPRIETARY:
break;
case MCPS_MULTICAST:
break;
default:
break;
}
// Check Multicast
// Check Port
// Check Datarate
// Check FramePending
// Check Buffer
// Check BufferSize
// Check Rssi
// Check Snr
// Check RxSlot
lora_obj.rx_timestamp = mcpsIndication->TimeStamp;
lora_obj.rssi = mcpsIndication->Rssi;
lora_obj.snr = mcpsIndication->Snr;
lora_obj.sfrx = mcpsIndication->RxDatarate;
if (lora_obj.ComplianceTest.Running == true) {
lora_obj.ComplianceTest.DownLinkCounter++;
}
// printf("MCPS indication!=%d :%d\n", mcpsIndication->BufferSize, mcpsIndication->Port);
if (mcpsIndication->RxData && mcpsIndication->BufferSize > 0) {
if (mcpsIndication->Port > 0 && mcpsIndication->Port < 224) {
if (mcpsIndication->BufferSize <= LORA_PAYLOAD_SIZE_MAX) {
memcpy((void *)rx_data_isr.data, mcpsIndication->Buffer, mcpsIndication->BufferSize);
rx_data_isr.len = mcpsIndication->BufferSize;
rx_data_isr.port = mcpsIndication->Port;
xQueueSend(xRxQueue, (void *)&rx_data_isr, 0);
lora_obj.events |= MODLORA_RX_EVENT;
if (lora_obj.trigger & MODLORA_RX_EVENT) {
mp_irq_queue_interrupt(lora_callback_handler, (void *)&lora_obj);
}
}
// printf("Data on port 1 or 2 received\n");
} else if (mcpsIndication->Port == 224) {
if (lora_obj.ComplianceTest.Enabled == true) {
if (lora_obj.ComplianceTest.Running == false) {
// printf("Checking start test msg\n");
// Check compliance test enable command (i)
if( ( mcpsIndication->BufferSize == 4 ) &&
( mcpsIndication->Buffer[0] == 0x01 ) &&
( mcpsIndication->Buffer[1] == 0x01 ) &&
( mcpsIndication->Buffer[2] == 0x01 ) &&
( mcpsIndication->Buffer[3] == 0x01 ) )
{
lora_obj.ComplianceTest.IsTxConfirmed = false;
lora_obj.ComplianceTest.DownLinkCounter = 0;
lora_obj.ComplianceTest.LinkCheck = false;
lora_obj.ComplianceTest.DemodMargin = 0;
lora_obj.ComplianceTest.NbGateways = 0;
lora_obj.ComplianceTest.Running = true;
lora_obj.ComplianceTest.State = 1;
// flush the rx queue
xQueueReset(xRxQueue);
// enable ADR during test mode
MibRequestConfirm_t mibReq;
mibReq.Type = MIB_ADR;
mibReq.Param.AdrEnable = true;
LoRaMacMibSetRequestConfirm( &mibReq );
// always disable duty cycle limitation during test mode
LoRaMacTestSetDutyCycleOn(false);
// printf("Compliance enabled\n");
}
} else {
lora_obj.ComplianceTest.State = mcpsIndication->Buffer[0];
switch (lora_obj.ComplianceTest.State) {
case 0: // Check compliance test disable command (ii)
lora_obj.ComplianceTest.IsTxConfirmed = false;
lora_obj.ComplianceTest.DownLinkCounter = 0;
lora_obj.ComplianceTest.Running = false;
// set adr back to its original value
MibRequestConfirm_t mibReq;
mibReq.Type = MIB_ADR;
mibReq.Param.AdrEnable = lora_obj.adr;
LoRaMacMibSetRequestConfirm(&mibReq);
LoRaMacTestSetDutyCycleOn(true);
// printf("Compliance disabled\n");
break;
case 1: // (iii, iv)
lora_obj.ComplianceTest.Running = true;
// printf("Compliance running\n");
break;
case 2: // Enable confirmed messages (v)
lora_obj.ComplianceTest.IsTxConfirmed = true;
lora_obj.ComplianceTest.State = 1;
// printf("Confirmed messages enabled\n");
break;
case 3: // Disable confirmed messages (vi)
lora_obj.ComplianceTest.IsTxConfirmed = false;
lora_obj.ComplianceTest.State = 1;
// printf("Confirmed messages disabled\n");
break;
case 4: // (vii)
// return the payload
if (mcpsIndication->BufferSize <= LORA_PAYLOAD_SIZE_MAX) {
memcpy((void *)rx_data_isr.data, mcpsIndication->Buffer, mcpsIndication->BufferSize);
rx_data_isr.len = mcpsIndication->BufferSize;
xQueueSend(xRxQueue, (void *)&rx_data_isr, 0);
}
// printf("Crypto message received\n");
break;
case 5: // (viii)
// trigger a link check
lora_obj.state = E_LORA_STATE_LINK_CHECK;
// printf("Link check\n");
break;
case 6: // (ix)
// trigger a join request
lora_obj.joined = false;
lora_obj.ComplianceTest.State = 6;
// printf("Trigger join\n");
break;
default:
break;
}
}
}
}
}
}
static void MlmeConfirm (MlmeConfirm_t *MlmeConfirm) {
if (MlmeConfirm->Status == LORAMAC_EVENT_INFO_STATUS_OK) {
switch (MlmeConfirm->MlmeRequest) {
case MLME_JOIN:
TimerStop(&TxNextActReqTimer);
lora_obj.joined = true;
lora_obj.ComplianceTest.State = 1;
lora_obj.ComplianceTest.Running = false;
lora_obj.ComplianceTest.DownLinkCounter = 0;
break;
case MLME_LINK_CHECK:
// Check DemodMargin
// Check NbGateways
if (lora_obj.ComplianceTest.Running == true) {
lora_obj.ComplianceTest.LinkCheck = true;
lora_obj.ComplianceTest.DemodMargin = MlmeConfirm->DemodMargin;
lora_obj.ComplianceTest.NbGateways = MlmeConfirm->NbGateways;
}
// printf("Link check confirm\n");
break;
default:
break;
}
}
#if defined(FIPY) || defined(LOPY4)
xSemaphoreGive(xLoRaSigfoxSem);
#endif
}
static void OnTxNextActReqTimerEvent(void) {
MibRequestConfirm_t mibReq;
LoRaMacStatus_t status;
mibReq.Type = MIB_NETWORK_JOINED;
status = LoRaMacMibGetRequestConfirm(&mibReq);
if (status == LORAMAC_STATUS_OK) {
if (mibReq.Param.IsNetworkJoined == true) {
lora_obj.joined = true;
lora_obj.ComplianceTest.State = 1;
lora_obj.ComplianceTest.Running = false;
lora_obj.ComplianceTest.DownLinkCounter = 0;
} else {
lora_obj.state = E_LORA_STATE_JOIN;
}
}
}
static void TASK_LoRa (void *pvParameters) {
MibRequestConfirm_t mibReq;
MlmeReq_t mlmeReq;
McpsReq_t mcpsReq;
lora_obj.state = E_LORA_STATE_NOINIT;
lora_obj.pwr_mode = E_LORA_MODE_ALWAYS_ON;
for ( ; ; ) {
vTaskDelay (2 / portTICK_PERIOD_MS);
switch (lora_obj.state) {
case E_LORA_STATE_NOINIT:
case E_LORA_STATE_IDLE:
case E_LORA_STATE_RX:
case E_LORA_STATE_SLEEP:
// receive from the command queue and act accordingly
if (xQueueReceive(xCmdQueue, &task_cmd_data, 0)) {
switch (task_cmd_data.cmd) {
case E_LORA_CMD_INIT:
// save the new configuration first
lora_set_config(&task_cmd_data);
if (task_cmd_data.info.init.stack_mode == E_LORA_STACK_MODE_LORAWAN) {
LoRaMacPrimitives.MacMcpsConfirm = McpsConfirm;
LoRaMacPrimitives.MacMcpsIndication = McpsIndication;
LoRaMacPrimitives.MacMlmeConfirm = MlmeConfirm;
LoRaMacCallbacks.GetBatteryLevel = BoardGetBatteryLevel;
LoRaMacInitialization(&LoRaMacPrimitives, &LoRaMacCallbacks, task_cmd_data.info.init.region);
TimerStop(&TxNextActReqTimer);
TimerInit(&TxNextActReqTimer, OnTxNextActReqTimerEvent);
TimerSetValue(&TxNextActReqTimer, OVER_THE_AIR_ACTIVATION_DUTYCYCLE);
mibReq.Type = MIB_ADR;
mibReq.Param.AdrEnable = task_cmd_data.info.init.adr;
LoRaMacMibSetRequestConfirm(&mibReq);
mibReq.Type = MIB_PUBLIC_NETWORK;
mibReq.Param.EnablePublicNetwork = task_cmd_data.info.init.public;
LoRaMacMibSetRequestConfirm(&mibReq);
mibReq.Type = MIB_DEVICE_CLASS;
mibReq.Param.Class = task_cmd_data.info.init.device_class;
LoRaMacMibSetRequestConfirm(&mibReq);
LoRaMacTestSetDutyCycleOn(false);
// check if we have already joined the network
if (lora_obj.joined) {
uint32_t length;
bool result = true;
result &= modlora_nvs_get_uint(E_LORA_NVS_ELE_NET_ID, (uint32_t *)&lora_obj.net_id);
result &= modlora_nvs_get_uint(E_LORA_NVS_ELE_DEVADDR, (uint32_t *)&lora_obj.u.abp.DevAddr);
length = 16;
result &= modlora_nvs_get_blob(E_LORA_NVS_ELE_NWSKEY, (void *)lora_obj.u.abp.NwkSKey, &length);
length = 16;
result &= modlora_nvs_get_blob(E_LORA_NVS_ELE_APPSKEY, (void *)lora_obj.u.abp.AppSKey, &length);
uint32_t uplinks, downlinks;
result &= modlora_nvs_get_uint(E_LORA_NVS_ELE_UPLINK, &uplinks);
result &= modlora_nvs_get_uint(E_LORA_NVS_ELE_DWLINK, &downlinks);
result &= modlora_nvs_get_uint(E_LORA_NVS_ELE_ADR_ACKS, LoRaMacGetAdrAckCounter());
if (result) {
mibReq.Type = MIB_UPLINK_COUNTER;
mibReq.Param.UpLinkCounter = uplinks;
LoRaMacMibSetRequestConfirm( &mibReq );
mibReq.Type = MIB_DOWNLINK_COUNTER;
mibReq.Param.DownLinkCounter = downlinks;
LoRaMacMibSetRequestConfirm( &mibReq );
// write the MAC params directly from the NVRAM
length = sizeof(LoRaMacParams_t);
modlora_nvs_get_blob(E_LORA_NVS_ELE_MAC_PARAMS, (void *)LoRaMacGetMacParams(), &length);
// write the channel list directly from the NVRAM
ChannelParams_t *channels;
LoRaMacGetChannelList(&channels, &length);
modlora_nvs_get_blob(E_LORA_NVS_ELE_CHANNELS, channels, &length);
// write the channel mask directly from the NVRAM
uint16_t *channelmask;
if (LoRaMacGetChannelsMask(&channelmask, &length)) {
modlora_nvs_get_blob(E_LORA_NVS_ELE_CHANNELMASK, channelmask, &length);
}
// write the channel mask remaining directly from the NVRAM
if (LoRaMacGetChannelsMaskRemaining(&channelmask, &length)) {
modlora_nvs_get_blob(E_LORA_NVS_ELE_CHANNELMASK_REMAINING, channelmask, &length);
}
uint32_t srv_ack_req;
modlora_nvs_get_uint(E_LORA_NVS_ELE_ACK_REQ, (uint32_t *)&srv_ack_req);
bool *ack_req = LoRaMacGetSrvAckRequested();
if (srv_ack_req) {
*ack_req = true;
} else {
*ack_req = false;
}
uint32_t mac_cmd_next_tx;
modlora_nvs_get_uint(E_LORA_NVS_MAC_NXT_TX, (uint32_t *)&mac_cmd_next_tx);
bool *next_tx = LoRaMacGetMacCmdNextTx();
if (mac_cmd_next_tx) {
*next_tx = true;
} else {
*next_tx = false;
}
uint32_t mac_cmd_buffer_idx;
modlora_nvs_get_uint(E_LORA_NVS_MAC_CMD_BUF_IDX, (uint32_t *)&mac_cmd_buffer_idx);
uint8_t *buffer_idx = LoRaMacGetMacCmdBufferIndex();
*buffer_idx = mac_cmd_buffer_idx;
modlora_nvs_get_uint(E_LORA_NVS_MAC_CMD_BUF_RPT_IDX, (uint32_t *)&mac_cmd_buffer_idx);
buffer_idx = LoRaMacGetMacCmdBufferRepeatIndex();
*buffer_idx = mac_cmd_buffer_idx;
// write the buffered MAC commads directly from NVRAM
length = 128;
modlora_nvs_get_blob(E_LORA_NVS_ELE_MAC_BUF, (void *)LoRaMacGetMacCmdBuffer(), &length);
// write the buffered MAC commads to repeat directly from NVRAM
length = 128;
modlora_nvs_get_blob(E_LORA_NVS_ELE_MAC_RPT_BUF, (void *)LoRaMacGetMacCmdBufferRepeat(), &length);
lora_obj.activation = E_LORA_ACTIVATION_ABP;
lora_obj.state = E_LORA_STATE_JOIN;
// clear the joined flag until the nvram_save method is called again
modlora_nvs_set_uint(E_LORA_NVS_ELE_JOINED, (uint32_t)false);
} else {
lora_obj.state = E_LORA_STATE_IDLE;
}
} else {
lora_obj.state = E_LORA_STATE_IDLE;
}
} else {
// radio initialization
RadioEvents.TxDone = OnTxDone;
RadioEvents.RxDone = OnRxDone;
RadioEvents.TxTimeout = OnTxTimeout;
RadioEvents.RxTimeout = OnRxTimeout;
RadioEvents.RxError = OnRxError;
Radio.Init(&RadioEvents);
// radio configuration
lora_radio_setup(&task_cmd_data.info.init);
lora_obj.state = E_LORA_STATE_IDLE;
}
lora_obj.joined = false;
if (lora_obj.state == E_LORA_STATE_IDLE) {
xEventGroupSetBits(LoRaEvents, LORA_STATUS_COMPLETED);
}
break;
case E_LORA_CMD_JOIN:
lora_obj.joined = false;
lora_obj.activation = task_cmd_data.info.join.activation;
if (lora_obj.activation == E_LORA_ACTIVATION_OTAA) {
memcpy((void *)lora_obj.u.otaa.DevEui, task_cmd_data.info.join.u.otaa.DevEui, sizeof(lora_obj.u.otaa.DevEui));
memcpy((void *)lora_obj.u.otaa.AppEui, task_cmd_data.info.join.u.otaa.AppEui, sizeof(lora_obj.u.otaa.AppEui));
memcpy((void *)lora_obj.u.otaa.AppKey, task_cmd_data.info.join.u.otaa.AppKey, sizeof(lora_obj.u.otaa.AppKey));
lora_obj.otaa_dr = task_cmd_data.info.join.otaa_dr;
} else {
lora_obj.net_id = DEF_LORAWAN_NETWORK_ID;
lora_obj.u.abp.DevAddr = task_cmd_data.info.join.u.abp.DevAddr;
memcpy((void *)lora_obj.u.abp.AppSKey, task_cmd_data.info.join.u.abp.AppSKey, sizeof(lora_obj.u.abp.AppSKey));
memcpy((void *)lora_obj.u.abp.NwkSKey, task_cmd_data.info.join.u.abp.NwkSKey, sizeof(lora_obj.u.abp.NwkSKey));
}
lora_obj.state = E_LORA_STATE_JOIN;
break;
case E_LORA_CMD_TX:
#if defined(FIPY) || defined(LOPY4)
xSemaphoreTake(xLoRaSigfoxSem, portMAX_DELAY);
#endif
Radio.Send(task_cmd_data.info.tx.data, task_cmd_data.info.tx.len);
lora_obj.state = E_LORA_STATE_TX;
break;
case E_LORA_CMD_CONFIG_CHANNEL:
if (task_cmd_data.info.channel.add) {
ChannelParams_t channel =
{ task_cmd_data.info.channel.frequency, 0, {((task_cmd_data.info.channel.dr_max << 4) | task_cmd_data.info.channel.dr_min)}, 0};
ChannelAddParams_t channelAdd = { &channel, task_cmd_data.info.channel.index };
RegionChannelManualAdd(lora_obj.region, &channelAdd);
} else {
ChannelRemoveParams_t channelRemove = { task_cmd_data.info.channel.index };
RegionChannelsManualRemove(lora_obj.region, &channelRemove);
}
xEventGroupSetBits(LoRaEvents, LORA_STATUS_COMPLETED);
break;
case E_LORA_CMD_LORAWAN_TX: {
LoRaMacTxInfo_t txInfo;
EventBits_t status = 0;
bool empty_frame = false;
int8_t mac_datarate = 0;
// set the new data rate before checking if Tx is possible, but store the current one
if (!lora_obj.adr) {
mibReq.Type = MIB_CHANNELS_DATARATE;
LoRaMacMibGetRequestConfirm( &mibReq );
mac_datarate = mibReq.Param.ChannelsDatarate;
mibReq.Param.ChannelsDatarate = task_cmd_data.info.tx.dr;
LoRaMacMibSetRequestConfirm( &mibReq );
}
if (LoRaMacQueryTxPossible (task_cmd_data.info.tx.len, &txInfo) != LORAMAC_STATUS_OK) {
// send an empty frame in order to flush MAC commands
mcpsReq.Type = MCPS_UNCONFIRMED;
mcpsReq.Req.Unconfirmed.fBuffer = NULL;
mcpsReq.Req.Unconfirmed.fBufferSize = 0;
mcpsReq.Req.Unconfirmed.Datarate = task_cmd_data.info.tx.dr;
empty_frame = true;
status |= LORA_STATUS_MSG_SIZE;
} else {
if (task_cmd_data.info.tx.confirmed) {
mcpsReq.Type = MCPS_CONFIRMED;
mcpsReq.Req.Confirmed.fPort = task_cmd_data.info.tx.port;
mcpsReq.Req.Confirmed.fBuffer = task_cmd_data.info.tx.data;
mcpsReq.Req.Confirmed.fBufferSize = task_cmd_data.info.tx.len;
mcpsReq.Req.Confirmed.NbTrials = lora_obj.tx_retries + 1;
mcpsReq.Req.Confirmed.Datarate = task_cmd_data.info.tx.dr;
} else {
mcpsReq.Type = MCPS_UNCONFIRMED;
mcpsReq.Req.Unconfirmed.fPort = task_cmd_data.info.tx.port;
mcpsReq.Req.Unconfirmed.fBuffer = task_cmd_data.info.tx.data;
mcpsReq.Req.Unconfirmed.fBufferSize = task_cmd_data.info.tx.len;
mcpsReq.Req.Unconfirmed.Datarate = task_cmd_data.info.tx.dr;
}
}
#if defined(FIPY) || defined(LOPY4)
xSemaphoreTake(xLoRaSigfoxSem, portMAX_DELAY);
#endif
// set back the original datarate
if (!lora_obj.adr) {
mibReq.Param.ChannelsDatarate = mac_datarate;
LoRaMacMibSetRequestConfirm( &mibReq );
}
if (LoRaMacMcpsRequest(&mcpsReq) != LORAMAC_STATUS_OK || empty_frame) {
// the command has failed, send the response now
lora_obj.state = E_LORA_STATE_IDLE;
status |= LORA_STATUS_ERROR;
xEventGroupSetBits(LoRaEvents, status);
#if defined(FIPY) || defined(LOPY4)
xSemaphoreGive(xLoRaSigfoxSem);
#endif
} else {
lora_obj.state = E_LORA_STATE_TX;
}
}
break;
case E_LORA_CMD_SLEEP:
Radio.Sleep();
lora_obj.state = E_LORA_STATE_SLEEP;
xEventGroupSetBits(LoRaEvents, LORA_STATUS_COMPLETED);
#if defined(FIPY) || defined(LOPY4)
xSemaphoreGive(xLoRaSigfoxSem);
#endif
break;
case E_LORA_CMD_WAKE_UP:
// just enable the receiver again
Radio.Rx(LORA_RX_TIMEOUT);
lora_obj.state = E_LORA_STATE_RX;
xEventGroupSetBits(LoRaEvents, LORA_STATUS_COMPLETED);
#if defined(FIPY) || defined(LOPY4)
xSemaphoreGive(xLoRaSigfoxSem);
#endif
break;
default:
break;
}
} else if (lora_obj.state == E_LORA_STATE_IDLE && lora_obj.stack_mode == E_LORA_STACK_MODE_LORA) {
Radio.Rx(LORA_RX_TIMEOUT);
lora_obj.state = E_LORA_STATE_RX;
}
break;
case E_LORA_STATE_JOIN:
TimerStop( &TxNextActReqTimer );
if (!lora_obj.joined) {
if (lora_obj.activation == E_LORA_ACTIVATION_OTAA) {
#if defined(FIPY) || defined(LOPY4)
xSemaphoreTake(xLoRaSigfoxSem, portMAX_DELAY);
#endif
mibReq.Type = MIB_NETWORK_ACTIVATION;
mibReq.Param.NetworkActivation = ACTIVATION_TYPE_OTAA;
LoRaMacMibSetRequestConfirm( &mibReq );
TimerStart( &TxNextActReqTimer );
mlmeReq.Type = MLME_JOIN;
mlmeReq.Req.Join.DevEui = (uint8_t *)lora_obj.u.otaa.DevEui;
mlmeReq.Req.Join.AppEui = (uint8_t *)lora_obj.u.otaa.AppEui;
mlmeReq.Req.Join.AppKey = (uint8_t *)lora_obj.u.otaa.AppKey;
mlmeReq.Req.Join.NbTrials = 1;
mlmeReq.Req.Join.DR = (uint8_t) lora_obj.otaa_dr;
LoRaMacMlmeRequest( &mlmeReq );
} else {
mibReq.Type = MIB_NETWORK_ACTIVATION;
mibReq.Param.NetworkActivation = ACTIVATION_TYPE_ABP;
LoRaMacMibSetRequestConfirm( &mibReq );
mibReq.Type = MIB_NET_ID;
mibReq.Param.NetID = lora_obj.net_id;
LoRaMacMibSetRequestConfirm( &mibReq );
mibReq.Type = MIB_DEV_ADDR;
mibReq.Param.DevAddr = (uint32_t)lora_obj.u.abp.DevAddr;
LoRaMacMibSetRequestConfirm( &mibReq );
mibReq.Type = MIB_NWK_SKEY;
mibReq.Param.NwkSKey = (uint8_t *)lora_obj.u.abp.NwkSKey;
LoRaMacMibSetRequestConfirm( &mibReq );
mibReq.Type = MIB_APP_SKEY;
mibReq.Param.AppSKey = (uint8_t *)lora_obj.u.abp.AppSKey;