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)
88 #if !defined(RADIOLIB_INTERRUPT_TIMING)
89 #define RADIOLIB_INTERRUPT_TIMING (0)
96 #if !defined(RADIOLIB_STATIC_ONLY)
97 #define RADIOLIB_STATIC_ONLY (0)
101 #if !defined(RADIOLIB_STATIC_ARRAY_SIZE)
102 #define RADIOLIB_STATIC_ARRAY_SIZE (256)
113 #if !defined(RADIOLIB_CLOCK_DRIFT_MS)
120 #define RADIOLIB_BUILD_ARDUINO
124 #define RADIOLIB_BUILD_GENERIC
127 #if defined(RADIOLIB_BUILD_ARDUINO)
149 #if defined(RADIOLIB_CUSTOM_ARDUINO)
151 #define RADIOLIB_PLATFORM "Custom"
158 #define RADIOLIB_NC (0xFFFFFFFF)
159 #define RADIOLIB_DEFAULT_SPI SPI
160 #define RADIOLIB_DEFAULT_SPI_SETTINGS SPISettings(2000000, MSBFIRST, SPI_MODE0)
161 #define RADIOLIB_NONVOLATILE PROGMEM
162 #define RADIOLIB_NONVOLATILE_READ_BYTE(addr) pgm_read_byte(addr)
163 #define RADIOLIB_NONVOLATILE_READ_DWORD(addr) pgm_read_dword(addr)
164 #define RADIOLIB_TYPE_ALIAS(type, alias) using alias = type;
167 #define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST
168 #define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST
169 #define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST
194 #elif defined(__AVR__) && !(defined(ARDUINO_AVR_UNO_WIFI_REV2) || defined(ARDUINO_AVR_NANO_EVERY) || defined(ARDUINO_ARCH_MEGAAVR))
196 #define RADIOLIB_PLATFORM "Arduino AVR"
198 #if !(defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__) || defined(__AVR_ATmega1284__) || defined(__AVR_ATmega1284P__))
199 #define RADIOLIB_LOWEND_PLATFORM
202 #elif defined(ESP8266)
204 #define RADIOLIB_PLATFORM "ESP8266"
206 #elif defined(ESP32) || defined(ARDUINO_ARCH_ESP32)
207 #define RADIOLIB_ESP32
210 #define RADIOLIB_PLATFORM "ESP32"
213 #define RADIOLIB_TONE_UNSUPPORTED
214 #define RADIOLIB_TONE_ESP32_CHANNEL (1)
216 #elif defined(ARDUINO_ARCH_STM32)
218 #define RADIOLIB_PLATFORM "Arduino STM32 (official)"
220 #elif defined(SAMD_SERIES)
222 #define RADIOLIB_PLATFORM "Adafruit SAMD"
224 #elif defined(ARDUINO_ARCH_SAMD)
226 #define RADIOLIB_PLATFORM "Arduino SAMD"
227 #define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PinMode)
228 #define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
229 #define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
231 #elif defined(__SAM3X8E__)
233 #define RADIOLIB_PLATFORM "Arduino Due"
234 #define RADIOLIB_TONE_UNSUPPORTED
236 #elif (defined(NRF52832_XXAA) || defined(NRF52840_XXAA)) && !defined(ARDUINO_ARDUINO_NANO33BLE)
238 #define RADIOLIB_PLATFORM "Adafruit nRF52"
240 #elif defined(ARDUINO_ARC32_TOOLS)
242 #define RADIOLIB_PLATFORM "Intel Curie"
244 #elif defined(ARDUINO_AVR_UNO_WIFI_REV2) || defined(ARDUINO_AVR_NANO_EVERY) || defined(PORTDUINO)
246 #define RADIOLIB_PLATFORM "Arduino megaAVR"
247 #define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PinMode)
248 #define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
249 #define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
251 #elif defined(ARDUINO_ARCH_APOLLO3)
253 #define RADIOLIB_PLATFORM "Sparkfun Apollo3"
254 #define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (Arduino_PinMode)
255 #define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
256 #define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
258 #elif defined(ARDUINO_ARDUINO_NANO33BLE)
260 #define RADIOLIB_PLATFORM "Arduino Nano 33 BLE"
261 #define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PinMode)
262 #define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
263 #define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
266 #define RADIOLIB_TONE_UNSUPPORTED
267 #define RADIOLIB_MBED_TONE_OVERRIDE
269 #elif defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_PORTENTA_H7_M4)
271 #define RADIOLIB_PLATFORM "Portenta H7"
272 #define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PinMode)
273 #define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
274 #define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
277 #define RADIOLIB_TONE_UNSUPPORTED
278 #define RADIOLIB_MBED_TONE_OVERRIDE
280 #elif defined(__STM32F4__) || defined(__STM32F1__)
282 #define RADIOLIB_PLATFORM "STM32duino (unofficial)"
283 #define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (WiringPinMode)
284 #define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (ExtIntTriggerMode)
286 #elif defined(ARDUINO_ARCH_MEGAAVR)
288 #define RADIOLIB_PLATFORM "MegaCoreX"
290 #elif defined(ARDUINO_ARCH_MBED_RP2040)
292 #define RADIOLIB_PLATFORM "Raspberry Pi Pico"
293 #define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PinMode)
294 #define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
295 #define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
298 #define RADIOLIB_TONE_UNSUPPORTED
299 #define RADIOLIB_MBED_TONE_OVERRIDE
301 #elif defined(ARDUINO_ARCH_RP2040)
303 #define RADIOLIB_PLATFORM "Raspberry Pi Pico (unofficial)"
304 #define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PinMode)
305 #define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
306 #define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
308 #elif defined(__ASR6501__) || defined(ARDUINO_ARCH_ASR650X) || defined(DARDUINO_ARCH_ASR6601)
310 #define RADIOLIB_PLATFORM "CubeCell"
311 #define RADIOLIB_DEFAULT_SPI_SETTINGS SPISettings(1000000, MSBFIRST, SPI_MODE0)
312 #define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PINMODE)
313 #define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (IrqModes)
322 #define RADIOLIB_TYPE_ALIAS(type, alias) typedef class type alias;
325 #define RADIOLIB_TONE_UNSUPPORTED
328 #define RADIOLIB_YIELD_UNSUPPORTED
335 #define RADIOLIB_PLATFORM "RasPiArduino"
338 #define RADIOLIB_TONE_UNSUPPORTED
341 #define RADIOLIB_YIELD_UNSUPPORTED
344 #define PGM_P const char *
357 #elif defined(TEENSYDUINO)
359 #define RADIOLIB_PLATFORM "Teensy"
361 #elif defined(ARDUINO_ARCH_RENESAS)
363 #define RADIOLIB_PLATFORM "Arduino Renesas (UNO R4)"
364 #define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PinMode)
365 #define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
366 #define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
370 #define RADIOLIB_PLATFORM "Unknown Arduino"
371 #define RADIOLIB_UNKNOWN_PLATFORM
377 #if !defined(RADIOLIB_NC)
378 #define RADIOLIB_NC (0xFFFFFFFF)
381 #if !defined(RADIOLIB_DEFAULT_SPI)
382 #define RADIOLIB_DEFAULT_SPI SPI
385 #if !defined(RADIOLIB_DEFAULT_SPI_SETTINGS)
386 #define RADIOLIB_DEFAULT_SPI_SETTINGS SPISettings(2000000, MSBFIRST, SPI_MODE0)
389 #if !defined(RADIOLIB_NONVOLATILE)
390 #define RADIOLIB_NONVOLATILE PROGMEM
393 #if !defined(RADIOLIB_NONVOLATILE_PTR)
394 #define RADIOLIB_NONVOLATILE_PTR PGM_P
397 #if !defined(RADIOLIB_NONVOLATILE_READ_BYTE)
398 #define RADIOLIB_NONVOLATILE_READ_BYTE(addr) pgm_read_byte(addr)
401 #if !defined(RADIOLIB_NONVOLATILE_READ_DWORD)
402 #define RADIOLIB_NONVOLATILE_READ_DWORD(addr) pgm_read_dword(addr)
405 #if !defined(RADIOLIB_TYPE_ALIAS)
406 #define RADIOLIB_TYPE_ALIAS(type, alias) using alias = type;
409 #if !defined(RADIOLIB_ARDUINOHAL_PIN_MODE_CAST)
410 #define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST
413 #if !defined(RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST)
414 #define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST
417 #if !defined(RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST)
418 #define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST
423 #define RADIOLIB_PLATFORM "Generic"
425 #define RADIOLIB_NC (0xFF)
426 #define RADIOLIB_NONVOLATILE
427 #define RADIOLIB_NONVOLATILE_READ_BYTE(addr) (*((uint8_t *)(void *)(addr)))
428 #define RADIOLIB_NONVOLATILE_READ_DWORD(addr) (*((uint32_t *)(void *)(addr)))
429 #define RADIOLIB_TYPE_ALIAS(type, alias) using alias = type;
431 #if !defined(RADIOLIB_DEBUG_PORT)
432 #define RADIOLIB_DEBUG_PORT stdout
446 #if (!defined(ARDUINO_ARCH_STM32) || !defined(SUBGHZSPI_BASE)) && !defined(DOXYGEN)
447 #define RADIOLIB_EXCLUDE_STM32WLX (1)
451 #if RADIOLIB_VERBOSE_ASSERT
452 #define RADIOLIB_DEBUG (1)
456 #if RADIOLIB_DEBUG_BASIC || RADIOLIB_DEBUG_PROTOCOL || RADIOLIB_DEBUG_SPI
457 #define RADIOLIB_DEBUG (1)
459 #define RADIOLIB_DEBUG (0)
463 #if defined(RADIOLIB_BUILD_ARDUINO)
464 #define RADIOLIB_DEBUG_PRINT(...) rlb_printf(__VA_ARGS__)
465 #define RADIOLIB_DEBUG_PRINTLN(M, ...) rlb_printf(M "\n", ##__VA_ARGS__)
466 #define RADIOLIB_DEBUG_PRINT_LVL(LEVEL, M, ...) rlb_printf(LEVEL "" M, ##__VA_ARGS__)
467 #define RADIOLIB_DEBUG_PRINTLN_LVL(LEVEL, M, ...) rlb_printf(LEVEL "" M "\n", ##__VA_ARGS__)
470 #define RADIOLIB_DEBUG_PRINT_FLOAT(LEVEL, VAL, DECIMALS) RADIOLIB_DEBUG_PRINT(LEVEL); RADIOLIB_DEBUG_PORT.print(VAL, DECIMALS)
472 #if !defined(RADIOLIB_DEBUG_PRINT)
473 #define RADIOLIB_DEBUG_PRINT(...) fprintf(RADIOLIB_DEBUG_PORT, __VA_ARGS__)
474 #define RADIOLIB_DEBUG_PRINT_LVL(LEVEL, M, ...) fprintf(RADIOLIB_DEBUG_PORT, LEVEL "" M, ##__VA_ARGS__)
476 #if !defined(RADIOLIB_DEBUG_PRINTLN)
477 #define RADIOLIB_DEBUG_PRINTLN(M, ...) fprintf(RADIOLIB_DEBUG_PORT, M "\n", ##__VA_ARGS__)
478 #define RADIOLIB_DEBUG_PRINTLN_LVL(LEVEL, M, ...) fprintf(RADIOLIB_DEBUG_PORT, LEVEL "" M "\n", ##__VA_ARGS__)
480 #define RADIOLIB_DEBUG_PRINT_FLOAT(LEVEL, VAL, DECIMALS) RADIOLIB_DEBUG_PRINT(LEVEL "%.3f", VAL)
483 #define RADIOLIB_DEBUG_HEXDUMP(LEVEL, ...) rlb_hexdump(LEVEL, __VA_ARGS__)
485 #define RADIOLIB_DEBUG_PRINT(...) {}
486 #define RADIOLIB_DEBUG_PRINTLN(...) {}
487 #define RADIOLIB_DEBUG_PRINT_FLOAT(VAL, DECIMALS) {}
488 #define RADIOLIB_DEBUG_HEXDUMP(...) {}
491 #if RADIOLIB_DEBUG_BASIC
492 #define RADIOLIB_DEBUG_BASIC_PRINT(...) RADIOLIB_DEBUG_PRINT_LVL("RLB_DBG: ", __VA_ARGS__)
493 #define RADIOLIB_DEBUG_BASIC_PRINT_NOTAG(...) RADIOLIB_DEBUG_PRINT_LVL("", __VA_ARGS__)
494 #define RADIOLIB_DEBUG_BASIC_PRINTLN(...) RADIOLIB_DEBUG_PRINTLN_LVL("RLB_DBG: ", __VA_ARGS__)
495 #define RADIOLIB_DEBUG_BASIC_PRINT_FLOAT(...) RADIOLIB_DEBUG_PRINT_FLOAT("RLB_DBG: ", __VA_ARGS__);
496 #define RADIOLIB_DEBUG_BASIC_HEXDUMP(...) RADIOLIB_DEBUG_HEXDUMP("RLB_DBG: ", __VA_ARGS__);
498 #define RADIOLIB_DEBUG_BASIC_PRINT(...) {}
499 #define RADIOLIB_DEBUG_BASIC_PRINT_NOTAG(...) {}
500 #define RADIOLIB_DEBUG_BASIC_PRINTLN(...) {}
501 #define RADIOLIB_DEBUG_BASIC_PRINT_FLOAT(...) {}
502 #define RADIOLIB_DEBUG_BASIC_HEXDUMP(...) {}
505 #if RADIOLIB_DEBUG_PROTOCOL
506 #define RADIOLIB_DEBUG_PROTOCOL_PRINT(...) RADIOLIB_DEBUG_PRINT_LVL("RLB_PRO: ", __VA_ARGS__)
507 #define RADIOLIB_DEBUG_PROTOCOL_PRINTLN(...) RADIOLIB_DEBUG_PRINTLN_LVL("RLB_PRO: ", __VA_ARGS__)
508 #define RADIOLIB_DEBUG_PROTOCOL_PRINT_FLOAT(...) RADIOLIB_DEBUG_PRINT_FLOAT("RLB_PRO: ", __VA_ARGS__);
509 #define RADIOLIB_DEBUG_PROTOCOL_HEXDUMP(...) RADIOLIB_DEBUG_HEXDUMP("RLB_PRO: ", __VA_ARGS__);
511 #define RADIOLIB_DEBUG_PROTOCOL_PRINT(...) {}
512 #define RADIOLIB_DEBUG_PROTOCOL_PRINTLN(...) {}
513 #define RADIOLIB_DEBUG_PROTOCOL_PRINT_FLOAT(...) {}
514 #define RADIOLIB_DEBUG_PROTOCOL_HEXDUMP(...) {}
517 #if RADIOLIB_DEBUG_SPI
518 #define RADIOLIB_DEBUG_SPI_PRINT(...) RADIOLIB_DEBUG_PRINT_LVL("RLB_SPI: ", __VA_ARGS__)
519 #define RADIOLIB_DEBUG_SPI_PRINT_NOTAG(...) RADIOLIB_DEBUG_PRINT_LVL("", __VA_ARGS__)
520 #define RADIOLIB_DEBUG_SPI_PRINTLN(...) RADIOLIB_DEBUG_PRINTLN_LVL("RLB_SPI: ", __VA_ARGS__)
521 #define RADIOLIB_DEBUG_SPI_PRINTLN_NOTAG(...) RADIOLIB_DEBUG_PRINTLN_LVL("", __VA_ARGS__)
522 #define RADIOLIB_DEBUG_SPI_PRINT_FLOAT(...) RADIOLIB_DEBUG_PRINT_FLOAT("RLB_SPI: ", __VA_ARGS__);
523 #define RADIOLIB_DEBUG_SPI_HEXDUMP(...) RADIOLIB_DEBUG_HEXDUMP("RLB_SPI: ", __VA_ARGS__);
525 #define RADIOLIB_DEBUG_SPI_PRINT(...) {}
526 #define RADIOLIB_DEBUG_SPI_PRINT_NOTAG(...) {}
527 #define RADIOLIB_DEBUG_SPI_PRINTLN(...) {}
528 #define RADIOLIB_DEBUG_SPI_PRINTLN_NOTAG(...) {}
529 #define RADIOLIB_DEBUG_SPI_PRINT_FLOAT(...) {}
530 #define RADIOLIB_DEBUG_SPI_HEXDUMP(...) {}
534 #define RADIOLIB_VALUE_TO_STRING(x) #x
535 #define RADIOLIB_VALUE(x) RADIOLIB_VALUE_TO_STRING(x)
537 #define RADIOLIB_INFO "\nRadioLib Info\nVersion: \"" \
538 RADIOLIB_VALUE(RADIOLIB_VERSION_MAJOR) "." \
539 RADIOLIB_VALUE(RADIOLIB_VERSION_MINOR) "." \
540 RADIOLIB_VALUE(RADIOLIB_VERSION_PATCH) "." \
541 RADIOLIB_VALUE(RADIOLIB_VERSION_EXTRA) "\"\n" \
542 "Platform: " RADIOLIB_VALUE(RADIOLIB_PLATFORM) "\n" \
543 "Compiled: " RADIOLIB_VALUE(__DATE__) " " RADIOLIB_VALUE(__TIME__)
550 #if RADIOLIB_VERBOSE_ASSERT
551 #define RADIOLIB_ASSERT(STATEVAR) { if((STATEVAR) != RADIOLIB_ERR_NONE) { RADIOLIB_DEBUG_BASIC_PRINTLN("%d at %s:%d", STATEVAR, __FILE__, __LINE__); return(STATEVAR); } }
552 #define RADIOLIB_ASSERT_PTR(PTR) { if((PTR) == NULL) { RADIOLIB_DEBUG_BASIC_PRINTLN("NULL at %s:%d", __FILE__, __LINE__); return(RADIOLIB_ERR_MEMORY_ALLOCATION_FAILED); } }
554 #define RADIOLIB_ASSERT(STATEVAR) { if((STATEVAR) != RADIOLIB_ERR_NONE) { return(STATEVAR); } }
555 #define RADIOLIB_ASSERT_PTR(PTR) { if((PTR) == NULL) { return(RADIOLIB_ERR_MEMORY_ALLOCATION_FAILED); } }
561 #if RADIOLIB_CHECK_PARAMS
562 #define RADIOLIB_CHECK_RANGE(VAR, MIN, MAX, ERR) { if(!(((VAR) >= (MIN)) && ((VAR) <= (MAX)))) { return(ERR); } }
564 #define RADIOLIB_CHECK_RANGE(VAR, MIN, MAX, ERR) {}
567 #if RADIOLIB_FIX_ERRATA_SX127X
568 #define RADIOLIB_ERRATA_SX127X(...) { errataFix(__VA_ARGS__); }
570 #define RADIOLIB_ERRATA_SX127X(...) {}
574 #define RADIOLIB_MIN(a,b) ((a)<(b)?(a):(b))
575 #define RADIOLIB_MAX(a,b) ((a)>(b)?(a):(b))
576 #define RADIOLIB_ABS(x) ((x)>0?(x):-(x))
579 #define RADIOLIB_VERSION_MAJOR 7
580 #define RADIOLIB_VERSION_MINOR 0
581 #define RADIOLIB_VERSION_PATCH 2
582 #define RADIOLIB_VERSION_EXTRA 0
584 #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:642