From 71035b390587a52e547487e854d9cd4a8c4ab9fd Mon Sep 17 00:00:00 2001 From: jgromes Date: Sun, 5 Mar 2023 18:31:39 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=20ed4fc?= =?UTF-8?q?84a70f59e61cce98543da381b77a47fad18=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- _c_c1101_8h_source.html | 6 +- _external_radio_8h_source.html | 2 +- _l_l_c_c68_8h_source.html | 2 +- _module_8h_source.html | 135 ++++++------ _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 | 79 ++++--- _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 | 12 +- _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 +- _type_def_8h_source.html | 44 ++-- class_c_c1101.html | 11 +- class_module-members.html | 117 +++++----- class_module.html | 39 +--- class_r_f69.html | 11 +- class_s_t_m32_w_lx-members.html | 199 +++++++++-------- class_s_t_m32_w_lx.html | 35 +-- class_s_t_m32_w_lx___module-members.html | 119 +++++----- class_s_t_m32_w_lx___module.html | 2 - class_s_x126x.html | 11 +- class_s_x127x.html | 11 +- class_s_x128x.html | 11 +- class_si443x.html | 11 +- functions_e.html | 4 - functions_vars.html | 8 - group__status__codes.html | 2 +- menudata.js | 1 - n_r_f24_8h_source.html | 2 +- search/all_10.js | 20 +- search/all_11.js | 4 +- search/all_12.js | 6 +- search/all_13.js | 2 +- search/all_14.js | 2 +- search/all_15.js | 4 +- search/all_4.js | 7 +- search/all_5.js | 20 +- search/all_6.js | 60 ++--- search/all_7.js | 6 +- search/all_8.js | 16 +- search/all_9.js | 6 +- search/all_a.js | 22 +- search/all_b.js | 8 +- search/all_c.js | 4 +- search/all_d.js | 14 +- search/all_e.js | 198 ++++++++--------- search/all_f.js | 268 +++++++++++------------ search/classes_0.js | 8 +- search/classes_1.js | 2 +- search/classes_2.js | 2 +- search/classes_3.js | 2 +- search/classes_4.js | 2 +- search/classes_5.js | 2 +- search/classes_6.js | 2 +- search/classes_7.js | 4 +- search/classes_8.js | 2 +- search/classes_9.js | 4 +- search/classes_a.js | 18 +- search/classes_b.js | 48 ++-- search/classes_c.js | 2 +- search/enums_0.js | 2 +- search/enumvalues_0.js | 12 +- search/functions_0.js | 14 +- search/functions_1.js | 14 +- search/functions_10.js | 12 +- search/functions_11.js | 2 +- search/functions_12.js | 4 +- search/functions_13.js | 2 +- search/functions_14.js | 4 +- search/functions_2.js | 18 +- search/functions_3.js | 26 +-- search/functions_4.js | 14 +- search/functions_5.js | 18 +- search/functions_6.js | 60 ++--- search/functions_7.js | 4 +- search/functions_8.js | 12 +- search/functions_9.js | 4 +- search/functions_a.js | 8 +- search/functions_b.js | 4 +- search/functions_c.js | 2 +- search/functions_d.js | 12 +- search/functions_e.js | 32 +-- search/functions_f.js | 234 ++++++++++---------- search/groups_0.js | 2 +- search/groups_1.js | 2 +- search/groups_2.js | 2 +- search/groups_3.js | 4 +- search/pages_0.js | 2 +- search/pages_1.js | 2 +- search/searchdata.js | 2 +- search/typedefs_0.js | 2 +- search/variables_0.js | 2 +- search/variables_1.js | 4 +- search/variables_2.js | 2 +- search/variables_3.js | 2 +- search/variables_4.js | 3 +- search/variables_5.js | 3 +- search/variables_6.js | 3 +- search/variables_7.js | 3 +- search/variables_8.js | 5 +- search/variables_9.js | 16 +- search/variables_a.js | 14 +- search/variables_b.js | 3 +- search/variables_c.js | 2 +- search/variables_d.js | 2 +- search/variables_e.html | 37 ---- search/variables_e.js | 4 - 128 files changed, 1107 insertions(+), 1237 deletions(-) delete mode 100644 search/variables_e.html delete mode 100644 search/variables_e.js diff --git a/_c_c1101_8h_source.html b/_c_c1101_8h_source.html index 6690b56a..89f7bcbb 100644 --- a/_c_c1101_8h_source.html +++ b/_c_c1101_8h_source.html @@ -813,14 +813,14 @@ $(document).ready(function(){initNavTree('_c_c1101_8h_source.html',''); initResi
int16_t startReceive()
Interrupt-driven receive method. GDO0 will be activated when full packet is received.
Definition: CC1101.cpp:334
int16_t setOOK(bool enableOOK)
Enables/disables OOK modulation instead of FSK.
Definition: CC1101.cpp:714
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:60
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
-
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:27
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
+
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:35
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:14
int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)
Arduino Flash String transmit method.
Definition: PhysicalLayer.cpp:12
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:141
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:122
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:60
-
Definition: Module.h:34
+
Definition: Module.h:42
diff --git a/_external_radio_8h_source.html b/_external_radio_8h_source.html index 25157a3c..9393dbdd 100644 --- a/_external_radio_8h_source.html +++ b/_external_radio_8h_source.html @@ -104,7 +104,7 @@ $(document).ready(function(){initNavTree('_external_radio_8h_source.html',''); i
16 
17 #endif
Definition: ExternalRadio.h:9
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:14
diff --git a/_l_l_c_c68_8h_source.html b/_l_l_c_c68_8h_source.html index c034c78f..968a7de9 100644 --- a/_l_l_c_c68_8h_source.html +++ b/_l_l_c_c68_8h_source.html @@ -122,7 +122,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:16
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
Derived class for SX1262 modules.
Definition: SX1262.h:23
diff --git a/_module_8h_source.html b/_module_8h_source.html index 694f13f3..dcf6aed0 100644 --- a/_module_8h_source.html +++ b/_module_8h_source.html @@ -95,23 +95,23 @@ $(document).ready(function(){initNavTree('_module_8h_source.html',''); initResiz
7  #include <SPI.h>
8 #endif
9 
-
16 class Module {
-
17  public:
-
27  static const size_t RFSWITCH_MAX_PINS = 3;
-
28 
-
34  struct RfSwitchMode_t {
-
35  uint8_t mode;
-
36  RADIOLIB_PIN_STATUS values[RFSWITCH_MAX_PINS];
-
37  };
-
38 
-
46  enum OpMode_t {
-
50  MODE_END_OF_TABLE = 0,
-
52  MODE_IDLE,
-
54  MODE_RX,
-
56  MODE_TX,
-
57  };
-
58 
-
65  static const RfSwitchMode_t END_OF_MODE_TABLE;
+
16 #define END_OF_MODE_TABLE { Module::MODE_END_OF_TABLE, {} }
+
17 
+
24 class Module {
+
25  public:
+
35  static const size_t RFSWITCH_MAX_PINS = 3;
+
36 
+
42  struct RfSwitchMode_t {
+
43  uint8_t mode;
+
44  RADIOLIB_PIN_STATUS values[RFSWITCH_MAX_PINS];
+
45  };
+
46 
+
54  enum OpMode_t {
+
58  MODE_END_OF_TABLE = 0,
+
60  MODE_IDLE,
+
62  MODE_RX,
+
64  MODE_TX,
+
65  };
66 
67  #if defined(RADIOLIB_BUILD_ARDUINO)
68 
@@ -326,71 +326,70 @@ $(document).ready(function(){initNavTree('_module_8h_source.html',''); initResiz
758 };
759 
760 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
-
void endTransaction()
Arduino core SPI endTransaction override.
Definition: Module.cpp:653
-
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:132
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
+
void endTransaction()
Arduino core SPI endTransaction override.
Definition: Module.cpp:651
+
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:130
uint8_t SPIstatusCommand
Basic SPI status read command. Defaults to 0x00.
Definition: Module.h:150
-
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:142
-
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:27
-
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: Module.cpp:773
-
Module(RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE gpio=RADIOLIB_NC)
Default constructor.
Definition: Module.cpp:83
-
uint32_t pulseIn(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_STATUS state, uint32_t timeout)
Arduino core pulseIn override.
Definition: Module.cpp:619
-
void delayMicroseconds(uint32_t us)
Arduino core delayMicroseconds override.
Definition: Module.cpp:598
-
static uint16_t flipBits16(uint16_t i)
Function to reflect bits within an integer.
Definition: Module.cpp:708
-
uint32_t millis()
Arduino core millis override.
Definition: Module.cpp:605
-
void yield()
Arduino core yield override.
Definition: Module.cpp:582
-
void tone(RADIOLIB_PIN_TYPE pin, uint16_t value, uint32_t duration=0)
Arduino core tone override that checks RADIOLIB_NC as alias for unused pin and RADIOLIB_TONE_UNSUPPOR...
Definition: Module.cpp:506
+
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:140
+
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:35
+
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: Module.cpp:771
+
Module(RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE gpio=RADIOLIB_NC)
Default constructor.
Definition: Module.cpp:81
+
uint32_t pulseIn(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_STATUS state, uint32_t timeout)
Arduino core pulseIn override.
Definition: Module.cpp:617
+
void delayMicroseconds(uint32_t us)
Arduino core delayMicroseconds override.
Definition: Module.cpp:596
+
static uint16_t flipBits16(uint16_t i)
Function to reflect bits within an integer.
Definition: Module.cpp:706
+
uint32_t millis()
Arduino core millis override.
Definition: Module.cpp:603
+
void yield()
Arduino core yield override.
Definition: Module.cpp:580
+
void tone(RADIOLIB_PIN_TYPE pin, uint16_t value, uint32_t duration=0)
Arduino core tone override that checks RADIOLIB_NC as alias for unused pin and RADIOLIB_TONE_UNSUPPOR...
Definition: Module.cpp:504
bool SPIstreamType
Whether the SPI interface is stream-type (e.g. SX126x) or register-type (e.g. SX127x)....
Definition: Module.h:161
-
void beginTransaction()
Arduino core SPI beginTransaction override.
Definition: Module.cpp:635
-
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:220
-
void term()
Terminate low-level module control.
Definition: Module.cpp:119
-
uint8_t transfer(uint8_t b)
Arduino core SPI transfer override.
Definition: Module.cpp:644
+
void beginTransaction()
Arduino core SPI beginTransaction override.
Definition: Module.cpp:633
+
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:218
+
void term()
Terminate low-level module control.
Definition: Module.cpp:117
+
uint8_t transfer(uint8_t b)
Arduino core SPI transfer override.
Definition: Module.cpp:642
uint8_t SPInopCommand
Basic SPI no-operation command. Defaults to 0x00.
Definition: Module.h:145
-
void digitalWrite(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_STATUS value)
Arduino core digitalWrite override that checks RADIOLIB_NC as alias for unused pin.
Definition: Module.cpp:487
-
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:462
-
static const RfSwitchMode_t END_OF_MODE_TABLE
Definition: Module.h:65
-
Module & operator=(const Module &mod)
Overload for assignment operator.
Definition: Module.cpp:98
-
const RfSwitchMode_t * findRfSwitchMode(uint8_t mode) const
Find a mode in the RfSwitchTable.
Definition: Module.cpp:795
-
OpMode_t
Definition: Module.h:46
-
@ MODE_TX
Definition: Module.h:56
-
@ MODE_IDLE
Definition: Module.h:52
-
@ MODE_RX
Definition: Module.h:54
-
@ MODE_END_OF_TABLE
Definition: Module.h:50
-
int16_t SPIcheckStream()
Method to check the result of last SPI stream transfer.
Definition: Module.cpp:316
-
void detachInterrupt(RADIOLIB_PIN_TYPE interruptNum)
Arduino core detachInterrupt override.
Definition: Module.cpp:575
+
void digitalWrite(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_STATUS value)
Arduino core digitalWrite override that checks RADIOLIB_NC as alias for unused pin.
Definition: Module.cpp:485
+
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:460
+
Module & operator=(const Module &mod)
Overload for assignment operator.
Definition: Module.cpp:96
+
const RfSwitchMode_t * findRfSwitchMode(uint8_t mode) const
Find a mode in the RfSwitchTable.
Definition: Module.cpp:793
+
OpMode_t
Definition: Module.h:54
+
@ MODE_TX
Definition: Module.h:64
+
@ MODE_IDLE
Definition: Module.h:60
+
@ MODE_RX
Definition: Module.h:62
+
@ MODE_END_OF_TABLE
Definition: Module.h:58
+
int16_t SPIcheckStream()
Method to check the result of last SPI stream transfer.
Definition: Module.cpp:314
+
void detachInterrupt(RADIOLIB_PIN_TYPE interruptNum)
Arduino core detachInterrupt override.
Definition: Module.cpp:573
int16_t SPIstreamError
The last recorded SPI stream error.
Definition: Module.h:166
-
RADIOLIB_PIN_STATUS digitalRead(RADIOLIB_PIN_TYPE pin)
Arduino core digitalWrite override that checks RADIOLIB_NC as alias for unused pin.
Definition: Module.cpp:494
-
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:299
-
void SPItransfer(uint8_t cmd, uint16_t reg, uint8_t *dataOut, uint8_t *dataIn, size_t numBytes)
SPI single transfer method.
Definition: Module.cpp:229
-
static uint8_t flipBits(uint8_t b)
Function to reflect bits within a byte.
Definition: Module.cpp:701
+
RADIOLIB_PIN_STATUS digitalRead(RADIOLIB_PIN_TYPE pin)
Arduino core digitalWrite override that checks RADIOLIB_NC as alias for unused pin.
Definition: Module.cpp:492
+
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:297
+
void SPItransfer(uint8_t cmd, uint16_t reg, uint8_t *dataOut, uint8_t *dataIn, size_t numBytes)
SPI single transfer method.
Definition: Module.cpp:227
+
static uint8_t flipBits(uint8_t b)
Function to reflect bits within a byte.
Definition: Module.cpp:699
uint8_t SPIreadCommand
Basic SPI read command. Defaults to 0x00.
Definition: Module.h:135
-
void setRfSwitchTable(const RADIOLIB_PIN_TYPE(&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:788
-
void SPIreadRegisterBurst(uint16_t reg, size_t numBytes, uint8_t *inBytes)
SPI burst read method.
Definition: Module.cpp:191
+
void setRfSwitchTable(const RADIOLIB_PIN_TYPE(&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:786
+
void SPIreadRegisterBurst(uint16_t reg, size_t numBytes, uint8_t *inBytes)
SPI burst read method.
Definition: Module.cpp:189
RADIOLIB_PIN_TYPE getIrq() const
Access method to get the pin number of interrupt/GPIO.
Definition: Module.h:415
-
void attachInterrupt(RADIOLIB_PIN_TYPE interruptNum, void(*userFunc)(void), RADIOLIB_INTERRUPT_STATUS mode)
Arduino core attachInterrupt override.
Definition: Module.cpp:568
+
void attachInterrupt(RADIOLIB_PIN_TYPE interruptNum, void(*userFunc)(void), RADIOLIB_INTERRUPT_STATUS mode)
Arduino core attachInterrupt override.
Definition: Module.cpp:566
int16_t(* SPIparseStatusCb_t)(uint8_t in)
SPI status parsing callback typedef.
Definition: Module.h:171
-
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:200
-
void end()
Arduino core SPI end override.
Definition: Module.cpp:662
-
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:282
-
void regdump(uint16_t start, size_t len)
Function to dump device registers as hex into the debug port.
Definition: Module.cpp:760
+
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:198
+
void end()
Arduino core SPI end override.
Definition: Module.cpp:660
+
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:280
+
void regdump(uint16_t start, size_t len)
Function to dump device registers as hex into the debug port.
Definition: Module.cpp:758
uint8_t SPIaddrWidth
SPI address width. Defaults to 8, currently only supports 8 and 16-bit addresses.
Definition: Module.h:155
-
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:336
-
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:716
-
void init()
Initialize low-level module control.
Definition: Module.cpp:109
+
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:334
+
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:714
+
void init()
Initialize low-level module control.
Definition: Module.cpp:107
RADIOLIB_PIN_TYPE getRst() const
Access method to get the pin number of hardware reset pin.
Definition: Module.h:422
RADIOLIB_PIN_TYPE getCs() const
Access method to get the pin number of SPI chip select.
Definition: Module.h:408
uint8_t SPIwriteCommand
Basic SPI write command. Defaults to 0x80.
Definition: Module.h:140
RADIOLIB_PIN_TYPE getGpio() const
Access method to get the pin number of second interrupt/GPIO.
Definition: Module.h:429
-
void delay(uint32_t ms)
Arduino core delay override.
Definition: Module.cpp:591
-
uint32_t micros()
Arduino core micros override.
Definition: Module.cpp:612
-
void SPIwriteRegisterBurst(uint16_t reg, uint8_t *data, size_t numBytes)
SPI burst write method.
Definition: Module.cpp:211
-
void begin()
Arduino core SPI begin override.
Definition: Module.cpp:626
+
void delay(uint32_t ms)
Arduino core delay override.
Definition: Module.cpp:589
+
uint32_t micros()
Arduino core micros override.
Definition: Module.cpp:610
+
void SPIwriteRegisterBurst(uint16_t reg, uint8_t *data, size_t numBytes)
SPI burst write method.
Definition: Module.cpp:209
+
void begin()
Arduino core SPI begin override.
Definition: Module.cpp:624
SPIparseStatusCb_t SPIparseStatusCb
Callback to function that will parse the module-specific status codes to RadioLib status codes....
Definition: Module.h:177
-
void pinMode(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_MODE mode)
Arduino core pinMode override that checks RADIOLIB_NC as alias for unused pin.
Definition: Module.cpp:480
-
void noTone(RADIOLIB_PIN_TYPE pin)
Arduino core noTone override that checks RADIOLIB_NC as alias for unused pin and RADIOLIB_TONE_UNSUPP...
Definition: Module.cpp:541
-
void setRfSwitchState(uint8_t mode)
Set RF switch state.
Definition: Module.cpp:805
+
void pinMode(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_MODE mode)
Arduino core pinMode override that checks RADIOLIB_NC as alias for unused pin.
Definition: Module.cpp:478
+
void noTone(RADIOLIB_PIN_TYPE pin)
Arduino core noTone override that checks RADIOLIB_NC as alias for unused pin and RADIOLIB_TONE_UNSUPP...
Definition: Module.cpp:539
+
void setRfSwitchState(uint8_t mode)
Set RF switch state.
Definition: Module.cpp:803
#define RADIOLIB_ERR_UNKNOWN
There was an unexpected, unknown error. If you see this, something went incredibly wrong....
Definition: TypeDef.h:108
-
Definition: Module.h:34
+
Definition: Module.h:42
diff --git a/_physical_layer_8h_source.html b/_physical_layer_8h_source.html index cb3cc4a8..a0661c37 100644 --- a/_physical_layer_8h_source.html +++ b/_physical_layer_8h_source.html @@ -222,7 +222,7 @@ $(document).ready(function(){initNavTree('_physical_layer_8h_source.html',''); i
Client for AX25 communication.
Definition: AX25.h:279
Client for FSK-4 communication. The public interface is the same as Arduino Serial.
Definition: FSK4.h:16
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:16
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
Client for Morse Code communication. The public interface is the same as Arduino Serial.
Definition: Morse.h:93
Client for Pager communication.
Definition: Pager.h:69
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:14
diff --git a/_r_f69_8h_source.html b/_r_f69_8h_source.html index 09bd9757..f97ae980 100644 --- a/_r_f69_8h_source.html +++ b/_r_f69_8h_source.html @@ -760,8 +760,8 @@ $(document).ready(function(){initNavTree('_r_f69_8h_source.html',''); initResiza
1098 #endif
1099 
1100 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
-
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:27
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
+
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:35
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:14
int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)
Arduino Flash String transmit method.
Definition: PhysicalLayer.cpp:12
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:141
@@ -834,7 +834,7 @@ $(document).ready(function(){initNavTree('_r_f69_8h_source.html',''); initResiza
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:60
RF69(Module *module)
Default constructor.
Definition: RF69.cpp:4
int16_t setRSSIThreshold(float dbm)
Sets the RSSI value above which the RSSI interrupt is signaled.
Definition: RF69.cpp:910
-
Definition: Module.h:34
+
Definition: Module.h:42
diff --git a/_r_f_m95_8h_source.html b/_r_f_m95_8h_source.html index 3de3178d..7351344d 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
99 #endif
100 
101 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
Derived class for RFM95 modules. Overrides some methods from SX1278 due to different parameter ranges...
Definition: RFM95.h:21
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 bec73967..92b1628f 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
106 #endif
107 
108 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
Derived class for RFM96 modules. Overrides some methods from SX1278 due to different parameter ranges...
Definition: RFM96.h:21
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 afeb0be3..0584668f 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
47 #endif
48 
49 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
Derived class for RFM95 modules. Overrides some methods from SX1278 due to different parameter ranges...
Definition: RFM95.h:21
Derived class for RFM97 modules. Overrides some methods from RFM95 due to different parameter ranges.
Definition: RFM97.h:18
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 1bb2da8e..334299bf 100644 --- a/_radio_lib_8h_source.html +++ b/_radio_lib_8h_source.html @@ -190,7 +190,7 @@ $(document).ready(function(){initNavTree('_radio_lib_8h_source.html',''); initRe
145 #endif
146 
147 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
diff --git a/_s_t_m32_w_lx_8h_source.html b/_s_t_m32_w_lx_8h_source.html index f0d1b7f7..a42f8a8f 100644 --- a/_s_t_m32_w_lx_8h_source.html +++ b/_s_t_m32_w_lx_8h_source.html @@ -119,60 +119,57 @@ $(document).ready(function(){initNavTree('_s_t_m32_w_lx_8h_source.html',''); ini
61  MODE_TX_LP = Module::MODE_TX,
63  MODE_TX_HP,
64  };
-
66  static const Module::RfSwitchMode_t END_OF_MODE_TABLE;
+
65 
+
66  // basic methods
67 
-
68  // basic methods
-
69 
-
73  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);
-
74 
-
78  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);
+
71  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);
+
72 
+
76  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);
+
77 
+
78  // configuration methods
79 
-
80  // configuration methods
-
81 
-
95  virtual int16_t setOutputPower(int8_t power) override;
-
96 
-
112  // Note: This explicitly inherits this method only to override docs
-
113  using SX126x::setRfSwitchTable;
-
114 
-
120  void setDio1Action(void (*func)(void));
-
121 
-
125  void clearDio1Action();
-
126 
-
127 #if !defined(RADIOLIB_GODMODE)
-
128  protected:
-
129 #endif
-
130  virtual int16_t clearIrqStatus(uint16_t clearIrqParams) override;
-
131 
-
132 #if !defined(RADIOLIB_GODMODE)
-
133  private:
-
134 #endif
-
135 };
+
93  virtual int16_t setOutputPower(int8_t power) override;
+
94 
+
110  // Note: This explicitly inherits this method only to override docs
+
111  using SX126x::setRfSwitchTable;
+
112 
+
118  void setDio1Action(void (*func)(void));
+
119 
+
123  void clearDio1Action();
+
124 
+
125 #if !defined(RADIOLIB_GODMODE)
+
126  protected:
+
127 #endif
+
128  virtual int16_t clearIrqStatus(uint16_t clearIrqParams) override;
+
129 
+
130 #if !defined(RADIOLIB_GODMODE)
+
131  private:
+
132 #endif
+
133 };
+
134 
+
135 #endif // !defined(RADIOLIB_EXCLUDE_SX126X)
136 
-
137 #endif // !defined(RADIOLIB_EXCLUDE_SX126X)
-
138 
-
139 #endif // _RADIOLIB_STM32WLX_MODULE_H
-
@ MODE_TX
Definition: Module.h:56
-
@ MODE_IDLE
Definition: Module.h:52
-
@ MODE_RX
Definition: Module.h:54
-
@ MODE_END_OF_TABLE
Definition: Module.h:50
+
137 #endif // _RADIOLIB_STM32WLX_MODULE_H
+
@ MODE_TX
Definition: Module.h:64
+
@ MODE_IDLE
Definition: Module.h:60
+
@ MODE_RX
Definition: Module.h:62
+
@ MODE_END_OF_TABLE
Definition: Module.h:58
Definition: STM32WLx_Module.h:26
Derived class for STM32WL modules.
Definition: STM32WLx.h:34
-
static const Module::RfSwitchMode_t END_OF_MODE_TABLE
Definition: STM32WLx.h:66
-
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:19
-
void clearDio1Action()
Clears interrupt service routine to call when DIO1/2/3 activates.
Definition: STM32WLx.cpp:104
-
void setDio1Action(void(*func)(void))
Sets interrupt service routine to call when DIO1/2/3 activates.
Definition: STM32WLx.cpp:94
-
virtual int16_t setOutputPower(int8_t power) override
Sets output power. Allowed values are in range from -17 to 22 dBm.
Definition: STM32WLx.cpp:47
-
STM32WLx(STM32WLx_Module *mod)
Default constructor.
Definition: STM32WLx.cpp:16
+
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:17
+
void clearDio1Action()
Clears interrupt service routine to call when DIO1/2/3 activates.
Definition: STM32WLx.cpp:102
+
void setDio1Action(void(*func)(void))
Sets interrupt service routine to call when DIO1/2/3 activates.
Definition: STM32WLx.cpp:92
+
virtual int16_t setOutputPower(int8_t power) override
Sets output power. Allowed values are in range from -17 to 22 dBm.
Definition: STM32WLx.cpp:45
+
STM32WLx(STM32WLx_Module *mod)
Default constructor.
Definition: STM32WLx.cpp:14
OpMode_t
Custom operation modes for STMWLx.
Definition: STM32WLx.h:53
@ MODE_END_OF_TABLE
Definition: STM32WLx.h:55
@ MODE_TX_LP
Definition: STM32WLx.h:61
@ MODE_TX_HP
Definition: STM32WLx.h:63
@ MODE_RX
Definition: STM32WLx.h:59
@ MODE_IDLE
Definition: STM32WLx.h:57
-
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: STM32WLx.cpp:33
+
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: STM32WLx.cpp:31
Derived class for SX1262 modules.
Definition: SX1262.h:23
void setRfSwitchTable(const RADIOLIB_PIN_TYPE(&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: SX126x.cpp:1325
-
Definition: Module.h:34
diff --git a/_s_t_m32_w_lx___module_8h_source.html b/_s_t_m32_w_lx___module_8h_source.html index 667c7f37..e9522336 100644 --- a/_s_t_m32_w_lx___module_8h_source.html +++ b/_s_t_m32_w_lx___module_8h_source.html @@ -126,7 +126,7 @@ $(document).ready(function(){initNavTree('_s_t_m32_w_lx___module_8h_source.html'
47 #endif // !defined(RADIOLIB_EXCLUDE_STM32WLX)
48 
49 #endif // _RADIOLIB_STM32WLX_MODULE_H
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
Definition: STM32WLx_Module.h:26
diff --git a/_s_x1231_8h_source.html b/_s_x1231_8h_source.html index 216252a4..ab5e3c45 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
128 #endif
129 
130 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
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:94
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 047a00c8..5242ae33 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
47 #endif
48 
49 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
Derived class for SX1261 modules.
Definition: SX1261.h:23
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 03bc9403..ba033146 100644 --- a/_s_x1262_8h_source.html +++ b/_s_x1262_8h_source.html @@ -132,7 +132,7 @@ $(document).ready(function(){initNavTree('_s_x1262_8h_source.html',''); initResi
122 #endif
123 
124 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
Derived class for SX1262 modules.
Definition: SX1262.h:23
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 609633e5..8b97268a 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
118 #endif
119 
120 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
Derived class for SX1268 modules.
Definition: SX1268.h:22
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 3050f5ca..e4c62789 100644 --- a/_s_x126x_8h_source.html +++ b/_s_x126x_8h_source.html @@ -739,9 +739,9 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
1137 #endif
1138 
1139 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
-
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:27
-
@ MODE_TX
Definition: Module.h:56
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
+
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:35
+
@ MODE_TX
Definition: Module.h:64
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:14
int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)
Arduino Flash String transmit method.
Definition: PhysicalLayer.cpp:12
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:141
@@ -782,7 +782,7 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX126X_MAX_PACKET_LENGTH)
Set modem in variable packet length mode. Available in FSK mode only.
Definition: SX126x.cpp:1255
int16_t begin(uint8_t cr, uint8_t syncWord, uint16_t preambleLength, float tcxoVoltage, bool useRegulatorLDO=false)
Initialization method for LoRa modem.
Definition: SX126x.cpp:13
int16_t setCRC(uint8_t len, uint16_t initial=0x1D0F, uint16_t polynomial=0x1021, bool inverted=true)
Sets CRC configuration.
Definition: SX126x.cpp:1121
-
uint16_t getIrqStatus()
Reads the current IRQ status.
Definition: SX126x.cpp:1528
+
uint16_t getIrqStatus()
Reads the current IRQ status.
Definition: SX126x.cpp:1533
int16_t reset(bool verify=true)
Reset method. Will reset the chip to the default state using RST pin.
Definition: SX126x.cpp:186
int16_t setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)
Sets LoRa sync word.
Definition: SX126x.cpp:808
float getCurrentLimit()
Reads current protection limit.
Definition: SX126x.cpp:832
@@ -802,7 +802,7 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
int16_t implicitHeader(size_t len)
Set implicit header mode for future reception/transmission.
Definition: SX126x.cpp:1301
float getRSSIInst()
Get instantaneous RSSI value during recption of the packet. Should switch to FSK receive mode for LBT...
Definition: SX126x.cpp:1294
float getSNR()
Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem.
Definition: SX126x.cpp:1228
-
int16_t setDio2AsRfSwitch(bool enable=true)
Set DIO2 to function as RF switch (default in Semtech example designs).
Definition: SX126x.cpp:1429
+
int16_t setDio2AsRfSwitch(bool enable=true)
Set DIO2 to function as RF switch (default in Semtech example designs).
Definition: SX126x.cpp:1434
int16_t setSpreadingFactor(uint8_t sf)
Sets LoRa spreading factor. Allowed values range from 5 to 12.
Definition: SX126x.cpp:782
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:141
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:122
@@ -811,7 +811,7 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
int16_t disableAddressFiltering()
Disables address filtering. Calling this method will also erase previously set addresses.
Definition: SX126x.cpp:1110
int16_t setCodingRate(uint8_t cr)
Sets LoRa coding rate denominator. Allowed values range from 5 to 8.
Definition: SX126x.cpp:795
void readBit(RADIOLIB_PIN_TYPE pin)
Dummy method, to ensure PhysicalLayer compatibility.
Definition: SX126x.cpp:1376
-
Definition: Module.h:34
+
Definition: Module.h:42
diff --git a/_s_x1272_8h_source.html b/_s_x1272_8h_source.html index 5ba3ec9c..117b4871 100644 --- a/_s_x1272_8h_source.html +++ b/_s_x1272_8h_source.html @@ -241,7 +241,7 @@ $(document).ready(function(){initNavTree('_s_x1272_8h_source.html',''); initResi
315 #endif
316 
317 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
Derived class for SX1272 modules. Also used as base class for SX1273. Both modules use the same basic...
Definition: SX1272.h:95
void reset() override
Reset method. Will reset the chip to the default state using RST pin.
Definition: SX1272.cpp:62
int16_t setBandwidth(float bw)
Sets LoRa link bandwidth. Allowed values are 125, 250 and 500 kHz. Only available in LoRa mode.
Definition: SX1272.cpp:81
diff --git a/_s_x1273_8h_source.html b/_s_x1273_8h_source.html index bbca15e5..0f0f3693 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
71 #endif
72 
73 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
Derived class for SX1272 modules. Also used as base class for SX1273. Both modules use the same basic...
Definition: SX1272.h:95
Derived class for SX1273 modules. Overrides some methods from SX1272 due to different parameter range...
Definition: SX1273.h:15
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 9ccab911..59b7ec3d 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
93 #endif
94 
95 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
Derived class for SX1276 modules. Overrides some methods from SX1278 due to different parameter range...
Definition: SX1276.h:15
int16_t setFrequency(float freq)
Sets carrier frequency. Allowed values range from 137.0 MHz to 1020.0 MHz.
Definition: SX1276.cpp:62
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 78143275..242749e3 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
102 #endif
103 
104 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
Derived class for SX1277 modules. Overrides some methods from SX1278 due to different parameter range...
Definition: SX1277.h:15
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:73
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 15659e39..7a487df4 100644 --- a/_s_x1278_8h_source.html +++ b/_s_x1278_8h_source.html @@ -250,7 +250,7 @@ $(document).ready(function(){initNavTree('_s_x1278_8h_source.html',''); initResi
324 #endif
325 
326 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
Derived class for SX1278 modules. Also used as base class for SX1276, SX1277, SX1279,...
Definition: SX1278.h:104
SX1278(Module *mod)
Default constructor. Called from Arduino sketch when creating new LoRa instance.
Definition: SX1278.cpp:4
int16_t setDataShapingOOK(uint8_t sh)
Sets filter cutoff frequency that will be used for data shaping. Allowed values are 1 for frequency e...
Definition: SX1278.cpp:344
diff --git a/_s_x1279_8h_source.html b/_s_x1279_8h_source.html index 227f9cbb..211ead67 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
93 #endif
94 
95 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
Derived class for SX1278 modules. Also used as base class for SX1276, SX1277, SX1279,...
Definition: SX1278.h:104
Derived class for SX1279 modules. Overrides some methods from SX1278 due to different parameter range...
Definition: SX1279.h:15
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 488b8a17..d1849956 100644 --- a/_s_x127x_8h_source.html +++ b/_s_x127x_8h_source.html @@ -878,8 +878,8 @@ $(document).ready(function(){initNavTree('_s_x127x_8h_source.html',''); initResi
1296 #endif
1297 
1298 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
-
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:27
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
+
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:35
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:14
int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)
Arduino Flash String transmit method.
Definition: PhysicalLayer.cpp:12
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:141
@@ -960,7 +960,7 @@ $(document).ready(function(){initNavTree('_s_x127x_8h_source.html',''); initResi
float getFrequencyError(bool autoCorrect=false)
Gets frequency error of the latest received packet.
Definition: SX127x.cpp:736
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:60
int16_t disableAddressFiltering()
Disables FSK address filtering.
Definition: SX127x.cpp:996
-
Definition: Module.h:34
+
Definition: Module.h:42
diff --git a/_s_x1280_8h_source.html b/_s_x1280_8h_source.html index c56d8d7b..5ad044bb 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
65 #endif
66 
67 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
Derived class for SX1280 modules.
Definition: SX1280.h:17
SX1280(Module *mod)
Default constructor.
Definition: SX1280.cpp:4
int16_t range(bool master, uint32_t addr, uint16_t calTable[3][6]=NULL)
Blocking ranging method.
Definition: SX1280.cpp:8
diff --git a/_s_x1281_8h_source.html b/_s_x1281_8h_source.html index 345f2750..ae74ea02 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
31 #endif
32 
33 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
Derived class for SX1281 modules.
Definition: SX1281.h:16
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:351
diff --git a/_s_x1282_8h_source.html b/_s_x1282_8h_source.html index 00d053b9..f3da455b 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
32 #endif
33 
34 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
Derived class for SX1280 modules.
Definition: SX1280.h:17
Derived class for SX1282 modules.
Definition: SX1282.h:17
SX1282(Module *mod)
Default constructor.
Definition: SX1282.cpp:5
diff --git a/_s_x128x_8h_source.html b/_s_x128x_8h_source.html index 2268c08b..9dbe46a0 100644 --- a/_s_x128x_8h_source.html +++ b/_s_x128x_8h_source.html @@ -617,8 +617,8 @@ $(document).ready(function(){initNavTree('_s_x128x_8h_source.html',''); initResi
912 #endif
913 
914 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
-
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:27
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
+
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:35
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:14
int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)
Arduino Flash String transmit method.
Definition: PhysicalLayer.cpp:12
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:141
@@ -674,7 +674,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:1279
int16_t receiveDirect() override
Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as SX128x series does...
Definition: SX128x.cpp:388
#define RADIOLIB_SHAPING_0_5
Gaussin shaping filter, BT = 0.5.
Definition: TypeDef.h:25
-
Definition: Module.h:34
+
Definition: Module.h:42
diff --git a/_si4430_8h_source.html b/_si4430_8h_source.html index 9f17ffa4..d4048fad 100644 --- a/_si4430_8h_source.html +++ b/_si4430_8h_source.html @@ -126,7 +126,7 @@ $(document).ready(function(){initNavTree('_si4430_8h_source.html',''); initResiz
79 #endif
80 
81 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
Derived class for Si4430 modules.
Definition: Si4430.h:16
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 82556de8..031adf4a 100644 --- a/_si4431_8h_source.html +++ b/_si4431_8h_source.html @@ -124,7 +124,7 @@ $(document).ready(function(){initNavTree('_si4431_8h_source.html',''); initResiz
70 #endif
71 
72 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
Derived class for Si4431 modules.
Definition: Si4431.h:16
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 8585e2b6..b9c6348d 100644 --- a/_si4432_8h_source.html +++ b/_si4432_8h_source.html @@ -126,7 +126,7 @@ $(document).ready(function(){initNavTree('_si4432_8h_source.html',''); initResiz
79 #endif
80 
81 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
Derived class for Si4432 modules.
Definition: Si4432.h:16
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 9de6178a..7930de39 100644 --- a/_si443x_8h_source.html +++ b/_si443x_8h_source.html @@ -751,8 +751,8 @@ $(document).ready(function(){initNavTree('_si443x_8h_source.html',''); initResiz
873 #endif
874 
875 #endif
-
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
-
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:27
+
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
+
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:35
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:14
int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)
Arduino Flash String transmit method.
Definition: PhysicalLayer.cpp:12
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:141
@@ -791,7 +791,7 @@ $(document).ready(function(){initNavTree('_si443x_8h_source.html',''); initResiz
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:141
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:122
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:60
-
Definition: Module.h:34
+
Definition: Module.h:42
diff --git a/_type_def_8h_source.html b/_type_def_8h_source.html index 774a8648..22e7821c 100644 --- a/_type_def_8h_source.html +++ b/_type_def_8h_source.html @@ -237,31 +237,31 @@ $(document).ready(function(){initNavTree('_type_def_8h_source.html',''); initRes
382 
386 #define RADIOLIB_ERR_SPI_CMD_INVALID (-706)
387 
-
391 #define RADIOLIB_ERR_SPI_CMD_FAILED (-707)
-
392 
-
399 #define RADIOLIB_ERR_INVALID_SLEEP_PERIOD (-708)
-
400 
-
406 #define RADIOLIB_ERR_INVALID_RX_PERIOD (-709)
-
407 
-
408 // AX.25-specific status codes
-
409 
-
415 #define RADIOLIB_ERR_INVALID_CALLSIGN (-801)
-
416 
-
422 #define RADIOLIB_ERR_INVALID_NUM_REPEATERS (-802)
-
423 
-
429 #define RADIOLIB_ERR_INVALID_REPEATER_CALLSIGN (-803)
-
430 
-
431 // SX128x-specific status codes
-
432 
-
436 #define RADIOLIB_ERR_RANGING_TIMEOUT (-901)
+
396 #define RADIOLIB_ERR_SPI_CMD_FAILED (-707)
+
397 
+
404 #define RADIOLIB_ERR_INVALID_SLEEP_PERIOD (-708)
+
405 
+
411 #define RADIOLIB_ERR_INVALID_RX_PERIOD (-709)
+
412 
+
413 // AX.25-specific status codes
+
414 
+
420 #define RADIOLIB_ERR_INVALID_CALLSIGN (-801)
+
421 
+
427 #define RADIOLIB_ERR_INVALID_NUM_REPEATERS (-802)
+
428 
+
434 #define RADIOLIB_ERR_INVALID_REPEATER_CALLSIGN (-803)
+
435 
+
436 // SX128x-specific status codes
437 
-
438 // Pager-specific status codes
-
439 
-
443 #define RADIOLIB_ERR_INVALID_PAYLOAD (-1001)
+
441 #define RADIOLIB_ERR_RANGING_TIMEOUT (-901)
+
442 
+
443 // Pager-specific status codes
444 
-
448 #define RADIOLIB_ERR_ADDRESS_NOT_FOUND (-1002)
+
448 #define RADIOLIB_ERR_INVALID_PAYLOAD (-1001)
449 
-
454 #endif
+
453 #define RADIOLIB_ERR_ADDRESS_NOT_FOUND (-1002)
+
454 
+
459 #endif
diff --git a/class_c_c1101.html b/class_c_c1101.html index e1c79de3..e4e2cf5f 100644 --- a/class_c_c1101.html +++ b/class_c_c1101.html @@ -1640,7 +1640,7 @@ void  {Module::MODE_IDLE, {LOW, LOW}},
{Module::MODE_RX, {HIGH, LOW}},
{Module::MODE_TX, {HIGH, HIGH}},
-
Module::END_OF_MODE_TABLE,
+
Module::END_OF_MODE_TABLE,
};
void setup() {
@@ -1649,11 +1649,10 @@ void  radio.setRfSwitchTable(rfswitch_pins, rfswitch_table);
...
}
-
static const RfSwitchMode_t END_OF_MODE_TABLE
Definition: Module.h:65
-
@ MODE_TX
Definition: Module.h:56
-
@ MODE_IDLE
Definition: Module.h:52
-
@ MODE_RX
Definition: Module.h:54
-
Definition: Module.h:34
+
@ MODE_TX
Definition: Module.h:64
+
@ MODE_IDLE
Definition: Module.h:60
+
@ MODE_RX
Definition: Module.h:62
+
Definition: Module.h:42
diff --git a/class_module-members.html b/class_module-members.html index 1f954485..523f5333 100644 --- a/class_module-members.html +++ b/class_module-members.html @@ -98,65 +98,64 @@ $(document).ready(function(){initNavTree('class_module.html',''); initResizable( digitalRead(RADIOLIB_PIN_TYPE pin)Module digitalWrite(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_STATUS value)Module end()Module - END_OF_MODE_TABLEModulestatic - endTransaction()Module - findRfSwitchMode(uint8_t mode) constModule - flipBits(uint8_t b)Modulestatic - flipBits16(uint16_t i)Modulestatic - getCs() constModuleinline - getGpio() constModuleinline - getIrq() constModuleinline - getRst() constModuleinline - hexdump(uint8_t *data, size_t len, uint32_t offset=0, uint8_t width=1, bool be=false)Modulestatic - init()Module - micros()Module - millis()Module - MODE_END_OF_TABLE enum valueModule - MODE_IDLE enum valueModule - MODE_RX enum valueModule - MODE_TX enum valueModule - Module(RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE gpio=RADIOLIB_NC)Module - Module(const Module &mod)Module - noTone(RADIOLIB_PIN_TYPE pin)Module - operator=(const Module &mod)Module - OpMode_t enum nameModule - pinMode(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_MODE mode)Module - pulseIn(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_STATUS state, uint32_t timeout)Module - regdump(uint16_t start, size_t len)Module - RFSWITCH_MAX_PINSModulestatic - setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)Module - setRfSwitchState(uint8_t mode)Module - setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[RFSWITCH_MAX_PINS], const RfSwitchMode_t table[])Module - SPIaddrWidthModule - SPIbeginTransaction() (defined in Module)Modulevirtual - SPIcheckStream()Module - SPIendTransaction() (defined in Module)Modulevirtual - SPIgetRegValue(uint16_t reg, uint8_t msb=7, uint8_t lsb=0)Module - SPInopCommandModule - SPIparseStatusCbModule - SPIparseStatusCb_t typedefModule - SPIreadCommandModule - SPIreadRegister(uint16_t reg)Module - SPIreadRegisterBurst(uint16_t reg, size_t numBytes, uint8_t *inBytes)Module - SPIreadStream(uint8_t cmd, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)Module - SPIreadStream(uint8_t *cmd, uint8_t cmdLen, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)Module - SPIsetRegValue(uint16_t reg, uint8_t value, uint8_t msb=7, uint8_t lsb=0, uint8_t checkInterval=2, uint8_t checkMask=0xFF)Module - SPIstatusCommandModule - SPIstreamErrorModule - SPIstreamTypeModule - SPItransfer(uint8_t cmd, uint16_t reg, uint8_t *dataOut, uint8_t *dataIn, size_t numBytes)Module - SPItransfer(uint8_t b) (defined in Module)Modulevirtual - SPItransferStream(uint8_t *cmd, uint8_t cmdLen, bool write, uint8_t *dataOut, uint8_t *dataIn, size_t numBytes, bool waitForGpio, uint32_t timeout)Module - SPIwriteCommandModule - SPIwriteRegister(uint16_t reg, uint8_t data)Module - SPIwriteRegisterBurst(uint16_t reg, uint8_t *data, size_t numBytes)Module - SPIwriteStream(uint8_t cmd, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)Module - SPIwriteStream(uint8_t *cmd, uint8_t cmdLen, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)Module - term()Module - tone(RADIOLIB_PIN_TYPE pin, uint16_t value, uint32_t duration=0)Module - transfer(uint8_t b)Module - waitForMicroseconds(uint32_t start, uint32_t len)Module - yield()Module + endTransaction()Module + findRfSwitchMode(uint8_t mode) constModule + flipBits(uint8_t b)Modulestatic + flipBits16(uint16_t i)Modulestatic + getCs() constModuleinline + getGpio() constModuleinline + getIrq() constModuleinline + getRst() constModuleinline + hexdump(uint8_t *data, size_t len, uint32_t offset=0, uint8_t width=1, bool be=false)Modulestatic + init()Module + micros()Module + millis()Module + MODE_END_OF_TABLE enum valueModule + MODE_IDLE enum valueModule + MODE_RX enum valueModule + MODE_TX enum valueModule + Module(RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE gpio=RADIOLIB_NC)Module + Module(const Module &mod)Module + noTone(RADIOLIB_PIN_TYPE pin)Module + operator=(const Module &mod)Module + OpMode_t enum nameModule + pinMode(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_MODE mode)Module + pulseIn(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_STATUS state, uint32_t timeout)Module + regdump(uint16_t start, size_t len)Module + RFSWITCH_MAX_PINSModulestatic + setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)Module + setRfSwitchState(uint8_t mode)Module + setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[RFSWITCH_MAX_PINS], const RfSwitchMode_t table[])Module + SPIaddrWidthModule + SPIbeginTransaction() (defined in Module)Modulevirtual + SPIcheckStream()Module + SPIendTransaction() (defined in Module)Modulevirtual + SPIgetRegValue(uint16_t reg, uint8_t msb=7, uint8_t lsb=0)Module + SPInopCommandModule + SPIparseStatusCbModule + SPIparseStatusCb_t typedefModule + SPIreadCommandModule + SPIreadRegister(uint16_t reg)Module + SPIreadRegisterBurst(uint16_t reg, size_t numBytes, uint8_t *inBytes)Module + SPIreadStream(uint8_t cmd, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)Module + SPIreadStream(uint8_t *cmd, uint8_t cmdLen, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)Module + SPIsetRegValue(uint16_t reg, uint8_t value, uint8_t msb=7, uint8_t lsb=0, uint8_t checkInterval=2, uint8_t checkMask=0xFF)Module + SPIstatusCommandModule + SPIstreamErrorModule + SPIstreamTypeModule + SPItransfer(uint8_t cmd, uint16_t reg, uint8_t *dataOut, uint8_t *dataIn, size_t numBytes)Module + SPItransfer(uint8_t b) (defined in Module)Modulevirtual + SPItransferStream(uint8_t *cmd, uint8_t cmdLen, bool write, uint8_t *dataOut, uint8_t *dataIn, size_t numBytes, bool waitForGpio, uint32_t timeout)Module + SPIwriteCommandModule + SPIwriteRegister(uint16_t reg, uint8_t data)Module + SPIwriteRegisterBurst(uint16_t reg, uint8_t *data, size_t numBytes)Module + SPIwriteStream(uint8_t cmd, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)Module + SPIwriteStream(uint8_t *cmd, uint8_t cmdLen, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)Module + term()Module + tone(RADIOLIB_PIN_TYPE pin, uint16_t value, uint32_t duration=0)Module + transfer(uint8_t b)Module + waitForMicroseconds(uint32_t start, uint32_t len)Module + yield()Module diff --git a/class_module.html b/class_module.html index ffa2a5e9..3bc18dd9 100644 --- a/class_module.html +++ b/class_module.html @@ -342,8 +342,6 @@ Static Public Attributes static const size_t RFSWITCH_MAX_PINS = 3  The maximum number of pins supported by the RF switch code. More...
  -static const RfSwitchMode_t END_OF_MODE_TABLE

Detailed Description

Implements all common low-level methods to control the wireless module. Every module class contains one private instance of this class.

@@ -362,7 +360,7 @@ Static Public Attributes

Constants to use in a mode table set be setRfSwitchTable. These constants work for most radios, but some radios define their own constants to be used instead.

See setRfSwitchTable() for details.

- @@ -1082,7 +1080,7 @@ Static Public Attributes
{Module::MODE_IDLE, {LOW, LOW}},
{Module::MODE_RX, {HIGH, LOW}},
{Module::MODE_TX, {HIGH, HIGH}},
- +
Module::END_OF_MODE_TABLE,
};
void setup() {
@@ -1091,11 +1089,10 @@ Static Public Attributes
radio.setRfSwitchTable(rfswitch_pins, rfswitch_table);
...
}
-
static const RfSwitchMode_t END_OF_MODE_TABLE
Definition: Module.h:65
-
@ MODE_TX
Definition: Module.h:56
-
@ MODE_IDLE
Definition: Module.h:52
-
@ MODE_RX
Definition: Module.h:54
-
Definition: Module.h:34
+
@ MODE_TX
Definition: Module.h:64
+
@ MODE_IDLE
Definition: Module.h:60
+
@ MODE_RX
Definition: Module.h:62
+
Definition: Module.h:42
@@ -1851,30 +1848,6 @@ Static Public Attributes

Member Data Documentation

- -

◆ END_OF_MODE_TABLE

- -
-
-
Enumerator
MODE_END_OF_TABLE 

End of table marker, use END_OF_MODE_TABLE constant instead. Value is zero to ensure zero-initialized mode ends the table

+
Enumerator
MODE_END_OF_TABLE 

End of table marker, use END_OF_MODE_TABLE constant instead. Value is zero to ensure zero-initialized mode ends the table

MODE_IDLE 

Idle mode

- - - - -
- - - - -
const RfSwitchMode_t Module::END_OF_MODE_TABLE
-
-static
-
-

Value to use as the last element in a mode table to indicate the end of the table.

-

See setRfSwitchTable() for details.

- -
-

◆ RFSWITCH_MAX_PINS

diff --git a/class_r_f69.html b/class_r_f69.html index e5b19cea..e8a76591 100644 --- a/class_r_f69.html +++ b/class_r_f69.html @@ -2050,7 +2050,7 @@ void  {Module::MODE_IDLE, {LOW, LOW}},
{Module::MODE_RX, {HIGH, LOW}},
{Module::MODE_TX, {HIGH, HIGH}},
-
Module::END_OF_MODE_TABLE,
+
Module::END_OF_MODE_TABLE,
};
void setup() {
@@ -2059,11 +2059,10 @@ void  radio.setRfSwitchTable(rfswitch_pins, rfswitch_table);
...
}
-
static const RfSwitchMode_t END_OF_MODE_TABLE
Definition: Module.h:65
-
@ MODE_TX
Definition: Module.h:56
-
@ MODE_IDLE
Definition: Module.h:52
-
@ MODE_RX
Definition: Module.h:54
-
Definition: Module.h:34
+
@ MODE_TX
Definition: Module.h:64
+
@ MODE_IDLE
Definition: Module.h:60
+
@ MODE_RX
Definition: Module.h:62
+
Definition: Module.h:42
diff --git a/class_s_t_m32_w_lx-members.html b/class_s_t_m32_w_lx-members.html index 16f8d753..2243038b 100644 --- a/class_s_t_m32_w_lx-members.html +++ b/class_s_t_m32_w_lx-members.html @@ -99,106 +99,105 @@ $(document).ready(function(){initNavTree('class_s_t_m32_w_lx.html',''); initResi clearDio1Action()STM32WLx disableAddressFiltering()SX126x dropSync()PhysicalLayer - END_OF_MODE_TABLESTM32WLxstatic - explicitHeader()SX126x - finishTransmit() overrideSX126xvirtual - fixedPacketLengthMode(uint8_t len=RADIOLIB_SX126X_MAX_PACKET_LENGTH)SX126x - forceLDRO(bool enable)SX126x - getChannelScanResult()SX126x - getCurrentLimit()SX126x - getDataRate() constSX126x - getFreqStep() constPhysicalLayer - getIrqStatus()SX126x - getMod() (defined in SX126x)SX126xvirtual - getPacketLength(bool update=true) overrideSX126xvirtual - getRSSI()SX126x - getRSSIInst()SX126x - getSNR()SX126x - getTimeOnAir(size_t len)SX126x - implicitHeader(size_t len)SX126x - MODE_END_OF_TABLE enum valueSTM32WLx - MODE_IDLE enum valueSTM32WLx - MODE_RX enum valueSTM32WLx - MODE_TX_HP enum valueSTM32WLx - MODE_TX_LP enum valueSTM32WLx - OpMode_t enum nameSTM32WLx - PhysicalLayer(float freqStep, size_t maxPacketLength)PhysicalLayer - random(int32_t max)PhysicalLayer - random(int32_t min, int32_t max)PhysicalLayer - randomByte()SX126xvirtual - read(bool drop=true)PhysicalLayer - readBit(RADIOLIB_PIN_TYPE pin)SX126xvirtual - readData(uint8_t *data, size_t len) overrideSX126xvirtual - readData(String &str, size_t len=0)SX126x - readData(uint8_t *data, size_t len)SX126x - PhysicalLayer::readData(String &str, size_t len=0)PhysicalLayer - receive(uint8_t *data, size_t len) overrideSX126xvirtual - receive(String &str, size_t len=0)SX126x - receive(uint8_t *data, size_t len)SX126x - PhysicalLayer::receive(String &str, size_t len=0)PhysicalLayer - receiveDirect() overrideSX126xvirtual - reset(bool verify=true)SX126x - scanChannel(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x - setBandwidth(float bw)SX126x - setBitRate(float br)SX126xvirtual - setBroadcastAddress(uint8_t broadAddr)SX126x - setCodingRate(uint8_t cr)SX126x - setCRC(uint8_t len, uint16_t initial=0x1D0F, uint16_t polynomial=0x1021, bool inverted=true)SX126x - setCurrentLimit(float currentLimit)SX126x - setDataShaping(uint8_t sh) overrideSX126xvirtual - setDio1Action(void(*func)(void))STM32WLx - setDio2AsRfSwitch(bool enable=true)SX126x - setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value)PhysicalLayervirtual - setDirectAction(void(*func)(void))SX126xvirtual - setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer - setEncoding(uint8_t encoding) overrideSX126xvirtual - setFrequency(float freq)SX1262virtual - setFrequency(float freq, bool calibrate)SX1262 - setFrequencyDeviation(float freqDev) overrideSX126xvirtual - setNodeAddress(uint8_t nodeAddr)SX126x - setOutputPower(int8_t power) overrideSTM32WLxvirtual - setPreambleLength(uint16_t preambleLength)SX126x - setRegulatorDCDC()SX126x - setRegulatorLDO()SX126x - setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)SX126x - setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])STM32WLx - SX1262::setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])SX126x - setRxBandwidth(float rxBw)SX126x - setRxBoostedGainMode(bool rxbgm, bool persist=true)SX126x - setSpreadingFactor(uint8_t sf)SX126x - setSyncBits(uint8_t *syncWord, uint8_t bitsLen)SX126x - setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)SX126x - setSyncWord(uint8_t *syncWord, uint8_t len)SX126x - setTCXO(float voltage, uint32_t delay=5000)SX126x - setWhitening(bool enabled, uint16_t initial=0x0100)SX126x - sleep(bool retainConfig=true)SX126x - standby() overrideSX126xvirtual - standby(uint8_t mode)SX126xvirtual - startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x - startDirect()PhysicalLayer - startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)SX126x - startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)SX126x - startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)SX126x - startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual - startTransmit(String &str, uint8_t addr=0)SX126x - startTransmit(const char *str, uint8_t addr=0)SX126x - startTransmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x - PhysicalLayer::startTransmit(String &str, uint8_t addr=0)PhysicalLayer - PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer - STM32WLx(STM32WLx_Module *mod)STM32WLx - SX1262(Module *mod)SX1262 - SX126x(Module *mod)SX126x - transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual - transmit(__FlashStringHelper *fstr, uint8_t addr=0)SX126x - transmit(String &str, uint8_t addr=0)SX126x - transmit(const char *str, uint8_t addr=0)SX126x - transmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x - PhysicalLayer::transmit(__FlashStringHelper *fstr, uint8_t addr=0)PhysicalLayer - PhysicalLayer::transmit(String &str, uint8_t addr=0)PhysicalLayer - PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer - transmitDirect(uint32_t frf=0) overrideSX126xvirtual - variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX126X_MAX_PACKET_LENGTH)SX126x - XTALSX126x + explicitHeader()SX126x + finishTransmit() overrideSX126xvirtual + fixedPacketLengthMode(uint8_t len=RADIOLIB_SX126X_MAX_PACKET_LENGTH)SX126x + forceLDRO(bool enable)SX126x + getChannelScanResult()SX126x + getCurrentLimit()SX126x + getDataRate() constSX126x + getFreqStep() constPhysicalLayer + getIrqStatus()SX126x + getMod() (defined in SX126x)SX126xvirtual + getPacketLength(bool update=true) overrideSX126xvirtual + getRSSI()SX126x + getRSSIInst()SX126x + getSNR()SX126x + getTimeOnAir(size_t len)SX126x + implicitHeader(size_t len)SX126x + MODE_END_OF_TABLE enum valueSTM32WLx + MODE_IDLE enum valueSTM32WLx + MODE_RX enum valueSTM32WLx + MODE_TX_HP enum valueSTM32WLx + MODE_TX_LP enum valueSTM32WLx + OpMode_t enum nameSTM32WLx + PhysicalLayer(float freqStep, size_t maxPacketLength)PhysicalLayer + random(int32_t max)PhysicalLayer + random(int32_t min, int32_t max)PhysicalLayer + randomByte()SX126xvirtual + read(bool drop=true)PhysicalLayer + readBit(RADIOLIB_PIN_TYPE pin)SX126xvirtual + readData(uint8_t *data, size_t len) overrideSX126xvirtual + readData(String &str, size_t len=0)SX126x + readData(uint8_t *data, size_t len)SX126x + PhysicalLayer::readData(String &str, size_t len=0)PhysicalLayer + receive(uint8_t *data, size_t len) overrideSX126xvirtual + receive(String &str, size_t len=0)SX126x + receive(uint8_t *data, size_t len)SX126x + PhysicalLayer::receive(String &str, size_t len=0)PhysicalLayer + receiveDirect() overrideSX126xvirtual + reset(bool verify=true)SX126x + scanChannel(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x + setBandwidth(float bw)SX126x + setBitRate(float br)SX126xvirtual + setBroadcastAddress(uint8_t broadAddr)SX126x + setCodingRate(uint8_t cr)SX126x + setCRC(uint8_t len, uint16_t initial=0x1D0F, uint16_t polynomial=0x1021, bool inverted=true)SX126x + setCurrentLimit(float currentLimit)SX126x + setDataShaping(uint8_t sh) overrideSX126xvirtual + setDio1Action(void(*func)(void))STM32WLx + setDio2AsRfSwitch(bool enable=true)SX126x + setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value)PhysicalLayervirtual + setDirectAction(void(*func)(void))SX126xvirtual + setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer + setEncoding(uint8_t encoding) overrideSX126xvirtual + setFrequency(float freq)SX1262virtual + setFrequency(float freq, bool calibrate)SX1262 + setFrequencyDeviation(float freqDev) overrideSX126xvirtual + setNodeAddress(uint8_t nodeAddr)SX126x + setOutputPower(int8_t power) overrideSTM32WLxvirtual + setPreambleLength(uint16_t preambleLength)SX126x + setRegulatorDCDC()SX126x + setRegulatorLDO()SX126x + setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)SX126x + setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])STM32WLx + SX1262::setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])SX126x + setRxBandwidth(float rxBw)SX126x + setRxBoostedGainMode(bool rxbgm, bool persist=true)SX126x + setSpreadingFactor(uint8_t sf)SX126x + setSyncBits(uint8_t *syncWord, uint8_t bitsLen)SX126x + setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)SX126x + setSyncWord(uint8_t *syncWord, uint8_t len)SX126x + setTCXO(float voltage, uint32_t delay=5000)SX126x + setWhitening(bool enabled, uint16_t initial=0x0100)SX126x + sleep(bool retainConfig=true)SX126x + standby() overrideSX126xvirtual + standby(uint8_t mode)SX126xvirtual + startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x + startDirect()PhysicalLayer + startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)SX126x + startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)SX126x + startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)SX126x + startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual + startTransmit(String &str, uint8_t addr=0)SX126x + startTransmit(const char *str, uint8_t addr=0)SX126x + startTransmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x + PhysicalLayer::startTransmit(String &str, uint8_t addr=0)PhysicalLayer + PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer + STM32WLx(STM32WLx_Module *mod)STM32WLx + SX1262(Module *mod)SX1262 + SX126x(Module *mod)SX126x + transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideSX126xvirtual + transmit(__FlashStringHelper *fstr, uint8_t addr=0)SX126x + transmit(String &str, uint8_t addr=0)SX126x + transmit(const char *str, uint8_t addr=0)SX126x + transmit(uint8_t *data, size_t len, uint8_t addr=0)SX126x + PhysicalLayer::transmit(__FlashStringHelper *fstr, uint8_t addr=0)PhysicalLayer + PhysicalLayer::transmit(String &str, uint8_t addr=0)PhysicalLayer + PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer + transmitDirect(uint32_t frf=0) overrideSX126xvirtual + variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX126X_MAX_PACKET_LENGTH)SX126x + XTALSX126x diff --git a/class_s_t_m32_w_lx.html b/class_s_t_m32_w_lx.html index e7db7ee0..977da279 100644 --- a/class_s_t_m32_w_lx.html +++ b/class_s_t_m32_w_lx.html @@ -85,7 +85,6 @@ $(document).ready(function(){initNavTree('class_s_t_m32_w_lx.html',''); initResi
Public Types | Public Member Functions | -Static Public Attributes | List of all members
STM32WLx Class Reference
@@ -449,11 +448,6 @@ void  Configure DIO pin mapping to get a given signal on a DIO pin (if available). More...
  - - - -

-Static Public Attributes

static const Module::RfSwitchMode_t END_OF_MODE_TABLE = {Module::MODE_END_OF_TABLE, {}}
 
@@ -482,7 +476,7 @@ bool  - -

Additional Inherited Members

- Public Attributes inherited from SX126x
setRfSwitchTable() method, instead of the Module::OpMode_t constants.

- @@ -774,33 +768,6 @@ bool  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Enumerator
MODE_END_OF_TABLE 

End of table marker, use END_OF_MODE_TABLE constant instead

+
Enumerator
MODE_END_OF_TABLE 

End of table marker, use END_OF_MODE_TABLE constant instead

MODE_IDLE 

Idle mode

setOutputPower() accordingly).

Note that the setRfSwitchTable() method should be called before the begin() method, to ensure the radio knows which modes are supported during initialization.

- - -

Member Data Documentation

- -

◆ END_OF_MODE_TABLE

- -
-
- - - - - -
- - - - -
const Module::RfSwitchMode_t STM32WLx::END_OF_MODE_TABLE = {Module::MODE_END_OF_TABLE, {}}
-
-static
-
- -

-

Value to use as the last element in a mode table to indicate the end of the table.

-

See setRfSwitchTable() for details.

-

The documentation for this class was generated from the following files:
    diff --git a/class_s_t_m32_w_lx___module-members.html b/class_s_t_m32_w_lx___module-members.html index f56f85c7..9453df55 100644 --- a/class_s_t_m32_w_lx___module-members.html +++ b/class_s_t_m32_w_lx___module-members.html @@ -98,66 +98,65 @@ $(document).ready(function(){initNavTree('class_s_t_m32_w_lx___module.html','');
digitalRead(RADIOLIB_PIN_TYPE pin)Module
digitalWrite(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_STATUS value)Module
end()Module
END_OF_MODE_TABLEModulestatic
endTransaction()Module
findRfSwitchMode(uint8_t mode) constModule
flipBits(uint8_t b)Modulestatic
flipBits16(uint16_t i)Modulestatic
getCs() constModuleinline
getGpio() constModuleinline
getIrq() constModuleinline
getRst() constModuleinline
hexdump(uint8_t *data, size_t len, uint32_t offset=0, uint8_t width=1, bool be=false)Modulestatic
init()Module
micros()Module
millis()Module
MODE_END_OF_TABLE enum valueModule
MODE_IDLE enum valueModule
MODE_RX enum valueModule
MODE_TX enum valueModule
Module(RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE gpio=RADIOLIB_NC)Module
Module(const Module &mod)Module
noTone(RADIOLIB_PIN_TYPE pin)Module
operator=(const Module &mod)Module
OpMode_t enum nameModule
pinMode(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_MODE mode)Module
pulseIn(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_STATUS state, uint32_t timeout)Module
regdump(uint16_t start, size_t len)Module
RFSWITCH_MAX_PINSModulestatic
setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)Module
setRfSwitchState(uint8_t mode)Module
setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[RFSWITCH_MAX_PINS], const RfSwitchMode_t table[])Module
SPIaddrWidthModule
SPIbeginTransaction() (defined in Module)Modulevirtual
SPIcheckStream()Module
SPIendTransaction() (defined in Module)Modulevirtual
SPIgetRegValue(uint16_t reg, uint8_t msb=7, uint8_t lsb=0)Module
SPInopCommandModule
SPIparseStatusCbModule
SPIparseStatusCb_t typedefModule
SPIreadCommandModule
SPIreadRegister(uint16_t reg)Module
SPIreadRegisterBurst(uint16_t reg, size_t numBytes, uint8_t *inBytes)Module
SPIreadStream(uint8_t cmd, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)Module
SPIreadStream(uint8_t *cmd, uint8_t cmdLen, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)Module
SPIsetRegValue(uint16_t reg, uint8_t value, uint8_t msb=7, uint8_t lsb=0, uint8_t checkInterval=2, uint8_t checkMask=0xFF)Module
SPIstatusCommandModule
SPIstreamErrorModule
SPIstreamTypeModule
SPItransfer(uint8_t cmd, uint16_t reg, uint8_t *dataOut, uint8_t *dataIn, size_t numBytes)Module
SPItransfer(uint8_t b) (defined in Module)Modulevirtual
SPItransferStream(uint8_t *cmd, uint8_t cmdLen, bool write, uint8_t *dataOut, uint8_t *dataIn, size_t numBytes, bool waitForGpio, uint32_t timeout)Module
SPIwriteCommandModule
SPIwriteRegister(uint16_t reg, uint8_t data)Module
SPIwriteRegisterBurst(uint16_t reg, uint8_t *data, size_t numBytes)Module
SPIwriteStream(uint8_t cmd, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)Module
SPIwriteStream(uint8_t *cmd, uint8_t cmdLen, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)Module
STM32WLx_Module() (defined in STM32WLx_Module)STM32WLx_Module
term()Module
tone(RADIOLIB_PIN_TYPE pin, uint16_t value, uint32_t duration=0)Module
transfer(uint8_t b)Module
waitForMicroseconds(uint32_t start, uint32_t len)Module
yield()Module
endTransaction()Module
findRfSwitchMode(uint8_t mode) constModule
flipBits(uint8_t b)Modulestatic
flipBits16(uint16_t i)Modulestatic
getCs() constModuleinline
getGpio() constModuleinline
getIrq() constModuleinline
getRst() constModuleinline
hexdump(uint8_t *data, size_t len, uint32_t offset=0, uint8_t width=1, bool be=false)Modulestatic
init()Module
micros()Module
millis()Module
MODE_END_OF_TABLE enum valueModule
MODE_IDLE enum valueModule
MODE_RX enum valueModule
MODE_TX enum valueModule
Module(RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE gpio=RADIOLIB_NC)Module
Module(const Module &mod)Module
noTone(RADIOLIB_PIN_TYPE pin)Module
operator=(const Module &mod)Module
OpMode_t enum nameModule
pinMode(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_MODE mode)Module
pulseIn(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_STATUS state, uint32_t timeout)Module
regdump(uint16_t start, size_t len)Module
RFSWITCH_MAX_PINSModulestatic
setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)Module
setRfSwitchState(uint8_t mode)Module
setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[RFSWITCH_MAX_PINS], const RfSwitchMode_t table[])Module
SPIaddrWidthModule
SPIbeginTransaction() (defined in Module)Modulevirtual
SPIcheckStream()Module
SPIendTransaction() (defined in Module)Modulevirtual
SPIgetRegValue(uint16_t reg, uint8_t msb=7, uint8_t lsb=0)Module
SPInopCommandModule
SPIparseStatusCbModule
SPIparseStatusCb_t typedefModule
SPIreadCommandModule
SPIreadRegister(uint16_t reg)Module
SPIreadRegisterBurst(uint16_t reg, size_t numBytes, uint8_t *inBytes)Module
SPIreadStream(uint8_t cmd, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)Module
SPIreadStream(uint8_t *cmd, uint8_t cmdLen, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)Module
SPIsetRegValue(uint16_t reg, uint8_t value, uint8_t msb=7, uint8_t lsb=0, uint8_t checkInterval=2, uint8_t checkMask=0xFF)Module
SPIstatusCommandModule
SPIstreamErrorModule
SPIstreamTypeModule
SPItransfer(uint8_t cmd, uint16_t reg, uint8_t *dataOut, uint8_t *dataIn, size_t numBytes)Module
SPItransfer(uint8_t b) (defined in Module)Modulevirtual
SPItransferStream(uint8_t *cmd, uint8_t cmdLen, bool write, uint8_t *dataOut, uint8_t *dataIn, size_t numBytes, bool waitForGpio, uint32_t timeout)Module
SPIwriteCommandModule
SPIwriteRegister(uint16_t reg, uint8_t data)Module
SPIwriteRegisterBurst(uint16_t reg, uint8_t *data, size_t numBytes)Module
SPIwriteStream(uint8_t cmd, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)Module
SPIwriteStream(uint8_t *cmd, uint8_t cmdLen, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)Module
STM32WLx_Module() (defined in STM32WLx_Module)STM32WLx_Module
term()Module
tone(RADIOLIB_PIN_TYPE pin, uint16_t value, uint32_t duration=0)Module
transfer(uint8_t b)Module
waitForMicroseconds(uint32_t start, uint32_t len)Module
yield()Module
diff --git a/class_s_t_m32_w_lx___module.html b/class_s_t_m32_w_lx___module.html index 586f2e85..bdaf1ad1 100644 --- a/class_s_t_m32_w_lx___module.html +++ b/class_s_t_m32_w_lx___module.html @@ -321,8 +321,6 @@ int16_t 
static const size_t RFSWITCH_MAX_PINS = 3
 The maximum number of pins supported by the RF switch code. More...
 
static const RfSwitchMode_t END_OF_MODE_TABLE
 

Detailed Description

This is a subclass of Module to be used with the STM32WLx driver.

diff --git a/class_s_x126x.html b/class_s_x126x.html index 01c47fe4..348fcaae 100644 --- a/class_s_x126x.html +++ b/class_s_x126x.html @@ -1867,7 +1867,7 @@ bool  {Module::MODE_IDLE, {LOW, LOW}},
{Module::MODE_RX, {HIGH, LOW}},
{Module::MODE_TX, {HIGH, HIGH}},
-
Module::END_OF_MODE_TABLE,
+
Module::END_OF_MODE_TABLE,
};
void setup() {
@@ -1876,11 +1876,10 @@ bool  radio.setRfSwitchTable(rfswitch_pins, rfswitch_table);
...
}
-
static const RfSwitchMode_t END_OF_MODE_TABLE
Definition: Module.h:65
-
@ MODE_TX
Definition: Module.h:56
-
@ MODE_IDLE
Definition: Module.h:52
-
@ MODE_RX
Definition: Module.h:54
-
Definition: Module.h:34
+
@ MODE_TX
Definition: Module.h:64
+
@ MODE_IDLE
Definition: Module.h:60
+
@ MODE_RX
Definition: Module.h:62
+
Definition: Module.h:42
diff --git a/class_s_x127x.html b/class_s_x127x.html index b49d38df..997668c7 100644 --- a/class_s_x127x.html +++ b/class_s_x127x.html @@ -2232,7 +2232,7 @@ void  {Module::MODE_IDLE, {LOW, LOW}},
{Module::MODE_RX, {HIGH, LOW}},
{Module::MODE_TX, {HIGH, HIGH}},
-
Module::END_OF_MODE_TABLE,
+
Module::END_OF_MODE_TABLE,
};
void setup() {
@@ -2241,11 +2241,10 @@ void  radio.setRfSwitchTable(rfswitch_pins, rfswitch_table);
...
}
-
static const RfSwitchMode_t END_OF_MODE_TABLE
Definition: Module.h:65
-
@ MODE_TX
Definition: Module.h:56
-
@ MODE_IDLE
Definition: Module.h:52
-
@ MODE_RX
Definition: Module.h:54
-
Definition: Module.h:34
+
@ MODE_TX
Definition: Module.h:64
+
@ MODE_IDLE
Definition: Module.h:60
+
@ MODE_RX
Definition: Module.h:62
+
Definition: Module.h:42
diff --git a/class_s_x128x.html b/class_s_x128x.html index 88710a0e..53ccc623 100644 --- a/class_s_x128x.html +++ b/class_s_x128x.html @@ -1773,7 +1773,7 @@ void  {Module::MODE_IDLE, {LOW, LOW}},
{Module::MODE_RX, {HIGH, LOW}},
{Module::MODE_TX, {HIGH, HIGH}},
-
Module::END_OF_MODE_TABLE,
+
Module::END_OF_MODE_TABLE,
};
void setup() {
@@ -1782,11 +1782,10 @@ void  radio.setRfSwitchTable(rfswitch_pins, rfswitch_table);
...
}
-
static const RfSwitchMode_t END_OF_MODE_TABLE
Definition: Module.h:65
-
@ MODE_TX
Definition: Module.h:56
-
@ MODE_IDLE
Definition: Module.h:52
-
@ MODE_RX
Definition: Module.h:54
-
Definition: Module.h:34
+
@ MODE_TX
Definition: Module.h:64
+
@ MODE_IDLE
Definition: Module.h:60
+
@ MODE_RX
Definition: Module.h:62
+
Definition: Module.h:42
diff --git a/class_si443x.html b/class_si443x.html index 17ca121d..6fae5a27 100644 --- a/class_si443x.html +++ b/class_si443x.html @@ -1135,7 +1135,7 @@ void  {Module::MODE_IDLE, {LOW, LOW}},
{Module::MODE_RX, {HIGH, LOW}},
{Module::MODE_TX, {HIGH, HIGH}},
-
Module::END_OF_MODE_TABLE,
+
Module::END_OF_MODE_TABLE,
};
void setup() {
@@ -1144,11 +1144,10 @@ void  radio.setRfSwitchTable(rfswitch_pins, rfswitch_table);
...
}
-
static const RfSwitchMode_t END_OF_MODE_TABLE
Definition: Module.h:65
-
@ MODE_TX
Definition: Module.h:56
-
@ MODE_IDLE
Definition: Module.h:52
-
@ MODE_RX
Definition: Module.h:54
-
Definition: Module.h:34
+
@ MODE_TX
Definition: Module.h:64
+
@ MODE_IDLE
Definition: Module.h:60
+
@ MODE_RX
Definition: Module.h:62
+
Definition: Module.h:42
diff --git a/functions_e.html b/functions_e.html index b3353e70..ef214acf 100644 --- a/functions_e.html +++ b/functions_e.html @@ -101,10 +101,6 @@ $(document).ready(function(){initNavTree('functions_e.html',''); initResizable()
  • end() : Module
  • -
  • END_OF_MODE_TABLE -: Module -, STM32WLx -
  • endTransaction() : Module
  • diff --git a/functions_vars.html b/functions_vars.html index 6cda2e57..5ab91080 100644 --- a/functions_vars.html +++ b/functions_vars.html @@ -101,14 +101,6 @@ $(document).ready(function(){initNavTree('functions_vars.html',''); initResizabl -

    - e -

    - -

    - f -