From b6792753ff19b0ef6f3d07da52eff631a1fbaf6c Mon Sep 17 00:00:00 2001 From: jgromes Date: Mon, 24 Apr 2023 16:32:53 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=20f244c?= =?UTF-8?q?aa0bb0b43cc2685a7ddf15a313db25b9c3e=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- _build_opt_8h_source.html | 4 +- _c_c1101_8h_source.html | 6 +- _external_radio_8h_source.html | 2 +- _l_l_c_c68_8h_source.html | 2 +- _module_8h_source.html | 351 +++++++++++++------------- _physical_layer_8h_source.html | 2 +- _r_f69_8h_source.html | 6 +- _r_f_m95_8h_source.html | 2 +- _r_f_m96_8h_source.html | 2 +- _r_f_m97_8h_source.html | 2 +- _radio_lib_8h_source.html | 2 +- _s_t_m32_w_lx_8h_source.html | 8 +- _s_t_m32_w_lx___module_8h_source.html | 2 +- _s_x1231_8h_source.html | 2 +- _s_x1261_8h_source.html | 2 +- _s_x1262_8h_source.html | 2 +- _s_x1268_8h_source.html | 2 +- _s_x126x_8h_source.html | 8 +- _s_x1272_8h_source.html | 2 +- _s_x1273_8h_source.html | 2 +- _s_x1276_8h_source.html | 2 +- _s_x1277_8h_source.html | 2 +- _s_x1278_8h_source.html | 2 +- _s_x1279_8h_source.html | 2 +- _s_x127x_8h_source.html | 6 +- _s_x1280_8h_source.html | 2 +- _s_x1281_8h_source.html | 2 +- _s_x1282_8h_source.html | 2 +- _s_x128x_8h_source.html | 6 +- _si4430_8h_source.html | 2 +- _si4431_8h_source.html | 2 +- _si4432_8h_source.html | 2 +- _si443x_8h_source.html | 6 +- class_c_c1101.html | 8 +- class_module.html | 8 +- class_r_f69.html | 8 +- class_s_x126x.html | 8 +- class_s_x127x.html | 8 +- class_s_x128x.html | 8 +- class_si443x.html | 8 +- n_r_f24_8h_source.html | 2 +- 41 files changed, 255 insertions(+), 252 deletions(-) diff --git a/_build_opt_8h_source.html b/_build_opt_8h_source.html index 76a98562..902ab3d3 100644 --- a/_build_opt_8h_source.html +++ b/_build_opt_8h_source.html @@ -549,8 +549,8 @@ $(document).ready(function(){initNavTree('_build_opt_8h_source.html',''); initRe
467 #endif
468 
469 // version definitions
-
470 #define RADIOLIB_VERSION_MAJOR (0x05)
-
471 #define RADIOLIB_VERSION_MINOR (0x07)
+
470 #define RADIOLIB_VERSION_MAJOR (0x06)
+
471 #define RADIOLIB_VERSION_MINOR (0x00)
472 #define RADIOLIB_VERSION_PATCH (0x00)
473 #define RADIOLIB_VERSION_EXTRA (0x00)
474 
diff --git a/_c_c1101_8h_source.html b/_c_c1101_8h_source.html index 74cdf2c0..0e63af09 100644 --- a/_c_c1101_8h_source.html +++ b/_c_c1101_8h_source.html @@ -834,14 +834,14 @@ $(document).ready(function(){initNavTree('_c_c1101_8h_source.html',''); initResi
int16_t finishTransmit() override
Clean up after transmission is done.
Definition: CC1101.cpp:350
int16_t startReceive()
Interrupt-driven receive method. GDO0 will be activated when full packet is received.
Definition: CC1101.cpp:361
int16_t setOOK(bool enableOOK)
Enables/disables OOK modulation instead of FSK.
Definition: CC1101.cpp:768
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:28
-
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:39
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
+
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:42
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:15
virtual int16_t readData(uint8_t *data, size_t len)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:205
int16_t transmit(const char *str, uint8_t addr=0)
C-string transmit method.
Definition: PhysicalLayer.cpp:52
int16_t startTransmit(const char *str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:145
virtual int16_t receive(uint8_t *data, size_t len)
Binary receive method. Must be implemented in module class.
Definition: PhysicalLayer.cpp:112
-
Definition: Module.h:46
+
Definition: Module.h:49
diff --git a/_external_radio_8h_source.html b/_external_radio_8h_source.html index bda1b21e..0242306f 100644 --- a/_external_radio_8h_source.html +++ b/_external_radio_8h_source.html @@ -111,7 +111,7 @@ $(document).ready(function(){initNavTree('_external_radio_8h_source.html',''); i
23 
24 #endif
Definition: ExternalRadio.h:12
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:28
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:15
Definition: Hal.h:11
diff --git a/_l_l_c_c68_8h_source.html b/_l_l_c_c68_8h_source.html index 7110469b..69c11825 100644 --- a/_l_l_c_c68_8h_source.html +++ b/_l_l_c_c68_8h_source.html @@ -125,7 +125,7 @@ $(document).ready(function(){initNavTree('_l_l_c_c68_8h_source.html',''); initRe
int16_t setBandwidth(float bw)
Sets LoRa bandwidth. Allowed values are 125.0, 250.0 and 500.0 kHz.
Definition: LLCC68.cpp:32
LLCC68(Module *mod)
Default constructor.
Definition: LLCC68.cpp:4
int16_t setSpreadingFactor(uint8_t sf)
Sets LoRa spreading factor. Allowed values range from 5 to 11, depending on currently set spreading f...
Definition: LLCC68.cpp:37
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:28
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
Derived class for SX1262 modules.
Definition: SX1262.h:22
diff --git a/_module_8h_source.html b/_module_8h_source.html index c1e8a443..aa6b2e31 100644 --- a/_module_8h_source.html +++ b/_module_8h_source.html @@ -102,197 +102,200 @@ $(document).ready(function(){initNavTree('_module_8h_source.html',''); initResiz
14 
21 #define END_OF_MODE_TABLE { Module::MODE_END_OF_TABLE, {} }
22 
-
28 class Module {
-
29  public:
-
39  static const size_t RFSWITCH_MAX_PINS = 3;
-
40 
-
46  struct RfSwitchMode_t {
-
47  uint8_t mode;
-
48  uint32_t values[RFSWITCH_MAX_PINS];
-
49  };
-
50 
-
58  enum OpMode_t {
-
62  MODE_END_OF_TABLE = 0,
-
64  MODE_IDLE,
-
66  MODE_RX,
-
68  MODE_TX,
-
69  };
-
70 
-
71  #if defined(RADIOLIB_BUILD_ARDUINO)
-
79  Module(uint32_t cs, uint32_t irq, uint32_t rst, uint32_t gpio = RADIOLIB_NC);
-
80 
-
90  Module(uint32_t cs, uint32_t irq, uint32_t rst, uint32_t gpio, SPIClass& spi, SPISettings spiSettings = RADIOLIB_DEFAULT_SPI_SETTINGS);
-
91  #endif
-
92 
-
101  Module(RadioLibHal *hal, uint32_t cs, uint32_t irq, uint32_t rst, uint32_t gpio = RADIOLIB_NC);
-
102 
-
107  Module(const Module& mod);
-
108 
-
113  Module& operator=(const Module& mod);
-
114 
-
115  // public member variables
-
119  RadioLibHal* hal = NULL;
-
120 
-
124  uint8_t SPIreadCommand = 0b00000000;
-
125 
-
129  uint8_t SPIwriteCommand = 0b10000000;
-
130 
-
134  uint8_t SPInopCommand = 0x00;
-
135 
-
139  uint8_t SPIstatusCommand = 0x00;
-
140 
-
144  uint8_t SPIaddrWidth = 8;
-
145 
-
150  bool SPIstreamType = false;
-
151 
-
155  int16_t SPIstreamError = RADIOLIB_ERR_UNKNOWN;
-
156 
-
160  typedef int16_t (*SPIparseStatusCb_t)(uint8_t in);
-
161 
-
166  SPIparseStatusCb_t SPIparseStatusCb = nullptr;
-
167 
-
168  #if defined(RADIOLIB_INTERRUPT_TIMING)
-
169 
-
173  typedef void (*TimerSetupCb_t)(uint32_t len);
-
174 
-
178  TimerSetupCb_t TimerSetupCb = nullptr;
-
179 
-
183  volatile bool TimerFlag = false;
-
184 
-
185  #endif
-
186 
-
187  // basic methods
-
188 
-
192  void init();
-
193 
-
197  void term();
-
198 
-
199  // SPI methods
-
200 
-
208  int16_t SPIgetRegValue(uint16_t reg, uint8_t msb = 7, uint8_t lsb = 0);
-
209 
-
220  int16_t SPIsetRegValue(uint16_t reg, uint8_t value, uint8_t msb = 7, uint8_t lsb = 0, uint8_t checkInterval = 2, uint8_t checkMask = 0xFF);
-
221 
-
228  void SPIreadRegisterBurst(uint16_t reg, size_t numBytes, uint8_t* inBytes);
-
229 
-
235  uint8_t SPIreadRegister(uint16_t reg);
-
236 
-
243  void SPIwriteRegisterBurst(uint16_t reg, uint8_t* data, size_t numBytes);
-
244 
-
250  void SPIwriteRegister(uint16_t reg, uint8_t data);
-
251 
-
260  void SPItransfer(uint8_t cmd, uint16_t reg, uint8_t* dataOut, uint8_t* dataIn, size_t numBytes);
-
261 
-
266  int16_t SPIcheckStream();
-
267 
-
277  int16_t SPIreadStream(uint8_t cmd, uint8_t* data, size_t numBytes, bool waitForGpio = true, bool verify = true);
-
278 
-
289  int16_t SPIreadStream(uint8_t* cmd, uint8_t cmdLen, uint8_t* data, size_t numBytes, bool waitForGpio = true, bool verify = true);
-
290 
-
300  int16_t SPIwriteStream(uint8_t cmd, uint8_t* data, size_t numBytes, bool waitForGpio = true, bool verify = true);
-
301 
-
312  int16_t SPIwriteStream(uint8_t* cmd, uint8_t cmdLen, uint8_t* data, size_t numBytes, bool waitForGpio = true, bool verify = true);
-
313 
-
326  int16_t SPItransferStream(uint8_t* cmd, uint8_t cmdLen, bool write, uint8_t* dataOut, uint8_t* dataIn, size_t numBytes, bool waitForGpio, uint32_t timeout);
-
327 
-
328  // pin number access methods
-
329 
-
334  uint32_t getCs() const { return(csPin); }
-
335 
-
340  uint32_t getIrq() const { return(irqPin); }
-
341 
-
346  uint32_t getRst() const { return(rstPin); }
-
347 
-
352  uint32_t getGpio() const { return(gpioPin); }
-
353 
-
370  void setRfSwitchPins(uint32_t rxEn, uint32_t txEn);
-
371 
-
434  void setRfSwitchTable(const uint32_t (&pins)[RFSWITCH_MAX_PINS], const RfSwitchMode_t table[]);
-
435 
-
443  const RfSwitchMode_t *findRfSwitchMode(uint8_t mode) const;
-
444 
-
449  void setRfSwitchState(uint8_t mode);
-
450 
-
458  void waitForMicroseconds(uint32_t start, uint32_t len);
-
459 
-
463  static uint8_t flipBits(uint8_t b);
-
464 
-
468  static uint16_t flipBits16(uint16_t i);
-
469 
-
477  static void hexdump(uint8_t* data, size_t len, uint32_t offset = 0, uint8_t width = 1, bool be = false);
-
478 
-
484  void regdump(uint16_t start, size_t len);
-
485 
-
486  #if defined(RADIOLIB_DEBUG) and defined(RADIOLIB_BUILD_ARDUINO)
-
487  static size_t serialPrintf(const char* format, ...);
-
488  #endif
-
489 
-
490 #if !defined(RADIOLIB_GODMODE)
-
491  private:
-
492 #endif
-
493  uint32_t csPin = RADIOLIB_NC;
-
494  uint32_t irqPin = RADIOLIB_NC;
-
495  uint32_t rstPin = RADIOLIB_NC;
-
496  uint32_t gpioPin = RADIOLIB_NC;
-
497 
-
498  // RF switch pins and table
-
499  uint32_t rfSwitchPins[RFSWITCH_MAX_PINS] = { RADIOLIB_NC, RADIOLIB_NC, RADIOLIB_NC };
-
500  const RfSwitchMode_t *rfSwitchTable = nullptr;
-
501 
-
502  #if defined(RADIOLIB_INTERRUPT_TIMING)
-
503  uint32_t prevTimingLen = 0;
-
504  #endif
-
505 };
-
506 
-
507 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:28
+
23 // default timeout for SPI transfers
+
24 #define RADIOLIB_MODULE_SPI_TIMEOUT (1000)
+
25 
+
31 class Module {
+
32  public:
+
42  static const size_t RFSWITCH_MAX_PINS = 3;
+
43 
+
49  struct RfSwitchMode_t {
+
50  uint8_t mode;
+
51  uint32_t values[RFSWITCH_MAX_PINS];
+
52  };
+
53 
+
61  enum OpMode_t {
+
65  MODE_END_OF_TABLE = 0,
+
67  MODE_IDLE,
+
69  MODE_RX,
+
71  MODE_TX,
+
72  };
+
73 
+
74  #if defined(RADIOLIB_BUILD_ARDUINO)
+
82  Module(uint32_t cs, uint32_t irq, uint32_t rst, uint32_t gpio = RADIOLIB_NC);
+
83 
+
93  Module(uint32_t cs, uint32_t irq, uint32_t rst, uint32_t gpio, SPIClass& spi, SPISettings spiSettings = RADIOLIB_DEFAULT_SPI_SETTINGS);
+
94  #endif
+
95 
+
104  Module(RadioLibHal *hal, uint32_t cs, uint32_t irq, uint32_t rst, uint32_t gpio = RADIOLIB_NC);
+
105 
+
110  Module(const Module& mod);
+
111 
+
116  Module& operator=(const Module& mod);
+
117 
+
118  // public member variables
+
122  RadioLibHal* hal = NULL;
+
123 
+
127  uint8_t SPIreadCommand = 0b00000000;
+
128 
+
132  uint8_t SPIwriteCommand = 0b10000000;
+
133 
+
137  uint8_t SPInopCommand = 0x00;
+
138 
+
142  uint8_t SPIstatusCommand = 0x00;
+
143 
+
147  uint8_t SPIaddrWidth = 8;
+
148 
+
153  bool SPIstreamType = false;
+
154 
+
158  int16_t SPIstreamError = RADIOLIB_ERR_UNKNOWN;
+
159 
+
163  typedef int16_t (*SPIparseStatusCb_t)(uint8_t in);
+
164 
+
169  SPIparseStatusCb_t SPIparseStatusCb = nullptr;
+
170 
+
171  #if defined(RADIOLIB_INTERRUPT_TIMING)
+
172 
+
176  typedef void (*TimerSetupCb_t)(uint32_t len);
+
177 
+
181  TimerSetupCb_t TimerSetupCb = nullptr;
+
182 
+
186  volatile bool TimerFlag = false;
+
187 
+
188  #endif
+
189 
+
190  // basic methods
+
191 
+
195  void init();
+
196 
+
200  void term();
+
201 
+
202  // SPI methods
+
203 
+
211  int16_t SPIgetRegValue(uint16_t reg, uint8_t msb = 7, uint8_t lsb = 0);
+
212 
+
223  int16_t SPIsetRegValue(uint16_t reg, uint8_t value, uint8_t msb = 7, uint8_t lsb = 0, uint8_t checkInterval = 2, uint8_t checkMask = 0xFF);
+
224 
+
231  void SPIreadRegisterBurst(uint16_t reg, size_t numBytes, uint8_t* inBytes);
+
232 
+
238  uint8_t SPIreadRegister(uint16_t reg);
+
239 
+
246  void SPIwriteRegisterBurst(uint16_t reg, uint8_t* data, size_t numBytes);
+
247 
+
253  void SPIwriteRegister(uint16_t reg, uint8_t data);
+
254 
+
263  void SPItransfer(uint8_t cmd, uint16_t reg, uint8_t* dataOut, uint8_t* dataIn, size_t numBytes);
+
264 
+
269  int16_t SPIcheckStream();
+
270 
+
280  int16_t SPIreadStream(uint8_t cmd, uint8_t* data, size_t numBytes, bool waitForGpio = true, bool verify = true);
+
281 
+
292  int16_t SPIreadStream(uint8_t* cmd, uint8_t cmdLen, uint8_t* data, size_t numBytes, bool waitForGpio = true, bool verify = true);
+
293 
+
303  int16_t SPIwriteStream(uint8_t cmd, uint8_t* data, size_t numBytes, bool waitForGpio = true, bool verify = true);
+
304 
+
315  int16_t SPIwriteStream(uint8_t* cmd, uint8_t cmdLen, uint8_t* data, size_t numBytes, bool waitForGpio = true, bool verify = true);
+
316 
+
329  int16_t SPItransferStream(uint8_t* cmd, uint8_t cmdLen, bool write, uint8_t* dataOut, uint8_t* dataIn, size_t numBytes, bool waitForGpio, uint32_t timeout);
+
330 
+
331  // pin number access methods
+
332 
+
337  uint32_t getCs() const { return(csPin); }
+
338 
+
343  uint32_t getIrq() const { return(irqPin); }
+
344 
+
349  uint32_t getRst() const { return(rstPin); }
+
350 
+
355  uint32_t getGpio() const { return(gpioPin); }
+
356 
+
373  void setRfSwitchPins(uint32_t rxEn, uint32_t txEn);
+
374 
+
437  void setRfSwitchTable(const uint32_t (&pins)[RFSWITCH_MAX_PINS], const RfSwitchMode_t table[]);
+
438 
+
446  const RfSwitchMode_t *findRfSwitchMode(uint8_t mode) const;
+
447 
+
452  void setRfSwitchState(uint8_t mode);
+
453 
+
461  void waitForMicroseconds(uint32_t start, uint32_t len);
+
462 
+
466  static uint8_t flipBits(uint8_t b);
+
467 
+
471  static uint16_t flipBits16(uint16_t i);
+
472 
+
480  static void hexdump(uint8_t* data, size_t len, uint32_t offset = 0, uint8_t width = 1, bool be = false);
+
481 
+
487  void regdump(uint16_t start, size_t len);
+
488 
+
489  #if defined(RADIOLIB_DEBUG) and defined(RADIOLIB_BUILD_ARDUINO)
+
490  static size_t serialPrintf(const char* format, ...);
+
491  #endif
+
492 
+
493 #if !defined(RADIOLIB_GODMODE)
+
494  private:
+
495 #endif
+
496  uint32_t csPin = RADIOLIB_NC;
+
497  uint32_t irqPin = RADIOLIB_NC;
+
498  uint32_t rstPin = RADIOLIB_NC;
+
499  uint32_t gpioPin = RADIOLIB_NC;
+
500 
+
501  // RF switch pins and table
+
502  uint32_t rfSwitchPins[RFSWITCH_MAX_PINS] = { RADIOLIB_NC, RADIOLIB_NC, RADIOLIB_NC };
+
503  const RfSwitchMode_t *rfSwitchTable = nullptr;
+
504 
+
505  #if defined(RADIOLIB_INTERRUPT_TIMING)
+
506  uint32_t prevTimingLen = 0;
+
507  #endif
+
508 };
+
509 
+
510 #endif
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
int16_t SPIgetRegValue(uint16_t reg, uint8_t msb=7, uint8_t lsb=0)
SPI read method that automatically masks unused bits. This method is the preferred SPI read mechanism...
Definition: Module.cpp:54
-
uint8_t SPIstatusCommand
Basic SPI status read command. Defaults to 0x00.
Definition: Module.h:139
+
uint8_t SPIstatusCommand
Basic SPI status read command. Defaults to 0x00.
Definition: Module.h:142
int16_t SPIsetRegValue(uint16_t reg, uint8_t value, uint8_t msb=7, uint8_t lsb=0, uint8_t checkInterval=2, uint8_t checkMask=0xFF)
Overwrite-safe SPI write method with verification. This method is the preferred SPI write mechanism.
Definition: Module.cpp:64
-
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:39
-
static uint16_t flipBits16(uint16_t i)
Function to reflect bits within an integer.
Definition: Module.cpp:382
-
bool SPIstreamType
Whether the SPI interface is stream-type (e.g. SX126x) or register-type (e.g. SX127x)....
Definition: Module.h:150
+
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:42
+
static uint16_t flipBits16(uint16_t i)
Function to reflect bits within an integer.
Definition: Module.cpp:383
+
bool SPIstreamType
Whether the SPI interface is stream-type (e.g. SX126x) or register-type (e.g. SX127x)....
Definition: Module.h:153
void SPIwriteRegister(uint16_t reg, uint8_t data)
SPI basic write method. Use of this method is reserved for special cases, SPIsetRegValue should be us...
Definition: Module.cpp:132
-
RadioLibHal * hal
Hardware abstraction layer to be used.
Definition: Module.h:119
+
RadioLibHal * hal
Hardware abstraction layer to be used.
Definition: Module.h:122
void term()
Terminate low-level module control.
Definition: Module.cpp:49
-
uint8_t SPInopCommand
Basic SPI no-operation command. Defaults to 0x00.
Definition: Module.h:134
-
void waitForMicroseconds(uint32_t start, uint32_t len)
Wait for time to elapse, either using the microsecond timer, or the TimerFlag. Note that in interrupt...
Definition: Module.cpp:357
+
uint8_t SPInopCommand
Basic SPI no-operation command. Defaults to 0x00.
Definition: Module.h:137
+
void waitForMicroseconds(uint32_t start, uint32_t len)
Wait for time to elapse, either using the microsecond timer, or the TimerFlag. Note that in interrupt...
Definition: Module.cpp:358
Module & operator=(const Module &mod)
Overload for assignment operator.
Definition: Module.cpp:33
-
uint32_t getGpio() const
Access method to get the pin number of second interrupt/GPIO.
Definition: Module.h:352
-
const RfSwitchMode_t * findRfSwitchMode(uint8_t mode) const
Find a mode in the RfSwitchTable.
Definition: Module.cpp:497
-
OpMode_t
Definition: Module.h:58
-
@ MODE_TX
Definition: Module.h:68
-
@ MODE_IDLE
Definition: Module.h:64
-
@ MODE_RX
Definition: Module.h:66
-
@ MODE_END_OF_TABLE
Definition: Module.h:62
+
uint32_t getGpio() const
Access method to get the pin number of second interrupt/GPIO.
Definition: Module.h:355
+
const RfSwitchMode_t * findRfSwitchMode(uint8_t mode) const
Find a mode in the RfSwitchTable.
Definition: Module.cpp:498
+
OpMode_t
Definition: Module.h:61
+
@ MODE_TX
Definition: Module.h:71
+
@ MODE_IDLE
Definition: Module.h:67
+
@ MODE_RX
Definition: Module.h:69
+
@ MODE_END_OF_TABLE
Definition: Module.h:65
int16_t SPIcheckStream()
Method to check the result of last SPI stream transfer.
Definition: Module.cpp:224
-
int16_t SPIstreamError
The last recorded SPI stream error.
Definition: Module.h:155
+
int16_t SPIstreamError
The last recorded SPI stream error.
Definition: Module.h:158
int16_t SPIwriteStream(uint8_t cmd, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)
Method to perform a write transaction with SPI stream.
Definition: Module.cpp:207
void SPItransfer(uint8_t cmd, uint16_t reg, uint8_t *dataOut, uint8_t *dataIn, size_t numBytes)
SPI single transfer method.
Definition: Module.cpp:141
-
void setRfSwitchPins(uint32_t rxEn, uint32_t txEn)
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: Module.cpp:474
-
static uint8_t flipBits(uint8_t b)
Function to reflect bits within a byte.
Definition: Module.cpp:375
+
void setRfSwitchPins(uint32_t rxEn, uint32_t txEn)
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: Module.cpp:475
+
static uint8_t flipBits(uint8_t b)
Function to reflect bits within a byte.
Definition: Module.cpp:376
Module(RadioLibHal *hal, uint32_t cs, uint32_t irq, uint32_t rst, uint32_t gpio=RADIOLIB_NC)
Module constructor.
Definition: Module.cpp:25
-
uint8_t SPIreadCommand
Basic SPI read command. Defaults to 0x00.
Definition: Module.h:124
+
uint8_t SPIreadCommand
Basic SPI read command. Defaults to 0x00.
Definition: Module.h:127
void SPIreadRegisterBurst(uint16_t reg, size_t numBytes, uint8_t *inBytes)
SPI burst read method.
Definition: Module.cpp:103
-
int16_t(* SPIparseStatusCb_t)(uint8_t in)
SPI status parsing callback typedef.
Definition: Module.h:160
+
int16_t(* SPIparseStatusCb_t)(uint8_t in)
SPI status parsing callback typedef.
Definition: Module.h:163
uint8_t SPIreadRegister(uint16_t reg)
SPI basic read method. Use of this method is reserved for special cases, SPIgetRegValue should be use...
Definition: Module.cpp:112
-
uint32_t getCs() const
Access method to get the pin number of SPI chip select.
Definition: Module.h:334
-
uint32_t getIrq() const
Access method to get the pin number of interrupt/GPIO.
Definition: Module.h:340
+
uint32_t getCs() const
Access method to get the pin number of SPI chip select.
Definition: Module.h:337
+
uint32_t getIrq() const
Access method to get the pin number of interrupt/GPIO.
Definition: Module.h:343
int16_t SPIreadStream(uint8_t cmd, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)
Method to perform a read transaction with SPI stream.
Definition: Module.cpp:190
-
void regdump(uint16_t start, size_t len)
Function to dump device registers as hex into the debug port.
Definition: Module.cpp:435
-
uint8_t SPIaddrWidth
SPI address width. Defaults to 8, currently only supports 8 and 16-bit addresses.
Definition: Module.h:144
-
void setRfSwitchTable(const uint32_t(&pins)[RFSWITCH_MAX_PINS], const RfSwitchMode_t table[])
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: Module.cpp:490
+
void regdump(uint16_t start, size_t len)
Function to dump device registers as hex into the debug port.
Definition: Module.cpp:436
+
uint8_t SPIaddrWidth
SPI address width. Defaults to 8, currently only supports 8 and 16-bit addresses.
Definition: Module.h:147
+
void setRfSwitchTable(const uint32_t(&pins)[RFSWITCH_MAX_PINS], const RfSwitchMode_t table[])
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: Module.cpp:491
int16_t SPItransferStream(uint8_t *cmd, uint8_t cmdLen, bool write, uint8_t *dataOut, uint8_t *dataIn, size_t numBytes, bool waitForGpio, uint32_t timeout)
SPI single transfer method for modules with stream-type SPI interface (SX126x, SX128x etc....
Definition: Module.cpp:243
-
static void hexdump(uint8_t *data, size_t len, uint32_t offset=0, uint8_t width=1, bool be=false)
Function to dump data as hex into the debug port.
Definition: Module.cpp:390
+
static void hexdump(uint8_t *data, size_t len, uint32_t offset=0, uint8_t width=1, bool be=false)
Function to dump data as hex into the debug port.
Definition: Module.cpp:391
void init()
Initialize low-level module control.
Definition: Module.cpp:43
-
uint32_t getRst() const
Access method to get the pin number of hardware reset pin.
Definition: Module.h:346
-
uint8_t SPIwriteCommand
Basic SPI write command. Defaults to 0x80.
Definition: Module.h:129
+
uint32_t getRst() const
Access method to get the pin number of hardware reset pin.
Definition: Module.h:349
+
uint8_t SPIwriteCommand
Basic SPI write command. Defaults to 0x80.
Definition: Module.h:132
void SPIwriteRegisterBurst(uint16_t reg, uint8_t *data, size_t numBytes)
SPI burst write method.
Definition: Module.cpp:123
-
SPIparseStatusCb_t SPIparseStatusCb
Callback to function that will parse the module-specific status codes to RadioLib status codes....
Definition: Module.h:166
-
void setRfSwitchState(uint8_t mode)
Set RF switch state.
Definition: Module.cpp:507
+
SPIparseStatusCb_t SPIparseStatusCb
Callback to function that will parse the module-specific status codes to RadioLib status codes....
Definition: Module.h:169
+
void setRfSwitchState(uint8_t mode)
Set RF switch state.
Definition: Module.cpp:508
Definition: Hal.h:11
#define RADIOLIB_ERR_UNKNOWN
There was an unexpected, unknown error. If you see this, something went incredibly wrong....
Definition: TypeDef.h:110
-
Definition: Module.h:46
+
Definition: Module.h:49
diff --git a/_physical_layer_8h_source.html b/_physical_layer_8h_source.html index 31dbf0c8..d1f13a2a 100644 --- a/_physical_layer_8h_source.html +++ b/_physical_layer_8h_source.html @@ -242,7 +242,7 @@ $(document).ready(function(){initNavTree('_physical_layer_8h_source.html',''); i
Client for AX25 communication.
Definition: AX25.h:249
Client for FSK-4 communication. The public interface is the same as Arduino Serial.
Definition: FSK4.h:15
Client for Hellschreiber transmissions.
Definition: Hellschreiber.h:89
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:28
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
Client for Morse Code communication. The public interface is the same as Arduino Serial.
Definition: Morse.h:92
Client for Pager communication.
Definition: Pager.h:68
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:15
diff --git a/_r_f69_8h_source.html b/_r_f69_8h_source.html index 911b372e..3c68c812 100644 --- a/_r_f69_8h_source.html +++ b/_r_f69_8h_source.html @@ -765,8 +765,8 @@ $(document).ready(function(){initNavTree('_r_f69_8h_source.html',''); initResiza
1013 #endif
1014 
1015 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:28
-
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:39
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
+
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:42
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:15
virtual int16_t readData(uint8_t *data, size_t len)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:205
int16_t transmit(const char *str, uint8_t addr=0)
C-string transmit method.
Definition: PhysicalLayer.cpp:52
@@ -839,7 +839,7 @@ $(document).ready(function(){initNavTree('_r_f69_8h_source.html',''); initResiza
RF69(Module *module)
Default constructor.
Definition: RF69.cpp:5
int16_t setRSSIThreshold(float dbm)
Sets the RSSI value above which the RSSI interrupt is signaled.
Definition: RF69.cpp:914
void setRfSwitchTable(const uint32_t(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: RF69.cpp:924
-
Definition: Module.h:46
+
Definition: Module.h:49
diff --git a/_r_f_m95_8h_source.html b/_r_f_m95_8h_source.html index d2b403b7..b5fa7ef3 100644 --- a/_r_f_m95_8h_source.html +++ b/_r_f_m95_8h_source.html @@ -127,7 +127,7 @@ $(document).ready(function(){initNavTree('_r_f_m95_8h_source.html',''); initResi
78 #endif
79 
80 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:28
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
Derived class for RFM95 modules. Overrides some methods from SX1278 due to different parameter ranges...
Definition: RFM95.h:20
int16_t begin(float freq=915.0, float bw=125.0, uint8_t sf=9, uint8_t cr=7, uint8_t syncWord=RADIOLIB_SX127X_SYNC_WORD, int8_t power=10, uint16_t preambleLength=8, uint8_t gain=0)
LoRa modem initialization method. Must be called at least once from Arduino sketch to initialize the ...
Definition: RFM95.cpp:8
int16_t beginFSK(float freq=434.0, float br=4.8, float freqDev=5.0, float rxBw=125.0, int8_t power=10, uint16_t preambleLength=16, bool enableOOK=false)
FSK modem initialization method. Must be called at least once from Arduino sketch to initialize the m...
Definition: RFM95.cpp:43
diff --git a/_r_f_m96_8h_source.html b/_r_f_m96_8h_source.html index 32ae5d22..e3eed4b1 100644 --- a/_r_f_m96_8h_source.html +++ b/_r_f_m96_8h_source.html @@ -129,7 +129,7 @@ $(document).ready(function(){initNavTree('_r_f_m96_8h_source.html',''); initResi
86 #endif
87 
88 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:28
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
Derived class for RFM96 modules. Overrides some methods from SX1278 due to different parameter ranges...
Definition: RFM96.h:20
int16_t beginFSK(float freq=434.0, float br=4.8, float freqDev=5.0, float rxBw=125.0, int8_t power=10, uint16_t preambleLength=16, bool enableOOK=false)
FSK modem initialization method. Must be called at least once from Arduino sketch to initialize the m...
Definition: RFM96.cpp:44
RFM96(Module *mod)
Default constructor. Called from Arduino sketch when creating new LoRa instance.
Definition: RFM96.cpp:4
diff --git a/_r_f_m97_8h_source.html b/_r_f_m97_8h_source.html index ec58b28a..53673c36 100644 --- a/_r_f_m97_8h_source.html +++ b/_r_f_m97_8h_source.html @@ -118,7 +118,7 @@ $(document).ready(function(){initNavTree('_r_f_m97_8h_source.html',''); initResi
43 #endif
44 
45 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:28
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
Derived class for RFM95 modules. Overrides some methods from SX1278 due to different parameter ranges...
Definition: RFM95.h:20
Derived class for RFM97 modules. Overrides some methods from RFM95 due to different parameter ranges.
Definition: RFM97.h:17
RFM97(Module *mod)
Default constructor. Called from Arduino sketch when creating new LoRa instance.
Definition: RFM97.cpp:4
diff --git a/_radio_lib_8h_source.html b/_radio_lib_8h_source.html index 38e8de65..c04c4f6b 100644 --- a/_radio_lib_8h_source.html +++ b/_radio_lib_8h_source.html @@ -196,7 +196,7 @@ $(document).ready(function(){initNavTree('_radio_lib_8h_source.html',''); initRe
151 #endif
152 
153 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:28
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
diff --git a/_s_t_m32_w_lx_8h_source.html b/_s_t_m32_w_lx_8h_source.html index 9686e885..760f1638 100644 --- a/_s_t_m32_w_lx_8h_source.html +++ b/_s_t_m32_w_lx_8h_source.html @@ -149,10 +149,10 @@ $(document).ready(function(){initNavTree('_s_t_m32_w_lx_8h_source.html',''); ini
132 #endif // !defined(RADIOLIB_EXCLUDE_SX126X)
133 
134 #endif // _RADIOLIB_STM32WLX_MODULE_H
-
@ MODE_TX
Definition: Module.h:68
-
@ MODE_IDLE
Definition: Module.h:64
-
@ MODE_RX
Definition: Module.h:66
-
@ MODE_END_OF_TABLE
Definition: Module.h:62
+
@ MODE_TX
Definition: Module.h:71
+
@ MODE_IDLE
Definition: Module.h:67
+
@ MODE_RX
Definition: Module.h:69
+
@ MODE_END_OF_TABLE
Definition: Module.h:65
Definition: STM32WLx_Module.h:26
Derived class for STM32WL modules.
Definition: STM32WLx.h:33
int16_t begin(float freq=434.0, float bw=125.0, uint8_t sf=9, uint8_t cr=7, uint8_t syncWord=RADIOLIB_SX126X_SYNC_WORD_PRIVATE, int8_t power=10, uint16_t preambleLength=8, float tcxoVoltage=1.6, bool useRegulatorLDO=false)
Initialization method for LoRa modem.
Definition: STM32WLx.cpp:13
diff --git a/_s_t_m32_w_lx___module_8h_source.html b/_s_t_m32_w_lx___module_8h_source.html index c69c6d96..c05c9d93 100644 --- a/_s_t_m32_w_lx___module_8h_source.html +++ b/_s_t_m32_w_lx___module_8h_source.html @@ -115,7 +115,7 @@ $(document).ready(function(){initNavTree('_s_t_m32_w_lx___module_8h_source.html'
36 #endif // !defined(RADIOLIB_EXCLUDE_STM32WLX)
37 
38 #endif // _RADIOLIB_STM32WLX_MODULE_H
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:28
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
Definition: STM32WLx_Module.h:26
diff --git a/_s_x1231_8h_source.html b/_s_x1231_8h_source.html index f00be07d..6addb7ef 100644 --- a/_s_x1231_8h_source.html +++ b/_s_x1231_8h_source.html @@ -189,7 +189,7 @@ $(document).ready(function(){initNavTree('_s_x1231_8h_source.html',''); initResi
119 #endif
120 
121 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:28
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
Control class for RF69 module. Also serves as base class for SX1231.
Definition: RF69.h:479
Control class for SX1231 module. Overrides some methods from RF69 due to different register values.
Definition: SX1231.h:93
int16_t begin(float freq=434.0, float br=4.8, float freqDev=5.0, float rxBw=125.0, int8_t power=10, uint8_t preambleLen=16)
Initialization method.
Definition: SX1231.cpp:8
diff --git a/_s_x1261_8h_source.html b/_s_x1261_8h_source.html index d15ba049..bbf195c1 100644 --- a/_s_x1261_8h_source.html +++ b/_s_x1261_8h_source.html @@ -118,7 +118,7 @@ $(document).ready(function(){initNavTree('_s_x1261_8h_source.html',''); initResi
43 #endif
44 
45 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:28
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
Derived class for SX1261 modules.
Definition: SX1261.h:22
SX1261(Module *mod)
Default constructor.
Definition: SX1261.cpp:4
int16_t setOutputPower(int8_t power)
Sets output power. Allowed values are in range from -17 to 14 dBm.
Definition: SX1261.cpp:8
diff --git a/_s_x1262_8h_source.html b/_s_x1262_8h_source.html index 6e71c7d6..751cad48 100644 --- a/_s_x1262_8h_source.html +++ b/_s_x1262_8h_source.html @@ -130,7 +130,7 @@ $(document).ready(function(){initNavTree('_s_x1262_8h_source.html',''); initResi
92 #endif
93 
94 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:28
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
Derived class for SX1262 modules.
Definition: SX1262.h:22
SX1262(Module *mod)
Default constructor.
Definition: SX1262.cpp:4
int16_t beginFSK(float freq=434.0, float br=4.8, float freqDev=5.0, float rxBw=156.2, int8_t power=10, uint16_t preambleLength=16, float tcxoVoltage=1.6, bool useRegulatorLDO=false)
Initialization method for FSK modem.
Definition: SX1262.cpp:32
diff --git a/_s_x1268_8h_source.html b/_s_x1268_8h_source.html index e3f95dd8..46b6fc47 100644 --- a/_s_x1268_8h_source.html +++ b/_s_x1268_8h_source.html @@ -129,7 +129,7 @@ $(document).ready(function(){initNavTree('_s_x1268_8h_source.html',''); initResi
90 #endif
91 
92 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:28
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
Derived class for SX1268 modules.
Definition: SX1268.h:21
int16_t setOutputPower(int8_t power)
Sets output power. Allowed values are in range from -9 to 22 dBm.
Definition: SX1268.cpp:79
SX1268(Module *mod)
Default constructor.
Definition: SX1268.cpp:4
diff --git a/_s_x126x_8h_source.html b/_s_x126x_8h_source.html index 54a72231..c33414dc 100644 --- a/_s_x126x_8h_source.html +++ b/_s_x126x_8h_source.html @@ -766,9 +766,9 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
1090 #endif
1091 
1092 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:28
-
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:39
-
@ MODE_TX
Definition: Module.h:68
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
+
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:42
+
@ MODE_TX
Definition: Module.h:71
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:15
virtual int16_t readData(uint8_t *data, size_t len)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:205
int16_t transmit(const char *str, uint8_t addr=0)
C-string transmit method.
Definition: PhysicalLayer.cpp:52
@@ -844,7 +844,7 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
int16_t setSpreadingFactor(uint8_t sf)
Sets LoRa spreading factor. Allowed values range from 5 to 12.
Definition: SX126x.cpp:784
int16_t disableAddressFiltering()
Disables address filtering. Calling this method will also erase previously set addresses.
Definition: SX126x.cpp:1115
int16_t setCodingRate(uint8_t cr)
Sets LoRa coding rate denominator. Allowed values range from 5 to 8.
Definition: SX126x.cpp:797
-
Definition: Module.h:46
+
Definition: Module.h:49
diff --git a/_s_x1272_8h_source.html b/_s_x1272_8h_source.html index 839da7b3..b2d3f2fa 100644 --- a/_s_x1272_8h_source.html +++ b/_s_x1272_8h_source.html @@ -243,7 +243,7 @@ $(document).ready(function(){initNavTree('_s_x1272_8h_source.html',''); initResi
278 #endif
279 
280 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:28
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
virtual float getRSSI()
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition: PhysicalLayer.cpp:254
Derived class for SX1272 modules. Also used as base class for SX1273. Both modules use the same basic...
Definition: SX1272.h:94
void reset() override
Reset method. Will reset the chip to the default state using RST pin.
Definition: SX1272.cpp:74
diff --git a/_s_x1273_8h_source.html b/_s_x1273_8h_source.html index 84ba8132..4dfb5cb9 100644 --- a/_s_x1273_8h_source.html +++ b/_s_x1273_8h_source.html @@ -119,7 +119,7 @@ $(document).ready(function(){initNavTree('_s_x1273_8h_source.html',''); initResi
58 #endif
59 
60 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:28
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
Derived class for SX1272 modules. Also used as base class for SX1273. Both modules use the same basic...
Definition: SX1272.h:94
Derived class for SX1273 modules. Overrides some methods from SX1272 due to different parameter range...
Definition: SX1273.h:14
int16_t begin(float freq=915.0, float bw=125.0, uint8_t sf=9, uint8_t cr=7, uint8_t syncWord=RADIOLIB_SX127X_SYNC_WORD, int8_t power=10, uint16_t preambleLength=8, uint8_t gain=0)
LoRa modem initialization method. Must be called at least once from Arduino sketch to initialize the ...
Definition: SX1273.cpp:8
diff --git a/_s_x1276_8h_source.html b/_s_x1276_8h_source.html index f3c1d707..5ac5e8a7 100644 --- a/_s_x1276_8h_source.html +++ b/_s_x1276_8h_source.html @@ -121,7 +121,7 @@ $(document).ready(function(){initNavTree('_s_x1276_8h_source.html',''); initResi
72 #endif
73 
74 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:28
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
Derived class for SX1276 modules. Overrides some methods from SX1278 due to different parameter range...
Definition: SX1276.h:14
int16_t setFrequency(float freq)
Sets carrier frequency. Allowed values range from 137.0 MHz to 1020.0 MHz.
Definition: SX1276.cpp:69
SX1276(Module *mod)
Default constructor. Called from Arduino sketch when creating new LoRa instance.
Definition: SX1276.cpp:4
diff --git a/_s_x1277_8h_source.html b/_s_x1277_8h_source.html index 954abf61..c561dd96 100644 --- a/_s_x1277_8h_source.html +++ b/_s_x1277_8h_source.html @@ -123,7 +123,7 @@ $(document).ready(function(){initNavTree('_s_x1277_8h_source.html',''); initResi
79 #endif
80 
81 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:28
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
Derived class for SX1277 modules. Overrides some methods from SX1278 due to different parameter range...
Definition: SX1277.h:14
int16_t setSpreadingFactor(uint8_t sf)
Sets LoRa link spreading factor. Allowed values range from 6 to 9. Only available in LoRa mode.
Definition: SX1277.cpp:80
SX1277(Module *mod)
Default constructor. Called from Arduino sketch when creating new LoRa instance.
Definition: SX1277.cpp:4
diff --git a/_s_x1278_8h_source.html b/_s_x1278_8h_source.html index 25bb2e71..f2c86fd4 100644 --- a/_s_x1278_8h_source.html +++ b/_s_x1278_8h_source.html @@ -252,7 +252,7 @@ $(document).ready(function(){initNavTree('_s_x1278_8h_source.html',''); initResi
287 #endif
288 
289 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:28
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
virtual float getRSSI()
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition: PhysicalLayer.cpp:254
Derived class for SX1278 modules. Also used as base class for SX1276, SX1277, SX1279,...
Definition: SX1278.h:103
SX1278(Module *mod)
Default constructor. Called from Arduino sketch when creating new LoRa instance.
Definition: SX1278.cpp:5
diff --git a/_s_x1279_8h_source.html b/_s_x1279_8h_source.html index 89451d1d..53c45366 100644 --- a/_s_x1279_8h_source.html +++ b/_s_x1279_8h_source.html @@ -121,7 +121,7 @@ $(document).ready(function(){initNavTree('_s_x1279_8h_source.html',''); initResi
72 #endif
73 
74 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:28
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
Derived class for SX1278 modules. Also used as base class for SX1276, SX1277, SX1279,...
Definition: SX1278.h:103
Derived class for SX1279 modules. Overrides some methods from SX1278 due to different parameter range...
Definition: SX1279.h:14
int16_t begin(float freq=434.0, float bw=125.0, uint8_t sf=9, uint8_t cr=7, uint8_t syncWord=RADIOLIB_SX127X_SYNC_WORD, int8_t power=10, uint16_t preambleLength=8, uint8_t gain=0)
LoRa modem initialization method. Must be called at least once from Arduino sketch to initialize the ...
Definition: SX1279.cpp:8
diff --git a/_s_x127x_8h_source.html b/_s_x127x_8h_source.html index 1b9774da..487db109 100644 --- a/_s_x127x_8h_source.html +++ b/_s_x127x_8h_source.html @@ -884,8 +884,8 @@ $(document).ready(function(){initNavTree('_s_x127x_8h_source.html',''); initResi
1182 #endif
1183 
1184 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:28
-
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:39
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
+
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:42
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:15
virtual int16_t readData(uint8_t *data, size_t len)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:205
int16_t transmit(const char *str, uint8_t addr=0)
C-string transmit method.
Definition: PhysicalLayer.cpp:52
@@ -966,7 +966,7 @@ $(document).ready(function(){initNavTree('_s_x127x_8h_source.html',''); initResi
int16_t transmitDirect(uint32_t frf=0) override
Enables direct transmission mode on pins DIO1 (clock) and DIO2 (data). While in direct mode,...
Definition: SX127x.cpp:294
float getFrequencyError(bool autoCorrect=false)
Gets frequency error of the latest received packet.
Definition: SX127x.cpp:741
int16_t disableAddressFiltering()
Disables FSK address filtering.
Definition: SX127x.cpp:1007
-
Definition: Module.h:46
+
Definition: Module.h:49
diff --git a/_s_x1280_8h_source.html b/_s_x1280_8h_source.html index 3ab7c332..0611330d 100644 --- a/_s_x1280_8h_source.html +++ b/_s_x1280_8h_source.html @@ -116,7 +116,7 @@ $(document).ready(function(){initNavTree('_s_x1280_8h_source.html',''); initResi
54 #endif
55 
56 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:28
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
Derived class for SX1280 modules.
Definition: SX1280.h:16
SX1280(Module *mod)
Default constructor.
Definition: SX1280.cpp:5
int16_t range(bool master, uint32_t addr, uint16_t calTable[3][6]=NULL)
Blocking ranging method.
Definition: SX1280.cpp:9
diff --git a/_s_x1281_8h_source.html b/_s_x1281_8h_source.html index a133d3ec..1ac12589 100644 --- a/_s_x1281_8h_source.html +++ b/_s_x1281_8h_source.html @@ -109,7 +109,7 @@ $(document).ready(function(){initNavTree('_s_x1281_8h_source.html',''); initResi
29 #endif
30 
31 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:28
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
Derived class for SX1281 modules.
Definition: SX1281.h:15
SX1281(Module *mod)
Default constructor.
Definition: SX1281.cpp:4
Base class for SX128x series. All derived classes for SX128x (e.g. SX1280 or SX1281) inherit from thi...
Definition: SX128x.h:350
diff --git a/_s_x1282_8h_source.html b/_s_x1282_8h_source.html index 8c035d51..5459abe7 100644 --- a/_s_x1282_8h_source.html +++ b/_s_x1282_8h_source.html @@ -110,7 +110,7 @@ $(document).ready(function(){initNavTree('_s_x1282_8h_source.html',''); initResi
30 #endif
31 
32 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:28
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
Derived class for SX1280 modules.
Definition: SX1280.h:16
Derived class for SX1282 modules.
Definition: SX1282.h:16
SX1282(Module *mod)
Default constructor.
Definition: SX1282.cpp:5
diff --git a/_s_x128x_8h_source.html b/_s_x128x_8h_source.html index 97a27675..296e0ab0 100644 --- a/_s_x128x_8h_source.html +++ b/_s_x128x_8h_source.html @@ -622,8 +622,8 @@ $(document).ready(function(){initNavTree('_s_x128x_8h_source.html',''); initResi
819 #endif
820 
821 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:28
-
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:39
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
+
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:42
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:15
virtual int16_t readData(uint8_t *data, size_t len)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:205
int16_t transmit(const char *str, uint8_t addr=0)
C-string transmit method.
Definition: PhysicalLayer.cpp:52
@@ -680,7 +680,7 @@ $(document).ready(function(){initNavTree('_s_x128x_8h_source.html',''); initResi
void setDirectAction(void(*func)(void))
Dummy method, to ensure PhysicalLayer compatibility.
Definition: SX128x.cpp:1298
int16_t receiveDirect() override
Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as SX128x series does...
Definition: SX128x.cpp:385
#define RADIOLIB_SHAPING_0_5
Gaussin shaping filter, BT = 0.5.
Definition: TypeDef.h:27
-
Definition: Module.h:46
+
Definition: Module.h:49
diff --git a/_si4430_8h_source.html b/_si4430_8h_source.html index c3a2f8e9..e7f0b45f 100644 --- a/_si4430_8h_source.html +++ b/_si4430_8h_source.html @@ -125,7 +125,7 @@ $(document).ready(function(){initNavTree('_si4430_8h_source.html',''); initResiz
65 #endif
66 
67 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:28
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
Derived class for Si4430 modules.
Definition: Si4430.h:15
int16_t setFrequency(float freq)
Sets carrier frequency. Allowed values range from 900.0 MHz to 960.0 MHz.
Definition: Si4430.cpp:24
int16_t begin(float freq=434.0, float br=4.8, float freqDev=5.0, float rxBw=181.1, int8_t power=10, uint8_t preambleLen=16)
Initialization method. Must be called at least once from Arduino sketch to initialize the module.
Definition: Si4430.cpp:8
diff --git a/_si4431_8h_source.html b/_si4431_8h_source.html index 8a4a58a9..61f2eb45 100644 --- a/_si4431_8h_source.html +++ b/_si4431_8h_source.html @@ -123,7 +123,7 @@ $(document).ready(function(){initNavTree('_si4431_8h_source.html',''); initResiz
58 #endif
59 
60 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:28
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
Derived class for Si4431 modules.
Definition: Si4431.h:15
Si4431(Module *mod)
Default constructor.
Definition: Si4431.cpp:4
int16_t begin(float freq=434.0, float br=4.8, float freqDev=5.0, float rxBw=181.1, int8_t power=10, uint8_t preambleLen=16)
Initialization method. Must be called at least once from Arduino sketch to initialize the module.
Definition: Si4431.cpp:8
diff --git a/_si4432_8h_source.html b/_si4432_8h_source.html index 53b13e68..a606c557 100644 --- a/_si4432_8h_source.html +++ b/_si4432_8h_source.html @@ -125,7 +125,7 @@ $(document).ready(function(){initNavTree('_si4432_8h_source.html',''); initResiz
65 #endif
66 
67 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:28
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
Derived class for Si4432 modules.
Definition: Si4432.h:15
int16_t begin(float freq=434.0, float br=4.8, float freqDev=5.0, float rxBw=181.1, int8_t power=10, uint8_t preambleLen=16)
Initialization method. Must be called at least once from Arduino sketch to initialize the module.
Definition: Si4432.cpp:8
int16_t setOutputPower(int8_t power)
Sets output power. Allowed values range from -1 to 20 dBm in 3 dBm steps.
Definition: Si4432.cpp:31
diff --git a/_si443x_8h_source.html b/_si443x_8h_source.html index 64559071..4df43635 100644 --- a/_si443x_8h_source.html +++ b/_si443x_8h_source.html @@ -755,8 +755,8 @@ $(document).ready(function(){initNavTree('_si443x_8h_source.html',''); initResiz
836 #endif
837 
838 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:28
-
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:39
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
+
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:42
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:15
virtual int16_t readData(uint8_t *data, size_t len)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:205
int16_t transmit(const char *str, uint8_t addr=0)
C-string transmit method.
Definition: PhysicalLayer.cpp:52
@@ -795,7 +795,7 @@ $(document).ready(function(){initNavTree('_si443x_8h_source.html',''); initResiz
void reset()
Reset method. Will reset the chip to the default state using SDN pin.
Definition: Si443x.cpp:70
Si443x(Module *mod)
Default constructor.
Definition: Si443x.cpp:5
void readBit(uint32_t pin)
Function to read and process data bit in direct reception mode.
Definition: Si443x.cpp:615
-
Definition: Module.h:46
+
Definition: Module.h:49
diff --git a/class_c_c1101.html b/class_c_c1101.html index 262ea990..1c0f8ecd 100644 --- a/class_c_c1101.html +++ b/class_c_c1101.html @@ -1610,10 +1610,10 @@ virtual void  radio.setRfSwitchTable(rfswitch_pins, rfswitch_table);
...
}
-
@ MODE_TX
Definition: Module.h:68
-
@ MODE_IDLE
Definition: Module.h:64
-
@ MODE_RX
Definition: Module.h:66
-
Definition: Module.h:46
+
@ MODE_TX
Definition: Module.h:71
+
@ MODE_IDLE
Definition: Module.h:67
+
@ MODE_RX
Definition: Module.h:69
+
Definition: Module.h:49
diff --git a/class_module.html b/class_module.html index 047c0283..19e909d1 100644 --- a/class_module.html +++ b/class_module.html @@ -779,10 +779,10 @@ Static Public Attributes
radio.setRfSwitchTable(rfswitch_pins, rfswitch_table);
...
}
-
@ MODE_TX
Definition: Module.h:68
-
@ MODE_IDLE
Definition: Module.h:64
-
@ MODE_RX
Definition: Module.h:66
-
Definition: Module.h:46
+
@ MODE_TX
Definition: Module.h:71
+
@ MODE_IDLE
Definition: Module.h:67
+
@ MODE_RX
Definition: Module.h:69
+
Definition: Module.h:49
diff --git a/class_r_f69.html b/class_r_f69.html index b00ffba3..b7eae2ae 100644 --- a/class_r_f69.html +++ b/class_r_f69.html @@ -2007,10 +2007,10 @@ void  radio.setRfSwitchTable(rfswitch_pins, rfswitch_table);
...
}
-
@ MODE_TX
Definition: Module.h:68
-
@ MODE_IDLE
Definition: Module.h:64
-
@ MODE_RX
Definition: Module.h:66
-
Definition: Module.h:46
+
@ MODE_TX
Definition: Module.h:71
+
@ MODE_IDLE
Definition: Module.h:67
+
@ MODE_RX
Definition: Module.h:69
+
Definition: Module.h:49
diff --git a/class_s_x126x.html b/class_s_x126x.html index 62c3f1e5..276ef0c1 100644 --- a/class_s_x126x.html +++ b/class_s_x126x.html @@ -1877,10 +1877,10 @@ bool  radio.setRfSwitchTable(rfswitch_pins, rfswitch_table);
...
}
-
@ MODE_TX
Definition: Module.h:68
-
@ MODE_IDLE
Definition: Module.h:64
-
@ MODE_RX
Definition: Module.h:66
-
Definition: Module.h:46
+
@ MODE_TX
Definition: Module.h:71
+
@ MODE_IDLE
Definition: Module.h:67
+
@ MODE_RX
Definition: Module.h:69
+
Definition: Module.h:49
diff --git a/class_s_x127x.html b/class_s_x127x.html index cacc6ec0..b6bbd7bd 100644 --- a/class_s_x127x.html +++ b/class_s_x127x.html @@ -2184,10 +2184,10 @@ void  radio.setRfSwitchTable(rfswitch_pins, rfswitch_table);
...
}
-
@ MODE_TX
Definition: Module.h:68
-
@ MODE_IDLE
Definition: Module.h:64
-
@ MODE_RX
Definition: Module.h:66
-
Definition: Module.h:46
+
@ MODE_TX
Definition: Module.h:71
+
@ MODE_IDLE
Definition: Module.h:67
+
@ MODE_RX
Definition: Module.h:69
+
Definition: Module.h:49
diff --git a/class_s_x128x.html b/class_s_x128x.html index 072a3358..59ba04d6 100644 --- a/class_s_x128x.html +++ b/class_s_x128x.html @@ -1770,10 +1770,10 @@ void  radio.setRfSwitchTable(rfswitch_pins, rfswitch_table);
...
}
-
@ MODE_TX
Definition: Module.h:68
-
@ MODE_IDLE
Definition: Module.h:64
-
@ MODE_RX
Definition: Module.h:66
-
Definition: Module.h:46
+
@ MODE_TX
Definition: Module.h:71
+
@ MODE_IDLE
Definition: Module.h:67
+
@ MODE_RX
Definition: Module.h:69
+
Definition: Module.h:49
diff --git a/class_si443x.html b/class_si443x.html index 9d886b84..35c03067 100644 --- a/class_si443x.html +++ b/class_si443x.html @@ -1082,10 +1082,10 @@ virtual void  radio.setRfSwitchTable(rfswitch_pins, rfswitch_table);
...
}
-
@ MODE_TX
Definition: Module.h:68
-
@ MODE_IDLE
Definition: Module.h:64
-
@ MODE_RX
Definition: Module.h:66
-
Definition: Module.h:46
+
@ MODE_TX
Definition: Module.h:71
+
@ MODE_IDLE
Definition: Module.h:67
+
@ MODE_RX
Definition: Module.h:69
+
Definition: Module.h:49
diff --git a/n_r_f24_8h_source.html b/n_r_f24_8h_source.html index 8a6590bb..92e69cf3 100644 --- a/n_r_f24_8h_source.html +++ b/n_r_f24_8h_source.html @@ -372,7 +372,7 @@ $(document).ready(function(){initNavTree('n_r_f24_8h_source.html',''); initResiz
462 };
463 
464 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:28
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:15
virtual int16_t readData(uint8_t *data, size_t len)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:205
int16_t transmit(const char *str, uint8_t addr=0)
C-string transmit method.
Definition: PhysicalLayer.cpp:52