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