RadioLib
Universal wireless communication library for Arduino
RadioLib.h
1 #if !defined(_RADIOLIB_H)
2 #define _RADIOLIB_H
3 
38 #include "TypeDef.h"
39 #include "Module.h"
40 
41 // warnings are printed in this file since BuildOpt.h is compiled in multiple places
42 
43 // check God mode
44 #if defined(RADIOLIB_GODMODE)
45  #warning "God mode active, I hope it was intentional. Buckle up, lads."
46 #endif
47 
48 // print debug info
49 #if defined(RADIOLIB_DEBUG)
50  #define RADIOLIB_VALUE_TO_STRING(x) #x
51  #define RADIOLIB_VALUE(x) RADIOLIB_VALUE_TO_STRING(x)
52  #define RADIOLIB_VAR_NAME_VALUE(var) #var "=" RADIOLIB_VALUE(var)
53  #pragma message(RADIOLIB_VAR_NAME_VALUE(RADIOLIB_PLATFORM))
54  #pragma message(RADIOLIB_VAR_NAME_VALUE(RADIOLIB_VERSION_MAJOR))
55  #pragma message(RADIOLIB_VAR_NAME_VALUE(RADIOLIB_VERSION_MINOR))
56  #pragma message(RADIOLIB_VAR_NAME_VALUE(RADIOLIB_VERSION_PATCH))
57  #pragma message(RADIOLIB_VAR_NAME_VALUE(RADIOLIB_VERSION_EXTRA))
58 #endif
59 
60 // check unknown/unsupported platform
61 #if defined(RADIOLIB_UNKNOWN_PLATFORM)
62  #warning "RadioLib might not be compatible with this Arduino board - check supported platforms at https://github.com/jgromes/RadioLib!"
63 #endif
64 
65 #include "modules/CC1101/CC1101.h"
66 #include "modules/LLCC68/LLCC68.h"
67 #include "modules/nRF24/nRF24.h"
68 #include "modules/RF69/RF69.h"
69 #include "modules/RFM2x/RFM22.h"
70 #include "modules/RFM2x/RFM23.h"
71 #include "modules/RFM9x/RFM95.h"
72 #include "modules/RFM9x/RFM96.h"
73 #include "modules/RFM9x/RFM97.h"
74 #include "modules/Si443x/Si4430.h"
75 #include "modules/Si443x/Si4431.h"
76 #include "modules/Si443x/Si4432.h"
77 #include "modules/SX1231/SX1231.h"
78 #include "modules/SX126x/SX1261.h"
79 #include "modules/SX126x/SX1262.h"
80 #include "modules/SX126x/SX1268.h"
81 #include "modules/SX126x/STM32WLx.h"
82 #include "modules/SX127x/SX1272.h"
83 #include "modules/SX127x/SX1273.h"
84 #include "modules/SX127x/SX1276.h"
85 #include "modules/SX127x/SX1277.h"
86 #include "modules/SX127x/SX1278.h"
87 #include "modules/SX127x/SX1279.h"
88 #include "modules/SX128x/SX1280.h"
89 #include "modules/SX128x/SX1281.h"
90 #include "modules/SX128x/SX1282.h"
91 
92 // physical layer protocols
93 #include "protocols/PhysicalLayer/PhysicalLayer.h"
94 #include "protocols/AFSK/AFSK.h"
95 #include "protocols/AX25/AX25.h"
96 #include "protocols/Hellschreiber/Hellschreiber.h"
97 #include "protocols/Morse/Morse.h"
98 #include "protocols/Pager/Pager.h"
99 #include "protocols/RTTY/RTTY.h"
100 #include "protocols/SSTV/SSTV.h"
101 #include "protocols/SSDV/SSDV.h"
102 #include "protocols/FSK4/FSK4.h"
103 #include "protocols/APRS/APRS.h"
104 #include "protocols/ExternalRadio/ExternalRadio.h"
105 
106 // only create Radio class when using RadioShield
107 #if defined(RADIOLIB_RADIOSHIELD)
108 
109 // RadioShield pin definitions
110 #define RADIOSHIELD_CS_A 10
111 #define RADIOSHIELD_IRQ_A 2
112 #define RADIOSHIELD_RST_A 9
113 #define RADIOSHIELD_GPIO_A 8
114 #define RADIOSHIELD_CS_B 5
115 #define RADIOSHIELD_IRQ_B 3
116 #define RADIOSHIELD_RST_B 7
117 #define RADIOSHIELD_GPIO_B 6
118 
125 class Radio {
126  public:
127 
128  Module* ModuleA;
129  Module* ModuleB;
130 
134  Radio() {
135  ModuleA = new Module(RADIOSHIELD_CS_A, RADIOSHIELD_IRQ_A, RADIOSHIELD_RST_A, RADIOSHIELD_GPIO_A);
136  ModuleB = new Module(RADIOSHIELD_CS_B, RADIOSHIELD_IRQ_B, RADIOSHIELD_RST_B, RADIOSHIELD_GPIO_B);
137  }
138 
139 #if defined(RADIOLIB_GODMODE)
140  private:
141 #endif
142 
143 };
144 
145 Radio RadioShield;
146 #endif
147 
148 #endif
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24