diff --git a/_build_opt_8h_source.html b/_build_opt_8h_source.html index af0fc316..9b29b755 100644 --- a/_build_opt_8h_source.html +++ b/_build_opt_8h_source.html @@ -84,7 +84,7 @@ $(document).ready(function(){initNavTree('_build_opt_8h_source.html','');});
BuildOpt.h
-
1 #ifndef _RADIOLIB_BUILD_OPTIONS_H
2 #define _RADIOLIB_BUILD_OPTIONS_H
3 
4 #if ARDUINO >= 100
5  #include "Arduino.h"
6 #else
7  #error "Unsupported Arduino version (< 1.0.0)"
8 #endif
9 
10 /*
11  * Platform-specific configuration.
12  *
13  * RADIOLIB_PLATFORM - platform name, used in debugging to quickly check the correct platform is detected.
14  * RADIOLIB_PIN_TYPE - which type should be used for pin numbers in functions like digitalRead().
15  * RADIOLIB_PIN_MODE - which type should be used for pin modes in functions like pinMode().
16  * RADIOLIB_PIN_STATUS - which type should be used for pin values in functions like digitalWrite().
17  * RADIOLIB_INTERRUPT_STATUS - which type should be used for pin changes in functions like attachInterrupt().
18  * RADIOLIB_DIGITAL_PIN_TO_INTERRUPT - function/macro to be used to convert digital pin number to interrupt pin number.
19  * RADIOLIB_NC - alias for unused pin, usually the largest possible value of RADIOLIB_PIN_TYPE.
20  * RADIOLIB_DEFAULT_SPI - default SPIClass instance to use.
21  * RADIOLIB_PROGMEM - macro to place variable into program storage (usually Flash).
22  * RADIOLIB_PROGMEM_READ_BYTE - function/macro to read variables saved in program storage (usually Flash).
23  * RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED - defined if the specific platform does not support SoftwareSerial.
24  * RADIOLIB_HARDWARE_SERIAL_PORT - which hardware serial port should be used on platform that do not have SoftwareSerial support.
25  * RADIOLIB_TONE_UNSUPPORTED - some platforms do not have tone()/noTone(), which is required for AFSK.
26  *
27  * In addition, some platforms may require RadioLib to disable specific drivers (such as ESP8266).
28  *
29  * Users may also specify their own configuration by uncommenting the RADIOLIB_CUSTOM_PLATFORM,
30  * and then specifying all platform parameters in the section below. This will override automatic
31  * platform detection.
32  */
33 
34 // uncomment to enable custom platform definition
35 //#define RADIOLIB_CUSTOM_PLATFORM
36 
37 #if defined(RADIOLIB_CUSTOM_PLATFORM)
38  // name for your platform
39  #define RADIOLIB_PLATFORM "Custom"
40 
41  // the following parameters must always be defined
42  #define RADIOLIB_PIN_TYPE uint8_t
43  #define RADIOLIB_PIN_MODE uint8_t
44  #define RADIOLIB_PIN_STATUS uint8_t
45  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
46  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
47  #define RADIOLIB_NC (0xFF)
48  #define RADIOLIB_DEFAULT_SPI SPI
49  #define RADIOLIB_PROGMEM PROGMEM
50  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
51 
52  // the following must be defined if the Arduino core does not support SoftwareSerial library
53  //#define RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
54  //#define RADIOLIB_HARDWARE_SERIAL_PORT Serial1
55 
56  // the following must be defined if the Arduino core does not support tone function
57  //#define RADIOLIB_TONE_UNSUPPORTED
58 
59  // some of RadioLib drivers may be excluded, to prevent collisions with platforms (or to speed up build process)
60  // the following is a complete list of all possible exclusion macros, uncomment any of them to disable that driver
61  // NOTE: Some of the exclusion macros are dependent on each other. For example, it is not possible to exclude RF69
62  // while keeping SX1231 (because RF69 is the base class for SX1231). The dependency is always uni-directional,
63  // so excluding SX1231 and keeping RF69 is valid.
64  //#define RADIOLIB_EXCLUDE_CC1101
65  //#define RADIOLIB_EXCLUDE_ESP8266
66  //#define RADIOLIB_EXCLUDE_HC05
67  //#define RADIOLIB_EXCLUDE_JDY08
68  //#define RADIOLIB_EXCLUDE_NRF24
69  //#define RADIOLIB_EXCLUDE_RF69
70  //#define RADIOLIB_EXCLUDE_SX1231 // dependent on RADIOLIB_EXCLUDE_RF69
71  //#define RADIOLIB_EXCLUDE_SI443X
72  //#define RADIOLIB_EXCLUDE_RFM2X // dependent on RADIOLIB_EXCLUDE_SI443X
73  //#define RADIOLIB_EXCLUDE_SX127X
74  //#define RADIOLIB_EXCLUDE_RFM9X // dependent on RADIOLIB_EXCLUDE_SX127X
75  //#define RADIOLIB_EXCLUDE_SX126X
76  //#define RADIOLIB_EXCLUDE_SX128X
77  //#define RADIOLIB_EXCLUDE_XBEE
78  //#define RADIOLIB_EXCLUDE_AFSK
79  //#define RADIOLIB_EXCLUDE_AX25
80  //#define RADIOLIB_EXCLUDE_HELLSCHREIBER
81  //#define RADIOLIB_EXCLUDE_HTTP
82  //#define RADIOLIB_EXCLUDE_MORSE
83  //#define RADIOLIB_EXCLUDE_MQTT
84  //#define RADIOLIB_EXCLUDE_RTTY
85  //#define RADIOLIB_EXCLUDE_SSTV
86 
87 #else
88  #if defined(__AVR__) && !(defined(ARDUINO_AVR_UNO_WIFI_REV2) || defined(ARDUINO_AVR_NANO_EVERY))
89  // Arduino AVR boards (except for megaAVR) - Uno, Mega etc.
90  #define RADIOLIB_PLATFORM "Arduino AVR"
91  #define RADIOLIB_PIN_TYPE uint8_t
92  #define RADIOLIB_PIN_MODE uint8_t
93  #define RADIOLIB_PIN_STATUS uint8_t
94  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
95  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
96  #define RADIOLIB_NC (0xFF)
97  #define RADIOLIB_DEFAULT_SPI SPI
98  #define RADIOLIB_PROGMEM PROGMEM
99  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
100 
101  #elif defined(ESP8266)
102  // ESP8266 boards
103  #define RADIOLIB_PLATFORM "ESP8266"
104  #define RADIOLIB_PIN_TYPE uint8_t
105  #define RADIOLIB_PIN_MODE uint8_t
106  #define RADIOLIB_PIN_STATUS uint8_t
107  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
108  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
109  #define RADIOLIB_NC (0xFF)
110  #define RADIOLIB_DEFAULT_SPI SPI
111  #define RADIOLIB_PROGMEM PROGMEM
112  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
113 
114  // RadioLib has ESP8266 driver, this must be disabled to use ESP8266 as platform
115  #define RADIOLIB_EXCLUDE_ESP8266
116 
117  #elif defined(ESP32)
118  // ESP32 boards
119  #define RADIOLIB_PLATFORM "ESP32"
120  #define RADIOLIB_PIN_TYPE uint8_t
121  #define RADIOLIB_PIN_MODE uint8_t
122  #define RADIOLIB_PIN_STATUS uint8_t
123  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
124  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
125  #define RADIOLIB_NC (0xFF)
126  #define RADIOLIB_DEFAULT_SPI SPI
127  #define RADIOLIB_PROGMEM PROGMEM
128  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
129  #define RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
130  #define RADIOLIB_HARDWARE_SERIAL_PORT Serial1
131 
132  // ESP32 doesn't support tone(), but it can be emulated via LED control peripheral
133  #define RADIOLIB_TONE_UNSUPPORTED
134  #define RADIOLIB_TONE_ESP32_CHANNEL (1)
135 
136  #elif defined(ARDUINO_ARCH_STM32)
137  // official STM32 Arduino core (https://github.com/stm32duino/Arduino_Core_STM32)
138  #define RADIOLIB_PLATFORM "Arduino STM32 (official)"
139  #define RADIOLIB_PIN_TYPE uint32_t
140  #define RADIOLIB_PIN_MODE uint32_t
141  #define RADIOLIB_PIN_STATUS uint32_t
142  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
143  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(digitalPinToPinName(p))
144  #define RADIOLIB_NC (0xFFFFFFFF)
145  #define RADIOLIB_DEFAULT_SPI SPI
146  #define RADIOLIB_PROGMEM PROGMEM
147  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
148  #define RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
149  #define RADIOLIB_HARDWARE_SERIAL_PORT Serial1
150 
151  #elif defined(SAMD_SERIES)
152  // Arduino SAMD (Zero, MKR, etc.) and Adafruit SAMD boards (M0 and M4)
153  #define RADIOLIB_PLATFORM "Arduino/Adafruit SAMD"
154  #define RADIOLIB_PIN_TYPE uint32_t
155  #define RADIOLIB_PIN_MODE uint32_t
156  #define RADIOLIB_PIN_STATUS uint32_t
157  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
158  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
159  #define RADIOLIB_NC (0xFFFFFFFF)
160  #define RADIOLIB_DEFAULT_SPI SPI
161  #define RADIOLIB_PROGMEM PROGMEM
162  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
163  #define RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
164  #define RADIOLIB_HARDWARE_SERIAL_PORT Serial1
165 
166  #elif defined(__SAM3X8E__)
167  // Arduino Due
168  #define RADIOLIB_PLATFORM "Arduino Due"
169  #define RADIOLIB_PIN_TYPE uint32_t
170  #define RADIOLIB_PIN_MODE uint32_t
171  #define RADIOLIB_PIN_STATUS uint32_t
172  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
173  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
174  #define RADIOLIB_NC (0xFFFFFFFF)
175  #define RADIOLIB_DEFAULT_SPI SPI
176  #define RADIOLIB_PROGMEM PROGMEM
177  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
178  #define RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
179  #define RADIOLIB_HARDWARE_SERIAL_PORT Serial1
180  #define RADIOLIB_TONE_UNSUPPORTED
181 
182  #elif (defined(NRF52832_XXAA) || defined(NRF52840_XXAA)) && !defined(ARDUINO_ARDUINO_NANO33BLE)
183  // Adafruit nRF52 boards
184  #define RADIOLIB_PLATFORM "Adafruit nRF52"
185  #define RADIOLIB_PIN_TYPE uint32_t
186  #define RADIOLIB_PIN_MODE uint32_t
187  #define RADIOLIB_PIN_STATUS uint32_t
188  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
189  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
190  #define RADIOLIB_NC (0xFFFFFFFF)
191  #define RADIOLIB_DEFAULT_SPI SPI
192  #define RADIOLIB_PROGMEM PROGMEM
193  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
194 
195  #elif defined(ARDUINO_ARC32_TOOLS)
196  // Intel Curie
197  #define RADIOLIB_PLATFORM "Intel Curie"
198  #define RADIOLIB_PIN_TYPE uint8_t
199  #define RADIOLIB_PIN_MODE uint8_t
200  #define RADIOLIB_PIN_STATUS uint8_t
201  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
202  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
203  #define RADIOLIB_NC (0xFF)
204  #define RADIOLIB_DEFAULT_SPI SPI
205  #define RADIOLIB_PROGMEM PROGMEM
206  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
207 
208  #elif defined(ARDUINO_AVR_UNO_WIFI_REV2) || defined(ARDUINO_AVR_NANO_EVERY)
209  // Arduino megaAVR boards - Uno Wifi Rev.2, Nano Every
210  #define RADIOLIB_PLATFORM "Arduino megaAVR"
211  #define RADIOLIB_PIN_TYPE uint8_t
212  #define RADIOLIB_PIN_MODE PinMode
213  #define RADIOLIB_PIN_STATUS PinStatus
214  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
215  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
216  #define RADIOLIB_NC (0xFF)
217  #define RADIOLIB_DEFAULT_SPI SPI
218  #define RADIOLIB_PROGMEM PROGMEM
219  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
220 
221  #elif defined(AM_PART_APOLLO3)
222  // Sparkfun Artemis boards
223  #define RADIOLIB_PLATFORM "Sparkfun Artemis"
224  #define RADIOLIB_PIN_TYPE uint8_t
225  #define RADIOLIB_PIN_MODE uint8_t
226  #define RADIOLIB_PIN_STATUS uint8_t
227  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
228  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
229  #define RADIOLIB_NC (0xFF)
230  #define RADIOLIB_DEFAULT_SPI SPI
231  #define RADIOLIB_PROGMEM PROGMEM
232  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
233  #define RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
234  #define RADIOLIB_HARDWARE_SERIAL_PORT Serial1
235 
236  #elif defined(ARDUINO_ARDUINO_NANO33BLE)
237  // Arduino Nano 33 BLE
238  #define RADIOLIB_PLATFORM "Arduino Nano 33 BLE"
239  #define RADIOLIB_PIN_TYPE pin_size_t
240  #define RADIOLIB_PIN_MODE PinMode
241  #define RADIOLIB_PIN_STATUS PinStatus
242  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
243  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
244  #define RADIOLIB_NC (0xFF)
245  #define RADIOLIB_DEFAULT_SPI SPI
246  #define RADIOLIB_PROGMEM PROGMEM
247  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
248  #define RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
249  #define RADIOLIB_HARDWARE_SERIAL_PORT Serial1
250 
251  // Nano 33 BLE uses mbed libraries, which already contain ESP8266 driver
252  #define RADIOLIB_EXCLUDE_ESP8266
253 
254  #elif defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_PORTENTA_H7_M4)
255  // Arduino Portenta H7
256  #define RADIOLIB_PLATFORM "Portenta H7"
257  #define RADIOLIB_PIN_TYPE pin_size_t
258  #define RADIOLIB_PIN_MODE PinMode
259  #define RADIOLIB_PIN_STATUS PinStatus
260  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
261  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
262  #define RADIOLIB_NC (0xFF)
263  #define RADIOLIB_DEFAULT_SPI SPI
264  #define RADIOLIB_PROGMEM PROGMEM
265  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
266  #define RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
267  #define RADIOLIB_HARDWARE_SERIAL_PORT Serial1
268 
269  // Arduino Portenta H7 uses mbed libraries, which already contain ESP8266 driver
270  #define RADIOLIB_EXCLUDE_ESP8266
271 
272  #elif defined(__STM32F4__) || defined(__STM32F1__)
273  // Arduino STM32 core by Roger Clark (https://github.com/rogerclarkmelbourne/Arduino_STM32)
274  #define RADIOLIB_PLATFORM "STM32duino (unofficial)"
275  #define RADIOLIB_PIN_TYPE uint8_t
276  #define RADIOLIB_PIN_MODE WiringPinMode
277  #define RADIOLIB_PIN_STATUS uint8_t
278  #define RADIOLIB_INTERRUPT_STATUS ExtIntTriggerMode
279  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
280  #define RADIOLIB_NC (0xFF)
281  #define RADIOLIB_DEFAULT_SPI SPI
282  #define RADIOLIB_PROGMEM PROGMEM
283  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
284  #define RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
285  #define RADIOLIB_HARDWARE_SERIAL_PORT Serial1
286 
287  #else
288  // other platforms not covered by the above list - this may or may not work
289  #define RADIOLIB_PLATFORM "Unknown"
290  #define RADIOLIB_UNKNOWN_PLATFORM
291  #define RADIOLIB_PIN_TYPE uint8_t
292  #define RADIOLIB_PIN_MODE uint8_t
293  #define RADIOLIB_PIN_STATUS uint8_t
294  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
295  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
296  #define RADIOLIB_NC (0xFF)
297  #define RADIOLIB_DEFAULT_SPI SPI
298  #define RADIOLIB_PROGMEM PROGMEM
299  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
300 
301  #endif
302 #endif
303 
304 /*
305  * Uncomment to enable debug output.
306  * Warning: Debug output will slow down the whole system significantly.
307  * Also, it will result in larger compiled binary.
308  * Levels: debug - only main info
309  * verbose - full transcript of all SPI/UART communication
310  */
311 
312 //#define RADIOLIB_DEBUG
313 //#define RADIOLIB_VERBOSE
314 
315 // set which Serial port should be used for debug output
316 #define RADIOLIB_DEBUG_PORT Serial
317 
318 #if defined(RADIOLIB_DEBUG)
319  #define RADIOLIB_DEBUG_PRINT(...) { RADIOLIB_DEBUG_PORT.print(__VA_ARGS__); }
320  #define RADIOLIB_DEBUG_PRINTLN(...) { RADIOLIB_DEBUG_PORT.println(__VA_ARGS__); }
321 #else
322  #define RADIOLIB_DEBUG_PRINT(...) {}
323  #define RADIOLIB_DEBUG_PRINTLN(...) {}
324 #endif
325 
326 #if defined(RADIOLIB_VERBOSE)
327  #define RADIOLIB_VERBOSE_PRINT(...) { RADIOLIB_DEBUG_PORT.print(__VA_ARGS__); }
328  #define RADIOLIB_VERBOSE_PRINTLN(...) { RADIOLIB_DEBUG_PORT.println(__VA_ARGS__); }
329 #else
330  #define RADIOLIB_VERBOSE_PRINT(...) {}
331  #define RADIOLIB_VERBOSE_PRINTLN(...) {}
332 #endif
333 
334 /*
335  * Uncomment to enable god mode - all methods and member variables in all classes will be made public, thus making them accessible from Arduino code.
336  * Warning: Come on, it's called GOD mode - obviously only use this if you know what you're doing.
337  * Failure to heed the above warning may result in bricked module.
338  */
339 //#define RADIOLIB_GODMODE
340 
341 /*
342  * Uncomment to enable pre-defined modules when using RadioShield.
343  */
344 //#define RADIOLIB_RADIOSHIELD
345 
346 /*
347  * Uncomment to enable static-only memory management: no dynamic allocation will be performed.
348  * Warning: Large static arrays will be created in some methods. It is not advised to send large packets in this mode.
349  */
350 
351 //#define RADIOLIB_STATIC_ONLY
352 
353 // set the size of static arrays to use
354 #if !defined(RADIOLIB_STATIC_ARRAY_SIZE)
355 #define RADIOLIB_STATIC_ARRAY_SIZE 256
356 #endif
357 
361 #define RADIOLIB_ASSERT(STATEVAR) { if((STATEVAR) != ERR_NONE) { return(STATEVAR); } }
362 
366 #define RADIOLIB_CHECK_RANGE(VAR, MIN, MAX, ERR) { if(!(((VAR) >= (MIN)) && ((VAR) <= (MAX)))) { return(ERR); } }
367 
368 
369 // version definitions
370 #define RADIOLIB_VERSION_MAJOR (0x04)
371 #define RADIOLIB_VERSION_MINOR (0x00)
372 #define RADIOLIB_VERSION_PATCH (0x04)
373 #define RADIOLIB_VERSION_EXTRA (0x00)
374 
375 #define RADIOLIB_VERSION ((RADIOLIB_VERSION_MAJOR << 24) | (RADIOLIB_VERSION_MINOR << 16) | (RADIOLIB_VERSION_PATCH << 8) | (RADIOLIB_VERSION_EXTRA))
376 
377 #endif
+
1 #ifndef _RADIOLIB_BUILD_OPTIONS_H
2 #define _RADIOLIB_BUILD_OPTIONS_H
3 
4 #if ARDUINO >= 100
5  #include "Arduino.h"
6 #else
7  #error "Unsupported Arduino version (< 1.0.0)"
8 #endif
9 
10 /*
11  * Platform-specific configuration.
12  *
13  * RADIOLIB_PLATFORM - platform name, used in debugging to quickly check the correct platform is detected.
14  * RADIOLIB_PIN_TYPE - which type should be used for pin numbers in functions like digitalRead().
15  * RADIOLIB_PIN_MODE - which type should be used for pin modes in functions like pinMode().
16  * RADIOLIB_PIN_STATUS - which type should be used for pin values in functions like digitalWrite().
17  * RADIOLIB_INTERRUPT_STATUS - which type should be used for pin changes in functions like attachInterrupt().
18  * RADIOLIB_DIGITAL_PIN_TO_INTERRUPT - function/macro to be used to convert digital pin number to interrupt pin number.
19  * RADIOLIB_NC - alias for unused pin, usually the largest possible value of RADIOLIB_PIN_TYPE.
20  * RADIOLIB_DEFAULT_SPI - default SPIClass instance to use.
21  * RADIOLIB_PROGMEM - macro to place variable into program storage (usually Flash).
22  * RADIOLIB_PROGMEM_READ_BYTE - function/macro to read variables saved in program storage (usually Flash).
23  * RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED - defined if the specific platform does not support SoftwareSerial.
24  * RADIOLIB_HARDWARE_SERIAL_PORT - which hardware serial port should be used on platform that do not have SoftwareSerial support.
25  * RADIOLIB_TONE_UNSUPPORTED - some platforms do not have tone()/noTone(), which is required for AFSK.
26  *
27  * In addition, some platforms may require RadioLib to disable specific drivers (such as ESP8266).
28  *
29  * Users may also specify their own configuration by uncommenting the RADIOLIB_CUSTOM_PLATFORM,
30  * and then specifying all platform parameters in the section below. This will override automatic
31  * platform detection.
32  */
33 
34 // uncomment to enable custom platform definition
35 //#define RADIOLIB_CUSTOM_PLATFORM
36 
37 #if defined(RADIOLIB_CUSTOM_PLATFORM)
38  // name for your platform
39  #define RADIOLIB_PLATFORM "Custom"
40 
41  // the following parameters must always be defined
42  #define RADIOLIB_PIN_TYPE uint8_t
43  #define RADIOLIB_PIN_MODE uint8_t
44  #define RADIOLIB_PIN_STATUS uint8_t
45  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
46  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
47  #define RADIOLIB_NC (0xFF)
48  #define RADIOLIB_DEFAULT_SPI SPI
49  #define RADIOLIB_PROGMEM PROGMEM
50  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
51 
52  // the following must be defined if the Arduino core does not support SoftwareSerial library
53  //#define RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
54  //#define RADIOLIB_HARDWARE_SERIAL_PORT Serial1
55 
56  // the following must be defined if the Arduino core does not support tone function
57  //#define RADIOLIB_TONE_UNSUPPORTED
58 
59  // some of RadioLib drivers may be excluded, to prevent collisions with platforms (or to speed up build process)
60  // the following is a complete list of all possible exclusion macros, uncomment any of them to disable that driver
61  // NOTE: Some of the exclusion macros are dependent on each other. For example, it is not possible to exclude RF69
62  // while keeping SX1231 (because RF69 is the base class for SX1231). The dependency is always uni-directional,
63  // so excluding SX1231 and keeping RF69 is valid.
64  //#define RADIOLIB_EXCLUDE_CC1101
65  //#define RADIOLIB_EXCLUDE_ESP8266
66  //#define RADIOLIB_EXCLUDE_HC05
67  //#define RADIOLIB_EXCLUDE_JDY08
68  //#define RADIOLIB_EXCLUDE_NRF24
69  //#define RADIOLIB_EXCLUDE_RF69
70  //#define RADIOLIB_EXCLUDE_SX1231 // dependent on RADIOLIB_EXCLUDE_RF69
71  //#define RADIOLIB_EXCLUDE_SI443X
72  //#define RADIOLIB_EXCLUDE_RFM2X // dependent on RADIOLIB_EXCLUDE_SI443X
73  //#define RADIOLIB_EXCLUDE_SX127X
74  //#define RADIOLIB_EXCLUDE_RFM9X // dependent on RADIOLIB_EXCLUDE_SX127X
75  //#define RADIOLIB_EXCLUDE_SX126X
76  //#define RADIOLIB_EXCLUDE_SX128X
77  //#define RADIOLIB_EXCLUDE_XBEE
78  //#define RADIOLIB_EXCLUDE_AFSK
79  //#define RADIOLIB_EXCLUDE_AX25
80  //#define RADIOLIB_EXCLUDE_HELLSCHREIBER
81  //#define RADIOLIB_EXCLUDE_HTTP
82  //#define RADIOLIB_EXCLUDE_MORSE
83  //#define RADIOLIB_EXCLUDE_MQTT
84  //#define RADIOLIB_EXCLUDE_RTTY
85  //#define RADIOLIB_EXCLUDE_SSTV
86 
87 #else
88  #if defined(__AVR__) && !(defined(ARDUINO_AVR_UNO_WIFI_REV2) || defined(ARDUINO_AVR_NANO_EVERY))
89  // Arduino AVR boards (except for megaAVR) - Uno, Mega etc.
90  #define RADIOLIB_PLATFORM "Arduino AVR"
91  #define RADIOLIB_PIN_TYPE uint8_t
92  #define RADIOLIB_PIN_MODE uint8_t
93  #define RADIOLIB_PIN_STATUS uint8_t
94  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
95  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
96  #define RADIOLIB_NC (0xFF)
97  #define RADIOLIB_DEFAULT_SPI SPI
98  #define RADIOLIB_PROGMEM PROGMEM
99  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
100 
101  #elif defined(ESP8266)
102  // ESP8266 boards
103  #define RADIOLIB_PLATFORM "ESP8266"
104  #define RADIOLIB_PIN_TYPE uint8_t
105  #define RADIOLIB_PIN_MODE uint8_t
106  #define RADIOLIB_PIN_STATUS uint8_t
107  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
108  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
109  #define RADIOLIB_NC (0xFF)
110  #define RADIOLIB_DEFAULT_SPI SPI
111  #define RADIOLIB_PROGMEM PROGMEM
112  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
113 
114  // RadioLib has ESP8266 driver, this must be disabled to use ESP8266 as platform
115  #define RADIOLIB_EXCLUDE_ESP8266
116 
117  #elif defined(ESP32)
118  // ESP32 boards
119  #define RADIOLIB_PLATFORM "ESP32"
120  #define RADIOLIB_PIN_TYPE uint8_t
121  #define RADIOLIB_PIN_MODE uint8_t
122  #define RADIOLIB_PIN_STATUS uint8_t
123  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
124  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
125  #define RADIOLIB_NC (0xFF)
126  #define RADIOLIB_DEFAULT_SPI SPI
127  #define RADIOLIB_PROGMEM PROGMEM
128  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
129  #define RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
130  #define RADIOLIB_HARDWARE_SERIAL_PORT Serial1
131 
132  // ESP32 doesn't support tone(), but it can be emulated via LED control peripheral
133  #define RADIOLIB_TONE_UNSUPPORTED
134  #define RADIOLIB_TONE_ESP32_CHANNEL (1)
135 
136  #elif defined(ARDUINO_ARCH_STM32)
137  // official STM32 Arduino core (https://github.com/stm32duino/Arduino_Core_STM32)
138  #define RADIOLIB_PLATFORM "Arduino STM32 (official)"
139  #define RADIOLIB_PIN_TYPE uint32_t
140  #define RADIOLIB_PIN_MODE uint32_t
141  #define RADIOLIB_PIN_STATUS uint32_t
142  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
143  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(digitalPinToPinName(p))
144  #define RADIOLIB_NC (0xFFFFFFFF)
145  #define RADIOLIB_DEFAULT_SPI SPI
146  #define RADIOLIB_PROGMEM PROGMEM
147  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
148  #define RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
149  #define RADIOLIB_HARDWARE_SERIAL_PORT Serial1
150 
151  #elif defined(SAMD_SERIES)
152  // Arduino SAMD (Zero, MKR, etc.) and Adafruit SAMD boards (M0 and M4)
153  #define RADIOLIB_PLATFORM "Arduino/Adafruit SAMD"
154  #define RADIOLIB_PIN_TYPE uint32_t
155  #define RADIOLIB_PIN_MODE uint32_t
156  #define RADIOLIB_PIN_STATUS uint32_t
157  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
158  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
159  #define RADIOLIB_NC (0xFFFFFFFF)
160  #define RADIOLIB_DEFAULT_SPI SPI
161  #define RADIOLIB_PROGMEM PROGMEM
162  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
163  #define RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
164  #define RADIOLIB_HARDWARE_SERIAL_PORT Serial1
165 
166  #elif defined(__SAM3X8E__)
167  // Arduino Due
168  #define RADIOLIB_PLATFORM "Arduino Due"
169  #define RADIOLIB_PIN_TYPE uint32_t
170  #define RADIOLIB_PIN_MODE uint32_t
171  #define RADIOLIB_PIN_STATUS uint32_t
172  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
173  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
174  #define RADIOLIB_NC (0xFFFFFFFF)
175  #define RADIOLIB_DEFAULT_SPI SPI
176  #define RADIOLIB_PROGMEM PROGMEM
177  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
178  #define RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
179  #define RADIOLIB_HARDWARE_SERIAL_PORT Serial1
180  #define RADIOLIB_TONE_UNSUPPORTED
181 
182  #elif (defined(NRF52832_XXAA) || defined(NRF52840_XXAA)) && !defined(ARDUINO_ARDUINO_NANO33BLE)
183  // Adafruit nRF52 boards
184  #define RADIOLIB_PLATFORM "Adafruit nRF52"
185  #define RADIOLIB_PIN_TYPE uint32_t
186  #define RADIOLIB_PIN_MODE uint32_t
187  #define RADIOLIB_PIN_STATUS uint32_t
188  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
189  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
190  #define RADIOLIB_NC (0xFFFFFFFF)
191  #define RADIOLIB_DEFAULT_SPI SPI
192  #define RADIOLIB_PROGMEM PROGMEM
193  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
194 
195  #elif defined(ARDUINO_ARC32_TOOLS)
196  // Intel Curie
197  #define RADIOLIB_PLATFORM "Intel Curie"
198  #define RADIOLIB_PIN_TYPE uint8_t
199  #define RADIOLIB_PIN_MODE uint8_t
200  #define RADIOLIB_PIN_STATUS uint8_t
201  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
202  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
203  #define RADIOLIB_NC (0xFF)
204  #define RADIOLIB_DEFAULT_SPI SPI
205  #define RADIOLIB_PROGMEM PROGMEM
206  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
207 
208  #elif defined(ARDUINO_AVR_UNO_WIFI_REV2) || defined(ARDUINO_AVR_NANO_EVERY)
209  // Arduino megaAVR boards - Uno Wifi Rev.2, Nano Every
210  #define RADIOLIB_PLATFORM "Arduino megaAVR"
211  #define RADIOLIB_PIN_TYPE uint8_t
212  #define RADIOLIB_PIN_MODE PinMode
213  #define RADIOLIB_PIN_STATUS PinStatus
214  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
215  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
216  #define RADIOLIB_NC (0xFF)
217  #define RADIOLIB_DEFAULT_SPI SPI
218  #define RADIOLIB_PROGMEM PROGMEM
219  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
220 
221  #elif defined(AM_PART_APOLLO3)
222  // Sparkfun Artemis boards
223  #define RADIOLIB_PLATFORM "Sparkfun Artemis"
224  #define RADIOLIB_PIN_TYPE uint8_t
225  #define RADIOLIB_PIN_MODE uint8_t
226  #define RADIOLIB_PIN_STATUS uint8_t
227  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
228  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
229  #define RADIOLIB_NC (0xFF)
230  #define RADIOLIB_DEFAULT_SPI SPI
231  #define RADIOLIB_PROGMEM PROGMEM
232  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
233  #define RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
234  #define RADIOLIB_HARDWARE_SERIAL_PORT Serial1
235 
236  #elif defined(ARDUINO_ARDUINO_NANO33BLE)
237  // Arduino Nano 33 BLE
238  #define RADIOLIB_PLATFORM "Arduino Nano 33 BLE"
239  #define RADIOLIB_PIN_TYPE pin_size_t
240  #define RADIOLIB_PIN_MODE PinMode
241  #define RADIOLIB_PIN_STATUS PinStatus
242  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
243  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
244  #define RADIOLIB_NC (0xFF)
245  #define RADIOLIB_DEFAULT_SPI SPI
246  #define RADIOLIB_PROGMEM PROGMEM
247  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
248  #define RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
249  #define RADIOLIB_HARDWARE_SERIAL_PORT Serial1
250 
251  // Nano 33 BLE uses mbed libraries, which already contain ESP8266 driver
252  #define RADIOLIB_EXCLUDE_ESP8266
253 
254  #elif defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_PORTENTA_H7_M4)
255  // Arduino Portenta H7
256  #define RADIOLIB_PLATFORM "Portenta H7"
257  #define RADIOLIB_PIN_TYPE pin_size_t
258  #define RADIOLIB_PIN_MODE PinMode
259  #define RADIOLIB_PIN_STATUS PinStatus
260  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
261  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
262  #define RADIOLIB_NC (0xFF)
263  #define RADIOLIB_DEFAULT_SPI SPI
264  #define RADIOLIB_PROGMEM PROGMEM
265  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
266  #define RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
267  #define RADIOLIB_HARDWARE_SERIAL_PORT Serial1
268 
269  // Arduino Portenta H7 uses mbed libraries, which already contain ESP8266 driver
270  #define RADIOLIB_EXCLUDE_ESP8266
271 
272  #elif defined(__STM32F4__) || defined(__STM32F1__)
273  // Arduino STM32 core by Roger Clark (https://github.com/rogerclarkmelbourne/Arduino_STM32)
274  #define RADIOLIB_PLATFORM "STM32duino (unofficial)"
275  #define RADIOLIB_PIN_TYPE uint8_t
276  #define RADIOLIB_PIN_MODE WiringPinMode
277  #define RADIOLIB_PIN_STATUS uint8_t
278  #define RADIOLIB_INTERRUPT_STATUS ExtIntTriggerMode
279  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
280  #define RADIOLIB_NC (0xFF)
281  #define RADIOLIB_DEFAULT_SPI SPI
282  #define RADIOLIB_PROGMEM PROGMEM
283  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
284  #define RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
285  #define RADIOLIB_HARDWARE_SERIAL_PORT Serial1
286 
287  #else
288  // other platforms not covered by the above list - this may or may not work
289  #define RADIOLIB_PLATFORM "Unknown"
290  #define RADIOLIB_UNKNOWN_PLATFORM
291  #define RADIOLIB_PIN_TYPE uint8_t
292  #define RADIOLIB_PIN_MODE uint8_t
293  #define RADIOLIB_PIN_STATUS uint8_t
294  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
295  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
296  #define RADIOLIB_NC (0xFF)
297  #define RADIOLIB_DEFAULT_SPI SPI
298  #define RADIOLIB_PROGMEM PROGMEM
299  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
300 
301  #endif
302 #endif
303 
304 /*
305  * Uncomment to enable debug output.
306  * Warning: Debug output will slow down the whole system significantly.
307  * Also, it will result in larger compiled binary.
308  * Levels: debug - only main info
309  * verbose - full transcript of all SPI/UART communication
310  */
311 
312 //#define RADIOLIB_DEBUG
313 //#define RADIOLIB_VERBOSE
314 
315 // set which Serial port should be used for debug output
316 #define RADIOLIB_DEBUG_PORT Serial
317 
318 #if defined(RADIOLIB_DEBUG)
319  #define RADIOLIB_DEBUG_PRINT(...) { RADIOLIB_DEBUG_PORT.print(__VA_ARGS__); }
320  #define RADIOLIB_DEBUG_PRINTLN(...) { RADIOLIB_DEBUG_PORT.println(__VA_ARGS__); }
321 #else
322  #define RADIOLIB_DEBUG_PRINT(...) {}
323  #define RADIOLIB_DEBUG_PRINTLN(...) {}
324 #endif
325 
326 #if defined(RADIOLIB_VERBOSE)
327  #define RADIOLIB_VERBOSE_PRINT(...) { RADIOLIB_DEBUG_PORT.print(__VA_ARGS__); }
328  #define RADIOLIB_VERBOSE_PRINTLN(...) { RADIOLIB_DEBUG_PORT.println(__VA_ARGS__); }
329 #else
330  #define RADIOLIB_VERBOSE_PRINT(...) {}
331  #define RADIOLIB_VERBOSE_PRINTLN(...) {}
332 #endif
333 
334 /*
335  * Uncomment to enable god mode - all methods and member variables in all classes will be made public, thus making them accessible from Arduino code.
336  * Warning: Come on, it's called GOD mode - obviously only use this if you know what you're doing.
337  * Failure to heed the above warning may result in bricked module.
338  */
339 //#define RADIOLIB_GODMODE
340 
341 /*
342  * Uncomment to enable pre-defined modules when using RadioShield.
343  */
344 //#define RADIOLIB_RADIOSHIELD
345 
346 /*
347  * Uncomment to enable static-only memory management: no dynamic allocation will be performed.
348  * Warning: Large static arrays will be created in some methods. It is not advised to send large packets in this mode.
349  */
350 
351 //#define RADIOLIB_STATIC_ONLY
352 
353 // set the size of static arrays to use
354 #if !defined(RADIOLIB_STATIC_ARRAY_SIZE)
355 #define RADIOLIB_STATIC_ARRAY_SIZE 256
356 #endif
357 
361 #define RADIOLIB_ASSERT(STATEVAR) { if((STATEVAR) != ERR_NONE) { return(STATEVAR); } }
362 
366 #define RADIOLIB_CHECK_RANGE(VAR, MIN, MAX, ERR) { if(!(((VAR) >= (MIN)) && ((VAR) <= (MAX)))) { return(ERR); } }
367 
368 
369 // version definitions
370 #define RADIOLIB_VERSION_MAJOR (0x04)
371 #define RADIOLIB_VERSION_MINOR (0x00)
372 #define RADIOLIB_VERSION_PATCH (0x05)
373 #define RADIOLIB_VERSION_EXTRA (0x00)
374 
375 #define RADIOLIB_VERSION ((RADIOLIB_VERSION_MAJOR << 24) | (RADIOLIB_VERSION_MINOR << 16) | (RADIOLIB_VERSION_PATCH << 8) | (RADIOLIB_VERSION_EXTRA))
376 
377 #endif