diff --git a/_c_c1101_8h_source.html b/_c_c1101_8h_source.html
index e4140041..1ea0f4af 100644
--- a/_c_c1101_8h_source.html
+++ b/_c_c1101_8h_source.html
@@ -767,7 +767,7 @@ $(document).ready(function(){initNavTree('_c_c1101_8h_source.html',''); initResi
int16_t packetMode()
Stops direct mode. It is required to call this method to switch from direct transmissions to packet-b...
Definition: CC1101.cpp:207
int16_t begin(float freq=434.0, float br=48.0, float freqDev=48.0, float rxBw=135.0, int8_t power=10, uint8_t preambleLength=16)
Initialization method.
Definition: CC1101.cpp:8
int16_t setPreambleLength(uint8_t preambleLength)
Sets preamble length.
Definition: CC1101.cpp:608
Implements all common low-level SPI/UART/I2C methods to control the wireless module....
Definition: Module.h:17
Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...
Definition: Module.h:17
int16_t receive(uint8_t *data, size_t len) override
Blocking binary receive method. Overloads for string-based transmissions are implemented in PhysicalL...
Definition: CC1101.cpp:139
void readBit(RADIOLIB_PIN_TYPE pin)
Function to read and process data bit in direct reception mode.
Definition: CC1101.cpp:865
int16_t receiveDirect() override
Starts direct mode reception.
Definition: CC1101.cpp:194
ESP8266(Module *module)
Default constructor.
Definition: ESP8266.cpp:4
int16_t send(const char *data) override
Send string-based data.
Definition: ESP8266.cpp:133
int16_t openTransportConnection(const char *host, const char *protocol, uint16_t port, uint16_t tcpKeepAlive=0) override
Open transport layer connection.
Definition: ESP8266.cpp:85
Implements all common low-level SPI/UART/I2C methods to control the wireless module....
Definition: Module.h:17
Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...
Definition: Module.h:17
Provides common interface for protocols that run on modules with Internet connectivity,...
Definition: TransportLayer.h:12
diff --git a/_h_c05_8h_source.html b/_h_c05_8h_source.html
index c6826d95..56ac889c 100644
--- a/_h_c05_8h_source.html
+++ b/_h_c05_8h_source.html
@@ -104,7 +104,7 @@ $(document).ready(function(){initNavTree('_h_c05_8h_source.html',''); initResiza
void begin(long speed)
Initialization method.
Definition: HC05.cpp:8
Interface class for Arduino Serial. Only calls the appropriate methods for the active UART interface.
Definition: ISerial.h:11
Control class for HC05 module. Most methods supported by this module are implemented in ISerial inter...
Definition: HC05.h:12
-
Implements all common low-level SPI/UART/I2C methods to control the wireless module....
Definition: Module.h:17
+
Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...
Definition: Module.h:17
HC05(Module *mod)
Default constructor.
Definition: HC05.cpp:4
diff --git a/_i_serial_8h_source.html b/_i_serial_8h_source.html
index b9e86b10..506ff222 100644
--- a/_i_serial_8h_source.html
+++ b/_i_serial_8h_source.html
@@ -142,7 +142,7 @@ $(document).ready(function(){initNavTree('_i_serial_8h_source.html',''); initRes
Interface class for Arduino Serial. Only calls the appropriate methods for the active UART interface.
Definition: ISerial.h:11
Implements all common low-level SPI/UART/I2C methods to control the wireless module....
Definition: Module.h:17
Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...
Definition: Module.h:17
diff --git a/_j_d_y08_8h_source.html b/_j_d_y08_8h_source.html
index b57470fc..48b60bc4 100644
--- a/_j_d_y08_8h_source.html
+++ b/_j_d_y08_8h_source.html
@@ -104,7 +104,7 @@ $(document).ready(function(){initNavTree('_j_d_y08_8h_source.html',''); initResi
JDY08(Module *mod)
Default constructor.
Definition: JDY08.cpp:4
Control class for JDY08 module. Most methods supported by this module are implemented in ISerial inte...
Definition: JDY08.h:12
Interface class for Arduino Serial. Only calls the appropriate methods for the active UART interface.
Definition: ISerial.h:11
Implements all common low-level SPI/UART/I2C methods to control the wireless module....
Definition: Module.h:17
Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...
Definition: Module.h:17
void begin(long speed)
Initialization method.
Definition: JDY08.cpp:8
diff --git a/_l_l_c_c68_8h_source.html b/_l_l_c_c68_8h_source.html
index 20e6cff0..39226ce7 100644
--- a/_l_l_c_c68_8h_source.html
+++ b/_l_l_c_c68_8h_source.html
@@ -120,7 +120,7 @@ $(document).ready(function(){initNavTree('_l_l_c_c68_8h_source.html',''); initRe
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:13
Derived class for LLCC68 modules.
Definition: LLCC68.h:16
int16_t setBandwidth(float bw)
Sets LoRa bandwidth. Allowed values are 125.0, 250.0 and 500.0 kHz.
Definition: LLCC68.cpp:8
-
Implements all common low-level SPI/UART/I2C methods to control the wireless module....
Definition: Module.h:17
+
Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...
Definition: Module.h:17
Derived class for SX1262 modules.
Definition: SX1262.h:19
LLCC68(Module *mod)
Default constructor.
Definition: LLCC68.cpp:4
diff --git a/_module_8h_source.html b/_module_8h_source.html
index 9fcf6e3c..7917962f 100644
--- a/_module_8h_source.html
+++ b/_module_8h_source.html
@@ -98,199 +98,211 @@ $(document).ready(function(){initNavTree('_module_8h_source.html',''); initResiz
-
-
31 #ifdef RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
-
32 Module (RADIOLIB_PIN_TYPE rx, RADIOLIB_PIN_TYPE tx, HardwareSerial* serial = &RADIOLIB_HARDWARE_SERIAL_PORT, RADIOLIB_PIN_TYPE rst = RADIOLIB_NC);
-
-
34 Module (RADIOLIB_PIN_TYPE rx, RADIOLIB_PIN_TYPE tx, HardwareSerial* serial =
nullptr , RADIOLIB_PIN_TYPE rst = RADIOLIB_NC);
-
-
-
46 Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst);
-
-
59 Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE gpio);
-
-
74 Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, SPIClass& spi, SPISettings spiSettings);
-
-
91 Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE gpio, SPIClass& spi, SPISettings spiSettings = SPISettings(2000000, MSBFIRST, SPI_MODE0));
-
-
112 #ifdef RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
-
113 Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE rx, RADIOLIB_PIN_TYPE tx, SPIClass& spi = RADIOLIB_DEFAULT_SPI, SPISettings spiSettings = SPISettings(2000000, MSBFIRST, SPI_MODE0), HardwareSerial* serial = &RADIOLIB_HARDWARE_SERIAL_PORT);
-
-
115 Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE rx, RADIOLIB_PIN_TYPE tx, SPIClass& spi = RADIOLIB_DEFAULT_SPI, SPISettings spiSettings = SPISettings(2000000, MSBFIRST, SPI_MODE0), HardwareSerial* serial =
nullptr );
-
-
-
+
28 Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst);
+
+
41 Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE gpio);
+
+
56 Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, SPIClass& spi, SPISettings spiSettings);
+
+
73 Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE gpio, SPIClass& spi, SPISettings spiSettings = SPISettings(2000000, MSBFIRST, SPI_MODE0));
+
+
94 #ifdef RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
+
95 Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE rx, RADIOLIB_PIN_TYPE tx, SPIClass& spi = RADIOLIB_DEFAULT_SPI, SPISettings spiSettings = SPISettings(2000000, MSBFIRST, SPI_MODE0), HardwareSerial* serial = &RADIOLIB_HARDWARE_SERIAL_PORT);
+
+
97 Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE rx, RADIOLIB_PIN_TYPE tx, SPIClass& spi = RADIOLIB_DEFAULT_SPI, SPISettings spiSettings = SPISettings(2000000, MSBFIRST, SPI_MODE0), HardwareSerial* serial =
nullptr );
+
+
+
+
+
+
+
+
+
119 #ifdef RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
+
+
+
+
-
-
-
-
-
137 #ifdef RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
152 void init (uint8_t interface);
+
+
159 void term (uint8_t interface);
+
+
-
-
-
170 void init (uint8_t interface);
-
-
177 void term (uint8_t interface);
-
-
-
-
-
-
-
-
-
-
-
-
-
-
226 int16_t
SPIgetRegValue (uint8_t reg, uint8_t msb = 7, uint8_t lsb = 0);
-
-
245 int16_t
SPIsetRegValue (uint8_t reg, uint8_t value, uint8_t msb = 7, uint8_t lsb = 0, uint8_t checkInterval = 2, uint8_t checkMask = 0xFF);
-
-
-
-
-
-
-
-
-
-
300 void SPItransfer (uint8_t cmd, uint8_t reg, uint8_t* dataOut, uint8_t* dataIn, uint8_t numBytes);
-
-
-
-
309 RADIOLIB_PIN_TYPE
getCs ()
const {
return (_cs); }
-
-
316 RADIOLIB_PIN_TYPE
getIrq ()
const {
return (_irq); }
-
-
323 RADIOLIB_PIN_TYPE
getRst ()
const {
return (_rst); }
-
-
330 RADIOLIB_PIN_TYPE
getGpio ()
const {
return (_rx); }
-
-
337 RADIOLIB_PIN_TYPE
getRx ()
const {
return (_rx); }
-
-
344 RADIOLIB_PIN_TYPE
getTx ()
const {
return (_tx); }
-
-
351 SPIClass*
getSpi ()
const {
return (_spi); }
-
-
-
-
-
-
377 void setRfSwitchState (RADIOLIB_PIN_STATUS rxPinState, RADIOLIB_PIN_STATUS txPinState);
-
-
+
+
+
+
+
+
+
+
+
+
+
208 int16_t
SPIgetRegValue (uint8_t reg, uint8_t msb = 7, uint8_t lsb = 0);
+
+
227 int16_t
SPIsetRegValue (uint8_t reg, uint8_t value, uint8_t msb = 7, uint8_t lsb = 0, uint8_t checkInterval = 2, uint8_t checkMask = 0xFF);
+
+
+
+
+
+
+
+
+
+
282 void SPItransfer (uint8_t cmd, uint8_t reg, uint8_t* dataOut, uint8_t* dataIn, uint8_t numBytes);
+
+
+
+
291 RADIOLIB_PIN_TYPE
getCs ()
const {
return (_cs); }
+
+
298 RADIOLIB_PIN_TYPE
getIrq ()
const {
return (_irq); }
+
+
305 RADIOLIB_PIN_TYPE
getRst ()
const {
return (_rst); }
+
+
312 RADIOLIB_PIN_TYPE
getGpio ()
const {
return (_rx); }
+
+
319 RADIOLIB_PIN_TYPE
getRx ()
const {
return (_rx); }
+
+
326 RADIOLIB_PIN_TYPE
getTx ()
const {
return (_tx); }
+
+
333 SPIClass*
getSpi ()
const {
return (_spi); }
+
+
+
+
+
+
359 void setRfSwitchState (RADIOLIB_PIN_STATUS rxPinState, RADIOLIB_PIN_STATUS txPinState);
+
+
+
+
370 static void pinMode (RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_MODE mode);
+
+
379 static void digitalWrite (RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_STATUS value);
-
388 static void pinMode (RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_MODE mode);
+
388 static RADIOLIB_PIN_STATUS
digitalRead (RADIOLIB_PIN_TYPE pin);
-
397 static void digitalWrite (RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_STATUS value);
+
397 static void tone (RADIOLIB_PIN_TYPE pin, uint16_t value);
-
406 static RADIOLIB_PIN_STATUS
digitalRead (RADIOLIB_PIN_TYPE pin);
-
-
415 static void tone (RADIOLIB_PIN_TYPE pin, uint16_t value);
+
404 static void noTone (RADIOLIB_PIN_TYPE pin);
+
+
415 static void attachInterrupt (RADIOLIB_PIN_TYPE interruptNum,
void (*userFunc)(
void ), RADIOLIB_INTERRUPT_STATUS mode);
-
422 static void noTone (RADIOLIB_PIN_TYPE pin);
+
-
433 static void attachInterrupt (RADIOLIB_PIN_TYPE interruptNum,
void (*userFunc)(
void ), RADIOLIB_INTERRUPT_STATUS mode);
-
-
-
-
-
-
452 static void delay (uint32_t ms);
-
-
-
-
-
-
-
-
-
-
-
-
481 #ifndef RADIOLIB_GODMODE
-
-
-
484 RADIOLIB_PIN_TYPE _cs = RADIOLIB_NC;
-
485 RADIOLIB_PIN_TYPE _irq = RADIOLIB_NC;
-
486 RADIOLIB_PIN_TYPE _rst = RADIOLIB_NC;
-
487 RADIOLIB_PIN_TYPE _rx = RADIOLIB_NC;
-
488 RADIOLIB_PIN_TYPE _tx = RADIOLIB_NC;
-
-
490 SPISettings _spiSettings = SPISettings(2000000, MSBFIRST, SPI_MODE0);
+
+
+
434 static void delay (uint32_t ms);
+
+
+
+
+
+
+
+
+
+
+
+
463 #ifndef RADIOLIB_GODMODE
+
+
+
+
+
+
+
470 bool _initInterface =
false ;
+
+
+
473 RADIOLIB_PIN_TYPE _cs = RADIOLIB_NC;
+
474 RADIOLIB_PIN_TYPE _irq = RADIOLIB_NC;
+
475 RADIOLIB_PIN_TYPE _rst = RADIOLIB_NC;
+
476 RADIOLIB_PIN_TYPE _rx = RADIOLIB_NC;
+
477 RADIOLIB_PIN_TYPE _tx = RADIOLIB_NC;
+
+
+
480 SPISettings _spiSettings = SPISettings(2000000, MSBFIRST, SPI_MODE0);
+
481 SPIClass* _spi = NULL;
+
+
+
484 bool _useRfSwitch =
false ;
+
485 RADIOLIB_PIN_TYPE _rxEn = RADIOLIB_NC;
+
486 RADIOLIB_PIN_TYPE _txEn = RADIOLIB_NC;
+
+
+
489 uint32_t _ATtimeout = 15000;
+
-
492 bool _initInterface =
false ;
-
493 SPIClass* _spi = NULL;
-
-
495 bool _useRfSwitch =
false ;
-
496 RADIOLIB_PIN_TYPE _rxEn = RADIOLIB_NC, _txEn = RADIOLIB_NC;
-
-
498 uint32_t _ATtimeout = 15000;
-
-
-
+
+
+
510 #ifdef RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED
+
511 SerialModule (RADIOLIB_PIN_TYPE rx, RADIOLIB_PIN_TYPE tx, HardwareSerial* serial = &RADIOLIB_HARDWARE_SERIAL_PORT, RADIOLIB_PIN_TYPE rst = RADIOLIB_NC);
+
+
513 SerialModule (RADIOLIB_PIN_TYPE rx, RADIOLIB_PIN_TYPE tx, HardwareSerial* serial =
nullptr , RADIOLIB_PIN_TYPE rst = RADIOLIB_NC);
+
+
+
+
-Module(RADIOLIB_PIN_TYPE rx, RADIOLIB_PIN_TYPE tx, HardwareSerial *serial=nullptr, RADIOLIB_PIN_TYPE rst=RADIOLIB_NC)
UART-based module constructor.
Definition: Module.cpp:29
static 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:323
RADIOLIB_PIN_TYPE getIrq() const
Access method to get the pin number of interrupt/GPIO.
Definition: Module.h:316
RADIOLIB_PIN_TYPE getRx() const
Access method to get the pin number of UART Rx.
Definition: Module.h:337
static RADIOLIB_PIN_STATUS digitalRead(RADIOLIB_PIN_TYPE pin)
Arduino core digitalWrite override that checks RADIOLIB_NC as alias for unused pin.
Definition: Module.cpp:335
void SPItransfer(uint8_t cmd, uint8_t reg, uint8_t *dataOut, uint8_t *dataIn, uint8_t numBytes)
SPI single transfer method.
Definition: Module.cpp:276
int16_t SPIgetRegValue(uint8_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:199
SPIClass * getSpi() const
Access method to get the SPI interface.
Definition: Module.h:351
SoftwareSerial * ModuleSerial
Internal SoftwareSerial instance.
Definition: Module.h:140
char AtLineFeed[3]
Line feed to be used when sending AT commands. Defaults to CR+LF.
Definition: Module.h:151
bool ATgetResponse()
Get response after sending AT command.
Definition: Module.cpp:175
RADIOLIB_PIN_TYPE getRst() const
Access method to get the pin number of hardware reset pin.
Definition: Module.h:323
uint8_t SPIwriteCommand
Basic SPI write command. Defaults to 0x80.
Definition: Module.h:161
bool ATsendData(uint8_t *data, uint32_t len)
Send raw AT data. Will also call ATgetResponse.
Definition: Module.cpp:165
static void delay(uint32_t ms)
Arduino core delay override.
Definition: Module.cpp:385
static void yield()
Arduino core yield override.
Definition: Module.cpp:381
static 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:329
static uint32_t micros()
Arduino core micros override.
Definition: Module.cpp:397
RADIOLIB_PIN_TYPE getCs() const
Access method to get the pin number of SPI chip select.
Definition: Module.h:309
int16_t SPIsetRegValue(uint8_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:209
void ATemptyBuffer()
Empty internal AT buffer.
Definition: Module.cpp:152
void SPIwriteRegister(uint8_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:272
void term(uint8_t interface)
Terminate low-level module control.
Definition: Module.cpp:137
static 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:358
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by two pins. This function gives RadioLib control ...
Definition: Module.cpp:416
RADIOLIB_PIN_TYPE getTx() const
Access method to get the pin number of UART Rx.
Definition: Module.h:344
RADIOLIB_PIN_TYPE getGpio() const
Access method to get the pin number of second interrupt/GPIO.
Definition: Module.h:330
static uint16_t flipBits16(uint16_t i)
Function to reflect bits within an integer.
Definition: Module.cpp:408
uint8_t SPIreadRegister(uint8_t reg)
SPI basic read method. Use of this method is reserved for special cases, SPIgetRegValue should be use...
Definition: Module.cpp:262
Implements all common low-level SPI/UART/I2C methods to control the wireless module....
Definition: Module.h:17
Module & operator=(const Module &mod)
Overload for assignment operator.
Definition: Module.cpp:96
void init(uint8_t interface)
Initialize low-level module control.
Definition: Module.cpp:113
uint8_t SPIreadCommand
Basic SPI read command. Defaults to 0x00.
Definition: Module.h:156
static void detachInterrupt(RADIOLIB_PIN_TYPE interruptNum)
Arduino core detachInterrupt override.
Definition: Module.cpp:377
SPISettings getSpiSettings() const
Access method to get the SPI interface settings.
Definition: Module.h:358
void setRfSwitchState(RADIOLIB_PIN_STATUS rxPinState, RADIOLIB_PIN_STATUS txPinState)
Set RF switch state.
Definition: Module.cpp:424
void SPIreadRegisterBurst(uint8_t reg, uint8_t numBytes, uint8_t *inBytes)
SPI burst read method.
Definition: Module.cpp:258
static void tone(RADIOLIB_PIN_TYPE pin, uint16_t value)
Arduino core tone override that checks RADIOLIB_NC as alias for unused pin and RADIOLIB_TONE_UNSUPPOR...
Definition: Module.cpp:342
static uint8_t flipBits(uint8_t b)
Function to reflect bits within a byte.
Definition: Module.cpp:401
uint32_t baudrate
Baud rate of SoftwareSerial UART communication. Defaults to 9600 baud.
Definition: Module.h:146
static uint32_t millis()
Arduino core millis override.
Definition: Module.cpp:393
bool ATsendCommand(const char *cmd)
Send AT command. Will also call ATgetResponse.
Definition: Module.cpp:158
static void delayMicroseconds(uint32_t us)
Arduino core delayMicroseconds override.
Definition: Module.cpp:389
static void attachInterrupt(RADIOLIB_PIN_TYPE interruptNum, void(*userFunc)(void), RADIOLIB_INTERRUPT_STATUS mode)
Arduino core attachInterrupt override.
Definition: Module.cpp:373
void SPIwriteRegisterBurst(uint8_t reg, uint8_t *data, uint8_t numBytes)
SPI burst write method.
Definition: Module.cpp:268
static 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:318
RADIOLIB_PIN_TYPE getIrq() const
Access method to get the pin number of interrupt/GPIO.
Definition: Module.h:298
RADIOLIB_PIN_TYPE getRx() const
Access method to get the pin number of UART Rx.
Definition: Module.h:319
static RADIOLIB_PIN_STATUS digitalRead(RADIOLIB_PIN_TYPE pin)
Arduino core digitalWrite override that checks RADIOLIB_NC as alias for unused pin.
Definition: Module.cpp:330
void SPItransfer(uint8_t cmd, uint8_t reg, uint8_t *dataOut, uint8_t *dataIn, uint8_t numBytes)
SPI single transfer method.
Definition: Module.cpp:271
int16_t SPIgetRegValue(uint8_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:194
SPIClass * getSpi() const
Access method to get the SPI interface.
Definition: Module.h:333
SoftwareSerial * ModuleSerial
Internal SoftwareSerial instance.
Definition: Module.h:122
char AtLineFeed[3]
Line feed to be used when sending AT commands. Defaults to CR+LF.
Definition: Module.h:133
bool ATgetResponse()
Get response after sending AT command.
Definition: Module.cpp:170
RADIOLIB_PIN_TYPE getRst() const
Access method to get the pin number of hardware reset pin.
Definition: Module.h:305
uint8_t SPIwriteCommand
Basic SPI write command. Defaults to 0x80.
Definition: Module.h:143
bool ATsendData(uint8_t *data, uint32_t len)
Send raw AT data. Will also call ATgetResponse.
Definition: Module.cpp:160
static void delay(uint32_t ms)
Arduino core delay override.
Definition: Module.cpp:380
static void yield()
Arduino core yield override.
Definition: Module.cpp:376
static 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:324
static uint32_t micros()
Arduino core micros override.
Definition: Module.cpp:392
RADIOLIB_PIN_TYPE getCs() const
Access method to get the pin number of SPI chip select.
Definition: Module.h:291
int16_t SPIsetRegValue(uint8_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:204
void ATemptyBuffer()
Empty internal AT buffer.
Definition: Module.cpp:147
void SPIwriteRegister(uint8_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:267
void term(uint8_t interface)
Terminate low-level module control.
Definition: Module.cpp:132
static 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:353
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by two pins. This function gives RadioLib control ...
Definition: Module.cpp:411
RADIOLIB_PIN_TYPE getTx() const
Access method to get the pin number of UART Rx.
Definition: Module.h:326
RADIOLIB_PIN_TYPE getGpio() const
Access method to get the pin number of second interrupt/GPIO.
Definition: Module.h:312
static uint16_t flipBits16(uint16_t i)
Function to reflect bits within an integer.
Definition: Module.cpp:403
uint8_t SPIreadRegister(uint8_t reg)
SPI basic read method. Use of this method is reserved for special cases, SPIgetRegValue should be use...
Definition: Module.cpp:257
Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...
Definition: Module.h:17
Module(RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst)
SPI-based module constructor. Will use the default SPI interface automatically initialize it.
Definition: Module.cpp:16
Module & operator=(const Module &mod)
Overload for assignment operator.
Definition: Module.cpp:91
void init(uint8_t interface)
Initialize low-level module control.
Definition: Module.cpp:108
uint8_t SPIreadCommand
Basic SPI read command. Defaults to 0x00.
Definition: Module.h:138
static void detachInterrupt(RADIOLIB_PIN_TYPE interruptNum)
Arduino core detachInterrupt override.
Definition: Module.cpp:372
SPISettings getSpiSettings() const
Access method to get the SPI interface settings.
Definition: Module.h:340
void setRfSwitchState(RADIOLIB_PIN_STATUS rxPinState, RADIOLIB_PIN_STATUS txPinState)
Set RF switch state.
Definition: Module.cpp:419
void SPIreadRegisterBurst(uint8_t reg, uint8_t numBytes, uint8_t *inBytes)
SPI burst read method.
Definition: Module.cpp:253
static void tone(RADIOLIB_PIN_TYPE pin, uint16_t value)
Arduino core tone override that checks RADIOLIB_NC as alias for unused pin and RADIOLIB_TONE_UNSUPPOR...
Definition: Module.cpp:337
static uint8_t flipBits(uint8_t b)
Function to reflect bits within a byte.
Definition: Module.cpp:396
Extension of Module class for UART-based modules, only exists to distinguish the UART constructor.
Definition: Module.h:497
uint32_t baudrate
Baud rate of SoftwareSerial UART communication. Defaults to 9600 baud.
Definition: Module.h:128
static uint32_t millis()
Arduino core millis override.
Definition: Module.cpp:388
bool ATsendCommand(const char *cmd)
Send AT command. Will also call ATgetResponse.
Definition: Module.cpp:153
static void delayMicroseconds(uint32_t us)
Arduino core delayMicroseconds override.
Definition: Module.cpp:384
static void attachInterrupt(RADIOLIB_PIN_TYPE interruptNum, void(*userFunc)(void), RADIOLIB_INTERRUPT_STATUS mode)
Arduino core attachInterrupt override.
Definition: Module.cpp:368
void SPIwriteRegisterBurst(uint8_t reg, uint8_t *data, uint8_t numBytes)
SPI burst write method.
Definition: Module.cpp:263
diff --git a/_r_f69_8h_source.html b/_r_f69_8h_source.html
index 7b5f1472..a0ab5c9b 100644
--- a/_r_f69_8h_source.html
+++ b/_r_f69_8h_source.html
@@ -722,7 +722,7 @@ $(document).ready(function(){initNavTree('_r_f69_8h_source.html',''); initResiza
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Allowed values are RADIOLIB_ENCODING_NRZ, RADIOLIB_ENCODING_MANCHESTER an...
Definition: RF69.cpp:769
void setAESKey(uint8_t *key)
Sets AES key.
Definition: RF69.cpp:229
void setDirectAction(void(*func)(void))
Set interrupt service routine function to call when data bit is receveid in direct mode.
Definition: RF69.cpp:822
Implements all common low-level SPI/UART/I2C methods to control the wireless module....
Definition: Module.h:17
Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...
Definition: Module.h:17
int16_t transmitDirect(uint32_t frf=0) override
Starts direct mode transmission.
Definition: RF69.cpp:179
int16_t setOutputPower(int8_t power, bool highPower=false)
Sets output power. Allowed values range from -18 to 13 dBm for low power modules (RF69C/CW) or -2 to ...
Definition: RF69.cpp:553
int16_t packetMode()
Stops direct mode. It is required to call this method to switch from direct transmissions to packet-b...
Definition: RF69.cpp:225
Derived class for RFM95 modules. Overrides some methods from SX1278 due to different parameter ranges...
Definition: RFM95.h:21
RFM95(Module *mod)
Default constructor. Called from Arduino sketch when creating new LoRa instance.
Definition: RFM95.cpp:4
int16_t setFrequency(float freq)
Sets carrier frequency. Allowed values range from 868.0 MHz to 915.0 MHz.
Definition: RFM95.cpp:43
Implements all common low-level SPI/UART/I2C methods to control the wireless module....
Definition: Module.h:17
Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...
Definition: Module.h:17
diff --git a/_r_f_m96_8h_source.html b/_r_f_m96_8h_source.html
index 79bebb00..c0f4c0e3 100644
--- a/_r_f_m96_8h_source.html
+++ b/_r_f_m96_8h_source.html
@@ -134,7 +134,7 @@ $(document).ready(function(){initNavTree('_r_f_m96_8h_source.html',''); initResi
Derived class for SX1278 modules. Also used as base class for SX1276, SX1277, SX1279,...
Definition: SX1278.h:104
RFM96(Module *mod)
Default constructor. Called from Arduino sketch when creating new LoRa instance.
Definition: RFM96.cpp:4
int16_t begin(float freq=434.0, float bw=125.0, uint8_t sf=9, uint8_t cr=7, uint8_t syncWord=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: RFM96.cpp:8
Implements all common low-level SPI/UART/I2C methods to control the wireless module....
Definition: Module.h:17
Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...
Definition: Module.h:17
Only exists as alias for RFM96, since there seems to be no difference between RFM96 and RFM98 modules...
diff --git a/_r_f_m97_8h_source.html b/_r_f_m97_8h_source.html
index 0a13266d..050f4fef 100644
--- a/_r_f_m97_8h_source.html
+++ b/_r_f_m97_8h_source.html
@@ -123,7 +123,7 @@ $(document).ready(function(){initNavTree('_r_f_m97_8h_source.html',''); initResi
RFM97(Module *mod)
Default constructor. Called from Arduino sketch when creating new LoRa instance.
Definition: RFM97.cpp:4
Derived class for RFM95 modules. Overrides some methods from SX1278 due to different parameter ranges...
Definition: RFM95.h:21
int16_t setSpreadingFactor(uint8_t sf)
Sets LoRa link spreading factor. Allowed values range from 6 to 9. Only available in LoRa mode.
Definition: RFM97.cpp:8
-
Implements all common low-level SPI/UART/I2C methods to control the wireless module....
Definition: Module.h:17
+
Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...
Definition: Module.h:17
Derived class for RFM97 modules. Overrides some methods from RFM95 due to different parameter ranges.
Definition: RFM97.h:18
diff --git a/_radio_lib_8h_source.html b/_radio_lib_8h_source.html
index 1db409e9..61b4e6e5 100644
--- a/_radio_lib_8h_source.html
+++ b/_radio_lib_8h_source.html
@@ -189,7 +189,7 @@ $(document).ready(function(){initNavTree('_radio_lib_8h_source.html',''); initRe
-Implements all common low-level SPI/UART/I2C methods to control the wireless module....
Definition: Module.h:17
Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...
Definition: Module.h:17
diff --git a/_s_x1231_8h_source.html b/_s_x1231_8h_source.html
index e4bccc99..85909fbf 100644
--- a/_s_x1231_8h_source.html
+++ b/_s_x1231_8h_source.html
@@ -127,7 +127,7 @@ $(document).ready(function(){initNavTree('_s_x1231_8h_source.html',''); initResi
Control class for SX1231 module. Overrides some methods from RF69 due to different register values.
Definition: SX1231.h:26
Control class for RF69 module. Also serves as base class for SX1231.
Definition: RF69.h:440
int16_t begin(float freq=434.0, float br=48.0, float rxBw=125.0, float freqDev=50.0, int8_t power=10, uint8_t preambleLen=16)
Initialization method.
Definition: SX1231.cpp:8
Implements all common low-level SPI/UART/I2C methods to control the wireless module....
Definition: Module.h:17
Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...
Definition: Module.h:17
diff --git a/_s_x1261_8h_source.html b/_s_x1261_8h_source.html
index 05cae58a..870ea4d2 100644
--- a/_s_x1261_8h_source.html
+++ b/_s_x1261_8h_source.html
@@ -120,7 +120,7 @@ $(document).ready(function(){initNavTree('_s_x1261_8h_source.html',''); initResi
int16_t setOutputPower(int8_t power)
Sets output power. Allowed values are in range from -17 to 14 dBm.
Definition: SX1261.cpp:8
SX1261(Module *mod)
Default constructor.
Definition: SX1261.cpp:4
Derived class for SX1261 modules.
Definition: SX1261.h:20
Implements all common low-level SPI/UART/I2C methods to control the wireless module....
Definition: Module.h:17
Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...
Definition: Module.h:17
Derived class for SX1262 modules.
Definition: SX1262.h:19
diff --git a/_s_x1262_8h_source.html b/_s_x1262_8h_source.html
index d6b48a58..e52d342b 100644
--- a/_s_x1262_8h_source.html
+++ b/_s_x1262_8h_source.html
@@ -129,7 +129,7 @@ $(document).ready(function(){initNavTree('_s_x1262_8h_source.html',''); initResi
SX1262(Module *mod)
Default constructor.
Definition: SX1262.cpp:4
int16_t beginFSK(float freq=434.0, float br=48.0, float freqDev=50.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:26
int16_t setFrequency(float freq, bool calibrate=true)
Sets carrier frequency. Allowed values are in range from 150.0 to 960.0 MHz.
Definition: SX1262.cpp:44
-
Implements all common low-level SPI/UART/I2C methods to control the wireless module....
Definition: Module.h:17
+
Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...
Definition: Module.h:17
int16_t begin(float freq=434.0, float bw=125.0, uint8_t sf=9, uint8_t cr=7, uint8_t syncWord=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: SX1262.cpp:8
int16_t setOutputPower(int8_t power)
Sets output power. Allowed values are in range from -17 to 22 dBm.
Definition: SX1262.cpp:74
Derived class for SX1262 modules.
Definition: SX1262.h:19
diff --git a/_s_x1268_8h_source.html b/_s_x1268_8h_source.html
index fb9c8bcf..21e12682 100644
--- a/_s_x1268_8h_source.html
+++ b/_s_x1268_8h_source.html
@@ -130,7 +130,7 @@ $(document).ready(function(){initNavTree('_s_x1268_8h_source.html',''); initResi
int16_t begin(float freq=434.0, float bw=125.0, uint8_t sf=9, uint8_t cr=7, uint8_t syncWord=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: SX1268.cpp:8
int16_t setFrequency(float freq, bool calibrate=true)
Sets carrier frequency. Allowed values are in range from 410.0 to 810.0 MHz.
Definition: SX1268.cpp:45
int16_t beginFSK(float freq=434.0, float br=48.0, float freqDev=50.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: SX1268.cpp:26
-
Implements all common low-level SPI/UART/I2C methods to control the wireless module....
Definition: Module.h:17
+
Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...
Definition: Module.h:17
Derived class for SX1268 modules.
Definition: SX1268.h:19
SX1268(Module *mod)
Default constructor.
Definition: SX1268.cpp:4
Base class for SX126x series. All derived classes for SX126x (e.g. SX1262 or SX1268) inherit from thi...
Definition: SX126x.h:342
diff --git a/_s_x126x_8h_source.html b/_s_x126x_8h_source.html
index b1e36ecd..3ea3f33e 100644
--- a/_s_x126x_8h_source.html
+++ b/_s_x126x_8h_source.html
@@ -679,7 +679,7 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:100
int16_t setCodingRate(uint8_t cr)
Sets LoRa coding rate denominator. Allowed values range from 5 to 8.
Definition: SX126x.cpp:675
int16_t startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8)
Calls startReceiveDutyCycle with rxPeriod and sleepPeriod set so the unit shouldn't miss any messages...
Definition: SX126x.cpp:515
-
Implements all common low-level SPI/UART/I2C methods to control the wireless module....
Definition: Module.h:17
+
Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...
Definition: Module.h:17
int16_t setFrequencyDeviation(float freqDev) override
Sets FSK frequency deviation. Allowed values range from 0.0 to 200.0 kHz.
Definition: SX126x.cpp:734
int16_t receiveDirect() override
Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as SX126x series does...
Definition: SX126x.cpp:325
int16_t startReceive(uint32_t timeout=SX126X_RX_TIMEOUT_INF)
Interrupt-driven receive method. DIO1 will be activated when full packet is received.
Definition: SX126x.cpp:475
diff --git a/_s_x1272_8h_source.html b/_s_x1272_8h_source.html
index e1deb78c..6d8640fb 100644
--- a/_s_x1272_8h_source.html
+++ b/_s_x1272_8h_source.html
@@ -256,7 +256,7 @@ $(document).ready(function(){initNavTree('_s_x1272_8h_source.html',''); initResi
int16_t autoLDRO()
Re-enables automatic LDRO configuration. Only available in LoRa mode. After calling this method,...
Definition: SX1272.cpp:418
int16_t setDataShaping(uint8_t sh) override
Sets Gaussian filter bandwidth-time product that will be used for data shaping. Only available in FSK...
Definition: SX1272.cpp:281
int16_t beginFSK(float freq=915.0, float br=48.0, float rxBw=125.0, float freqDev=50.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: SX1272.cpp:40
-
Implements all common low-level SPI/UART/I2C methods to control the wireless module....
Definition: Module.h:17
+
Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...
Definition: Module.h:17
void reset() override
Reset method. Will reset the chip to the default state using RST pin.
Definition: SX1272.cpp:67
int16_t setCRC(bool enable, bool mode=false)
Enables/disables CRC check of received packets.
Definition: SX1272.cpp:377
SX1272(Module *mod)
Default constructor. Called from Arduino sketch when creating new LoRa instance.
Definition: SX1272.cpp:4
diff --git a/_s_x1273_8h_source.html b/_s_x1273_8h_source.html
index 12efbb5b..36d1924d 100644
--- a/_s_x1273_8h_source.html
+++ b/_s_x1273_8h_source.html
@@ -126,7 +126,7 @@ $(document).ready(function(){initNavTree('_s_x1273_8h_source.html',''); initResi
int16_t setSpreadingFactor(uint8_t sf)
Sets LoRa link spreading factor. Allowed values range from 6 to 9. Only available in LoRa mode.
Definition: SX1273.cpp:40
int16_t begin(float freq=915.0, float bw=125.0, uint8_t sf=9, uint8_t cr=7, uint8_t syncWord=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
Derived class for SX1272 modules. Also used as base class for SX1273. Both modules use the same basic...
Definition: SX1272.h:95
-
Implements all common low-level SPI/UART/I2C methods to control the wireless module....
Definition: Module.h:17
+
Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...
Definition: Module.h:17
diff --git a/_s_x1276_8h_source.html b/_s_x1276_8h_source.html
index 3570be7a..7d165237 100644
--- a/_s_x1276_8h_source.html
+++ b/_s_x1276_8h_source.html
@@ -127,7 +127,7 @@ $(document).ready(function(){initNavTree('_s_x1276_8h_source.html',''); initResi
int16_t begin(float freq=434.0, float bw=125.0, uint8_t sf=9, uint8_t cr=7, uint8_t syncWord=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: SX1276.cpp:8
Derived class for SX1278 modules. Also used as base class for SX1276, SX1277, SX1279,...
Definition: SX1278.h:104
Derived class for SX1276 modules. Overrides some methods from SX1278 due to different parameter range...
Definition: SX1276.h:15
Implements all common low-level SPI/UART/I2C methods to control the wireless module....
Definition: Module.h:17
Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...
Definition: Module.h:17
int16_t beginFSK(float freq=434.0, float br=48.0, float freqDev=50.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: SX1276.cpp:35
SX1276(Module *mod)
Default constructor. Called from Arduino sketch when creating new LoRa instance.
Definition: SX1276.cpp:4
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:127
Derived class for SX1278 modules. Also used as base class for SX1276, SX1277, SX1279,...
Definition: SX1278.h:104
int16_t setFrequency(float freq)
Sets carrier frequency. Allowed values range from 137.0 MHz to 1020.0 MHz.
Definition: SX1277.cpp:53
Implements all common low-level SPI/UART/I2C methods to control the wireless module....
Definition: Module.h:17
Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...
Definition: Module.h:17
diff --git a/_s_x1278_8h_source.html b/_s_x1278_8h_source.html
index 5f617205..8a4a4d7e 100644
--- a/_s_x1278_8h_source.html
+++ b/_s_x1278_8h_source.html
@@ -263,7 +263,7 @@ $(document).ready(function(){initNavTree('_s_x1278_8h_source.html',''); initResi
float getRSSI(bool skipReceive=false)
Gets recorded signal strength indicator of the latest received packet for LoRa modem,...
Definition: SX1278.cpp:415
Base class for SX127x series. All derived classes for SX127x (e.g. SX1278 or SX1272) inherit from thi...
Definition: SX127x.h:547
int16_t setFrequency(float freq)
Sets carrier frequency. Allowed values range from 137.0 MHz to 525.0 MHz.
Definition: SX1278.cpp:70
Implements all common low-level SPI/UART/I2C methods to control the wireless module....
Definition: Module.h:17
Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...
Definition: Module.h:17
int16_t forceLDRO(bool enable)
Forces LoRa low data rate optimization. Only available in LoRa mode. After calling this method,...
Definition: SX1278.cpp:483
int16_t autoLDRO()
Re-enables automatic LDRO configuration. Only available in LoRa mode. After calling this method,...
Definition: SX1278.cpp:496
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:383
int16_t setFrequency(float freq)
Sets carrier frequency. Allowed values range from 137.0 MHz to 960.0 MHz.
Definition: SX1279.cpp:53
Derived class for SX1279 modules. Overrides some methods from SX1278 due to different parameter range...
Definition: SX1279.h:15
int16_t beginFSK(float freq=434.0, float br=48.0, float freqDev=50.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: SX1279.cpp:35
Implements all common low-level SPI/UART/I2C methods to control the wireless module....
Definition: Module.h:17
Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...
Definition: Module.h:17
int16_t begin(float freq=434.0, float bw=125.0, uint8_t sf=9, uint8_t cr=7, uint8_t syncWord=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 d5db2ff0..6065c89e 100644
--- a/_s_x127x_8h_source.html
+++ b/_s_x127x_8h_source.html
@@ -846,7 +846,7 @@ $(document).ready(function(){initNavTree('_s_x127x_8h_source.html',''); initResi
int16_t setAFCBandwidth(float afcBw)
Sets FSK automatic frequency correction bandwidth. Allowed values range from 2.6 to 250 kHz....
Definition: SX127x.cpp:790
int16_t setOOK(bool enableOOK)
Enables/disables OOK modulation instead of FSK.
Definition: SX127x.cpp:920
int16_t setRxBandwidth(float rxBw)
Sets FSK receiver bandwidth. Allowed values range from 2.6 to 250 kHz. Only available in FSK mode.
Definition: SX127x.cpp:774
-
Implements all common low-level SPI/UART/I2C methods to control the wireless module....
Definition: Module.h:17
+
Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...
Definition: Module.h:17
int16_t scanChannel()
Performs scan for valid LoRa preamble in the current channel.
Definition: SX127x.cpp:249
int16_t receive(uint8_t *data, size_t len) override
Binary receive method. Will attempt to receive arbitrary binary data up to 255 bytes long using LoRa ...
Definition: SX127x.cpp:204
int16_t getChipVersion()
Read version SPI register. Should return SX1278_CHIP_VERSION (0x12) or SX1272_CHIP_VERSION (0x22) if ...
Definition: SX127x.cpp:1086
diff --git a/_s_x1280_8h_source.html b/_s_x1280_8h_source.html
index 72b5ccbd..122c9869 100644
--- a/_s_x1280_8h_source.html
+++ b/_s_x1280_8h_source.html
@@ -122,7 +122,7 @@ $(document).ready(function(){initNavTree('_s_x1280_8h_source.html',''); initResi
int16_t startRanging(bool master, uint32_t addr)
Interrupt-driven ranging method.
Definition: SX1280.cpp:34
Derived class for SX1280 modules.
Definition: SX1280.h:17
float getRangingResult()
Gets ranging result of the last ranging exchange.
Definition: SX1280.cpp:132
-
Implements all common low-level SPI/UART/I2C methods to control the wireless module....
Definition: Module.h:17
+
Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...
Definition: Module.h:17
Derived class for SX1281 modules.
Definition: SX1281.h:16
int16_t range(bool master, uint32_t addr)
Blocking ranging method.
Definition: SX1280.cpp:8
diff --git a/_s_x1281_8h_source.html b/_s_x1281_8h_source.html
index 00d94625..f054ca77 100644
--- a/_s_x1281_8h_source.html
+++ b/_s_x1281_8h_source.html
@@ -113,7 +113,7 @@ $(document).ready(function(){initNavTree('_s_x1281_8h_source.html',''); initResi
Base class for SX128x series. All derived classes for SX128x (e.g. SX1280 or SX1281) inherit from thi...
Definition: SX128x.h:350
SX1281(Module *mod)
Default constructor.
Definition: SX1281.cpp:4
Implements all common low-level SPI/UART/I2C methods to control the wireless module....
Definition: Module.h:17
Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...
Definition: Module.h:17
Derived class for SX1281 modules.
Definition: SX1281.h:16
diff --git a/_s_x1282_8h_source.html b/_s_x1282_8h_source.html
index 8dea8724..5ff52a7f 100644
--- a/_s_x1282_8h_source.html
+++ b/_s_x1282_8h_source.html
@@ -114,7 +114,7 @@ $(document).ready(function(){initNavTree('_s_x1282_8h_source.html',''); initResi
Derived class for SX1282 modules.
Definition: SX1282.h:17
Derived class for SX1280 modules.
Definition: SX1280.h:17
Implements all common low-level SPI/UART/I2C methods to control the wireless module....
Definition: Module.h:17
Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...
Definition: Module.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 ce57c0bc..d354f812 100644
--- a/_s_x128x_8h_source.html
+++ b/_s_x128x_8h_source.html
@@ -647,7 +647,7 @@ $(document).ready(function(){initNavTree('_s_x128x_8h_source.html',''); initResi
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:14
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:100
uint32_t getTimeOnAir(size_t len)
Get expected time-on-air for a given size of payload.
Definition: SX128x.cpp:1069
-
Implements all common low-level SPI/UART/I2C methods to control the wireless module....
Definition: Module.h:17
+
Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...
Definition: Module.h:17
void setDio1Action(void(*func)(void))
Sets interrupt service routine to call when DIO1 activates.
Definition: SX128x.cpp:449
int16_t setPreambleLength(uint32_t preambleLength)
Sets preamble length for currently active modem. Allowed values range from 1 to 65535.
Definition: SX128x.cpp:696
int16_t explicitHeader()
Set explicit header mode for future reception/transmission.
Definition: SX128x.cpp:1137
diff --git a/_si4430_8h_source.html b/_si4430_8h_source.html
index 25bf6681..df420088 100644
--- a/_si4430_8h_source.html
+++ b/_si4430_8h_source.html
@@ -134,7 +134,7 @@ $(document).ready(function(){initNavTree('_si4430_8h_source.html',''); initResiz
int16_t begin(float freq=434.0, float br=48.0, float freqDev=50.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
int16_t setFrequency(float freq)
Sets carrier frequency. Allowed values range from 900.0 MHz to 960.0 MHz.
Definition: Si4430.cpp:24
Derived class for Si4430 modules.
Definition: Si4430.h:16
-
Implements all common low-level SPI/UART/I2C methods to control the wireless module....
Definition: Module.h:17
+
Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...
Definition: Module.h:17
diff --git a/_si4431_8h_source.html b/_si4431_8h_source.html
index 62fea230..dfcd5131 100644
--- a/_si4431_8h_source.html
+++ b/_si4431_8h_source.html
@@ -130,7 +130,7 @@ $(document).ready(function(){initNavTree('_si4431_8h_source.html',''); initResiz
int16_t begin(float freq=434.0, float br=48.0, float freqDev=50.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
Si4431(Module *mod)
Default constructor.
Definition: Si4431.cpp:4
Derived class for Si4432 modules.
Definition: Si4432.h:16
Implements all common low-level SPI/UART/I2C methods to control the wireless module....
Definition: Module.h:17
Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...
Definition: Module.h:17
int16_t setOutputPower(int8_t power)
Sets output power. Allowed values range from -8 to 13 dBm in 3 dBm steps.
Definition: Si4431.cpp:24
diff --git a/_si4432_8h_source.html b/_si4432_8h_source.html
index e8a6143e..e8667feb 100644
--- a/_si4432_8h_source.html
+++ b/_si4432_8h_source.html
@@ -133,7 +133,7 @@ $(document).ready(function(){initNavTree('_si4432_8h_source.html',''); initResiz
int16_t setFrequency(float freq)
Sets carrier frequency. Allowed values range from 240.0 MHz to 930.0 MHz.
Definition: Si4432.cpp:24
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
Si4432(Module *mod)
Default constructor.
Definition: Si4432.cpp:4
-
Implements all common low-level SPI/UART/I2C methods to control the wireless module....
Definition: Module.h:17
+
Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...
Definition: Module.h:17
Base class for Si443x series. All derived classes for Si443x (e.g. Si4431 or Si4432) inherit from thi...
Definition: Si443x.h:554
diff --git a/_si443x_8h_source.html b/_si443x_8h_source.html
index 8d19a180..2c3340f3 100644
--- a/_si443x_8h_source.html
+++ b/_si443x_8h_source.html
@@ -759,7 +759,7 @@ $(document).ready(function(){initNavTree('_si443x_8h_source.html',''); initResiz
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
Some modules contain external RF switch controlled by two pins. This function gives RadioLib control ...
Definition: Si443x.cpp:547
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:14
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:100
-
Implements all common low-level SPI/UART/I2C methods to control the wireless module....
Definition: Module.h:17
+
Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...
Definition: Module.h:17
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Only available in FSK mode. Allowed values are RADIOLIB_ENCODING_NRZ,...
Definition: Si443x.cpp:509
void reset()
Reset method. Will reset the chip to the default state using SDN pin.
Definition: Si443x.cpp:63
void readBit(RADIOLIB_PIN_TYPE pin)
Function to read and process data bit in direct reception mode.
Definition: Si443x.cpp:578
diff --git a/_x_bee_8h_source.html b/_x_bee_8h_source.html
index e55cecaf..0bd69c6b 100644
--- a/_x_bee_8h_source.html
+++ b/_x_bee_8h_source.html
@@ -210,7 +210,7 @@ $(document).ready(function(){initNavTree('_x_bee_8h_source.html',''); initResiza
String getPacketData()
Gets packet payload.
Definition: XBee.cpp:157
String getPacketSource()
Gets packet source 64-bit address.
Definition: XBee.cpp:149
Control class for XBee modules.
Definition: XBee.h:96
-
Implements all common low-level SPI/UART/I2C methods to control the wireless module....
Definition: Module.h:17
+
Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...
Definition: Module.h:17
int16_t begin(long speed)
Initialization method.
Definition: XBee.cpp:184
int16_t begin(long speed)
Initialization method.
Definition: XBee.cpp:9
int16_t setDestinationAddress(const char *destinationAddressHigh, const char *destinationAddressLow)
Sets destination XBee address.
Definition: XBee.cpp:226
diff --git a/annotated.html b/annotated.html
index c2909d81..042e73b4 100644
--- a/annotated.html
+++ b/annotated.html
@@ -100,7 +100,7 @@ $(document).ready(function(){initNavTree('annotated.html',''); initResizable();
C ITA2String ITA2-encoded string C JDY08 Control class for JDY08 module. Most methods supported by this module are implemented in ISerial interface C LLCC68 Derived class for LLCC68 modules
-
C Module Implements all common low-level SPI/UART/I2C methods to control the wireless module. Every module class contains one private instance of this class
+
C Module Implements all common low-level SPI/UART methods to control the wireless module. Every module class contains one private instance of this class C MorseClient Client for Morse Code communication. The public interface is the same as Arduino Serial C MQTTClient Client for simple MQTT communication C nRF24 Control class for nRF24 module
@@ -113,32 +113,33 @@ $(document).ready(function(){initNavTree('annotated.html',''); initResizable();
C RFM97 Derived class for RFM97 modules. Overrides some methods from RFM95 due to different parameter ranges C RFM98 Only exists as alias for RFM96 , since there seems to be no difference between RFM96 and RFM98 modules C RTTYClient Client for RTTY communication. The public interface is the same as Arduino Serial
-
C Si4430 Derived class for Si4430 modules
-
C Si4431 Derived class for Si4431 modules
-
C Si4432 Derived class for Si4432 modules
-
C Si443x Base class for Si443x series. All derived classes for Si443x (e.g. Si4431 or Si4432 ) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes
-
C SSTVClient Client for SSTV transmissions
-
C SSTVMode_t Structure to save data about supported SSTV modes
-
C SX1231 Control class for SX1231 module. Overrides some methods from RF69 due to different register values
-
C SX1261 Derived class for SX1261 modules
-
C SX1262 Derived class for SX1262 modules
-
C SX1268 Derived class for SX1268 modules
-
C SX126x Base class for SX126x series. All derived classes for SX126x (e.g. SX1262 or SX1268 ) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes
-
C SX1272 Derived class for SX1272 modules. Also used as base class for SX1273 . Both modules use the same basic hardware and only differ in parameter ranges
-
C SX1273 Derived class for SX1273 modules. Overrides some methods from SX1272 due to different parameter ranges
-
C SX1276 Derived class for SX1276 modules. Overrides some methods from SX1278 due to different parameter ranges
-
C SX1277 Derived class for SX1277 modules. Overrides some methods from SX1278 due to different parameter ranges
-
C SX1278 Derived class for SX1278 modules. Also used as base class for SX1276 , SX1277 , SX1279 , RFM95 and RFM96 . All of these modules use the same basic hardware and only differ in parameter ranges (and names)
-
C SX1279 Derived class for SX1279 modules. Overrides some methods from SX1278 due to different parameter ranges
-
C SX127x Base class for SX127x series. All derived classes for SX127x (e.g. SX1278 or SX1272 ) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes
-
C SX1280 Derived class for SX1280 modules
-
C SX1281 Derived class for SX1281 modules
-
C SX1282 Derived class for SX1282 modules
-
C SX128x Base class for SX128x series. All derived classes for SX128x (e.g. SX1280 or SX1281 ) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes
-
C tone_t Structure to save data about tone
-
C TransportLayer Provides common interface for protocols that run on modules with Internet connectivity, such as HTTP or MQTT. Because this class is used mainly as interface, all of its virtual members must be implemented in the module class
-
C XBee Control class for XBee modules
-
C XBeeSerial XBee Serial interface. This class is used for XBees in transparent mode, i.e. when two XBees act as a "wireless UART"
+
C SerialModule Extension of Module class for UART-based modules, only exists to distinguish the UART constructor
+
C Si4430 Derived class for Si4430 modules
+
C Si4431 Derived class for Si4431 modules
+
C Si4432 Derived class for Si4432 modules
+
C Si443x Base class for Si443x series. All derived classes for Si443x (e.g. Si4431 or Si4432 ) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes
+
C SSTVClient Client for SSTV transmissions
+
C SSTVMode_t Structure to save data about supported SSTV modes
+
C SX1231 Control class for SX1231 module. Overrides some methods from RF69 due to different register values
+
C SX1261 Derived class for SX1261 modules
+
C SX1262 Derived class for SX1262 modules
+
C SX1268 Derived class for SX1268 modules
+
C SX126x Base class for SX126x series. All derived classes for SX126x (e.g. SX1262 or SX1268 ) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes
+
C SX1272 Derived class for SX1272 modules. Also used as base class for SX1273 . Both modules use the same basic hardware and only differ in parameter ranges
+
C SX1273 Derived class for SX1273 modules. Overrides some methods from SX1272 due to different parameter ranges
+
C SX1276 Derived class for SX1276 modules. Overrides some methods from SX1278 due to different parameter ranges
+
C SX1277 Derived class for SX1277 modules. Overrides some methods from SX1278 due to different parameter ranges
+
C SX1278 Derived class for SX1278 modules. Also used as base class for SX1276 , SX1277 , SX1279 , RFM95 and RFM96 . All of these modules use the same basic hardware and only differ in parameter ranges (and names)
+
C SX1279 Derived class for SX1279 modules. Overrides some methods from SX1278 due to different parameter ranges
+
C SX127x Base class for SX127x series. All derived classes for SX127x (e.g. SX1278 or SX1272 ) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes
+
C SX1280 Derived class for SX1280 modules
+
C SX1281 Derived class for SX1281 modules
+
C SX1282 Derived class for SX1282 modules
+
C SX128x Base class for SX128x series. All derived classes for SX128x (e.g. SX1280 or SX1281 ) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes
+
C tone_t Structure to save data about tone
+
C TransportLayer Provides common interface for protocols that run on modules with Internet connectivity, such as HTTP or MQTT. Because this class is used mainly as interface, all of its virtual members must be implemented in the module class
+
C XBee Control class for XBee modules
+
C XBeeSerial XBee Serial interface. This class is used for XBees in transparent mode, i.e. when two XBees act as a "wireless UART" Parameters
- mod Instance of Module that will be used to communicate with the radio. mod Instance of Module that will be used to communicate with the radio.
diff --git a/class_e_s_p8266.html b/class_e_s_p8266.html
index b7c03f0d..e935b04d 100644
--- a/class_e_s_p8266.html
+++ b/class_e_s_p8266.html
@@ -159,7 +159,7 @@ Public Member FunctionsDefault constructor.
Parameters
- mod Instance of Module that will be used to communicate with the radio. mod Instance of Module that will be used to communicate with the radio.
println (void)<
Default constructor.
Parameters
- mod Instance of Module that will be used to communicate with the radio. mod Instance of Module that will be used to communicate with the radio.
println (void)<
Default constructor.
Parameters
- mod Instance of Module that will be used to communicate with the radio. mod Instance of Module that will be used to communicate with the radio.
Parameters
- mod Instance of Module that will be used to communicate with the radio. mod Instance of Module that will be used to communicate with the radio.
diff --git a/class_module-members.html b/class_module-members.html
index 72eb320f..7e817b8d 100644
--- a/class_module-members.html
+++ b/class_module-members.html
@@ -114,17 +114,17 @@ $(document).ready(function(){initNavTree('class_module.html',''); initResizable(
init (uint8_t interface)Module micros ()Module static millis ()Module static Module (RADIOLIB_PIN_TYPE rx, RADIOLIB_PIN_TYPE tx, HardwareSerial *serial=nullptr, RADIOLIB_PIN_TYPE rst=RADIOLIB_NC)Module Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst)Module Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE gpio)Module Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, SPIClass &spi, SPISettings spiSettings)Module Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE gpio, SPIClass &spi, SPISettings spiSettings=SPISettings(2000000, MSBFIRST, SPI_MODE0))Module Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE rx, RADIOLIB_PIN_TYPE tx, SPIClass &spi=RADIOLIB_DEFAULT_SPI, SPISettings spiSettings=SPISettings(2000000, MSBFIRST, SPI_MODE0), HardwareSerial *serial=nullptr)Module Module (const Module &mod)Module ModuleSerial Module noTone (RADIOLIB_PIN_TYPE pin)Module static operator= (const Module &mod)Module pinMode (RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_MODE mode)Module static Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst)Module Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE gpio)Module Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, SPIClass &spi, SPISettings spiSettings)Module Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE gpio, SPIClass &spi, SPISettings spiSettings=SPISettings(2000000, MSBFIRST, SPI_MODE0))Module Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE rx, RADIOLIB_PIN_TYPE tx, SPIClass &spi=RADIOLIB_DEFAULT_SPI, SPISettings spiSettings=SPISettings(2000000, MSBFIRST, SPI_MODE0), HardwareSerial *serial=nullptr)Module Module (const Module &mod)Module ModuleSerial Module noTone (RADIOLIB_PIN_TYPE pin)Module static operator= (const Module &mod)Module pinMode (RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_MODE mode)Module static SerialModule (defined in Module )Module friend setRfSwitchPins (RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)Module setRfSwitchState (RADIOLIB_PIN_STATUS rxPinState, RADIOLIB_PIN_STATUS txPinState)Module SPIgetRegValue (uint8_t reg, uint8_t msb=7, uint8_t lsb=0)Module Public Member Functions |
Static Public Member Functions |
Public Attributes |
+Friends |
List of all members
-
Implements all common low-level SPI/UART/I2C methods to control the wireless module. Every module class contains one private instance of this class.
+
Implements all common low-level SPI/UART methods to control the wireless module. Every module class contains one private instance of this class.
More...
#include <Module.h >
+
+
+
+
+
+
+
Module (RADIOLIB_PIN_TYPE rx, RADIOLIB_PIN_TYPE tx, HardwareSerial *serial=nullptr, RADIOLIB_PIN_TYPE rst=RADIOLIB_NC) UART-based module constructor. More... Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst) SPI-based module constructor. Will use the default SPI interface automatically initialize it. More... SPIwriteCommand = 0b10000000 Basic SPI write command. Defaults to 0x80.
+SerialModule
-
Implements all common low-level SPI/UART/I2C methods to control the wireless module. Every module class contains one private instance of this class.
+
Implements all common low-level SPI/UART methods to control the wireless module. Every module class contains one private instance of this class.
-
-
◆ [1/7]
-
-
-
-
-
- Module::Module
- (
- RADIOLIB_PIN_TYPE
- rx ,
-
- RADIOLIB_PIN_TYPE
- tx ,
-
- HardwareSerial *
- serial = nullptr,
-
- RADIOLIB_PIN_TYPE
- rst = RADIOLIB_NC
-
- )
-
-
-
-
-
UART-based module constructor.
-
Parameters
-
- rx Arduino pin to be used as Rx pin for SoftwareSerial communication. tx Arduino pin to be used as Tx pin for SoftwareSerial communication. serial HardwareSerial to be used on platforms that do not support SoftwareSerial. Defaults to Serial1. rst Arduino pin to be used as hardware reset for the module. Defaults to NC (unused).
-
-
-
-
-
-
◆ [2/7]
+
◆ [1/6]
@@ -366,7 +328,7 @@ uint8_t
◆ [3/7] ◆ [2/6]
@@ -417,7 +379,7 @@ uint8_t
◆ [4/7] ◆ [3/6]
@@ -475,7 +437,7 @@ uint8_t
◆ [5/7] ◆ [4/6]
@@ -540,7 +502,7 @@ uint8_t
◆ [6/7] ◆ [5/6]
@@ -619,7 +581,7 @@ uint8_t
◆ [7/7] ◆ [6/6]
@@ -637,7 +599,7 @@ uint8_t
Parameters
@@ -1267,7 +1229,7 @@ uint8_t Parameters
diff --git a/class_module.js b/class_module.js
index e7a20995..894785c3 100644
--- a/class_module.js
+++ b/class_module.js
@@ -1,6 +1,5 @@
var class_module =
[
- [ "Module", "class_module.html#a5ea76bc25ef979ec1ff90c032e476004", null ],
[ "Module", "class_module.html#a06b2e1f1eb9e07a280e55f517f2fab38", null ],
[ "Module", "class_module.html#ae8709b81f592a23ebd72ba3fd8066b0f", null ],
[ "Module", "class_module.html#ac65f3d9e022b3284134ced1c20bcff09", null ],
@@ -31,6 +30,7 @@ var class_module =
[ "SPIwriteRegister", "class_module.html#ab814614ddd34b57f5a612a20f5fe4c57", null ],
[ "SPIwriteRegisterBurst", "class_module.html#a9d77a08070cbd48fd4ece62a739333e9", null ],
[ "term", "class_module.html#af0569f6930da7bee761eeca8158aed3a", null ],
+ [ "SerialModule", "class_module.html#a5d5cccbb54f87aeffd144ecc5261511c", null ],
[ "AtLineFeed", "class_module.html#a9d8ab2ff353bad5d0e7568d300a48ba0", null ],
[ "baudrate", "class_module.html#a128ead3f3198e3b06d39a128a5d6c777", null ],
[ "ModuleSerial", "class_module.html#a99556decb983f682b98220ae5434b004", null ],
diff --git a/class_module.png b/class_module.png
new file mode 100644
index 00000000..d5783ee6
Binary files /dev/null and b/class_module.png differ
diff --git a/class_r_f69.html b/class_r_f69.html
index 7510a22b..3b475c98 100644
--- a/class_r_f69.html
+++ b/class_r_f69.html
@@ -363,7 +363,7 @@ void Parameters
- mod Instance of Module that will be used to communicate with the radio. mod Instance of Module that will be used to communicate with the radio.
diff --git a/class_r_f_m95.html b/class_r_f_m95.html
index af67533b..1a9ffaf2 100644
--- a/class_r_f_m95.html
+++ b/class_r_f_m95.html
@@ -438,7 +438,7 @@ void Parameters
- mod Instance of Module that will be used to communicate with the LoRa chip. mod Instance of Module that will be used to communicate with the LoRa chip.
diff --git a/class_r_f_m96.html b/class_r_f_m96.html
index 2a904d71..03712c7f 100644
--- a/class_r_f_m96.html
+++ b/class_r_f_m96.html
@@ -437,7 +437,7 @@ void Parameters
- mod Instance of Module that will be used to communicate with the LoRa chip. mod Instance of Module that will be used to communicate with the LoRa chip.
diff --git a/class_r_f_m97.html b/class_r_f_m97.html
index b9dc816e..43e178e0 100644
--- a/class_r_f_m97.html
+++ b/class_r_f_m97.html
@@ -445,7 +445,7 @@ void Parameters
- mod Instance of Module that will be used to communicate with the LoRa chip. mod Instance of Module that will be used to communicate with the LoRa chip.
diff --git a/class_s_x1231.html b/class_s_x1231.html
index c38da938..b1c34bbe 100644
--- a/class_s_x1231.html
+++ b/class_s_x1231.html
@@ -370,7 +370,7 @@ void Parameters
- mod Instance of Module that will be used to communicate with the radio. mod Instance of Module that will be used to communicate with the radio.
diff --git a/class_s_x1261.html b/class_s_x1261.html
index 98a54373..e23bbc58 100644
--- a/class_s_x1261.html
+++ b/class_s_x1261.html
@@ -408,7 +408,7 @@ void Parameters
- mod Instance of Module that will be used to communicate with the radio. mod Instance of Module that will be used to communicate with the radio.
diff --git a/class_s_x1262.html b/class_s_x1262.html
index a35d61b0..14f36084 100644
--- a/class_s_x1262.html
+++ b/class_s_x1262.html
@@ -402,7 +402,7 @@ void Parameters
- mod Instance of Module that will be used to communicate with the radio. mod Instance of Module that will be used to communicate with the radio.
diff --git a/class_s_x1268.html b/class_s_x1268.html
index 1e75dfcf..384b792a 100644
--- a/class_s_x1268.html
+++ b/class_s_x1268.html
@@ -400,7 +400,7 @@ void Parameters
- mod Instance of Module that will be used to communicate with the radio. mod Instance of Module that will be used to communicate with the radio.
diff --git a/class_s_x126x.html b/class_s_x126x.html
index aeb71c1a..868cbe32 100644
--- a/class_s_x126x.html
+++ b/class_s_x126x.html
@@ -387,7 +387,7 @@ void Parameters
- mod Instance of Module that will be used to communicate with the radio. mod Instance of Module that will be used to communicate with the radio.
diff --git a/class_s_x1272.html b/class_s_x1272.html
index ebd80f6c..f779215a 100644
--- a/class_s_x1272.html
+++ b/class_s_x1272.html
@@ -427,7 +427,7 @@ void Parameters
- mod Instance of Module that will be used to communicate with the LoRa chip. mod Instance of Module that will be used to communicate with the LoRa chip.
diff --git a/class_s_x1273.html b/class_s_x1273.html
index 60fc3b48..c46da272 100644
--- a/class_s_x1273.html
+++ b/class_s_x1273.html
@@ -437,7 +437,7 @@ void Parameters
- mod Instance of Module that will be used to communicate with the LoRa chip. mod Instance of Module that will be used to communicate with the LoRa chip.
diff --git a/class_s_x1276.html b/class_s_x1276.html
index c7d1c456..81de5091 100644
--- a/class_s_x1276.html
+++ b/class_s_x1276.html
@@ -440,7 +440,7 @@ void Parameters
- mod Instance of Module that will be used to communicate with the LoRa chip. mod Instance of Module that will be used to communicate with the LoRa chip.
diff --git a/class_s_x1277.html b/class_s_x1277.html
index 076e4512..ef4db196 100644
--- a/class_s_x1277.html
+++ b/class_s_x1277.html
@@ -443,7 +443,7 @@ void Parameters
- mod Instance of Module that will be used to communicate with the LoRa chip. mod Instance of Module that will be used to communicate with the LoRa chip.
diff --git a/class_s_x1278.html b/class_s_x1278.html
index 8926a67e..8c1f3250 100644
--- a/class_s_x1278.html
+++ b/class_s_x1278.html
@@ -432,7 +432,7 @@ void Parameters
- mod Instance of Module that will be used to communicate with the LoRa chip. mod Instance of Module that will be used to communicate with the LoRa chip.
diff --git a/class_s_x1279.html b/class_s_x1279.html
index 62b54f2a..ac61afec 100644
--- a/class_s_x1279.html
+++ b/class_s_x1279.html
@@ -440,7 +440,7 @@ void Parameters
- mod Instance of Module that will be used to communicate with the LoRa chip. mod Instance of Module that will be used to communicate with the LoRa chip.
diff --git a/class_s_x127x.html b/class_s_x127x.html
index f3802b39..34291d84 100644
--- a/class_s_x127x.html
+++ b/class_s_x127x.html
@@ -385,7 +385,7 @@ void Parameters
- mod Instance of Module that will be used to communicate with the LoRa chip. mod Instance of Module that will be used to communicate with the LoRa chip.
diff --git a/class_s_x1280.html b/class_s_x1280.html
index 11d38711..e68335f0 100644
--- a/class_s_x1280.html
+++ b/class_s_x1280.html
@@ -361,7 +361,7 @@ void Parameters
- mod Instance of Module that will be used to communicate with the radio. mod Instance of Module that will be used to communicate with the radio.
diff --git a/class_s_x1281.html b/class_s_x1281.html
index 60d6343e..b6085d12 100644
--- a/class_s_x1281.html
+++ b/class_s_x1281.html
@@ -348,7 +348,7 @@ void Parameters
- mod Instance of Module that will be used to communicate with the radio. mod Instance of Module that will be used to communicate with the radio.
diff --git a/class_s_x1282.html b/class_s_x1282.html
index 24e5f154..7d12beeb 100644
--- a/class_s_x1282.html
+++ b/class_s_x1282.html
@@ -365,7 +365,7 @@ void Parameters
- mod Instance of Module that will be used to communicate with the radio. mod Instance of Module that will be used to communicate with the radio.
diff --git a/class_s_x128x.html b/class_s_x128x.html
index 5ab655e9..2a44f3ac 100644
--- a/class_s_x128x.html
+++ b/class_s_x128x.html
@@ -344,7 +344,7 @@ void Parameters
- mod Instance of Module that will be used to communicate with the radio. mod Instance of Module that will be used to communicate with the radio.
diff --git a/class_serial_module-members.html b/class_serial_module-members.html
new file mode 100644
index 00000000..cc981737
--- /dev/null
+++ b/class_serial_module-members.html
@@ -0,0 +1,153 @@
+
+
+
+RadioLib: Member List
+
+
+
+
+
+
+ RadioLib
+
+ Universal wireless communication library for Arduino
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for SerialModule , including all inherited members.
+
+ ATemptyBuffer ()Module ATgetResponse ()Module AtLineFeed Module ATsendCommand (const char *cmd)Module ATsendData (uint8_t *data, uint32_t len)Module attachInterrupt (RADIOLIB_PIN_TYPE interruptNum, void(*userFunc)(void), RADIOLIB_INTERRUPT_STATUS mode)Module static baudrate Module delay (uint32_t ms)Module static delayMicroseconds (uint32_t us)Module static detachInterrupt (RADIOLIB_PIN_TYPE interruptNum)Module static digitalRead (RADIOLIB_PIN_TYPE pin)Module static digitalWrite (RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_STATUS value)Module static flipBits (uint8_t b)Module static flipBits16 (uint16_t i)Module static getCs () constModule inline getGpio () constModule inline getIrq () constModule inline getRst () constModule inline getRx () constModule inline getSpi () constModule inline getSpiSettings () constModule inline getTx () constModule inline init (uint8_t interface)Module micros ()Module static millis ()Module static Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst)Module Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE gpio)Module Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, SPIClass &spi, SPISettings spiSettings)Module Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE gpio, SPIClass &spi, SPISettings spiSettings=SPISettings(2000000, MSBFIRST, SPI_MODE0))Module Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE rx, RADIOLIB_PIN_TYPE tx, SPIClass &spi=RADIOLIB_DEFAULT_SPI, SPISettings spiSettings=SPISettings(2000000, MSBFIRST, SPI_MODE0), HardwareSerial *serial=nullptr)Module Module (const Module &mod)Module ModuleSerial Module noTone (RADIOLIB_PIN_TYPE pin)Module static operator= (const Module &mod)Module pinMode (RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_MODE mode)Module static SerialModule (RADIOLIB_PIN_TYPE rx, RADIOLIB_PIN_TYPE tx, HardwareSerial *serial=nullptr, RADIOLIB_PIN_TYPE rst=RADIOLIB_NC)SerialModule setRfSwitchPins (RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)Module setRfSwitchState (RADIOLIB_PIN_STATUS rxPinState, RADIOLIB_PIN_STATUS txPinState)Module SPIgetRegValue (uint8_t reg, uint8_t msb=7, uint8_t lsb=0)Module SPIreadCommand Module SPIreadRegister (uint8_t reg)Module SPIreadRegisterBurst (uint8_t reg, uint8_t numBytes, uint8_t *inBytes)Module SPIsetRegValue (uint8_t reg, uint8_t value, uint8_t msb=7, uint8_t lsb=0, uint8_t checkInterval=2, uint8_t checkMask=0xFF)Module SPItransfer (uint8_t cmd, uint8_t reg, uint8_t *dataOut, uint8_t *dataIn, uint8_t numBytes)Module SPIwriteCommand Module SPIwriteRegister (uint8_t reg, uint8_t data)Module SPIwriteRegisterBurst (uint8_t reg, uint8_t *data, uint8_t numBytes)Module term (uint8_t interface)Module tone (RADIOLIB_PIN_TYPE pin, uint16_t value)Module static yield ()Module static
+
RadioLib: SerialModule Class Reference
+
+
+
+
+
+
+ RadioLib
+
+ Universal wireless communication library for Arduino
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Extension of Module class for UART-based modules, only exists to distinguish the UART constructor.
+ More...
+
+
#include <Module.h >
+
+
+
+
+
+
+
+
+ SerialModule (RADIOLIB_PIN_TYPE rx, RADIOLIB_PIN_TYPE tx, HardwareSerial *serial=nullptr, RADIOLIB_PIN_TYPE rst=RADIOLIB_NC) UART-based module constructor. More... Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst) SPI-based module constructor. Will use the default SPI interface automatically initialize it. More... Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE gpio) Extended SPI-based module constructor. Will use the default SPI interface automatically initialize it. More... Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, SPIClass &spi, SPISettings spiSettings) SPI-based module constructor. More... Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE gpio, SPIClass &spi, SPISettings spiSettings=SPISettings(2000000, MSBFIRST, SPI_MODE0)) Extended SPI-based module constructor. More... Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE rx, RADIOLIB_PIN_TYPE tx, SPIClass &spi=RADIOLIB_DEFAULT_SPI, SPISettings spiSettings=SPISettings(2000000, MSBFIRST, SPI_MODE0), HardwareSerial *serial=nullptr) Generic module constructor. More... Module (const Module &mod) Copy constructor. More... Module & operator= (const Module &mod) Overload for assignment operator. More... void init (uint8_t interface) Initialize low-level module control. More... void term (uint8_t interface) Terminate low-level module control. More... ATemptyBuffer () Empty internal AT buffer. bool ATgetResponse () Get response after sending AT command. More... bool ATsendCommand (const char *cmd) Send AT command. Will also call ATgetResponse. More... bool ATsendData (uint8_t *data, uint32_t len) Send raw AT data. Will also call ATgetResponse. More... int16_t SPIgetRegValue (uint8_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. More... int16_t SPIsetRegValue (uint8_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. More... void SPIreadRegisterBurst (uint8_t reg, uint8_t numBytes, uint8_t *inBytes) SPI burst read method. More... uint8_t SPIreadRegister (uint8_t reg) SPI basic read method. Use of this method is reserved for special cases, SPIgetRegValue should be used instead. More... void SPIwriteRegisterBurst (uint8_t reg, uint8_t *data, uint8_t numBytes) SPI burst write method. More... void SPIwriteRegister (uint8_t reg, uint8_t data) SPI basic write method. Use of this method is reserved for special cases, SPIsetRegValue should be used instead. More... void SPItransfer (uint8_t cmd, uint8_t reg, uint8_t *dataOut, uint8_t *dataIn, uint8_t numBytes) SPI single transfer method. More... RADIOLIB_PIN_TYPE getCs () const Access method to get the pin number of SPI chip select. More... RADIOLIB_PIN_TYPE getIrq () const Access method to get the pin number of interrupt/GPIO. More... RADIOLIB_PIN_TYPE getRst () const Access method to get the pin number of hardware reset pin. More... RADIOLIB_PIN_TYPE getGpio () const Access method to get the pin number of second interrupt/GPIO. More... RADIOLIB_PIN_TYPE getRx () const Access method to get the pin number of UART Rx. More... RADIOLIB_PIN_TYPE getTx () const Access method to get the pin number of UART Rx. More... SPIClass * getSpi () const Access method to get the SPI interface. More... SPISettings getSpiSettings () const Access method to get the SPI interface settings. More... void setRfSwitchPins (RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn) Some modules contain external RF switch controlled by two pins. This function gives RadioLib control over those two pins to automatically switch Rx and Tx state. When using automatic RF switch control, DO NOT change the pin mode of rxEn or txEn from Arduino sketch! More... void setRfSwitchState (RADIOLIB_PIN_STATUS rxPinState, RADIOLIB_PIN_STATUS txPinState) Set RF switch state. More...
+static void pinMode (RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_MODE mode) Arduino core pinMode override that checks RADIOLIB_NC as alias for unused pin. More... static void digitalWrite (RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_STATUS value) Arduino core digitalWrite override that checks RADIOLIB_NC as alias for unused pin. More... static RADIOLIB_PIN_STATUS digitalRead (RADIOLIB_PIN_TYPE pin) Arduino core digitalWrite override that checks RADIOLIB_NC as alias for unused pin. More... static void tone (RADIOLIB_PIN_TYPE pin, uint16_t value) Arduino core tone override that checks RADIOLIB_NC as alias for unused pin and RADIOLIB_TONE_UNSUPPORTED to make sure the platform does support tone. More... static void noTone (RADIOLIB_PIN_TYPE pin) Arduino core noTone override that checks RADIOLIB_NC as alias for unused pin and RADIOLIB_TONE_UNSUPPORTED to make sure the platform does support tone. More... static void attachInterrupt (RADIOLIB_PIN_TYPE interruptNum, void(*userFunc)(void), RADIOLIB_INTERRUPT_STATUS mode) Arduino core attachInterrupt override. More... static void detachInterrupt (RADIOLIB_PIN_TYPE interruptNum) Arduino core detachInterrupt override. More... yield () Arduino core yield override. static void delay (uint32_t ms) Arduino core delay override. More... static void delayMicroseconds (uint32_t us) Arduino core delayMicroseconds override. More... millis () Arduino core millis override. micros () Arduino core micros override. flipBits (uint8_t b) Function to reflect bits within a byte. flipBits16 (uint16_t i) Function to reflect bits within an integer. ModuleSerial Internal SoftwareSerial instance. baudrate = 9600 Baud rate of SoftwareSerial UART communication. Defaults to 9600 baud. AtLineFeed [3] = {'\r', '\n'} Line feed to be used when sending AT commands. Defaults to CR+LF. SPIreadCommand = 0b00000000 Basic SPI read command. Defaults to 0x00. SPIwriteCommand = 0b10000000 Basic SPI write command. Defaults to 0x80.
+
+
Extension of Module class for UART-based modules, only exists to distinguish the UART constructor.
+
+
+
◆
+
+
+
+
+
+ SerialModule::SerialModule
+ (
+ RADIOLIB_PIN_TYPE
+ rx ,
+
+ RADIOLIB_PIN_TYPE
+ tx ,
+
+ HardwareSerial *
+ serial = nullptr,
+
+ RADIOLIB_PIN_TYPE
+ rst = RADIOLIB_NC
+
+ )
+
+
+
+
+
UART-based module constructor.
+
Parameters
+
+ rx Arduino pin to be used as Rx pin for SoftwareSerial communication. tx Arduino pin to be used as Tx pin for SoftwareSerial communication. serial HardwareSerial to be used on platforms that do not support SoftwareSerial. Defaults to Serial1. rst Arduino pin to be used as hardware reset for the module. Defaults to NC (unused).
+
+
+
+
+
+
The documentation for this class was generated from the following files:
+
+
Parameters
- mod Instance of Module that will be used to communicate with the radio chip. mod Instance of Module that will be used to communicate with the radio chip.
diff --git a/class_si4431.html b/class_si4431.html
index fd59fa44..b844d7ad 100644
--- a/class_si4431.html
+++ b/class_si4431.html
@@ -319,7 +319,7 @@ void Parameters
- mod Instance of Module that will be used to communicate with the radio chip. mod Instance of Module that will be used to communicate with the radio chip.
diff --git a/class_si4432.html b/class_si4432.html
index 1230e323..57a95b87 100644
--- a/class_si4432.html
+++ b/class_si4432.html
@@ -310,7 +310,7 @@ void Parameters
- mod Instance of Module that will be used to communicate with the radio chip. mod Instance of Module that will be used to communicate with the radio chip.
diff --git a/class_si443x.html b/class_si443x.html
index f6c39790..00f8a81b 100644
--- a/class_si443x.html
+++ b/class_si443x.html
@@ -297,7 +297,7 @@ void Parameters
- mod Instance of Module that will be used to communicate with the radio. mod Instance of Module that will be used to communicate with the radio.
diff --git a/class_x_bee.html b/class_x_bee.html
index 18ea8262..cf67fc3f 100644
--- a/class_x_bee.html
+++ b/class_x_bee.html
@@ -148,7 +148,7 @@ void Parameters
- mod Instance of Module that will be used to communicate with the radio. mod Instance of Module that will be used to communicate with the radio.
diff --git a/class_x_bee_serial.html b/class_x_bee_serial.html
index 07145dfc..f641a711 100644
--- a/class_x_bee_serial.html
+++ b/class_x_bee_serial.html
@@ -239,7 +239,7 @@ size_t println (void)<
Default constructor.
Parameters
- mod Instance of Module that will be used to communicate with the radio. mod Instance of Module that will be used to communicate with the radio.
Si4431 SX127x Si4430 SX1279 Si4432 SX1280 Si4431 SX127x AFSKClient ISerial PhysicalLayer Si443x SX1281 Si4432 SX1280 AX25Client ITA2String SSTVClient SX1282 Si443x SX1281 AX25Frame SSTVMode_t SX128x SSTVClient SX1282 RF69 SX1231 SSTVMode_t SX128x JDY08 RFM22 SX1261 SX1231 CC1101 RFM23 SX1262 tone_t SX1261 RFM95 SX1268 TransportLayer SX1262 tone_t LLCC68 RFM96 SX126x SX1268 TransportLayer ESP8266 RFM97 SX1272 SX126x RFM98 SX1273 XBee SX1272 Module RTTYClient SX1276 XBeeSerial SX1273 XBee HC05 MorseClient SX1277 SX1276 XBeeSerial HellClient MQTTClient SX1278 SX1277 HTTPClient Si4430 SX1279 SerialModule SX1278 nRF24 Default constructor.
Parameters
- mod Instance of Module that will be used to communicate with the radio. mod Instance of Module that will be used to communicate with the radio.
Module
Module()
-: Module
+: Module
MorseClient()
-: MorseClient
+: MorseClient
MQTTClient()
: MQTTClient
diff --git a/functions_func_s.html b/functions_func_s.html
index ea4f897f..2795bdaf 100644
--- a/functions_func_s.html
+++ b/functions_func_s.html
@@ -103,6 +103,9 @@ $(document).ready(function(){initNavTree('functions_func_s.html',''); initResiza
sendLine()
: SSTVClient
+SerialModule()
+: SerialModule
+
setAccessAddress()
: SX128x
@@ -377,9 +380,9 @@ $(document).ready(function(){initNavTree('functions_func_s.html',''); initResiza
: CC1101
, RF69
, Si443x
-, SX126x
-, SX127x
-, SX128x
+, SX126x
+, SX127x
+, SX128x
setTCXO()
: SX126x
@@ -433,7 +436,7 @@ $(document).ready(function(){initNavTree('functions_func_s.html',''); initResiza
: Module
SSTVClient()
-: SSTVClient
+: SSTVClient
standby()
: CC1101
@@ -472,7 +475,7 @@ $(document).ready(function(){initNavTree('functions_func_s.html',''); initResiza
startTransmit()
: CC1101
, nRF24
-, PhysicalLayer
+, PhysicalLayer
, RF69
, Si443x
, SX126x
diff --git a/functions_m.html b/functions_m.html
index de60023f..2a36892b 100644
--- a/functions_m.html
+++ b/functions_m.html
@@ -92,13 +92,13 @@ $(document).ready(function(){initNavTree('functions_m.html',''); initResizable()
: Module
Module()
-: Module
+: Module
ModuleSerial
: Module
MorseClient()
-: MorseClient
+: MorseClient
MQTTClient()
: MQTTClient
diff --git a/functions_s.html b/functions_s.html
index df6207a0..173285de 100644
--- a/functions_s.html
+++ b/functions_s.html
@@ -109,6 +109,9 @@ $(document).ready(function(){initNavTree('functions_s.html',''); initResizable()
sendSeqNumber
: AX25Frame
+SerialModule()
+: SerialModule
+
setAccessAddress()
: SX128x
@@ -380,7 +383,7 @@ $(document).ready(function(){initNavTree('functions_s.html',''); initResizable()
: SX126x
setSyncWord()
-: CC1101
+: CC1101
, RF69
, Si443x
, SX126x
@@ -451,7 +454,7 @@ $(document).ready(function(){initNavTree('functions_s.html',''); initResizable()
: AX25Frame
SSTVClient()
-: SSTVClient
+: SSTVClient
standby()
: CC1101
@@ -461,7 +464,7 @@ $(document).ready(function(){initNavTree('functions_s.html',''); initResizable()
, Si443x
, SX126x
, SX127x
-, SX128x
+, SX128x
startDirect()
: PhysicalLayer
@@ -490,7 +493,7 @@ $(document).ready(function(){initNavTree('functions_s.html',''); initResizable()
startTransmit()
: CC1101
, nRF24
-, PhysicalLayer
+, PhysicalLayer
, RF69
, Si443x
, SX126x
diff --git a/hierarchy.html b/hierarchy.html
index 31e643c1..ce6ccdcb 100644
--- a/hierarchy.html
+++ b/hierarchy.html
@@ -98,47 +98,48 @@ $(document).ready(function(){initNavTree('hierarchy.html',''); initResizable();
C JDY08 Control class for JDY08 module. Most methods supported by this module are implemented in ISerial interface C XBeeSerial XBee Serial interface. This class is used for XBees in transparent mode, i.e. when two XBees act as a "wireless UART" C ITA2String ITA2-encoded string C Module Implements all common low-level SPI/UART/I2C methods to control the wireless module. Every module class contains one private instance of this class C MorseClient Client for Morse Code communication. The public interface is the same as Arduino Serial C MQTTClient Client for simple MQTT communication ▼ C PhysicalLayer Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN. Also extracts some common module-independent methods. Using this interface class allows to use the protocols on various modules without much code duplicity. Because this class is used mainly as interface, all of its virtual members must be implemented in the module class C CC1101 Control class for CC1101 module C nRF24 Control class for nRF24 module ▼ C RF69 Control class for RF69 module. Also serves as base class for SX1231 C SX1231 Control class for SX1231 module. Overrides some methods from RF69 due to different register values ▼ C Si443x Base class for Si443x series. All derived classes for Si443x (e.g. Si4431 or Si4432 ) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes ▼ C Si4432 Derived class for Si4432 modules C Si4430 Derived class for Si4430 modules C Si4431 Derived class for Si4431 modules ▼ C SX126x Base class for SX126x series. All derived classes for SX126x (e.g. SX1262 or SX1268 ) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes ▼ C SX1262 Derived class for SX1262 modules C LLCC68 Derived class for LLCC68 modules C SX1261 Derived class for SX1261 modules C SX1268 Derived class for SX1268 modules ▼ C SX127x Base class for SX127x series. All derived classes for SX127x (e.g. SX1278 or SX1272 ) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes ▼ C SX1272 Derived class for SX1272 modules. Also used as base class for SX1273 . Both modules use the same basic hardware and only differ in parameter ranges C SX1273 Derived class for SX1273 modules. Overrides some methods from SX1272 due to different parameter ranges ▼ C SX1278 Derived class for SX1278 modules. Also used as base class for SX1276 , SX1277 , SX1279 , RFM95 and RFM96 . All of these modules use the same basic hardware and only differ in parameter ranges (and names) ▼ C RFM95 Derived class for RFM95 modules. Overrides some methods from SX1278 due to different parameter ranges C RFM97 Derived class for RFM97 modules. Overrides some methods from RFM95 due to different parameter ranges C RFM96 Derived class for RFM96 modules. Overrides some methods from SX1278 due to different parameter ranges C SX1276 Derived class for SX1276 modules. Overrides some methods from SX1278 due to different parameter ranges C SX1277 Derived class for SX1277 modules. Overrides some methods from SX1278 due to different parameter ranges C SX1279 Derived class for SX1279 modules. Overrides some methods from SX1278 due to different parameter ranges ▼ C SX128x Base class for SX128x series. All derived classes for SX128x (e.g. SX1280 or SX1281 ) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes ▼ C SX1281 Derived class for SX1281 modules ▼ C SX1280 Derived class for SX1280 modules C SX1282 Derived class for SX1282 modules C RFM22 Only exists as alias for Si4432 , since there seems to be no difference between RFM22 and Si4432 modules C RFM23 Only exists as alias for Si4431 , since there seems to be no difference between RFM23 and Si4431 modules C RFM98 Only exists as alias for RFM96 , since there seems to be no difference between RFM96 and RFM98 modules C RTTYClient Client for RTTY communication. The public interface is the same as Arduino Serial C SSTVClient Client for SSTV transmissions C SSTVMode_t Structure to save data about supported SSTV modes C tone_t Structure to save data about tone ▼ C TransportLayer Provides common interface for protocols that run on modules with Internet connectivity, such as HTTP or MQTT. Because this class is used mainly as interface, all of its virtual members must be implemented in the module class C ESP8266 Control class for ESP8266 module. Implements TransportLayer methods C XBee Control class for XBee modules ▼ C Module Implements all common low-level SPI/UART methods to control the wireless module. Every module class contains one private instance of this class C SerialModule Extension of Module class for UART-based modules, only exists to distinguish the UART constructor C MorseClient Client for Morse Code communication. The public interface is the same as Arduino Serial C MQTTClient Client for simple MQTT communication ▼ C PhysicalLayer Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN. Also extracts some common module-independent methods. Using this interface class allows to use the protocols on various modules without much code duplicity. Because this class is used mainly as interface, all of its virtual members must be implemented in the module class C CC1101 Control class for CC1101 module C nRF24 Control class for nRF24 module ▼ C RF69 Control class for RF69 module. Also serves as base class for SX1231 C SX1231 Control class for SX1231 module. Overrides some methods from RF69 due to different register values ▼ C Si443x Base class for Si443x series. All derived classes for Si443x (e.g. Si4431 or Si4432 ) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes ▼ C Si4432 Derived class for Si4432 modules C Si4430 Derived class for Si4430 modules C Si4431 Derived class for Si4431 modules ▼ C SX126x Base class for SX126x series. All derived classes for SX126x (e.g. SX1262 or SX1268 ) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes ▼ C SX1262 Derived class for SX1262 modules C LLCC68 Derived class for LLCC68 modules C SX1261 Derived class for SX1261 modules C SX1268 Derived class for SX1268 modules ▼ C SX127x Base class for SX127x series. All derived classes for SX127x (e.g. SX1278 or SX1272 ) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes ▼ C SX1272 Derived class for SX1272 modules. Also used as base class for SX1273 . Both modules use the same basic hardware and only differ in parameter ranges C SX1273 Derived class for SX1273 modules. Overrides some methods from SX1272 due to different parameter ranges ▼ C SX1278 Derived class for SX1278 modules. Also used as base class for SX1276 , SX1277 , SX1279 , RFM95 and RFM96 . All of these modules use the same basic hardware and only differ in parameter ranges (and names) ▼ C RFM95 Derived class for RFM95 modules. Overrides some methods from SX1278 due to different parameter ranges C RFM97 Derived class for RFM97 modules. Overrides some methods from RFM95 due to different parameter ranges C RFM96 Derived class for RFM96 modules. Overrides some methods from SX1278 due to different parameter ranges C SX1276 Derived class for SX1276 modules. Overrides some methods from SX1278 due to different parameter ranges C SX1277 Derived class for SX1277 modules. Overrides some methods from SX1278 due to different parameter ranges C SX1279 Derived class for SX1279 modules. Overrides some methods from SX1278 due to different parameter ranges ▼ C SX128x Base class for SX128x series. All derived classes for SX128x (e.g. SX1280 or SX1281 ) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes ▼ C SX1281 Derived class for SX1281 modules ▼ C SX1280 Derived class for SX1280 modules C SX1282 Derived class for SX1282 modules C RFM22 Only exists as alias for Si4432 , since there seems to be no difference between RFM22 and Si4432 modules C RFM23 Only exists as alias for Si4431 , since there seems to be no difference between RFM23 and Si4431 modules C RFM98 Only exists as alias for RFM96 , since there seems to be no difference between RFM96 and RFM98 modules C RTTYClient Client for RTTY communication. The public interface is the same as Arduino Serial C SSTVClient Client for SSTV transmissions C SSTVMode_t Structure to save data about supported SSTV modes C tone_t Structure to save data about tone ▼ C TransportLayer Provides common interface for protocols that run on modules with Internet connectivity, such as HTTP or MQTT. Because this class is used mainly as interface, all of its virtual members must be implemented in the module class C ESP8266 Control class for ESP8266 module. Implements TransportLayer methods C XBee Control class for XBee modules
int16_t setOutputPower(int8_t power)
Sets output power. Allowed values are -18, -12, -6 or 0 dBm.
Definition: nRF24.cpp:274
int16_t getStatus(uint8_t mask=0xFF)
Gets nRF24 status register.
Definition: nRF24.cpp:432
int16_t sleep()
Sets the module to sleep mode.
Definition: nRF24.cpp:66
Implements all common low-level SPI/UART/I2C methods to control the wireless module....
Definition: Module.h:17
Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...
Definition: Module.h:17
Control class for nRF24 module.
Definition: nRF24.h:179
int16_t begin(int16_t freq=2400, int16_t dataRate=1000, int8_t power=-12, uint8_t addrWidth=5)
Initialization method.
Definition: nRF24.cpp:8
int16_t setFrequency(int16_t freq)
Sets carrier frequency. Allowed values range from 2400 MHz to 2525 MHz.
Definition: nRF24.cpp:244
Member SX127x::setBitRate (float br)
Member SX1282::SX1282 (Module *mod)
+Member SX1282::SX1282 (Module *mod)
Member SX128x::getTimeOnAir (size_t len)
SX1280 datasheet v3.0 section 7.4.4.2 
1.8.17
+ 
+
+
+
+
Public Member Functions inherited from Module