From 259401bf1a12b6b1e06de6cd351809fa06053f20 Mon Sep 17 00:00:00 2001 From: jgromes Date: Fri, 18 Nov 2022 12:40:45 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=20f942c?= =?UTF-8?q?caec717eff2b7d80fb84909df4e1056a1ca=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- _s_x1262_8h_source.html | 2 +- _s_x1268_8h_source.html | 2 +- _s_x126x_8h_source.html | 530 ++++++++++++++++++----------------- class_l_l_c_c68-members.html | 4 +- class_l_l_c_c68.html | 12 +- class_physical_layer.html | 4 +- class_s_x1261-members.html | 4 +- class_s_x1261.html | 12 +- class_s_x1262-members.html | 4 +- class_s_x1262.html | 12 +- class_s_x1268-members.html | 4 +- class_s_x1268.html | 12 +- class_s_x126x-members.html | 4 +- class_s_x126x.html | 74 ++++- class_s_x126x.js | 4 +- functions_func_s.html | 4 +- functions_s.html | 4 +- navtreeindex1.js | 2 +- navtreeindex2.js | 2 +- search/all_f.js | 4 +- search/functions_f.js | 4 +- 21 files changed, 378 insertions(+), 326 deletions(-) diff --git a/_s_x1262_8h_source.html b/_s_x1262_8h_source.html index cd43ccda..ca75962c 100644 --- a/_s_x1262_8h_source.html +++ b/_s_x1262_8h_source.html @@ -135,7 +135,7 @@ $(document).ready(function(){initNavTree('_s_x1262_8h_source.html',''); initResi
SX1262::beginFSK
int16_t beginFSK(float freq=434.0, float br=4.8, float freqDev=5.0, float rxBw=156.2, int8_t power=10, uint16_t preambleLength=16, float tcxoVoltage=1.6, bool useRegulatorLDO=false)
Initialization method for FSK modem.
Definition: SX1262.cpp:32
SX1262::setOutputPower
virtual int16_t setOutputPower(int8_t power)
Sets output power. Allowed values are in range from -9 to 22 dBm. This method is virtual to allow ove...
Definition: SX1262.cpp:84
SX1262
Derived class for SX1262 modules.
Definition: SX1262.h:19
-
SX126x
Base class for SX126x series. All derived classes for SX126x (e.g. SX1262 or SX1268) inherit from thi...
Definition: SX126x.h:362
+
SX126x
Base class for SX126x series. All derived classes for SX126x (e.g. SX1262 or SX1268) inherit from thi...
Definition: SX126x.h:364
SX126x::variablePacketLengthMode
int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX126X_MAX_PACKET_LENGTH)
Set modem in variable packet length mode. Available in FSK mode only.
Definition: SX126x.cpp:1132
@@ -687,7 +689,7 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
SX126x::receive
int16_t receive(uint8_t *data, size_t len) override
Blocking binary receive method. Overloads for string-based transmissions are implemented in PhysicalL...
Definition: SX126x.cpp:243
SX126x::getCurrentLimit
float getCurrentLimit()
Reads current protection limit.
Definition: SX126x.cpp:740
SX126x::clearDio1Action
void clearDio1Action()
Clears interrupt service routine to call when DIO1 activates.
Definition: SX126x.cpp:370
-
SX126x::getIrqStatus
uint16_t getIrqStatus()
Reads the current IRQ status.
Definition: SX126x.cpp:1418
+
SX126x::getIrqStatus
uint16_t getIrqStatus()
Reads the current IRQ status.
Definition: SX126x.cpp:1411
SX126x::setSyncWord
int16_t setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)
Sets LoRa sync word.
Definition: SX126x.cpp:716
SX126x::startReceive
int16_t startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF)
Interrupt-driven receive method. DIO1 will be activated when full packet is received.
Definition: SX126x.cpp:443
SX126x::setRegulatorDCDC
int16_t setRegulatorDCDC()
Set regulator mode to DC-DC.
Definition: SX126x.cpp:1190
@@ -708,16 +710,16 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
SX126x::implicitHeader
int16_t implicitHeader(size_t len)
Set implicit header mode for future reception/transmission.
Definition: SX126x.cpp:1178
SX126x::setRxBandwidth
int16_t setRxBandwidth(float rxBw)
Sets FSK receiver bandwidth. Allowed values are 4.8, 5.8, 7.3, 9.7, 11.7, 14.6, 19....
Definition: SX126x.cpp:810
SX126x::forceLDRO
int16_t forceLDRO(bool enable)
Forces LoRa low data rate optimization. Only available in LoRa mode. After calling this method,...
Definition: SX126x.cpp:1202
-
SX126x::scanChannel
int16_t scanChannel()
Performs scan for LoRa transmission in the current channel. Detects both preamble and payload.
Definition: SX126x.cpp:324
SX126x::getDataRate
float getDataRate() const
Gets effective data rate for the last transmitted packet. The value is calculated only for payload by...
Definition: SX126x.cpp:1094
SX126x::autoLDRO
int16_t autoLDRO()
Re-enables automatic LDRO configuration. Only available in LoRa mode. After calling this method,...
Definition: SX126x.cpp:1214
SX126x::setDio1Action
void setDio1Action(void(*func)(void))
Sets interrupt service routine to call when DIO1 activates.
Definition: SX126x.cpp:366
SX126x::setTCXO
int16_t setTCXO(float voltage, uint32_t delay=5000)
Sets TCXO (Temperature Compensated Crystal Oscillator) configuration.
Definition: SX126x.cpp:1262
+
SX126x::startChannelScan
int16_t startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)
Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is dete...
Definition: SX126x.cpp:592
SX126x::startTransmit
int16_t startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override
Interrupt-driven binary transmit method. Overloads for string-based transmissions are implemented in ...
Definition: SX126x.cpp:374
SX126x::setCRC
int16_t setCRC(uint8_t len, uint16_t initial=0x1D0F, uint16_t polynomial=0x1021, bool inverted=true)
Sets CRC configuration.
Definition: SX126x.cpp:998
SX126x::getChannelScanResult
int16_t getChannelScanResult()
Read the channel scan result.
Definition: SX126x.cpp:618
+
SX126x::scanChannel
int16_t scanChannel(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)
Performs scan for LoRa transmission in the current channel. Detects both preamble and payload.
Definition: SX126x.cpp:324
SX126x::setDataShaping
int16_t setDataShaping(uint8_t sh) override
Sets time-bandwidth product of Gaussian filter applied for shaping. Allowed values are RADIOLIB_SHAPI...
Definition: SX126x.cpp:873
-
SX126x::startChannelScan
int16_t startChannelScan()
Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is dete...
Definition: SX126x.cpp:592
SX126x::randomByte
uint8_t randomByte()
Get one truly random byte from RSSI noise.
Definition: SX126x.cpp:1223
PhysicalLayer
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:14
PhysicalLayer::receive
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:104
@@ -734,7 +736,7 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
SX126x::getSNR
float getSNR()
Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem.
Definition: SX126x.cpp:1105
SX126x::standby
int16_t standby() override
Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator)...
Definition: SX126x.cpp:354
SX126x::transmitDirect
int16_t transmitDirect(uint32_t frf=0) override
Starts direct mode transmission.
Definition: SX126x.cpp:300
-
SX126x
Base class for SX126x series. All derived classes for SX126x (e.g. SX1262 or SX1268) inherit from thi...
Definition: SX126x.h:362
+
SX126x
Base class for SX126x series. All derived classes for SX126x (e.g. SX1262 or SX1268) inherit from thi...
Definition: SX126x.h:364
SX126x::finishTransmit
int16_t finishTransmit() override
Clean up after transmission is done.
Definition: SX126x.cpp:435
SX126x::setBitRate
int16_t setBitRate(float br)
Sets FSK bit rate. Allowed values range from 0.6 to 300.0 kbps.
Definition: SX126x.cpp:789
PhysicalLayer::startTransmit
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:53
diff --git a/class_l_l_c_c68-members.html b/class_l_l_c_c68-members.html index 2724a2c1..2887463b 100644 --- a/class_l_l_c_c68-members.html +++ b/class_l_l_c_c68-members.html @@ -132,7 +132,7 @@ $(document).ready(function(){initNavTree('class_l_l_c_c68.html',''); initResizab PhysicalLayer::receive(String &str, size_t len=0)PhysicalLayer receiveDirect() overrideSX126xvirtual reset(bool verify=true)SX126x - scanChannel()SX126x + scanChannel(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x setBandwidth(float bw)LLCC68 setBitRate(float br)SX126xvirtual setBroadcastAddress(uint8_t broadAddr)SX126x @@ -165,7 +165,7 @@ $(document).ready(function(){initNavTree('class_l_l_c_c68.html',''); initResizab sleep(bool retainConfig=true)SX126x standby() overrideSX126xvirtual standby(uint8_t mode)SX126x - startChannelScan()SX126x + startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x startDirect()PhysicalLayer startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF)SX126x startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod)SX126x diff --git a/class_l_l_c_c68.html b/class_l_l_c_c68.html index ee3c54b4..d5c09c6a 100644 --- a/class_l_l_c_c68.html +++ b/class_l_l_c_c68.html @@ -167,9 +167,9 @@ Public Member Functions int16_t receiveDirect () override  Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as SX126x series does not support direct mode reception. Will always return RADIOLIB_ERR_UNKNOWN. More...
  -int16_t scanChannel () - Performs scan for LoRa transmission in the current channel. Detects both preamble and payload. More...
-  +int16_t scanChannel (uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT) + Performs scan for LoRa transmission in the current channel. Detects both preamble and payload. More...
+  int16_t sleep (bool retainConfig=true)  Sets the module to sleep mode. More...
  @@ -207,9 +207,9 @@ void int16_t readData (uint8_t *data, size_t len) override  Reads data received after calling startReceive method. More...
  -int16_t startChannelScan () - Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is detected, or upon timeout. More...
-  +int16_t startChannelScan (uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT) + Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is detected, or upon timeout. More...
+  int16_t getChannelScanResult ()  Read the channel scan result. More...
  diff --git a/class_physical_layer.html b/class_physical_layer.html index c6bf26a9..7665abbd 100644 --- a/class_physical_layer.html +++ b/class_physical_layer.html @@ -406,7 +406,7 @@ class PagerClient
Returns
Length of last received packet in bytes.
-

Implemented in SX127x, RF69, SX126x, CC1101, SX128x, Si443x, and nRF24.

+

Implemented in SX127x, SX126x, RF69, CC1101, SX128x, Si443x, and nRF24.

@@ -999,7 +999,7 @@ class PagerClient
Returns
Status Codes
-

Implemented in SX127x, RF69, CC1101, SX126x, SX128x, Si443x, and nRF24.

+

Implemented in SX127x, RF69, SX126x, CC1101, SX128x, Si443x, and nRF24.

diff --git a/class_s_x1261-members.html b/class_s_x1261-members.html index 2571ed95..e1f3a07a 100644 --- a/class_s_x1261-members.html +++ b/class_s_x1261-members.html @@ -131,7 +131,7 @@ $(document).ready(function(){initNavTree('class_s_x1261.html',''); initResizable PhysicalLayer::receive(String &str, size_t len=0)PhysicalLayer receiveDirect() overrideSX126xvirtual reset(bool verify=true)SX126x - scanChannel()SX126x + scanChannel(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x setBandwidth(float bw)SX126x setBitRate(float br)SX126xvirtual setBroadcastAddress(uint8_t broadAddr)SX126x @@ -164,7 +164,7 @@ $(document).ready(function(){initNavTree('class_s_x1261.html',''); initResizable sleep(bool retainConfig=true)SX126x standby() overrideSX126xvirtual standby(uint8_t mode)SX126x - startChannelScan()SX126x + startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x startDirect()PhysicalLayer startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF)SX126x startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod)SX126x diff --git a/class_s_x1261.html b/class_s_x1261.html index 5926bd0f..277b95db 100644 --- a/class_s_x1261.html +++ b/class_s_x1261.html @@ -158,9 +158,9 @@ Public Member Functions int16_t receiveDirect () override  Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as SX126x series does not support direct mode reception. Will always return RADIOLIB_ERR_UNKNOWN. More...
  -int16_t scanChannel () - Performs scan for LoRa transmission in the current channel. Detects both preamble and payload. More...
-  +int16_t scanChannel (uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT) + Performs scan for LoRa transmission in the current channel. Detects both preamble and payload. More...
+  int16_t sleep (bool retainConfig=true)  Sets the module to sleep mode. More...
  @@ -198,9 +198,9 @@ void int16_t readData (uint8_t *data, size_t len) override  Reads data received after calling startReceive method. More...
  -int16_t startChannelScan () - Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is detected, or upon timeout. More...
-  +int16_t startChannelScan (uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT) + Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is detected, or upon timeout. More...
+  int16_t getChannelScanResult ()  Read the channel scan result. More...
  diff --git a/class_s_x1262-members.html b/class_s_x1262-members.html index 5b9d9ffb..46e32ac8 100644 --- a/class_s_x1262-members.html +++ b/class_s_x1262-members.html @@ -131,7 +131,7 @@ $(document).ready(function(){initNavTree('class_s_x1262.html',''); initResizable PhysicalLayer::receive(String &str, size_t len=0)PhysicalLayer receiveDirect() overrideSX126xvirtual reset(bool verify=true)SX126x - scanChannel()SX126x + scanChannel(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x setBandwidth(float bw)SX126x setBitRate(float br)SX126xvirtual setBroadcastAddress(uint8_t broadAddr)SX126x @@ -164,7 +164,7 @@ $(document).ready(function(){initNavTree('class_s_x1262.html',''); initResizable sleep(bool retainConfig=true)SX126x standby() overrideSX126xvirtual standby(uint8_t mode)SX126x - startChannelScan()SX126x + startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x startDirect()PhysicalLayer startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF)SX126x startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod)SX126x diff --git a/class_s_x1262.html b/class_s_x1262.html index e2c8d3f4..0afb567f 100644 --- a/class_s_x1262.html +++ b/class_s_x1262.html @@ -155,9 +155,9 @@ Public Member Functions int16_t receiveDirect () override  Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as SX126x series does not support direct mode reception. Will always return RADIOLIB_ERR_UNKNOWN. More...
  -int16_t scanChannel () - Performs scan for LoRa transmission in the current channel. Detects both preamble and payload. More...
-  +int16_t scanChannel (uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT) + Performs scan for LoRa transmission in the current channel. Detects both preamble and payload. More...
+  int16_t sleep (bool retainConfig=true)  Sets the module to sleep mode. More...
  @@ -195,9 +195,9 @@ void int16_t readData (uint8_t *data, size_t len) override  Reads data received after calling startReceive method. More...
  -int16_t startChannelScan () - Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is detected, or upon timeout. More...
-  +int16_t startChannelScan (uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT) + Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is detected, or upon timeout. More...
+  int16_t getChannelScanResult ()  Read the channel scan result. More...
  diff --git a/class_s_x1268-members.html b/class_s_x1268-members.html index 5d70f830..15432563 100644 --- a/class_s_x1268-members.html +++ b/class_s_x1268-members.html @@ -131,7 +131,7 @@ $(document).ready(function(){initNavTree('class_s_x1268.html',''); initResizable PhysicalLayer::receive(String &str, size_t len=0)PhysicalLayer receiveDirect() overrideSX126xvirtual reset(bool verify=true)SX126x - scanChannel()SX126x + scanChannel(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x setBandwidth(float bw)SX126x setBitRate(float br)SX126xvirtual setBroadcastAddress(uint8_t broadAddr)SX126x @@ -164,7 +164,7 @@ $(document).ready(function(){initNavTree('class_s_x1268.html',''); initResizable sleep(bool retainConfig=true)SX126x standby() overrideSX126xvirtual standby(uint8_t mode)SX126x - startChannelScan()SX126x + startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x startDirect()PhysicalLayer startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF)SX126x startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod)SX126x diff --git a/class_s_x1268.html b/class_s_x1268.html index 3d2dcbe8..f3d92021 100644 --- a/class_s_x1268.html +++ b/class_s_x1268.html @@ -153,9 +153,9 @@ Public Member Functions int16_t receiveDirect () override  Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as SX126x series does not support direct mode reception. Will always return RADIOLIB_ERR_UNKNOWN. More...
  -int16_t scanChannel () - Performs scan for LoRa transmission in the current channel. Detects both preamble and payload. More...
-  +int16_t scanChannel (uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT) + Performs scan for LoRa transmission in the current channel. Detects both preamble and payload. More...
+  int16_t sleep (bool retainConfig=true)  Sets the module to sleep mode. More...
  @@ -193,9 +193,9 @@ void int16_t readData (uint8_t *data, size_t len) override  Reads data received after calling startReceive method. More...
  -int16_t startChannelScan () - Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is detected, or upon timeout. More...
-  +int16_t startChannelScan (uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT) + Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is detected, or upon timeout. More...
+  int16_t getChannelScanResult ()  Read the channel scan result. More...
  diff --git a/class_s_x126x-members.html b/class_s_x126x-members.html index e65e91d2..659525f0 100644 --- a/class_s_x126x-members.html +++ b/class_s_x126x-members.html @@ -129,7 +129,7 @@ $(document).ready(function(){initNavTree('class_s_x126x.html',''); initResizable PhysicalLayer::receive(String &str, size_t len=0)PhysicalLayer receiveDirect() overrideSX126xvirtual reset(bool verify=true)SX126x - scanChannel()SX126x + scanChannel(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x setBandwidth(float bw)SX126x setBitRate(float br)SX126xvirtual setBroadcastAddress(uint8_t broadAddr)SX126x @@ -160,7 +160,7 @@ $(document).ready(function(){initNavTree('class_s_x126x.html',''); initResizable sleep(bool retainConfig=true)SX126x standby() overrideSX126xvirtual standby(uint8_t mode)SX126x - startChannelScan()SX126x + startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x startDirect()PhysicalLayer startReceive(uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF)SX126x startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod)SX126x diff --git a/class_s_x126x.html b/class_s_x126x.html index 694dd44e..068db3e7 100644 --- a/class_s_x126x.html +++ b/class_s_x126x.html @@ -137,9 +137,9 @@ Public Member Functions int16_t receiveDirect () override  Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as SX126x series does not support direct mode reception. Will always return RADIOLIB_ERR_UNKNOWN. More...
  -int16_t scanChannel () - Performs scan for LoRa transmission in the current channel. Detects both preamble and payload. More...
-  +int16_t scanChannel (uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT) + Performs scan for LoRa transmission in the current channel. Detects both preamble and payload. More...
+  int16_t sleep (bool retainConfig=true)  Sets the module to sleep mode. More...
  @@ -177,9 +177,9 @@ void int16_t readData (uint8_t *data, size_t len) override  Reads data received after calling startReceive method. More...
  -int16_t startChannelScan () - Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is detected, or upon timeout. More...
-  +int16_t startChannelScan (uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT) + Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is detected, or upon timeout. More...
+  int16_t getChannelScanResult ()  Read the channel scan result. More...
  @@ -1258,8 +1258,8 @@ void  -

◆ scanChannel()

+ +

◆ scanChannel()

@@ -1267,13 +1267,38 @@ void int16_t SX126x::scanChannel ( - ) + uint8_t  + symbolNum = RADIOLIB_SX126X_CAD_PARAM_DEFAULT, + + + + uint8_t  + detPeak = RADIOLIB_SX126X_CAD_PARAM_DEFAULT, + + + + + uint8_t  + detMin = RADIOLIB_SX126X_CAD_PARAM_DEFAULT  + + + + ) +

Performs scan for LoRa transmission in the current channel. Detects both preamble and payload.

+
Parameters
+ + + + +
symbolNumNumber of symbols for CAD detection. Defaults to the value recommended by AN1200.48.
detPeakPeak value for CAD detection. Defaults to the value recommended by AN1200.48.
detMinMinimum value for CAD detection. Defaults to the value recommended by AN1200.48.
+
+
Returns
Status Codes
@@ -2128,8 +2153,8 @@ void  -

◆ startChannelScan()

+ +

◆ startChannelScan()

@@ -2137,13 +2162,38 @@ void int16_t SX126x::startChannelScan ( - ) + uint8_t  + symbolNum = RADIOLIB_SX126X_CAD_PARAM_DEFAULT, + + + + uint8_t  + detPeak = RADIOLIB_SX126X_CAD_PARAM_DEFAULT, + + + + + uint8_t  + detMin = RADIOLIB_SX126X_CAD_PARAM_DEFAULT  + + + + ) +

Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is detected, or upon timeout.

+
Parameters
+ + + + +
symbolNumNumber of symbols for CAD detection. Defaults to the value recommended by AN1200.48.
detPeakPeak value for CAD detection. Defaults to the value recommended by AN1200.48.
detMinMinimum value for CAD detection. Defaults to the value recommended by AN1200.48.
+
+
Returns
Status Codes
diff --git a/class_s_x126x.js b/class_s_x126x.js index 86dd5a43..dba44b27 100644 --- a/class_s_x126x.js +++ b/class_s_x126x.js @@ -32,7 +32,7 @@ var class_s_x126x = [ "receive", "class_s_x126x.html#a2ad4c6a8ac267f8ac590260414ffcda3", null ], [ "receiveDirect", "class_s_x126x.html#a8a18aee2bf05793aa29b5cf6b47bb435", null ], [ "reset", "class_s_x126x.html#a9aa6dd05dd32ef717a06cc8ba28ff71f", null ], - [ "scanChannel", "class_s_x126x.html#ae9f24414bd684434c310df54b3558f21", null ], + [ "scanChannel", "class_s_x126x.html#a755e7df4b0958f7c793d0c058408831a", null ], [ "setBandwidth", "class_s_x126x.html#a2f60df59c80241d98ce078c0417a7f08", null ], [ "setBitRate", "class_s_x126x.html#a7deeef45d7f64a4018a3e56aaea4eb0e", null ], [ "setBroadcastAddress", "class_s_x126x.html#abd8eea7e468db3d6064c19d4934d5034", null ], @@ -60,7 +60,7 @@ var class_s_x126x = [ "sleep", "class_s_x126x.html#afb5509f0705cdd971065251ed6b2fb4e", null ], [ "standby", "class_s_x126x.html#a7a1579e2557c36a4a34b09039c0d0c71", null ], [ "standby", "class_s_x126x.html#ad7569396f09f3867dc1bd4d4a0613acd", null ], - [ "startChannelScan", "class_s_x126x.html#a37a716aab163aebbe36599dc7e530c92", null ], + [ "startChannelScan", "class_s_x126x.html#a10a0e75571350fb05fa100e5d5151be2", null ], [ "startReceive", "class_s_x126x.html#aeb92dc9d2e2a2b3a3a5ff2856528d497", null ], [ "startReceiveDutyCycle", "class_s_x126x.html#adc46b6adda2d0e82e25ed1fc78274136", null ], [ "startReceiveDutyCycleAuto", "class_s_x126x.html#a6b50cb78f02a3d93939437eb48489d3f", null ], diff --git a/functions_func_s.html b/functions_func_s.html index d11ff808..87de2968 100644 --- a/functions_func_s.html +++ b/functions_func_s.html @@ -86,7 +86,7 @@ $(document).ready(function(){initNavTree('functions_func_s.html',''); initResiza

- s -

  • scanChannel() -: SX126x +: SX126x , SX127x , SX128x
    • @@ -487,7 +487,7 @@ $(document).ready(function(){initNavTree('functions_func_s.html',''); initResiza , SX128x
  • startChannelScan() -: SX126x +: SX126x , SX127x
  • startDirect() diff --git a/functions_s.html b/functions_s.html index 48a96e0b..2847a682 100644 --- a/functions_s.html +++ b/functions_s.html @@ -86,7 +86,7 @@ $(document).ready(function(){initNavTree('functions_s.html',''); initResizable()

    - s -

    • scanChannel() -: SX126x +: SX126x , SX127x , SX128x
      • @@ -505,7 +505,7 @@ $(document).ready(function(){initNavTree('functions_s.html',''); initResizable() , SX128x
    • startChannelScan() -: SX126x +: SX126x , SX127x
    • startDirect() diff --git a/navtreeindex1.js b/navtreeindex1.js index bedc7849..a93c94b3 100644 --- a/navtreeindex1.js +++ b/navtreeindex1.js @@ -233,6 +233,7 @@ var NAVTREEINDEX1 = "class_s_x126x.html":[3,0,32], "class_s_x126x.html#a0da667fe702d7b4aafaa4bf7e69ea40d":[3,0,32,40], "class_s_x126x.html#a0e5f0032a91686b9673a48c908eb1925":[3,0,32,17], +"class_s_x126x.html#a10a0e75571350fb05fa100e5d5151be2":[3,0,32,60], "class_s_x126x.html#a1d8f4deb555844b24c2426dd86e69676":[3,0,32,39], "class_s_x126x.html#a21c263ce1a339faa74c568d9afb81cd2":[3,0,32,48], "class_s_x126x.html#a288257242e483cb3eb6944333179dd26":[3,0,32,49], @@ -242,7 +243,6 @@ var NAVTREEINDEX1 = "class_s_x126x.html#a2f60df59c80241d98ce078c0417a7f08":[3,0,32,33], "class_s_x126x.html#a3350cbfab628956c1a456383ac7bb2b2":[3,0,32,25], "class_s_x126x.html#a3765f534418d4e0540c179621c019138":[3,0,32,6], -"class_s_x126x.html#a37a716aab163aebbe36599dc7e530c92":[3,0,32,60], "class_s_x126x.html#a38e6d7831f35893a5b8328c10a2901bf":[3,0,32,53], "class_s_x126x.html#a41a1de0ebffe7b65de6fd8cceb9a5123":[3,0,32,67], "class_s_x126x.html#a420c23bb1861646e29f44c0f4c646ee8":[3,0,32,9], diff --git a/navtreeindex2.js b/navtreeindex2.js index 97b8bb0f..1075622a 100644 --- a/navtreeindex2.js +++ b/navtreeindex2.js @@ -4,6 +4,7 @@ var NAVTREEINDEX2 = "class_s_x126x.html#a67702de41ae866b9f9d73234fc9ae376":[3,0,32,56], "class_s_x126x.html#a6848afe4c16a47edb3e0b342a86ecdfd":[3,0,32,4], "class_s_x126x.html#a6b50cb78f02a3d93939437eb48489d3f":[3,0,32,63], +"class_s_x126x.html#a755e7df4b0958f7c793d0c058408831a":[3,0,32,32], "class_s_x126x.html#a7a1579e2557c36a4a34b09039c0d0c71":[3,0,32,58], "class_s_x126x.html#a7cd95a5f2e39ae8fb1a3040e77fa21a3":[3,0,32,44], "class_s_x126x.html#a7deeef45d7f64a4018a3e56aaea4eb0e":[3,0,32,34], @@ -46,7 +47,6 @@ var NAVTREEINDEX2 = "class_s_x126x.html#ae5993359ace652fbdc862eb23fdd263d":[3,0,32,51], "class_s_x126x.html#ae8b6c756eb4b92855433ca389d73c632":[3,0,32,26], "class_s_x126x.html#ae8eed0e888a7c8742e89d2b850977de2":[3,0,32,24], -"class_s_x126x.html#ae9f24414bd684434c310df54b3558f21":[3,0,32,32], "class_s_x126x.html#aeb62c5a521aafc1e0525c58e9364482b":[3,0,32,70], "class_s_x126x.html#aeb92dc9d2e2a2b3a3a5ff2856528d497":[3,0,32,61], "class_s_x126x.html#af068e6e862c99e39d0261a7971dd56db":[3,0,32,65], diff --git a/search/all_f.js b/search/all_f.js index 35fe2f4a..896f0027 100644 --- a/search/all_f.js +++ b/search/all_f.js @@ -1,6 +1,6 @@ var searchData= [ - ['scanchannel_210',['scanChannel',['../class_s_x126x.html#ae9f24414bd684434c310df54b3558f21',1,'SX126x::scanChannel()'],['../class_s_x127x.html#ada007b90821258fe8c6ca7f8ae3efed5',1,'SX127x::scanChannel()'],['../class_s_x128x.html#a89cc916f5cd5cdfbd331bb15f8a3d5cb',1,'SX128x::scanChannel()']]], + ['scanchannel_210',['scanChannel',['../class_s_x126x.html#a755e7df4b0958f7c793d0c058408831a',1,'SX126x::scanChannel()'],['../class_s_x127x.html#ada007b90821258fe8c6ca7f8ae3efed5',1,'SX127x::scanChannel()'],['../class_s_x128x.html#a89cc916f5cd5cdfbd331bb15f8a3d5cb',1,'SX128x::scanChannel()']]], ['scanpixellen_211',['scanPixelLen',['../struct_s_s_t_v_mode__t.html#a991e84b2b6f696ec2390f2c3f8cb9694',1,'SSTVMode_t']]], ['sendframe_212',['sendFrame',['../class_a_p_r_s_client.html#a05076f44e5708f1230894c11053707b1',1,'APRSClient::sendFrame()'],['../class_a_x25_client.html#a341db993853c6817a8f6c7087ead0ba6',1,'AX25Client::sendFrame()']]], ['sendheader_213',['sendHeader',['../class_s_s_t_v_client.html#a30741de183c81492402187b9d6d8c11e',1,'SSTVClient']]], @@ -93,7 +93,7 @@ var searchData= ['sstvclient_300',['SSTVClient',['../class_s_s_t_v_client.html',1,'SSTVClient'],['../class_s_s_t_v_client.html#af15cf501c00172270d2d2c43d7a7100a',1,'SSTVClient::SSTVClient(PhysicalLayer *phy)'],['../class_s_s_t_v_client.html#a99e46bec8403dfc36b9e5b102b1f7cf1',1,'SSTVClient::SSTVClient(AFSKClient *audio)']]], ['sstvmode_5ft_301',['SSTVMode_t',['../struct_s_s_t_v_mode__t.html',1,'']]], ['standby_302',['standby',['../class_c_c1101.html#a7612bf81e48086004c62548de2682266',1,'CC1101::standby()'],['../classn_r_f24.html#a5957f06a891d3d9c07e87b59c239ce56',1,'nRF24::standby()'],['../class_r_f69.html#a20242499eb926ff7b7da6e3f74a9ece1',1,'RF69::standby()'],['../class_si443x.html#ac45d2776df3ff338db154ead143fb7b8',1,'Si443x::standby()'],['../class_s_x126x.html#a7a1579e2557c36a4a34b09039c0d0c71',1,'SX126x::standby() override'],['../class_s_x126x.html#ad7569396f09f3867dc1bd4d4a0613acd',1,'SX126x::standby(uint8_t mode)'],['../class_s_x127x.html#a760b8c5103128f122fbe489c6529ce41',1,'SX127x::standby()'],['../class_s_x128x.html#a2be8cc6c3b61b59cb6a6ca4f6a030b45',1,'SX128x::standby() override'],['../class_s_x128x.html#aa11ba80f0cebb3e6927c775ad5f96b4e',1,'SX128x::standby(uint8_t mode)'],['../class_physical_layer.html#a0e77da761a2cbb5c9535df0bdea993f9',1,'PhysicalLayer::standby()'],['../class_r_t_t_y_client.html#a928dd206749d68b8ce450e14c24b9f22',1,'RTTYClient::standby()']]], - ['startchannelscan_303',['startChannelScan',['../class_s_x126x.html#a37a716aab163aebbe36599dc7e530c92',1,'SX126x::startChannelScan()'],['../class_s_x127x.html#a1d4631691c16d6ecf38815dc4e59a059',1,'SX127x::startChannelScan()']]], + ['startchannelscan_303',['startChannelScan',['../class_s_x126x.html#a10a0e75571350fb05fa100e5d5151be2',1,'SX126x::startChannelScan()'],['../class_s_x127x.html#a1d4631691c16d6ecf38815dc4e59a059',1,'SX127x::startChannelScan()']]], ['startdirect_304',['startDirect',['../class_physical_layer.html#a88a10657bd2215a11a2331f937414b55',1,'PhysicalLayer']]], ['startranging_305',['startRanging',['../class_s_x1280.html#af30ff497ca3bcc043dc4dc2e7587a795',1,'SX1280']]], ['startreceive_306',['startReceive',['../class_c_c1101.html#af727750d05be0bcef4bb8ac260d110e3',1,'CC1101::startReceive()'],['../classn_r_f24.html#af4f443da5d90e032e5f2f65420515f9c',1,'nRF24::startReceive()'],['../class_r_f69.html#afae38fa64242043de34096bf497725f1',1,'RF69::startReceive()'],['../class_si443x.html#a10f886fc534a85bbf8c1aeb9b5ffe4f2',1,'Si443x::startReceive()'],['../class_s_x126x.html#aeb92dc9d2e2a2b3a3a5ff2856528d497',1,'SX126x::startReceive()'],['../class_s_x127x.html#adffb96b7f80dc43909bb4cebde68fe9d',1,'SX127x::startReceive()'],['../class_s_x128x.html#ad59ee052d8ab1f250245a14039fc8b66',1,'SX128x::startReceive()'],['../class_pager_client.html#ad6f4f034b71311144f76b629a8ef8f8d',1,'PagerClient::startReceive()']]], diff --git a/search/functions_f.js b/search/functions_f.js index e44325f7..f58ca7de 100644 --- a/search/functions_f.js +++ b/search/functions_f.js @@ -1,6 +1,6 @@ var searchData= [ - ['scanchannel_508',['scanChannel',['../class_s_x126x.html#ae9f24414bd684434c310df54b3558f21',1,'SX126x::scanChannel()'],['../class_s_x127x.html#ada007b90821258fe8c6ca7f8ae3efed5',1,'SX127x::scanChannel()'],['../class_s_x128x.html#a89cc916f5cd5cdfbd331bb15f8a3d5cb',1,'SX128x::scanChannel()']]], + ['scanchannel_508',['scanChannel',['../class_s_x126x.html#a755e7df4b0958f7c793d0c058408831a',1,'SX126x::scanChannel()'],['../class_s_x127x.html#ada007b90821258fe8c6ca7f8ae3efed5',1,'SX127x::scanChannel()'],['../class_s_x128x.html#a89cc916f5cd5cdfbd331bb15f8a3d5cb',1,'SX128x::scanChannel()']]], ['sendframe_509',['sendFrame',['../class_a_p_r_s_client.html#a05076f44e5708f1230894c11053707b1',1,'APRSClient::sendFrame()'],['../class_a_x25_client.html#a341db993853c6817a8f6c7087ead0ba6',1,'AX25Client::sendFrame()']]], ['sendheader_510',['sendHeader',['../class_s_s_t_v_client.html#a30741de183c81492402187b9d6d8c11e',1,'SSTVClient']]], ['sendline_511',['sendLine',['../class_s_s_t_v_client.html#a772bfc68ac0a5f723c1031138dc27bd0',1,'SSTVClient']]], @@ -86,7 +86,7 @@ var searchData= ['spiwriteregisterburst_591',['SPIwriteRegisterBurst',['../class_module.html#a9d77a08070cbd48fd4ece62a739333e9',1,'Module']]], ['sstvclient_592',['SSTVClient',['../class_s_s_t_v_client.html#af15cf501c00172270d2d2c43d7a7100a',1,'SSTVClient::SSTVClient(PhysicalLayer *phy)'],['../class_s_s_t_v_client.html#a99e46bec8403dfc36b9e5b102b1f7cf1',1,'SSTVClient::SSTVClient(AFSKClient *audio)']]], ['standby_593',['standby',['../class_c_c1101.html#a7612bf81e48086004c62548de2682266',1,'CC1101::standby()'],['../classn_r_f24.html#a5957f06a891d3d9c07e87b59c239ce56',1,'nRF24::standby()'],['../class_r_f69.html#a20242499eb926ff7b7da6e3f74a9ece1',1,'RF69::standby()'],['../class_si443x.html#ac45d2776df3ff338db154ead143fb7b8',1,'Si443x::standby()'],['../class_s_x126x.html#a7a1579e2557c36a4a34b09039c0d0c71',1,'SX126x::standby() override'],['../class_s_x126x.html#ad7569396f09f3867dc1bd4d4a0613acd',1,'SX126x::standby(uint8_t mode)'],['../class_s_x127x.html#a760b8c5103128f122fbe489c6529ce41',1,'SX127x::standby()'],['../class_s_x128x.html#a2be8cc6c3b61b59cb6a6ca4f6a030b45',1,'SX128x::standby() override'],['../class_s_x128x.html#aa11ba80f0cebb3e6927c775ad5f96b4e',1,'SX128x::standby(uint8_t mode)'],['../class_physical_layer.html#a0e77da761a2cbb5c9535df0bdea993f9',1,'PhysicalLayer::standby()'],['../class_r_t_t_y_client.html#a928dd206749d68b8ce450e14c24b9f22',1,'RTTYClient::standby()']]], - ['startchannelscan_594',['startChannelScan',['../class_s_x126x.html#a37a716aab163aebbe36599dc7e530c92',1,'SX126x::startChannelScan()'],['../class_s_x127x.html#a1d4631691c16d6ecf38815dc4e59a059',1,'SX127x::startChannelScan()']]], + ['startchannelscan_594',['startChannelScan',['../class_s_x126x.html#a10a0e75571350fb05fa100e5d5151be2',1,'SX126x::startChannelScan()'],['../class_s_x127x.html#a1d4631691c16d6ecf38815dc4e59a059',1,'SX127x::startChannelScan()']]], ['startdirect_595',['startDirect',['../class_physical_layer.html#a88a10657bd2215a11a2331f937414b55',1,'PhysicalLayer']]], ['startranging_596',['startRanging',['../class_s_x1280.html#af30ff497ca3bcc043dc4dc2e7587a795',1,'SX1280']]], ['startreceive_597',['startReceive',['../class_c_c1101.html#af727750d05be0bcef4bb8ac260d110e3',1,'CC1101::startReceive()'],['../classn_r_f24.html#af4f443da5d90e032e5f2f65420515f9c',1,'nRF24::startReceive()'],['../class_r_f69.html#afae38fa64242043de34096bf497725f1',1,'RF69::startReceive()'],['../class_si443x.html#a10f886fc534a85bbf8c1aeb9b5ffe4f2',1,'Si443x::startReceive()'],['../class_s_x126x.html#aeb92dc9d2e2a2b3a3a5ff2856528d497',1,'SX126x::startReceive()'],['../class_s_x127x.html#adffb96b7f80dc43909bb4cebde68fe9d',1,'SX127x::startReceive()'],['../class_s_x128x.html#ad59ee052d8ab1f250245a14039fc8b66',1,'SX128x::startReceive()'],['../class_pager_client.html#ad6f4f034b71311144f76b629a8ef8f8d',1,'PagerClient::startReceive()']]],