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)
147 #if defined(RADIOLIB_CUSTOM_ARDUINO)
149 #define RADIOLIB_PLATFORM "Custom"
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;
165 #define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST
166 #define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST
167 #define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST
192 #elif defined(__AVR__) && !(defined(ARDUINO_AVR_UNO_WIFI_REV2) || defined(ARDUINO_AVR_NANO_EVERY) || defined(ARDUINO_ARCH_MEGAAVR))
194 #define RADIOLIB_PLATFORM "Arduino AVR"
196 #if !(defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__) || defined(__AVR_ATmega1284__) || defined(__AVR_ATmega1284P__))
197 #define RADIOLIB_LOWEND_PLATFORM
200 #elif defined(ESP8266)
202 #define RADIOLIB_PLATFORM "ESP8266"
204 #elif defined(ESP32) || defined(ARDUINO_ARCH_ESP32)
205 #define RADIOLIB_ESP32
208 #define RADIOLIB_PLATFORM "ESP32"
211 #define RADIOLIB_TONE_UNSUPPORTED
212 #define RADIOLIB_TONE_ESP32_CHANNEL (1)
214 #elif defined(ARDUINO_ARCH_STM32)
216 #define RADIOLIB_PLATFORM "Arduino STM32 (official)"
218 #elif defined(SAMD_SERIES)
220 #define RADIOLIB_PLATFORM "Adafruit SAMD"
222 #elif defined(ARDUINO_ARCH_SAMD)
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)
229 #elif defined(__SAM3X8E__)
231 #define RADIOLIB_PLATFORM "Arduino Due"
232 #define RADIOLIB_TONE_UNSUPPORTED
234 #elif (defined(NRF52832_XXAA) || defined(NRF52840_XXAA)) && !defined(ARDUINO_ARDUINO_NANO33BLE)
236 #define RADIOLIB_PLATFORM "Adafruit nRF52"
238 #elif defined(ARDUINO_ARC32_TOOLS)
240 #define RADIOLIB_PLATFORM "Intel Curie"
242 #elif defined(ARDUINO_AVR_UNO_WIFI_REV2) || defined(ARDUINO_AVR_NANO_EVERY) || defined(PORTDUINO)
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)
249 #elif defined(ARDUINO_ARCH_APOLLO3)
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)
256 #elif defined(ARDUINO_ARDUINO_NANO33BLE)
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)
264 #define RADIOLIB_TONE_UNSUPPORTED
265 #define RADIOLIB_MBED_TONE_OVERRIDE
267 #elif defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_PORTENTA_H7_M4)
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)
275 #define RADIOLIB_TONE_UNSUPPORTED
276 #define RADIOLIB_MBED_TONE_OVERRIDE
278 #elif defined(__STM32F4__) || defined(__STM32F1__)
280 #define RADIOLIB_PLATFORM "STM32duino (unofficial)"
281 #define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (WiringPinMode)
282 #define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (ExtIntTriggerMode)
284 #elif defined(ARDUINO_ARCH_MEGAAVR)
286 #define RADIOLIB_PLATFORM "MegaCoreX"
288 #elif defined(ARDUINO_ARCH_MBED_RP2040)
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)
296 #define RADIOLIB_TONE_UNSUPPORTED
297 #define RADIOLIB_MBED_TONE_OVERRIDE
299 #elif defined(ARDUINO_ARCH_RP2040)
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)
306 #elif defined(__ASR6501__) || defined(ARDUINO_ARCH_ASR650X) || defined(DARDUINO_ARCH_ASR6601)
308 #define RADIOLIB_PLATFORM "CubeCell"
309 #define RADIOLIB_DEFAULT_SPI_SETTINGS SPISettings(1000000, MSBFIRST, SPI_MODE0)
310 #define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PINMODE)
311 #define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (IrqModes)
320 #define RADIOLIB_TYPE_ALIAS(type, alias) typedef class type alias;
323 #define RADIOLIB_TONE_UNSUPPORTED
326 #define RADIOLIB_YIELD_UNSUPPORTED
333 #define RADIOLIB_PLATFORM "RasPiArduino"
336 #define RADIOLIB_TONE_UNSUPPORTED
339 #define RADIOLIB_YIELD_UNSUPPORTED
342 #define PGM_P const char *
355 #elif defined(TEENSYDUINO)
357 #define RADIOLIB_PLATFORM "Teensy"
359 #elif defined(ARDUINO_ARCH_RENESAS)
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)
366 #elif defined(ARDUINO_ARCH_SILABS)
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)
375 #define RADIOLIB_PLATFORM "Unknown Arduino"
376 #define RADIOLIB_UNKNOWN_PLATFORM
382 #if !defined(RADIOLIB_NC)
383 #define RADIOLIB_NC (0xFFFFFFFF)
386 #if !defined(RADIOLIB_DEFAULT_SPI)
387 #define RADIOLIB_DEFAULT_SPI SPI
390 #if !defined(RADIOLIB_DEFAULT_SPI_SETTINGS)
391 #define RADIOLIB_DEFAULT_SPI_SETTINGS SPISettings(2000000, MSBFIRST, SPI_MODE0)
394 #if !defined(RADIOLIB_NONVOLATILE)
395 #define RADIOLIB_NONVOLATILE PROGMEM
398 #if !defined(RADIOLIB_NONVOLATILE_PTR)
399 #define RADIOLIB_NONVOLATILE_PTR PGM_P
402 #if !defined(RADIOLIB_NONVOLATILE_READ_BYTE)
403 #define RADIOLIB_NONVOLATILE_READ_BYTE(addr) pgm_read_byte(addr)
406 #if !defined(RADIOLIB_NONVOLATILE_READ_DWORD)
407 #define RADIOLIB_NONVOLATILE_READ_DWORD(addr) pgm_read_dword(addr)
410 #if !defined(RADIOLIB_TYPE_ALIAS)
411 #define RADIOLIB_TYPE_ALIAS(type, alias) using alias = type;
414 #if !defined(RADIOLIB_ARDUINOHAL_PIN_MODE_CAST)
415 #define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST
418 #if !defined(RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST)
419 #define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST
422 #if !defined(RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST)
423 #define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST
428 #define RADIOLIB_PLATFORM "Generic"
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;
436 #if !defined(RADIOLIB_DEBUG_PORT)
437 #define RADIOLIB_DEBUG_PORT stdout
451 #if (!defined(ARDUINO_ARCH_STM32) || !defined(SUBGHZSPI_BASE)) && !defined(DOXYGEN)
452 #define RADIOLIB_EXCLUDE_STM32WLX (1)
456 #if RADIOLIB_VERBOSE_ASSERT
457 #define RADIOLIB_DEBUG (1)
461 #if RADIOLIB_DEBUG_BASIC || RADIOLIB_DEBUG_PROTOCOL || RADIOLIB_DEBUG_SPI
462 #define RADIOLIB_DEBUG (1)
464 #define RADIOLIB_DEBUG (0)
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__)
475 #define RADIOLIB_DEBUG_PRINT_FLOAT(LEVEL, VAL, DECIMALS) RADIOLIB_DEBUG_PRINT(LEVEL); RADIOLIB_DEBUG_PORT.print(VAL, DECIMALS)
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__)
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__)
485 #define RADIOLIB_DEBUG_PRINT_FLOAT(LEVEL, VAL, DECIMALS) RADIOLIB_DEBUG_PRINT(LEVEL "%.3f", VAL)
488 #define RADIOLIB_DEBUG_HEXDUMP(LEVEL, ...) rlb_hexdump(LEVEL, __VA_ARGS__)
490 #define RADIOLIB_DEBUG_PRINT(...) {}
491 #define RADIOLIB_DEBUG_PRINTLN(...) {}
492 #define RADIOLIB_DEBUG_PRINT_FLOAT(VAL, DECIMALS) {}
493 #define RADIOLIB_DEBUG_HEXDUMP(...) {}
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__);
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(...) {}
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__);
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(...) {}
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__);
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(...) {}
539 #define RADIOLIB_VALUE_TO_STRING(x) #x
540 #define RADIOLIB_VALUE(x) RADIOLIB_VALUE_TO_STRING(x)
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__)
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); } }
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); } }
566 #if RADIOLIB_CHECK_PARAMS
567 #define RADIOLIB_CHECK_RANGE(VAR, MIN, MAX, ERR) { if(!(((VAR) >= (MIN)) && ((VAR) <= (MAX)))) { return(ERR); } }
569 #define RADIOLIB_CHECK_RANGE(VAR, MIN, MAX, ERR) {}
572 #if RADIOLIB_FIX_ERRATA_SX127X
573 #define RADIOLIB_ERRATA_SX127X(...) { errataFix(__VA_ARGS__); }
575 #define RADIOLIB_ERRATA_SX127X(...) {}
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))
584 #define RADIOLIB_VERSION_MAJOR 7
585 #define RADIOLIB_VERSION_MINOR 1
586 #define RADIOLIB_VERSION_PATCH 0
587 #define RADIOLIB_VERSION_EXTRA 0
589 #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