-
Notifications
You must be signed in to change notification settings - Fork 0
/
BresserWeatherSensorLW.ino
1071 lines (939 loc) · 34 KB
/
BresserWeatherSensorLW.ino
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
///////////////////////////////////////////////////////////////////////////////
// BresserWeatherSensorLW.ino
//
// Bresser 868 MHz Weather Sensor Radio Receiver
// based on ESP32 and RFM95W/SX1276/SX1262 -
// sends data to a LoRaWAN network (e.g. The Things Network)
//
// The radio transceiver is used with RadioLib
// in FSK mode to receive weather sensor data
// and
// in LoRaWAN mode to connect to a LoRaWAN network
//
// Based on:
// ---------
// RadioLib by Jan Gromeš (https://github.com/jgromes/RadioLib)
// Persistence support for RadioLib (https://github.com/radiolib-org/radiolib-persistence)
// Bresser5in1-CC1101 by Sean Siford (https://github.com/seaniefs/Bresser5in1-CC1101)
// rtl_433 (https://github.com/merbanan/rtl_433)
// BresserWeatherSensorTTN by Matthias Prinke (https://github.com/matthias-bs/BresserWeatherSensorTTN)
// Lora-Serialization by Joscha Feth (https://github.com/thesolarnomad/lora-serialization)
// ESP32Time by Felix Biego (https://github.com/fbiego/ESP32Time)
// OneWireNg by Piotr Stolarz (https://github.com/pstolarz/OneWireNg)
// DallasTemperature / Arduino-Temperature-Control-Library by Miles Burton (https://github.com/milesburton/Arduino-Temperature-Control-Library)
//
// Library dependencies (tested versions):
// ---------------------------------------
// (install via normal Arduino Library installer:)
// RadioLib 6.6.0
// LoRa_Serialization 3.2.1
// ESP32Time 2.0.6
// BresserWeatherSensorReceiver 0.28.2
// OneWireNg 0.13.1 (optional)
// DallasTemperature 3.9.0 (optional)
// NimBLE-Arduino 1.4.1 (optional)
// ATC MiThermometer 0.4.2 (optional)
// Theengs Decoder 1.7.8 (optional)
//
// (installed from ZIP file:)
// DistanceSensor_A02YYUW 1.0.2 (optional)
//
// created: 04/2024
//
//
// MIT License
//
// Copyright (c) 2024 Matthias Prinke
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//
//
// History:
//
// 20240407 Created from
// https://github.com/matthias-bs/BresserWeatherSensorTTN (v0.12.2)
// https://github.com/jgromes/RadioLib/blob/master/examples/LoRaWAN/LoRaWAN_Reference/LoRaWAN_Reference.ino
// https://github.com/radiolib-org/radiolib-persistence/blob/main/examples/LoRaWAN_ESP32/LoRaWAN_ESP32.ino
// 20240410 Added RP2040 specific implementation
// Added minimum sleep interval (and thus uplink interval)
// Added M5Stack Core2 initialization
// 20240414 Added separation between LoRaWAN and application layer
// Fixed battLevel calculation
// 20240415 Added ESP32-S3 PowerFeather
// 20240416 Added enabling of 3.3V power supply for FeatherWing on ESP32-S3 PowerFeather
// 20240423 Removed rtcSyncReq & runtimeExpired, added rtcTimeSource
// 20240424 Added appLayer.begin()
// 20240504 PowerFeather: added BATTERY_CAPACITY_MAH to init()
// Added BresserWeatherSensorLWCmd.h
// 20240505 Implemented loading of LoRaWAN secrets from file on LittleFS (if available)
// 20230524 Modified PAYLOAD_SIZE: Moved define to header file, added small reserve
// to uplinkPayload[], modified actual size in sendReceive()
// 20240528 Disabled uplink transmission of LoRaWAN node status flags
// 20242529 Fixed payload size calculation
// 20240530 Updated to RadioLib v6.6.0
// 20240603 Added AppLayer status uplink
// 20240606 Changed appStatusUplinkInterval from const to variable
// 20240608 Added LoRaWAN device status uplink
// 20240630 Switched to lwActivate() from radiolib-persistence/examples/LoRaWAN_ESP32
//
// ToDo:
// -
//
// Notes:
// - Set "Core Debug Level: Debug" for initial testing
// - The lines with "#pragma message()" in the compiler output are not errors, but useful hints!
// - The default LoRaWAN credentials are read at compile time from secrets.h (included in config.h),
// they can be overriden by the JSON file secrets.json placed in LittleFS
// (Use https://github.com/earlephilhower/arduino-littlefs-upload for uploading.)
// - Pin mapping of radio transceiver module is done in two places:
// - BresserWeatherSensorLW: config.h
// - BresserWeatherSensorReceiver: WeatherSensorCfg.h
// - After a successful transmission, the controller can go into deep sleep
// - If joining the network or transmitting uplink data fails,
// the controller will go into deep sleep
// - For LoRaWAN Specification 1.1.0, a small set of data (the "nonces") have to be stored persistently -
// this implementation uses Flash (via Preferences library
// - Storing LoRaWAN network session information speeds up the connection (join) after a restart -
// this implementation uses the ESP32's RTC RAM or a variable located in the RP2040's RAM, respectively.
// In the latter case, an uninitialzed linker section is used for this purpose.
// - The ESP32's Bluetooth LE interface is used to access sensor data (option)
// - settimeofday()/gettimeofday() must be used to access the ESP32's RTC time
// - Arduino ESP32 package has built-in time zone handling, see
// https://github.com/SensorsIot/NTP-time-for-ESP8266-and-ESP32/blob/master/NTP_Example/NTP_Example.ino
//
///////////////////////////////////////////////////////////////////////////////
/*! \file BresserWeatherSensorLW.ino */
#if !defined(ESP32) && !defined(ARDUINO_ARCH_RP2040)
#pragma error("This is not the example your device is looking for - ESP32 & RP2040 only")
#endif
// LoRa_Serialization
#include <LoraMessage.h>
// ##### load the ESP32 preferences facilites
#include <Preferences.h>
static Preferences store;
/// Preferences (stored in flash memory)
static Preferences preferences;
struct sPrefs
{
uint16_t sleep_interval; //!< preferences: sleep interval
uint16_t sleep_interval_long; //!< preferences: sleep interval long
} prefs;
// Logging macros for RP2040
#include "src/logging.h"
#if defined(ARDUINO_ARCH_RP2040)
#include "src/rp2040/pico_rtc_utils.h"
#include <hardware/rtc.h>
#endif
#if defined(ARDUINO_M5STACK_Core2) || defined(ARDUINO_M5STACK_CORE2)
#include <M5Unified.h>
#endif
#if defined(ARDUINO_ESP32S3_POWERFEATHER)
#include <PowerFeather.h>
using namespace PowerFeather;
#endif
// LoRaWAN config, credentials & pinmap
#include "config.h"
#include <RadioLib.h>
#include <ESP32Time.h>
#include <LittleFS.h>
#include <ArduinoJson.h>
#include "BresserWeatherSensorLWCfg.h"
#include "BresserWeatherSensorLWCmd.h"
#include "src/AppLayer.h"
#include "src/adc/adc.h"
// Time zone info
const char *TZ_INFO = TZINFO_STR;
// Time source & status, see below
//
// bits 0..3 time source
// 0x00 = GPS
// 0x01 = RTC
// 0x02 = LORA
// 0x03 = unsynched
// 0x04 = set (source unknown)
//
// bits 4..7 esp32 sntp time status (not used)
enum class E_TIME_SOURCE : uint8_t
{
E_GPS = 0x00,
E_RTC = 0x01,
E_LORA = 0x02,
E_UNSYNCHED = 0x04,
E_SET = 0x08
};
// Variables which must retain their values after deep sleep
#if defined(ESP32)
// Stored in RTC RAM
RTC_DATA_ATTR bool longSleep; //!< last sleep interval; 0 - normal / 1 - long
RTC_DATA_ATTR time_t rtcLastClockSync = 0; //!< timestamp of last RTC synchonization to network time
// utilities & vars to support ESP32 deep-sleep. The RTC_DATA_ATTR attribute
// puts these in to the RTC memory which is preserved during deep-sleep
RTC_DATA_ATTR uint16_t bootCount = 1;
RTC_DATA_ATTR uint16_t bootCountSinceUnsuccessfulJoin = 0;
RTC_DATA_ATTR E_TIME_SOURCE rtcTimeSource;
RTC_DATA_ATTR bool appStatusUplinkPending = false;
RTC_DATA_ATTR uint8_t LWsession[RADIOLIB_LORAWAN_SESSION_BUF_SIZE];
#else
// Saved to/restored from Watchdog SCRATCH registers
bool longSleep; //!< last sleep interval; 0 - normal / 1 - long
time_t rtcLastClockSync; //!< timestamp of last RTC synchonization to network time
// utilities & vars to support deep-sleep
// Saved to/restored from Watchdog SCRATCH registers
uint16_t bootCount;
uint16_t bootCountSinceUnsuccessfulJoin;
/// RP2040 RAM is preserved during sleep; we just have to ensure that it is not initialized at startup (after reset)
uint8_t LWsession[RADIOLIB_LORAWAN_SESSION_BUF_SIZE] __attribute__((section(".uninitialized_data")));
/// RTC time source
E_TIME_SOURCE rtcTimeSource __attribute__((section(".uninitialized_data")));
/// AppLayer status uplink pending
bool appStatusUplinkPending __attribute__((section(".uninitialized_data")));
#endif
/// Real time clock
ESP32Time rtc;
/// Application layer
AppLayer appLayer(&rtc, &rtcLastClockSync);
#if defined(ESP32)
/*!
* \brief Print wakeup reason (ESP32 only)
*
* Abbreviated version from the Arduino-ESP32 package, see
* https://espressif-docs.readthedocs-hosted.com/projects/arduino-esp32/en/latest/api/deepsleep.html
* for the complete set of options.
*/
void print_wakeup_reason()
{
esp_sleep_wakeup_cause_t wakeup_reason = esp_sleep_get_wakeup_cause();
if (wakeup_reason == ESP_SLEEP_WAKEUP_TIMER)
{
log_i("Wake from sleep");
}
else
{
log_i("Wake not caused by deep sleep: %u", wakeup_reason);
}
}
#endif
/*!
* \brief Load LoRaWAN secrets from file 'secrets.json' on LittleFS, if available
*
* Returns all values by reference/pointer
*
* Use https://github.com/earlephilhower/arduino-littlefs-upload for uploading
* the file to Flash.
*
* \param joinEUI
* \param devEUI
* \param nwkKey
* \param appKey
*/
void loadSecrets(uint64_t &joinEUI, uint64_t &devEUI, uint8_t *nwkKey, uint8_t *appKey)
{
if (!LittleFS.begin(
#if defined(ESP32)
// Format the LittleFS partition on error; parameter only available for ESP32
true
#endif
))
{
log_d("Could not initialize LittleFS.");
}
else
{
File file = LittleFS.open("/secrets.json", "r");
if (!file)
{
log_i("File 'secrets.json' not found.");
}
else
{
log_d("Reading 'secrets.json'");
JsonDocument doc;
// Deserialize the JSON document
DeserializationError error = deserializeJson(doc, file);
if (error)
{
log_d("Failed to read JSON file, using defaults.");
}
else
{
const char *joinEUIStr = doc["joinEUI"];
if (joinEUIStr == nullptr)
{
log_e("Missing joinEUI.");
file.close();
return;
}
uint64_t _joinEUI = 0;
for (int i = 2; i < 18; i += 2)
{
char tmpStr[3] = "";
unsigned int tmpByte;
strncpy(tmpStr, &joinEUIStr[i], 2);
sscanf(tmpStr, "%x", &tmpByte);
_joinEUI = (_joinEUI << 8) | tmpByte;
}
// printf() cannot print 64-bit hex numbers (sic!), so we split it in two 32-bit numbers...
log_d("joinEUI: 0x%08X%08X", static_cast<uint32_t>(_joinEUI >> 32), static_cast<uint32_t>(_joinEUI & 0xFFFFFFFF));
const char *devEUIStr = doc["devEUI"];
if (devEUIStr == nullptr)
{
log_e("Missing devEUI.");
file.close();
return;
}
uint64_t _devEUI = 0;
for (int i = 2; i < 18; i += 2)
{
char tmpStr[3] = "";
unsigned int tmpByte;
strncpy(tmpStr, &devEUIStr[i], 2);
sscanf(tmpStr, "%x", &tmpByte);
_devEUI = (_devEUI << 8) | tmpByte;
}
if (_devEUI == 0)
{
log_e("devEUI is zero.");
file.close();
return;
}
// printf() cannot print 64-bit hex numbers (sic!), so we split it in two 32-bit numbers...
log_d("devEUI: 0x%08X%08X", static_cast<uint32_t>(_devEUI >> 32), static_cast<uint32_t>(_devEUI & 0xFFFFFFFF));
uint8_t check = 0;
bool fail = false;
log_d("nwkKey:");
uint8_t _nwkKey[16];
for (size_t i = 0; i < 16; i++)
{
const char *buf = doc["nwkKey"][i];
if (buf == nullptr)
{
fail = true;
break;
}
unsigned int tmp;
sscanf(buf, "%x", &tmp);
_nwkKey[i] = static_cast<uint8_t>(tmp);
check |= _nwkKey[i];
#if CORE_DEBUG_LEVEL >= ARDUHAL_LOG_LEVEL_INFO
printf("0x%02X", _nwkKey[i]);
if (i < 15)
{
printf(", ");
}
#endif
} // for all nwk_key bytes
#if CORE_DEBUG_LEVEL >= ARDUHAL_LOG_LEVEL_INFO
printf("\n");
#endif
if (fail || (check == 0))
{
log_e("nwkKey parse error");
file.close();
return;
}
check = 0;
log_i("appKey:");
uint8_t _appKey[16];
for (size_t i = 0; i < 16; i++)
{
const char *buf = doc["appKey"][i];
if (buf == nullptr)
{
fail = true;
break;
}
unsigned int tmp;
sscanf(buf, "%x", &tmp);
_appKey[i] = static_cast<uint8_t>(tmp);
check |= _appKey[i];
#if CORE_DEBUG_LEVEL >= ARDUHAL_LOG_LEVEL_INFO
printf("0x%02X", _appKey[i]);
if (i < 15)
{
printf(", ");
}
#endif
} // for all app_key bytes
#if CORE_DEBUG_LEVEL >= ARDUHAL_LOG_LEVEL_INFO
printf("\n");
#endif
if (fail || (check == 0))
{
log_e("appKey parse error");
file.close();
return;
}
// Every check passed, copy intermediate values as result
joinEUI = _joinEUI;
devEUI = _devEUI;
memcpy(nwkKey, _nwkKey, 16);
memcpy(appKey, _appKey, 16);
} // deserializeJson o.k.
} // file read o.k.
file.close();
} // LittleFS o.k.
}
/*!
* \brief Compute sleep duration
*
* Minimum duration: SLEEP_INTERVAL_MIN
* If battery voltage is available and <= BATTERY_WEAK:
* sleep_interval_long
* else
* sleep_interval
*
* Additionally, the sleep interval is reduced from the
* default value to achieve a wake-up time alinged to
* an integer multiple of the interval after a full hour.
*
* \returns sleep duration in seconds
*/
uint32_t sleepDuration(void)
{
uint32_t sleep_interval = prefs.sleep_interval;
longSleep = false;
uint16_t voltage = getBatteryVoltage();
// Long sleep interval if battery is weak
if (voltage && voltage <= BATTERY_WEAK)
{
sleep_interval = prefs.sleep_interval_long;
longSleep = true;
}
// If the real time is available, align the wake-up time to the
// to next non-fractional multiple of sleep_interval past the hour
if (rtcLastClockSync)
{
struct tm timeinfo;
time_t t_now = rtc.getLocalEpoch();
localtime_r(&t_now, &timeinfo);
sleep_interval = sleep_interval - ((timeinfo.tm_min * 60) % sleep_interval + timeinfo.tm_sec);
}
sleep_interval = max(sleep_interval, static_cast<uint32_t>(SLEEP_INTERVAL_MIN));
return sleep_interval;
}
#if defined(ESP32)
/*!
* \brief Enter sleep mode (ESP32 variant)
*
* ESP32 deep sleep mode
*
* \param seconds sleep duration in seconds
*/
void gotoSleep(uint32_t seconds)
{
esp_sleep_enable_timer_wakeup(seconds * 1000UL * 1000UL); // function uses uS
log_i("Sleeping for %lu s", seconds);
Serial.flush();
esp_deep_sleep_start();
// if this appears in the serial debug, we didn't go to sleep!
// so take defensive action so we don't continually uplink
log_w("\n\n### Sleep failed, delay of 5 minutes & then restart ###");
delay(5UL * 60UL * 1000UL);
ESP.restart();
}
#else
/*!
* \brief Enter sleep mode (RP2040 variant)
*
* \param seconds sleep duration in seconds
*/
void gotoSleep(uint32_t seconds)
{
log_i("Sleeping for %lu s", seconds);
time_t t_now = rtc.getLocalEpoch();
datetime_t dt;
epoch_to_datetime(&t_now, &dt);
rtc_set_datetime(&dt);
sleep_us(64);
pico_sleep(seconds);
// Save variables to be retained after reset
watchdog_hw->scratch[3] = (bootCountSinceUnsuccessfulJoin << 16) | bootCount;
watchdog_hw->scratch[2] = rtcLastClockSync;
if (longSleep)
{
watchdog_hw->scratch[1] |= 2;
}
else
{
watchdog_hw->scratch[1] &= ~2;
}
// Save the current time, because RTC will be reset (SIC!)
rtc_get_datetime(&dt);
time_t now = datetime_to_epoch(&dt, NULL);
watchdog_hw->scratch[0] = now;
log_i("Now: %llu", now);
rp2040.restart();
}
#endif
/// Print date and time (i.e. local time)
void printDateTime(void)
{
struct tm timeinfo;
char tbuf[25];
time_t tnow = rtc.getLocalEpoch();
localtime_r(&tnow, &timeinfo);
strftime(tbuf, 25, "%Y-%m-%d %H:%M:%S", &timeinfo);
log_i("%s", tbuf);
}
/*!
* \brief Decode downlink
*
* \param port downlink message port
* \param payload downlink message payload
* \param size downlink message size in bytes
*
* \returns command ID, if downlink message requests a response, otherwise 0
*/
uint8_t decodeDownlink(uint8_t port, uint8_t *payload, size_t size)
{
log_v("Port: %d", port);
if ((port == CMD_GET_DATETIME) && (payload[0] == 0x00) && (size == 1))
{
log_d("Get date/time");
return CMD_GET_DATETIME;
}
if ((port == CMD_SET_DATETIME) && (size == 4))
{
time_t set_time = (payload[0] << 24) | (payload[1] << 16) | (payload[2] << 8) | payload[3];
rtc.setTime(set_time);
rtcLastClockSync = rtc.getLocalEpoch();
rtcTimeSource = E_TIME_SOURCE::E_SET;
#if CORE_DEBUG_LEVEL >= ARDUHAL_LOG_LEVEL_DEBUG
char tbuf[25];
struct tm timeinfo;
localtime_r(&set_time, &timeinfo);
strftime(tbuf, 25, "%Y-%m-%d %H:%M:%S", &timeinfo);
log_d("Set date/time: %s", tbuf);
#endif
return 0;
}
if ((port == CMD_SET_SLEEP_INTERVAL) && (size == 2))
{
prefs.sleep_interval = (payload[0] << 8) | payload[1];
log_d("Set sleep_interval: %u s", prefs.sleep_interval);
preferences.begin("BWS-LW", false);
preferences.putUShort("sleep_int", prefs.sleep_interval);
preferences.end();
return 0;
}
if ((port == CMD_SET_SLEEP_INTERVAL_LONG) && (size == 2))
{
prefs.sleep_interval_long = (payload[0] << 8) | payload[1];
log_d("Set sleep_interval_long: %u s", prefs.sleep_interval_long);
preferences.begin("BWS-LW", false);
preferences.putUShort("sleep_int_long", prefs.sleep_interval_long);
preferences.end();
return 0;
}
if ((port == CMD_GET_LW_CONFIG) && (payload[0] == 0x00) && (size == 1))
{
log_d("Get config");
return CMD_GET_LW_CONFIG;
}
if ((port == CMD_GET_LW_STATUS) && (payload[0] == 0x00) && (size == 1))
{
log_d("Get device status");
return CMD_GET_LW_STATUS;
}
log_d("appLayer.decodeDownlink(port=%d, payload[0]=0x%02X, size=%d)", port, payload[0], size);
return appLayer.decodeDownlink(port, payload, size);
}
/*!
* \brief Send configuration uplink
*
* \param uplinkRequest command ID of uplink request
*/
void sendCfgUplink(uint8_t uplinkReq)
{
log_d("--- Uplink Configuration/Status ---");
uint8_t uplinkPayload[48];
uint8_t port = uplinkReq;
//
// Encode data as byte array for LoRaWAN transmission
//
LoraEncoder encoder(uplinkPayload);
if (uplinkReq == CMD_GET_DATETIME)
{
log_d("Date/Time");
time_t t_now = rtc.getLocalEpoch();
encoder.writeUint8((t_now >> 24) & 0xff);
encoder.writeUint8((t_now >> 16) & 0xff);
encoder.writeUint8((t_now >> 8) & 0xff);
encoder.writeUint8(t_now & 0xff);
encoder.writeUint8(static_cast<uint8_t>(rtcTimeSource));
}
else if (uplinkReq == CMD_GET_LW_CONFIG)
{
log_d("LoRaWAN Config");
encoder.writeUint8(prefs.sleep_interval >> 8);
encoder.writeUint8(prefs.sleep_interval & 0xFF);
encoder.writeUint8(prefs.sleep_interval_long >> 8);
encoder.writeUint8(prefs.sleep_interval_long & 0xFF);
}
else if (uplinkReq == CMD_GET_LW_STATUS)
{
uint8_t status = longSleep ? 1 : 0;
log_d("Device Status: U_batt=%u mV, longSleep=%u", getBatteryVoltage(), status);
encoder.writeUint16(getBatteryVoltage());
encoder.writeUint8(status);
}
else
{
appLayer.getConfigPayload(uplinkReq, port, encoder);
}
log_d("Configuration uplink: port=%d, size=%d", port, encoder.getLength());
for (int i = 0; i < encoder.getLength(); i++)
{
Serial.printf("%02X ", uplinkPayload[i]);
}
Serial.println();
// wait before sending uplink
uint32_t minimumDelay = uplinkIntervalSeconds * 1000UL;
uint32_t interval = node.timeUntilUplink(); // calculate minimum duty cycle delay (per FUP & law!)
uint32_t delayMs = max(interval, minimumDelay); // cannot send faster than duty cycle allows
log_d("Sending configuration uplink in %u s", delayMs / 1000);
delay(delayMs);
log_d("Sending configuration uplink now.");
int16_t state = node.sendReceive(uplinkPayload, encoder.getLength(), port);
debug((state != RADIOLIB_LORAWAN_NO_DOWNLINK) && (state != RADIOLIB_ERR_NONE), "Error in sendReceive", state, false);
}
/*!
* \brief Activate node by restoring session or otherwise joining the network
*
* \return RADIOLIB_LORAWAN_NEW_SESSION or RADIOLIB_LORAWAN_SESSION_RESTORED
*/
int16_t lwActivate(void)
{
int16_t state = RADIOLIB_ERR_UNKNOWN;
// setup the OTAA session information
node.beginOTAA(joinEUI, devEUI, nwkKey, appKey);
log_d("Recalling LoRaWAN nonces & session");
// ##### setup the flash storage
store.begin("radiolib");
// ##### if we have previously saved nonces, restore them and try to restore session as well
if (store.isKey("nonces"))
{
uint8_t buffer[RADIOLIB_LORAWAN_NONCES_BUF_SIZE]; // create somewhere to store nonces
store.getBytes("nonces", buffer, RADIOLIB_LORAWAN_NONCES_BUF_SIZE); // get them from the store
state = node.setBufferNonces(buffer); // send them to LoRaWAN
debug(state != RADIOLIB_ERR_NONE, "Restoring nonces buffer failed", state, false);
// recall session from RTC deep-sleep preserved variable
state = node.setBufferSession(LWsession); // send them to LoRaWAN stack
// if we have booted more than once we should have a session to restore, so report any failure
// otherwise no point saying there's been a failure when it was bound to fail with an empty LWsession var.
debug((state != RADIOLIB_ERR_NONE) && (bootCount > 1), "Restoring session buffer failed", state, false);
// if Nonces and Session restored successfully, activation is just a formality
// moreover, Nonces didn't change so no need to re-save them
if (state == RADIOLIB_ERR_NONE)
{
log_d("Succesfully restored session - now activating");
state = node.activateOTAA();
debug((state != RADIOLIB_LORAWAN_SESSION_RESTORED), "Failed to activate restored session", state, true);
// ##### close the store before returning
store.end();
return (state);
}
}
else
{ // store has no key "nonces"
log_d("No Nonces saved - starting fresh.");
}
// if we got here, there was no session to restore, so start trying to join
state = RADIOLIB_ERR_NETWORK_NOT_JOINED;
while (state != RADIOLIB_LORAWAN_NEW_SESSION)
{
log_d("Join ('login') to the LoRaWAN Network");
state = node.activateOTAA();
// ##### save the join counters (nonces) to permanent store
log_d("Saving nonces to flash");
uint8_t buffer[RADIOLIB_LORAWAN_NONCES_BUF_SIZE]; // create somewhere to store nonces
uint8_t *persist = node.getBufferNonces(); // get pointer to nonces
memcpy(buffer, persist, RADIOLIB_LORAWAN_NONCES_BUF_SIZE); // copy in to buffer
store.putBytes("nonces", buffer, RADIOLIB_LORAWAN_NONCES_BUF_SIZE); // send them to the store
// we'll save the session after an uplink
if (state != RADIOLIB_LORAWAN_NEW_SESSION)
{
log_d("Join failed: %d", state);
// how long to wait before join attempts. This is an interim solution pending
// implementation of TS001 LoRaWAN Specification section #7 - this doc applies to v1.0.4 & v1.1
// it sleeps for longer & longer durations to give time for any gateway issues to resolve
// or whatever is interfering with the device <-> gateway airwaves.
uint32_t sleepForSeconds = min((bootCountSinceUnsuccessfulJoin++ + 1UL) * 60UL, 3UL * 60UL);
log_i("Boots since unsuccessful join: %u", bootCountSinceUnsuccessfulJoin);
log_i("Retrying join in %u seconds", sleepForSeconds);
gotoSleep(sleepForSeconds);
} // if activateOTAA state
} // while join
log_d("Joined");
// reset the failed join count
bootCountSinceUnsuccessfulJoin = 0;
delay(1000); // hold off off hitting the airwaves again too soon - an issue in the US
// ##### close the store
store.end();
return (state);
}
// setup & execute all device functions ...
void setup()
{
#if defined(ARDUINO_M5STACK_Core2) || defined(ARDUINO_M5STACK_CORE2)
auto cfg = M5.config();
cfg.clear_display = true; // default=true. clear the screen when begin.
cfg.output_power = true; // default=true. use external port 5V output.
cfg.internal_imu = false; // default=true. use internal IMU.
cfg.internal_rtc = true; // default=true. use internal RTC.
cfg.internal_spk = false; // default=true. use internal speaker.
cfg.internal_mic = false; // default=true. use internal microphone.
M5.begin(cfg);
#endif
#if defined(ARDUINO_ESP32S3_POWERFEATHER)
delay(2000);
Board.init(BATTERY_CAPACITY_MAH); // Note: Battery capacity / type has to be set for voltage measurement
Board.enable3V3(true); // Power supply for FeatherWing
Board.enableVSQT(true); // Power supply for battery management chip (voltage measurement)
#endif
Serial.begin(115200);
delay(2000); // give time to switch to the serial monitor
log_i("Setup");
#if defined(ARDUINO_ARCH_RP2040)
// see pico-sdk/src/rp2_common/hardware_rtc/rtc.c
rtc_init();
// Restore variables and RTC after reset
time_t time_saved = watchdog_hw->scratch[0];
datetime_t dt;
epoch_to_datetime(&time_saved, &dt);
// Set HW clock (only used in sleep mode)
rtc_set_datetime(&dt);
// Set SW clock
rtc.setTime(time_saved);
longSleep = ((watchdog_hw->scratch[1] & 2) == 2);
rtcLastClockSync = watchdog_hw->scratch[2];
bootCount = watchdog_hw->scratch[3] & 0xFFFF;
if (bootCount == 0)
{
bootCount = 1;
}
bootCountSinceUnsuccessfulJoin = watchdog_hw->scratch[3] >> 16;
#else
print_wakeup_reason();
#endif
log_i("Boot count: %u", bootCount++);
if (bootCount == 1)
{
rtcTimeSource = E_TIME_SOURCE::E_UNSYNCHED;
appStatusUplinkPending = 0;
}
// Set time zone
setenv("TZ", TZ_INFO, 1);
printDateTime();
// Try to load LoRaWAN secrets from LittleFS file, if available
loadSecrets(joinEUI, devEUI, nwkKey, appKey);
// Initialize Application Layer
appLayer.begin();
preferences.begin("BWS-LW", false);
prefs.sleep_interval = preferences.getUShort("sleep_int", SLEEP_INTERVAL);
log_d("Preferences: sleep_interval: %u s", prefs.sleep_interval);
prefs.sleep_interval_long = preferences.getUShort("sleep_int_long", SLEEP_INTERVAL_LONG);
log_d("Preferences: sleep_interval_long: %u s", prefs.sleep_interval_long);
preferences.end();
uint16_t voltage = getBatteryVoltage();
if (voltage && voltage <= BATTERY_LOW)
{
log_i("Battery low!");
gotoSleep(sleepDuration());
}
// build payload byte array (+ reserve to prevent overflow with configuration at run-time)
uint8_t uplinkPayload[PAYLOAD_SIZE + 8];
LoraEncoder encoder(uplinkPayload);
appLayer.getPayloadStage1(1, encoder);
int16_t state = 0; // return value for calls to RadioLib
// setup the radio based on the pinmap (connections) in config.h
log_v("Initalise the radio");
radio.reset();
state = radio.begin();
debug(state != RADIOLIB_ERR_NONE, "Initalise radio failed", state, true);
// activate node by restoring session or otherwise joining the network
state = lwActivate();
// state is one of RADIOLIB_LORAWAN_NEW_SESSION or RADIOLIB_LORAWAN_SESSION_RESTORED
// Set battery fill level -
// the LoRaWAN network server may periodically request this information
// 0 = external power source
// 1 = lowest (empty battery)
// 254 = highest (full battery)
// 255 = unable to measure
uint8_t battLevel;
if (voltage == 0)
{
battLevel = 255;
}
else if (voltage > BATTERY_CHARGE_LIMIT)
{
battLevel = 0;
}
else
{
battLevel = static_cast<uint8_t>(
static_cast<float>(voltage - BATTERY_DISCHARGE_LIMIT) / static_cast<float>(BATTERY_CHARGE_LIMIT - BATTERY_DISCHARGE_LIMIT) * 255);
battLevel = (battLevel == 0) ? 1 : battLevel;
battLevel = (battLevel == 255) ? 254 : battLevel;
}
log_d("Battery level: %u", battLevel);
node.setDeviceStatus(battLevel);
// Check if clock was never synchronized or sync interval has expired
if ((rtcLastClockSync == 0) || ((rtc.getLocalEpoch() - rtcLastClockSync) > (CLOCK_SYNC_INTERVAL * 60)))
{
log_i("RTC sync required");
node.sendMacCommandReq(RADIOLIB_LORAWAN_MAC_DEVICE_TIME);
}
// Retrieve the last uplink frame counter
uint32_t fCntUp = node.getFCntUp();
// Send a confirmed uplink every 64th frame
// and also request the LinkCheck command
if (fCntUp % 64 == 0)
{
log_i("[LoRaWAN] Requesting LinkCheck");
node.sendMacCommandReq(RADIOLIB_LORAWAN_MAC_LINK_CHECK);
}
// Set appStatusUplink flag if required
uint8_t appStatusUplinkInterval = appLayer.getAppStatusUplinkInterval();
log_i("App status uplink interval: %u", appStatusUplinkInterval);
if (appStatusUplinkInterval && (fCntUp % appStatusUplinkInterval == 0))
{
appStatusUplinkPending = true;
}
// ----- and now for the main event -----
log_i("Sending uplink");
// get payload immediately before uplink - not used here
appLayer.getPayloadStage2(1, encoder);
uint8_t port = 1;
uint8_t downlinkPayload[MAX_DOWNLINK_SIZE]; // Make sure this fits your plans!
size_t downlinkSize; // To hold the actual payload size rec'd
LoRaWANEvent_t uplinkDetails;
LoRaWANEvent_t downlinkDetails;
uint8_t payloadSize = encoder.getLength();
if (payloadSize > PAYLOAD_SIZE)
{
log_w("Payload size exceeds maximum of %u bytes - truncating", PAYLOAD_SIZE);
payloadSize = PAYLOAD_SIZE;
}
// perform an uplink & optionally receive downlink
if (fCntUp % 64 == 0)
{
state = node.sendReceive(
uplinkPayload,
payloadSize,
port,
downlinkPayload,
&downlinkSize,
true,
&uplinkDetails,
&downlinkDetails);
}
else
{
state = node.sendReceive(
uplinkPayload,
payloadSize,
port,
downlinkPayload,
&downlinkSize,
false,
nullptr,
&downlinkDetails);
}
debug((state != RADIOLIB_LORAWAN_NO_DOWNLINK) && (state != RADIOLIB_ERR_NONE), "Error in sendReceive", state, false);
/// Uplink request - command received via downlink
uint8_t uplinkReq = 0;
// Check if downlink was received
if (state != RADIOLIB_LORAWAN_NO_DOWNLINK)
{
// Did we get a downlink with data for us
if (downlinkSize > 0)
{
log_i("Downlink port %u, data: ", downlinkDetails.fPort);
arrayDump(downlinkPayload, downlinkSize);
if (downlinkDetails.fPort > 0)
{
uplinkReq = decodeDownlink(downlinkDetails.fPort, downlinkPayload, downlinkSize);
}
}
else
{
log_d("<MAC commands only>");
}
// print RSSI (Received Signal Strength Indicator)
log_d("[LoRaWAN] RSSI:\t\t%f dBm", radio.getRSSI());
// print SNR (Signal-to-Noise Ratio)