diff --git a/_build_opt_8h_source.html b/_build_opt_8h_source.html index 8a38e247..3b11c21f 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  #define RADIOLIB_TONE_UNSUPPORTED
132 
133  #elif defined(ARDUINO_ARCH_STM32)
134  // official STM32 Arduino core (https://github.com/stm32duino/Arduino_Core_STM32)
135  #define RADIOLIB_PLATFORM "Arduino STM32 (official)"
136  #define RADIOLIB_PIN_TYPE uint32_t
137  #define RADIOLIB_PIN_MODE uint32_t
138  #define RADIOLIB_PIN_STATUS uint32_t
139  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
140  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(digitalPinToPinName(p))
141  #define RADIOLIB_NC (0xFFFFFFFF)
142  #define RADIOLIB_DEFAULT_SPI SPI
143  #define RADIOLIB_PROGMEM PROGMEM
144  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
145  #define RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
146  #define RADIOLIB_HARDWARE_SERIAL_PORT Serial1
147 
148  #elif defined(SAMD_SERIES)
149  // Arduino SAMD (Zero, MKR, etc.) and Adafruit SAMD boards (M0 and M4)
150  #define RADIOLIB_PLATFORM "Arduino/Adafruit SAMD"
151  #define RADIOLIB_PIN_TYPE uint32_t
152  #define RADIOLIB_PIN_MODE uint32_t
153  #define RADIOLIB_PIN_STATUS uint32_t
154  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
155  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
156  #define RADIOLIB_NC (0xFFFFFFFF)
157  #define RADIOLIB_DEFAULT_SPI SPI
158  #define RADIOLIB_PROGMEM PROGMEM
159  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
160  #define RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
161  #define RADIOLIB_HARDWARE_SERIAL_PORT Serial1
162 
163  #elif defined(__SAM3X8E__)
164  // Arduino Due
165  #define RADIOLIB_PLATFORM "Arduino Due"
166  #define RADIOLIB_PIN_TYPE uint32_t
167  #define RADIOLIB_PIN_MODE uint32_t
168  #define RADIOLIB_PIN_STATUS uint32_t
169  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
170  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
171  #define RADIOLIB_NC (0xFFFFFFFF)
172  #define RADIOLIB_DEFAULT_SPI SPI
173  #define RADIOLIB_PROGMEM PROGMEM
174  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
175  #define RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
176  #define RADIOLIB_HARDWARE_SERIAL_PORT Serial1
177  #define RADIOLIB_TONE_UNSUPPORTED
178 
179  #elif (defined(NRF52832_XXAA) || defined(NRF52840_XXAA)) && !defined(ARDUINO_ARDUINO_NANO33BLE)
180  // Adafruit nRF52 boards
181  #define RADIOLIB_PLATFORM "Adafruit nRF52"
182  #define RADIOLIB_PIN_TYPE uint32_t
183  #define RADIOLIB_PIN_MODE uint32_t
184  #define RADIOLIB_PIN_STATUS uint32_t
185  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
186  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
187  #define RADIOLIB_NC (0xFFFFFFFF)
188  #define RADIOLIB_DEFAULT_SPI SPI
189  #define RADIOLIB_PROGMEM PROGMEM
190  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
191 
192  #elif defined(ARDUINO_ARC32_TOOLS)
193  // Intel Curie
194  #define RADIOLIB_PLATFORM "Intel Curie"
195  #define RADIOLIB_PIN_TYPE uint8_t
196  #define RADIOLIB_PIN_MODE uint8_t
197  #define RADIOLIB_PIN_STATUS uint8_t
198  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
199  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
200  #define RADIOLIB_NC (0xFF)
201  #define RADIOLIB_DEFAULT_SPI SPI
202  #define RADIOLIB_PROGMEM PROGMEM
203  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
204 
205  #elif defined(ARDUINO_AVR_UNO_WIFI_REV2) || defined(ARDUINO_AVR_NANO_EVERY)
206  // Arduino megaAVR boards - Uno Wifi Rev.2, Nano Every
207  #define RADIOLIB_PLATFORM "Arduino megaAVR"
208  #define RADIOLIB_PIN_TYPE uint8_t
209  #define RADIOLIB_PIN_MODE PinMode
210  #define RADIOLIB_PIN_STATUS PinStatus
211  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
212  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
213  #define RADIOLIB_NC (0xFF)
214  #define RADIOLIB_DEFAULT_SPI SPI
215  #define RADIOLIB_PROGMEM PROGMEM
216  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
217 
218  #elif defined(AM_PART_APOLLO3)
219  // Sparkfun Artemis boards
220  #define RADIOLIB_PLATFORM "Sparkfun Artemis"
221  #define RADIOLIB_PIN_TYPE uint8_t
222  #define RADIOLIB_PIN_MODE uint8_t
223  #define RADIOLIB_PIN_STATUS uint8_t
224  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
225  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
226  #define RADIOLIB_NC (0xFF)
227  #define RADIOLIB_DEFAULT_SPI SPI
228  #define RADIOLIB_PROGMEM PROGMEM
229  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
230  #define RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
231  #define RADIOLIB_HARDWARE_SERIAL_PORT Serial1
232  #define RADIOLIB_TONE_UNSUPPORTED
233 
234  #elif defined(ARDUINO_ARDUINO_NANO33BLE)
235  // Arduino Nano 33 BLE
236  #define RADIOLIB_PLATFORM "Arduino Nano 33 BLE"
237  #define RADIOLIB_PIN_TYPE pin_size_t
238  #define RADIOLIB_PIN_MODE PinMode
239  #define RADIOLIB_PIN_STATUS PinStatus
240  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
241  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
242  #define RADIOLIB_NC (0xFF)
243  #define RADIOLIB_DEFAULT_SPI SPI
244  #define RADIOLIB_PROGMEM PROGMEM
245  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
246  #define RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
247  #define RADIOLIB_HARDWARE_SERIAL_PORT Serial1
248 
249  // Nano 33 BLE uses mbed libraries, which already contain ESP8266 driver
250  #define RADIOLIB_EXCLUDE_ESP8266
251 
252  #elif defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_PORTENTA_H7_M4)
253  // Arduino Portenta H7
254  #define RADIOLIB_PLATFORM "Portenta H7"
255  #define RADIOLIB_PIN_TYPE pin_size_t
256  #define RADIOLIB_PIN_MODE PinMode
257  #define RADIOLIB_PIN_STATUS PinStatus
258  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
259  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
260  #define RADIOLIB_NC (0xFF)
261  #define RADIOLIB_DEFAULT_SPI SPI
262  #define RADIOLIB_PROGMEM PROGMEM
263  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
264  #define RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
265  #define RADIOLIB_HARDWARE_SERIAL_PORT Serial1
266 
267  // Arduino Portenta H7 uses mbed libraries, which already contain ESP8266 driver
268  #define RADIOLIB_EXCLUDE_ESP8266
269 
270  #elif defined(__STM32F4__) || defined(__STM32F1__)
271  // Arduino STM32 core by Roger Clark (https://github.com/rogerclarkmelbourne/Arduino_STM32)
272  #define RADIOLIB_PLATFORM "STM32duino (unofficial)"
273  #define RADIOLIB_PIN_TYPE uint8_t
274  #define RADIOLIB_PIN_MODE WiringPinMode
275  #define RADIOLIB_PIN_STATUS uint8_t
276  #define RADIOLIB_INTERRUPT_STATUS ExtIntTriggerMode
277  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
278  #define RADIOLIB_NC (0xFF)
279  #define RADIOLIB_DEFAULT_SPI SPI
280  #define RADIOLIB_PROGMEM PROGMEM
281  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
282  #define RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
283  #define RADIOLIB_HARDWARE_SERIAL_PORT Serial1
284  #define RADIOLIB_TONE_UNSUPPORTED
285 
286  #else
287  // other platforms not covered by the above list - this may or may not work
288  #define RADIOLIB_PLATFORM "Unknown"
289  #define RADIOLIB_UNKNOWN_PLATFORM
290  #define RADIOLIB_PIN_TYPE uint8_t
291  #define RADIOLIB_PIN_MODE uint8_t
292  #define RADIOLIB_PIN_STATUS uint8_t
293  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
294  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
295  #define RADIOLIB_NC (0xFF)
296  #define RADIOLIB_DEFAULT_SPI SPI
297  #define RADIOLIB_PROGMEM PROGMEM
298  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
299 
300  #endif
301 #endif
302 
303 /*
304  * Uncomment to enable debug output.
305  * Warning: Debug output will slow down the whole system significantly.
306  * Also, it will result in larger compiled binary.
307  * Levels: debug - only main info
308  * verbose - full transcript of all SPI/UART communication
309  */
310 
311 //#define RADIOLIB_DEBUG
312 //#define RADIOLIB_VERBOSE
313 
314 // set which Serial port should be used for debug output
315 #define RADIOLIB_DEBUG_PORT Serial
316 
317 #if defined(RADIOLIB_DEBUG)
318  #define RADIOLIB_DEBUG_PRINT(...) { RADIOLIB_DEBUG_PORT.print(__VA_ARGS__); }
319  #define RADIOLIB_DEBUG_PRINTLN(...) { RADIOLIB_DEBUG_PORT.println(__VA_ARGS__); }
320 #else
321  #define RADIOLIB_DEBUG_PRINT(...) {}
322  #define RADIOLIB_DEBUG_PRINTLN(...) {}
323 #endif
324 
325 #if defined(RADIOLIB_VERBOSE)
326  #define RADIOLIB_VERBOSE_PRINT(...) { RADIOLIB_DEBUG_PORT.print(__VA_ARGS__); }
327  #define RADIOLIB_VERBOSE_PRINTLN(...) { RADIOLIB_DEBUG_PORT.println(__VA_ARGS__); }
328 #else
329  #define RADIOLIB_VERBOSE_PRINT(...) {}
330  #define RADIOLIB_VERBOSE_PRINTLN(...) {}
331 #endif
332 
333 /*
334  * Uncomment to enable god mode - all methods and member variables in all classes will be made public, thus making them accessible from Arduino code.
335  * Warning: Come on, it's called GOD mode - obviously only use this if you know what you're doing.
336  * Failure to heed the above warning may result in bricked module.
337  */
338 //#define RADIOLIB_GODMODE
339 
340 /*
341  * Uncomment to enable pre-defined modules when using RadioShield.
342  */
343 //#define RADIOLIB_RADIOSHIELD
344 
345 /*
346  * Uncomment to enable static-only memory management: no dynamic allocation will be performed.
347  * Warning: Large static arrays will be created in some methods. It is not advised to send large packets in this mode.
348  */
349 
350 //#define RADIOLIB_STATIC_ONLY
351 
352 // set the size of static arrays to use
353 #if !defined(RADIOLIB_STATIC_ARRAY_SIZE)
354 #define RADIOLIB_STATIC_ARRAY_SIZE 256
355 #endif
356 
360 #define RADIOLIB_ASSERT(STATEVAR) { if((STATEVAR) != ERR_NONE) { return(STATEVAR); } }
361 
365 #define RADIOLIB_CHECK_RANGE(VAR, MIN, MAX, ERR) { if(!(((VAR) >= (MIN)) && ((VAR) <= (MAX)))) { return(ERR); } }
366 
367 
368 // version definitions
369 #define RADIOLIB_VERSION_MAJOR (0x04)
370 #define RADIOLIB_VERSION_MINOR (0x00)
371 #define RADIOLIB_VERSION_PATCH (0x04)
372 #define RADIOLIB_VERSION_EXTRA (0x00)
373 
374 #define RADIOLIB_VERSION ((RADIOLIB_VERSION_MAJOR << 24) | (RADIOLIB_VERSION_MINOR << 16) | (RADIOLIB_VERSION_PATCH << 8) | (RADIOLIB_VERSION_EXTRA))
375 
376 #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  #define RADIOLIB_TONE_UNSUPPORTED
132 
133  #elif defined(ARDUINO_ARCH_STM32)
134  // official STM32 Arduino core (https://github.com/stm32duino/Arduino_Core_STM32)
135  #define RADIOLIB_PLATFORM "Arduino STM32 (official)"
136  #define RADIOLIB_PIN_TYPE uint32_t
137  #define RADIOLIB_PIN_MODE uint32_t
138  #define RADIOLIB_PIN_STATUS uint32_t
139  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
140  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(digitalPinToPinName(p))
141  #define RADIOLIB_NC (0xFFFFFFFF)
142  #define RADIOLIB_DEFAULT_SPI SPI
143  #define RADIOLIB_PROGMEM PROGMEM
144  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
145  #define RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
146  #define RADIOLIB_HARDWARE_SERIAL_PORT Serial1
147 
148  #elif defined(SAMD_SERIES)
149  // Arduino SAMD (Zero, MKR, etc.) and Adafruit SAMD boards (M0 and M4)
150  #define RADIOLIB_PLATFORM "Arduino/Adafruit SAMD"
151  #define RADIOLIB_PIN_TYPE uint32_t
152  #define RADIOLIB_PIN_MODE uint32_t
153  #define RADIOLIB_PIN_STATUS uint32_t
154  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
155  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
156  #define RADIOLIB_NC (0xFFFFFFFF)
157  #define RADIOLIB_DEFAULT_SPI SPI
158  #define RADIOLIB_PROGMEM PROGMEM
159  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
160  #define RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
161  #define RADIOLIB_HARDWARE_SERIAL_PORT Serial1
162 
163  #elif defined(__SAM3X8E__)
164  // Arduino Due
165  #define RADIOLIB_PLATFORM "Arduino Due"
166  #define RADIOLIB_PIN_TYPE uint32_t
167  #define RADIOLIB_PIN_MODE uint32_t
168  #define RADIOLIB_PIN_STATUS uint32_t
169  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
170  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
171  #define RADIOLIB_NC (0xFFFFFFFF)
172  #define RADIOLIB_DEFAULT_SPI SPI
173  #define RADIOLIB_PROGMEM PROGMEM
174  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
175  #define RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
176  #define RADIOLIB_HARDWARE_SERIAL_PORT Serial1
177  #define RADIOLIB_TONE_UNSUPPORTED
178 
179  #elif (defined(NRF52832_XXAA) || defined(NRF52840_XXAA)) && !defined(ARDUINO_ARDUINO_NANO33BLE)
180  // Adafruit nRF52 boards
181  #define RADIOLIB_PLATFORM "Adafruit nRF52"
182  #define RADIOLIB_PIN_TYPE uint32_t
183  #define RADIOLIB_PIN_MODE uint32_t
184  #define RADIOLIB_PIN_STATUS uint32_t
185  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
186  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
187  #define RADIOLIB_NC (0xFFFFFFFF)
188  #define RADIOLIB_DEFAULT_SPI SPI
189  #define RADIOLIB_PROGMEM PROGMEM
190  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
191 
192  #elif defined(ARDUINO_ARC32_TOOLS)
193  // Intel Curie
194  #define RADIOLIB_PLATFORM "Intel Curie"
195  #define RADIOLIB_PIN_TYPE uint8_t
196  #define RADIOLIB_PIN_MODE uint8_t
197  #define RADIOLIB_PIN_STATUS uint8_t
198  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
199  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
200  #define RADIOLIB_NC (0xFF)
201  #define RADIOLIB_DEFAULT_SPI SPI
202  #define RADIOLIB_PROGMEM PROGMEM
203  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
204 
205  #elif defined(ARDUINO_AVR_UNO_WIFI_REV2) || defined(ARDUINO_AVR_NANO_EVERY)
206  // Arduino megaAVR boards - Uno Wifi Rev.2, Nano Every
207  #define RADIOLIB_PLATFORM "Arduino megaAVR"
208  #define RADIOLIB_PIN_TYPE uint8_t
209  #define RADIOLIB_PIN_MODE PinMode
210  #define RADIOLIB_PIN_STATUS PinStatus
211  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
212  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
213  #define RADIOLIB_NC (0xFF)
214  #define RADIOLIB_DEFAULT_SPI SPI
215  #define RADIOLIB_PROGMEM PROGMEM
216  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
217 
218  #elif defined(AM_PART_APOLLO3)
219  // Sparkfun Artemis boards
220  #define RADIOLIB_PLATFORM "Sparkfun Artemis"
221  #define RADIOLIB_PIN_TYPE uint8_t
222  #define RADIOLIB_PIN_MODE uint8_t
223  #define RADIOLIB_PIN_STATUS uint8_t
224  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
225  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
226  #define RADIOLIB_NC (0xFF)
227  #define RADIOLIB_DEFAULT_SPI SPI
228  #define RADIOLIB_PROGMEM PROGMEM
229  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
230  #define RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
231  #define RADIOLIB_HARDWARE_SERIAL_PORT Serial1
232 
233  #elif defined(ARDUINO_ARDUINO_NANO33BLE)
234  // Arduino Nano 33 BLE
235  #define RADIOLIB_PLATFORM "Arduino Nano 33 BLE"
236  #define RADIOLIB_PIN_TYPE pin_size_t
237  #define RADIOLIB_PIN_MODE PinMode
238  #define RADIOLIB_PIN_STATUS PinStatus
239  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
240  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
241  #define RADIOLIB_NC (0xFF)
242  #define RADIOLIB_DEFAULT_SPI SPI
243  #define RADIOLIB_PROGMEM PROGMEM
244  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
245  #define RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
246  #define RADIOLIB_HARDWARE_SERIAL_PORT Serial1
247 
248  // Nano 33 BLE uses mbed libraries, which already contain ESP8266 driver
249  #define RADIOLIB_EXCLUDE_ESP8266
250 
251  #elif defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_PORTENTA_H7_M4)
252  // Arduino Portenta H7
253  #define RADIOLIB_PLATFORM "Portenta H7"
254  #define RADIOLIB_PIN_TYPE pin_size_t
255  #define RADIOLIB_PIN_MODE PinMode
256  #define RADIOLIB_PIN_STATUS PinStatus
257  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
258  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
259  #define RADIOLIB_NC (0xFF)
260  #define RADIOLIB_DEFAULT_SPI SPI
261  #define RADIOLIB_PROGMEM PROGMEM
262  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
263  #define RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
264  #define RADIOLIB_HARDWARE_SERIAL_PORT Serial1
265 
266  // Arduino Portenta H7 uses mbed libraries, which already contain ESP8266 driver
267  #define RADIOLIB_EXCLUDE_ESP8266
268 
269  #elif defined(__STM32F4__) || defined(__STM32F1__)
270  // Arduino STM32 core by Roger Clark (https://github.com/rogerclarkmelbourne/Arduino_STM32)
271  #define RADIOLIB_PLATFORM "STM32duino (unofficial)"
272  #define RADIOLIB_PIN_TYPE uint8_t
273  #define RADIOLIB_PIN_MODE WiringPinMode
274  #define RADIOLIB_PIN_STATUS uint8_t
275  #define RADIOLIB_INTERRUPT_STATUS ExtIntTriggerMode
276  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
277  #define RADIOLIB_NC (0xFF)
278  #define RADIOLIB_DEFAULT_SPI SPI
279  #define RADIOLIB_PROGMEM PROGMEM
280  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
281  #define RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
282  #define RADIOLIB_HARDWARE_SERIAL_PORT Serial1
283 
284  #else
285  // other platforms not covered by the above list - this may or may not work
286  #define RADIOLIB_PLATFORM "Unknown"
287  #define RADIOLIB_UNKNOWN_PLATFORM
288  #define RADIOLIB_PIN_TYPE uint8_t
289  #define RADIOLIB_PIN_MODE uint8_t
290  #define RADIOLIB_PIN_STATUS uint8_t
291  #define RADIOLIB_INTERRUPT_STATUS RADIOLIB_PIN_STATUS
292  #define RADIOLIB_DIGITAL_PIN_TO_INTERRUPT(p) digitalPinToInterrupt(p)
293  #define RADIOLIB_NC (0xFF)
294  #define RADIOLIB_DEFAULT_SPI SPI
295  #define RADIOLIB_PROGMEM PROGMEM
296  #define RADIOLIB_PROGMEM_READ_BYTE(addr) pgm_read_byte(addr)
297 
298  #endif
299 #endif
300 
301 /*
302  * Uncomment to enable debug output.
303  * Warning: Debug output will slow down the whole system significantly.
304  * Also, it will result in larger compiled binary.
305  * Levels: debug - only main info
306  * verbose - full transcript of all SPI/UART communication
307  */
308 
309 //#define RADIOLIB_DEBUG
310 //#define RADIOLIB_VERBOSE
311 
312 // set which Serial port should be used for debug output
313 #define RADIOLIB_DEBUG_PORT Serial
314 
315 #if defined(RADIOLIB_DEBUG)
316  #define RADIOLIB_DEBUG_PRINT(...) { RADIOLIB_DEBUG_PORT.print(__VA_ARGS__); }
317  #define RADIOLIB_DEBUG_PRINTLN(...) { RADIOLIB_DEBUG_PORT.println(__VA_ARGS__); }
318 #else
319  #define RADIOLIB_DEBUG_PRINT(...) {}
320  #define RADIOLIB_DEBUG_PRINTLN(...) {}
321 #endif
322 
323 #if defined(RADIOLIB_VERBOSE)
324  #define RADIOLIB_VERBOSE_PRINT(...) { RADIOLIB_DEBUG_PORT.print(__VA_ARGS__); }
325  #define RADIOLIB_VERBOSE_PRINTLN(...) { RADIOLIB_DEBUG_PORT.println(__VA_ARGS__); }
326 #else
327  #define RADIOLIB_VERBOSE_PRINT(...) {}
328  #define RADIOLIB_VERBOSE_PRINTLN(...) {}
329 #endif
330 
331 /*
332  * Uncomment to enable god mode - all methods and member variables in all classes will be made public, thus making them accessible from Arduino code.
333  * Warning: Come on, it's called GOD mode - obviously only use this if you know what you're doing.
334  * Failure to heed the above warning may result in bricked module.
335  */
336 //#define RADIOLIB_GODMODE
337 
338 /*
339  * Uncomment to enable pre-defined modules when using RadioShield.
340  */
341 //#define RADIOLIB_RADIOSHIELD
342 
343 /*
344  * Uncomment to enable static-only memory management: no dynamic allocation will be performed.
345  * Warning: Large static arrays will be created in some methods. It is not advised to send large packets in this mode.
346  */
347 
348 //#define RADIOLIB_STATIC_ONLY
349 
350 // set the size of static arrays to use
351 #if !defined(RADIOLIB_STATIC_ARRAY_SIZE)
352 #define RADIOLIB_STATIC_ARRAY_SIZE 256
353 #endif
354 
358 #define RADIOLIB_ASSERT(STATEVAR) { if((STATEVAR) != ERR_NONE) { return(STATEVAR); } }
359 
363 #define RADIOLIB_CHECK_RANGE(VAR, MIN, MAX, ERR) { if(!(((VAR) >= (MIN)) && ((VAR) <= (MAX)))) { return(ERR); } }
364 
365 
366 // version definitions
367 #define RADIOLIB_VERSION_MAJOR (0x04)
368 #define RADIOLIB_VERSION_MINOR (0x00)
369 #define RADIOLIB_VERSION_PATCH (0x04)
370 #define RADIOLIB_VERSION_EXTRA (0x00)
371 
372 #define RADIOLIB_VERSION ((RADIOLIB_VERSION_MAJOR << 24) | (RADIOLIB_VERSION_MINOR << 16) | (RADIOLIB_VERSION_PATCH << 8) | (RADIOLIB_VERSION_EXTRA))
373 
374 #endif