From 989da0b28e8782637ef626d4a01796e8f354575a Mon Sep 17 00:00:00 2001 From: jgromes Date: Tue, 17 Dec 2024 20:13:11 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=206e3b8?= =?UTF-8?q?70317770a38aa58ca55075ca8ee5b86bc13=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- _s_t_m32_w_lx_8h_source.html | 2 +- _s_x126x_8h_source.html | 273 +++++++++++++++++------------------ functions_func_g.html | 4 +- functions_g.html | 4 +- search/all_6.js | 4 +- search/functions_6.js | 4 +- 6 files changed, 145 insertions(+), 146 deletions(-) diff --git a/_s_t_m32_w_lx_8h_source.html b/_s_t_m32_w_lx_8h_source.html index 379e5c34..8e5c12c7 100644 --- a/_s_t_m32_w_lx_8h_source.html +++ b/_s_t_m32_w_lx_8h_source.html @@ -186,7 +186,7 @@ $(document).ready(function(){initNavTree('_s_t_m32_w_lx_8h_source.html',''); ini
void setPacketReceivedAction(void(*func)(void)) override
Sets interrupt service routine to call when a packet is received.
Definition: STM32WLx.cpp:130
int16_t beginFSK(float freq=434.0, float br=4.8, float freqDev=5.0, float rxBw=156.2, int8_t power=10, uint16_t preambleLength=16, float tcxoVoltage=1.6, bool useRegulatorLDO=false)
Initialization method for FSK modem.
Definition: STM32WLx.cpp:27
Derived class for SX1262 modules.
Definition: SX1262.h:22
-
void setRfSwitchTable(const uint32_t(&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:1628
+
void setRfSwitchTable(const uint32_t(&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:1569
diff --git a/_s_x126x_8h_source.html b/_s_x126x_8h_source.html index 54d377d1..a81dcae3 100644 --- a/_s_x126x_8h_source.html +++ b/_s_x126x_8h_source.html @@ -673,11 +673,11 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
901 
909  int16_t setSyncBits(uint8_t *syncWord, uint8_t bitsLen);
910 
-
916  int16_t setNodeAddress(uint8_t addr);
+
916  int16_t setNodeAddress(uint8_t addr);
917 
-
924  int16_t setBroadcastAddress(uint8_t broadAddr);
+
924  int16_t setBroadcastAddress(uint8_t broadAddr);
925 
-
930  int16_t disableAddressFiltering();
+
930  int16_t disableAddressFiltering();
931 
940  int16_t setCRC(uint8_t len, uint16_t initial = 0x1D0F, uint16_t polynomial = 0x1021, bool inverted = true);
941 
@@ -821,63 +821,62 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
1286  bool ldroAuto = true;
1287 
1288  uint32_t bitRate = 0, frequencyDev = 0;
-
1289  uint8_t preambleDetLength = 0, rxBandwidth = 0, pulseShape = 0, crcTypeFSK = 0, syncWordLength = 0, addrComp = 0, whitening = 0, packetType = 0;
+
1289  uint8_t preambleDetLength = 0, rxBandwidth = 0, pulseShape = 0, crcTypeFSK = 0, syncWordLength = 0, whitening = 0, packetType = 0;
1290  uint16_t preambleLengthFSK = 0;
1291  float rxBandwidthKhz = 0;
-
1292  uint8_t nodeAddr = 0;
-
1293 
-
1294  float dataRateMeasured = 0;
-
1295 
-
1296  uint32_t tcxoDelay = 0;
-
1297  uint8_t pwr = 0;
-
1298 
-
1299  size_t implicitLen = 0;
-
1300  uint8_t invertIQEnabled = RADIOLIB_SX126X_LORA_IQ_STANDARD;
-
1301 
-
1302  // LR-FHSS stuff - there's a lot of it because all the encoding happens in software
-
1303  uint8_t lrFhssCr = RADIOLIB_SX126X_LR_FHSS_CR_2_3;
-
1304  uint8_t lrFhssBw = RADIOLIB_SX126X_LR_FHSS_BW_722_66;
-
1305  uint8_t lrFhssHdrCount = 3;
-
1306  uint8_t lrFhssSyncWord[RADIOLIB_SX126X_LR_FHSS_SYNC_WORD_BYTES] = { 0x12, 0xAD, 0x10, 0x1B };
-
1307  bool lrFhssGridNonFcc = false;
-
1308  uint16_t lrFhssNgrid = 0;
-
1309  uint16_t lrFhssLfsrState = 0;
-
1310  uint16_t lrFhssPoly = 0;
-
1311  uint16_t lrFhssSeed = 0;
-
1312  uint16_t lrFhssHopSeqId = 0;
-
1313  size_t lrFhssFrameBitsRem = 0;
-
1314  size_t lrFhssFrameHopsRem = 0;
-
1315  size_t lrFhssHopNum = 0;
-
1316 
-
1317  int16_t modSetup(float tcxoVoltage, bool useRegulatorLDO, uint8_t modem);
-
1318  int16_t config(uint8_t modem);
-
1319  bool findChip(const char* verStr);
-
1320  int16_t startReceiveCommon(uint32_t timeout = RADIOLIB_SX126X_RX_TIMEOUT_INF, RadioLibIrqFlags_t irqFlags = RADIOLIB_IRQ_RX_DEFAULT_FLAGS, RadioLibIrqFlags_t irqMask = RADIOLIB_IRQ_RX_DEFAULT_MASK);
-
1321  int16_t setPacketMode(uint8_t mode, uint8_t len);
-
1322  int16_t setHeaderType(uint8_t hdrType, size_t len = 0xFF);
-
1323  int16_t directMode();
-
1324  int16_t packetMode();
-
1325 
-
1326  // fixes to errata
-
1327  int16_t fixSensitivity();
-
1328  int16_t fixImplicitTimeout();
-
1329  int16_t fixInvertedIQ(uint8_t iqConfig);
-
1330 
-
1331  // LR-FHSS utilities
-
1332  int16_t buildLRFHSSPacket(const uint8_t* in, size_t in_len, uint8_t* out, size_t* out_len, size_t* out_bits, size_t* out_hops);
-
1333  int16_t resetLRFHSS();
-
1334  uint16_t stepLRFHSS();
-
1335  int16_t setLRFHSSHop(uint8_t index);
-
1336 
-
1337  void regdump();
-
1338  void effectEvalPre(uint8_t* buff, uint32_t start);
-
1339  void effectEvalPost(uint8_t* buff, uint32_t start);
-
1340  void effectEval();
-
1341 };
-
1342 
-
1343 #endif
-
1344 
-
1345 #endif
+
1292 
+
1293  float dataRateMeasured = 0;
+
1294 
+
1295  uint32_t tcxoDelay = 0;
+
1296  uint8_t pwr = 0;
+
1297 
+
1298  size_t implicitLen = 0;
+
1299  uint8_t invertIQEnabled = RADIOLIB_SX126X_LORA_IQ_STANDARD;
+
1300 
+
1301  // LR-FHSS stuff - there's a lot of it because all the encoding happens in software
+
1302  uint8_t lrFhssCr = RADIOLIB_SX126X_LR_FHSS_CR_2_3;
+
1303  uint8_t lrFhssBw = RADIOLIB_SX126X_LR_FHSS_BW_722_66;
+
1304  uint8_t lrFhssHdrCount = 3;
+
1305  uint8_t lrFhssSyncWord[RADIOLIB_SX126X_LR_FHSS_SYNC_WORD_BYTES] = { 0x12, 0xAD, 0x10, 0x1B };
+
1306  bool lrFhssGridNonFcc = false;
+
1307  uint16_t lrFhssNgrid = 0;
+
1308  uint16_t lrFhssLfsrState = 0;
+
1309  uint16_t lrFhssPoly = 0;
+
1310  uint16_t lrFhssSeed = 0;
+
1311  uint16_t lrFhssHopSeqId = 0;
+
1312  size_t lrFhssFrameBitsRem = 0;
+
1313  size_t lrFhssFrameHopsRem = 0;
+
1314  size_t lrFhssHopNum = 0;
+
1315 
+
1316  int16_t modSetup(float tcxoVoltage, bool useRegulatorLDO, uint8_t modem);
+
1317  int16_t config(uint8_t modem);
+
1318  bool findChip(const char* verStr);
+
1319  int16_t startReceiveCommon(uint32_t timeout = RADIOLIB_SX126X_RX_TIMEOUT_INF, RadioLibIrqFlags_t irqFlags = RADIOLIB_IRQ_RX_DEFAULT_FLAGS, RadioLibIrqFlags_t irqMask = RADIOLIB_IRQ_RX_DEFAULT_MASK);
+
1320  int16_t setPacketMode(uint8_t mode, uint8_t len);
+
1321  int16_t setHeaderType(uint8_t hdrType, size_t len = 0xFF);
+
1322  int16_t directMode();
+
1323  int16_t packetMode();
+
1324 
+
1325  // fixes to errata
+
1326  int16_t fixSensitivity();
+
1327  int16_t fixImplicitTimeout();
+
1328  int16_t fixInvertedIQ(uint8_t iqConfig);
+
1329 
+
1330  // LR-FHSS utilities
+
1331  int16_t buildLRFHSSPacket(const uint8_t* in, size_t in_len, uint8_t* out, size_t* out_len, size_t* out_bits, size_t* out_hops);
+
1332  int16_t resetLRFHSS();
+
1333  uint16_t stepLRFHSS();
+
1334  int16_t setLRFHSSHop(uint8_t index);
+
1335 
+
1336  void regdump();
+
1337  void effectEvalPre(uint8_t* buff, uint32_t start);
+
1338  void effectEvalPost(uint8_t* buff, uint32_t start);
+
1339  void effectEval();
+
1340 };
+
1341 
+
1342 #endif
+
1343 
+
1344 #endif
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:73
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code. Note: It is not recommended to use this c...
Definition: Module.h:82
@ MODE_TX
Transmission mode.
Definition: Module.h:119
@@ -887,94 +886,94 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
int16_t startTransmit(const char *str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:148
virtual int16_t receive(uint8_t *data, size_t len)
Binary receive method. Must be implemented in module class.
Definition: PhysicalLayer.cpp:111
Base class for SX126x series. All derived classes for SX126x (e.g. SX1262 or SX1268) inherit from thi...
Definition: SX126x.h:475
-
int16_t startChannelScan() override
Interrupt-driven channel activity detection method. DIO1 will be activated when LoRa preamble is dete...
Definition: SX126x.cpp:799
-
float getFrequencyError()
Gets frequency error of the latest received packet. WARNING: This functionality is based on SX128x im...
Definition: SX126x.cpp:1451
-
void setRfSwitchPins(uint32_t rxEn, uint32_t txEn)
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: SX126x.cpp:1624
-
void setDio1Action(void(*func)(void))
Sets interrupt service routine to call when DIO1 activates.
Definition: SX126x.cpp:479
-
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)
Set the PA configuration. Allows user to optimize PA for a specific output power and matching network...
Definition: SX126x.cpp:1936
-
RadioLibTime_t getTimeOnAir(size_t len) override
Get expected time-on-air for a given size of payload.
Definition: SX126x.cpp:1512
-
uint8_t randomByte() override
Get one truly random byte from RSSI noise.
Definition: SX126x.cpp:1653
-
RadioLibTime_t calculateRxTimeout(RadioLibTime_t timeoutUs) override
Calculate the timeout value for this specific module / series (in number of symbols or units of time)
Definition: SX126x.cpp:1583
-
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:1173
-
int16_t setRegulatorLDO()
Set regulator mode to LDO.
Definition: SX126x.cpp:1612
-
int16_t invertIQ(bool enable) override
Enable/disable inversion of the I and Q signals.
Definition: SX126x.cpp:1682
-
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 mus...
Definition: SX126x.cpp:1725
-
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Available in FSK mode only. Serves only as alias for PhysicalLayer compat...
Definition: SX126x.cpp:1620
-
void setRfSwitchTable(const uint32_t(&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:1628
+
int16_t startChannelScan() override
Interrupt-driven channel activity detection method. DIO1 will be activated when LoRa preamble is dete...
Definition: SX126x.cpp:786
+
float getFrequencyError()
Gets frequency error of the latest received packet. WARNING: This functionality is based on SX128x im...
Definition: SX126x.cpp:1392
+
void setRfSwitchPins(uint32_t rxEn, uint32_t txEn)
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: SX126x.cpp:1565
+
void setDio1Action(void(*func)(void))
Sets interrupt service routine to call when DIO1 activates.
Definition: SX126x.cpp:478
+
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)
Set the PA configuration. Allows user to optimize PA for a specific output power and matching network...
Definition: SX126x.cpp:1877
+
RadioLibTime_t getTimeOnAir(size_t len) override
Get expected time-on-air for a given size of payload.
Definition: SX126x.cpp:1453
+
uint8_t randomByte() override
Get one truly random byte from RSSI noise.
Definition: SX126x.cpp:1594
+
RadioLibTime_t calculateRxTimeout(RadioLibTime_t timeoutUs) override
Calculate the timeout value for this specific module / series (in number of symbols or units of time)
Definition: SX126x.cpp:1524
+
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:1160
+
int16_t setRegulatorLDO()
Set regulator mode to LDO.
Definition: SX126x.cpp:1553
+
int16_t invertIQ(bool enable) override
Enable/disable inversion of the I and Q signals.
Definition: SX126x.cpp:1623
+
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 mus...
Definition: SX126x.cpp:1666
+
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Available in FSK mode only. Serves only as alias for PhysicalLayer compat...
Definition: SX126x.cpp:1561
+
void setRfSwitchTable(const uint32_t(&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:1569
int16_t beginFSK(float br, float freqDev, float rxBw, uint16_t preambleLength, float tcxoVoltage, bool useRegulatorLDO=false)
Initialization method for FSK modem.
Definition: SX126x.cpp:68
-
int16_t setBandwidth(float bw)
Sets LoRa bandwidth. Allowed values are 7.8, 10.4, 15.6, 20.8, 31.25, 41.7, 62.5, 125....
Definition: SX126x.cpp:859
-
int16_t calibrateImage(float freq)
Perform image rejection calibration for the specified frequency. Will try to use Semtech-defined pres...
Definition: SX126x.cpp:1983
+
int16_t setBandwidth(float bw)
Sets LoRa bandwidth. Allowed values are 7.8, 10.4, 15.6, 20.8, 31.25, 41.7, 62.5, 125....
Definition: SX126x.cpp:846
+
int16_t calibrateImage(float freq)
Perform image rejection calibration for the specified frequency. Will try to use Semtech-defined pres...
Definition: SX126x.cpp:1924
virtual int16_t readData(uint8_t *data, size_t len)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:206
-
int16_t explicitHeader()
Set explicit header mode for future reception/transmission.
Definition: SX126x.cpp:1608
-
void clearChannelScanAction() override
Clears interrupt service routine to call when a channel scan is finished.
Definition: SX126x.cpp:507
-
int16_t forceLDRO(bool enable)
Forces LoRa low data rate optimization. Only available in LoRa mode. After calling this method,...
Definition: SX126x.cpp:1632
+
int16_t explicitHeader()
Set explicit header mode for future reception/transmission.
Definition: SX126x.cpp:1549
+
void clearChannelScanAction() override
Clears interrupt service routine to call when a channel scan is finished.
Definition: SX126x.cpp:506
+
int16_t forceLDRO(bool enable)
Forces LoRa low data rate optimization. Only available in LoRa mode. After calling this method,...
Definition: SX126x.cpp:1573
int16_t transmit(const char *str, uint8_t addr=0)
C-string transmit method.
Definition: PhysicalLayer.cpp:53
-
void setDirectAction(void(*func)(void)) override
Set interrupt service routine function to call when data bit is received in direct mode.
Definition: SX126x.cpp:1716
-
int16_t setIrqFlags(uint32_t irq) override
Set interrupt on DIO1 to be sent on a specific IRQ bit (e.g. RxTimeout, CadDone).
Definition: SX126x.cpp:1596
-
int16_t spectralScanGetStatus()
Read the status of spectral scan.
Definition: SX126x.cpp:1792
-
void clearPacketReceivedAction() override
Clears interrupt service routine to call when a packet is received.
Definition: SX126x.cpp:491
-
int16_t setTCXO(float voltage, uint32_t delay=5000)
Sets TCXO (Temperature Compensated Crystal Oscillator) configuration.
Definition: SX126x.cpp:1812
-
float getSNR() override
Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem.
Definition: SX126x.cpp:1435
-
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:1094
-
int16_t setRegulatorDCDC()
Set regulator mode to DC-DC.
Definition: SX126x.cpp:1616
-
int16_t startReceive() override
Interrupt-driven receive method with default parameters. Implemented for compatibility with PhysicalL...
Definition: SX126x.cpp:639
-
void clearDio1Action()
Clears interrupt service routine to call when DIO1 activates.
Definition: SX126x.cpp:483
-
int16_t checkDataRate(DataRate_t dr) override
Check the data rate can be configured by this module.
Definition: SX126x.cpp:1073
-
void setPacketReceivedAction(void(*func)(void)) override
Sets interrupt service routine to call when a packet is received.
Definition: SX126x.cpp:487
-
float getRSSI() override
Gets recorded signal strength indicator. Overload with packet mode enabled for PhysicalLayer compatib...
Definition: SX126x.cpp:1417
-
int16_t standby() override
Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator)...
Definition: SX126x.cpp:462
-
int16_t setFrequencyDeviation(float freqDev) override
Sets FSK frequency deviation. Allowed values range from 0.0 to 200.0 kHz.
Definition: SX126x.cpp:990
-
void spectralScanAbort()
Abort an ongoing spectral scan.
Definition: SX126x.cpp:1788
-
int16_t getModem(ModemType_t *modem) override
Get modem currently in use by the radio.
Definition: SX126x.cpp:1696
-
int16_t sleep() override
Sets the module to sleep mode. To wake the device up, call standby(). Overload with warm start enable...
Definition: SX126x.cpp:442
-
int16_t receiveDirect() override
Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as SX126x series does...
Definition: SX126x.cpp:339
-
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:1772
-
int16_t finishTransmit() override
Clean up after transmission is done.
Definition: SX126x.cpp:624
-
int16_t setCurrentLimit(float currentLimit)
Sets current protection limit. Can be set in 2.5 mA steps.
Definition: SX126x.cpp:947
-
int16_t setRxBoostedGainMode(bool rxbgm, bool persist=true)
Enables or disables Rx Boosted Gain mode as described in SX126x datasheet section 9....
Definition: SX126x.cpp:1157
-
int16_t transmitDirect(uint32_t frf=0) override
Starts direct mode transmission.
Definition: SX126x.cpp:323
+
void setDirectAction(void(*func)(void)) override
Set interrupt service routine function to call when data bit is received in direct mode.
Definition: SX126x.cpp:1657
+
int16_t setIrqFlags(uint32_t irq) override
Set interrupt on DIO1 to be sent on a specific IRQ bit (e.g. RxTimeout, CadDone).
Definition: SX126x.cpp:1537
+
int16_t spectralScanGetStatus()
Read the status of spectral scan.
Definition: SX126x.cpp:1733
+
void clearPacketReceivedAction() override
Clears interrupt service routine to call when a packet is received.
Definition: SX126x.cpp:490
+
int16_t setTCXO(float voltage, uint32_t delay=5000)
Sets TCXO (Temperature Compensated Crystal Oscillator) configuration.
Definition: SX126x.cpp:1753
+
float getSNR() override
Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem.
Definition: SX126x.cpp:1376
+
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:1081
+
int16_t setRegulatorDCDC()
Set regulator mode to DC-DC.
Definition: SX126x.cpp:1557
+
int16_t startReceive() override
Interrupt-driven receive method with default parameters. Implemented for compatibility with PhysicalL...
Definition: SX126x.cpp:626
+
void clearDio1Action()
Clears interrupt service routine to call when DIO1 activates.
Definition: SX126x.cpp:482
+
int16_t checkDataRate(DataRate_t dr) override
Check the data rate can be configured by this module.
Definition: SX126x.cpp:1060
+
void setPacketReceivedAction(void(*func)(void)) override
Sets interrupt service routine to call when a packet is received.
Definition: SX126x.cpp:486
+
float getRSSI() override
Gets recorded signal strength indicator. Overload with packet mode enabled for PhysicalLayer compatib...
Definition: SX126x.cpp:1358
+
int16_t standby() override
Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator)...
Definition: SX126x.cpp:461
+
int16_t setFrequencyDeviation(float freqDev) override
Sets FSK frequency deviation. Allowed values range from 0.0 to 200.0 kHz.
Definition: SX126x.cpp:977
+
void spectralScanAbort()
Abort an ongoing spectral scan.
Definition: SX126x.cpp:1729
+
int16_t getModem(ModemType_t *modem) override
Get modem currently in use by the radio.
Definition: SX126x.cpp:1637
+
int16_t sleep() override
Sets the module to sleep mode. To wake the device up, call standby(). Overload with warm start enable...
Definition: SX126x.cpp:441
+
int16_t receiveDirect() override
Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as SX126x series does...
Definition: SX126x.cpp:338
+
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:1713
+
int16_t finishTransmit() override
Clean up after transmission is done.
Definition: SX126x.cpp:617
+
int16_t setCurrentLimit(float currentLimit)
Sets current protection limit. Can be set in 2.5 mA steps.
Definition: SX126x.cpp:934
+
int16_t setRxBoostedGainMode(bool rxbgm, bool persist=true)
Enables or disables Rx Boosted Gain mode as described in SX126x datasheet section 9....
Definition: SX126x.cpp:1144
+
int16_t transmitDirect(uint32_t frf=0) override
Starts direct mode transmission.
Definition: SX126x.cpp:322
int16_t startTransmit(const char *str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:148
-
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:1508
+
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:1449
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:22
-
int16_t setCRC(uint8_t len, uint16_t initial=0x1D0F, uint16_t polynomial=0x1021, bool inverted=true)
Sets CRC configuration.
Definition: SX126x.cpp:1317
-
int16_t reset(bool verify=true)
Reset method. Will reset the chip to the default state using RST pin.
Definition: SX126x.cpp:163
-
int16_t setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)
Sets LoRa sync word.
Definition: SX126x.cpp:936
-
int16_t setLrFhssConfig(uint8_t bw, uint8_t cr, uint8_t hdrCount=3, uint16_t hopSeqId=0x100)
Sets LR-FHSS configuration.
Definition: SX126x.cpp:150
-
int16_t calibrateImageRejection(float freqMin, float freqMax)
Perform image rejection calibration for the specified frequency band. WARNING: Use at your own risk!...
Definition: SX126x.cpp:2020
-
float getCurrentLimit()
Reads current protection limit.
Definition: SX126x.cpp:960
+
int16_t setCRC(uint8_t len, uint16_t initial=0x1D0F, uint16_t polynomial=0x1021, bool inverted=true)
Sets CRC configuration.
Definition: SX126x.cpp:1258
+
int16_t reset(bool verify=true)
Reset method. Will reset the chip to the default state using RST pin.
Definition: SX126x.cpp:162
+
int16_t setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)
Sets LoRa sync word.
Definition: SX126x.cpp:923
+
int16_t setLrFhssConfig(uint8_t bw, uint8_t cr, uint8_t hdrCount=3, uint16_t hopSeqId=0x100)
Sets LR-FHSS configuration.
Definition: SX126x.cpp:149
+
int16_t calibrateImageRejection(float freqMin, float freqMax)
Perform image rejection calibration for the specified frequency band. WARNING: Use at your own risk!...
Definition: SX126x.cpp:1961
+
float getCurrentLimit()
Reads current protection limit.
Definition: SX126x.cpp:947
SX126x(Module *mod)
Default constructor.
Definition: SX126x.cpp:6
-
int16_t clearIrqFlags(uint32_t irq) override
Clear interrupt on a specific IRQ bit (e.g. RxTimeout, CadDone).
Definition: SX126x.cpp:1600
-
uint32_t getIrqFlags() override
Read currently active IRQ flags.
Definition: SX126x.cpp:1590
+
int16_t clearIrqFlags(uint32_t irq) override
Clear interrupt on a specific IRQ bit (e.g. RxTimeout, CadDone).
Definition: SX126x.cpp:1541
+
uint32_t getIrqFlags() override
Read currently active IRQ flags.
Definition: SX126x.cpp:1531
virtual int16_t receive(uint8_t *data, size_t len)
Binary receive method. Must be implemented in module class.
Definition: PhysicalLayer.cpp:111
-
int16_t autoLDRO()
Re-enables automatic LDRO configuration. Only available in LoRa mode. After calling this method,...
Definition: SX126x.cpp:1644
-
int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_SX126X_MAX_PACKET_LENGTH)
Set modem in fixed packet length mode. Available in FSK mode only.
Definition: SX126x.cpp:1504
-
int16_t setBroadcastAddress(uint8_t broadAddr)
Sets broadcast address. Calling this method will also enable address filtering for node and broadcast...
Definition: SX126x.cpp:1289
-
int16_t setBitRate(float br) override
Sets FSK bit rate. Allowed values range from 0.6 to 300.0 kbps.
Definition: SX126x.cpp:1014
-
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: SX126x.cpp:1484
-
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:1252
-
void setPacketSentAction(void(*func)(void)) override
Sets interrupt service routine to call when a packet is sent.
Definition: SX126x.cpp:495
-
void readBit(uint32_t pin) override
Function to read and process data bit in direct reception mode.
Definition: SX126x.cpp:1720
-
int16_t scanChannel() override
Performs scan for LoRa transmission in the current channel. Detects both preamble and payload....
Definition: SX126x.cpp:413
-
float getDataRate() const
Gets effective data rate for the last transmitted packet. The value is calculated only for payload by...
Definition: SX126x.cpp:1413
-
int16_t startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8, RadioLibIrqFlags_t irqFlags=RADIOLIB_IRQ_RX_DEFAULT_FLAGS, RadioLibIrqFlags_t irqMask=RADIOLIB_IRQ_RX_DEFAULT_MASK)
Calls startReceiveDutyCycle with rxPeriod and sleepPeriod set so the unit shouldn't miss any messages...
Definition: SX126x.cpp:689
-
int16_t setPreambleLength(size_t preambleLength) override
Sets preamble length for LoRa or FSK modem. Allowed values range from 1 to 65535.
Definition: SX126x.cpp:969
-
int16_t setPaRampTime(uint8_t rampTime)
Set PA ramp-up time. Set to 200us by default.
Definition: SX126x.cpp:2028
+
int16_t autoLDRO()
Re-enables automatic LDRO configuration. Only available in LoRa mode. After calling this method,...
Definition: SX126x.cpp:1585
+
int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_SX126X_MAX_PACKET_LENGTH)
Set modem in fixed packet length mode. Available in FSK mode only.
Definition: SX126x.cpp:1445
+
int16_t setBroadcastAddress(uint8_t broadAddr)
Sets broadcast address. Calling this method will also enable address filtering for node and broadcast...
+
int16_t setBitRate(float br) override
Sets FSK bit rate. Allowed values range from 0.6 to 300.0 kbps.
Definition: SX126x.cpp:1001
+
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: SX126x.cpp:1425
+
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:1239
+
void setPacketSentAction(void(*func)(void)) override
Sets interrupt service routine to call when a packet is sent.
Definition: SX126x.cpp:494
+
void readBit(uint32_t pin) override
Function to read and process data bit in direct reception mode.
Definition: SX126x.cpp:1661
+
int16_t scanChannel() override
Performs scan for LoRa transmission in the current channel. Detects both preamble and payload....
Definition: SX126x.cpp:412
+
float getDataRate() const
Gets effective data rate for the last transmitted packet. The value is calculated only for payload by...
Definition: SX126x.cpp:1354
+
int16_t startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8, RadioLibIrqFlags_t irqFlags=RADIOLIB_IRQ_RX_DEFAULT_FLAGS, RadioLibIrqFlags_t irqMask=RADIOLIB_IRQ_RX_DEFAULT_MASK)
Calls startReceiveDutyCycle with rxPeriod and sleepPeriod set so the unit shouldn't miss any messages...
Definition: SX126x.cpp:676
+
int16_t setPreambleLength(size_t preambleLength) override
Sets preamble length for LoRa or FSK modem. Allowed values range from 1 to 65535.
Definition: SX126x.cpp:956
+
int16_t setPaRampTime(uint8_t rampTime)
Set PA ramp-up time. Set to 200us by default.
Definition: SX126x.cpp:1969
bool XTAL
Whether the module has an XTAL (true) or TCXO (false). Defaults to false.
Definition: SX126x.h:492
-
int16_t implicitHeader(size_t len)
Set implicit header mode for future reception/transmission.
Definition: SX126x.cpp:1604
-
int16_t setNodeAddress(uint8_t addr)
Sets node address. Calling this method will also enable address filtering for node address only.
Definition: SX126x.cpp:1271
-
int16_t setDio2AsRfSwitch(bool enable=true)
Set DIO2 to function as RF switch (default in Semtech example designs).
Definition: SX126x.cpp:1865
-
int16_t spectralScanGetResult(uint16_t *results)
Read the result of spectral scan.
Definition: SX126x.cpp:1800
-
int16_t setWhitening(bool enabled, uint16_t initial=0x01FF)
Sets FSK whitening parameters.
Definition: SX126x.cpp:1376
-
int16_t setSpreadingFactor(uint8_t sf)
Sets LoRa spreading factor. Allowed values range from 5 to 12.
Definition: SX126x.cpp:910
+
int16_t implicitHeader(size_t len)
Set implicit header mode for future reception/transmission.
Definition: SX126x.cpp:1545
+
int16_t setNodeAddress(uint8_t addr)
Sets node address. Calling this method will also enable address filtering for node address only.
+
int16_t setDio2AsRfSwitch(bool enable=true)
Set DIO2 to function as RF switch (default in Semtech example designs).
Definition: SX126x.cpp:1806
+
int16_t spectralScanGetResult(uint16_t *results)
Read the result of spectral scan.
Definition: SX126x.cpp:1741
+
int16_t setWhitening(bool enabled, uint16_t initial=0x01FF)
Sets FSK whitening parameters.
Definition: SX126x.cpp:1317
+
int16_t setSpreadingFactor(uint8_t sf)
Sets LoRa spreading factor. Allowed values range from 5 to 12.
Definition: SX126x.cpp:897
bool standbyXOSC
Whether to use XOSC (true) or RC (false) oscillator in standby mode. Defaults to false.
Definition: SX126x.h:497
-
void setChannelScanAction(void(*func)(void)) override
Sets interrupt service routine to call when a channel scan is finished.
Definition: SX126x.cpp:503
-
int16_t setDataRate(DataRate_t dr) override
Set data.
Definition: SX126x.cpp:1035
-
void clearPacketSentAction() override
Clears interrupt service routine to call when a packet is sent.
Definition: SX126x.cpp:499
-
int16_t beginLRFHSS(uint8_t bw, uint8_t cr, bool narrowGrid, float tcxoVoltage, bool useRegulatorLDO=false)
Initialization method for LR-FHSS modem. This modem only supports transmission!
Definition: SX126x.cpp:122
-
int16_t startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, RadioLibIrqFlags_t irqFlags=RADIOLIB_IRQ_RX_DEFAULT_FLAGS, RadioLibIrqFlags_t irqMask=RADIOLIB_IRQ_RX_DEFAULT_MASK)
Interrupt-driven receive method where the device mostly sleeps and periodically wakes to listen....
Definition: SX126x.cpp:662
-
int16_t disableAddressFiltering()
Disables address filtering. Calling this method will also erase previously set addresses.
Definition: SX126x.cpp:1306
-
int16_t setCodingRate(uint8_t cr)
Sets LoRa coding rate denominator. Allowed values range from 5 to 8.
Definition: SX126x.cpp:923
-
int16_t getChannelScanResult() override
Read the channel scan result.
Definition: SX126x.cpp:840
+
void setChannelScanAction(void(*func)(void)) override
Sets interrupt service routine to call when a channel scan is finished.
Definition: SX126x.cpp:502
+
int16_t setDataRate(DataRate_t dr) override
Set data.
Definition: SX126x.cpp:1022
+
void clearPacketSentAction() override
Clears interrupt service routine to call when a packet is sent.
Definition: SX126x.cpp:498
+
int16_t beginLRFHSS(uint8_t bw, uint8_t cr, bool narrowGrid, float tcxoVoltage, bool useRegulatorLDO=false)
Initialization method for LR-FHSS modem. This modem only supports transmission!
Definition: SX126x.cpp:121
+
int16_t startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, RadioLibIrqFlags_t irqFlags=RADIOLIB_IRQ_RX_DEFAULT_FLAGS, RadioLibIrqFlags_t irqMask=RADIOLIB_IRQ_RX_DEFAULT_MASK)
Interrupt-driven receive method where the device mostly sleeps and periodically wakes to listen....
Definition: SX126x.cpp:649
+
int16_t disableAddressFiltering()
Disables address filtering. Calling this method will also erase previously set addresses.
+
int16_t setCodingRate(uint8_t cr)
Sets LoRa coding rate denominator. Allowed values range from 5 to 8.
Definition: SX126x.cpp:910
+
int16_t getChannelScanResult() override
Read the channel scan result.
Definition: SX126x.cpp:827
unsigned long RadioLibTime_t
Type used for durations in RadioLib.
Definition: TypeDef.h:642
uint32_t RadioLibIrqFlags_t
Type used for radio-agnostic IRQ flags. IRQ to enable corresponds to the bit index (RadioLibIrq_t)....
Definition: TypeDef.h:648
Description of RF switch pin states for a single mode. See setRfSwitchTable for details.
Definition: Module.h:89
diff --git a/functions_func_g.html b/functions_func_g.html index 5ae695e0..6517221f 100644 --- a/functions_func_g.html +++ b/functions_func_g.html @@ -171,13 +171,13 @@ $(document).ready(function(){initNavTree('functions_func_g.html',''); initResiza : LR11x0 , PhysicalLayer , SX126x +, SX127x
  • getIRQFlags() : SX127x
  • getIrqFlags() -: SX127x -, SX128x +: SX128x
  • getIrqMapped() : PhysicalLayer diff --git a/functions_g.html b/functions_g.html index 74e76766..42593b19 100644 --- a/functions_g.html +++ b/functions_g.html @@ -171,13 +171,13 @@ $(document).ready(function(){initNavTree('functions_g.html',''); initResizable() : LR11x0 , PhysicalLayer , SX126x -, SX127x
  • getIRQFlags() : SX127x
  • getIrqFlags() -: SX128x +: SX127x +, SX128x
  • getIrqMapped() : PhysicalLayer diff --git a/search/all_6.js b/search/all_6.js index 7f7aa268..92667129 100644 --- a/search/all_6.js +++ b/search/all_6.js @@ -23,8 +23,8 @@ var searchData= ['getgnsssatellites_172',['getGnssSatellites',['../class_l_r11x0.html#a97a3f23b796257135a9afd33c28e8ed5',1,'LR11x0']]], ['getgpio_173',['getGpio',['../class_module.html#a4ec27f0ba5e0009ea9661a5110526b52',1,'Module']]], ['getirq_174',['getIrq',['../class_module.html#ab61bc5066c356e2d0d79f08a2bd0fbc9',1,'Module']]], - ['getirqflags_175',['getIrqFlags',['../class_l_r11x0.html#a205364e65d54f3f87b9b8f5972cdcb99',1,'LR11x0::getIrqFlags()'],['../class_s_x126x.html#ab4f9b0c6496a796211e9816bf92146a7',1,'SX126x::getIrqFlags()'],['../class_s_x127x.html#a22de05835dda9ed287ec48f60ef91f55',1,'SX127x::getIrqFlags()'],['../class_s_x128x.html#aa17ffcb939f6b2eb0712e63b6ee7a71f',1,'SX128x::getIrqFlags()'],['../class_physical_layer.html#af1caeed34b2e2ff0355467507106a1a2',1,'PhysicalLayer::getIrqFlags()']]], - ['getirqflags_176',['getIRQFlags',['../class_s_x127x.html#ac5d2ddb517e474a699b4539653b3754d',1,'SX127x']]], + ['getirqflags_175',['getIRQFlags',['../class_s_x127x.html#ac5d2ddb517e474a699b4539653b3754d',1,'SX127x']]], + ['getirqflags_176',['getIrqFlags',['../class_l_r11x0.html#a205364e65d54f3f87b9b8f5972cdcb99',1,'LR11x0::getIrqFlags()'],['../class_s_x126x.html#ab4f9b0c6496a796211e9816bf92146a7',1,'SX126x::getIrqFlags()'],['../class_s_x127x.html#a22de05835dda9ed287ec48f60ef91f55',1,'SX127x::getIrqFlags()'],['../class_s_x128x.html#aa17ffcb939f6b2eb0712e63b6ee7a71f',1,'SX128x::getIrqFlags()'],['../class_physical_layer.html#af1caeed34b2e2ff0355467507106a1a2',1,'PhysicalLayer::getIrqFlags()']]], ['getirqmapped_177',['getIrqMapped',['../class_physical_layer.html#ae602ebd46d60da8670c9f353cef695d9',1,'PhysicalLayer']]], ['getirqstatus_178',['getIrqStatus',['../class_l_r11x0.html#a0309154558a0d88e2e8957e4dbf6a2f8',1,'LR11x0::getIrqStatus()'],['../class_s_x128x.html#ae1f933f767161cc59fdaca816ab93e22',1,'SX128x::getIrqStatus()']]], ['getlasttoa_179',['getLastToA',['../class_lo_ra_w_a_n_node.html#a683b02b63867bb7de5df45c94d190305',1,'LoRaWANNode']]], diff --git a/search/functions_6.js b/search/functions_6.js index 885cc6ad..125e75bc 100644 --- a/search/functions_6.js +++ b/search/functions_6.js @@ -23,8 +23,8 @@ var searchData= ['getgnsssatellites_905',['getGnssSatellites',['../class_l_r11x0.html#a97a3f23b796257135a9afd33c28e8ed5',1,'LR11x0']]], ['getgpio_906',['getGpio',['../class_module.html#a4ec27f0ba5e0009ea9661a5110526b52',1,'Module']]], ['getirq_907',['getIrq',['../class_module.html#ab61bc5066c356e2d0d79f08a2bd0fbc9',1,'Module']]], - ['getirqflags_908',['getIRQFlags',['../class_s_x127x.html#ac5d2ddb517e474a699b4539653b3754d',1,'SX127x']]], - ['getirqflags_909',['getIrqFlags',['../class_physical_layer.html#af1caeed34b2e2ff0355467507106a1a2',1,'PhysicalLayer::getIrqFlags()'],['../class_s_x128x.html#aa17ffcb939f6b2eb0712e63b6ee7a71f',1,'SX128x::getIrqFlags()'],['../class_s_x127x.html#a22de05835dda9ed287ec48f60ef91f55',1,'SX127x::getIrqFlags()'],['../class_s_x126x.html#ab4f9b0c6496a796211e9816bf92146a7',1,'SX126x::getIrqFlags()'],['../class_l_r11x0.html#a205364e65d54f3f87b9b8f5972cdcb99',1,'LR11x0::getIrqFlags()']]], + ['getirqflags_908',['getIrqFlags',['../class_physical_layer.html#af1caeed34b2e2ff0355467507106a1a2',1,'PhysicalLayer::getIrqFlags()'],['../class_s_x128x.html#aa17ffcb939f6b2eb0712e63b6ee7a71f',1,'SX128x::getIrqFlags()'],['../class_s_x127x.html#a22de05835dda9ed287ec48f60ef91f55',1,'SX127x::getIrqFlags()'],['../class_s_x126x.html#ab4f9b0c6496a796211e9816bf92146a7',1,'SX126x::getIrqFlags()'],['../class_l_r11x0.html#a205364e65d54f3f87b9b8f5972cdcb99',1,'LR11x0::getIrqFlags()']]], + ['getirqflags_909',['getIRQFlags',['../class_s_x127x.html#ac5d2ddb517e474a699b4539653b3754d',1,'SX127x']]], ['getirqmapped_910',['getIrqMapped',['../class_physical_layer.html#ae602ebd46d60da8670c9f353cef695d9',1,'PhysicalLayer']]], ['getirqstatus_911',['getIrqStatus',['../class_l_r11x0.html#a0309154558a0d88e2e8957e4dbf6a2f8',1,'LR11x0::getIrqStatus()'],['../class_s_x128x.html#ae1f933f767161cc59fdaca816ab93e22',1,'SX128x::getIrqStatus()']]], ['getlasttoa_912',['getLastToA',['../class_lo_ra_w_a_n_node.html#a683b02b63867bb7de5df45c94d190305',1,'LoRaWANNode']]],