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 
256 #elif defined(ARDUINO_ARCH_APOLLO3)
257  // Sparkfun Apollo3 boards
258  #define RADIOLIB_PLATFORM "Sparkfun Apollo3"
259  #define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (Arduino_PinMode)
260  #define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
261  #define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
262 
263 #elif defined(ARDUINO_ARDUINO_NANO33BLE)
264  // Arduino Nano 33 BLE
265  #define RADIOLIB_PLATFORM "Arduino Nano 33 BLE"
266  #define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PinMode)
267  #define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
268  #define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
269 
270  // Arduino mbed OS boards have a really bad tone implementation which will crash after a couple seconds
271  #define RADIOLIB_TONE_UNSUPPORTED
272  #define RADIOLIB_MBED_TONE_OVERRIDE
273 
274 #elif defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_PORTENTA_H7_M4)
275  // Arduino Portenta H7
276  #define RADIOLIB_PLATFORM "Portenta H7"
277  #define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PinMode)
278  #define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
279  #define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
280 
281  // Arduino mbed OS boards have a really bad tone implementation which will crash after a couple seconds
282  #define RADIOLIB_TONE_UNSUPPORTED
283  #define RADIOLIB_MBED_TONE_OVERRIDE
284 
285 #elif defined(__STM32F4__) || defined(__STM32F1__)
286  // Arduino STM32 core by Roger Clark (https://github.com/rogerclarkmelbourne/Arduino_STM32)
287  #define RADIOLIB_PLATFORM "STM32duino (unofficial)"
288  #define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (WiringPinMode)
289  #define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (ExtIntTriggerMode)
290 
291 #elif defined(ARDUINO_ARCH_MEGAAVR)
292  // MegaCoreX by MCUdude (https://github.com/MCUdude/MegaCoreX)
293  #define RADIOLIB_PLATFORM "MegaCoreX"
294 
295 #elif defined(ARDUINO_ARCH_MBED_RP2040)
296  // Raspberry Pi Pico (official mbed core)
297  #define RADIOLIB_PLATFORM "Raspberry Pi Pico"
298  #define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PinMode)
299  #define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
300  #define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
301 
302  // Arduino mbed OS boards have a really bad tone implementation which will crash after a couple seconds
303  #define RADIOLIB_TONE_UNSUPPORTED
304  #define RADIOLIB_MBED_TONE_OVERRIDE
305 
306 #elif defined(ARDUINO_ARCH_RP2040)
307  // Raspberry Pi Pico (unofficial core)
308  #define RADIOLIB_PLATFORM "Raspberry Pi Pico (unofficial)"
309  #define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PinMode)
310  #define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
311  #define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
312 
313 #elif defined(__ASR6501__) || defined(ARDUINO_ARCH_ASR650X) || defined(DARDUINO_ARCH_ASR6601)
314  // CubeCell
315  #define RADIOLIB_PLATFORM "CubeCell"
316  #define RADIOLIB_DEFAULT_SPI_SETTINGS SPISettings(1000000, MSBFIRST, SPI_MODE0) // see issue #709
317  #define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PINMODE)
318  #define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (IrqModes)
319 
320  // provide an easy access to the on-board module
321  #include "board-config.h"
322  #define RADIOLIB_BUILTIN_MODULE RADIO_NSS, RADIO_DIO_1, RADIO_RESET, RADIO_BUSY
323 
324  // CubeCell doesn't seem to define nullptr, let's do something like that now
325  #define nullptr NULL
326 
327  // ... and also defines pinMode() as a macro, which is by far the stupidest thing I have seen on Arduino
328  #undef pinMode
329 
330  // ... and uses an outdated GCC which does not support type aliases
331  #define RADIOLIB_TYPE_ALIAS(type, alias) typedef class type alias;
332 
333  // ... and it also has no tone(). This platform was designed by an idiot.
334  #define RADIOLIB_TONE_UNSUPPORTED
335 
336  // ... AND as the (hopefully) final nail in the coffin, IT F*CKING DEFINES YIELD() AS A MACRO THAT DOES NOTHING!!!
337  #define RADIOLIB_YIELD_UNSUPPORTED
338  #if defined(yield)
339  #undef yield
340  #endif
341 
342 #elif defined(RASPI)
343  // RaspiDuino framework (https://github.com/me-no-dev/RasPiArduino)
344  #define RADIOLIB_PLATFORM "RasPiArduino"
345 
346  // let's start off easy - no tone on this platform, that can happen
347  #define RADIOLIB_TONE_UNSUPPORTED
348 
349  // hmm, no yield either - weird on something like Raspberry PI, but sure, we can handle it
350  #define RADIOLIB_YIELD_UNSUPPORTED
351 
352  // aight, getting to the juicy stuff - PGM_P seems missing, that's the first time
353  #define PGM_P const char *
354 
355  // ... and for the grand finale, we have millis() and micros() DEFINED AS MACROS!
356  #if defined(millis)
357  #undef millis
358  inline RadioLibTime_t millis() { return((RadioLibTime_t)(STCV / 1000)); };
359  #endif
360 
361  #if defined(micros)
362  #undef micros
363  inline RadioLibTime_t micros() { return((RadioLibTime_t)(STCV)); };
364  #endif
365 
366 #elif defined(TEENSYDUINO)
367  // Teensy
368  #define RADIOLIB_PLATFORM "Teensy"
369 
370 #elif defined(ARDUINO_ARCH_RENESAS)
371  // Arduino Renesas (UNO R4)
372  #define RADIOLIB_PLATFORM "Arduino Renesas (UNO R4)"
373  #define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PinMode)
374  #define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
375  #define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
376 
377 #else
378  // other Arduino platforms not covered by the above list - this may or may not work
379  #define RADIOLIB_PLATFORM "Unknown Arduino"
380  #define RADIOLIB_UNKNOWN_PLATFORM
381 
382 #endif
383 
384  // set the default values for all macros
385  // these will be applied if they were not defined above
386  #if !defined(RADIOLIB_NC)
387  #define RADIOLIB_NC (0xFFFFFFFF)
388  #endif
389 
390  #if !defined(RADIOLIB_DEFAULT_SPI)
391  #define RADIOLIB_DEFAULT_SPI SPI
392  #endif
393 
394  #if !defined(RADIOLIB_DEFAULT_SPI_SETTINGS)
395  #define RADIOLIB_DEFAULT_SPI_SETTINGS SPISettings(2000000, MSBFIRST, SPI_MODE0)
396  #endif
397 
398  #if !defined(RADIOLIB_NONVOLATILE)
399  #define RADIOLIB_NONVOLATILE PROGMEM
400  #endif
401 
402  #if !defined(RADIOLIB_NONVOLATILE_PTR)
403  #define RADIOLIB_NONVOLATILE_PTR PGM_P
404  #endif
405 
406  #if !defined(RADIOLIB_NONVOLATILE_READ_BYTE)
407  #define RADIOLIB_NONVOLATILE_READ_BYTE(addr) pgm_read_byte(addr)
408  #endif
409 
410  #if !defined(RADIOLIB_NONVOLATILE_READ_DWORD)
411  #define RADIOLIB_NONVOLATILE_READ_DWORD(addr) pgm_read_dword(addr)
412  #endif
413 
414  #if !defined(RADIOLIB_TYPE_ALIAS)
415  #define RADIOLIB_TYPE_ALIAS(type, alias) using alias = type;
416  #endif
417 
418  #if !defined(RADIOLIB_ARDUINOHAL_PIN_MODE_CAST)
419  #define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST
420  #endif
421 
422  #if !defined(RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST)
423  #define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST
424  #endif
425 
426  #if !defined(RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST)
427  #define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST
428  #endif
429 
430 #else
431  // generic non-Arduino platform
432  #define RADIOLIB_PLATFORM "Generic"
433 
434  #define RADIOLIB_NC (0xFF)
435  #define RADIOLIB_NONVOLATILE
436  #define RADIOLIB_NONVOLATILE_READ_BYTE(addr) (*((uint8_t *)(void *)(addr)))
437  #define RADIOLIB_NONVOLATILE_READ_DWORD(addr) (*((uint32_t *)(void *)(addr)))
438  #define RADIOLIB_TYPE_ALIAS(type, alias) using alias = type;
439 
440  #if !defined(RADIOLIB_DEBUG_PORT)
441  #define RADIOLIB_DEBUG_PORT stdout
442  #endif
443 
444  #define DEC 10
445  #define HEX 16
446  #define OCT 8
447  #define BIN 2
448 
449  #include <stdint.h>
450 
451 #endif
452 
453 // This only compiles on STM32 boards with SUBGHZ module, but also
454 // include when generating docs
455 #if (!defined(ARDUINO_ARCH_STM32) || !defined(SUBGHZSPI_BASE)) && !defined(DOXYGEN)
456  #define RADIOLIB_EXCLUDE_STM32WLX (1)
457 #endif
458 
459 // if verbose assert is enabled, enable basic debug too
460 #if RADIOLIB_VERBOSE_ASSERT
461  #define RADIOLIB_DEBUG (1)
462 #endif
463 
464 // set the global debug mode flag
465 #if RADIOLIB_DEBUG_BASIC || RADIOLIB_DEBUG_PROTOCOL || RADIOLIB_DEBUG_SPI
466  #define RADIOLIB_DEBUG (1)
467 #else
468  #define RADIOLIB_DEBUG (0)
469 #endif
470 
471 #if RADIOLIB_DEBUG
472  #if defined(RADIOLIB_BUILD_ARDUINO)
473  #define RADIOLIB_DEBUG_PRINT(...) Module::serialPrintf(__VA_ARGS__)
474  #define RADIOLIB_DEBUG_PRINTLN(M, ...) Module::serialPrintf(M "\n", ##__VA_ARGS__)
475  #define RADIOLIB_DEBUG_PRINT_LVL(LEVEL, M, ...) Module::serialPrintf(LEVEL "" M, ##__VA_ARGS__)
476  #define RADIOLIB_DEBUG_PRINTLN_LVL(LEVEL, M, ...) Module::serialPrintf(LEVEL "" M "\n", ##__VA_ARGS__)
477 
478  // some platforms do not support printf("%f"), so it has to be done this way
479  #define RADIOLIB_DEBUG_PRINT_FLOAT(LEVEL, VAL, DECIMALS) RADIOLIB_DEBUG_PRINT(LEVEL); RADIOLIB_DEBUG_PORT.print(VAL, DECIMALS)
480  #else
481  #if !defined(RADIOLIB_DEBUG_PRINT)
482  #define RADIOLIB_DEBUG_PRINT(...) fprintf(RADIOLIB_DEBUG_PORT, __VA_ARGS__)
483  #define RADIOLIB_DEBUG_PRINT_LVL(LEVEL, M, ...) fprintf(RADIOLIB_DEBUG_PORT, LEVEL "" M, ##__VA_ARGS__)
484  #endif
485  #if !defined(RADIOLIB_DEBUG_PRINTLN)
486  #define RADIOLIB_DEBUG_PRINTLN(M, ...) fprintf(RADIOLIB_DEBUG_PORT, M "\n", ##__VA_ARGS__)
487  #define RADIOLIB_DEBUG_PRINTLN_LVL(LEVEL, M, ...) fprintf(RADIOLIB_DEBUG_PORT, LEVEL "" M "\n", ##__VA_ARGS__)
488  #endif
489  #define RADIOLIB_DEBUG_PRINT_FLOAT(LEVEL, VAL, DECIMALS) RADIOLIB_DEBUG_PRINT(LEVEL "%.3f", VAL)
490  #endif
491 
492  #define RADIOLIB_DEBUG_HEXDUMP(LEVEL, ...) Module::hexdump(LEVEL, __VA_ARGS__)
493 #else
494  #define RADIOLIB_DEBUG_PRINT(...) {}
495  #define RADIOLIB_DEBUG_PRINTLN(...) {}
496  #define RADIOLIB_DEBUG_PRINT_FLOAT(VAL, DECIMALS) {}
497  #define RADIOLIB_DEBUG_HEXDUMP(...) {}
498 #endif
499 
500 #if RADIOLIB_DEBUG_BASIC
501  #define RADIOLIB_DEBUG_BASIC_PRINT(...) RADIOLIB_DEBUG_PRINT_LVL("RLB_DBG: ", __VA_ARGS__)
502  #define RADIOLIB_DEBUG_BASIC_PRINT_NOTAG(...) RADIOLIB_DEBUG_PRINT_LVL("", __VA_ARGS__)
503  #define RADIOLIB_DEBUG_BASIC_PRINTLN(...) RADIOLIB_DEBUG_PRINTLN_LVL("RLB_DBG: ", __VA_ARGS__)
504  #define RADIOLIB_DEBUG_BASIC_PRINT_FLOAT(...) RADIOLIB_DEBUG_PRINT_FLOAT("RLB_DBG: ", __VA_ARGS__);
505  #define RADIOLIB_DEBUG_BASIC_HEXDUMP(...) RADIOLIB_DEBUG_HEXDUMP("RLB_DBG: ", __VA_ARGS__);
506 #else
507  #define RADIOLIB_DEBUG_BASIC_PRINT(...) {}
508  #define RADIOLIB_DEBUG_BASIC_PRINT_NOTAG(...) {}
509  #define RADIOLIB_DEBUG_BASIC_PRINTLN(...) {}
510  #define RADIOLIB_DEBUG_BASIC_PRINT_FLOAT(...) {}
511  #define RADIOLIB_DEBUG_BASIC_HEXDUMP(...) {}
512 #endif
513 
514 #if RADIOLIB_DEBUG_PROTOCOL
515  #define RADIOLIB_DEBUG_PROTOCOL_PRINT(...) RADIOLIB_DEBUG_PRINT_LVL("RLB_PRO: ", __VA_ARGS__)
516  #define RADIOLIB_DEBUG_PROTOCOL_PRINTLN(...) RADIOLIB_DEBUG_PRINTLN_LVL("RLB_PRO: ", __VA_ARGS__)
517  #define RADIOLIB_DEBUG_PROTOCOL_PRINT_FLOAT(...) RADIOLIB_DEBUG_PRINT_FLOAT("RLB_PRO: ", __VA_ARGS__);
518  #define RADIOLIB_DEBUG_PROTOCOL_HEXDUMP(...) RADIOLIB_DEBUG_HEXDUMP("RLB_PRO: ", __VA_ARGS__);
519 #else
520  #define RADIOLIB_DEBUG_PROTOCOL_PRINT(...) {}
521  #define RADIOLIB_DEBUG_PROTOCOL_PRINTLN(...) {}
522  #define RADIOLIB_DEBUG_PROTOCOL_PRINT_FLOAT(...) {}
523  #define RADIOLIB_DEBUG_PROTOCOL_HEXDUMP(...) {}
524 #endif
525 
526 #if RADIOLIB_DEBUG_SPI
527  #define RADIOLIB_DEBUG_SPI_PRINT(...) RADIOLIB_DEBUG_PRINT_LVL("RLB_SPI: ", __VA_ARGS__)
528  #define RADIOLIB_DEBUG_SPI_PRINT_NOTAG(...) RADIOLIB_DEBUG_PRINT_LVL("", __VA_ARGS__)
529  #define RADIOLIB_DEBUG_SPI_PRINTLN(...) RADIOLIB_DEBUG_PRINTLN_LVL("RLB_SPI: ", __VA_ARGS__)
530  #define RADIOLIB_DEBUG_SPI_PRINTLN_NOTAG(...) RADIOLIB_DEBUG_PRINTLN_LVL("", __VA_ARGS__)
531  #define RADIOLIB_DEBUG_SPI_PRINT_FLOAT(...) RADIOLIB_DEBUG_PRINT_FLOAT("RLB_SPI: ", __VA_ARGS__);
532  #define RADIOLIB_DEBUG_SPI_HEXDUMP(...) RADIOLIB_DEBUG_HEXDUMP("RLB_SPI: ", __VA_ARGS__);
533 #else
534  #define RADIOLIB_DEBUG_SPI_PRINT(...) {}
535  #define RADIOLIB_DEBUG_SPI_PRINT_NOTAG(...) {}
536  #define RADIOLIB_DEBUG_SPI_PRINTLN(...) {}
537  #define RADIOLIB_DEBUG_SPI_PRINTLN_NOTAG(...) {}
538  #define RADIOLIB_DEBUG_SPI_PRINT_FLOAT(...) {}
539  #define RADIOLIB_DEBUG_SPI_HEXDUMP(...) {}
540 #endif
541 
542 // debug info strings
543 #define RADIOLIB_VALUE_TO_STRING(x) #x
544 #define RADIOLIB_VALUE(x) RADIOLIB_VALUE_TO_STRING(x)
545 
546 #define RADIOLIB_INFO "\nRadioLib Info\nVersion: \"" \
547  RADIOLIB_VALUE(RADIOLIB_VERSION_MAJOR) "." \
548  RADIOLIB_VALUE(RADIOLIB_VERSION_MINOR) "." \
549  RADIOLIB_VALUE(RADIOLIB_VERSION_PATCH) "." \
550  RADIOLIB_VALUE(RADIOLIB_VERSION_EXTRA) "\"\n" \
551  "Platform: " RADIOLIB_VALUE(RADIOLIB_PLATFORM) "\n" \
552  "Compiled: " RADIOLIB_VALUE(__DATE__) " " RADIOLIB_VALUE(__TIME__)
553 
559 #if RADIOLIB_VERBOSE_ASSERT
560 #define RADIOLIB_ASSERT(STATEVAR) { if((STATEVAR) != RADIOLIB_ERR_NONE) { RADIOLIB_DEBUG_BASIC_PRINTLN("%d at %s:%d", STATEVAR, __FILE__, __LINE__); return(STATEVAR); } }
561 #else
562 #define RADIOLIB_ASSERT(STATEVAR) { if((STATEVAR) != RADIOLIB_ERR_NONE) { return(STATEVAR); } }
563 #endif
564 
568 #if RADIOLIB_CHECK_PARAMS
569  #define RADIOLIB_CHECK_RANGE(VAR, MIN, MAX, ERR) { if(!(((VAR) >= (MIN)) && ((VAR) <= (MAX)))) { return(ERR); } }
570 #else
571  #define RADIOLIB_CHECK_RANGE(VAR, MIN, MAX, ERR) {}
572 #endif
573 
574 #if RADIOLIB_FIX_ERRATA_SX127X
575  #define RADIOLIB_ERRATA_SX127X(...) { errataFix(__VA_ARGS__); }
576 #else
577  #define RADIOLIB_ERRATA_SX127X(...) {}
578 #endif
579 
580 // these macros are usually defined by Arduino, but some platforms undef them, so its safer to use our own
581 #define RADIOLIB_MIN(a,b) ((a)<(b)?(a):(b))
582 #define RADIOLIB_MAX(a,b) ((a)>(b)?(a):(b))
583 #define RADIOLIB_ABS(x) ((x)>0?(x):-(x))
584 
585 // version definitions
586 #define RADIOLIB_VERSION_MAJOR 6
587 #define RADIOLIB_VERSION_MINOR 6
588 #define RADIOLIB_VERSION_PATCH 0
589 #define RADIOLIB_VERSION_EXTRA 0
590 
591 #define RADIOLIB_VERSION (((RADIOLIB_VERSION_MAJOR) << 24) | ((RADIOLIB_VERSION_MINOR) << 16) | ((RADIOLIB_VERSION_PATCH) << 8) | (RADIOLIB_VERSION_EXTRA))
592 
593 #endif
unsigned long RadioLibTime_t
Type used for durations in RadioLib.
Definition: TypeDef.h:616