From 7b61114e9a2f2f812d2b4fd9e7bee6fa852370ac Mon Sep 17 00:00:00 2001 From: jgromes Date: Sun, 5 Sep 2021 10:03:49 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=203f803?= =?UTF-8?q?f0e16ca30e451b255b54803a99eb828da3d=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- _c_c1101_8h_source.html | 2 +- _e_s_p8266_8h_source.html | 2 +- _h_c05_8h_source.html | 2 +- _i_serial_8h_source.html | 2 +- _j_d_y08_8h_source.html | 2 +- _l_l_c_c68_8h_source.html | 2 +- _module_8h_source.html | 378 ++++++++++++----------- _r_f69_8h_source.html | 2 +- _r_f_m95_8h_source.html | 2 +- _r_f_m96_8h_source.html | 2 +- _r_f_m97_8h_source.html | 2 +- _radio_lib_8h_source.html | 2 +- _s_x1231_8h_source.html | 2 +- _s_x1261_8h_source.html | 2 +- _s_x1262_8h_source.html | 2 +- _s_x1268_8h_source.html | 2 +- _s_x126x_8h_source.html | 2 +- _s_x1272_8h_source.html | 2 +- _s_x1273_8h_source.html | 2 +- _s_x1276_8h_source.html | 2 +- _s_x1277_8h_source.html | 2 +- _s_x1278_8h_source.html | 2 +- _s_x1279_8h_source.html | 2 +- _s_x127x_8h_source.html | 2 +- _s_x1280_8h_source.html | 2 +- _s_x1281_8h_source.html | 2 +- _s_x1282_8h_source.html | 2 +- _s_x128x_8h_source.html | 2 +- _si4430_8h_source.html | 2 +- _si4431_8h_source.html | 2 +- _si4432_8h_source.html | 2 +- _si443x_8h_source.html | 2 +- _x_bee_8h_source.html | 2 +- annotated.html | 55 ++-- annotated_dup.js | 1 + class_c_c1101.html | 2 +- class_e_s_p8266.html | 2 +- class_h_c05.html | 2 +- class_j_d_y08.html | 2 +- class_l_l_c_c68.html | 2 +- class_module-members.html | 22 +- class_module.html | 90 ++---- class_module.js | 2 +- class_module.png | Bin 0 -> 428 bytes class_r_f69.html | 2 +- class_r_f_m95.html | 2 +- class_r_f_m96.html | 2 +- class_r_f_m97.html | 2 +- class_s_x1231.html | 2 +- class_s_x1261.html | 2 +- class_s_x1262.html | 2 +- class_s_x1268.html | 2 +- class_s_x126x.html | 2 +- class_s_x1272.html | 2 +- class_s_x1273.html | 2 +- class_s_x1276.html | 2 +- class_s_x1277.html | 2 +- class_s_x1278.html | 2 +- class_s_x1279.html | 2 +- class_s_x127x.html | 2 +- class_s_x1280.html | 2 +- class_s_x1281.html | 2 +- class_s_x1282.html | 2 +- class_s_x128x.html | 2 +- class_serial_module-members.html | 153 ++++++++++ class_serial_module.html | 347 +++++++++++++++++++++ class_serial_module.js | 4 + class_serial_module.png | Bin 0 -> 427 bytes class_si4430.html | 2 +- class_si4431.html | 2 +- class_si4432.html | 2 +- class_si443x.html | 2 +- class_x_bee.html | 2 +- class_x_bee_serial.html | 2 +- classes.html | 63 ++-- classn_r_f24.html | 2 +- functions_func_m.html | 4 +- functions_func_s.html | 13 +- functions_m.html | 4 +- functions_s.html | 11 +- hierarchy.html | 83 ++--- hierarchy.js | 4 +- n_r_f24_8h_source.html | 2 +- navtreedata.js | 4 +- navtreeindex0.js | 6 +- navtreeindex1.js | 160 +++++----- navtreeindex2.js | 500 +++++++++++++++---------------- navtreeindex3.js | 128 ++++---- navtreeindex4.js | 32 +- search/all_10.js | 205 ++++++------- search/all_11.js | 18 +- search/all_12.js | 4 +- search/all_13.js | 4 +- search/all_14.js | 2 +- search/all_15.js | 4 +- search/all_16.js | 2 +- search/all_17.js | 4 +- search/all_b.js | 2 +- search/classes_0.js | 6 +- search/classes_1.js | 2 +- search/classes_2.js | 2 +- search/classes_3.js | 6 +- search/classes_4.js | 4 +- search/classes_5.js | 2 +- search/classes_6.js | 2 +- search/classes_7.js | 6 +- search/classes_8.js | 2 +- search/classes_9.js | 2 +- search/classes_a.js | 16 +- search/classes_b.js | 45 +-- search/classes_c.js | 4 +- search/classes_d.js | 4 +- search/functions_0.js | 20 +- search/functions_1.js | 12 +- search/functions_10.js | 201 ++++++------- search/functions_11.js | 8 +- search/functions_12.js | 2 +- search/functions_13.js | 2 +- search/functions_14.js | 4 +- search/functions_15.js | 2 +- search/functions_16.js | 4 +- search/functions_2.js | 18 +- search/functions_3.js | 20 +- search/functions_4.js | 8 +- search/functions_5.js | 8 +- search/functions_6.js | 64 ++-- search/functions_7.js | 6 +- search/functions_8.js | 12 +- search/functions_9.js | 4 +- search/functions_a.js | 4 +- search/functions_b.js | 10 +- search/functions_c.js | 4 +- search/functions_d.js | 4 +- search/functions_e.js | 14 +- search/functions_f.js | 28 +- search/groups_0.js | 2 +- search/groups_1.js | 2 +- search/groups_2.js | 4 +- search/groups_3.js | 2 +- search/pages_0.js | 2 +- search/pages_1.js | 2 +- search/variables_0.js | 2 +- search/variables_1.js | 2 +- search/variables_2.js | 2 +- search/variables_3.js | 4 +- search/variables_4.js | 2 +- search/variables_5.js | 2 +- search/variables_6.js | 4 +- search/variables_7.js | 2 +- search/variables_8.js | 2 +- search/variables_9.js | 4 +- search/variables_a.js | 2 +- search/variables_b.js | 6 +- search/variables_c.js | 12 +- search/variables_d.js | 4 +- search/variables_e.js | 2 +- search/variables_f.js | 2 +- todo.html | 2 +- 158 files changed, 1783 insertions(+), 1288 deletions(-) create mode 100644 class_module.png create mode 100644 class_serial_module-members.html create mode 100644 class_serial_module.html create mode 100644 class_serial_module.js create mode 100644 class_serial_module.png 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
diff --git a/_e_s_p8266_8h_source.html b/_e_s_p8266_8h_source.html index b550d9db..476a1cdc 100644 --- a/_e_s_p8266_8h_source.html +++ b/_e_s_p8266_8h_source.html @@ -137,7 +137,7 @@ $(document).ready(function(){initNavTree('_e_s_p8266_8h_source.html',''); initRe
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
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
-
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