RadioLib
Universal wireless communication library for Arduino
Loading...
Searching...
No Matches
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
#if ARDUINO >= 100
33
#define RADIOLIB_DEBUG_PORT Serial
34
#else
35
#define RADIOLIB_DEBUG_PORT stdout
36
#endif
37
#endif
38
39
/*
40
* Comment to disable "paranoid" SPI mode, or set RADIOLIB_SPI_PARANOID to 0
41
* Every write to an SPI register using SPI set function will be verified by a subsequent read operation.
42
* This improves reliability, but slightly slows down communication.
43
* Note: Enabled by default.
44
*/
45
#if !defined(RADIOLIB_SPI_PARANOID)
46
#define RADIOLIB_SPI_PARANOID (1)
47
#endif
48
49
/*
50
* Comment to disable parameter range checking
51
* RadioLib will check provided parameters (such as frequency) against limits determined by the device manufacturer.
52
* It is highly advised to keep this macro defined, removing it will allow invalid values to be set,
53
* possibly leading to bricked module and/or program crashing.
54
* Note: Enabled by default.
55
*/
56
#if !defined(RADIOLIB_CHECK_PARAMS)
57
#define RADIOLIB_CHECK_PARAMS (1)
58
#endif
59
60
/*
61
* SX127x errata fix enable
62
* Warning: SX127x errata fix has been reported to cause issues with LoRa bandwidths lower than 62.5 kHz.
63
* It should only be enabled if you really are observing some errata-related issue.
64
* Note: Disabled by default.
65
*/
66
#if !defined(RADIOLIB_FIX_ERRATA_SX127X)
67
#define RADIOLIB_FIX_ERRATA_SX127X (0)
68
#endif
69
70
/*
71
* God mode enable - all methods and member variables in all classes will be made public, thus making them accessible from Arduino code.
72
* Warning: Come on, it's called GOD mode - obviously only use this if you know what you're doing.
73
* Failure to heed the above warning may result in bricked module.
74
*/
75
#if !defined(RADIOLIB_GODMODE)
76
#define RADIOLIB_GODMODE (0)
77
#endif
78
79
/*
80
* Low-level hardware access enable
81
* This will make some hardware methods like SPI get/set accessible from the user sketch - think of it as "god mode lite"
82
* Warning: RadioLib won't stop you from writing invalid stuff into your device, so it's quite easy to brick your module with this.
83
*/
84
#if !defined(RADIOLIB_LOW_LEVEL)
85
#define RADIOLIB_LOW_LEVEL (0)
86
#endif
87
88
/*
89
* Enable interrupt-based timing control
90
* For details, see https://github.com/jgromes/RadioLib/wiki/Interrupt-Based-Timing
91
*/
92
#if !defined(RADIOLIB_INTERRUPT_TIMING)
93
#define RADIOLIB_INTERRUPT_TIMING (0)
94
#endif
95
96
/*
97
* Enable static-only memory management: no dynamic allocation will be performed.
98
* Warning: Large static arrays will be created in some methods. It is not advised to send large packets in this mode.
99
*/
100
#if !defined(RADIOLIB_STATIC_ONLY)
101
#define RADIOLIB_STATIC_ONLY (0)
102
#endif
103
104
// set the size of static arrays to use
105
#if !defined(RADIOLIB_STATIC_ARRAY_SIZE)
106
#define RADIOLIB_STATIC_ARRAY_SIZE (256)
107
#endif
108
109
/*
110
* Uncomment on boards whose clock runs too slow or too fast
111
* Set the value according to the following scheme:
112
* Enable timestamps on your terminal
113
* Print something to terminal, wait 1000 milliseconds, print something again
114
* If the difference is e.g. 1014 milliseconds between the prints, set this value to 14
115
* Or, for more accuracy, wait for 100,000 milliseconds and divide the total drift by 100
116
*/
117
#if !defined(RADIOLIB_CLOCK_DRIFT_MS)
118
//#define RADIOLIB_CLOCK_DRIFT_MS (0)
119
#endif
120
121
#if ARDUINO >= 100
122
// Arduino build
123
#include "Arduino.h"
124
#define RADIOLIB_BUILD_ARDUINO
125
#else
126
// generic build
127
#include <stdio.h>
128
#define RADIOLIB_BUILD_GENERIC
129
#endif
130
131
#if defined(RADIOLIB_BUILD_ARDUINO)
132
/*
133
* Platform-specific configuration.
134
*
135
* RADIOLIB_PLATFORM - platform name, used in debugging to quickly check the correct platform is detected.
136
* RADIOLIB_NC - alias for unused pin, usually the largest possible value of uint32_t.
137
* RADIOLIB_DEFAULT_SPI - default SPIClass instance to use.
138
* RADIOLIB_NONVOLATILE - macro to place variable into program storage (usually Flash).
139
* RADIOLIB_NONVOLATILE_READ_BYTE - function/macro to read variables saved in program storage (usually Flash).
140
* RADIOLIB_TYPE_ALIAS - construct to create an alias for a type, usually via the `using` keyword.
141
* RADIOLIB_TONE_UNSUPPORTED - some platforms do not have tone()/noTone(), which is required for AFSK.
142
*
143
* Users may also specify their own configuration by uncommenting the RADIOLIB_CUSTOM_ARDUINO,
144
* and then specifying all platform parameters in the section below. This will override automatic
145
* platform detection.
146
*/
147
148
// uncomment to enable custom platform definition
149
//#define RADIOLIB_CUSTOM_ARDUINO
150
151
#if defined(RADIOLIB_CUSTOM_ARDUINO)
152
// name for your platform
153
#define RADIOLIB_PLATFORM "Custom"
154
155
// the following must be defined if the Arduino core does not support tone or yield function
156
//#define RADIOLIB_TONE_UNSUPPORTED
157
//#define RADIOLIB_YIELD_UNSUPPORTED
158
159
// in addition, the following macros may be defined if the Arduino core differs from the defaults
160
#define RADIOLIB_NC (0xFFFFFFFF)
161
#define RADIOLIB_DEFAULT_SPI SPI
162
#define RADIOLIB_DEFAULT_SPI_SETTINGS SPISettings(2000000, MSBFIRST, SPI_MODE0)
163
#define RADIOLIB_NONVOLATILE PROGMEM
164
#define RADIOLIB_NONVOLATILE_READ_BYTE(addr) pgm_read_byte(addr)
165
#define RADIOLIB_NONVOLATILE_READ_DWORD(addr) pgm_read_dword(addr)
166
#define RADIOLIB_TYPE_ALIAS(type, alias) using alias = type;
167
168
// you might also have to define these if the Arduino core has some uncommon pin mode/status types
169
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST
170
#define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST
171
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST
172
173
// some of RadioLib drivers may be excluded, to prevent collisions with platforms (or to speed up build process)
174
// the following is a complete list of all possible exclusion macros, uncomment any of them to disable that driver
175
// NOTE: Some of the exclusion macros are dependent on each other. For example, it is not possible to exclude RF69
176
// while keeping SX1231 (because RF69 is the base class for SX1231). The dependency is always uni-directional,
177
// so excluding SX1231 and keeping RF69 is valid.
178
//#define RADIOLIB_EXCLUDE_CC1101 (1)
179
//#define RADIOLIB_EXCLUDE_NRF24 (1)
180
//#define RADIOLIB_EXCLUDE_RF69 (1)
181
//#define RADIOLIB_EXCLUDE_SX1231 (1) // dependent on RADIOLIB_EXCLUDE_RF69
182
//#define RADIOLIB_EXCLUDE_SI443X (1)
183
//#define RADIOLIB_EXCLUDE_RFM2X (1) // dependent on RADIOLIB_EXCLUDE_SI443X
184
//#define RADIOLIB_EXCLUDE_SX127X (1)
185
//#define RADIOLIB_EXCLUDE_SX126X (1)
186
//#define RADIOLIB_EXCLUDE_STM32WLX (1) // dependent on RADIOLIB_EXCLUDE_SX126X
187
//#define RADIOLIB_EXCLUDE_SX128X (1)
188
//#define RADIOLIB_EXCLUDE_AFSK (1)
189
//#define RADIOLIB_EXCLUDE_AX25 (1)
190
//#define RADIOLIB_EXCLUDE_HELLSCHREIBER (1)
191
//#define RADIOLIB_EXCLUDE_MORSE (1)
192
//#define RADIOLIB_EXCLUDE_RTTY (1)
193
//#define RADIOLIB_EXCLUDE_SSTV (1)
194
//#define RADIOLIB_EXCLUDE_DIRECT_RECEIVE (1)
195
196
#elif defined(__AVR__) && !(defined(ARDUINO_AVR_UNO_WIFI_REV2) || defined(ARDUINO_AVR_NANO_EVERY) || defined(ARDUINO_ARCH_MEGAAVR))
197
// Arduino AVR boards (except for megaAVR) - Uno, Mega etc.
198
#define RADIOLIB_PLATFORM "Arduino AVR"
199
200
#if !(defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__) || defined(__AVR_ATmega1284__) || defined(__AVR_ATmega1284P__))
201
#define RADIOLIB_LOWEND_PLATFORM
202
#endif
203
204
#elif defined(ESP8266)
205
// ESP8266 boards
206
#define RADIOLIB_PLATFORM "ESP8266"
207
208
#elif defined(ESP32) || defined(ARDUINO_ARCH_ESP32)
209
#define RADIOLIB_ESP32
210
211
// ESP32 boards
212
#define RADIOLIB_PLATFORM "ESP32"
213
214
// ESP32 doesn't support tone(), but it can be emulated via LED control peripheral
215
#define RADIOLIB_TONE_UNSUPPORTED
216
#define RADIOLIB_TONE_ESP32_CHANNEL (1)
217
218
#elif defined(ARDUINO_ARCH_STM32)
219
// official STM32 Arduino core (https://github.com/stm32duino/Arduino_Core_STM32)
220
#define RADIOLIB_PLATFORM "Arduino STM32 (official)"
221
222
#elif defined(SAMD_SERIES)
223
// Adafruit SAMD boards (M0 and M4)
224
#define RADIOLIB_PLATFORM "Adafruit SAMD"
225
226
#elif defined(ARDUINO_ARCH_SAMD)
227
// Arduino SAMD (Zero, MKR, etc.)
228
#define RADIOLIB_PLATFORM "Arduino SAMD"
229
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PinMode)
230
#define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
231
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
232
233
#elif defined(__SAM3X8E__)
234
// Arduino Due
235
#define RADIOLIB_PLATFORM "Arduino Due"
236
#define RADIOLIB_TONE_UNSUPPORTED
237
238
#elif (defined(NRF52832_XXAA) || defined(NRF52840_XXAA)) && !defined(ARDUINO_ARDUINO_NANO33BLE)
239
// Adafruit nRF52 boards
240
#define RADIOLIB_PLATFORM "Adafruit nRF52"
241
242
#elif defined(ARDUINO_ARC32_TOOLS)
243
// Intel Curie
244
#define RADIOLIB_PLATFORM "Intel Curie"
245
246
#elif defined(ARDUINO_AVR_UNO_WIFI_REV2) || defined(ARDUINO_AVR_NANO_EVERY) || defined(PORTDUINO)
247
// Arduino megaAVR boards - Uno Wifi Rev.2, Nano Every
248
#define RADIOLIB_PLATFORM "Arduino megaAVR"
249
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PinMode)
250
#define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
251
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
252
253
#elif defined(ARDUINO_ARCH_APOLLO3)
254
// Sparkfun Apollo3 boards
255
#define RADIOLIB_PLATFORM "Sparkfun Apollo3"
256
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (Arduino_PinMode)
257
#define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
258
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
259
260
#elif defined(ARDUINO_ARDUINO_NANO33BLE)
261
// Arduino Nano 33 BLE
262
#define RADIOLIB_PLATFORM "Arduino Nano 33 BLE"
263
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PinMode)
264
#define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
265
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
266
267
// Arduino mbed OS boards have a really bad tone implementation which will crash after a couple seconds
268
#define RADIOLIB_TONE_UNSUPPORTED
269
#define RADIOLIB_MBED_TONE_OVERRIDE
270
271
#elif defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_PORTENTA_H7_M4)
272
// Arduino Portenta H7
273
#define RADIOLIB_PLATFORM "Portenta H7"
274
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PinMode)
275
#define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
276
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
277
278
// Arduino mbed OS boards have a really bad tone implementation which will crash after a couple seconds
279
#define RADIOLIB_TONE_UNSUPPORTED
280
#define RADIOLIB_MBED_TONE_OVERRIDE
281
282
#elif defined(__STM32F4__) || defined(__STM32F1__)
283
// Arduino STM32 core by Roger Clark (https://github.com/rogerclarkmelbourne/Arduino_STM32)
284
#define RADIOLIB_PLATFORM "STM32duino (unofficial)"
285
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (WiringPinMode)
286
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (ExtIntTriggerMode)
287
288
#elif defined(ARDUINO_ARCH_MEGAAVR)
289
// MegaCoreX by MCUdude (https://github.com/MCUdude/MegaCoreX)
290
#define RADIOLIB_PLATFORM "MegaCoreX"
291
292
#elif defined(ARDUINO_ARCH_MBED_RP2040)
293
// Raspberry Pi Pico (official mbed core)
294
#define RADIOLIB_PLATFORM "Raspberry Pi Pico"
295
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PinMode)
296
#define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
297
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
298
299
// Arduino mbed OS boards have a really bad tone implementation which will crash after a couple seconds
300
#define RADIOLIB_TONE_UNSUPPORTED
301
#define RADIOLIB_MBED_TONE_OVERRIDE
302
303
#elif defined(ARDUINO_ARCH_RP2040)
304
// Raspberry Pi Pico (unofficial core)
305
#define RADIOLIB_PLATFORM "Raspberry Pi Pico (unofficial)"
306
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PinMode)
307
#define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
308
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
309
310
#elif defined(__ASR6501__) || defined(ARDUINO_ARCH_ASR650X) || defined(DARDUINO_ARCH_ASR6601)
311
// CubeCell
312
#define RADIOLIB_PLATFORM "CubeCell"
313
#define RADIOLIB_DEFAULT_SPI_SETTINGS SPISettings(1000000, MSBFIRST, SPI_MODE0)
// see issue #709
314
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PINMODE)
315
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (IrqModes)
316
317
// CubeCell doesn't seem to define nullptr, let's do something like that now
318
#define nullptr NULL
319
320
// ... and also defines pinMode() as a macro, which is by far the stupidest thing I have seen on Arduino
321
#undef pinMode
322
323
// ... and uses an outdated GCC which does not support type aliases
324
#define RADIOLIB_TYPE_ALIAS(type, alias) typedef class type alias;
325
326
// ... and it also has no tone(). This platform was designed by an idiot.
327
#define RADIOLIB_TONE_UNSUPPORTED
328
329
// ... AND as the (hopefully) final nail in the coffin, IT F*CKING DEFINES YIELD() AS A MACRO THAT DOES NOTHING!!!
330
#define RADIOLIB_YIELD_UNSUPPORTED
331
#if defined(yield)
332
#undef yield
333
#endif
334
335
#elif defined(RASPI)
336
// RaspiDuino framework (https://github.com/me-no-dev/RasPiArduino)
337
#define RADIOLIB_PLATFORM "RasPiArduino"
338
339
// let's start off easy - no tone on this platform, that can happen
340
#define RADIOLIB_TONE_UNSUPPORTED
341
342
// hmm, no yield either - weird on something like Raspberry PI, but sure, we can handle it
343
#define RADIOLIB_YIELD_UNSUPPORTED
344
345
// aight, getting to the juicy stuff - PGM_P seems missing, that's the first time
346
#define PGM_P const char *
347
348
// ... and for the grand finale, we have millis() and micros() DEFINED AS MACROS!
349
#if defined(millis)
350
#undef millis
351
inline
RadioLibTime_t
millis() {
return
((
RadioLibTime_t
)(STCV / 1000)); };
352
#endif
353
354
#if defined(micros)
355
#undef micros
356
inline
RadioLibTime_t
micros() {
return
((
RadioLibTime_t
)(STCV)); };
357
#endif
358
359
#elif defined(TEENSYDUINO)
360
// Teensy
361
#define RADIOLIB_PLATFORM "Teensy"
362
363
#elif defined(ARDUINO_ARCH_RENESAS)
364
// Arduino Renesas (UNO R4)
365
#define RADIOLIB_PLATFORM "Arduino Renesas (UNO R4)"
366
#define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST (PinMode)
367
#define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST (PinStatus)
368
#define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST (PinStatus)
369
370
#elif defined(ARDUINO_ARCH_SILABS)
371
// Silicon Labs Arduino
372
#define RADIOLIB_PLATFORM "Arduino Silicon Labs"
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 (0xFFFFFFFF)
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
#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 2
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
RadioLibTime_t
unsigned long RadioLibTime_t
Type used for durations in RadioLib.
Definition
TypeDef.h:642
src
BuildOpt.h
Generated by
1.9.8