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