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
/*
128
* Enable custom implementation of AES-128
129
* This is useful when using platforms which provides hardware acceleration for AES.
130
* The default RadioLib implementation has a softwre AES-128, which takes a lot of time to calculate.
131
* When set, you will have to create a new AES-128 class which overrides the default implementations
132
* in RadioLibAES128 class, create an instance of that class and provide it to RadioLibHal::aes128.
133
*/
134
#if !defined(RADIOLIB_CUSTOM_AES128)
135
#define RADIOLIB_CUSTOM_AES128 (0)
136
#endif
137
138
#if !defined(RADIOLIB_LINE_FEED)
139
#define RADIOLIB_LINE_FEED "\r\n"
140
#endif
141
142
#if ARDUINO >= 100
143
// Arduino build
144
#include "Arduino.h"
145
#define RADIOLIB_BUILD_ARDUINO
146
#else
147
// generic build
148
#include <stdio.h>
149
#define RADIOLIB_BUILD_GENERIC
150
#endif
151
152
#if defined(RADIOLIB_BUILD_ARDUINO)
153
/*
154
* Platform-specific configuration.
155
*
156
* RADIOLIB_PLATFORM - platform name, used in debugging to quickly check the correct platform is detected.
157
* RADIOLIB_NC - alias for unused pin, usually the largest possible value of uint32_t.
158
* RADIOLIB_DEFAULT_SPI - default SPIClass instance to use.
159
* RADIOLIB_NONVOLATILE - macro to place variable into program storage (usually Flash).
160
* RADIOLIB_NONVOLATILE_READ_BYTE - function/macro to read variables saved in program storage (usually Flash).
161
* RADIOLIB_TYPE_ALIAS - construct to create an alias for a type, usually via the `using` keyword.
162
* RADIOLIB_TONE_UNSUPPORTED - some platforms do not have tone()/noTone(), which is required for AFSK.
163
*
164
* Users may also specify their own configuration by uncommenting the RADIOLIB_CUSTOM_ARDUINO,
165
* and then specifying all platform parameters in the section below. This will override automatic
166
* platform detection.
167
*/
168
169
// uncomment to enable custom platform definition
170
//#define RADIOLIB_CUSTOM_ARDUINO
171
172
#if defined(RADIOLIB_CUSTOM_ARDUINO)
173
// name for your platform
174
#define RADIOLIB_PLATFORM "Custom"
175
176
// the following must be defined if the Arduino core does not support tone or yield function
177
//#define RADIOLIB_TONE_UNSUPPORTED
178
//#define RADIOLIB_YIELD_UNSUPPORTED
179
180
// in addition, the following macros may be defined if the Arduino core differs from the defaults
181
#define RADIOLIB_NC (0xFFFFFFFF)
182
#define RADIOLIB_DEFAULT_SPI SPI
183
#define RADIOLIB_DEFAULT_SPI_SETTINGS SPISettings(2000000, MSBFIRST, SPI_MODE0)
184
#define RADIOLIB_NONVOLATILE PROGMEM
185
#define RADIOLIB_NONVOLATILE_READ_BYTE(addr) pgm_read_byte(addr)
186
#define RADIOLIB_NONVOLATILE_READ_DWORD(addr) pgm_read_dword(addr)
187
#define RADIOLIB_TYPE_ALIAS(type, alias) using alias = type;
188
189
// you might also have to define these if the Arduino core has some uncommon pin mode/status types
190
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST
191
#define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST
192
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST
193
194
// some of RadioLib drivers may be excluded, to prevent collisions with platforms (or to speed up build process)
195
// the following is a complete list of all possible exclusion macros, uncomment any of them to disable that driver
196
// NOTE: Some of the exclusion macros are dependent on each other. For example, it is not possible to exclude RF69
197
// while keeping SX1231 (because RF69 is the base class for SX1231). The dependency is always uni-directional,
198
// so excluding SX1231 and keeping RF69 is valid.
199
//#define RADIOLIB_EXCLUDE_CC1101 (1)
200
//#define RADIOLIB_EXCLUDE_NRF24 (1)
201
//#define RADIOLIB_EXCLUDE_RF69 (1)
202
//#define RADIOLIB_EXCLUDE_SX1231 (1) // dependent on RADIOLIB_EXCLUDE_RF69
203
//#define RADIOLIB_EXCLUDE_SI443X (1)
204
//#define RADIOLIB_EXCLUDE_RFM2X (1) // dependent on RADIOLIB_EXCLUDE_SI443X
205
//#define RADIOLIB_EXCLUDE_SX127X (1)
206
//#define RADIOLIB_EXCLUDE_SX126X (1)
207
//#define RADIOLIB_EXCLUDE_STM32WLX (1) // dependent on RADIOLIB_EXCLUDE_SX126X
208
//#define RADIOLIB_EXCLUDE_SX128X (1)
209
//#define RADIOLIB_EXCLUDE_AFSK (1)
210
//#define RADIOLIB_EXCLUDE_AX25 (1)
211
//#define RADIOLIB_EXCLUDE_HELLSCHREIBER (1)
212
//#define RADIOLIB_EXCLUDE_MORSE (1)
213
//#define RADIOLIB_EXCLUDE_RTTY (1)
214
//#define RADIOLIB_EXCLUDE_SSTV (1)
215
//#define RADIOLIB_EXCLUDE_DIRECT_RECEIVE (1)
216
//#define RADIOLIB_EXCLUDE_BELL (1)
217
//#define RADIOLIB_EXCLUDE_APRS (1)
218
//#define RADIOLIB_EXCLUDE_LORAWAN (1)
219
//#define RADIOLIB_EXCLUDE_LR11X0 (1)
220
//#define RADIOLIB_EXCLUDE_FSK4 (1)
221
//#define RADIOLIB_EXCLUDE_PAGER (1)
222
223
#elif defined(__AVR__) && !(defined(ARDUINO_AVR_UNO_WIFI_REV2) || defined(ARDUINO_AVR_NANO_EVERY) || defined(ARDUINO_ARCH_MEGAAVR))
224
// Arduino AVR boards (except for megaAVR) - Uno, Mega etc.
225
#define RADIOLIB_PLATFORM "Arduino AVR"
226
227
#if !(defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__) || defined(__AVR_ATmega1284__) || defined(__AVR_ATmega1284P__))
228
#define RADIOLIB_LOWEND_PLATFORM
229
#endif
230
231
#elif defined(ESP8266)
232
// ESP8266 boards
233
#define RADIOLIB_PLATFORM "ESP8266"
234
235
#elif defined(ESP32) || defined(ARDUINO_ARCH_ESP32)
236
#define RADIOLIB_ESP32
237
238
// ESP32 boards
239
#define RADIOLIB_PLATFORM "ESP32"
240
241
// ESP32 doesn't support tone(), but it can be emulated via LED control peripheral
242
#define RADIOLIB_TONE_UNSUPPORTED
243
#define RADIOLIB_TONE_ESP32_CHANNEL (1)
244
245
#elif defined(ARDUINO_ARCH_STM32)
246
// official STM32 Arduino core (https://github.com/stm32duino/Arduino_Core_STM32)
247
#define RADIOLIB_PLATFORM "Arduino STM32 (official)"
248
249
#elif defined(SAMD_SERIES)
250
// Adafruit SAMD boards (M0 and M4)
251
#define RADIOLIB_PLATFORM "Adafruit SAMD"
252
253
#elif defined(ARDUINO_ARCH_SAMD)
254
// Arduino SAMD (Zero, MKR, etc.)
255
#define RADIOLIB_PLATFORM "Arduino SAMD"
256
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PinMode)
257
#define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
258
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
259
260
#elif defined(__SAM3X8E__)
261
// Arduino Due
262
#define RADIOLIB_PLATFORM "Arduino Due"
263
#define RADIOLIB_TONE_UNSUPPORTED
264
265
#elif (defined(NRF52832_XXAA) || defined(NRF52840_XXAA)) && !defined(ARDUINO_ARDUINO_NANO33BLE)
266
// Adafruit nRF52 boards
267
#define RADIOLIB_PLATFORM "Adafruit nRF52"
268
269
#elif defined(ARDUINO_ARC32_TOOLS)
270
// Intel Curie
271
#define RADIOLIB_PLATFORM "Intel Curie"
272
273
#elif defined(ARDUINO_AVR_UNO_WIFI_REV2) || defined(ARDUINO_AVR_NANO_EVERY) || defined(PORTDUINO)
274
// Arduino megaAVR boards - Uno Wifi Rev.2, Nano Every
275
#define RADIOLIB_PLATFORM "Arduino megaAVR"
276
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PinMode)
277
#define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
278
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
279
280
#elif defined(ARDUINO_ARCH_APOLLO3)
281
// Sparkfun Apollo3 boards
282
#define RADIOLIB_PLATFORM "Sparkfun Apollo3"
283
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (Arduino_PinMode)
284
#define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
285
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
286
287
#elif defined(ARDUINO_ARDUINO_NANO33BLE)
288
// Arduino Nano 33 BLE
289
#define RADIOLIB_PLATFORM "Arduino Nano 33 BLE"
290
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PinMode)
291
#define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
292
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
293
294
#if defined(ARDUINO_ARCH_MBED)
295
// Arduino mbed OS boards have a really bad tone implementation which will crash after a couple seconds
296
#define RADIOLIB_TONE_UNSUPPORTED
297
#define RADIOLIB_MBED_TONE_OVERRIDE
298
#endif
299
300
#elif defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7)
301
// Arduino Portenta H7
302
#define RADIOLIB_PLATFORM "Portenta H7"
303
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PinMode)
304
#define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
305
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
306
307
#if defined(ARDUINO_ARCH_MBED)
308
// Arduino mbed OS boards have a really bad tone implementation which will crash after a couple seconds
309
#define RADIOLIB_TONE_UNSUPPORTED
310
#define RADIOLIB_MBED_TONE_OVERRIDE
311
#endif
312
313
#elif defined(__STM32F4__) || defined(__STM32F1__)
314
// Arduino STM32 core by Roger Clark (https://github.com/rogerclarkmelbourne/Arduino_STM32)
315
#define RADIOLIB_PLATFORM "STM32duino (unofficial)"
316
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (WiringPinMode)
317
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (ExtIntTriggerMode)
318
319
#elif defined(ARDUINO_ARCH_MEGAAVR)
320
// MegaCoreX by MCUdude (https://github.com/MCUdude/MegaCoreX)
321
#define RADIOLIB_PLATFORM "MegaCoreX"
322
323
#elif defined(ARDUINO_ARCH_MBED_RP2040)
324
// Raspberry Pi Pico (official mbed core)
325
#define RADIOLIB_PLATFORM "Raspberry Pi Pico"
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
// Arduino mbed OS boards have a really bad tone implementation which will crash after a couple seconds
331
#define RADIOLIB_TONE_UNSUPPORTED
332
#define RADIOLIB_MBED_TONE_OVERRIDE
333
334
#elif defined(ARDUINO_ARCH_RP2040)
335
// Raspberry Pi Pico (unofficial core)
336
#define RADIOLIB_PLATFORM "Raspberry Pi Pico (unofficial)"
337
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PinMode)
338
#define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
339
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
340
341
#elif defined(__ASR6501__) || defined(ARDUINO_ARCH_ASR650X) || defined(DARDUINO_ARCH_ASR6601)
342
// CubeCell
343
#define RADIOLIB_PLATFORM "CubeCell"
344
#define RADIOLIB_DEFAULT_SPI_SETTINGS SPISettings(1000000, MSBFIRST, SPI_MODE0)
// see issue #709
345
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PINMODE)
346
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (IrqModes)
347
348
// CubeCell doesn't seem to define nullptr, let's do something like that now
349
#define nullptr NULL
350
351
// ... and also defines pinMode() as a macro, which is by far the stupidest thing I have seen on Arduino
352
#undef pinMode
353
354
// ... and uses an outdated GCC which does not support type aliases
355
#define RADIOLIB_TYPE_ALIAS(type, alias) typedef class type alias;
356
357
// ... and it also has no tone(). This platform was designed by an idiot.
358
#define RADIOLIB_TONE_UNSUPPORTED
359
360
// ... AND as the (hopefully) final nail in the coffin, IT F*CKING DEFINES YIELD() AS A MACRO THAT DOES NOTHING!!!
361
#define RADIOLIB_YIELD_UNSUPPORTED
362
#if defined(yield)
363
#undef yield
364
#endif
365
366
#elif defined(RASPI)
367
// RaspiDuino framework (https://github.com/me-no-dev/RasPiArduino)
368
#define RADIOLIB_PLATFORM "RasPiArduino"
369
370
// let's start off easy - no tone on this platform, that can happen
371
#define RADIOLIB_TONE_UNSUPPORTED
372
373
// hmm, no yield either - weird on something like Raspberry PI, but sure, we can handle it
374
#define RADIOLIB_YIELD_UNSUPPORTED
375
376
// aight, getting to the juicy stuff - PGM_P seems missing, that's the first time
377
#define PGM_P const char *
378
379
// ... and for the grand finale, we have millis() and micros() DEFINED AS MACROS!
380
#if defined(millis)
381
#undef millis
382
inline
RadioLibTime_t
millis() {
return
((
RadioLibTime_t
)(STCV / 1000)); };
383
#endif
384
385
#if defined(micros)
386
#undef micros
387
inline
RadioLibTime_t
micros() {
return
((
RadioLibTime_t
)(STCV)); };
388
#endif
389
390
#elif defined(TEENSYDUINO)
391
// Teensy
392
#define RADIOLIB_PLATFORM "Teensy"
393
394
#elif defined(ARDUINO_ARCH_RENESAS)
395
// Arduino Renesas (UNO R4)
396
#define RADIOLIB_PLATFORM "Arduino Renesas (UNO R4)"
397
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PinMode)
398
#define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
399
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
400
401
#elif defined(ARDUINO_ARCH_SILABS)
402
// Silicon Labs Arduino
403
#define RADIOLIB_PLATFORM "Arduino Silicon Labs"
404
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PinMode)
405
#define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
406
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
407
408
#elif defined(ARDUINO_ARCH_ZEPHYR) && defined(ARDUINO_UNO_Q)
409
// Arduino Uno Q (Zephyr OS)
410
#define RADIOLIB_PLATFORM "Arduino Uno Q (Zephyr OS)"
411
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PinMode)
412
#define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
413
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
414
415
#else
416
// other Arduino platforms not covered by the above list - this may or may not work
417
#define RADIOLIB_PLATFORM "Unknown Arduino"
418
#define RADIOLIB_UNKNOWN_PLATFORM
419
420
#endif
421
422
// set the default values for all macros
423
// these will be applied if they were not defined above
424
#if !defined(RADIOLIB_NC)
425
#define RADIOLIB_NC (0xFFFFFFFF)
426
#endif
427
428
#if !defined(RADIOLIB_DEFAULT_SPI)
429
#define RADIOLIB_DEFAULT_SPI SPI
430
#endif
431
432
#if !defined(RADIOLIB_DEFAULT_SPI_SETTINGS)
433
#define RADIOLIB_DEFAULT_SPI_SETTINGS SPISettings(2000000, MSBFIRST, SPI_MODE0)
434
#endif
435
436
#if !defined(RADIOLIB_NONVOLATILE)
437
#define RADIOLIB_NONVOLATILE PROGMEM
438
#endif
439
440
#if !defined(RADIOLIB_NONVOLATILE_PTR)
441
#define RADIOLIB_NONVOLATILE_PTR PGM_P
442
#endif
443
444
#if !defined(RADIOLIB_NONVOLATILE_READ_BYTE)
445
#define RADIOLIB_NONVOLATILE_READ_BYTE(addr) pgm_read_byte(addr)
446
#endif
447
448
#if !defined(RADIOLIB_NONVOLATILE_READ_DWORD)
449
#define RADIOLIB_NONVOLATILE_READ_DWORD(addr) pgm_read_dword(addr)
450
#endif
451
452
#if !defined(RADIOLIB_TYPE_ALIAS)
453
#define RADIOLIB_TYPE_ALIAS(type, alias) using alias = type;
454
#endif
455
456
#if !defined(RADIOLIB_ARDUINOHAL_PIN_MODE_CAST)
457
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST
458
#endif
459
460
#if !defined(RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST)
461
#define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST
462
#endif
463
464
#if !defined(RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST)
465
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST
466
#endif
467
468
#else
469
// generic non-Arduino platform
470
#define RADIOLIB_PLATFORM "Generic"
471
472
#define RADIOLIB_NC (0xFFFFFFFF)
473
#define RADIOLIB_NONVOLATILE
474
#define RADIOLIB_NONVOLATILE_READ_BYTE(addr) (*(reinterpret_cast<uint8_t *>(reinterpret_cast<void *>(addr))))
475
#define RADIOLIB_NONVOLATILE_READ_DWORD(addr) (*(reinterpret_cast<uint32_t *>(reinterpret_cast<void *>(addr))))
476
#define RADIOLIB_TYPE_ALIAS(type, alias) using alias = type;
477
478
#define DEC 10
479
#define HEX 16
480
#define OCT 8
481
#define BIN 2
482
483
#include <stdint.h>
484
485
#endif
486
487
// This only compiles on STM32 boards with SUBGHZ module, but also
488
// include when generating docs
489
#if (!defined(ARDUINO_ARCH_STM32) || !defined(SUBGHZSPI_BASE)) && !defined(DOXYGEN)
490
#define RADIOLIB_EXCLUDE_STM32WLX (1)
491
#endif
492
493
// if verbose assert is enabled, enable basic debug too
494
#if RADIOLIB_VERBOSE_ASSERT
495
#define RADIOLIB_DEBUG (1)
496
#endif
497
498
// set the global debug mode flag
499
#if RADIOLIB_DEBUG_BASIC || RADIOLIB_DEBUG_PROTOCOL || RADIOLIB_DEBUG_SPI
500
#define RADIOLIB_DEBUG (1)
501
#else
502
#define RADIOLIB_DEBUG (0)
503
#endif
504
505
#if RADIOLIB_DEBUG
506
#if !defined(RADIOLIB_DEBUG_PRINT)
507
#define RADIOLIB_DEBUG_PRINT(M, ...) rlb_printf(false, M, ##__VA_ARGS__)
508
#define RADIOLIB_DEBUG_PRINT_LVL(LEVEL, M, ...) rlb_printf(true, LEVEL "" M, ##__VA_ARGS__)
509
#endif
510
511
#if !defined(RADIOLIB_DEBUG_PRINTLN)
512
#define RADIOLIB_DEBUG_PRINTLN(M, ...) rlb_printf(false, M RADIOLIB_LINE_FEED, ##__VA_ARGS__)
513
#define RADIOLIB_DEBUG_PRINTLN_LVL(LEVEL, M, ...) rlb_printf(true, LEVEL "" M RADIOLIB_LINE_FEED, ##__VA_ARGS__)
514
#endif
515
516
// some Arduino platforms do not support printf("%f"), so it has to be done this way
517
#if defined(RADIOLIB_BUILD_ARDUINO)
518
#define RADIOLIB_DEBUG_PRINT_FLOAT(VAL, DECIMALS) RADIOLIB_DEBUG_PORT.print(VAL, DECIMALS)
519
#define RADIOLIB_DEBUG_PRINT_FLOAT_LVL(LEVEL, VAL, DECIMALS) RADIOLIB_DEBUG_PRINT(LEVEL); RADIOLIB_DEBUG_PORT.print(VAL, DECIMALS)
520
#else
521
#define RADIOLIB_DEBUG_PRINT_FLOAT(VAL, DECIMALS) RADIOLIB_DEBUG_PRINT("%.3f", VAL)
522
#define RADIOLIB_DEBUG_PRINT_FLOAT_LVL(LEVEL, VAL, DECIMALS) RADIOLIB_DEBUG_PRINT(LEVEL "%.3f", VAL)
523
#endif
524
525
#define RADIOLIB_DEBUG_HEXDUMP(LEVEL, ...) rlb_hexdump(LEVEL, __VA_ARGS__)
526
#else
527
#define RADIOLIB_DEBUG_PRINT(...) {}
528
#define RADIOLIB_DEBUG_PRINTLN(...) {}
529
#define RADIOLIB_DEBUG_PRINT_FLOAT(LEVEL, VAL, DECIMALS) {}
530
#define RADIOLIB_DEBUG_HEXDUMP(...) {}
531
#endif
532
533
#define RADIOLIB_DEBUG_TAG ": "
534
#define RADIOLIB_DEBUG_TAG_BASIC "RLB_DBG" RADIOLIB_DEBUG_TAG
535
#define RADIOLIB_DEBUG_TAG_PROTOCOL "RLB_PRO" RADIOLIB_DEBUG_TAG
536
#define RADIOLIB_DEBUG_TAG_SPI "RLB_SPI" RADIOLIB_DEBUG_TAG
537
538
#if RADIOLIB_DEBUG_BASIC
539
#define RADIOLIB_DEBUG_BASIC_PRINT(...) RADIOLIB_DEBUG_PRINT_LVL(RADIOLIB_DEBUG_TAG_BASIC, __VA_ARGS__)
540
#define RADIOLIB_DEBUG_BASIC_PRINTLN(...) RADIOLIB_DEBUG_PRINTLN_LVL(RADIOLIB_DEBUG_TAG_BASIC, __VA_ARGS__)
541
#define RADIOLIB_DEBUG_BASIC_HEXDUMP(...) RADIOLIB_DEBUG_HEXDUMP(RADIOLIB_DEBUG_TAG_BASIC, __VA_ARGS__)
542
#define RADIOLIB_DEBUG_BASIC_PRINT_FLOAT(...) RADIOLIB_DEBUG_PRINT_FLOAT_LVL(RADIOLIB_DEBUG_TAG_BASIC, __VA_ARGS__)
543
#define RADIOLIB_DEBUG_BASIC_PRINT_NOTAG(...) RADIOLIB_DEBUG_PRINT(__VA_ARGS__)
544
#define RADIOLIB_DEBUG_BASIC_PRINTLN_NOTAG(...) RADIOLIB_DEBUG_PRINTLN(__VA_ARGS__)
545
#define RADIOLIB_DEBUG_BASIC_PRINT_FLOAT_NOTAG(...) RADIOLIB_DEBUG_PRINT_FLOAT(__VA_ARGS__)
546
#else
547
#define RADIOLIB_DEBUG_BASIC_PRINT(...) {}
548
#define RADIOLIB_DEBUG_BASIC_PRINTLN(...) {}
549
#define RADIOLIB_DEBUG_BASIC_HEXDUMP(...) {}
550
#define RADIOLIB_DEBUG_BASIC_PRINT_FLOAT(...) {}
551
#define RADIOLIB_DEBUG_BASIC_PRINT_NOTAG(...) {}
552
#define RADIOLIB_DEBUG_BASIC_PRINTLN_NOTAG(...) {}
553
#define RADIOLIB_DEBUG_BASIC_PRINT_FLOAT_NOTAG(...) {}
554
#endif
555
556
#if RADIOLIB_DEBUG_PROTOCOL
557
#define RADIOLIB_DEBUG_PROTOCOL_PRINT(...) RADIOLIB_DEBUG_PRINT_LVL(RADIOLIB_DEBUG_TAG_PROTOCOL, __VA_ARGS__)
558
#define RADIOLIB_DEBUG_PROTOCOL_PRINTLN(...) RADIOLIB_DEBUG_PRINTLN_LVL(RADIOLIB_DEBUG_TAG_PROTOCOL, __VA_ARGS__)
559
#define RADIOLIB_DEBUG_PROTOCOL_HEXDUMP(...) RADIOLIB_DEBUG_HEXDUMP(RADIOLIB_DEBUG_TAG_PROTOCOL, __VA_ARGS__)
560
#define RADIOLIB_DEBUG_PROTOCOL_PRINT_FLOAT(...) RADIOLIB_DEBUG_PRINT_FLOAT_LVL(RADIOLIB_DEBUG_TAG_PROTOCOL, __VA_ARGS__)
561
#define RADIOLIB_DEBUG_PROTOCOL_PRINT_NOTAG(...) RADIOLIB_DEBUG_PRINT(__VA_ARGS__)
562
#define RADIOLIB_DEBUG_PROTOCOL_PRINTLN_NOTAG(...) RADIOLIB_DEBUG_PRINTLN(__VA_ARGS__)
563
#define RADIOLIB_DEBUG_PROTOCOL_PRINT_FLOAT_NOTAG(...) RADIOLIB_DEBUG_PRINT_FLOAT(__VA_ARGS__)
564
#else
565
#define RADIOLIB_DEBUG_PROTOCOL_PRINT(...) {}
566
#define RADIOLIB_DEBUG_PROTOCOL_PRINTLN(...) {}
567
#define RADIOLIB_DEBUG_PROTOCOL_HEXDUMP(...) {}
568
#define RADIOLIB_DEBUG_PROTOCOL_PRINT_FLOAT(...) {}
569
#define RADIOLIB_DEBUG_PROTOCOL_PRINT_NOTAG(...) {}
570
#define RADIOLIB_DEBUG_PROTOCOL_PRINTLN_NOTAG(...) {}
571
#define RADIOLIB_DEBUG_PROTOCOL_PRINT_FLOAT_NOTAG(...) {}
572
#endif
573
574
#if RADIOLIB_DEBUG_SPI
575
#define RADIOLIB_DEBUG_SPI_PRINT(...) RADIOLIB_DEBUG_PRINT_LVL(RADIOLIB_DEBUG_TAG_SPI, __VA_ARGS__)
576
#define RADIOLIB_DEBUG_SPI_PRINTLN(...) RADIOLIB_DEBUG_PRINTLN_LVL(RADIOLIB_DEBUG_TAG_SPI, __VA_ARGS__)
577
#define RADIOLIB_DEBUG_SPI_HEXDUMP(...) RADIOLIB_DEBUG_HEXDUMP(RADIOLIB_DEBUG_TAG_SPI, __VA_ARGS__)
578
#define RADIOLIB_DEBUG_SPI_PRINT_FLOAT(...) RADIOLIB_DEBUG_PRINT_FLOAT_LVL(RADIOLIB_DEBUG_TAG_SPI, __VA_ARGS__)
579
#define RADIOLIB_DEBUG_SPI_PRINT_NOTAG(...) RADIOLIB_DEBUG_PRINT(__VA_ARGS__)
580
#define RADIOLIB_DEBUG_SPI_PRINTLN_NOTAG(...) RADIOLIB_DEBUG_PRINTLN(__VA_ARGS__)
581
#define RADIOLIB_DEBUG_SPI_PRINT_FLOAT_NOTAG(...) RADIOLIB_DEBUG_PRINT_FLOAT(__VA_ARGS__)
582
#else
583
#define RADIOLIB_DEBUG_SPI_PRINT(...) {}
584
#define RADIOLIB_DEBUG_SPI_PRINTLN(...) {}
585
#define RADIOLIB_DEBUG_SPI_HEXDUMP(...) {}
586
#define RADIOLIB_DEBUG_SPI_PRINT_FLOAT(...) {}
587
#define RADIOLIB_DEBUG_SPI_PRINT_NOTAG(...) {}
588
#define RADIOLIB_DEBUG_SPI_PRINTLN_NOTAG(...) {}
589
#define RADIOLIB_DEBUG_SPI_PRINT_FLOAT_NOTAG(...) {}
590
#endif
591
592
// debug info strings
593
#define RADIOLIB_VALUE_TO_STRING(x) #x
594
#define RADIOLIB_VALUE(x) RADIOLIB_VALUE_TO_STRING(x)
595
#define RADIOLIB_VALUE_USED(x) __asm__ __volatile__("" :: "m" (x))
596
597
#define RADIOLIB_INFO "\r\nRadioLib Info\nVersion: \"" \
598
RADIOLIB_VALUE(RADIOLIB_VERSION_MAJOR) "." \
599
RADIOLIB_VALUE(RADIOLIB_VERSION_MINOR) "." \
600
RADIOLIB_VALUE(RADIOLIB_VERSION_PATCH) "." \
601
RADIOLIB_VALUE(RADIOLIB_VERSION_EXTRA) "\"\r\n" \
602
"Platform: " RADIOLIB_VALUE(RADIOLIB_PLATFORM) "\r\n" \
603
RADIOLIB_VALUE(__DATE__) " " RADIOLIB_VALUE(__TIME__)
604
610
#if RADIOLIB_VERBOSE_ASSERT
611
#define RADIOLIB_ASSERT(STATEVAR) { if((STATEVAR) != RADIOLIB_ERR_NONE) { RADIOLIB_DEBUG_BASIC_PRINTLN("%d at %s:%d", STATEVAR, __FILE__, __LINE__); return(STATEVAR); } }
612
#define RADIOLIB_ASSERT_PTR(PTR) { if((PTR) == NULL) { RADIOLIB_DEBUG_BASIC_PRINTLN("NULL at %s:%d", __FILE__, __LINE__); return(RADIOLIB_ERR_MEMORY_ALLOCATION_FAILED); } }
613
#else
614
#define RADIOLIB_ASSERT(STATEVAR) { if((STATEVAR) != RADIOLIB_ERR_NONE) { return(STATEVAR); } }
615
#define RADIOLIB_ASSERT_PTR(PTR) { if((PTR) == NULL) { return(RADIOLIB_ERR_MEMORY_ALLOCATION_FAILED); } }
616
#endif
617
621
#if RADIOLIB_CHECK_PARAMS
622
#define RADIOLIB_CHECK_RANGE(VAR, MIN, MAX, ERR) { if(!(((VAR) >= (MIN)) && ((VAR) <= (MAX)))) { return(ERR); } }
623
#else
624
#define RADIOLIB_CHECK_RANGE(VAR, MIN, MAX, ERR) {}
625
#endif
626
627
#if RADIOLIB_FIX_ERRATA_SX127X
628
#define RADIOLIB_ERRATA_SX127X(...) { errataFix(__VA_ARGS__); }
629
#else
630
#define RADIOLIB_ERRATA_SX127X(...) {}
631
#endif
632
633
// these macros are usually defined by Arduino, but some platforms undef them, so its safer to use our own
634
#define RADIOLIB_MIN(a,b) ((a)<(b)?(a):(b))
635
#define RADIOLIB_MAX(a,b) ((a)>(b)?(a):(b))
636
#define RADIOLIB_ABS(x) ((x)>0?(x):-(x))
637
638
// version definitions
639
#define RADIOLIB_VERSION_MAJOR 7
640
#define RADIOLIB_VERSION_MINOR 6
641
#define RADIOLIB_VERSION_PATCH 0
642
#define RADIOLIB_VERSION_EXTRA 0
643
644
#define RADIOLIB_VERSION (((RADIOLIB_VERSION_MAJOR) << 24) | ((RADIOLIB_VERSION_MINOR) << 16) | ((RADIOLIB_VERSION_PATCH) << 8) | (RADIOLIB_VERSION_EXTRA))
645
646
#endif
RadioLibTime_t
unsigned long RadioLibTime_t
Type used for durations in RadioLib.
Definition
TypeDef.h:679
src
BuildOpt.h
Generated by
1.9.8