RadioLib
Universal wireless communication library for Arduino
Loading...
Searching...
No Matches
BuildOpt.h
1
#if !defined(_RADIOLIB_BUILD_OPTIONS_H)
2
#define _RADIOLIB_BUILD_OPTIONS_H
3
4
#include "TypeDef.h"
5
6
/* RadioLib build configuration options */
7
8
/*
9
* Debug output enable.
10
* Warning: Debug output will slow down the whole system significantly.
11
* Also, it will result in larger compiled binary.
12
* Levels: basic - only main info
13
* protocol - mainly LoRaWAN stuff, but other protocols as well
14
* SPI - full transcript of all SPI communication
15
*/
16
#if !defined(RADIOLIB_DEBUG_BASIC)
17
#define RADIOLIB_DEBUG_BASIC (0)
18
#endif
19
#if !defined(RADIOLIB_DEBUG_PROTOCOL)
20
#define RADIOLIB_DEBUG_PROTOCOL (0)
21
#endif
22
#if !defined(RADIOLIB_DEBUG_SPI)
23
#define RADIOLIB_DEBUG_SPI (0)
24
#endif
25
#if !defined(RADIOLIB_VERBOSE_ASSERT)
26
#define RADIOLIB_VERBOSE_ASSERT (0)
27
#endif
28
29
// set which output port should be used for debug output
30
// may be Serial port (on Arduino) or file like stdout or stderr (on generic platforms)
31
#if !defined(RADIOLIB_DEBUG_PORT)
32
#if ARDUINO >= 100
33
#define RADIOLIB_DEBUG_PORT Serial
34
#else
35
#define RADIOLIB_DEBUG_PORT stdout
36
#endif
37
#endif
38
39
/*
40
* Comment to disable "paranoid" SPI mode, or set RADIOLIB_SPI_PARANOID to 0
41
* Every write to an SPI register using SPI set function will be verified by a subsequent read operation.
42
* This improves reliability, but slightly slows down communication.
43
* Note: Enabled by default.
44
*/
45
#if !defined(RADIOLIB_SPI_PARANOID)
46
#define RADIOLIB_SPI_PARANOID (1)
47
#endif
48
49
/*
50
* Comment to disable parameter range checking
51
* RadioLib will check provided parameters (such as frequency) against limits determined by the device manufacturer.
52
* It is highly advised to keep this macro defined, removing it will allow invalid values to be set,
53
* possibly leading to bricked module and/or program crashing.
54
* Note: Enabled by default.
55
*/
56
#if !defined(RADIOLIB_CHECK_PARAMS)
57
#define RADIOLIB_CHECK_PARAMS (1)
58
#endif
59
60
/*
61
* SX127x errata fix enable
62
* Warning: SX127x errata fix has been reported to cause issues with LoRa bandwidths lower than 62.5 kHz.
63
* It should only be enabled if you really are observing some errata-related issue.
64
* Note: Disabled by default.
65
*/
66
#if !defined(RADIOLIB_FIX_ERRATA_SX127X)
67
#define RADIOLIB_FIX_ERRATA_SX127X (0)
68
#endif
69
70
/*
71
* God mode enable - all methods and member variables in all classes will be made public, thus making them accessible from Arduino code.
72
* Warning: Come on, it's called GOD mode - obviously only use this if you know what you're doing.
73
* Failure to heed the above warning may result in bricked module.
74
*/
75
#if !defined(RADIOLIB_GODMODE)
76
#define RADIOLIB_GODMODE (0)
77
#endif
78
79
/*
80
* Low-level hardware access enable
81
* This will make some hardware methods like SPI get/set accessible from the user sketch - think of it as "god mode lite"
82
* Warning: RadioLib won't stop you from writing invalid stuff into your device, so it's quite easy to brick your module with this.
83
*/
84
#if !defined(RADIOLIB_LOW_LEVEL)
85
#define RADIOLIB_LOW_LEVEL (0)
86
#endif
87
88
/*
89
* Enable interrupt-based timing control
90
* For details, see https://github.com/jgromes/RadioLib/wiki/Interrupt-Based-Timing
91
*/
92
#if !defined(RADIOLIB_INTERRUPT_TIMING)
93
#define RADIOLIB_INTERRUPT_TIMING (0)
94
#endif
95
96
/*
97
* Enable static-only memory management: no dynamic allocation will be performed.
98
* Warning: Large static arrays will be created in some methods. It is not advised to send large packets in this mode.
99
*/
100
#if !defined(RADIOLIB_STATIC_ONLY)
101
#define RADIOLIB_STATIC_ONLY (0)
102
#endif
103
104
// set the size of static arrays to use
105
#if !defined(RADIOLIB_STATIC_ARRAY_SIZE)
106
#define RADIOLIB_STATIC_ARRAY_SIZE (256)
107
#endif
108
109
// allow user to set custom SPI buffer size
110
// the default covers the maximum supported SPI command, address and status
111
#if !defined(RADIOLIB_STATIC_SPI_ARRAY_SIZE)
112
#define RADIOLIB_STATIC_SPI_ARRAY_SIZE (3*sizeof(uint32_t) + (RADIOLIB_STATIC_ARRAY_SIZE))
113
#endif
114
115
/*
116
* Uncomment on boards whose clock runs too slow or too fast
117
* Set the value according to the following scheme:
118
* Enable timestamps on your terminal
119
* Print something to terminal, wait 1000 milliseconds, print something again
120
* If the difference is e.g. 1014 milliseconds between the prints, set this value to 14
121
* Or, for more accuracy, wait for 100,000 milliseconds and divide the total drift by 100
122
*/
123
#if !defined(RADIOLIB_CLOCK_DRIFT_MS)
124
//#define RADIOLIB_CLOCK_DRIFT_MS (0)
125
#endif
126
127
#if !defined(RADIOLIB_LINE_FEED)
128
#define RADIOLIB_LINE_FEED "\r\n"
129
#endif
130
131
#if ARDUINO >= 100
132
// Arduino build
133
#include "Arduino.h"
134
#define RADIOLIB_BUILD_ARDUINO
135
#else
136
// generic build
137
#include <stdio.h>
138
#define RADIOLIB_BUILD_GENERIC
139
#endif
140
141
#if defined(RADIOLIB_BUILD_ARDUINO)
142
/*
143
* Platform-specific configuration.
144
*
145
* RADIOLIB_PLATFORM - platform name, used in debugging to quickly check the correct platform is detected.
146
* RADIOLIB_NC - alias for unused pin, usually the largest possible value of uint32_t.
147
* RADIOLIB_DEFAULT_SPI - default SPIClass instance to use.
148
* RADIOLIB_NONVOLATILE - macro to place variable into program storage (usually Flash).
149
* RADIOLIB_NONVOLATILE_READ_BYTE - function/macro to read variables saved in program storage (usually Flash).
150
* RADIOLIB_TYPE_ALIAS - construct to create an alias for a type, usually via the `using` keyword.
151
* RADIOLIB_TONE_UNSUPPORTED - some platforms do not have tone()/noTone(), which is required for AFSK.
152
*
153
* Users may also specify their own configuration by uncommenting the RADIOLIB_CUSTOM_ARDUINO,
154
* and then specifying all platform parameters in the section below. This will override automatic
155
* platform detection.
156
*/
157
158
// uncomment to enable custom platform definition
159
//#define RADIOLIB_CUSTOM_ARDUINO
160
161
#if defined(RADIOLIB_CUSTOM_ARDUINO)
162
// name for your platform
163
#define RADIOLIB_PLATFORM "Custom"
164
165
// the following must be defined if the Arduino core does not support tone or yield function
166
//#define RADIOLIB_TONE_UNSUPPORTED
167
//#define RADIOLIB_YIELD_UNSUPPORTED
168
169
// in addition, the following macros may be defined if the Arduino core differs from the defaults
170
#define RADIOLIB_NC (0xFFFFFFFF)
171
#define RADIOLIB_DEFAULT_SPI SPI
172
#define RADIOLIB_DEFAULT_SPI_SETTINGS SPISettings(2000000, MSBFIRST, SPI_MODE0)
173
#define RADIOLIB_NONVOLATILE PROGMEM
174
#define RADIOLIB_NONVOLATILE_READ_BYTE(addr) pgm_read_byte(addr)
175
#define RADIOLIB_NONVOLATILE_READ_DWORD(addr) pgm_read_dword(addr)
176
#define RADIOLIB_TYPE_ALIAS(type, alias) using alias = type;
177
178
// you might also have to define these if the Arduino core has some uncommon pin mode/status types
179
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST
180
#define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST
181
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST
182
183
// some of RadioLib drivers may be excluded, to prevent collisions with platforms (or to speed up build process)
184
// the following is a complete list of all possible exclusion macros, uncomment any of them to disable that driver
185
// NOTE: Some of the exclusion macros are dependent on each other. For example, it is not possible to exclude RF69
186
// while keeping SX1231 (because RF69 is the base class for SX1231). The dependency is always uni-directional,
187
// so excluding SX1231 and keeping RF69 is valid.
188
//#define RADIOLIB_EXCLUDE_CC1101 (1)
189
//#define RADIOLIB_EXCLUDE_NRF24 (1)
190
//#define RADIOLIB_EXCLUDE_RF69 (1)
191
//#define RADIOLIB_EXCLUDE_SX1231 (1) // dependent on RADIOLIB_EXCLUDE_RF69
192
//#define RADIOLIB_EXCLUDE_SI443X (1)
193
//#define RADIOLIB_EXCLUDE_RFM2X (1) // dependent on RADIOLIB_EXCLUDE_SI443X
194
//#define RADIOLIB_EXCLUDE_SX127X (1)
195
//#define RADIOLIB_EXCLUDE_SX126X (1)
196
//#define RADIOLIB_EXCLUDE_STM32WLX (1) // dependent on RADIOLIB_EXCLUDE_SX126X
197
//#define RADIOLIB_EXCLUDE_SX128X (1)
198
//#define RADIOLIB_EXCLUDE_AFSK (1)
199
//#define RADIOLIB_EXCLUDE_AX25 (1)
200
//#define RADIOLIB_EXCLUDE_HELLSCHREIBER (1)
201
//#define RADIOLIB_EXCLUDE_MORSE (1)
202
//#define RADIOLIB_EXCLUDE_RTTY (1)
203
//#define RADIOLIB_EXCLUDE_SSTV (1)
204
//#define RADIOLIB_EXCLUDE_DIRECT_RECEIVE (1)
205
//#define RADIOLIB_EXCLUDE_BELL (1)
206
//#define RADIOLIB_EXCLUDE_APRS (1)
207
//#define RADIOLIB_EXCLUDE_LORAWAN (1)
208
//#define RADIOLIB_EXCLUDE_LR11X0 (1)
209
//#define RADIOLIB_EXCLUDE_FSK4 (1)
210
//#define RADIOLIB_EXCLUDE_PAGER (1)
211
212
#elif defined(__AVR__) && !(defined(ARDUINO_AVR_UNO_WIFI_REV2) || defined(ARDUINO_AVR_NANO_EVERY) || defined(ARDUINO_ARCH_MEGAAVR))
213
// Arduino AVR boards (except for megaAVR) - Uno, Mega etc.
214
#define RADIOLIB_PLATFORM "Arduino AVR"
215
216
#if !(defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__) || defined(__AVR_ATmega1284__) || defined(__AVR_ATmega1284P__))
217
#define RADIOLIB_LOWEND_PLATFORM
218
#endif
219
220
#elif defined(ESP8266)
221
// ESP8266 boards
222
#define RADIOLIB_PLATFORM "ESP8266"
223
224
#elif defined(ESP32) || defined(ARDUINO_ARCH_ESP32)
225
#define RADIOLIB_ESP32
226
227
// ESP32 boards
228
#define RADIOLIB_PLATFORM "ESP32"
229
230
// ESP32 doesn't support tone(), but it can be emulated via LED control peripheral
231
#define RADIOLIB_TONE_UNSUPPORTED
232
#define RADIOLIB_TONE_ESP32_CHANNEL (1)
233
234
#elif defined(ARDUINO_ARCH_STM32)
235
// official STM32 Arduino core (https://github.com/stm32duino/Arduino_Core_STM32)
236
#define RADIOLIB_PLATFORM "Arduino STM32 (official)"
237
238
#elif defined(SAMD_SERIES)
239
// Adafruit SAMD boards (M0 and M4)
240
#define RADIOLIB_PLATFORM "Adafruit SAMD"
241
242
#elif defined(ARDUINO_ARCH_SAMD)
243
// Arduino SAMD (Zero, MKR, etc.)
244
#define RADIOLIB_PLATFORM "Arduino SAMD"
245
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PinMode)
246
#define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
247
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
248
249
#elif defined(__SAM3X8E__)
250
// Arduino Due
251
#define RADIOLIB_PLATFORM "Arduino Due"
252
#define RADIOLIB_TONE_UNSUPPORTED
253
254
#elif (defined(NRF52832_XXAA) || defined(NRF52840_XXAA)) && !defined(ARDUINO_ARDUINO_NANO33BLE)
255
// Adafruit nRF52 boards
256
#define RADIOLIB_PLATFORM "Adafruit nRF52"
257
258
#elif defined(ARDUINO_ARC32_TOOLS)
259
// Intel Curie
260
#define RADIOLIB_PLATFORM "Intel Curie"
261
262
#elif defined(ARDUINO_AVR_UNO_WIFI_REV2) || defined(ARDUINO_AVR_NANO_EVERY) || defined(PORTDUINO)
263
// Arduino megaAVR boards - Uno Wifi Rev.2, Nano Every
264
#define RADIOLIB_PLATFORM "Arduino megaAVR"
265
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PinMode)
266
#define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
267
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
268
269
#elif defined(ARDUINO_ARCH_APOLLO3)
270
// Sparkfun Apollo3 boards
271
#define RADIOLIB_PLATFORM "Sparkfun Apollo3"
272
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (Arduino_PinMode)
273
#define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
274
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
275
276
#elif defined(ARDUINO_ARDUINO_NANO33BLE)
277
// Arduino Nano 33 BLE
278
#define RADIOLIB_PLATFORM "Arduino Nano 33 BLE"
279
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PinMode)
280
#define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
281
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
282
283
#if defined(ARDUINO_ARCH_MBED)
284
// Arduino mbed OS boards have a really bad tone implementation which will crash after a couple seconds
285
#define RADIOLIB_TONE_UNSUPPORTED
286
#define RADIOLIB_MBED_TONE_OVERRIDE
287
#endif
288
289
#elif defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7)
290
// Arduino Portenta H7
291
#define RADIOLIB_PLATFORM "Portenta H7"
292
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PinMode)
293
#define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
294
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
295
296
#if defined(ARDUINO_ARCH_MBED)
297
// Arduino mbed OS boards have a really bad tone implementation which will crash after a couple seconds
298
#define RADIOLIB_TONE_UNSUPPORTED
299
#define RADIOLIB_MBED_TONE_OVERRIDE
300
#endif
301
302
#elif defined(__STM32F4__) || defined(__STM32F1__)
303
// Arduino STM32 core by Roger Clark (https://github.com/rogerclarkmelbourne/Arduino_STM32)
304
#define RADIOLIB_PLATFORM "STM32duino (unofficial)"
305
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (WiringPinMode)
306
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (ExtIntTriggerMode)
307
308
#elif defined(ARDUINO_ARCH_MEGAAVR)
309
// MegaCoreX by MCUdude (https://github.com/MCUdude/MegaCoreX)
310
#define RADIOLIB_PLATFORM "MegaCoreX"
311
312
#elif defined(ARDUINO_ARCH_MBED_RP2040)
313
// Raspberry Pi Pico (official mbed core)
314
#define RADIOLIB_PLATFORM "Raspberry Pi Pico"
315
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PinMode)
316
#define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
317
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
318
319
// Arduino mbed OS boards have a really bad tone implementation which will crash after a couple seconds
320
#define RADIOLIB_TONE_UNSUPPORTED
321
#define RADIOLIB_MBED_TONE_OVERRIDE
322
323
#elif defined(ARDUINO_ARCH_RP2040)
324
// Raspberry Pi Pico (unofficial core)
325
#define RADIOLIB_PLATFORM "Raspberry Pi Pico (unofficial)"
326
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PinMode)
327
#define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
328
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
329
330
#elif defined(__ASR6501__) || defined(ARDUINO_ARCH_ASR650X) || defined(DARDUINO_ARCH_ASR6601)
331
// CubeCell
332
#define RADIOLIB_PLATFORM "CubeCell"
333
#define RADIOLIB_DEFAULT_SPI_SETTINGS SPISettings(1000000, MSBFIRST, SPI_MODE0)
// see issue #709
334
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PINMODE)
335
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (IrqModes)
336
337
// CubeCell doesn't seem to define nullptr, let's do something like that now
338
#define nullptr NULL
339
340
// ... and also defines pinMode() as a macro, which is by far the stupidest thing I have seen on Arduino
341
#undef pinMode
342
343
// ... and uses an outdated GCC which does not support type aliases
344
#define RADIOLIB_TYPE_ALIAS(type, alias) typedef class type alias;
345
346
// ... and it also has no tone(). This platform was designed by an idiot.
347
#define RADIOLIB_TONE_UNSUPPORTED
348
349
// ... AND as the (hopefully) final nail in the coffin, IT F*CKING DEFINES YIELD() AS A MACRO THAT DOES NOTHING!!!
350
#define RADIOLIB_YIELD_UNSUPPORTED
351
#if defined(yield)
352
#undef yield
353
#endif
354
355
#elif defined(RASPI)
356
// RaspiDuino framework (https://github.com/me-no-dev/RasPiArduino)
357
#define RADIOLIB_PLATFORM "RasPiArduino"
358
359
// let's start off easy - no tone on this platform, that can happen
360
#define RADIOLIB_TONE_UNSUPPORTED
361
362
// hmm, no yield either - weird on something like Raspberry PI, but sure, we can handle it
363
#define RADIOLIB_YIELD_UNSUPPORTED
364
365
// aight, getting to the juicy stuff - PGM_P seems missing, that's the first time
366
#define PGM_P const char *
367
368
// ... and for the grand finale, we have millis() and micros() DEFINED AS MACROS!
369
#if defined(millis)
370
#undef millis
371
inline
RadioLibTime_t
millis() {
return
((
RadioLibTime_t
)(STCV / 1000)); };
372
#endif
373
374
#if defined(micros)
375
#undef micros
376
inline
RadioLibTime_t
micros() {
return
((
RadioLibTime_t
)(STCV)); };
377
#endif
378
379
#elif defined(TEENSYDUINO)
380
// Teensy
381
#define RADIOLIB_PLATFORM "Teensy"
382
383
#elif defined(ARDUINO_ARCH_RENESAS)
384
// Arduino Renesas (UNO R4)
385
#define RADIOLIB_PLATFORM "Arduino Renesas (UNO R4)"
386
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PinMode)
387
#define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
388
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
389
390
#elif defined(ARDUINO_ARCH_SILABS)
391
// Silicon Labs Arduino
392
#define RADIOLIB_PLATFORM "Arduino Silicon Labs"
393
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PinMode)
394
#define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
395
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
396
397
#elif defined(ARDUINO_ARCH_ZEPHYR) && defined(ARDUINO_UNO_Q)
398
// Arduino Uno Q (Zephyr OS)
399
#define RADIOLIB_PLATFORM "Arduino Uno Q (Zephyr OS)"
400
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PinMode)
401
#define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
402
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
403
404
#else
405
// other Arduino platforms not covered by the above list - this may or may not work
406
#define RADIOLIB_PLATFORM "Unknown Arduino"
407
#define RADIOLIB_UNKNOWN_PLATFORM
408
409
#endif
410
411
// set the default values for all macros
412
// these will be applied if they were not defined above
413
#if !defined(RADIOLIB_NC)
414
#define RADIOLIB_NC (0xFFFFFFFF)
415
#endif
416
417
#if !defined(RADIOLIB_DEFAULT_SPI)
418
#define RADIOLIB_DEFAULT_SPI SPI
419
#endif
420
421
#if !defined(RADIOLIB_DEFAULT_SPI_SETTINGS)
422
#define RADIOLIB_DEFAULT_SPI_SETTINGS SPISettings(2000000, MSBFIRST, SPI_MODE0)
423
#endif
424
425
#if !defined(RADIOLIB_NONVOLATILE)
426
#define RADIOLIB_NONVOLATILE PROGMEM
427
#endif
428
429
#if !defined(RADIOLIB_NONVOLATILE_PTR)
430
#define RADIOLIB_NONVOLATILE_PTR PGM_P
431
#endif
432
433
#if !defined(RADIOLIB_NONVOLATILE_READ_BYTE)
434
#define RADIOLIB_NONVOLATILE_READ_BYTE(addr) pgm_read_byte(addr)
435
#endif
436
437
#if !defined(RADIOLIB_NONVOLATILE_READ_DWORD)
438
#define RADIOLIB_NONVOLATILE_READ_DWORD(addr) pgm_read_dword(addr)
439
#endif
440
441
#if !defined(RADIOLIB_TYPE_ALIAS)
442
#define RADIOLIB_TYPE_ALIAS(type, alias) using alias = type;
443
#endif
444
445
#if !defined(RADIOLIB_ARDUINOHAL_PIN_MODE_CAST)
446
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST
447
#endif
448
449
#if !defined(RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST)
450
#define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST
451
#endif
452
453
#if !defined(RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST)
454
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST
455
#endif
456
457
#else
458
// generic non-Arduino platform
459
#define RADIOLIB_PLATFORM "Generic"
460
461
#define RADIOLIB_NC (0xFFFFFFFF)
462
#define RADIOLIB_NONVOLATILE
463
#define RADIOLIB_NONVOLATILE_READ_BYTE(addr) (*(reinterpret_cast<uint8_t *>(reinterpret_cast<void *>(addr))))
464
#define RADIOLIB_NONVOLATILE_READ_DWORD(addr) (*(reinterpret_cast<uint32_t *>(reinterpret_cast<void *>(addr))))
465
#define RADIOLIB_TYPE_ALIAS(type, alias) using alias = type;
466
467
#define DEC 10
468
#define HEX 16
469
#define OCT 8
470
#define BIN 2
471
472
#include <stdint.h>
473
474
#endif
475
476
// This only compiles on STM32 boards with SUBGHZ module, but also
477
// include when generating docs
478
#if (!defined(ARDUINO_ARCH_STM32) || !defined(SUBGHZSPI_BASE)) && !defined(DOXYGEN)
479
#define RADIOLIB_EXCLUDE_STM32WLX (1)
480
#endif
481
482
// if verbose assert is enabled, enable basic debug too
483
#if RADIOLIB_VERBOSE_ASSERT
484
#define RADIOLIB_DEBUG (1)
485
#endif
486
487
// set the global debug mode flag
488
#if RADIOLIB_DEBUG_BASIC || RADIOLIB_DEBUG_PROTOCOL || RADIOLIB_DEBUG_SPI
489
#define RADIOLIB_DEBUG (1)
490
#else
491
#define RADIOLIB_DEBUG (0)
492
#endif
493
494
#if RADIOLIB_DEBUG
495
#if !defined(RADIOLIB_DEBUG_PRINT)
496
#define RADIOLIB_DEBUG_PRINT(M, ...) rlb_printf(false, M, ##__VA_ARGS__)
497
#define RADIOLIB_DEBUG_PRINT_LVL(LEVEL, M, ...) rlb_printf(true, LEVEL "" M, ##__VA_ARGS__)
498
#endif
499
500
#if !defined(RADIOLIB_DEBUG_PRINTLN)
501
#define RADIOLIB_DEBUG_PRINTLN(M, ...) rlb_printf(false, M RADIOLIB_LINE_FEED, ##__VA_ARGS__)
502
#define RADIOLIB_DEBUG_PRINTLN_LVL(LEVEL, M, ...) rlb_printf(true, LEVEL "" M RADIOLIB_LINE_FEED, ##__VA_ARGS__)
503
#endif
504
505
// some Arduino platforms do not support printf("%f"), so it has to be done this way
506
#if defined(RADIOLIB_BUILD_ARDUINO)
507
#define RADIOLIB_DEBUG_PRINT_FLOAT(VAL, DECIMALS) RADIOLIB_DEBUG_PORT.print(VAL, DECIMALS)
508
#define RADIOLIB_DEBUG_PRINT_FLOAT_LVL(LEVEL, VAL, DECIMALS) RADIOLIB_DEBUG_PRINT(LEVEL); RADIOLIB_DEBUG_PORT.print(VAL, DECIMALS)
509
#else
510
#define RADIOLIB_DEBUG_PRINT_FLOAT(VAL, DECIMALS) RADIOLIB_DEBUG_PRINT("%.3f", VAL)
511
#define RADIOLIB_DEBUG_PRINT_FLOAT_LVL(LEVEL, VAL, DECIMALS) RADIOLIB_DEBUG_PRINT(LEVEL "%.3f", VAL)
512
#endif
513
514
#define RADIOLIB_DEBUG_HEXDUMP(LEVEL, ...) rlb_hexdump(LEVEL, __VA_ARGS__)
515
#else
516
#define RADIOLIB_DEBUG_PRINT(...) {}
517
#define RADIOLIB_DEBUG_PRINTLN(...) {}
518
#define RADIOLIB_DEBUG_PRINT_FLOAT(LEVEL, VAL, DECIMALS) {}
519
#define RADIOLIB_DEBUG_HEXDUMP(...) {}
520
#endif
521
522
#define RADIOLIB_DEBUG_TAG ": "
523
#define RADIOLIB_DEBUG_TAG_BASIC "RLB_DBG" RADIOLIB_DEBUG_TAG
524
#define RADIOLIB_DEBUG_TAG_PROTOCOL "RLB_PRO" RADIOLIB_DEBUG_TAG
525
#define RADIOLIB_DEBUG_TAG_SPI "RLB_SPI" RADIOLIB_DEBUG_TAG
526
527
#if RADIOLIB_DEBUG_BASIC
528
#define RADIOLIB_DEBUG_BASIC_PRINT(...) RADIOLIB_DEBUG_PRINT_LVL(RADIOLIB_DEBUG_TAG_BASIC, __VA_ARGS__)
529
#define RADIOLIB_DEBUG_BASIC_PRINTLN(...) RADIOLIB_DEBUG_PRINTLN_LVL(RADIOLIB_DEBUG_TAG_BASIC, __VA_ARGS__)
530
#define RADIOLIB_DEBUG_BASIC_HEXDUMP(...) RADIOLIB_DEBUG_HEXDUMP(RADIOLIB_DEBUG_TAG_BASIC, __VA_ARGS__)
531
#define RADIOLIB_DEBUG_BASIC_PRINT_FLOAT(...) RADIOLIB_DEBUG_PRINT_FLOAT_LVL(RADIOLIB_DEBUG_TAG_BASIC, __VA_ARGS__)
532
#define RADIOLIB_DEBUG_BASIC_PRINT_NOTAG(...) RADIOLIB_DEBUG_PRINT(__VA_ARGS__)
533
#define RADIOLIB_DEBUG_BASIC_PRINTLN_NOTAG(...) RADIOLIB_DEBUG_PRINTLN(__VA_ARGS__)
534
#define RADIOLIB_DEBUG_BASIC_PRINT_FLOAT_NOTAG(...) RADIOLIB_DEBUG_PRINT_FLOAT(__VA_ARGS__)
535
#else
536
#define RADIOLIB_DEBUG_BASIC_PRINT(...) {}
537
#define RADIOLIB_DEBUG_BASIC_PRINTLN(...) {}
538
#define RADIOLIB_DEBUG_BASIC_HEXDUMP(...) {}
539
#define RADIOLIB_DEBUG_BASIC_PRINT_FLOAT(...) {}
540
#define RADIOLIB_DEBUG_BASIC_PRINT_NOTAG(...) {}
541
#define RADIOLIB_DEBUG_BASIC_PRINTLN_NOTAG(...) {}
542
#define RADIOLIB_DEBUG_BASIC_PRINT_FLOAT_NOTAG(...) {}
543
#endif
544
545
#if RADIOLIB_DEBUG_PROTOCOL
546
#define RADIOLIB_DEBUG_PROTOCOL_PRINT(...) RADIOLIB_DEBUG_PRINT_LVL(RADIOLIB_DEBUG_TAG_PROTOCOL, __VA_ARGS__)
547
#define RADIOLIB_DEBUG_PROTOCOL_PRINTLN(...) RADIOLIB_DEBUG_PRINTLN_LVL(RADIOLIB_DEBUG_TAG_PROTOCOL, __VA_ARGS__)
548
#define RADIOLIB_DEBUG_PROTOCOL_HEXDUMP(...) RADIOLIB_DEBUG_HEXDUMP(RADIOLIB_DEBUG_TAG_PROTOCOL, __VA_ARGS__)
549
#define RADIOLIB_DEBUG_PROTOCOL_PRINT_FLOAT(...) RADIOLIB_DEBUG_PRINT_FLOAT_LVL(RADIOLIB_DEBUG_TAG_PROTOCOL, __VA_ARGS__)
550
#define RADIOLIB_DEBUG_PROTOCOL_PRINT_NOTAG(...) RADIOLIB_DEBUG_PRINT(__VA_ARGS__)
551
#define RADIOLIB_DEBUG_PROTOCOL_PRINTLN_NOTAG(...) RADIOLIB_DEBUG_PRINTLN(__VA_ARGS__)
552
#define RADIOLIB_DEBUG_PROTOCOL_PRINT_FLOAT_NOTAG(...) RADIOLIB_DEBUG_PRINT_FLOAT(__VA_ARGS__)
553
#else
554
#define RADIOLIB_DEBUG_PROTOCOL_PRINT(...) {}
555
#define RADIOLIB_DEBUG_PROTOCOL_PRINTLN(...) {}
556
#define RADIOLIB_DEBUG_PROTOCOL_HEXDUMP(...) {}
557
#define RADIOLIB_DEBUG_PROTOCOL_PRINT_FLOAT(...) {}
558
#define RADIOLIB_DEBUG_PROTOCOL_PRINT_NOTAG(...) {}
559
#define RADIOLIB_DEBUG_PROTOCOL_PRINTLN_NOTAG(...) {}
560
#define RADIOLIB_DEBUG_PROTOCOL_PRINT_FLOAT_NOTAG(...) {}
561
#endif
562
563
#if RADIOLIB_DEBUG_SPI
564
#define RADIOLIB_DEBUG_SPI_PRINT(...) RADIOLIB_DEBUG_PRINT_LVL(RADIOLIB_DEBUG_TAG_SPI, __VA_ARGS__)
565
#define RADIOLIB_DEBUG_SPI_PRINTLN(...) RADIOLIB_DEBUG_PRINTLN_LVL(RADIOLIB_DEBUG_TAG_SPI, __VA_ARGS__)
566
#define RADIOLIB_DEBUG_SPI_HEXDUMP(...) RADIOLIB_DEBUG_HEXDUMP(RADIOLIB_DEBUG_TAG_SPI, __VA_ARGS__)
567
#define RADIOLIB_DEBUG_SPI_PRINT_FLOAT(...) RADIOLIB_DEBUG_PRINT_FLOAT_LVL(RADIOLIB_DEBUG_TAG_SPI, __VA_ARGS__)
568
#define RADIOLIB_DEBUG_SPI_PRINT_NOTAG(...) RADIOLIB_DEBUG_PRINT(__VA_ARGS__)
569
#define RADIOLIB_DEBUG_SPI_PRINTLN_NOTAG(...) RADIOLIB_DEBUG_PRINTLN(__VA_ARGS__)
570
#define RADIOLIB_DEBUG_SPI_PRINT_FLOAT_NOTAG(...) RADIOLIB_DEBUG_PRINT_FLOAT(__VA_ARGS__)
571
#else
572
#define RADIOLIB_DEBUG_SPI_PRINT(...) {}
573
#define RADIOLIB_DEBUG_SPI_PRINTLN(...) {}
574
#define RADIOLIB_DEBUG_SPI_HEXDUMP(...) {}
575
#define RADIOLIB_DEBUG_SPI_PRINT_FLOAT(...) {}
576
#define RADIOLIB_DEBUG_SPI_PRINT_NOTAG(...) {}
577
#define RADIOLIB_DEBUG_SPI_PRINTLN_NOTAG(...) {}
578
#define RADIOLIB_DEBUG_SPI_PRINT_FLOAT_NOTAG(...) {}
579
#endif
580
581
// debug info strings
582
#define RADIOLIB_VALUE_TO_STRING(x) #x
583
#define RADIOLIB_VALUE(x) RADIOLIB_VALUE_TO_STRING(x)
584
585
#define RADIOLIB_INFO "\r\nRadioLib Info\nVersion: \"" \
586
RADIOLIB_VALUE(RADIOLIB_VERSION_MAJOR) "." \
587
RADIOLIB_VALUE(RADIOLIB_VERSION_MINOR) "." \
588
RADIOLIB_VALUE(RADIOLIB_VERSION_PATCH) "." \
589
RADIOLIB_VALUE(RADIOLIB_VERSION_EXTRA) "\"\r\n" \
590
"Platform: " RADIOLIB_VALUE(RADIOLIB_PLATFORM) "\r\n" \
591
RADIOLIB_VALUE(__DATE__) " " RADIOLIB_VALUE(__TIME__)
592
598
#if RADIOLIB_VERBOSE_ASSERT
599
#define RADIOLIB_ASSERT(STATEVAR) { if((STATEVAR) != RADIOLIB_ERR_NONE) { RADIOLIB_DEBUG_BASIC_PRINTLN("%d at %s:%d", STATEVAR, __FILE__, __LINE__); return(STATEVAR); } }
600
#define RADIOLIB_ASSERT_PTR(PTR) { if((PTR) == NULL) { RADIOLIB_DEBUG_BASIC_PRINTLN("NULL at %s:%d", __FILE__, __LINE__); return(RADIOLIB_ERR_MEMORY_ALLOCATION_FAILED); } }
601
#else
602
#define RADIOLIB_ASSERT(STATEVAR) { if((STATEVAR) != RADIOLIB_ERR_NONE) { return(STATEVAR); } }
603
#define RADIOLIB_ASSERT_PTR(PTR) { if((PTR) == NULL) { return(RADIOLIB_ERR_MEMORY_ALLOCATION_FAILED); } }
604
#endif
605
609
#if RADIOLIB_CHECK_PARAMS
610
#define RADIOLIB_CHECK_RANGE(VAR, MIN, MAX, ERR) { if(!(((VAR) >= (MIN)) && ((VAR) <= (MAX)))) { return(ERR); } }
611
#else
612
#define RADIOLIB_CHECK_RANGE(VAR, MIN, MAX, ERR) {}
613
#endif
614
615
#if RADIOLIB_FIX_ERRATA_SX127X
616
#define RADIOLIB_ERRATA_SX127X(...) { errataFix(__VA_ARGS__); }
617
#else
618
#define RADIOLIB_ERRATA_SX127X(...) {}
619
#endif
620
621
// these macros are usually defined by Arduino, but some platforms undef them, so its safer to use our own
622
#define RADIOLIB_MIN(a,b) ((a)<(b)?(a):(b))
623
#define RADIOLIB_MAX(a,b) ((a)>(b)?(a):(b))
624
#define RADIOLIB_ABS(x) ((x)>0?(x):-(x))
625
626
// version definitions
627
#define RADIOLIB_VERSION_MAJOR 7
628
#define RADIOLIB_VERSION_MINOR 6
629
#define RADIOLIB_VERSION_PATCH 0
630
#define RADIOLIB_VERSION_EXTRA 0
631
632
#define RADIOLIB_VERSION (((RADIOLIB_VERSION_MAJOR) << 24) | ((RADIOLIB_VERSION_MINOR) << 16) | ((RADIOLIB_VERSION_PATCH) << 8) | (RADIOLIB_VERSION_EXTRA))
633
634
#endif
RadioLibTime_t
unsigned long RadioLibTime_t
Type used for durations in RadioLib.
Definition
TypeDef.h:674
src
BuildOpt.h
Generated by
1.9.8