1 #if !defined(_RADIOLIB_BUILD_OPTIONS_H)
2 #define _RADIOLIB_BUILD_OPTIONS_H
16 #if !defined(RADIOLIB_DEBUG_BASIC)
17 #define RADIOLIB_DEBUG_BASIC (0)
19 #if !defined(RADIOLIB_DEBUG_PROTOCOL)
20 #define RADIOLIB_DEBUG_PROTOCOL (0)
22 #if !defined(RADIOLIB_DEBUG_SPI)
23 #define RADIOLIB_DEBUG_SPI (0)
25 #if !defined(RADIOLIB_VERBOSE_ASSERT)
26 #define RADIOLIB_VERBOSE_ASSERT (0)
31 #if !defined(RADIOLIB_DEBUG_PORT)
32 #define RADIOLIB_DEBUG_PORT Serial
41 #if !defined(RADIOLIB_SPI_PARANOID)
42 #define RADIOLIB_SPI_PARANOID (1)
52 #if !defined(RADIOLIB_CHECK_PARAMS)
53 #define RADIOLIB_CHECK_PARAMS (1)
62 #if !defined(RADIOLIB_FIX_ERRATA_SX127X)
63 #define RADIOLIB_FIX_ERRATA_SX127X (0)
71 #if !defined(RADIOLIB_GODMODE)
72 #define RADIOLIB_GODMODE (0)
80 #if !defined(RADIOLIB_LOW_LEVEL)
81 #define RADIOLIB_LOW_LEVEL (0)
87 #if !defined(RADIOLIB_RADIOSHIELD)
88 #define RADIOLIB_RADIOSHIELD (0)
95 #if !defined(RADIOLIB_INTERRUPT_TIMING)
96 #define RADIOLIB_INTERRUPT_TIMING (0)
103 #if !defined(RADIOLIB_STATIC_ONLY)
104 #define RADIOLIB_STATIC_ONLY (0)
108 #if !defined(RADIOLIB_STATIC_ARRAY_SIZE)
109 #define RADIOLIB_STATIC_ARRAY_SIZE (256)
120 #if !defined(RADIOLIB_CLOCK_DRIFT_MS)
127 #define RADIOLIB_BUILD_ARDUINO
131 #define RADIOLIB_BUILD_GENERIC
134 #if defined(RADIOLIB_BUILD_ARDUINO)
157 #if defined(RADIOLIB_CUSTOM_ARDUINO)
159 #define RADIOLIB_PLATFORM "Custom"
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;
175 #define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST
176 #define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST
177 #define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST
202 #elif defined(__AVR__) && !(defined(ARDUINO_AVR_UNO_WIFI_REV2) || defined(ARDUINO_AVR_NANO_EVERY) || defined(ARDUINO_ARCH_MEGAAVR))
204 #define RADIOLIB_PLATFORM "Arduino AVR"
206 #if !(defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__) || defined(__AVR_ATmega1284__) || defined(__AVR_ATmega1284P__))
207 #define RADIOLIB_LOWEND_PLATFORM
210 #elif defined(ESP8266)
212 #define RADIOLIB_PLATFORM "ESP8266"
214 #elif defined(ESP32) || defined(ARDUINO_ARCH_ESP32)
215 #define RADIOLIB_ESP32
218 #define RADIOLIB_PLATFORM "ESP32"
221 #define RADIOLIB_TONE_UNSUPPORTED
222 #define RADIOLIB_TONE_ESP32_CHANNEL (1)
224 #elif defined(ARDUINO_ARCH_STM32)
226 #define RADIOLIB_PLATFORM "Arduino STM32 (official)"
228 #elif defined(SAMD_SERIES)
230 #define RADIOLIB_PLATFORM "Adafruit SAMD"
232 #elif defined(ARDUINO_ARCH_SAMD)
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)
239 #elif defined(__SAM3X8E__)
241 #define RADIOLIB_PLATFORM "Arduino Due"
242 #define RADIOLIB_TONE_UNSUPPORTED
244 #elif (defined(NRF52832_XXAA) || defined(NRF52840_XXAA)) && !defined(ARDUINO_ARDUINO_NANO33BLE)
246 #define RADIOLIB_PLATFORM "Adafruit nRF52"
248 #elif defined(ARDUINO_ARC32_TOOLS)
250 #define RADIOLIB_PLATFORM "Intel Curie"
252 #elif defined(ARDUINO_AVR_UNO_WIFI_REV2) || defined(ARDUINO_AVR_NANO_EVERY) || defined(PORTDUINO)
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)
259 #elif defined(ARDUINO_ARCH_APOLLO3)
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)
266 #elif defined(ARDUINO_ARDUINO_NANO33BLE)
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)
274 #define RADIOLIB_TONE_UNSUPPORTED
275 #define RADIOLIB_MBED_TONE_OVERRIDE
277 #elif defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_PORTENTA_H7_M4)
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)
285 #define RADIOLIB_TONE_UNSUPPORTED
286 #define RADIOLIB_MBED_TONE_OVERRIDE
288 #elif defined(__STM32F4__) || defined(__STM32F1__)
290 #define RADIOLIB_PLATFORM "STM32duino (unofficial)"
291 #define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (WiringPinMode)
292 #define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (ExtIntTriggerMode)
294 #elif defined(ARDUINO_ARCH_MEGAAVR)
296 #define RADIOLIB_PLATFORM "MegaCoreX"
298 #elif defined(ARDUINO_ARCH_MBED_RP2040)
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)
306 #define RADIOLIB_TONE_UNSUPPORTED
307 #define RADIOLIB_MBED_TONE_OVERRIDE
309 #elif defined(ARDUINO_ARCH_RP2040)
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)
316 #elif defined(__ASR6501__) || defined(ARDUINO_ARCH_ASR650X) || defined(DARDUINO_ARCH_ASR6601)
318 #define RADIOLIB_PLATFORM "CubeCell"
319 #define RADIOLIB_DEFAULT_SPI_SETTINGS SPISettings(1000000, MSBFIRST, SPI_MODE0)
320 #define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PINMODE)
321 #define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (IrqModes)
324 #include "board-config.h"
325 #define RADIOLIB_BUILTIN_MODULE RADIO_NSS, RADIO_DIO_1, RADIO_RESET, RADIO_BUSY
334 #define RADIOLIB_TYPE_ALIAS(type, alias) typedef class type alias;
337 #define RADIOLIB_TONE_UNSUPPORTED
340 #define RADIOLIB_YIELD_UNSUPPORTED
347 #define RADIOLIB_PLATFORM "RasPiArduino"
350 #define RADIOLIB_TONE_UNSUPPORTED
353 #define RADIOLIB_YIELD_UNSUPPORTED
356 #define PGM_P const char *
369 #elif defined(TEENSYDUINO)
371 #define RADIOLIB_PLATFORM "Teensy"
373 #elif defined(ARDUINO_ARCH_RENESAS)
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)
382 #define RADIOLIB_PLATFORM "Unknown Arduino"
383 #define RADIOLIB_UNKNOWN_PLATFORM
389 #if !defined(RADIOLIB_NC)
390 #define RADIOLIB_NC (0xFFFFFFFF)
393 #if !defined(RADIOLIB_DEFAULT_SPI)
394 #define RADIOLIB_DEFAULT_SPI SPI
397 #if !defined(RADIOLIB_DEFAULT_SPI_SETTINGS)
398 #define RADIOLIB_DEFAULT_SPI_SETTINGS SPISettings(2000000, MSBFIRST, SPI_MODE0)
401 #if !defined(RADIOLIB_NONVOLATILE)
402 #define RADIOLIB_NONVOLATILE PROGMEM
405 #if !defined(RADIOLIB_NONVOLATILE_PTR)
406 #define RADIOLIB_NONVOLATILE_PTR PGM_P
409 #if !defined(RADIOLIB_NONVOLATILE_READ_BYTE)
410 #define RADIOLIB_NONVOLATILE_READ_BYTE(addr) pgm_read_byte(addr)
413 #if !defined(RADIOLIB_NONVOLATILE_READ_DWORD)
414 #define RADIOLIB_NONVOLATILE_READ_DWORD(addr) pgm_read_dword(addr)
417 #if !defined(RADIOLIB_TYPE_ALIAS)
418 #define RADIOLIB_TYPE_ALIAS(type, alias) using alias = type;
421 #if !defined(RADIOLIB_ARDUINOHAL_PIN_MODE_CAST)
422 #define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST
425 #if !defined(RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST)
426 #define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST
429 #if !defined(RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST)
430 #define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST
435 #define RADIOLIB_PLATFORM "Generic"
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;
443 #if !defined(RADIOLIB_DEBUG_PORT)
444 #define RADIOLIB_DEBUG_PORT stdout
458 #if (!defined(ARDUINO_ARCH_STM32) || !defined(SUBGHZSPI_BASE)) && !defined(DOXYGEN)
459 #define RADIOLIB_EXCLUDE_STM32WLX (1)
463 #if RADIOLIB_VERBOSE_ASSERT
464 #define RADIOLIB_DEBUG (1)
468 #if RADIOLIB_DEBUG_BASIC || RADIOLIB_DEBUG_PROTOCOL || RADIOLIB_DEBUG_SPI
469 #define RADIOLIB_DEBUG (1)
471 #define RADIOLIB_DEBUG (0)
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__)
482 #define RADIOLIB_DEBUG_PRINT_FLOAT(LEVEL, VAL, DECIMALS) RADIOLIB_DEBUG_PRINT(LEVEL); RADIOLIB_DEBUG_PORT.print(VAL, DECIMALS)
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__)
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__)
492 #define RADIOLIB_DEBUG_PRINT_FLOAT(LEVEL, VAL, DECIMALS) RADIOLIB_DEBUG_PRINT(LEVEL "%.3f", VAL)
495 #define RADIOLIB_DEBUG_HEXDUMP(LEVEL, ...) Module::hexdump(LEVEL, __VA_ARGS__)
497 #define RADIOLIB_DEBUG_PRINT(...) {}
498 #define RADIOLIB_DEBUG_PRINTLN(...) {}
499 #define RADIOLIB_DEBUG_PRINT_FLOAT(VAL, DECIMALS) {}
500 #define RADIOLIB_DEBUG_HEXDUMP(...) {}
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__);
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(...) {}
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__);
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(...) {}
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__);
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(...) {}
546 #define RADIOLIB_VALUE_TO_STRING(x) #x
547 #define RADIOLIB_VALUE(x) RADIOLIB_VALUE_TO_STRING(x)
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__)
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); } }
565 #define RADIOLIB_ASSERT(STATEVAR) { if((STATEVAR) != RADIOLIB_ERR_NONE) { return(STATEVAR); } }
571 #if RADIOLIB_CHECK_PARAMS
572 #define RADIOLIB_CHECK_RANGE(VAR, MIN, MAX, ERR) { if(!(((VAR) >= (MIN)) && ((VAR) <= (MAX)))) { return(ERR); } }
574 #define RADIOLIB_CHECK_RANGE(VAR, MIN, MAX, ERR) {}
577 #if RADIOLIB_FIX_ERRATA_SX127X
578 #define RADIOLIB_ERRATA_SX127X(...) { errataFix(__VA_ARGS__); }
580 #define RADIOLIB_ERRATA_SX127X(...) {}
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))
589 #define RADIOLIB_VERSION_MAJOR 7
590 #define RADIOLIB_VERSION_MINOR 0
591 #define RADIOLIB_VERSION_PATCH 0
592 #define RADIOLIB_VERSION_EXTRA 0
594 #define RADIOLIB_VERSION (((RADIOLIB_VERSION_MAJOR) << 24) | ((RADIOLIB_VERSION_MINOR) << 16) | ((RADIOLIB_VERSION_PATCH) << 8) | (RADIOLIB_VERSION_EXTRA))
unsigned long RadioLibTime_t
Type used for durations in RadioLib.
Definition: TypeDef.h:621