From bcb9161e2a68231570f9adacb4c64b78a0184af4 Mon Sep 17 00:00:00 2001 From: jgromes Date: Mon, 27 Mar 2023 16:49:28 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=20c1034?= =?UTF-8?q?3e853e77186ceef19f8f55968077c70a341=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- _s_x126x_8h_source.html | 161 ++++++++++++++++---------------- class_l_l_c_c68-members.html | 2 +- class_l_l_c_c68.html | 6 +- class_s_t_m32_w_lx-members.html | 2 +- class_s_t_m32_w_lx.html | 6 +- class_s_x1261-members.html | 2 +- class_s_x1261.html | 6 +- class_s_x1262-members.html | 2 +- class_s_x1262.html | 6 +- class_s_x1268-members.html | 2 +- class_s_x1268.html | 6 +- class_s_x126x-members.html | 2 +- class_s_x126x.html | 14 +-- class_s_x126x.js | 2 +- functions_func_s.html | 2 +- functions_s.html | 2 +- navtreeindex2.js | 2 +- navtreeindex4.js | 2 +- search/all_f.js | 2 +- search/functions_f.js | 2 +- 20 files changed, 116 insertions(+), 115 deletions(-) diff --git a/_s_x126x_8h_source.html b/_s_x126x_8h_source.html index 013cce24..7defa9fe 100644 --- a/_s_x126x_8h_source.html +++ b/_s_x126x_8h_source.html @@ -663,7 +663,7 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
1070 
1084  int16_t uploadPatch(const uint32_t* patch, size_t len, bool nonvolatile = true);
1085 
-
1097  int16_t spectralScanStart(uint16_t numScans, uint8_t window = RADIOLIB_SX126x_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval = RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US);
+
1097  int16_t spectralScanStart(uint16_t numSamples, uint8_t window = RADIOLIB_SX126x_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval = RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US);
1098 
1102  void spectralScanAbort();
1103 
@@ -675,83 +675,84 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
1121  protected:
1122 #endif
1123  // SX126x SPI command implementations
-
1124  int16_t setTx(uint32_t timeout = 0);
-
1125  int16_t setRx(uint32_t timeout);
-
1126  int16_t setCad(uint8_t symbolNum, uint8_t detPeak, uint8_t detMin);
-
1127  int16_t setPaConfig(uint8_t paDutyCycle, uint8_t deviceSel, uint8_t hpMax = RADIOLIB_SX126X_PA_CONFIG_HP_MAX, uint8_t paLut = RADIOLIB_SX126X_PA_CONFIG_PA_LUT);
-
1128  int16_t writeRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
-
1129  int16_t readRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
-
1130  int16_t writeBuffer(uint8_t* data, uint8_t numBytes, uint8_t offset = 0x00);
-
1131  int16_t readBuffer(uint8_t* data, uint8_t numBytes);
-
1132  int16_t setDioIrqParams(uint16_t irqMask, uint16_t dio1Mask, uint16_t dio2Mask = RADIOLIB_SX126X_IRQ_NONE, uint16_t dio3Mask = RADIOLIB_SX126X_IRQ_NONE);
-
1133  virtual int16_t clearIrqStatus(uint16_t clearIrqParams = RADIOLIB_SX126X_IRQ_ALL);
-
1134  int16_t setRfFrequency(uint32_t frf);
-
1135  int16_t calibrateImage(uint8_t* data);
-
1136  uint8_t getPacketType();
-
1137  int16_t setTxParams(uint8_t power, uint8_t rampTime = RADIOLIB_SX126X_PA_RAMP_200U);
-
1138  int16_t setModulationParams(uint8_t sf, uint8_t bw, uint8_t cr, uint8_t ldro);
-
1139  int16_t setModulationParamsFSK(uint32_t br, uint8_t pulseShape, uint8_t rxBw, uint32_t freqDev);
-
1140  int16_t setPacketParams(uint16_t preambleLength, uint8_t crcType, uint8_t payloadLength, uint8_t headerType, uint8_t invertIQ = RADIOLIB_SX126X_LORA_IQ_STANDARD);
-
1141  int16_t setPacketParamsFSK(uint16_t preambleLength, uint8_t crcType, uint8_t syncWordLength, uint8_t addrComp, uint8_t whitening, uint8_t packetType = RADIOLIB_SX126X_GFSK_PACKET_VARIABLE, uint8_t payloadLength = 0xFF, uint8_t preambleDetectorLength = RADIOLIB_SX126X_GFSK_PREAMBLE_DETECT_16);
-
1142  int16_t setBufferBaseAddress(uint8_t txBaseAddress = 0x00, uint8_t rxBaseAddress = 0x00);
-
1143  int16_t setRegulatorMode(uint8_t mode);
-
1144  uint8_t getStatus();
-
1145  uint32_t getPacketStatus();
-
1146  uint16_t getDeviceErrors();
-
1147  int16_t clearDeviceErrors();
-
1148 
-
1149  int16_t startReceiveCommon(uint32_t timeout = RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags = RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask = RADIOLIB_SX126X_IRQ_RX_DONE);
-
1150  int16_t setFrequencyRaw(float freq);
-
1151  int16_t setPacketMode(uint8_t mode, uint8_t len);
-
1152  int16_t setHeaderType(uint8_t headerType, size_t len = 0xFF);
-
1153  int16_t directMode();
-
1154  int16_t packetMode();
-
1155 
-
1156  // fixes to errata
-
1157  int16_t fixSensitivity();
-
1158  int16_t fixPaClamping(bool enable = true);
-
1159  int16_t fixImplicitTimeout();
-
1160  int16_t fixInvertedIQ(uint8_t iqConfig);
-
1161 
-
1162 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
-
1163  protected:
-
1164 #endif
-
1165  Module* _mod;
-
1166 
-
1167  // common low-level SPI interface
-
1168  static int16_t SPIparseStatus(uint8_t in);
-
1169 
-
1170 #if !defined(RADIOLIB_GODMODE)
-
1171  protected:
-
1172 #endif
-
1173 
-
1174  uint8_t _bw = 0, _sf = 0, _cr = 0, _ldro = 0, _crcType = 0, _headerType = 0;
-
1175  uint16_t _preambleLength = 0;
-
1176  float _bwKhz = 0;
-
1177  bool _ldroAuto = true;
-
1178 
-
1179  uint32_t _br = 0, _freqDev = 0;
-
1180  uint8_t _rxBw = 0, _pulseShape = 0, _crcTypeFSK = 0, _syncWordLength = 0, _addrComp = 0, _whitening = 0, _packetType = 0;
-
1181  uint16_t _preambleLengthFSK = 0;
-
1182  float _rxBwKhz = 0;
-
1183 
-
1184  float _dataRate = 0;
-
1185 
-
1186  uint32_t _tcxoDelay = 0;
-
1187 
-
1188  size_t _implicitLen = 0;
-
1189  const char* _chipType;
-
1190 
-
1191  // Allow subclasses to define different TX modes
-
1192  uint8_t _tx_mode = Module::MODE_TX;
-
1193 
-
1194  int16_t config(uint8_t modem);
-
1195  bool findChip(const char* verStr);
-
1196 };
-
1197 
-
1198 #endif
-
1199 
-
1200 #endif
+
1124  int16_t setFs();
+
1125  int16_t setTx(uint32_t timeout = 0);
+
1126  int16_t setRx(uint32_t timeout);
+
1127  int16_t setCad(uint8_t symbolNum, uint8_t detPeak, uint8_t detMin);
+
1128  int16_t setPaConfig(uint8_t paDutyCycle, uint8_t deviceSel, uint8_t hpMax = RADIOLIB_SX126X_PA_CONFIG_HP_MAX, uint8_t paLut = RADIOLIB_SX126X_PA_CONFIG_PA_LUT);
+
1129  int16_t writeRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
+
1130  int16_t readRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
+
1131  int16_t writeBuffer(uint8_t* data, uint8_t numBytes, uint8_t offset = 0x00);
+
1132  int16_t readBuffer(uint8_t* data, uint8_t numBytes);
+
1133  int16_t setDioIrqParams(uint16_t irqMask, uint16_t dio1Mask, uint16_t dio2Mask = RADIOLIB_SX126X_IRQ_NONE, uint16_t dio3Mask = RADIOLIB_SX126X_IRQ_NONE);
+
1134  virtual int16_t clearIrqStatus(uint16_t clearIrqParams = RADIOLIB_SX126X_IRQ_ALL);
+
1135  int16_t setRfFrequency(uint32_t frf);
+
1136  int16_t calibrateImage(uint8_t* data);
+
1137  uint8_t getPacketType();
+
1138  int16_t setTxParams(uint8_t power, uint8_t rampTime = RADIOLIB_SX126X_PA_RAMP_200U);
+
1139  int16_t setModulationParams(uint8_t sf, uint8_t bw, uint8_t cr, uint8_t ldro);
+
1140  int16_t setModulationParamsFSK(uint32_t br, uint8_t pulseShape, uint8_t rxBw, uint32_t freqDev);
+
1141  int16_t setPacketParams(uint16_t preambleLength, uint8_t crcType, uint8_t payloadLength, uint8_t headerType, uint8_t invertIQ = RADIOLIB_SX126X_LORA_IQ_STANDARD);
+
1142  int16_t setPacketParamsFSK(uint16_t preambleLength, uint8_t crcType, uint8_t syncWordLength, uint8_t addrComp, uint8_t whitening, uint8_t packetType = RADIOLIB_SX126X_GFSK_PACKET_VARIABLE, uint8_t payloadLength = 0xFF, uint8_t preambleDetectorLength = RADIOLIB_SX126X_GFSK_PREAMBLE_DETECT_16);
+
1143  int16_t setBufferBaseAddress(uint8_t txBaseAddress = 0x00, uint8_t rxBaseAddress = 0x00);
+
1144  int16_t setRegulatorMode(uint8_t mode);
+
1145  uint8_t getStatus();
+
1146  uint32_t getPacketStatus();
+
1147  uint16_t getDeviceErrors();
+
1148  int16_t clearDeviceErrors();
+
1149 
+
1150  int16_t startReceiveCommon(uint32_t timeout = RADIOLIB_SX126X_RX_TIMEOUT_INF, uint16_t irqFlags = RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask = RADIOLIB_SX126X_IRQ_RX_DONE);
+
1151  int16_t setFrequencyRaw(float freq);
+
1152  int16_t setPacketMode(uint8_t mode, uint8_t len);
+
1153  int16_t setHeaderType(uint8_t headerType, size_t len = 0xFF);
+
1154  int16_t directMode();
+
1155  int16_t packetMode();
+
1156 
+
1157  // fixes to errata
+
1158  int16_t fixSensitivity();
+
1159  int16_t fixPaClamping(bool enable = true);
+
1160  int16_t fixImplicitTimeout();
+
1161  int16_t fixInvertedIQ(uint8_t iqConfig);
+
1162 
+
1163 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
+
1164  protected:
+
1165 #endif
+
1166  Module* _mod;
+
1167 
+
1168  // common low-level SPI interface
+
1169  static int16_t SPIparseStatus(uint8_t in);
+
1170 
+
1171 #if !defined(RADIOLIB_GODMODE)
+
1172  protected:
+
1173 #endif
+
1174 
+
1175  uint8_t _bw = 0, _sf = 0, _cr = 0, _ldro = 0, _crcType = 0, _headerType = 0;
+
1176  uint16_t _preambleLength = 0;
+
1177  float _bwKhz = 0;
+
1178  bool _ldroAuto = true;
+
1179 
+
1180  uint32_t _br = 0, _freqDev = 0;
+
1181  uint8_t _rxBw = 0, _pulseShape = 0, _crcTypeFSK = 0, _syncWordLength = 0, _addrComp = 0, _whitening = 0, _packetType = 0;
+
1182  uint16_t _preambleLengthFSK = 0;
+
1183  float _rxBwKhz = 0;
+
1184 
+
1185  float _dataRate = 0;
+
1186 
+
1187  uint32_t _tcxoDelay = 0;
+
1188 
+
1189  size_t _implicitLen = 0;
+
1190  const char* _chipType;
+
1191 
+
1192  // Allow subclasses to define different TX modes
+
1193  uint8_t _tx_mode = Module::MODE_TX;
+
1194 
+
1195  int16_t config(uint8_t modem);
+
1196  bool findChip(const char* verStr);
+
1197 };
+
1198 
+
1199 #endif
+
1200 
+
1201 #endif
Module
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:24
Module::RFSWITCH_MAX_PINS
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:35
Module::MODE_TX
@ MODE_TX
Definition: Module.h:64
@@ -785,7 +786,6 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
SX126x::startReceiveDutyCycle
int16_t startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)
Interrupt-driven receive method where the device mostly sleeps and periodically wakes to listen....
Definition: SX126x.cpp:553
SX126x::setWhitening
int16_t setWhitening(bool enabled, uint16_t initial=0x0100)
Sets FSK whitening parameters.
Definition: SX126x.cpp:1184
SX126x::clearDio1Action
void clearDio1Action()
Clears interrupt service routine to call when DIO1 activates.
Definition: SX126x.cpp:466
-
SX126x::spectralScanStart
int16_t spectralScanStart(uint16_t numScans, uint8_t window=RADIOLIB_SX126x_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US)
Start spectral scan. Requires binary path to be uploaded.
Definition: SX126x.cpp:1467
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:420
SX126x::standby
int16_t standby() override
Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator)...
Definition: SX126x.cpp:450
SX126x::setFrequencyDeviation
int16_t setFrequencyDeviation(float freqDev) override
Sets FSK frequency deviation. Allowed values range from 0.0 to 200.0 kHz.
Definition: SX126x.cpp:858
@@ -801,7 +801,7 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
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:1292
SX126x::begin
int16_t begin(uint8_t cr, uint8_t syncWord, uint16_t preambleLength, float tcxoVoltage, bool useRegulatorLDO=false)
Initialization method for LoRa modem.
Definition: SX126x.cpp:13
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:1125
-
SX126x::getIrqStatus
uint16_t getIrqStatus()
Reads the current IRQ status.
Definition: SX126x.cpp:1659
+
SX126x::getIrqStatus
uint16_t getIrqStatus()
Reads the current IRQ status.
Definition: SX126x.cpp:1663
SX126x::reset
int16_t reset(bool verify=true)
Reset method. Will reset the chip to the default state using RST pin.
Definition: SX126x.cpp:189
SX126x::setSyncWord
int16_t setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)
Sets LoRa sync word.
Definition: SX126x.cpp:812
SX126x::getCurrentLimit
float getCurrentLimit()
Reads current protection limit.
Definition: SX126x.cpp:836
@@ -816,6 +816,7 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
SX126x::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: SX126x.cpp:1281
SX126x::setSyncBits
int16_t setSyncBits(uint8_t *syncWord, uint8_t bitsLen)
Sets FSK sync word in the form of array of up to 8 bytes.
Definition: SX126x.cpp:1053
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:1221
+
SX126x::spectralScanStart
int16_t spectralScanStart(uint16_t numSamples, uint8_t window=RADIOLIB_SX126x_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US)
Start spectral scan. Requires binary path to be uploaded.
Definition: SX126x.cpp:1467
SX126x::setRfSwitchTable
void setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: SX126x.cpp:1362
SX126x::XTAL
bool XTAL
Whether the module has an XTAL (true) or TCXO (false). Defaults to false.
Definition: SX126x.h:452
SX126x::implicitHeader
int16_t implicitHeader(size_t len)
Set implicit header mode for future reception/transmission.
Definition: SX126x.cpp:1338
diff --git a/class_l_l_c_c68-members.html b/class_l_l_c_c68-members.html index f2cc8979..dab50d0f 100644 --- a/class_l_l_c_c68-members.html +++ b/class_l_l_c_c68-members.html @@ -170,7 +170,7 @@ $(document).ready(function(){initNavTree('class_l_l_c_c68.html',''); initResizab spectralScanAbort()SX126x spectralScanGetResult(uint16_t *results)SX126x spectralScanGetStatus()SX126x - spectralScanStart(uint16_t numScans, uint8_t window=RADIOLIB_SX126x_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US)SX126x + spectralScanStart(uint16_t numSamples, uint8_t window=RADIOLIB_SX126x_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US)SX126x standby() overrideSX126xvirtual standby(uint8_t mode)SX126xvirtual startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x diff --git a/class_l_l_c_c68.html b/class_l_l_c_c68.html index b6b0428b..275f90bd 100644 --- a/class_l_l_c_c68.html +++ b/class_l_l_c_c68.html @@ -345,9 +345,9 @@ void int16_t uploadPatch (const uint32_t *patch, size_t len, bool nonvolatile=true)  Upload binary patch into the SX126x device RAM. Patch is needed to e.g., enable spectral scan and must be uploaded again on every power cycle. More...
  -int16_t spectralScanStart (uint16_t numScans, uint8_t window=RADIOLIB_SX126x_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US) - Start spectral scan. Requires binary path to be uploaded. More...
-  +int16_t spectralScanStart (uint16_t numSamples, uint8_t window=RADIOLIB_SX126x_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US) + Start spectral scan. Requires binary path to be uploaded. More...
+  void spectralScanAbort ()  Abort an ongoing spectral scan.
diff --git a/class_s_t_m32_w_lx-members.html b/class_s_t_m32_w_lx-members.html index 1c94d5a0..f11181e8 100644 --- a/class_s_t_m32_w_lx-members.html +++ b/class_s_t_m32_w_lx-members.html @@ -176,7 +176,7 @@ $(document).ready(function(){initNavTree('class_s_t_m32_w_lx.html',''); initResi spectralScanAbort()SX126x spectralScanGetResult(uint16_t *results)SX126x spectralScanGetStatus()SX126x - spectralScanStart(uint16_t numScans, uint8_t window=RADIOLIB_SX126x_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US)SX126x + spectralScanStart(uint16_t numSamples, uint8_t window=RADIOLIB_SX126x_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US)SX126x standby() overrideSX126xvirtual standby(uint8_t mode)SX126xvirtual startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x diff --git a/class_s_t_m32_w_lx.html b/class_s_t_m32_w_lx.html index 6e245071..388bf1cb 100644 --- a/class_s_t_m32_w_lx.html +++ b/class_s_t_m32_w_lx.html @@ -367,9 +367,9 @@ void int16_t uploadPatch (const uint32_t *patch, size_t len, bool nonvolatile=true)  Upload binary patch into the SX126x device RAM. Patch is needed to e.g., enable spectral scan and must be uploaded again on every power cycle. More...
  -int16_t spectralScanStart (uint16_t numScans, uint8_t window=RADIOLIB_SX126x_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US) - Start spectral scan. Requires binary path to be uploaded. More...
-  +int16_t spectralScanStart (uint16_t numSamples, uint8_t window=RADIOLIB_SX126x_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US) + Start spectral scan. Requires binary path to be uploaded. More...
+  void spectralScanAbort ()  Abort an ongoing spectral scan.
diff --git a/class_s_x1261-members.html b/class_s_x1261-members.html index 1064063a..6d37dc05 100644 --- a/class_s_x1261-members.html +++ b/class_s_x1261-members.html @@ -169,7 +169,7 @@ $(document).ready(function(){initNavTree('class_s_x1261.html',''); initResizable spectralScanAbort()SX126x spectralScanGetResult(uint16_t *results)SX126x spectralScanGetStatus()SX126x - spectralScanStart(uint16_t numScans, uint8_t window=RADIOLIB_SX126x_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US)SX126x + spectralScanStart(uint16_t numSamples, uint8_t window=RADIOLIB_SX126x_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US)SX126x standby() overrideSX126xvirtual standby(uint8_t mode)SX126xvirtual startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x diff --git a/class_s_x1261.html b/class_s_x1261.html index 83a4b0d3..5e18a2f1 100644 --- a/class_s_x1261.html +++ b/class_s_x1261.html @@ -336,9 +336,9 @@ void int16_t uploadPatch (const uint32_t *patch, size_t len, bool nonvolatile=true)  Upload binary patch into the SX126x device RAM. Patch is needed to e.g., enable spectral scan and must be uploaded again on every power cycle. More...
  -int16_t spectralScanStart (uint16_t numScans, uint8_t window=RADIOLIB_SX126x_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US) - Start spectral scan. Requires binary path to be uploaded. More...
-  +int16_t spectralScanStart (uint16_t numSamples, uint8_t window=RADIOLIB_SX126x_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US) + Start spectral scan. Requires binary path to be uploaded. More...
+  void spectralScanAbort ()  Abort an ongoing spectral scan.
diff --git a/class_s_x1262-members.html b/class_s_x1262-members.html index 32758b4a..29400693 100644 --- a/class_s_x1262-members.html +++ b/class_s_x1262-members.html @@ -169,7 +169,7 @@ $(document).ready(function(){initNavTree('class_s_x1262.html',''); initResizable spectralScanAbort()SX126x spectralScanGetResult(uint16_t *results)SX126x spectralScanGetStatus()SX126x - spectralScanStart(uint16_t numScans, uint8_t window=RADIOLIB_SX126x_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US)SX126x + spectralScanStart(uint16_t numSamples, uint8_t window=RADIOLIB_SX126x_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US)SX126x standby() overrideSX126xvirtual standby(uint8_t mode)SX126xvirtual startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x diff --git a/class_s_x1262.html b/class_s_x1262.html index 1f0b3b55..dc07866f 100644 --- a/class_s_x1262.html +++ b/class_s_x1262.html @@ -334,9 +334,9 @@ void int16_t uploadPatch (const uint32_t *patch, size_t len, bool nonvolatile=true)  Upload binary patch into the SX126x device RAM. Patch is needed to e.g., enable spectral scan and must be uploaded again on every power cycle. More...
  -int16_t spectralScanStart (uint16_t numScans, uint8_t window=RADIOLIB_SX126x_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US) - Start spectral scan. Requires binary path to be uploaded. More...
-  +int16_t spectralScanStart (uint16_t numSamples, uint8_t window=RADIOLIB_SX126x_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US) + Start spectral scan. Requires binary path to be uploaded. More...
+  void spectralScanAbort ()  Abort an ongoing spectral scan.
diff --git a/class_s_x1268-members.html b/class_s_x1268-members.html index 4b8f02f1..67a6a15a 100644 --- a/class_s_x1268-members.html +++ b/class_s_x1268-members.html @@ -168,7 +168,7 @@ $(document).ready(function(){initNavTree('class_s_x1268.html',''); initResizable spectralScanAbort()SX126x spectralScanGetResult(uint16_t *results)SX126x spectralScanGetStatus()SX126x - spectralScanStart(uint16_t numScans, uint8_t window=RADIOLIB_SX126x_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US)SX126x + spectralScanStart(uint16_t numSamples, uint8_t window=RADIOLIB_SX126x_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US)SX126x standby() overrideSX126xvirtual standby(uint8_t mode)SX126xvirtual startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x diff --git a/class_s_x1268.html b/class_s_x1268.html index 4aff839d..8c0345e9 100644 --- a/class_s_x1268.html +++ b/class_s_x1268.html @@ -328,9 +328,9 @@ void int16_t uploadPatch (const uint32_t *patch, size_t len, bool nonvolatile=true)  Upload binary patch into the SX126x device RAM. Patch is needed to e.g., enable spectral scan and must be uploaded again on every power cycle. More...
  -int16_t spectralScanStart (uint16_t numScans, uint8_t window=RADIOLIB_SX126x_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US) - Start spectral scan. Requires binary path to be uploaded. More...
-  +int16_t spectralScanStart (uint16_t numSamples, uint8_t window=RADIOLIB_SX126x_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US) + Start spectral scan. Requires binary path to be uploaded. More...
+  void spectralScanAbort ()  Abort an ongoing spectral scan.
diff --git a/class_s_x126x-members.html b/class_s_x126x-members.html index 98067d33..7b192d99 100644 --- a/class_s_x126x-members.html +++ b/class_s_x126x-members.html @@ -164,7 +164,7 @@ $(document).ready(function(){initNavTree('class_s_x126x.html',''); initResizable spectralScanAbort()SX126x spectralScanGetResult(uint16_t *results)SX126x spectralScanGetStatus()SX126x - spectralScanStart(uint16_t numScans, uint8_t window=RADIOLIB_SX126x_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US)SX126x + spectralScanStart(uint16_t numSamples, uint8_t window=RADIOLIB_SX126x_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US)SX126x standby() overrideSX126xvirtual standby(uint8_t mode)SX126xvirtual startChannelScan(uint8_t symbolNum=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detPeak=RADIOLIB_SX126X_CAD_PARAM_DEFAULT, uint8_t detMin=RADIOLIB_SX126X_CAD_PARAM_DEFAULT)SX126x diff --git a/class_s_x126x.html b/class_s_x126x.html index 67467615..4cba10be 100644 --- a/class_s_x126x.html +++ b/class_s_x126x.html @@ -314,9 +314,9 @@ void int16_t uploadPatch (const uint32_t *patch, size_t len, bool nonvolatile=true)  Upload binary patch into the SX126x device RAM. Patch is needed to e.g., enable spectral scan and must be uploaded again on every power cycle. More...
  -int16_t spectralScanStart (uint16_t numScans, uint8_t window=RADIOLIB_SX126x_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US) - Start spectral scan. Requires binary path to be uploaded. More...
-  +int16_t spectralScanStart (uint16_t numSamples, uint8_t window=RADIOLIB_SX126x_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US) + Start spectral scan. Requires binary path to be uploaded. More...
+  void spectralScanAbort ()  Abort an ongoing spectral scan.
@@ -2311,8 +2311,8 @@ bool  -

◆ spectralScanStart()

+ +

◆ spectralScanStart()

@@ -2321,7 +2321,7 @@ bool int16_t SX126x::spectralScanStart ( uint16_t  - numScans, + numSamples, @@ -2346,7 +2346,7 @@ bool 
Parameters
- +
numScansNumber of scans for each iteration. Fewer scans = better temporal resolution, but fewer power samples.
numSamplesNumber of samples for each scan. Fewer samples = better temporal resolution.
windowRSSI averaging window size.
intervalScan interval length, one of RADIOLIB_SX126X_SCAN_INTERVAL_* macros.
diff --git a/class_s_x126x.js b/class_s_x126x.js index 93d68df5..07a40604 100644 --- a/class_s_x126x.js +++ b/class_s_x126x.js @@ -63,7 +63,7 @@ var class_s_x126x = [ "spectralScanAbort", "class_s_x126x.html#a865397e1cca38bec2d055c047825ea07", null ], [ "spectralScanGetResult", "class_s_x126x.html#ae473773e5bed4b08452e80311bdb26f2", null ], [ "spectralScanGetStatus", "class_s_x126x.html#a5595fff99d76d50d711b8cdad98527c4", null ], - [ "spectralScanStart", "class_s_x126x.html#a6a5ed11f9932a065438d073e7790a0e0", null ], + [ "spectralScanStart", "class_s_x126x.html#acea676a81ee40e83f96becdee91d42be", null ], [ "standby", "class_s_x126x.html#a7a1579e2557c36a4a34b09039c0d0c71", null ], [ "standby", "class_s_x126x.html#ad7569396f09f3867dc1bd4d4a0613acd", null ], [ "startChannelScan", "class_s_x126x.html#a10a0e75571350fb05fa100e5d5151be2", null ], diff --git a/functions_func_s.html b/functions_func_s.html index 59c07eec..66d9073e 100644 --- a/functions_func_s.html +++ b/functions_func_s.html @@ -480,7 +480,7 @@ $(document).ready(function(){initNavTree('functions_func_s.html',''); initResiza : SX126x
  • spectralScanStart() -: SX126x +: SX126x
  • SPIcheckStream() : Module diff --git a/functions_s.html b/functions_s.html index 01d3a74b..5fd8796b 100644 --- a/functions_s.html +++ b/functions_s.html @@ -486,7 +486,7 @@ $(document).ready(function(){initNavTree('functions_s.html',''); initResizable() : SX126x
  • spectralScanStart() -: SX126x +: SX126x
  • SPIaddrWidth : Module diff --git a/navtreeindex2.js b/navtreeindex2.js index c7438045..4969562e 100644 --- a/navtreeindex2.js +++ b/navtreeindex2.js @@ -74,7 +74,6 @@ var NAVTREEINDEX2 = "class_s_x126x.html#a5b4f8a41b593436b8c7a2a2d46ac387e":[3,0,35,68], "class_s_x126x.html#a67702de41ae866b9f9d73234fc9ae376":[3,0,35,58], "class_s_x126x.html#a6848afe4c16a47edb3e0b342a86ecdfd":[3,0,35,4], -"class_s_x126x.html#a6a5ed11f9932a065438d073e7790a0e0":[3,0,35,63], "class_s_x126x.html#a755e7df4b0958f7c793d0c058408831a":[3,0,35,32], "class_s_x126x.html#a7a1579e2557c36a4a34b09039c0d0c71":[3,0,35,64], "class_s_x126x.html#a7cd95a5f2e39ae8fb1a3040e77fa21a3":[3,0,35,44], @@ -110,6 +109,7 @@ var NAVTREEINDEX2 = "class_s_x126x.html#ac4ef8c8751a3c09d64e431684840c987":[3,0,35,16], "class_s_x126x.html#ac594fbb30c5010658c970a64654c7162":[3,0,35,54], "class_s_x126x.html#acbe2d75b1e2df8bcc58c4fd9d8e6e4f9":[3,0,35,12], +"class_s_x126x.html#acea676a81ee40e83f96becdee91d42be":[3,0,35,63], "class_s_x126x.html#ad59e37ce0606dc8051e40be9d14cfec3":[3,0,35,72], "class_s_x126x.html#ad7569396f09f3867dc1bd4d4a0613acd":[3,0,35,65], "class_s_x126x.html#ad92085fdf4508c0849de0aec8dee2494":[3,0,35,50], diff --git a/navtreeindex4.js b/navtreeindex4.js index 715c8b52..d2fffb45 100644 --- a/navtreeindex4.js +++ b/navtreeindex4.js @@ -121,8 +121,8 @@ var NAVTREEINDEX4 = "group__status__codes.html#gafbc04b924d23cba05307e94972d7d607":[2,4,5], "group__status__codes.html#gafeff72bd7b618959d86b804a11f09063":[2,4,1], "hierarchy.html":[3,2], -"index.html":[0], "index.html":[], +"index.html":[0], "modules.html":[2], "n_r_f24_8h_source.html":[4,0,0,0,2,0], "pages.html":[], diff --git a/search/all_f.js b/search/all_f.js index 89d1bbfa..b939b00a 100644 --- a/search/all_f.js +++ b/search/all_f.js @@ -84,7 +84,7 @@ var searchData= ['spectralscanabort_311',['spectralScanAbort',['../class_s_x126x.html#a865397e1cca38bec2d055c047825ea07',1,'SX126x']]], ['spectralscangetresult_312',['spectralScanGetResult',['../class_s_x126x.html#ae473773e5bed4b08452e80311bdb26f2',1,'SX126x']]], ['spectralscangetstatus_313',['spectralScanGetStatus',['../class_s_x126x.html#a5595fff99d76d50d711b8cdad98527c4',1,'SX126x']]], - ['spectralscanstart_314',['spectralScanStart',['../class_s_x126x.html#a6a5ed11f9932a065438d073e7790a0e0',1,'SX126x']]], + ['spectralscanstart_314',['spectralScanStart',['../class_s_x126x.html#acea676a81ee40e83f96becdee91d42be',1,'SX126x']]], ['spiaddrwidth_315',['SPIaddrWidth',['../class_module.html#ac19a495026aae62f5c2f089aa1b2b57a',1,'Module']]], ['spicheckstream_316',['SPIcheckStream',['../class_module.html#a5efa7ae78cab1d7f43005e965923f769',1,'Module']]], ['spigetregvalue_317',['SPIgetRegValue',['../class_module.html#a01e15988ec448c76142ee5709929be2c',1,'Module']]], diff --git a/search/functions_f.js b/search/functions_f.js index 5bca9def..87965d05 100644 --- a/search/functions_f.js +++ b/search/functions_f.js @@ -82,7 +82,7 @@ var searchData= ['spectralscanabort_637',['spectralScanAbort',['../class_s_x126x.html#a865397e1cca38bec2d055c047825ea07',1,'SX126x']]], ['spectralscangetresult_638',['spectralScanGetResult',['../class_s_x126x.html#ae473773e5bed4b08452e80311bdb26f2',1,'SX126x']]], ['spectralscangetstatus_639',['spectralScanGetStatus',['../class_s_x126x.html#a5595fff99d76d50d711b8cdad98527c4',1,'SX126x']]], - ['spectralscanstart_640',['spectralScanStart',['../class_s_x126x.html#a6a5ed11f9932a065438d073e7790a0e0',1,'SX126x']]], + ['spectralscanstart_640',['spectralScanStart',['../class_s_x126x.html#acea676a81ee40e83f96becdee91d42be',1,'SX126x']]], ['spicheckstream_641',['SPIcheckStream',['../class_module.html#a5efa7ae78cab1d7f43005e965923f769',1,'Module']]], ['spigetregvalue_642',['SPIgetRegValue',['../class_module.html#a01e15988ec448c76142ee5709929be2c',1,'Module']]], ['spireadregister_643',['SPIreadRegister',['../class_module.html#a9a545e4a001da0d9f6358279ac40d4f0',1,'Module']]],