diff --git a/_l_r11x0_8h_source.html b/_l_r11x0_8h_source.html index 6da0225a..84b1eb90 100644 --- a/_l_r11x0_8h_source.html +++ b/_l_r11x0_8h_source.html @@ -721,407 +721,409 @@ $(document).ready(function(){initNavTree('_l_r11x0_8h_source.html',''); initResi
760 
768  int16_t standby(uint8_t mode, bool wakeup = true);
769 
-
777  int16_t sleep(bool retainConfig = true, uint32_t sleepTime = 0);
-
778 
-
779  // interrupt methods
-
780 
-
785  void setIrqAction(void (*func)(void));
-
786 
-
790  void clearIrqAction();
-
791 
-
796  void setPacketReceivedAction(void (*func)(void)) override;
-
797 
-
801  void clearPacketReceivedAction() override;
-
802 
-
807  void setPacketSentAction(void (*func)(void)) override;
-
808 
-
812  void clearPacketSentAction() override;
-
813 
-
822  int16_t startTransmit(uint8_t* data, size_t len, uint8_t addr = 0) override;
-
823 
-
828  int16_t finishTransmit() override;
-
829 
-
836  int16_t startReceive() override;
-
837 
-
850  int16_t startReceive(uint32_t timeout, uint32_t irqFlags = RADIOLIB_LR11X0_IRQ_RX_DONE, uint32_t irqMask = 0, size_t len = 0);
-
851 
-
856  uint32_t getIrqStatus();
-
857 
-
866  int16_t readData(uint8_t* data, size_t len) override;
-
867 
-
873  int16_t startChannelScan() override;
-
874 
-
883  int16_t startChannelScan(uint8_t symbolNum, uint8_t detPeak, uint8_t detMin);
-
884 
-
889  int16_t getChannelScanResult() override;
-
890 
-
891  // configuration methods
-
892 
-
898  int16_t setOutputPower(int8_t power) override;
-
899 
-
907  int16_t setOutputPower(int8_t power, bool forceHighPower);
-
908 
-
916  int16_t checkOutputPower(int8_t power, int8_t* clipped) override;
-
917 
-
926  int16_t checkOutputPower(int8_t power, int8_t* clipped, bool forceHighPower);
-
927 
-
933  int16_t setBandwidth(float bw);
-
934 
-
941  int16_t setSpreadingFactor(uint8_t sf, bool legacy = false);
-
942 
-
950  int16_t setCodingRate(uint8_t cr, bool longInterleave = false);
-
951 
-
957  int16_t setSyncWord(uint32_t syncWord);
-
958 
-
964  int16_t setBitRate(float br) override;
-
965 
-
971  int16_t setFrequencyDeviation(float freqDev) override;
-
972 
-
979  int16_t setRxBandwidth(float rxBw);
-
980 
-
987  int16_t setSyncWord(uint8_t* syncWord, size_t len) override;
-
988 
-
996  int16_t setSyncBits(uint8_t *syncWord, uint8_t bitsLen);
-
997 
-
1003  int16_t setNodeAddress(uint8_t nodeAddr);
-
1004 
-
1011  int16_t setBroadcastAddress(uint8_t broadAddr);
-
1012 
-
1017  int16_t disableAddressFiltering();
-
1018 
-
1026  int16_t setDataShaping(uint8_t sh) override;
-
1027 
-
1033  int16_t setEncoding(uint8_t encoding) override;
-
1034 
-
1040  int16_t fixedPacketLengthMode(uint8_t len = RADIOLIB_LR11X0_MAX_PACKET_LENGTH);
-
1041 
-
1047  int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_LR11X0_MAX_PACKET_LENGTH);
-
1048 
-
1056  int16_t setWhitening(bool enabled, uint16_t initial = 0x01FF);
-
1057 
-
1063  int16_t setDataRate(DataRate_t dr) override;
-
1064 
-
1070  int16_t checkDataRate(DataRate_t dr) override;
-
1071 
-
1077  int16_t setPreambleLength(size_t preambleLength) override;
-
1078 
-
1087  int16_t setTCXO(float voltage, uint32_t delay = 5000);
-
1088 
-
1097  int16_t setCRC(uint8_t len, uint32_t initial = 0x00001D0FUL, uint32_t polynomial = 0x00001021UL, bool inverted = true);
-
1098 
-
1104  int16_t invertIQ(bool enable) override;
-
1105 
-
1110  float getRSSI() override;
-
1111 
-
1116  float getSNR() override;
-
1117 
-
1122  float getFrequencyError();
-
1123 
-
1129  size_t getPacketLength(bool update = true) override;
-
1130 
-
1136  size_t getPacketLength(bool update, uint8_t* offset);
-
1137 
-
1143  RadioLibTime_t getTimeOnAir(size_t len) override;
-
1144 
-
1150  RadioLibTime_t calculateRxTimeout(RadioLibTime_t timeoutUs) override;
-
1151 
-
1158  int16_t irqRxDoneRxTimeout(uint32_t &irqFlags, uint32_t &irqMask) override;
-
1159 
-
1164  bool isRxTimeout() override;
-
1165 
-
1170  uint8_t randomByte() override;
-
1171 
-
1177  int16_t implicitHeader(size_t len);
-
1178 
-
1183  int16_t explicitHeader();
-
1184 
-
1189  float getDataRate() const;
-
1190 
-
1199  int16_t setLrFhssConfig(uint8_t bw, uint8_t cr, uint8_t hdrCount = 3, uint16_t hopSeed = 0x13A);
-
1200 
-
1215  int16_t startWifiScan(char wifiType, uint8_t mode = RADIOLIB_LR11X0_WIFI_ACQ_MODE_FULL_BEACON, uint16_t chanMask = RADIOLIB_LR11X0_WIFI_ALL_CHANNELS, uint8_t numScans = 16, uint16_t timeout = 100);
-
1216 
-
1221  void setWiFiScanAction(void (*func)(void));
-
1222 
-
1226  void clearWiFiScanAction();
-
1227 
-
1233  int16_t getWifiScanResultsCount(uint8_t* count);
-
1234 
-
1244  int16_t getWifiScanResult(LR11x0WifiResult_t* result, uint8_t index, bool brief = false);
-
1245 
-
1262  int16_t wifiScan(uint8_t wifiType, uint8_t* count, uint8_t mode = RADIOLIB_LR11X0_WIFI_ACQ_MODE_FULL_BEACON, uint16_t chanMask = RADIOLIB_LR11X0_WIFI_ALL_CHANNELS, uint8_t numScans = 16, uint16_t timeout = 100);
-
1263 
-
1264 #if !RADIOLIB_GODMODE && !RADIOLIB_LOW_LEVEL
-
1265  protected:
-
1266 #endif
-
1267  Module* getMod() override;
-
1268 
-
1269  // LR11x0 SPI command implementations
-
1270  int16_t writeRegMem32(uint32_t addr, uint32_t* data, size_t len);
-
1271  int16_t readRegMem32(uint32_t addr, uint32_t* data, size_t len);
-
1272  int16_t writeBuffer8(uint8_t* data, size_t len);
-
1273  int16_t readBuffer8(uint8_t* data, size_t len, size_t offset);
-
1274  int16_t clearRxBuffer(void);
-
1275  int16_t writeRegMemMask32(uint32_t addr, uint32_t mask, uint32_t data);
-
1276 
-
1277  int16_t getStatus(uint8_t* stat1, uint8_t* stat2, uint32_t* irq);
-
1278  int16_t getVersion(uint8_t* hw, uint8_t* device, uint8_t* major, uint8_t* minor);
-
1279  int16_t getErrors(uint16_t* err);
-
1280  int16_t clearErrors(void);
-
1281  int16_t calibrate(uint8_t params);
-
1282  int16_t setRegMode(uint8_t mode);
-
1283  int16_t calibImage(float freq1, float freq2);
-
1284  int16_t setDioAsRfSwitch(uint8_t en, uint8_t stbyCfg, uint8_t rxCfg, uint8_t txCfg, uint8_t txHpCfg, uint8_t txHfCfg, uint8_t gnssCfg, uint8_t wifiCfg);
-
1285  int16_t setDioIrqParams(uint32_t irq1, uint32_t irq2);
-
1286  int16_t clearIrq(uint32_t irq);
-
1287  int16_t configLfClock(uint8_t setup);
-
1288  int16_t setTcxoMode(uint8_t tune, uint32_t delay);
-
1289  int16_t reboot(bool stay);
-
1290  int16_t getVbat(float* vbat);
-
1291  int16_t getTemp(float* temp);
-
1292  int16_t setFs(void);
-
1293  int16_t getRandomNumber(uint32_t* rnd);
-
1294  int16_t eraseInfoPage(void);
-
1295  int16_t writeInfoPage(uint16_t addr, const uint32_t* data, size_t len);
-
1296  int16_t readInfoPage(uint16_t addr, uint32_t* data, size_t len);
-
1297  int16_t getChipEui(uint8_t* eui);
-
1298  int16_t getSemtechJoinEui(uint8_t* eui);
-
1299  int16_t deriveRootKeysAndGetPin(uint8_t* pin);
-
1300  int16_t enableSpiCrc(bool en);
-
1301  int16_t driveDiosInSleepMode(bool en);
-
1302 
-
1303  int16_t resetStats(void);
-
1304  int16_t getStats(uint16_t* nbPktReceived, uint16_t* nbPktCrcError, uint16_t* data1, uint16_t* data2);
-
1305  int16_t getPacketType(uint8_t* type);
-
1306  int16_t getRxBufferStatus(uint8_t* len, uint8_t* startOffset);
-
1307  int16_t getPacketStatusLoRa(float* rssiPkt, float* snrPkt, float* signalRssiPkt);
-
1308  int16_t getPacketStatusGFSK(float* rssiSync, float* rssiAvg, uint8_t* rxLen, uint8_t* stat);
-
1309  int16_t getRssiInst(float* rssi);
-
1310  int16_t setGfskSyncWord(uint8_t* sync);
-
1311  int16_t setLoRaPublicNetwork(bool pub);
-
1312  int16_t setRx(uint32_t timeout);
-
1313  int16_t setTx(uint32_t timeout);
-
1314  int16_t setRfFrequency(uint32_t rfFreq);
-
1315  int16_t autoTxRx(uint32_t delay, uint8_t intMode, uint32_t timeout);
-
1316  int16_t setCadParams(uint8_t symNum, uint8_t detPeak, uint8_t detMin, uint8_t cadExitMode, uint32_t timeout);
-
1317  int16_t setPacketType(uint8_t type);
-
1318  int16_t setModulationParamsLoRa(uint8_t sf, uint8_t bw, uint8_t cr, uint8_t ldro);
-
1319  int16_t setModulationParamsGFSK(uint32_t br, uint8_t sh, uint8_t rxBw, uint32_t freqDev);
-
1320  int16_t setModulationParamsLrFhss(uint32_t br, uint8_t sh);
-
1321  int16_t setModulationParamsSigfox(uint32_t br, uint8_t sh);
-
1322  int16_t setPacketParamsLoRa(uint16_t preambleLen, uint8_t hdrType, uint8_t payloadLen, uint8_t crcType, uint8_t invertIQ);
-
1323  int16_t setPacketParamsGFSK(uint16_t preambleLen, uint8_t preambleDetectorLen, uint8_t syncWordLen, uint8_t addrCmp, uint8_t packType, uint8_t payloadLen, uint8_t crcType, uint8_t whiten);
-
1324  int16_t setPacketParamsSigfox(uint8_t payloadLen, uint16_t rampUpDelay, uint16_t rampDownDelay, uint16_t bitNum);
-
1325  int16_t setTxParams(int8_t pwr, uint8_t ramp);
-
1326  int16_t setPacketAdrs(uint8_t node, uint8_t broadcast);
-
1327  int16_t setRxTxFallbackMode(uint8_t mode);
-
1328  int16_t setRxDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint8_t mode);
-
1329  int16_t setPaConfig(uint8_t paSel, uint8_t regPaSupply, uint8_t paDutyCycle, uint8_t paHpSel);
-
1330  int16_t stopTimeoutOnPreamble(bool stop);
-
1331  int16_t setCad(void);
-
1332  int16_t setTxCw(void);
-
1333  int16_t setTxInfinitePreamble(void);
-
1334  int16_t setLoRaSynchTimeout(uint8_t symbolNum);
-
1335  int16_t setRangingAddr(uint32_t addr, uint8_t checkLen);
-
1336  int16_t setRangingReqAddr(uint32_t addr);
-
1337  int16_t getRangingResult(uint8_t type, float* res);
-
1338  int16_t setRangingTxRxDelay(uint32_t delay);
-
1339  int16_t setGfskCrcParams(uint32_t init, uint32_t poly);
-
1340  int16_t setGfskWhitParams(uint16_t seed);
-
1341  int16_t setRxBoosted(bool en);
-
1342  int16_t setRangingParameter(uint8_t symbolNum);
-
1343  int16_t setLoRaSyncWord(uint8_t sync);
-
1344  int16_t lrFhssBuildFrame(uint8_t hdrCount, uint8_t cr, uint8_t grid, bool hop, uint8_t bw, uint16_t hopSeq, int8_t devOffset, uint8_t* payload, size_t len);
-
1345  int16_t lrFhssSetSyncWord(uint32_t sync);
-
1346  int16_t configBleBeacon(uint8_t chan, uint8_t* payload, size_t len);
-
1347  int16_t getLoRaRxHeaderInfos(uint8_t* info);
-
1348  int16_t bleBeaconSend(uint8_t chan, uint8_t* payload, size_t len);
-
1349 
-
1350  int16_t wifiScan(uint8_t type, uint16_t mask, uint8_t acqMode, uint8_t nbMaxRes, uint8_t nbScanPerChan, uint16_t timeout, uint8_t abortOnTimeout);
-
1351  int16_t wifiScanTimeLimit(uint8_t type, uint16_t mask, uint8_t acqMode, uint8_t nbMaxRes, uint16_t timePerChan, uint16_t timeout);
-
1352  int16_t wifiCountryCode(uint16_t mask, uint8_t nbMaxRes, uint8_t nbScanPerChan, uint16_t timeout, uint8_t abortOnTimeout);
-
1353  int16_t wifiCountryCodeTimeLimit(uint16_t mask, uint8_t nbMaxRes, uint16_t timePerChan, uint16_t timeout);
-
1354  int16_t wifiGetNbResults(uint8_t* nbResults);
-
1355  int16_t wifiReadResults(uint8_t index, uint8_t nbResults, uint8_t format, uint8_t* results);
-
1356  int16_t wifiResetCumulTimings(void);
-
1357  int16_t wifiReadCumulTimings(uint32_t* detection, uint32_t* capture, uint32_t* demodulation);
-
1358  int16_t wifiGetNbCountryCodeResults(uint8_t* nbResults);
-
1359  int16_t wifiReadCountryCodeResults(uint8_t index, uint8_t nbResults, uint8_t* results);
-
1360  int16_t wifiCfgTimestampAPphone(uint32_t timestamp);
-
1361  int16_t wifiReadVersion(uint8_t* major, uint8_t* minor);
-
1362 
-
1363  int16_t gnssSetConstellationToUse(uint8_t mask);
-
1364  int16_t gnssReadConstellationToUse(uint8_t* mask);
-
1365  int16_t gnssSetAlmanacUpdate(uint8_t mask);
-
1366  int16_t gnssReadAlmanacUpdate(uint8_t* mask);
-
1367  int16_t gnssReadVersion(uint8_t* fw, uint8_t* almanac);
-
1368  int16_t gnssReadSupportedConstellations(uint8_t* mask);
-
1369  int16_t gnssSetMode(uint8_t mode);
-
1370  int16_t gnssAutonomous(uint32_t gpsTime, uint8_t resMask, uint8_t nbSvMask);
-
1371  int16_t gnssAssisted(uint32_t gpsTime, uint8_t effort, uint8_t resMask, uint8_t nbSvMask);
-
1372  int16_t gnssSetAssistancePosition(float lat, float lon);
-
1373  int16_t gnssReadAssistancePosition(float* lat, float* lon);
-
1374  int16_t gnssPushSolverMsg(uint8_t* payload, size_t len);
-
1375  int16_t gnssPushDmMsg(uint8_t* payload, size_t len);
-
1376  int16_t gnssGetContextStatus(uint8_t* fwVersion, uint32_t* almanacCrc, uint8_t* errCode, uint8_t* almUpdMask, uint8_t* freqSpace);
-
1377  int16_t gnssGetNbSvDetected(uint8_t* nbSv);
-
1378  int16_t gnssGetSvDetected(uint8_t* svId, uint8_t* snr, uint16_t* doppler, size_t nbSv);
-
1379  int16_t gnssGetConsumption(uint32_t* cpu, uint32_t* radio);
-
1380  int16_t gnssGetResultSize(uint16_t* size);
-
1381  int16_t gnssReadResults(uint8_t* result, uint16_t size);
-
1382  int16_t gnssAlmanacFullUpdateHeader(uint16_t date, uint32_t globalCrc);
-
1383  int16_t gnssAlmanacFullUpdateSV(uint8_t svn, uint8_t* svnAlmanac);
-
1384  int16_t gnssGetSvVisible(uint32_t time, float lat, float lon, uint8_t constellation, uint8_t* nbSv);
-
1385 
-
1386  int16_t cryptoSetKey(uint8_t keyId, uint8_t* key);
-
1387  int16_t cryptoDeriveKey(uint8_t srcKeyId, uint8_t dstKeyId, uint8_t* key);
-
1388  int16_t cryptoProcessJoinAccept(uint8_t decKeyId, uint8_t verKeyId, uint8_t lwVer, uint8_t* header, uint8_t* dataIn, size_t len, uint8_t* dataOut);
-
1389  int16_t cryptoComputeAesCmac(uint8_t keyId, uint8_t* data, size_t len, uint32_t* mic);
-
1390  int16_t cryptoVerifyAesCmac(uint8_t keyId, uint32_t micExp, uint8_t* data, size_t len, bool* result);
-
1391  int16_t cryptoAesEncrypt01(uint8_t keyId, uint8_t* dataIn, size_t len, uint8_t* dataOut);
-
1392  int16_t cryptoAesEncrypt(uint8_t keyId, uint8_t* dataIn, size_t len, uint8_t* dataOut);
-
1393  int16_t cryptoAesDecrypt(uint8_t keyId, uint8_t* dataIn, size_t len, uint8_t* dataOut);
-
1394  int16_t cryptoStoreToFlash(void);
-
1395  int16_t cryptoRestoreFromFlash(void);
-
1396  int16_t cryptoSetParam(uint8_t id, uint32_t value);
-
1397  int16_t cryptoGetParam(uint8_t id, uint32_t* value);
-
1398  int16_t cryptoCheckEncryptedFirmwareImage(uint32_t offset, uint32_t* data, size_t len);
-
1399  int16_t cryptoCheckEncryptedFirmwareImageResult(bool* result);
-
1400 
-
1401  int16_t bootEraseFlash(void);
-
1402  int16_t bootWriteFlashEncrypted(uint32_t offset, uint32_t* data, size_t len);
-
1403  int16_t bootReboot(bool stay);
-
1404  int16_t bootGetPin(uint8_t* pin);
-
1405  int16_t bootGetChipEui(uint8_t* eui);
-
1406  int16_t bootGetJoinEui(uint8_t* eui);
-
1407 
-
1408  int16_t SPIcommand(uint16_t cmd, bool write, uint8_t* data, size_t len, uint8_t* out = NULL, size_t outLen = 0);
-
1409 
-
1410 #if !RADIOLIB_GODMODE
-
1411  protected:
-
1412 #endif
-
1413  uint8_t chipType = 0;
-
1414 
-
1415 #if !RADIOLIB_GODMODE
-
1416  private:
-
1417 #endif
-
1418  Module* mod;
-
1419 
-
1420  // cached LoRa parameters
-
1421  uint8_t bandwidth = 0, spreadingFactor = 0, codingRate = 0, ldrOptimize = 0, crcTypeLoRa = 0, headerType = 0;
-
1422  uint16_t preambleLengthLoRa = 0;
-
1423  float bandwidthKhz = 0;
-
1424  bool ldroAuto = true;
-
1425  size_t implicitLen = 0;
-
1426  bool invertIQEnabled = false;
-
1427 
-
1428  // cached GFSK parameters
-
1429  uint32_t bitRate = 0, frequencyDev = 0;
-
1430  uint8_t preambleDetLength = 0, rxBandwidth = 0, pulseShape = 0, crcTypeGFSK = 0, syncWordLength = 0, addrComp = 0, whitening = 0, packetType = 0, node = 0;
-
1431  uint16_t preambleLengthGFSK = 0;
-
1432 
-
1433  // cached LR-FHSS parameters
-
1434  uint8_t lrFhssCr = 0, lrFhssBw = 0, lrFhssHdrCount = 0;
-
1435  uint16_t lrFhssHopSeq = 0;
-
1436 
-
1437  float dataRateMeasured = 0;
-
1438 
-
1439  uint8_t wifiScanMode = 0;
-
1440 
-
1441  int16_t modSetup(float tcxoVoltage, uint8_t modem);
-
1442  static int16_t SPIparseStatus(uint8_t in);
-
1443  static int16_t SPIcheckStatus(Module* mod);
-
1444  bool findChip(uint8_t ver);
-
1445  int16_t config(uint8_t modem);
-
1446  int16_t setPacketMode(uint8_t mode, uint8_t len);
-
1447  int16_t startCad(uint8_t symbolNum, uint8_t detPeak, uint8_t detMin);
-
1448  int16_t setHeaderType(uint8_t hdrType, size_t len = 0xFF);
-
1449 
-
1450  // common methods to avoid some copy-paste
-
1451  int16_t bleBeaconCommon(uint16_t cmd, uint8_t chan, uint8_t* payload, size_t len);
-
1452  int16_t writeCommon(uint16_t cmd, uint32_t addrOffset, const uint32_t* data, size_t len);
-
1453  int16_t cryptoCommon(uint16_t cmd, uint8_t keyId, uint8_t* dataIn, size_t len, uint8_t* dataOut);
-
1454 };
-
1455 
-
1456 #endif
-
1457 
-
1458 #endif
+
778  int16_t sleep();
+
779 
+
780  int16_t sleep(bool retainConfig, uint32_t sleepTime);
+
781 
+
782  // interrupt methods
+
783 
+
788  void setIrqAction(void (*func)(void));
+
789 
+
793  void clearIrqAction();
+
794 
+
799  void setPacketReceivedAction(void (*func)(void)) override;
+
800 
+
804  void clearPacketReceivedAction() override;
+
805 
+
810  void setPacketSentAction(void (*func)(void)) override;
+
811 
+
815  void clearPacketSentAction() override;
+
816 
+
825  int16_t startTransmit(uint8_t* data, size_t len, uint8_t addr = 0) override;
+
826 
+
831  int16_t finishTransmit() override;
+
832 
+
839  int16_t startReceive() override;
+
840 
+
853  int16_t startReceive(uint32_t timeout, uint32_t irqFlags = RADIOLIB_LR11X0_IRQ_RX_DONE, uint32_t irqMask = 0, size_t len = 0);
+
854 
+
859  uint32_t getIrqStatus();
+
860 
+
869  int16_t readData(uint8_t* data, size_t len) override;
+
870 
+
876  int16_t startChannelScan() override;
+
877 
+
886  int16_t startChannelScan(uint8_t symbolNum, uint8_t detPeak, uint8_t detMin);
+
887 
+
892  int16_t getChannelScanResult() override;
+
893 
+
894  // configuration methods
+
895 
+
901  int16_t setOutputPower(int8_t power) override;
+
902 
+
910  int16_t setOutputPower(int8_t power, bool forceHighPower);
+
911 
+
919  int16_t checkOutputPower(int8_t power, int8_t* clipped) override;
+
920 
+
929  int16_t checkOutputPower(int8_t power, int8_t* clipped, bool forceHighPower);
+
930 
+
936  int16_t setBandwidth(float bw);
+
937 
+
944  int16_t setSpreadingFactor(uint8_t sf, bool legacy = false);
+
945 
+
953  int16_t setCodingRate(uint8_t cr, bool longInterleave = false);
+
954 
+
960  int16_t setSyncWord(uint32_t syncWord);
+
961 
+
967  int16_t setBitRate(float br) override;
+
968 
+
974  int16_t setFrequencyDeviation(float freqDev) override;
+
975 
+
982  int16_t setRxBandwidth(float rxBw);
+
983 
+
990  int16_t setSyncWord(uint8_t* syncWord, size_t len) override;
+
991 
+
999  int16_t setSyncBits(uint8_t *syncWord, uint8_t bitsLen);
+
1000 
+
1006  int16_t setNodeAddress(uint8_t nodeAddr);
+
1007 
+
1014  int16_t setBroadcastAddress(uint8_t broadAddr);
+
1015 
+
1020  int16_t disableAddressFiltering();
+
1021 
+
1029  int16_t setDataShaping(uint8_t sh) override;
+
1030 
+
1036  int16_t setEncoding(uint8_t encoding) override;
+
1037 
+
1043  int16_t fixedPacketLengthMode(uint8_t len = RADIOLIB_LR11X0_MAX_PACKET_LENGTH);
+
1044 
+
1050  int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_LR11X0_MAX_PACKET_LENGTH);
+
1051 
+
1059  int16_t setWhitening(bool enabled, uint16_t initial = 0x01FF);
+
1060 
+
1066  int16_t setDataRate(DataRate_t dr) override;
+
1067 
+
1073  int16_t checkDataRate(DataRate_t dr) override;
+
1074 
+
1080  int16_t setPreambleLength(size_t preambleLength) override;
+
1081 
+
1090  int16_t setTCXO(float voltage, uint32_t delay = 5000);
+
1091 
+
1100  int16_t setCRC(uint8_t len, uint32_t initial = 0x00001D0FUL, uint32_t polynomial = 0x00001021UL, bool inverted = true);
+
1101 
+
1107  int16_t invertIQ(bool enable) override;
+
1108 
+
1113  float getRSSI() override;
+
1114 
+
1119  float getSNR() override;
+
1120 
+
1125  float getFrequencyError();
+
1126 
+
1132  size_t getPacketLength(bool update = true) override;
+
1133 
+
1139  size_t getPacketLength(bool update, uint8_t* offset);
+
1140 
+
1146  RadioLibTime_t getTimeOnAir(size_t len) override;
+
1147 
+
1153  RadioLibTime_t calculateRxTimeout(RadioLibTime_t timeoutUs) override;
+
1154 
+
1161  int16_t irqRxDoneRxTimeout(uint32_t &irqFlags, uint32_t &irqMask) override;
+
1162 
+
1167  bool isRxTimeout() override;
+
1168 
+
1173  uint8_t randomByte() override;
+
1174 
+
1180  int16_t implicitHeader(size_t len);
+
1181 
+
1186  int16_t explicitHeader();
+
1187 
+
1192  float getDataRate() const;
+
1193 
+
1202  int16_t setLrFhssConfig(uint8_t bw, uint8_t cr, uint8_t hdrCount = 3, uint16_t hopSeed = 0x13A);
+
1203 
+
1218  int16_t startWifiScan(char wifiType, uint8_t mode = RADIOLIB_LR11X0_WIFI_ACQ_MODE_FULL_BEACON, uint16_t chanMask = RADIOLIB_LR11X0_WIFI_ALL_CHANNELS, uint8_t numScans = 16, uint16_t timeout = 100);
+
1219 
+
1224  void setWiFiScanAction(void (*func)(void));
+
1225 
+
1229  void clearWiFiScanAction();
+
1230 
+
1236  int16_t getWifiScanResultsCount(uint8_t* count);
+
1237 
+
1247  int16_t getWifiScanResult(LR11x0WifiResult_t* result, uint8_t index, bool brief = false);
+
1248 
+
1265  int16_t wifiScan(uint8_t wifiType, uint8_t* count, uint8_t mode = RADIOLIB_LR11X0_WIFI_ACQ_MODE_FULL_BEACON, uint16_t chanMask = RADIOLIB_LR11X0_WIFI_ALL_CHANNELS, uint8_t numScans = 16, uint16_t timeout = 100);
+
1266 
+
1267 #if !RADIOLIB_GODMODE && !RADIOLIB_LOW_LEVEL
+
1268  protected:
+
1269 #endif
+
1270  Module* getMod() override;
+
1271 
+
1272  // LR11x0 SPI command implementations
+
1273  int16_t writeRegMem32(uint32_t addr, uint32_t* data, size_t len);
+
1274  int16_t readRegMem32(uint32_t addr, uint32_t* data, size_t len);
+
1275  int16_t writeBuffer8(uint8_t* data, size_t len);
+
1276  int16_t readBuffer8(uint8_t* data, size_t len, size_t offset);
+
1277  int16_t clearRxBuffer(void);
+
1278  int16_t writeRegMemMask32(uint32_t addr, uint32_t mask, uint32_t data);
+
1279 
+
1280  int16_t getStatus(uint8_t* stat1, uint8_t* stat2, uint32_t* irq);
+
1281  int16_t getVersion(uint8_t* hw, uint8_t* device, uint8_t* major, uint8_t* minor);
+
1282  int16_t getErrors(uint16_t* err);
+
1283  int16_t clearErrors(void);
+
1284  int16_t calibrate(uint8_t params);
+
1285  int16_t setRegMode(uint8_t mode);
+
1286  int16_t calibImage(float freq1, float freq2);
+
1287  int16_t setDioAsRfSwitch(uint8_t en, uint8_t stbyCfg, uint8_t rxCfg, uint8_t txCfg, uint8_t txHpCfg, uint8_t txHfCfg, uint8_t gnssCfg, uint8_t wifiCfg);
+
1288  int16_t setDioIrqParams(uint32_t irq1, uint32_t irq2);
+
1289  int16_t clearIrq(uint32_t irq);
+
1290  int16_t configLfClock(uint8_t setup);
+
1291  int16_t setTcxoMode(uint8_t tune, uint32_t delay);
+
1292  int16_t reboot(bool stay);
+
1293  int16_t getVbat(float* vbat);
+
1294  int16_t getTemp(float* temp);
+
1295  int16_t setFs(void);
+
1296  int16_t getRandomNumber(uint32_t* rnd);
+
1297  int16_t eraseInfoPage(void);
+
1298  int16_t writeInfoPage(uint16_t addr, const uint32_t* data, size_t len);
+
1299  int16_t readInfoPage(uint16_t addr, uint32_t* data, size_t len);
+
1300  int16_t getChipEui(uint8_t* eui);
+
1301  int16_t getSemtechJoinEui(uint8_t* eui);
+
1302  int16_t deriveRootKeysAndGetPin(uint8_t* pin);
+
1303  int16_t enableSpiCrc(bool en);
+
1304  int16_t driveDiosInSleepMode(bool en);
+
1305 
+
1306  int16_t resetStats(void);
+
1307  int16_t getStats(uint16_t* nbPktReceived, uint16_t* nbPktCrcError, uint16_t* data1, uint16_t* data2);
+
1308  int16_t getPacketType(uint8_t* type);
+
1309  int16_t getRxBufferStatus(uint8_t* len, uint8_t* startOffset);
+
1310  int16_t getPacketStatusLoRa(float* rssiPkt, float* snrPkt, float* signalRssiPkt);
+
1311  int16_t getPacketStatusGFSK(float* rssiSync, float* rssiAvg, uint8_t* rxLen, uint8_t* stat);
+
1312  int16_t getRssiInst(float* rssi);
+
1313  int16_t setGfskSyncWord(uint8_t* sync);
+
1314  int16_t setLoRaPublicNetwork(bool pub);
+
1315  int16_t setRx(uint32_t timeout);
+
1316  int16_t setTx(uint32_t timeout);
+
1317  int16_t setRfFrequency(uint32_t rfFreq);
+
1318  int16_t autoTxRx(uint32_t delay, uint8_t intMode, uint32_t timeout);
+
1319  int16_t setCadParams(uint8_t symNum, uint8_t detPeak, uint8_t detMin, uint8_t cadExitMode, uint32_t timeout);
+
1320  int16_t setPacketType(uint8_t type);
+
1321  int16_t setModulationParamsLoRa(uint8_t sf, uint8_t bw, uint8_t cr, uint8_t ldro);
+
1322  int16_t setModulationParamsGFSK(uint32_t br, uint8_t sh, uint8_t rxBw, uint32_t freqDev);
+
1323  int16_t setModulationParamsLrFhss(uint32_t br, uint8_t sh);
+
1324  int16_t setModulationParamsSigfox(uint32_t br, uint8_t sh);
+
1325  int16_t setPacketParamsLoRa(uint16_t preambleLen, uint8_t hdrType, uint8_t payloadLen, uint8_t crcType, uint8_t invertIQ);
+
1326  int16_t setPacketParamsGFSK(uint16_t preambleLen, uint8_t preambleDetectorLen, uint8_t syncWordLen, uint8_t addrCmp, uint8_t packType, uint8_t payloadLen, uint8_t crcType, uint8_t whiten);
+
1327  int16_t setPacketParamsSigfox(uint8_t payloadLen, uint16_t rampUpDelay, uint16_t rampDownDelay, uint16_t bitNum);
+
1328  int16_t setTxParams(int8_t pwr, uint8_t ramp);
+
1329  int16_t setPacketAdrs(uint8_t node, uint8_t broadcast);
+
1330  int16_t setRxTxFallbackMode(uint8_t mode);
+
1331  int16_t setRxDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint8_t mode);
+
1332  int16_t setPaConfig(uint8_t paSel, uint8_t regPaSupply, uint8_t paDutyCycle, uint8_t paHpSel);
+
1333  int16_t stopTimeoutOnPreamble(bool stop);
+
1334  int16_t setCad(void);
+
1335  int16_t setTxCw(void);
+
1336  int16_t setTxInfinitePreamble(void);
+
1337  int16_t setLoRaSynchTimeout(uint8_t symbolNum);
+
1338  int16_t setRangingAddr(uint32_t addr, uint8_t checkLen);
+
1339  int16_t setRangingReqAddr(uint32_t addr);
+
1340  int16_t getRangingResult(uint8_t type, float* res);
+
1341  int16_t setRangingTxRxDelay(uint32_t delay);
+
1342  int16_t setGfskCrcParams(uint32_t init, uint32_t poly);
+
1343  int16_t setGfskWhitParams(uint16_t seed);
+
1344  int16_t setRxBoosted(bool en);
+
1345  int16_t setRangingParameter(uint8_t symbolNum);
+
1346  int16_t setLoRaSyncWord(uint8_t sync);
+
1347  int16_t lrFhssBuildFrame(uint8_t hdrCount, uint8_t cr, uint8_t grid, bool hop, uint8_t bw, uint16_t hopSeq, int8_t devOffset, uint8_t* payload, size_t len);
+
1348  int16_t lrFhssSetSyncWord(uint32_t sync);
+
1349  int16_t configBleBeacon(uint8_t chan, uint8_t* payload, size_t len);
+
1350  int16_t getLoRaRxHeaderInfos(uint8_t* info);
+
1351  int16_t bleBeaconSend(uint8_t chan, uint8_t* payload, size_t len);
+
1352 
+
1353  int16_t wifiScan(uint8_t type, uint16_t mask, uint8_t acqMode, uint8_t nbMaxRes, uint8_t nbScanPerChan, uint16_t timeout, uint8_t abortOnTimeout);
+
1354  int16_t wifiScanTimeLimit(uint8_t type, uint16_t mask, uint8_t acqMode, uint8_t nbMaxRes, uint16_t timePerChan, uint16_t timeout);
+
1355  int16_t wifiCountryCode(uint16_t mask, uint8_t nbMaxRes, uint8_t nbScanPerChan, uint16_t timeout, uint8_t abortOnTimeout);
+
1356  int16_t wifiCountryCodeTimeLimit(uint16_t mask, uint8_t nbMaxRes, uint16_t timePerChan, uint16_t timeout);
+
1357  int16_t wifiGetNbResults(uint8_t* nbResults);
+
1358  int16_t wifiReadResults(uint8_t index, uint8_t nbResults, uint8_t format, uint8_t* results);
+
1359  int16_t wifiResetCumulTimings(void);
+
1360  int16_t wifiReadCumulTimings(uint32_t* detection, uint32_t* capture, uint32_t* demodulation);
+
1361  int16_t wifiGetNbCountryCodeResults(uint8_t* nbResults);
+
1362  int16_t wifiReadCountryCodeResults(uint8_t index, uint8_t nbResults, uint8_t* results);
+
1363  int16_t wifiCfgTimestampAPphone(uint32_t timestamp);
+
1364  int16_t wifiReadVersion(uint8_t* major, uint8_t* minor);
+
1365 
+
1366  int16_t gnssSetConstellationToUse(uint8_t mask);
+
1367  int16_t gnssReadConstellationToUse(uint8_t* mask);
+
1368  int16_t gnssSetAlmanacUpdate(uint8_t mask);
+
1369  int16_t gnssReadAlmanacUpdate(uint8_t* mask);
+
1370  int16_t gnssReadVersion(uint8_t* fw, uint8_t* almanac);
+
1371  int16_t gnssReadSupportedConstellations(uint8_t* mask);
+
1372  int16_t gnssSetMode(uint8_t mode);
+
1373  int16_t gnssAutonomous(uint32_t gpsTime, uint8_t resMask, uint8_t nbSvMask);
+
1374  int16_t gnssAssisted(uint32_t gpsTime, uint8_t effort, uint8_t resMask, uint8_t nbSvMask);
+
1375  int16_t gnssSetAssistancePosition(float lat, float lon);
+
1376  int16_t gnssReadAssistancePosition(float* lat, float* lon);
+
1377  int16_t gnssPushSolverMsg(uint8_t* payload, size_t len);
+
1378  int16_t gnssPushDmMsg(uint8_t* payload, size_t len);
+
1379  int16_t gnssGetContextStatus(uint8_t* fwVersion, uint32_t* almanacCrc, uint8_t* errCode, uint8_t* almUpdMask, uint8_t* freqSpace);
+
1380  int16_t gnssGetNbSvDetected(uint8_t* nbSv);
+
1381  int16_t gnssGetSvDetected(uint8_t* svId, uint8_t* snr, uint16_t* doppler, size_t nbSv);
+
1382  int16_t gnssGetConsumption(uint32_t* cpu, uint32_t* radio);
+
1383  int16_t gnssGetResultSize(uint16_t* size);
+
1384  int16_t gnssReadResults(uint8_t* result, uint16_t size);
+
1385  int16_t gnssAlmanacFullUpdateHeader(uint16_t date, uint32_t globalCrc);
+
1386  int16_t gnssAlmanacFullUpdateSV(uint8_t svn, uint8_t* svnAlmanac);
+
1387  int16_t gnssGetSvVisible(uint32_t time, float lat, float lon, uint8_t constellation, uint8_t* nbSv);
+
1388 
+
1389  int16_t cryptoSetKey(uint8_t keyId, uint8_t* key);
+
1390  int16_t cryptoDeriveKey(uint8_t srcKeyId, uint8_t dstKeyId, uint8_t* key);
+
1391  int16_t cryptoProcessJoinAccept(uint8_t decKeyId, uint8_t verKeyId, uint8_t lwVer, uint8_t* header, uint8_t* dataIn, size_t len, uint8_t* dataOut);
+
1392  int16_t cryptoComputeAesCmac(uint8_t keyId, uint8_t* data, size_t len, uint32_t* mic);
+
1393  int16_t cryptoVerifyAesCmac(uint8_t keyId, uint32_t micExp, uint8_t* data, size_t len, bool* result);
+
1394  int16_t cryptoAesEncrypt01(uint8_t keyId, uint8_t* dataIn, size_t len, uint8_t* dataOut);
+
1395  int16_t cryptoAesEncrypt(uint8_t keyId, uint8_t* dataIn, size_t len, uint8_t* dataOut);
+
1396  int16_t cryptoAesDecrypt(uint8_t keyId, uint8_t* dataIn, size_t len, uint8_t* dataOut);
+
1397  int16_t cryptoStoreToFlash(void);
+
1398  int16_t cryptoRestoreFromFlash(void);
+
1399  int16_t cryptoSetParam(uint8_t id, uint32_t value);
+
1400  int16_t cryptoGetParam(uint8_t id, uint32_t* value);
+
1401  int16_t cryptoCheckEncryptedFirmwareImage(uint32_t offset, uint32_t* data, size_t len);
+
1402  int16_t cryptoCheckEncryptedFirmwareImageResult(bool* result);
+
1403 
+
1404  int16_t bootEraseFlash(void);
+
1405  int16_t bootWriteFlashEncrypted(uint32_t offset, uint32_t* data, size_t len);
+
1406  int16_t bootReboot(bool stay);
+
1407  int16_t bootGetPin(uint8_t* pin);
+
1408  int16_t bootGetChipEui(uint8_t* eui);
+
1409  int16_t bootGetJoinEui(uint8_t* eui);
+
1410 
+
1411  int16_t SPIcommand(uint16_t cmd, bool write, uint8_t* data, size_t len, uint8_t* out = NULL, size_t outLen = 0);
+
1412 
+
1413 #if !RADIOLIB_GODMODE
+
1414  protected:
+
1415 #endif
+
1416  uint8_t chipType = 0;
+
1417 
+
1418 #if !RADIOLIB_GODMODE
+
1419  private:
+
1420 #endif
+
1421  Module* mod;
+
1422 
+
1423  // cached LoRa parameters
+
1424  uint8_t bandwidth = 0, spreadingFactor = 0, codingRate = 0, ldrOptimize = 0, crcTypeLoRa = 0, headerType = 0;
+
1425  uint16_t preambleLengthLoRa = 0;
+
1426  float bandwidthKhz = 0;
+
1427  bool ldroAuto = true;
+
1428  size_t implicitLen = 0;
+
1429  bool invertIQEnabled = false;
+
1430 
+
1431  // cached GFSK parameters
+
1432  uint32_t bitRate = 0, frequencyDev = 0;
+
1433  uint8_t preambleDetLength = 0, rxBandwidth = 0, pulseShape = 0, crcTypeGFSK = 0, syncWordLength = 0, addrComp = 0, whitening = 0, packetType = 0, node = 0;
+
1434  uint16_t preambleLengthGFSK = 0;
+
1435 
+
1436  // cached LR-FHSS parameters
+
1437  uint8_t lrFhssCr = 0, lrFhssBw = 0, lrFhssHdrCount = 0;
+
1438  uint16_t lrFhssHopSeq = 0;
+
1439 
+
1440  float dataRateMeasured = 0;
+
1441 
+
1442  uint8_t wifiScanMode = 0;
+
1443 
+
1444  int16_t modSetup(float tcxoVoltage, uint8_t modem);
+
1445  static int16_t SPIparseStatus(uint8_t in);
+
1446  static int16_t SPIcheckStatus(Module* mod);
+
1447  bool findChip(uint8_t ver);
+
1448  int16_t config(uint8_t modem);
+
1449  int16_t setPacketMode(uint8_t mode, uint8_t len);
+
1450  int16_t startCad(uint8_t symbolNum, uint8_t detPeak, uint8_t detMin);
+
1451  int16_t setHeaderType(uint8_t hdrType, size_t len = 0xFF);
+
1452 
+
1453  // common methods to avoid some copy-paste
+
1454  int16_t bleBeaconCommon(uint16_t cmd, uint8_t chan, uint8_t* payload, size_t len);
+
1455  int16_t writeCommon(uint16_t cmd, uint32_t addrOffset, const uint32_t* data, size_t len);
+
1456  int16_t cryptoCommon(uint16_t cmd, uint8_t keyId, uint8_t* dataIn, size_t len, uint8_t* dataOut);
+
1457 };
+
1458 
+
1459 #endif
+
1460 
+
1461 #endif
LR11x0
Base class for LR11x0 series. All derived classes for LR11x0 (e.g. LR1110 or LR1120) inherit from thi...
Definition: LR11x0.h:647
-
LR11x0::getSNR
float getSNR() override
Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem.
Definition: LR11x0.cpp:1220
-
LR11x0::getIrqStatus
uint32_t getIrqStatus()
Reads the current IRQ status.
Definition: LR11x0.cpp:484
-
LR11x0::setDataRate
int16_t setDataRate(DataRate_t dr) override
Set data.
Definition: LR11x0.cpp:1022
-
LR11x0::getChannelScanResult
int16_t getChannelScanResult() override
Read the channel scan result.
Definition: LR11x0.cpp:572
-
LR11x0::getDataRate
float getDataRate() const
Gets effective data rate for the last transmitted packet. The value is calculated only for payload by...
Definition: LR11x0.cpp:1358
-
LR11x0::setRxBandwidth
int16_t setRxBandwidth(float rxBw)
Sets GFSK receiver bandwidth. Allowed values are 4.8, 5.8, 7.3, 9.7, 11.7, 14.6, 19....
Definition: LR11x0.cpp:782
-
LR11x0::calculateRxTimeout
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: LR11x0.cpp:1325
+
LR11x0::getSNR
float getSNR() override
Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem.
Definition: LR11x0.cpp:1224
+
LR11x0::getIrqStatus
uint32_t getIrqStatus()
Reads the current IRQ status.
Definition: LR11x0.cpp:488
+
LR11x0::setDataRate
int16_t setDataRate(DataRate_t dr) override
Set data.
Definition: LR11x0.cpp:1026
+
LR11x0::getChannelScanResult
int16_t getChannelScanResult() override
Read the channel scan result.
Definition: LR11x0.cpp:576
+
LR11x0::getDataRate
float getDataRate() const
Gets effective data rate for the last transmitted packet. The value is calculated only for payload by...
Definition: LR11x0.cpp:1362
+
LR11x0::setRxBandwidth
int16_t setRxBandwidth(float rxBw)
Sets GFSK receiver bandwidth. Allowed values are 4.8, 5.8, 7.3, 9.7, 11.7, 14.6, 19....
Definition: LR11x0.cpp:786
+
LR11x0::calculateRxTimeout
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: LR11x0.cpp:1329
LR11x0::reset
int16_t reset()
Reset method. Will reset the chip to the default state using RST pin.
Definition: LR11x0.cpp:110
-
LR11x0::startWifiScan
int16_t startWifiScan(char wifiType, uint8_t mode=RADIOLIB_LR11X0_WIFI_ACQ_MODE_FULL_BEACON, uint16_t chanMask=RADIOLIB_LR11X0_WIFI_ALL_CHANNELS, uint8_t numScans=16, uint16_t timeout=100)
Start passive WiFi scan. BUSY pin will be de-activated when the scan is finished.
Definition: LR11x0.cpp:1383
+
LR11x0::startWifiScan
int16_t startWifiScan(char wifiType, uint8_t mode=RADIOLIB_LR11X0_WIFI_ACQ_MODE_FULL_BEACON, uint16_t chanMask=RADIOLIB_LR11X0_WIFI_ALL_CHANNELS, uint8_t numScans=16, uint16_t timeout=100)
Start passive WiFi scan. BUSY pin will be de-activated when the scan is finished.
Definition: LR11x0.cpp:1387
LR11x0::readData
virtual int16_t readData(uint8_t *data, size_t len)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:209
-
LR11x0::explicitHeader
int16_t explicitHeader()
Set explicit header mode for future reception/transmission.
Definition: LR11x0.cpp:1354
+
LR11x0::explicitHeader
int16_t explicitHeader()
Set explicit header mode for future reception/transmission.
Definition: LR11x0.cpp:1358
LR11x0::XTAL
bool XTAL
Whether the module has an XTAL (true) or TCXO (false). Defaults to false.
Definition: LR11x0.h:664
LR11x0::beginLRFHSS
int16_t beginLRFHSS(uint8_t bw, uint8_t cr, int8_t power, float tcxoVoltage)
Initialization method for LR-FHSS modem.
Definition: LR11x0.cpp:91
LR11x0::begin
int16_t begin(float bw, uint8_t sf, uint8_t cr, uint8_t syncWord, int8_t power, uint16_t preambleLength, float tcxoVoltage)
Initialization method for LoRa modem.
Definition: LR11x0.cpp:16
-
LR11x0::getWifiScanResult
int16_t getWifiScanResult(LR11x0WifiResult_t *result, uint8_t index, bool brief=false)
Retrieve passive WiFi scan result.
Definition: LR11x0.cpp:1442
-
LR11x0::setIrqAction
void setIrqAction(void(*func)(void))
Sets interrupt service routine to call when IRQ1 activates.
Definition: LR11x0.cpp:338
+
LR11x0::getWifiScanResult
int16_t getWifiScanResult(LR11x0WifiResult_t *result, uint8_t index, bool brief=false)
Retrieve passive WiFi scan result.
Definition: LR11x0.cpp:1446
+
LR11x0::setIrqAction
void setIrqAction(void(*func)(void))
Sets interrupt service routine to call when IRQ1 activates.
Definition: LR11x0.cpp:342
LR11x0::transmit
int16_t transmit(const char *str, uint8_t addr=0)
C-string transmit method.
Definition: PhysicalLayer.cpp:52
-
LR11x0::checkDataRate
int16_t checkDataRate(DataRate_t dr) override
Check the data rate can be configured by this module.
Definition: LR11x0.cpp:1052
-
LR11x0::startChannelScan
int16_t startChannelScan() override
Interrupt-driven channel activity detection method. IRQ1 will be activated when LoRa preamble is dete...
Definition: LR11x0.cpp:539
-
LR11x0::setCRC
int16_t setCRC(uint8_t len, uint32_t initial=0x00001D0FUL, uint32_t polynomial=0x00001021UL, bool inverted=true)
Sets CRC configuration.
Definition: LR11x0.cpp:1146
+
LR11x0::checkDataRate
int16_t checkDataRate(DataRate_t dr) override
Check the data rate can be configured by this module.
Definition: LR11x0.cpp:1056
+
LR11x0::startChannelScan
int16_t startChannelScan() override
Interrupt-driven channel activity detection method. IRQ1 will be activated when LoRa preamble is dete...
Definition: LR11x0.cpp:543
+
LR11x0::setCRC
int16_t setCRC(uint8_t len, uint32_t initial=0x00001D0FUL, uint32_t polynomial=0x00001021UL, bool inverted=true)
Sets CRC configuration.
Definition: LR11x0.cpp:1150
LR11x0::LR11x0
LR11x0(Module *mod)
Default constructor.
Definition: LR11x0.cpp:11
-
LR11x0::setCodingRate
int16_t setCodingRate(uint8_t cr, bool longInterleave=false)
Sets LoRa coding rate denominator. Allowed values range from 5 to 8.
Definition: LR11x0.cpp:696
-
LR11x0::setDataShaping
int16_t setDataShaping(uint8_t sh) override
Sets time-bandwidth product of Gaussian filter applied for shaping. Allowed values are RADIOLIB_SHAPI...
Definition: LR11x0.cpp:951
-
LR11x0::setOutputPower
int16_t setOutputPower(int8_t power) override
Sets output power. Allowed values are in range from -9 to 22 dBm (high-power PA) or -17 to 14 dBm (lo...
Definition: LR11x0.cpp:595
-
LR11x0::fixedPacketLengthMode
int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_LR11X0_MAX_PACKET_LENGTH)
Set modem in fixed packet length mode. Available in GFSK mode only.
Definition: LR11x0.cpp:989
-
LR11x0::getWifiScanResultsCount
int16_t getWifiScanResultsCount(uint8_t *count)
Get number of WiFi scan results after the scan is finished.
Definition: LR11x0.cpp:1428
-
LR11x0::setNodeAddress
int16_t setNodeAddress(uint8_t nodeAddr)
Sets node address. Calling this method will also enable address filtering for node address only.
Definition: LR11x0.cpp:900
-
LR11x0::setSyncBits
int16_t setSyncBits(uint8_t *syncWord, uint8_t bitsLen)
Sets GFSK sync word in the form of array of up to 8 bytes.
Definition: LR11x0.cpp:879
-
LR11x0::checkOutputPower
int16_t checkOutputPower(int8_t power, int8_t *clipped) override
Check if output power is configurable. This method is needed for compatibility with PhysicalLayer::ch...
Definition: LR11x0.cpp:618
+
LR11x0::setCodingRate
int16_t setCodingRate(uint8_t cr, bool longInterleave=false)
Sets LoRa coding rate denominator. Allowed values range from 5 to 8.
Definition: LR11x0.cpp:700
+
LR11x0::setDataShaping
int16_t setDataShaping(uint8_t sh) override
Sets time-bandwidth product of Gaussian filter applied for shaping. Allowed values are RADIOLIB_SHAPI...
Definition: LR11x0.cpp:955
+
LR11x0::setOutputPower
int16_t setOutputPower(int8_t power) override
Sets output power. Allowed values are in range from -9 to 22 dBm (high-power PA) or -17 to 14 dBm (lo...
Definition: LR11x0.cpp:599
+
LR11x0::fixedPacketLengthMode
int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_LR11X0_MAX_PACKET_LENGTH)
Set modem in fixed packet length mode. Available in GFSK mode only.
Definition: LR11x0.cpp:993
+
LR11x0::getWifiScanResultsCount
int16_t getWifiScanResultsCount(uint8_t *count)
Get number of WiFi scan results after the scan is finished.
Definition: LR11x0.cpp:1432
+
LR11x0::setNodeAddress
int16_t setNodeAddress(uint8_t nodeAddr)
Sets node address. Calling this method will also enable address filtering for node address only.
Definition: LR11x0.cpp:904
+
LR11x0::setSyncBits
int16_t setSyncBits(uint8_t *syncWord, uint8_t bitsLen)
Sets GFSK sync word in the form of array of up to 8 bytes.
Definition: LR11x0.cpp:883
+
LR11x0::checkOutputPower
int16_t checkOutputPower(int8_t power, int8_t *clipped) override
Check if output power is configurable. This method is needed for compatibility with PhysicalLayer::ch...
Definition: LR11x0.cpp:622
LR11x0::scanChannel
int16_t scanChannel() override
Performs scan for LoRa transmission in the current channel. Detects both preamble and payload.
Definition: LR11x0.cpp:280
-
LR11x0::getRSSI
float getRSSI() override
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet. Only available for LoRa o...
Definition: LR11x0.cpp:1203
+
LR11x0::getRSSI
float getRSSI() override
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet. Only available for LoRa o...
Definition: LR11x0.cpp:1207
LR11x0::standby
int16_t standby() override
Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator)...
Definition: LR11x0.cpp:298
-
LR11x0::setSyncWord
int16_t setSyncWord(uint32_t syncWord)
Sets LoRa or LR-FHSS sync word.
Definition: LR11x0.cpp:729
-
LR11x0::randomByte
uint8_t randomByte() override
Get one truly random byte from RSSI noise.
Definition: LR11x0.cpp:1344
-
LR11x0::setEncoding
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Available in GFSK mode only. Serves only as alias for PhysicalLayer compa...
Definition: LR11x0.cpp:985
-
LR11x0::setLrFhssConfig
int16_t setLrFhssConfig(uint8_t bw, uint8_t cr, uint8_t hdrCount=3, uint16_t hopSeed=0x13A)
Sets LR-FHSS configuration.
Definition: LR11x0.cpp:1362
-
LR11x0::isRxTimeout
bool isRxTimeout() override
Check whether the IRQ bit for RxTimeout is set.
Definition: LR11x0.cpp:1338
-
LR11x0::setPacketSentAction
void setPacketSentAction(void(*func)(void)) override
Sets interrupt service routine to call when a packet is sent.
Definition: LR11x0.cpp:354
+
LR11x0::setSyncWord
int16_t setSyncWord(uint32_t syncWord)
Sets LoRa or LR-FHSS sync word.
Definition: LR11x0.cpp:733
+
LR11x0::randomByte
uint8_t randomByte() override
Get one truly random byte from RSSI noise.
Definition: LR11x0.cpp:1348
+
LR11x0::setEncoding
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Available in GFSK mode only. Serves only as alias for PhysicalLayer compa...
Definition: LR11x0.cpp:989
+
LR11x0::setLrFhssConfig
int16_t setLrFhssConfig(uint8_t bw, uint8_t cr, uint8_t hdrCount=3, uint16_t hopSeed=0x13A)
Sets LR-FHSS configuration.
Definition: LR11x0.cpp:1366
+
LR11x0::isRxTimeout
bool isRxTimeout() override
Check whether the IRQ bit for RxTimeout is set.
Definition: LR11x0.cpp:1342
+
LR11x0::setPacketSentAction
void setPacketSentAction(void(*func)(void)) override
Sets interrupt service routine to call when a packet is sent.
Definition: LR11x0.cpp:358
LR11x0::startTransmit
int16_t startTransmit(const char *str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:149
-
LR11x0::clearPacketSentAction
void clearPacketSentAction() override
Clears interrupt service routine to call when a packet is sent.
Definition: LR11x0.cpp:358
-
LR11x0::clearPacketReceivedAction
void clearPacketReceivedAction() override
Clears interrupt service routine to call when a packet is received.
Definition: LR11x0.cpp:350
-
LR11x0::setTCXO
int16_t setTCXO(float voltage, uint32_t delay=5000)
Sets TCXO (Temperature Compensated Crystal Oscillator) configuration.
Definition: LR11x0.cpp:1091
-
LR11x0::setPreambleLength
int16_t setPreambleLength(size_t preambleLength) override
Sets preamble length for LoRa or GFSK modem. Allowed values range from 1 to 65535.
Definition: LR11x0.cpp:1074
-
LR11x0::startReceive
int16_t startReceive() override
Interrupt-driven receive method with default parameters. Implemented for compatibility with PhysicalL...
Definition: LR11x0.cpp:437
-
LR11x0::finishTransmit
int16_t finishTransmit() override
Clean up after transmission is done.
Definition: LR11x0.cpp:429
-
LR11x0::clearIrqAction
void clearIrqAction()
Clears interrupt service routine to call when IRQ1 activates.
Definition: LR11x0.cpp:342
-
LR11x0::setBitRate
int16_t setBitRate(float br) override
Sets GFSK bit rate. Allowed values range from 0.6 to 300.0 kbps.
Definition: LR11x0.cpp:745
+
LR11x0::clearPacketSentAction
void clearPacketSentAction() override
Clears interrupt service routine to call when a packet is sent.
Definition: LR11x0.cpp:362
+
LR11x0::clearPacketReceivedAction
void clearPacketReceivedAction() override
Clears interrupt service routine to call when a packet is received.
Definition: LR11x0.cpp:354
+
LR11x0::setTCXO
int16_t setTCXO(float voltage, uint32_t delay=5000)
Sets TCXO (Temperature Compensated Crystal Oscillator) configuration.
Definition: LR11x0.cpp:1095
+
LR11x0::setPreambleLength
int16_t setPreambleLength(size_t preambleLength) override
Sets preamble length for LoRa or GFSK modem. Allowed values range from 1 to 65535.
Definition: LR11x0.cpp:1078
+
LR11x0::startReceive
int16_t startReceive() override
Interrupt-driven receive method with default parameters. Implemented for compatibility with PhysicalL...
Definition: LR11x0.cpp:441
+
LR11x0::finishTransmit
int16_t finishTransmit() override
Clean up after transmission is done.
Definition: LR11x0.cpp:433
+
LR11x0::sleep
int16_t sleep()
Sets the module to sleep mode. To wake the device up, call standby().
Definition: LR11x0.cpp:317
+
LR11x0::clearIrqAction
void clearIrqAction()
Clears interrupt service routine to call when IRQ1 activates.
Definition: LR11x0.cpp:346
+
LR11x0::setBitRate
int16_t setBitRate(float br) override
Sets GFSK bit rate. Allowed values range from 0.6 to 300.0 kbps.
Definition: LR11x0.cpp:749
LR11x0::beginGFSK
int16_t beginGFSK(float br, float freqDev, float rxBw, int8_t power, uint16_t preambleLength, float tcxoVoltage)
Initialization method for FSK modem.
Definition: LR11x0.cpp:50
LR11x0::receive
virtual int16_t receive(uint8_t *data, size_t len)
Binary receive method. Must be implemented in module class.
Definition: PhysicalLayer.cpp:112
-
LR11x0::implicitHeader
int16_t implicitHeader(size_t len)
Set implicit header mode for future reception/transmission.
Definition: LR11x0.cpp:1350
-
LR11x0::getTimeOnAir
RadioLibTime_t getTimeOnAir(size_t len) override
Get expected time-on-air for a given size of payload.
Definition: LR11x0.cpp:1257
-
LR11x0::setBandwidth
int16_t setBandwidth(float bw)
Sets LoRa bandwidth. Allowed values are 62.5, 125.0, 250.0 and 500.0 kHz.
Definition: LR11x0.cpp:639
-
LR11x0::setFrequencyDeviation
int16_t setFrequencyDeviation(float freqDev) override
Sets GFSK frequency deviation. Allowed values range from 0.0 to 200.0 kHz.
Definition: LR11x0.cpp:762
-
LR11x0::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: LR11x0.cpp:1238
-
LR11x0::setPacketReceivedAction
void setPacketReceivedAction(void(*func)(void)) override
Sets interrupt service routine to call when a packet is received.
Definition: LR11x0.cpp:346
-
LR11x0::clearWiFiScanAction
void clearWiFiScanAction()
Clears interrupt service routine to call when a WiFi scan is completed.
Definition: LR11x0.cpp:1424
-
LR11x0::getFrequencyError
float getFrequencyError()
Gets frequency error of the latest received packet.
Definition: LR11x0.cpp:1233
-
LR11x0::variablePacketLengthMode
int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_LR11X0_MAX_PACKET_LENGTH)
Set modem in variable packet length mode. Available in GFSK mode only.
Definition: LR11x0.cpp:993
-
LR11x0::setWhitening
int16_t setWhitening(bool enabled, uint16_t initial=0x01FF)
Sets GFSK whitening parameters.
Definition: LR11x0.cpp:997
-
LR11x0::wifiScan
int16_t wifiScan(uint8_t wifiType, uint8_t *count, uint8_t mode=RADIOLIB_LR11X0_WIFI_ACQ_MODE_FULL_BEACON, uint16_t chanMask=RADIOLIB_LR11X0_WIFI_ALL_CHANNELS, uint8_t numScans=16, uint16_t timeout=100)
Blocking WiFi scan method. Performs a full passive WiFi scan. This method may block for several secon...
Definition: LR11x0.cpp:1518
-
LR11x0::setSpreadingFactor
int16_t setSpreadingFactor(uint8_t sf, bool legacy=false)
Sets LoRa spreading factor. Allowed values range from 5 to 12.
Definition: LR11x0.cpp:675
+
LR11x0::implicitHeader
int16_t implicitHeader(size_t len)
Set implicit header mode for future reception/transmission.
Definition: LR11x0.cpp:1354
+
LR11x0::getTimeOnAir
RadioLibTime_t getTimeOnAir(size_t len) override
Get expected time-on-air for a given size of payload.
Definition: LR11x0.cpp:1261
+
LR11x0::setBandwidth
int16_t setBandwidth(float bw)
Sets LoRa bandwidth. Allowed values are 62.5, 125.0, 250.0 and 500.0 kHz.
Definition: LR11x0.cpp:643
+
LR11x0::setFrequencyDeviation
int16_t setFrequencyDeviation(float freqDev) override
Sets GFSK frequency deviation. Allowed values range from 0.0 to 200.0 kHz.
Definition: LR11x0.cpp:766
+
LR11x0::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: LR11x0.cpp:1242
+
LR11x0::setPacketReceivedAction
void setPacketReceivedAction(void(*func)(void)) override
Sets interrupt service routine to call when a packet is received.
Definition: LR11x0.cpp:350
+
LR11x0::clearWiFiScanAction
void clearWiFiScanAction()
Clears interrupt service routine to call when a WiFi scan is completed.
Definition: LR11x0.cpp:1428
+
LR11x0::getFrequencyError
float getFrequencyError()
Gets frequency error of the latest received packet.
Definition: LR11x0.cpp:1237
+
LR11x0::variablePacketLengthMode
int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_LR11X0_MAX_PACKET_LENGTH)
Set modem in variable packet length mode. Available in GFSK mode only.
Definition: LR11x0.cpp:997
+
LR11x0::setWhitening
int16_t setWhitening(bool enabled, uint16_t initial=0x01FF)
Sets GFSK whitening parameters.
Definition: LR11x0.cpp:1001
+
LR11x0::wifiScan
int16_t wifiScan(uint8_t wifiType, uint8_t *count, uint8_t mode=RADIOLIB_LR11X0_WIFI_ACQ_MODE_FULL_BEACON, uint16_t chanMask=RADIOLIB_LR11X0_WIFI_ALL_CHANNELS, uint8_t numScans=16, uint16_t timeout=100)
Blocking WiFi scan method. Performs a full passive WiFi scan. This method may block for several secon...
Definition: LR11x0.cpp:1522
+
LR11x0::setSpreadingFactor
int16_t setSpreadingFactor(uint8_t sf, bool legacy=false)
Sets LoRa spreading factor. Allowed values range from 5 to 12.
Definition: LR11x0.cpp:679
LR11x0::transmitDirect
int16_t transmitDirect(uint32_t frf=0) override
Starts direct mode transmission.
Definition: LR11x0.cpp:257
LR11x0::receiveDirect
int16_t receiveDirect() override
Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as SX126x series does...
Definition: LR11x0.cpp:272
-
LR11x0::disableAddressFiltering
int16_t disableAddressFiltering()
Disables address filtering. Calling this method will also erase previously set addresses.
Definition: LR11x0.cpp:937
-
LR11x0::setBroadcastAddress
int16_t setBroadcastAddress(uint8_t broadAddr)
Sets broadcast address. Calling this method will also enable address filtering for node and broadcast...
Definition: LR11x0.cpp:919
-
LR11x0::irqRxDoneRxTimeout
int16_t irqRxDoneRxTimeout(uint32_t &irqFlags, uint32_t &irqMask) override
Create the flags that make up RxDone and RxTimeout used for receiving downlinks.
Definition: LR11x0.cpp:1332
-
LR11x0::invertIQ
int16_t invertIQ(bool enable) override
Enable/disable inversion of the I and Q signals.
Definition: LR11x0.cpp:1190
-
LR11x0::setWiFiScanAction
void setWiFiScanAction(void(*func)(void))
Sets interrupt service routine to call when a WiFi scan is completed.
Definition: LR11x0.cpp:1420
+
LR11x0::disableAddressFiltering
int16_t disableAddressFiltering()
Disables address filtering. Calling this method will also erase previously set addresses.
Definition: LR11x0.cpp:941
+
LR11x0::setBroadcastAddress
int16_t setBroadcastAddress(uint8_t broadAddr)
Sets broadcast address. Calling this method will also enable address filtering for node and broadcast...
Definition: LR11x0.cpp:923
+
LR11x0::irqRxDoneRxTimeout
int16_t irqRxDoneRxTimeout(uint32_t &irqFlags, uint32_t &irqMask) override
Create the flags that make up RxDone and RxTimeout used for receiving downlinks.
Definition: LR11x0.cpp:1336
+
LR11x0::invertIQ
int16_t invertIQ(bool enable) override
Enable/disable inversion of the I and Q signals.
Definition: LR11x0.cpp:1194
+
LR11x0::setWiFiScanAction
void setWiFiScanAction(void(*func)(void))
Sets interrupt service routine to call when a WiFi scan is completed.
Definition: LR11x0.cpp:1424
Module
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:68
PhysicalLayer
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:54
PhysicalLayer::readData
virtual int16_t readData(uint8_t *data, size_t len)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:209
PhysicalLayer::transmit
int16_t transmit(const char *str, uint8_t addr=0)
C-string transmit method.
Definition: PhysicalLayer.cpp:52
PhysicalLayer::startTransmit
int16_t startTransmit(const char *str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:149
PhysicalLayer::receive
virtual int16_t receive(uint8_t *data, size_t len)
Binary receive method. Must be implemented in module class.
Definition: PhysicalLayer.cpp:112
-
PhysicalLayer::sleep
virtual int16_t sleep()
Sets module to sleep.
Definition: PhysicalLayer.cpp:118
RadioLibTime_t
unsigned long RadioLibTime_t
Type used for durations in RadioLib.
Definition: TypeDef.h:586
LR11x0WifiResult_t
Structure to save result of passive WiFi scan. This result only saves the basic information.
Definition: LR11x0.h:549
LR11x0WifiResult_t::ap
bool ap
Whether this signal was sent by an access point (true) or end device (false)
Definition: LR11x0.h:563
diff --git a/_s_t_m32_w_lx_8h_source.html b/_s_t_m32_w_lx_8h_source.html index 92e7b3cc..d75d72d6 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
STM32WLx::setPacketReceivedAction
void setPacketReceivedAction(void(*func)(void)) override
Sets interrupt service routine to call when a packet is received.
Definition: STM32WLx.cpp:131
STM32WLx::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: STM32WLx.cpp:27
SX1262
Derived class for SX1262 modules.
Definition: SX1262.h:22
-
SX126x::setRfSwitchTable
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:1487
+
SX126x::setRfSwitchTable
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:1492
diff --git a/_s_x126x_8h_source.html b/_s_x126x_8h_source.html index 46e8a228..bd953c37 100644 --- a/_s_x126x_8h_source.html +++ b/_s_x126x_8h_source.html @@ -557,258 +557,259 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
539 
547  int16_t scanChannel(uint8_t symbolNum, uint8_t detPeak, uint8_t detMin);
548 
-
555  int16_t sleep(bool retainConfig = true);
-
556 
-
561  int16_t standby() override;
-
562 
-
570  int16_t standby(uint8_t mode, bool wakeup = true);
-
571 
-
572  // interrupt methods
-
573 
-
578  void setDio1Action(void (*func)(void));
-
579 
-
583  void clearDio1Action();
-
584 
-
589  void setPacketReceivedAction(void (*func)(void)) override;
-
590 
-
594  void clearPacketReceivedAction() override;
-
595 
-
600  void setPacketSentAction(void (*func)(void)) override;
-
601 
-
605  void clearPacketSentAction() override;
-
606 
-
611  void setChannelScanAction(void (*func)(void)) override;
-
612 
-
616  void clearChannelScanAction() override;
-
617 
-
626  int16_t startTransmit(uint8_t* data, size_t len, uint8_t addr = 0) override;
-
627 
-
632  int16_t finishTransmit() override;
-
633 
-
640  int16_t startReceive() override;
-
641 
-
657  int16_t startReceive(uint32_t timeout, uint32_t irqFlags = RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint32_t irqMask = RADIOLIB_SX126X_IRQ_RX_DONE, size_t len = 0);
-
658 
-
669  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);
-
670 
-
685  int16_t startReceiveDutyCycleAuto(uint16_t senderPreambleLength = 0, uint16_t minSymbols = 8, uint16_t irqFlags = RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask = RADIOLIB_SX126X_IRQ_RX_DONE);
-
686 
-
691  uint16_t getIrqStatus();
-
692 
-
701  int16_t readData(uint8_t* data, size_t len) override;
-
702 
-
708  int16_t startChannelScan() override;
-
709 
-
718  int16_t startChannelScan(uint8_t symbolNum, uint8_t detPeak, uint8_t detMin);
-
719 
-
724  int16_t getChannelScanResult() override;
-
725 
-
726  // configuration methods
-
727 
-
733  int16_t setBandwidth(float bw);
-
734 
-
740  int16_t setSpreadingFactor(uint8_t sf);
-
741 
-
747  int16_t setCodingRate(uint8_t cr);
-
748 
-
755  int16_t setSyncWord(uint8_t syncWord, uint8_t controlBits = 0x44);
-
756 
-
762  int16_t setCurrentLimit(float currentLimit);
-
763 
-
768  float getCurrentLimit();
-
769 
-
775  int16_t setPreambleLength(size_t preambleLength) override;
-
776 
-
782  int16_t setFrequencyDeviation(float freqDev) override;
-
783 
-
789  int16_t setBitRate(float br) override;
-
790 
-
796  int16_t setDataRate(DataRate_t dr) override;
-
797 
-
803  int16_t checkDataRate(DataRate_t dr) override;
-
804 
-
811  int16_t setRxBandwidth(float rxBw);
-
812 
-
821  int16_t setRxBoostedGainMode(bool rxbgm, bool persist = true);
-
822 
-
830  int16_t setDataShaping(uint8_t sh) override;
-
831 
-
838  int16_t setSyncWord(uint8_t* syncWord, size_t len) override;
-
839 
-
847  int16_t setSyncBits(uint8_t *syncWord, uint8_t bitsLen);
-
848 
-
854  int16_t setNodeAddress(uint8_t nodeAddr);
-
855 
-
862  int16_t setBroadcastAddress(uint8_t broadAddr);
-
863 
-
868  int16_t disableAddressFiltering();
-
869 
-
878  int16_t setCRC(uint8_t len, uint16_t initial = 0x1D0F, uint16_t polynomial = 0x1021, bool inverted = true);
-
879 
-
887  int16_t setWhitening(bool enabled, uint16_t initial = 0x01FF);
-
888 
-
898  int16_t setTCXO(float voltage, uint32_t delay = 5000);
-
899 
-
904  int16_t setDio2AsRfSwitch(bool enable = true);
-
905 
-
910  float getDataRate() const;
-
911 
-
917  float getRSSI(bool packet = true);
-
918 
-
923  float getSNR() override;
-
924 
-
932  float getFrequencyError();
-
933 
-
939  size_t getPacketLength(bool update = true) override;
-
940 
-
946  int16_t fixedPacketLengthMode(uint8_t len = RADIOLIB_SX126X_MAX_PACKET_LENGTH);
-
947 
-
953  int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_SX126X_MAX_PACKET_LENGTH);
-
954 
-
960  RadioLibTime_t getTimeOnAir(size_t len) override;
-
961 
-
967  RadioLibTime_t calculateRxTimeout(RadioLibTime_t timeoutUs) override;
-
968 
-
975  int16_t irqRxDoneRxTimeout(uint32_t &irqFlags, uint32_t &irqMask) override;
-
976 
-
981  bool isRxTimeout() override;
-
982 
-
988  int16_t implicitHeader(size_t len);
-
989 
-
994  int16_t explicitHeader();
-
995 
-
1000  int16_t setRegulatorLDO();
-
1001 
-
1006  int16_t setRegulatorDCDC();
-
1007 
-
1013  int16_t setEncoding(uint8_t encoding) override;
-
1014 
-
1016  void setRfSwitchPins(uint32_t rxEn, uint32_t txEn);
-
1017 
-
1019  void setRfSwitchTable(const uint32_t (&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[]);
-
1020 
-
1029  int16_t forceLDRO(bool enable);
-
1030 
-
1037  int16_t autoLDRO();
-
1038 
-
1043  uint8_t randomByte() override;
-
1044 
-
1050  int16_t invertIQ(bool enable) override;
-
1051 
-
1052  #if !RADIOLIB_EXCLUDE_DIRECT_RECEIVE
-
1057  void setDirectAction(void (*func)(void)) override;
-
1058 
-
1063  void readBit(uint32_t pin) override;
-
1064  #endif
-
1065 
-
1075  int16_t uploadPatch(const uint32_t* patch, size_t len, bool nonvolatile = true);
-
1076 
-
1084  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);
-
1085 
-
1089  void spectralScanAbort();
-
1090 
-
1095  int16_t spectralScanGetStatus();
-
1096 
-
1102  int16_t spectralScanGetResult(uint16_t* results);
-
1103 
-
1115  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);
-
1116 
-
1124  int16_t calibrateImageRejection(float freqMin, float freqMax);
-
1125 
-
1130  int16_t setPaRampTime(uint8_t rampTime);
-
1131 
-
1132 #if !RADIOLIB_GODMODE && !RADIOLIB_LOW_LEVEL
-
1133  protected:
-
1134 #endif
-
1135  Module* getMod() override;
-
1136 
-
1137  // SX126x SPI command implementations
-
1138  int16_t setFs();
-
1139  int16_t setTx(uint32_t timeout = 0);
-
1140  int16_t setRx(uint32_t timeout);
-
1141  int16_t setCad(uint8_t symbolNum, uint8_t detPeak, uint8_t detMin);
-
1142  int16_t writeRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
-
1143  int16_t readRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
-
1144  int16_t writeBuffer(uint8_t* data, uint8_t numBytes, uint8_t offset = 0x00);
-
1145  int16_t readBuffer(uint8_t* data, uint8_t numBytes, uint8_t offset = 0x00);
-
1146  int16_t setDioIrqParams(uint16_t irqMask, uint16_t dio1Mask, uint16_t dio2Mask = RADIOLIB_SX126X_IRQ_NONE, uint16_t dio3Mask = RADIOLIB_SX126X_IRQ_NONE);
-
1147  virtual int16_t clearIrqStatus(uint16_t clearIrqParams = RADIOLIB_SX126X_IRQ_ALL);
-
1148  int16_t setRfFrequency(uint32_t frf);
-
1149  int16_t calibrateImage(uint8_t* data);
-
1150  uint8_t getPacketType();
-
1151  int16_t setTxParams(uint8_t power, uint8_t rampTime);
-
1152  int16_t setModulationParams(uint8_t sf, uint8_t bw, uint8_t cr, uint8_t ldro);
-
1153  int16_t setModulationParamsFSK(uint32_t br, uint8_t sh, uint8_t rxBw, uint32_t freqDev);
-
1154  int16_t setPacketParams(uint16_t preambleLen, uint8_t crcType, uint8_t payloadLen, uint8_t hdrType, uint8_t invertIQ);
-
1155  int16_t setPacketParamsFSK(uint16_t preambleLen, uint8_t crcType, uint8_t syncWordLen, uint8_t addrCmp, uint8_t whiten, uint8_t packType = RADIOLIB_SX126X_GFSK_PACKET_VARIABLE, uint8_t payloadLen = 0xFF, uint8_t preambleDetectorLen = RADIOLIB_SX126X_GFSK_PREAMBLE_DETECT_16);
-
1156  int16_t setBufferBaseAddress(uint8_t txBaseAddress = 0x00, uint8_t rxBaseAddress = 0x00);
-
1157  int16_t setRegulatorMode(uint8_t mode);
-
1158  uint8_t getStatus();
-
1159  uint32_t getPacketStatus();
-
1160  uint16_t getDeviceErrors();
-
1161  int16_t clearDeviceErrors();
-
1162 
-
1163 #if !RADIOLIB_GODMODE
-
1164  protected:
-
1165 #endif
-
1166  const char* chipType = NULL;
-
1167  uint8_t bandwidth = 0;
-
1168 
-
1169  // Allow subclasses to define different TX modes
-
1170  uint8_t txMode = Module::MODE_TX;
-
1171 
-
1172  int16_t setFrequencyRaw(float freq);
-
1173  int16_t fixPaClamping(bool enable = true);
-
1174 
-
1175  // common low-level SPI interface
-
1176  static int16_t SPIparseStatus(uint8_t in);
-
1177 
-
1178 #if !RADIOLIB_GODMODE
-
1179  private:
-
1180 #endif
-
1181  Module* mod;
-
1182 
-
1183  uint8_t spreadingFactor = 0, codingRate = 0, ldrOptimize = 0, crcTypeLoRa = 0, headerType = 0;
-
1184  uint16_t preambleLengthLoRa = 0;
-
1185  float bandwidthKhz = 0;
-
1186  bool ldroAuto = true;
-
1187 
-
1188  uint32_t bitRate = 0, frequencyDev = 0;
-
1189  uint8_t rxBandwidth = 0, pulseShape = 0, crcTypeFSK = 0, syncWordLength = 0, addrComp = 0, whitening = 0, packetType = 0;
-
1190  uint16_t preambleLengthFSK = 0;
-
1191  float rxBandwidthKhz = 0;
-
1192 
-
1193  float dataRateMeasured = 0;
-
1194 
-
1195  uint32_t tcxoDelay = 0;
-
1196  uint8_t pwr = 0;
-
1197 
-
1198  size_t implicitLen = 0;
-
1199  uint8_t invertIQEnabled = RADIOLIB_SX126X_LORA_IQ_STANDARD;
-
1200 
-
1201  int16_t config(uint8_t modem);
-
1202  bool findChip(const char* verStr);
-
1203  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);
-
1204  int16_t setPacketMode(uint8_t mode, uint8_t len);
-
1205  int16_t setHeaderType(uint8_t hdrType, size_t len = 0xFF);
-
1206  int16_t directMode();
-
1207  int16_t packetMode();
-
1208 
-
1209  // fixes to errata
-
1210  int16_t fixSensitivity();
-
1211  int16_t fixImplicitTimeout();
-
1212  int16_t fixInvertedIQ(uint8_t iqConfig);
-
1213 
+
555  int16_t sleep();
+
556  int16_t sleep(bool retainConfig);
+
557 
+
562  int16_t standby() override;
+
563 
+
571  int16_t standby(uint8_t mode, bool wakeup = true);
+
572 
+
573  // interrupt methods
+
574 
+
579  void setDio1Action(void (*func)(void));
+
580 
+
584  void clearDio1Action();
+
585 
+
590  void setPacketReceivedAction(void (*func)(void)) override;
+
591 
+
595  void clearPacketReceivedAction() override;
+
596 
+
601  void setPacketSentAction(void (*func)(void)) override;
+
602 
+
606  void clearPacketSentAction() override;
+
607 
+
612  void setChannelScanAction(void (*func)(void)) override;
+
613 
+
617  void clearChannelScanAction() override;
+
618 
+
627  int16_t startTransmit(uint8_t* data, size_t len, uint8_t addr = 0) override;
+
628 
+
633  int16_t finishTransmit() override;
+
634 
+
641  int16_t startReceive() override;
+
642 
+
658  int16_t startReceive(uint32_t timeout, uint32_t irqFlags = RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint32_t irqMask = RADIOLIB_SX126X_IRQ_RX_DONE, size_t len = 0);
+
659 
+
670  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);
+
671 
+
686  int16_t startReceiveDutyCycleAuto(uint16_t senderPreambleLength = 0, uint16_t minSymbols = 8, uint16_t irqFlags = RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask = RADIOLIB_SX126X_IRQ_RX_DONE);
+
687 
+
692  uint16_t getIrqStatus();
+
693 
+
702  int16_t readData(uint8_t* data, size_t len) override;
+
703 
+
709  int16_t startChannelScan() override;
+
710 
+
719  int16_t startChannelScan(uint8_t symbolNum, uint8_t detPeak, uint8_t detMin);
+
720 
+
725  int16_t getChannelScanResult() override;
+
726 
+
727  // configuration methods
+
728 
+
734  int16_t setBandwidth(float bw);
+
735 
+
741  int16_t setSpreadingFactor(uint8_t sf);
+
742 
+
748  int16_t setCodingRate(uint8_t cr);
+
749 
+
756  int16_t setSyncWord(uint8_t syncWord, uint8_t controlBits = 0x44);
+
757 
+
763  int16_t setCurrentLimit(float currentLimit);
+
764 
+
769  float getCurrentLimit();
+
770 
+
776  int16_t setPreambleLength(size_t preambleLength) override;
+
777 
+
783  int16_t setFrequencyDeviation(float freqDev) override;
+
784 
+
790  int16_t setBitRate(float br) override;
+
791 
+
797  int16_t setDataRate(DataRate_t dr) override;
+
798 
+
804  int16_t checkDataRate(DataRate_t dr) override;
+
805 
+
812  int16_t setRxBandwidth(float rxBw);
+
813 
+
822  int16_t setRxBoostedGainMode(bool rxbgm, bool persist = true);
+
823 
+
831  int16_t setDataShaping(uint8_t sh) override;
+
832 
+
839  int16_t setSyncWord(uint8_t* syncWord, size_t len) override;
+
840 
+
848  int16_t setSyncBits(uint8_t *syncWord, uint8_t bitsLen);
+
849 
+
855  int16_t setNodeAddress(uint8_t nodeAddr);
+
856 
+
863  int16_t setBroadcastAddress(uint8_t broadAddr);
+
864 
+
869  int16_t disableAddressFiltering();
+
870 
+
879  int16_t setCRC(uint8_t len, uint16_t initial = 0x1D0F, uint16_t polynomial = 0x1021, bool inverted = true);
+
880 
+
888  int16_t setWhitening(bool enabled, uint16_t initial = 0x01FF);
+
889 
+
899  int16_t setTCXO(float voltage, uint32_t delay = 5000);
+
900 
+
905  int16_t setDio2AsRfSwitch(bool enable = true);
+
906 
+
911  float getDataRate() const;
+
912 
+
918  float getRSSI(bool packet = true);
+
919 
+
924  float getSNR() override;
+
925 
+
933  float getFrequencyError();
+
934 
+
940  size_t getPacketLength(bool update = true) override;
+
941 
+
947  int16_t fixedPacketLengthMode(uint8_t len = RADIOLIB_SX126X_MAX_PACKET_LENGTH);
+
948 
+
954  int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_SX126X_MAX_PACKET_LENGTH);
+
955 
+
961  RadioLibTime_t getTimeOnAir(size_t len) override;
+
962 
+
968  RadioLibTime_t calculateRxTimeout(RadioLibTime_t timeoutUs) override;
+
969 
+
976  int16_t irqRxDoneRxTimeout(uint32_t &irqFlags, uint32_t &irqMask) override;
+
977 
+
982  bool isRxTimeout() override;
+
983 
+
989  int16_t implicitHeader(size_t len);
+
990 
+
995  int16_t explicitHeader();
+
996 
+
1001  int16_t setRegulatorLDO();
+
1002 
+
1007  int16_t setRegulatorDCDC();
+
1008 
+
1014  int16_t setEncoding(uint8_t encoding) override;
+
1015 
+
1017  void setRfSwitchPins(uint32_t rxEn, uint32_t txEn);
+
1018 
+
1020  void setRfSwitchTable(const uint32_t (&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[]);
+
1021 
+
1030  int16_t forceLDRO(bool enable);
+
1031 
+
1038  int16_t autoLDRO();
+
1039 
+
1044  uint8_t randomByte() override;
+
1045 
+
1051  int16_t invertIQ(bool enable) override;
+
1052 
+
1053  #if !RADIOLIB_EXCLUDE_DIRECT_RECEIVE
+
1058  void setDirectAction(void (*func)(void)) override;
+
1059 
+
1064  void readBit(uint32_t pin) override;
+
1065  #endif
+
1066 
+
1076  int16_t uploadPatch(const uint32_t* patch, size_t len, bool nonvolatile = true);
+
1077 
+
1085  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);
+
1086 
+
1090  void spectralScanAbort();
+
1091 
+
1096  int16_t spectralScanGetStatus();
+
1097 
+
1103  int16_t spectralScanGetResult(uint16_t* results);
+
1104 
+
1116  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);
+
1117 
+
1125  int16_t calibrateImageRejection(float freqMin, float freqMax);
+
1126 
+
1131  int16_t setPaRampTime(uint8_t rampTime);
+
1132 
+
1133 #if !RADIOLIB_GODMODE && !RADIOLIB_LOW_LEVEL
+
1134  protected:
+
1135 #endif
+
1136  Module* getMod() override;
+
1137 
+
1138  // SX126x SPI command implementations
+
1139  int16_t setFs();
+
1140  int16_t setTx(uint32_t timeout = 0);
+
1141  int16_t setRx(uint32_t timeout);
+
1142  int16_t setCad(uint8_t symbolNum, uint8_t detPeak, uint8_t detMin);
+
1143  int16_t writeRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
+
1144  int16_t readRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
+
1145  int16_t writeBuffer(uint8_t* data, uint8_t numBytes, uint8_t offset = 0x00);
+
1146  int16_t readBuffer(uint8_t* data, uint8_t numBytes, uint8_t offset = 0x00);
+
1147  int16_t setDioIrqParams(uint16_t irqMask, uint16_t dio1Mask, uint16_t dio2Mask = RADIOLIB_SX126X_IRQ_NONE, uint16_t dio3Mask = RADIOLIB_SX126X_IRQ_NONE);
+
1148  virtual int16_t clearIrqStatus(uint16_t clearIrqParams = RADIOLIB_SX126X_IRQ_ALL);
+
1149  int16_t setRfFrequency(uint32_t frf);
+
1150  int16_t calibrateImage(uint8_t* data);
+
1151  uint8_t getPacketType();
+
1152  int16_t setTxParams(uint8_t power, uint8_t rampTime);
+
1153  int16_t setModulationParams(uint8_t sf, uint8_t bw, uint8_t cr, uint8_t ldro);
+
1154  int16_t setModulationParamsFSK(uint32_t br, uint8_t sh, uint8_t rxBw, uint32_t freqDev);
+
1155  int16_t setPacketParams(uint16_t preambleLen, uint8_t crcType, uint8_t payloadLen, uint8_t hdrType, uint8_t invertIQ);
+
1156  int16_t setPacketParamsFSK(uint16_t preambleLen, uint8_t crcType, uint8_t syncWordLen, uint8_t addrCmp, uint8_t whiten, uint8_t packType = RADIOLIB_SX126X_GFSK_PACKET_VARIABLE, uint8_t payloadLen = 0xFF, uint8_t preambleDetectorLen = RADIOLIB_SX126X_GFSK_PREAMBLE_DETECT_16);
+
1157  int16_t setBufferBaseAddress(uint8_t txBaseAddress = 0x00, uint8_t rxBaseAddress = 0x00);
+
1158  int16_t setRegulatorMode(uint8_t mode);
+
1159  uint8_t getStatus();
+
1160  uint32_t getPacketStatus();
+
1161  uint16_t getDeviceErrors();
+
1162  int16_t clearDeviceErrors();
+
1163 
+
1164 #if !RADIOLIB_GODMODE
+
1165  protected:
+
1166 #endif
+
1167  const char* chipType = NULL;
+
1168  uint8_t bandwidth = 0;
+
1169 
+
1170  // Allow subclasses to define different TX modes
+
1171  uint8_t txMode = Module::MODE_TX;
+
1172 
+
1173  int16_t setFrequencyRaw(float freq);
+
1174  int16_t fixPaClamping(bool enable = true);
+
1175 
+
1176  // common low-level SPI interface
+
1177  static int16_t SPIparseStatus(uint8_t in);
+
1178 
+
1179 #if !RADIOLIB_GODMODE
+
1180  private:
+
1181 #endif
+
1182  Module* mod;
+
1183 
+
1184  uint8_t spreadingFactor = 0, codingRate = 0, ldrOptimize = 0, crcTypeLoRa = 0, headerType = 0;
+
1185  uint16_t preambleLengthLoRa = 0;
+
1186  float bandwidthKhz = 0;
+
1187  bool ldroAuto = true;
+
1188 
+
1189  uint32_t bitRate = 0, frequencyDev = 0;
+
1190  uint8_t rxBandwidth = 0, pulseShape = 0, crcTypeFSK = 0, syncWordLength = 0, addrComp = 0, whitening = 0, packetType = 0;
+
1191  uint16_t preambleLengthFSK = 0;
+
1192  float rxBandwidthKhz = 0;
+
1193 
+
1194  float dataRateMeasured = 0;
+
1195 
+
1196  uint32_t tcxoDelay = 0;
+
1197  uint8_t pwr = 0;
+
1198 
+
1199  size_t implicitLen = 0;
+
1200  uint8_t invertIQEnabled = RADIOLIB_SX126X_LORA_IQ_STANDARD;
+
1201 
+
1202  int16_t config(uint8_t modem);
+
1203  bool findChip(const char* verStr);
+
1204  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);
+
1205  int16_t setPacketMode(uint8_t mode, uint8_t len);
+
1206  int16_t setHeaderType(uint8_t hdrType, size_t len = 0xFF);
+
1207  int16_t directMode();
+
1208  int16_t packetMode();
+
1209 
+
1210  // fixes to errata
+
1211  int16_t fixSensitivity();
+
1212  int16_t fixImplicitTimeout();
+
1213  int16_t fixInvertedIQ(uint8_t iqConfig);
1214 
-
1215  void regdump();
-
1216  void effectEvalPre(uint8_t* buff, uint32_t start);
-
1217  void effectEvalPost(uint8_t* buff, uint32_t start);
-
1218  void effectEval();
-
1219 };
-
1220 
-
1221 #endif
-
1222 
-
1223 #endif
+
1215 
+
1216  void regdump();
+
1217  void effectEvalPre(uint8_t* buff, uint32_t start);
+
1218  void effectEvalPost(uint8_t* buff, uint32_t start);
+
1219  void effectEval();
+
1220 };
+
1221 
+
1222 #endif
+
1223 
+
1224 #endif
Module
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:68
Module::RFSWITCH_MAX_PINS
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:77
Module::MODE_TX
@ MODE_TX
Transmission mode.
Definition: Module.h:114
@@ -818,90 +819,90 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
PhysicalLayer::startTransmit
int16_t startTransmit(const char *str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:149
PhysicalLayer::getRSSI
virtual float getRSSI()
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition: PhysicalLayer.cpp:295
PhysicalLayer::receive
virtual int16_t receive(uint8_t *data, size_t len)
Binary receive method. Must be implemented in module class.
Definition: PhysicalLayer.cpp:112
-
PhysicalLayer::sleep
virtual int16_t sleep()
Sets module to sleep.
Definition: PhysicalLayer.cpp:118
SX126x
Base class for SX126x series. All derived classes for SX126x (e.g. SX1262 or SX1268) inherit from thi...
Definition: SX126x.h:443
-
SX126x::startChannelScan
int16_t startChannelScan() override
Interrupt-driven channel activity detection method. DIO1 will be activated when LoRa preamble is dete...
Definition: SX126x.cpp:733
-
SX126x::getFrequencyError
float getFrequencyError()
Gets frequency error of the latest received packet. WARNING: This functionality is based on SX128x im...
Definition: SX126x.cpp:1355
-
SX126x::startReceiveDutyCycleAuto
int16_t startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)
Calls startReceiveDutyCycle with rxPeriod and sleepPeriod set so the unit shouldn't miss any messages...
Definition: SX126x.cpp:625
-
SX126x::setRfSwitchPins
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:1483
-
SX126x::setDio1Action
void setDio1Action(void(*func)(void))
Sets interrupt service routine to call when DIO1 activates.
Definition: SX126x.cpp:478
-
SX126x::setPaConfig
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:1790
-
SX126x::getTimeOnAir
RadioLibTime_t getTimeOnAir(size_t len) override
Get expected time-on-air for a given size of payload.
Definition: SX126x.cpp:1409
-
SX126x::randomByte
uint8_t randomByte() override
Get one truly random byte from RSSI noise.
Definition: SX126x.cpp:1512
-
SX126x::calculateRxTimeout
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:1444
-
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:1100
-
SX126x::setRegulatorLDO
int16_t setRegulatorLDO()
Set regulator mode to LDO.
Definition: SX126x.cpp:1471
-
SX126x::invertIQ
int16_t invertIQ(bool enable) override
Enable/disable inversion of the I and Q signals.
Definition: SX126x.cpp:1541
-
SX126x::uploadPatch
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:1565
-
SX126x::setEncoding
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:1479
-
SX126x::setRfSwitchTable
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:1487
+
SX126x::startChannelScan
int16_t startChannelScan() override
Interrupt-driven channel activity detection method. DIO1 will be activated when LoRa preamble is dete...
Definition: SX126x.cpp:738
+
SX126x::getFrequencyError
float getFrequencyError()
Gets frequency error of the latest received packet. WARNING: This functionality is based on SX128x im...
Definition: SX126x.cpp:1360
+
SX126x::startReceiveDutyCycleAuto
int16_t startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)
Calls startReceiveDutyCycle with rxPeriod and sleepPeriod set so the unit shouldn't miss any messages...
Definition: SX126x.cpp:630
+
SX126x::setRfSwitchPins
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:1488
+
SX126x::setDio1Action
void setDio1Action(void(*func)(void))
Sets interrupt service routine to call when DIO1 activates.
Definition: SX126x.cpp:483
+
SX126x::setPaConfig
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:1795
+
SX126x::getTimeOnAir
RadioLibTime_t getTimeOnAir(size_t len) override
Get expected time-on-air for a given size of payload.
Definition: SX126x.cpp:1414
+
SX126x::randomByte
uint8_t randomByte() override
Get one truly random byte from RSSI noise.
Definition: SX126x.cpp:1517
+
SX126x::calculateRxTimeout
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:1449
+
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:1105
+
SX126x::setRegulatorLDO
int16_t setRegulatorLDO()
Set regulator mode to LDO.
Definition: SX126x.cpp:1476
+
SX126x::invertIQ
int16_t invertIQ(bool enable) override
Enable/disable inversion of the I and Q signals.
Definition: SX126x.cpp:1546
+
SX126x::uploadPatch
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:1570
+
SX126x::setEncoding
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:1484
+
SX126x::setRfSwitchTable
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:1492
SX126x::beginFSK
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:101
-
SX126x::setBandwidth
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:782
-
SX126x::isRxTimeout
bool isRxTimeout() override
Check whether the IRQ bit for RxTimeout is set.
Definition: SX126x.cpp:1457
+
SX126x::setBandwidth
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:787
+
SX126x::isRxTimeout
bool isRxTimeout() override
Check whether the IRQ bit for RxTimeout is set.
Definition: SX126x.cpp:1462
SX126x::readData
virtual int16_t readData(uint8_t *data, size_t len)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:209
-
SX126x::explicitHeader
int16_t explicitHeader()
Set explicit header mode for future reception/transmission.
Definition: SX126x.cpp:1467
-
SX126x::clearChannelScanAction
void clearChannelScanAction() override
Clears interrupt service routine to call when a channel scan is finished.
Definition: SX126x.cpp:506
-
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:1491
+
SX126x::explicitHeader
int16_t explicitHeader()
Set explicit header mode for future reception/transmission.
Definition: SX126x.cpp:1472
+
SX126x::clearChannelScanAction
void clearChannelScanAction() override
Clears interrupt service routine to call when a channel scan is finished.
Definition: SX126x.cpp:511
+
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:1496
SX126x::transmit
int16_t transmit(const char *str, uint8_t addr=0)
C-string transmit method.
Definition: PhysicalLayer.cpp:52
-
SX126x::setDirectAction
void setDirectAction(void(*func)(void)) override
Set interrupt service routine function to call when data bit is received in direct mode.
Definition: SX126x.cpp:1556
-
SX126x::setNodeAddress
int16_t setNodeAddress(uint8_t nodeAddr)
Sets node address. Calling this method will also enable address filtering for node address only.
Definition: SX126x.cpp:1180
-
SX126x::spectralScanGetStatus
int16_t spectralScanGetStatus()
Read the status of spectral scan.
Definition: SX126x.cpp:1632
-
SX126x::clearPacketReceivedAction
void clearPacketReceivedAction() override
Clears interrupt service routine to call when a packet is received.
Definition: SX126x.cpp:490
-
SX126x::setTCXO
int16_t setTCXO(float voltage, uint32_t delay=5000)
Sets TCXO (Temperature Compensated Crystal Oscillator) configuration.
Definition: SX126x.cpp:1652
-
SX126x::getSNR
float getSNR() override
Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem.
Definition: SX126x.cpp:1339
-
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:1000
-
SX126x::setRegulatorDCDC
int16_t setRegulatorDCDC()
Set regulator mode to DC-DC.
Definition: SX126x.cpp:1475
-
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:598
-
SX126x::startReceive
int16_t startReceive() override
Interrupt-driven receive method with default parameters. Implemented for compatibility with PhysicalL...
Definition: SX126x.cpp:580
-
SX126x::clearDio1Action
void clearDio1Action()
Clears interrupt service routine to call when DIO1 activates.
Definition: SX126x.cpp:482
-
SX126x::checkDataRate
int16_t checkDataRate(DataRate_t dr) override
Check the data rate can be configured by this module.
Definition: SX126x.cpp:979
-
SX126x::setPacketReceivedAction
void setPacketReceivedAction(void(*func)(void)) override
Sets interrupt service routine to call when a packet is received.
Definition: SX126x.cpp:486
-
SX126x::standby
int16_t standby() override
Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator)...
Definition: SX126x.cpp:461
-
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:905
-
SX126x::spectralScanAbort
void spectralScanAbort()
Abort an ongoing spectral scan.
Definition: SX126x.cpp:1628
+
SX126x::setDirectAction
void setDirectAction(void(*func)(void)) override
Set interrupt service routine function to call when data bit is received in direct mode.
Definition: SX126x.cpp:1561
+
SX126x::setNodeAddress
int16_t setNodeAddress(uint8_t nodeAddr)
Sets node address. Calling this method will also enable address filtering for node address only.
Definition: SX126x.cpp:1185
+
SX126x::spectralScanGetStatus
int16_t spectralScanGetStatus()
Read the status of spectral scan.
Definition: SX126x.cpp:1637
+
SX126x::clearPacketReceivedAction
void clearPacketReceivedAction() override
Clears interrupt service routine to call when a packet is received.
Definition: SX126x.cpp:495
+
SX126x::setTCXO
int16_t setTCXO(float voltage, uint32_t delay=5000)
Sets TCXO (Temperature Compensated Crystal Oscillator) configuration.
Definition: SX126x.cpp:1657
+
SX126x::getSNR
float getSNR() override
Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem.
Definition: SX126x.cpp:1344
+
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:1005
+
SX126x::setRegulatorDCDC
int16_t setRegulatorDCDC()
Set regulator mode to DC-DC.
Definition: SX126x.cpp:1480
+
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:603
+
SX126x::startReceive
int16_t startReceive() override
Interrupt-driven receive method with default parameters. Implemented for compatibility with PhysicalL...
Definition: SX126x.cpp:585
+
SX126x::clearDio1Action
void clearDio1Action()
Clears interrupt service routine to call when DIO1 activates.
Definition: SX126x.cpp:487
+
SX126x::checkDataRate
int16_t checkDataRate(DataRate_t dr) override
Check the data rate can be configured by this module.
Definition: SX126x.cpp:984
+
SX126x::setPacketReceivedAction
void setPacketReceivedAction(void(*func)(void)) override
Sets interrupt service routine to call when a packet is received.
Definition: SX126x.cpp:491
+
SX126x::standby
int16_t standby() override
Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator)...
Definition: SX126x.cpp:466
+
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:910
+
SX126x::spectralScanAbort
void spectralScanAbort()
Abort an ongoing spectral scan.
Definition: SX126x.cpp:1633
SX126x::receiveDirect
int16_t receiveDirect() override
Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as SX126x series does...
Definition: SX126x.cpp:353
-
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:1612
-
SX126x::finishTransmit
int16_t finishTransmit() override
Clean up after transmission is done.
Definition: SX126x.cpp:572
-
SX126x::setCurrentLimit
int16_t setCurrentLimit(float currentLimit)
Sets current protection limit. Can be set in 2.5 mA steps.
Definition: SX126x.cpp:870
-
SX126x::setRxBoostedGainMode
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:1063
+
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:1617
+
SX126x::finishTransmit
int16_t finishTransmit() override
Clean up after transmission is done.
Definition: SX126x.cpp:577
+
SX126x::setCurrentLimit
int16_t setCurrentLimit(float currentLimit)
Sets current protection limit. Can be set in 2.5 mA steps.
Definition: SX126x.cpp:875
+
SX126x::setRxBoostedGainMode
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:1068
SX126x::transmitDirect
int16_t transmitDirect(uint32_t frf=0) override
Starts direct mode transmission.
Definition: SX126x.cpp:337
SX126x::startTransmit
int16_t startTransmit(const char *str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:149
-
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:1405
+
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:1410
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:12
-
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:1225
-
SX126x::getIrqStatus
uint16_t getIrqStatus()
Reads the current IRQ status.
Definition: SX126x.cpp:1827
+
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:1230
+
SX126x::getIrqStatus
uint16_t getIrqStatus()
Reads the current IRQ status.
Definition: SX126x.cpp:1832
SX126x::reset
int16_t reset(bool verify=true)
Reset method. Will reset the chip to the default state using RST pin.
Definition: SX126x.cpp:198
-
SX126x::setSyncWord
int16_t setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)
Sets LoRa sync word.
Definition: SX126x.cpp:859
-
SX126x::calibrateImageRejection
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:1843
-
SX126x::getCurrentLimit
float getCurrentLimit()
Reads current protection limit.
Definition: SX126x.cpp:883
+
SX126x::setSyncWord
int16_t setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)
Sets LoRa sync word.
Definition: SX126x.cpp:864
+
SX126x::calibrateImageRejection
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:1848
+
SX126x::getCurrentLimit
float getCurrentLimit()
Reads current protection limit.
Definition: SX126x.cpp:888
SX126x::SX126x
SX126x(Module *mod)
Default constructor.
Definition: SX126x.cpp:6
-
SX126x::irqRxDoneRxTimeout
int16_t irqRxDoneRxTimeout(uint32_t &irqFlags, uint32_t &irqMask) override
Create the flags that make up RxDone and RxTimeout used for receiving downlinks.
Definition: SX126x.cpp:1451
+
SX126x::irqRxDoneRxTimeout
int16_t irqRxDoneRxTimeout(uint32_t &irqFlags, uint32_t &irqMask) override
Create the flags that make up RxDone and RxTimeout used for receiving downlinks.
Definition: SX126x.cpp:1456
SX126x::receive
virtual int16_t receive(uint8_t *data, size_t len)
Binary receive method. Must be implemented in module class.
Definition: PhysicalLayer.cpp:112
-
SX126x::autoLDRO
int16_t autoLDRO()
Re-enables automatic LDRO configuration. Only available in LoRa mode. After calling this method,...
Definition: SX126x.cpp:1503
-
SX126x::fixedPacketLengthMode
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:1401
-
SX126x::setBroadcastAddress
int16_t setBroadcastAddress(uint8_t broadAddr)
Sets broadcast address. Calling this method will also enable address filtering for node and broadcast...
Definition: SX126x.cpp:1197
-
SX126x::setBitRate
int16_t setBitRate(float br) override
Sets FSK bit rate. Allowed values range from 0.6 to 300.0 kbps.
Definition: SX126x.cpp:929
-
SX126x::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: SX126x.cpp:1388
-
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:1161
-
SX126x::setPacketSentAction
void setPacketSentAction(void(*func)(void)) override
Sets interrupt service routine to call when a packet is sent.
Definition: SX126x.cpp:494
-
SX126x::readBit
void readBit(uint32_t pin) override
Function to read and process data bit in direct reception mode.
Definition: SX126x.cpp:1560
+
SX126x::autoLDRO
int16_t autoLDRO()
Re-enables automatic LDRO configuration. Only available in LoRa mode. After calling this method,...
Definition: SX126x.cpp:1508
+
SX126x::fixedPacketLengthMode
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:1406
+
SX126x::setBroadcastAddress
int16_t setBroadcastAddress(uint8_t broadAddr)
Sets broadcast address. Calling this method will also enable address filtering for node and broadcast...
Definition: SX126x.cpp:1202
+
SX126x::setBitRate
int16_t setBitRate(float br) override
Sets FSK bit rate. Allowed values range from 0.6 to 300.0 kbps.
Definition: SX126x.cpp:934
+
SX126x::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: SX126x.cpp:1393
+
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:1166
+
SX126x::setPacketSentAction
void setPacketSentAction(void(*func)(void)) override
Sets interrupt service routine to call when a packet is sent.
Definition: SX126x.cpp:499
+
SX126x::readBit
void readBit(uint32_t pin) override
Function to read and process data bit in direct reception mode.
Definition: SX126x.cpp:1565
SX126x::scanChannel
int16_t scanChannel() override
Performs scan for LoRa transmission in the current channel. Detects both preamble and payload.
Definition: SX126x.cpp:427
-
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:1321
-
SX126x::setPreambleLength
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:892
-
SX126x::setPaRampTime
int16_t setPaRampTime(uint8_t rampTime)
Set PA ramp-up time. Set to 200us by default.
Definition: SX126x.cpp:1849
+
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:1326
+
SX126x::setPreambleLength
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:897
+
SX126x::setPaRampTime
int16_t setPaRampTime(uint8_t rampTime)
Set PA ramp-up time. Set to 200us by default.
Definition: SX126x.cpp:1854
SX126x::XTAL
bool XTAL
Whether the module has an XTAL (true) or TCXO (false). Defaults to false.
Definition: SX126x.h:460
-
SX126x::implicitHeader
int16_t implicitHeader(size_t len)
Set implicit header mode for future reception/transmission.
Definition: SX126x.cpp:1463
-
SX126x::setDio2AsRfSwitch
int16_t setDio2AsRfSwitch(bool enable=true)
Set DIO2 to function as RF switch (default in Semtech example designs).
Definition: SX126x.cpp:1705
-
SX126x::spectralScanGetResult
int16_t spectralScanGetResult(uint16_t *results)
Read the result of spectral scan.
Definition: SX126x.cpp:1640
-
SX126x::setWhitening
int16_t setWhitening(bool enabled, uint16_t initial=0x01FF)
Sets FSK whitening parameters.
Definition: SX126x.cpp:1284
-
SX126x::setSpreadingFactor
int16_t setSpreadingFactor(uint8_t sf)
Sets LoRa spreading factor. Allowed values range from 5 to 12.
Definition: SX126x.cpp:833
+
SX126x::implicitHeader
int16_t implicitHeader(size_t len)
Set implicit header mode for future reception/transmission.
Definition: SX126x.cpp:1468
+
SX126x::setDio2AsRfSwitch
int16_t setDio2AsRfSwitch(bool enable=true)
Set DIO2 to function as RF switch (default in Semtech example designs).
Definition: SX126x.cpp:1710
+
SX126x::spectralScanGetResult
int16_t spectralScanGetResult(uint16_t *results)
Read the result of spectral scan.
Definition: SX126x.cpp:1645
+
SX126x::setWhitening
int16_t setWhitening(bool enabled, uint16_t initial=0x01FF)
Sets FSK whitening parameters.
Definition: SX126x.cpp:1289
+
SX126x::setSpreadingFactor
int16_t setSpreadingFactor(uint8_t sf)
Sets LoRa spreading factor. Allowed values range from 5 to 12.
Definition: SX126x.cpp:838
SX126x::standbyXOSC
bool standbyXOSC
Whether to use XOSC (true) or RC (false) oscillator in standby mode. Defaults to false.
Definition: SX126x.h:465
-
SX126x::setChannelScanAction
void setChannelScanAction(void(*func)(void)) override
Sets interrupt service routine to call when a channel scan is finished.
Definition: SX126x.cpp:502
-
SX126x::setDataRate
int16_t setDataRate(DataRate_t dr) override
Set data.
Definition: SX126x.cpp:950
-
SX126x::clearPacketSentAction
void clearPacketSentAction() override
Clears interrupt service routine to call when a packet is sent.
Definition: SX126x.cpp:498
-
SX126x::disableAddressFiltering
int16_t disableAddressFiltering()
Disables address filtering. Calling this method will also erase previously set addresses.
Definition: SX126x.cpp:1214
-
SX126x::setCodingRate
int16_t setCodingRate(uint8_t cr)
Sets LoRa coding rate denominator. Allowed values range from 5 to 8.
Definition: SX126x.cpp:846
-
SX126x::getChannelScanResult
int16_t getChannelScanResult() override
Read the channel scan result.
Definition: SX126x.cpp:763
+
SX126x::sleep
int16_t sleep()
Sets the module to sleep mode. To wake the device up, call standby().
Definition: SX126x.cpp:446
+
SX126x::setChannelScanAction
void setChannelScanAction(void(*func)(void)) override
Sets interrupt service routine to call when a channel scan is finished.
Definition: SX126x.cpp:507
+
SX126x::setDataRate
int16_t setDataRate(DataRate_t dr) override
Set data.
Definition: SX126x.cpp:955
+
SX126x::clearPacketSentAction
void clearPacketSentAction() override
Clears interrupt service routine to call when a packet is sent.
Definition: SX126x.cpp:503
+
SX126x::disableAddressFiltering
int16_t disableAddressFiltering()
Disables address filtering. Calling this method will also erase previously set addresses.
Definition: SX126x.cpp:1219
+
SX126x::setCodingRate
int16_t setCodingRate(uint8_t cr)
Sets LoRa coding rate denominator. Allowed values range from 5 to 8.
Definition: SX126x.cpp:851
+
SX126x::getChannelScanResult
int16_t getChannelScanResult() override
Read the channel scan result.
Definition: SX126x.cpp:768
RadioLibTime_t
unsigned long RadioLibTime_t
Type used for durations in RadioLib.
Definition: TypeDef.h:586
Module::RfSwitchMode_t
Description of RF switch pin states for a single mode. See setRfSwitchTable for details.
Definition: Module.h:84
DataRate_t
Common data rate structure.
Definition: PhysicalLayer.h:38
diff --git a/_s_x128x_8h_source.html b/_s_x128x_8h_source.html index 0f8fb595..382481c3 100644 --- a/_s_x128x_8h_source.html +++ b/_s_x128x_8h_source.html @@ -462,173 +462,174 @@ $(document).ready(function(){initNavTree('_s_x128x_8h_source.html',''); initResi
453 
458  int16_t scanChannel() override;
459 
-
466  int16_t sleep(bool retainConfig = true);
-
467 
-
472  int16_t standby() override;
-
473 
-
481  int16_t standby(uint8_t mode, bool wakeup = false);
-
482 
-
483  // interrupt methods
-
484 
-
489  void setDio1Action(void (*func)(void));
-
490 
-
494  void clearDio1Action();
-
495 
-
500  void setPacketReceivedAction(void (*func)(void)) override;
-
501 
-
505  void clearPacketReceivedAction() override;
-
506 
-
511  void setPacketSentAction(void (*func)(void)) override;
-
512 
-
516  void clearPacketSentAction() override;
-
517 
-
526  int16_t startTransmit(uint8_t* data, size_t len, uint8_t addr = 0) override;
-
527 
-
532  int16_t finishTransmit() override;
-
533 
-
540  int16_t startReceive() override;
-
541 
-
554  int16_t startReceive(uint16_t timeout, uint32_t irqFlags = RADIOLIB_SX128X_IRQ_RX_DEFAULT, uint32_t irqMask = RADIOLIB_SX128X_IRQ_RX_DONE, size_t len = 0);
-
555 
-
560  uint16_t getIrqStatus();
-
561 
-
570  int16_t readData(uint8_t* data, size_t len) override;
-
571 
-
577  int16_t startChannelScan() override;
-
578 
-
583  int16_t getChannelScanResult() override;
-
584 
-
585  // configuration methods
-
586 
-
592  int16_t setFrequency(float freq) override;
-
593 
-
599  int16_t setBandwidth(float bw);
-
600 
-
606  int16_t setSpreadingFactor(uint8_t sf);
-
607 
-
615  int16_t setCodingRate(uint8_t cr, bool longInterleaving = false);
-
616 
-
622  int16_t setOutputPower(int8_t pwr) override;
-
623 
-
630  int16_t checkOutputPower(int8_t power, int8_t* clipped) override;
-
631 
-
637  int16_t setPreambleLength(uint32_t preambleLength);
-
638 
-
645  int16_t setBitRate(float br) override;
-
646 
-
652  int16_t setFrequencyDeviation(float freqDev) override;
-
653 
-
660  int16_t setDataShaping(uint8_t sh) override;
-
661 
-
669  int16_t setSyncWord(const uint8_t* syncWord, uint8_t len);
-
670 
-
677  int16_t setSyncWord(uint8_t syncWord, uint8_t controlBits = 0x44);
-
678 
-
686  int16_t setCRC(uint8_t len, uint32_t initial = 0x1D0F, uint16_t polynomial = 0x1021);
-
687 
-
693  int16_t setWhitening(bool enabled);
-
694 
-
700  int16_t setAccessAddress(uint32_t addr);
-
701 
-
707  int16_t setHighSensitivityMode(bool enable);
-
708 
-
714  int16_t setGainControl(uint8_t gain = 0);
-
715 
-
720  float getRSSI() override;
-
721 
-
726  float getSNR() override;
-
727 
-
732  float getFrequencyError();
-
733 
-
739  size_t getPacketLength(bool update = true) override;
-
740 
-
746  RadioLibTime_t getTimeOnAir(size_t len) override;
-
747 
-
752  int16_t implicitHeader(size_t len);
-
753 
-
759  int16_t explicitHeader();
-
760 
-
766  int16_t setEncoding(uint8_t encoding) override;
-
767 
-
769  void setRfSwitchPins(uint32_t rxEn, uint32_t txEn);
-
770 
-
772  void setRfSwitchTable(const uint32_t (&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[]);
-
773 
-
778  uint8_t randomByte() override;
-
779 
-
785  int16_t invertIQ(bool enable) override;
-
786 
-
787  #if !RADIOLIB_EXCLUDE_DIRECT_RECEIVE
-
792  void setDirectAction(void (*func)(void)) override;
-
793 
-
798  void readBit(uint32_t pin) override;
-
799  #endif
-
800 
-
801 #if !RADIOLIB_GODMODE && !RADIOLIB_LOW_LEVEL
-
802  protected:
-
803 #endif
-
804  Module* getMod() override;
-
805 
-
806  // cached LoRa parameters
-
807  float bandwidthKhz = 0;
-
808  uint8_t bandwidth = 0, spreadingFactor = 0, codingRateLoRa = 0;
-
809  uint8_t preambleLengthLoRa = 0, headerType = 0, payloadLen = 0, crcLoRa = 0;
-
810 
-
811  // SX128x SPI command implementations
-
812  uint8_t getStatus();
-
813  int16_t writeRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
-
814  int16_t readRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
-
815  int16_t writeBuffer(uint8_t* data, uint8_t numBytes, uint8_t offset = 0x00);
-
816  int16_t readBuffer(uint8_t* data, uint8_t numBytes);
-
817  int16_t setTx(uint16_t periodBaseCount = RADIOLIB_SX128X_TX_TIMEOUT_NONE, uint8_t periodBase = RADIOLIB_SX128X_PERIOD_BASE_15_625_US);
-
818  int16_t setRx(uint16_t periodBaseCount, uint8_t periodBase = RADIOLIB_SX128X_PERIOD_BASE_15_625_US);
-
819  int16_t setCad();
-
820  uint8_t getPacketType();
-
821  int16_t setRfFrequency(uint32_t frf);
-
822  int16_t setTxParams(uint8_t pwr, uint8_t rampTime = RADIOLIB_SX128X_PA_RAMP_10_US);
-
823  int16_t setBufferBaseAddress(uint8_t txBaseAddress = 0x00, uint8_t rxBaseAddress = 0x00);
-
824  int16_t setModulationParams(uint8_t modParam1, uint8_t modParam2, uint8_t modParam3);
-
825  int16_t setPacketParamsGFSK(uint8_t preambleLen, uint8_t syncLen, uint8_t syncMatch, uint8_t crcLen, uint8_t whiten, uint8_t payLen = 0xFF, uint8_t hdrType = RADIOLIB_SX128X_GFSK_FLRC_PACKET_VARIABLE);
-
826  int16_t setPacketParamsBLE(uint8_t connState, uint8_t crcLen, uint8_t bleTest, uint8_t whiten);
-
827  int16_t setPacketParamsLoRa(uint8_t preambleLen, uint8_t hdrType, uint8_t payLen, uint8_t crc, uint8_t invIQ = RADIOLIB_SX128X_LORA_IQ_STANDARD);
-
828  int16_t setDioIrqParams(uint16_t irqMask, uint16_t dio1Mask, uint16_t dio2Mask = RADIOLIB_SX128X_IRQ_NONE, uint16_t dio3Mask = RADIOLIB_SX128X_IRQ_NONE);
-
829  int16_t clearIrqStatus(uint16_t clearIrqParams = RADIOLIB_SX128X_IRQ_ALL);
-
830  int16_t setRangingRole(uint8_t role);
-
831  int16_t setPacketType(uint8_t type);
-
832 
-
833 #if !RADIOLIB_GODMODE
-
834  private:
-
835 #endif
-
836  Module* mod;
-
837 
-
838  // common low-level SPI interface
-
839  static int16_t SPIparseStatus(uint8_t in);
-
840 
-
841  // common parameters
-
842  uint8_t power = 0;
-
843 
-
844  // cached LoRa parameters
-
845  uint8_t invertIQEnabled = RADIOLIB_SX128X_LORA_IQ_STANDARD;
-
846 
-
847  // cached GFSK parameters
-
848  float modIndexReal = 0;
-
849  uint16_t bitRateKbps = 0;
-
850  uint8_t bitRate = 0, modIndex = 0, shaping = 0;
-
851  uint8_t preambleLengthGFSK = 0, syncWordLen = 0, syncWordMatch = 0, crcGFSK = 0, whitening = 0;
-
852 
-
853  // cached FLRC parameters
-
854  uint8_t codingRateFLRC = 0;
-
855 
-
856  // cached BLE parameters
-
857  uint8_t connectionState = 0, crcBLE = 0, bleTestPayload = 0;
-
858 
-
859  int16_t config(uint8_t modem);
-
860  int16_t setHeaderType(uint8_t hdrType, size_t len = 0xFF);
-
861 };
-
862 
-
863 #endif
-
864 
-
865 #endif
+
466  int16_t sleep();
+
467  int16_t sleep(bool retainConfig);
+
468 
+
473  int16_t standby() override;
+
474 
+
482  int16_t standby(uint8_t mode, bool wakeup = false);
+
483 
+
484  // interrupt methods
+
485 
+
490  void setDio1Action(void (*func)(void));
+
491 
+
495  void clearDio1Action();
+
496 
+
501  void setPacketReceivedAction(void (*func)(void)) override;
+
502 
+
506  void clearPacketReceivedAction() override;
+
507 
+
512  void setPacketSentAction(void (*func)(void)) override;
+
513 
+
517  void clearPacketSentAction() override;
+
518 
+
527  int16_t startTransmit(uint8_t* data, size_t len, uint8_t addr = 0) override;
+
528 
+
533  int16_t finishTransmit() override;
+
534 
+
541  int16_t startReceive() override;
+
542 
+
555  int16_t startReceive(uint16_t timeout, uint32_t irqFlags = RADIOLIB_SX128X_IRQ_RX_DEFAULT, uint32_t irqMask = RADIOLIB_SX128X_IRQ_RX_DONE, size_t len = 0);
+
556 
+
561  uint16_t getIrqStatus();
+
562 
+
571  int16_t readData(uint8_t* data, size_t len) override;
+
572 
+
578  int16_t startChannelScan() override;
+
579 
+
584  int16_t getChannelScanResult() override;
+
585 
+
586  // configuration methods
+
587 
+
593  int16_t setFrequency(float freq) override;
+
594 
+
600  int16_t setBandwidth(float bw);
+
601 
+
607  int16_t setSpreadingFactor(uint8_t sf);
+
608 
+
616  int16_t setCodingRate(uint8_t cr, bool longInterleaving = false);
+
617 
+
623  int16_t setOutputPower(int8_t pwr) override;
+
624 
+
631  int16_t checkOutputPower(int8_t power, int8_t* clipped) override;
+
632 
+
638  int16_t setPreambleLength(uint32_t preambleLength);
+
639 
+
646  int16_t setBitRate(float br) override;
+
647 
+
653  int16_t setFrequencyDeviation(float freqDev) override;
+
654 
+
661  int16_t setDataShaping(uint8_t sh) override;
+
662 
+
670  int16_t setSyncWord(const uint8_t* syncWord, uint8_t len);
+
671 
+
678  int16_t setSyncWord(uint8_t syncWord, uint8_t controlBits = 0x44);
+
679 
+
687  int16_t setCRC(uint8_t len, uint32_t initial = 0x1D0F, uint16_t polynomial = 0x1021);
+
688 
+
694  int16_t setWhitening(bool enabled);
+
695 
+
701  int16_t setAccessAddress(uint32_t addr);
+
702 
+
708  int16_t setHighSensitivityMode(bool enable);
+
709 
+
715  int16_t setGainControl(uint8_t gain = 0);
+
716 
+
721  float getRSSI() override;
+
722 
+
727  float getSNR() override;
+
728 
+
733  float getFrequencyError();
+
734 
+
740  size_t getPacketLength(bool update = true) override;
+
741 
+
747  RadioLibTime_t getTimeOnAir(size_t len) override;
+
748 
+
753  int16_t implicitHeader(size_t len);
+
754 
+
760  int16_t explicitHeader();
+
761 
+
767  int16_t setEncoding(uint8_t encoding) override;
+
768 
+
770  void setRfSwitchPins(uint32_t rxEn, uint32_t txEn);
+
771 
+
773  void setRfSwitchTable(const uint32_t (&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[]);
+
774 
+
779  uint8_t randomByte() override;
+
780 
+
786  int16_t invertIQ(bool enable) override;
+
787 
+
788  #if !RADIOLIB_EXCLUDE_DIRECT_RECEIVE
+
793  void setDirectAction(void (*func)(void)) override;
+
794 
+
799  void readBit(uint32_t pin) override;
+
800  #endif
+
801 
+
802 #if !RADIOLIB_GODMODE && !RADIOLIB_LOW_LEVEL
+
803  protected:
+
804 #endif
+
805  Module* getMod() override;
+
806 
+
807  // cached LoRa parameters
+
808  float bandwidthKhz = 0;
+
809  uint8_t bandwidth = 0, spreadingFactor = 0, codingRateLoRa = 0;
+
810  uint8_t preambleLengthLoRa = 0, headerType = 0, payloadLen = 0, crcLoRa = 0;
+
811 
+
812  // SX128x SPI command implementations
+
813  uint8_t getStatus();
+
814  int16_t writeRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
+
815  int16_t readRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
+
816  int16_t writeBuffer(uint8_t* data, uint8_t numBytes, uint8_t offset = 0x00);
+
817  int16_t readBuffer(uint8_t* data, uint8_t numBytes);
+
818  int16_t setTx(uint16_t periodBaseCount = RADIOLIB_SX128X_TX_TIMEOUT_NONE, uint8_t periodBase = RADIOLIB_SX128X_PERIOD_BASE_15_625_US);
+
819  int16_t setRx(uint16_t periodBaseCount, uint8_t periodBase = RADIOLIB_SX128X_PERIOD_BASE_15_625_US);
+
820  int16_t setCad();
+
821  uint8_t getPacketType();
+
822  int16_t setRfFrequency(uint32_t frf);
+
823  int16_t setTxParams(uint8_t pwr, uint8_t rampTime = RADIOLIB_SX128X_PA_RAMP_10_US);
+
824  int16_t setBufferBaseAddress(uint8_t txBaseAddress = 0x00, uint8_t rxBaseAddress = 0x00);
+
825  int16_t setModulationParams(uint8_t modParam1, uint8_t modParam2, uint8_t modParam3);
+
826  int16_t setPacketParamsGFSK(uint8_t preambleLen, uint8_t syncLen, uint8_t syncMatch, uint8_t crcLen, uint8_t whiten, uint8_t payLen = 0xFF, uint8_t hdrType = RADIOLIB_SX128X_GFSK_FLRC_PACKET_VARIABLE);
+
827  int16_t setPacketParamsBLE(uint8_t connState, uint8_t crcLen, uint8_t bleTest, uint8_t whiten);
+
828  int16_t setPacketParamsLoRa(uint8_t preambleLen, uint8_t hdrType, uint8_t payLen, uint8_t crc, uint8_t invIQ = RADIOLIB_SX128X_LORA_IQ_STANDARD);
+
829  int16_t setDioIrqParams(uint16_t irqMask, uint16_t dio1Mask, uint16_t dio2Mask = RADIOLIB_SX128X_IRQ_NONE, uint16_t dio3Mask = RADIOLIB_SX128X_IRQ_NONE);
+
830  int16_t clearIrqStatus(uint16_t clearIrqParams = RADIOLIB_SX128X_IRQ_ALL);
+
831  int16_t setRangingRole(uint8_t role);
+
832  int16_t setPacketType(uint8_t type);
+
833 
+
834 #if !RADIOLIB_GODMODE
+
835  private:
+
836 #endif
+
837  Module* mod;
+
838 
+
839  // common low-level SPI interface
+
840  static int16_t SPIparseStatus(uint8_t in);
+
841 
+
842  // common parameters
+
843  uint8_t power = 0;
+
844 
+
845  // cached LoRa parameters
+
846  uint8_t invertIQEnabled = RADIOLIB_SX128X_LORA_IQ_STANDARD;
+
847 
+
848  // cached GFSK parameters
+
849  float modIndexReal = 0;
+
850  uint16_t bitRateKbps = 0;
+
851  uint8_t bitRate = 0, modIndex = 0, shaping = 0;
+
852  uint8_t preambleLengthGFSK = 0, syncWordLen = 0, syncWordMatch = 0, crcGFSK = 0, whitening = 0;
+
853 
+
854  // cached FLRC parameters
+
855  uint8_t codingRateFLRC = 0;
+
856 
+
857  // cached BLE parameters
+
858  uint8_t connectionState = 0, crcBLE = 0, bleTestPayload = 0;
+
859 
+
860  int16_t config(uint8_t modem);
+
861  int16_t setHeaderType(uint8_t hdrType, size_t len = 0xFF);
+
862 };
+
863 
+
864 #endif
+
865 
+
866 #endif
Module
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:68
Module::RFSWITCH_MAX_PINS
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:77
PhysicalLayer
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:54
@@ -636,62 +637,62 @@ $(document).ready(function(){initNavTree('_s_x128x_8h_source.html',''); initResi
PhysicalLayer::transmit
int16_t transmit(const char *str, uint8_t addr=0)
C-string transmit method.
Definition: PhysicalLayer.cpp:52
PhysicalLayer::startTransmit
int16_t startTransmit(const char *str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:149
PhysicalLayer::receive
virtual int16_t receive(uint8_t *data, size_t len)
Binary receive method. Must be implemented in module class.
Definition: PhysicalLayer.cpp:112
-
PhysicalLayer::sleep
virtual int16_t sleep()
Sets module to sleep.
Definition: PhysicalLayer.cpp:118
SX128x
Base class for SX128x series. All derived classes for SX128x (e.g. SX1280 or SX1281) inherit from thi...
Definition: SX128x.h:350
-
SX128x::setDio1Action
void setDio1Action(void(*func)(void))
Sets interrupt service routine to call when DIO1 activates.
Definition: SX128x.cpp:460
-
SX128x::setPreambleLength
int16_t setPreambleLength(uint32_t preambleLength)
Sets preamble length for currently active modem. Allowed values range from 1 to 65535.
Definition: SX128x.cpp:799
-
SX128x::setOutputPower
int16_t setOutputPower(int8_t pwr) override
Sets output power. Allowed values are in range from -18 to 13 dBm.
Definition: SX128x.cpp:782
-
SX128x::setPacketSentAction
void setPacketSentAction(void(*func)(void)) override
Sets interrupt service routine to call when a packet is sent.
Definition: SX128x.cpp:476
-
SX128x::setDirectAction
void setDirectAction(void(*func)(void)) override
Dummy method, to ensure PhysicalLayer compatibility.
Definition: SX128x.cpp:1369
-
SX128x::getRSSI
float getRSSI() override
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition: SX128x.cpp:1174
+
SX128x::setDio1Action
void setDio1Action(void(*func)(void))
Sets interrupt service routine to call when DIO1 activates.
Definition: SX128x.cpp:464
+
SX128x::setPreambleLength
int16_t setPreambleLength(uint32_t preambleLength)
Sets preamble length for currently active modem. Allowed values range from 1 to 65535.
Definition: SX128x.cpp:803
+
SX128x::setOutputPower
int16_t setOutputPower(int8_t pwr) override
Sets output power. Allowed values are in range from -18 to 13 dBm.
Definition: SX128x.cpp:786
+
SX128x::setPacketSentAction
void setPacketSentAction(void(*func)(void)) override
Sets interrupt service routine to call when a packet is sent.
Definition: SX128x.cpp:480
+
SX128x::setDirectAction
void setDirectAction(void(*func)(void)) override
Dummy method, to ensure PhysicalLayer compatibility.
Definition: SX128x.cpp:1373
+
SX128x::getRSSI
float getRSSI() override
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition: SX128x.cpp:1178
SX128x::reset
int16_t reset(bool verify=true)
Reset method. Will reset the chip to the default state using RST pin.
Definition: SX128x.cpp:271
-
SX128x::setFrequencyDeviation
int16_t setFrequencyDeviation(float freqDev) override
Sets FSK frequency deviation. Allowed values range from 0.0 to 3200.0 kHz.
Definition: SX128x.cpp:904
+
SX128x::setFrequencyDeviation
int16_t setFrequencyDeviation(float freqDev) override
Sets FSK frequency deviation. Allowed values range from 0.0 to 3200.0 kHz.
Definition: SX128x.cpp:908
SX128x::begin
int16_t begin(float freq=2400.0, float bw=812.5, uint8_t sf=9, uint8_t cr=7, uint8_t syncWord=RADIOLIB_SX128X_SYNC_WORD_PRIVATE, int8_t pwr=10, uint16_t preambleLength=12)
Initialization method for LoRa modem.
Definition: SX128x.cpp:9
-
SX128x::getFrequencyError
float getFrequencyError()
Gets frequency error of the latest received packet.
Definition: SX128x.cpp:1218
-
SX128x::standby
int16_t standby() override
Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator)...
Definition: SX128x.cpp:443
+
SX128x::getFrequencyError
float getFrequencyError()
Gets frequency error of the latest received packet.
Definition: SX128x.cpp:1222
+
SX128x::standby
int16_t standby() override
Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator)...
Definition: SX128x.cpp:447
SX128x::beginFLRC
int16_t beginFLRC(float freq=2400.0, uint16_t br=650, uint8_t cr=3, int8_t pwr=10, uint16_t preambleLength=16, uint8_t dataShaping=RADIOLIB_SHAPING_0_5)
Initialization method for FLRC modem.
Definition: SX128x.cpp:203
SX128x::scanChannel
int16_t scanChannel() override
Performs scan for LoRa transmission in the current channel. Detects both preamble and payload.
Definition: SX128x.cpp:413
SX128x::readData
virtual int16_t readData(uint8_t *data, size_t len)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:209
-
SX128x::setGainControl
int16_t setGainControl(uint8_t gain=0)
Enables or disables receiver manual gain control.
Definition: SX128x.cpp:1138
-
SX128x::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: SX128x.cpp:1251
-
SX128x::finishTransmit
int16_t finishTransmit() override
Clean up after transmission is done.
Definition: SX128x.cpp:548
-
SX128x::invertIQ
int16_t invertIQ(bool enable) override
Enable/disable inversion of the I and Q signals.
Definition: SX128x.cpp:1354
+
SX128x::setGainControl
int16_t setGainControl(uint8_t gain=0)
Enables or disables receiver manual gain control.
Definition: SX128x.cpp:1142
+
SX128x::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: SX128x.cpp:1255
+
SX128x::finishTransmit
int16_t finishTransmit() override
Clean up after transmission is done.
Definition: SX128x.cpp:552
+
SX128x::invertIQ
int16_t invertIQ(bool enable) override
Enable/disable inversion of the I and Q signals.
Definition: SX128x.cpp:1358
SX128x::transmit
int16_t transmit(const char *str, uint8_t addr=0)
C-string transmit method.
Definition: PhysicalLayer.cpp:52
SX128x::transmitDirect
int16_t transmitDirect(uint32_t frf=0) override
Starts direct mode transmission.
Definition: SX128x.cpp:390
-
SX128x::setRfSwitchPins
void setRfSwitchPins(uint32_t rxEn, uint32_t txEn)
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: SX128x.cpp:1340
-
SX128x::checkOutputPower
int16_t checkOutputPower(int8_t power, int8_t *clipped) override
Check if output power is configurable.
Definition: SX128x.cpp:791
-
SX128x::setHighSensitivityMode
int16_t setHighSensitivityMode(bool enable)
Enables or disables receiver high sensitivity mode.
Definition: SX128x.cpp:1121
+
SX128x::setRfSwitchPins
void setRfSwitchPins(uint32_t rxEn, uint32_t txEn)
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: SX128x.cpp:1344
+
SX128x::checkOutputPower
int16_t checkOutputPower(int8_t power, int8_t *clipped) override
Check if output power is configurable.
Definition: SX128x.cpp:795
+
SX128x::setHighSensitivityMode
int16_t setHighSensitivityMode(bool enable)
Enables or disables receiver high sensitivity mode.
Definition: SX128x.cpp:1125
SX128x::beginGFSK
int16_t beginGFSK(float freq=2400.0, uint16_t br=800, float freqDev=400.0, int8_t pwr=10, uint16_t preambleLength=16)
Initialization method for GFSK modem.
Definition: SX128x.cpp:73
-
SX128x::startReceive
int16_t startReceive() override
Interrupt-driven receive method with default parameters. Implemented for compatibility with PhysicalL...
Definition: SX128x.cpp:556
-
SX128x::setEncoding
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Serves only as alias for PhysicalLayer compatibility.
Definition: SX128x.cpp:1336
-
SX128x::setWhitening
int16_t setWhitening(bool enabled)
Sets whitening parameters, not available for LoRa or FLRC modem.
Definition: SX128x.cpp:1090
-
SX128x::randomByte
uint8_t randomByte() override
Dummy random method, to ensure PhysicalLayer compatibility.
Definition: SX128x.cpp:1348
+
SX128x::startReceive
int16_t startReceive() override
Interrupt-driven receive method with default parameters. Implemented for compatibility with PhysicalL...
Definition: SX128x.cpp:560
+
SX128x::setEncoding
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Serves only as alias for PhysicalLayer compatibility.
Definition: SX128x.cpp:1340
+
SX128x::setWhitening
int16_t setWhitening(bool enabled)
Sets whitening parameters, not available for LoRa or FLRC modem.
Definition: SX128x.cpp:1094
+
SX128x::randomByte
uint8_t randomByte() override
Dummy random method, to ensure PhysicalLayer compatibility.
Definition: SX128x.cpp:1352
SX128x::startTransmit
int16_t startTransmit(const char *str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:149
-
SX128x::setAccessAddress
int16_t setAccessAddress(uint32_t addr)
Sets BLE access address.
Definition: SX128x.cpp:1110
-
SX128x::startChannelScan
int16_t startChannelScan() override
Interrupt-driven channel activity detection method. DIO1 will be activated when LoRa preamble is dete...
Definition: SX128x.cpp:636
-
SX128x::explicitHeader
int16_t explicitHeader()
Set explicit header mode for future reception/transmission.
Definition: SX128x.cpp:1332
-
SX128x::setDataShaping
int16_t setDataShaping(uint8_t sh) override
Sets time-bandwidth product of Gaussian filter applied for shaping. Allowed values are RADIOLIB_SHAPI...
Definition: SX128x.cpp:937
+
SX128x::setAccessAddress
int16_t setAccessAddress(uint32_t addr)
Sets BLE access address.
Definition: SX128x.cpp:1114
+
SX128x::startChannelScan
int16_t startChannelScan() override
Interrupt-driven channel activity detection method. DIO1 will be activated when LoRa preamble is dete...
Definition: SX128x.cpp:640
+
SX128x::explicitHeader
int16_t explicitHeader()
Set explicit header mode for future reception/transmission.
Definition: SX128x.cpp:1336
+
SX128x::setDataShaping
int16_t setDataShaping(uint8_t sh) override
Sets time-bandwidth product of Gaussian filter applied for shaping. Allowed values are RADIOLIB_SHAPI...
Definition: SX128x.cpp:941
+
SX128x::sleep
int16_t sleep()
Sets the module to sleep mode. To wake the device up, call standby().
Definition: SX128x.cpp:427
SX128x::SX128x
SX128x(Module *mod)
Default constructor.
Definition: SX128x.cpp:5
-
SX128x::setCodingRate
int16_t setCodingRate(uint8_t cr, bool longInterleaving=false)
Sets LoRa coding rate denominator. Allowed values range from 5 to 8.
Definition: SX128x.cpp:754
-
SX128x::setCRC
int16_t setCRC(uint8_t len, uint32_t initial=0x1D0F, uint16_t polynomial=0x1021)
Sets CRC configuration.
Definition: SX128x.cpp:1026
-
SX128x::clearPacketSentAction
void clearPacketSentAction() override
Clears interrupt service routine to call when a packet is sent.
Definition: SX128x.cpp:480
+
SX128x::setCodingRate
int16_t setCodingRate(uint8_t cr, bool longInterleaving=false)
Sets LoRa coding rate denominator. Allowed values range from 5 to 8.
Definition: SX128x.cpp:758
+
SX128x::setCRC
int16_t setCRC(uint8_t len, uint32_t initial=0x1D0F, uint16_t polynomial=0x1021)
Sets CRC configuration.
Definition: SX128x.cpp:1030
+
SX128x::clearPacketSentAction
void clearPacketSentAction() override
Clears interrupt service routine to call when a packet is sent.
Definition: SX128x.cpp:484
SX128x::receive
virtual int16_t receive(uint8_t *data, size_t len)
Binary receive method. Must be implemented in module class.
Definition: PhysicalLayer.cpp:112
-
SX128x::clearDio1Action
void clearDio1Action()
Clears interrupt service routine to call when DIO1 activates.
Definition: SX128x.cpp:464
-
SX128x::setFrequency
int16_t setFrequency(float freq) override
Sets carrier frequency. Allowed values are in range from 2400.0 to 2500.0 MHz.
Definition: SX128x.cpp:682
-
SX128x::getChannelScanResult
int16_t getChannelScanResult() override
Read the channel scan result.
Definition: SX128x.cpp:661
-
SX128x::implicitHeader
int16_t implicitHeader(size_t len)
Set implicit header mode for future reception/transmission.
Definition: SX128x.cpp:1328
-
SX128x::clearPacketReceivedAction
void clearPacketReceivedAction() override
Clears interrupt service routine to call when a packet is received.
Definition: SX128x.cpp:472
+
SX128x::clearDio1Action
void clearDio1Action()
Clears interrupt service routine to call when DIO1 activates.
Definition: SX128x.cpp:468
+
SX128x::setFrequency
int16_t setFrequency(float freq) override
Sets carrier frequency. Allowed values are in range from 2400.0 to 2500.0 MHz.
Definition: SX128x.cpp:686
+
SX128x::getChannelScanResult
int16_t getChannelScanResult() override
Read the channel scan result.
Definition: SX128x.cpp:665
+
SX128x::implicitHeader
int16_t implicitHeader(size_t len)
Set implicit header mode for future reception/transmission.
Definition: SX128x.cpp:1332
+
SX128x::clearPacketReceivedAction
void clearPacketReceivedAction() override
Clears interrupt service routine to call when a packet is received.
Definition: SX128x.cpp:476
SX128x::beginBLE
int16_t beginBLE(float freq=2400.0, uint16_t br=800, float freqDev=400.0, int8_t pwr=10, uint8_t dataShaping=RADIOLIB_SHAPING_0_5)
Initialization method for BLE modem.
Definition: SX128x.cpp:145
-
SX128x::setRfSwitchTable
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: SX128x.cpp:1344
-
SX128x::setBitRate
int16_t setBitRate(float br) override
Sets FSK or FLRC bit rate. Allowed values are 125, 250, 400, 500, 800, 1000, 1600 and 2000 kbps (for ...
Definition: SX128x.cpp:847
-
SX128x::setSyncWord
int16_t setSyncWord(const uint8_t *syncWord, uint8_t len)
Sets FSK/FLRC sync word in the form of array of up to 5 bytes (FSK). For FLRC modem,...
Definition: SX128x.cpp:967
-
SX128x::setPacketReceivedAction
void setPacketReceivedAction(void(*func)(void)) override
Sets interrupt service routine to call when a packet is received.
Definition: SX128x.cpp:468
-
SX128x::getSNR
float getSNR() override
Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa or ranging mode...
Definition: SX128x.cpp:1198
-
SX128x::getIrqStatus
uint16_t getIrqStatus()
Reads the current IRQ status.
Definition: SX128x.cpp:1479
-
SX128x::setSpreadingFactor
int16_t setSpreadingFactor(uint8_t sf)
Sets LoRa spreading factor. Allowed values range from 5 to 12.
Definition: SX128x.cpp:720
-
SX128x::getTimeOnAir
RadioLibTime_t getTimeOnAir(size_t len) override
Get expected time-on-air for a given size of payload.
Definition: SX128x.cpp:1264
-
SX128x::setBandwidth
int16_t setBandwidth(float bw)
Sets LoRa bandwidth. Allowed values are 203.125, 406.25, 812.5 and 1625.0 kHz.
Definition: SX128x.cpp:690
-
SX128x::readBit
void readBit(uint32_t pin) override
Dummy method, to ensure PhysicalLayer compatibility.
Definition: SX128x.cpp:1375
+
SX128x::setRfSwitchTable
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: SX128x.cpp:1348
+
SX128x::setBitRate
int16_t setBitRate(float br) override
Sets FSK or FLRC bit rate. Allowed values are 125, 250, 400, 500, 800, 1000, 1600 and 2000 kbps (for ...
Definition: SX128x.cpp:851
+
SX128x::setSyncWord
int16_t setSyncWord(const uint8_t *syncWord, uint8_t len)
Sets FSK/FLRC sync word in the form of array of up to 5 bytes (FSK). For FLRC modem,...
Definition: SX128x.cpp:971
+
SX128x::setPacketReceivedAction
void setPacketReceivedAction(void(*func)(void)) override
Sets interrupt service routine to call when a packet is received.
Definition: SX128x.cpp:472
+
SX128x::getSNR
float getSNR() override
Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa or ranging mode...
Definition: SX128x.cpp:1202
+
SX128x::getIrqStatus
uint16_t getIrqStatus()
Reads the current IRQ status.
Definition: SX128x.cpp:1483
+
SX128x::setSpreadingFactor
int16_t setSpreadingFactor(uint8_t sf)
Sets LoRa spreading factor. Allowed values range from 5 to 12.
Definition: SX128x.cpp:724
+
SX128x::getTimeOnAir
RadioLibTime_t getTimeOnAir(size_t len) override
Get expected time-on-air for a given size of payload.
Definition: SX128x.cpp:1268
+
SX128x::setBandwidth
int16_t setBandwidth(float bw)
Sets LoRa bandwidth. Allowed values are 203.125, 406.25, 812.5 and 1625.0 kHz.
Definition: SX128x.cpp:694
+
SX128x::readBit
void readBit(uint32_t pin) override
Dummy method, to ensure PhysicalLayer compatibility.
Definition: SX128x.cpp:1379
SX128x::receiveDirect
int16_t receiveDirect() override
Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as SX128x series does...
Definition: SX128x.cpp:405
RADIOLIB_SHAPING_0_5
#define RADIOLIB_SHAPING_0_5
Gaussian shaping filter, BT = 0.5.
Definition: TypeDef.h:27
RadioLibTime_t
unsigned long RadioLibTime_t
Type used for durations in RadioLib.
Definition: TypeDef.h:586
diff --git a/class_l_l_c_c68-members.html b/class_l_l_c_c68-members.html index 60525a32..8953251b 100644 --- a/class_l_l_c_c68-members.html +++ b/class_l_l_c_c68-members.html @@ -176,8 +176,8 @@ $(document).ready(function(){initNavTree('class_l_l_c_c68.html',''); initResizab setSyncWord(uint8_t *syncWord, size_t len) overrideSX126xvirtual setTCXO(float voltage, uint32_t delay=5000)SX126x setWhitening(bool enabled, uint16_t initial=0x01FF)SX126x - sleep(bool retainConfig=true)SX126x - PhysicalLayer::sleep()PhysicalLayervirtual + sleep()SX126xvirtual + sleep(bool retainConfig) (defined in SX126x)SX126x spectralScanAbort()SX126x spectralScanGetResult(uint16_t *results)SX126x spectralScanGetStatus()SX126x diff --git a/class_l_l_c_c68.html b/class_l_l_c_c68.html index df99ee16..d404d4e7 100644 --- a/class_l_l_c_c68.html +++ b/class_l_l_c_c68.html @@ -179,9 +179,12 @@ Public Member Functions int16_t scanChannel (uint8_t symbolNum, uint8_t detPeak, uint8_t detMin)  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. To wake the device up, call standby(). More...
-  +int16_t sleep () + Sets the module to sleep mode. To wake the device up, call standby(). More...
+  + +int16_t sleep (bool retainConfig) +  int16_t standby () override  Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator). More...
  @@ -440,9 +443,6 @@ void int16_t transmit (const char *str, uint8_t addr=0)  C-string transmit method. More...
  -virtual int16_t sleep () - Sets module to sleep. More...
-  virtual int16_t standby (uint8_t mode)  Sets module to a specific standby mode. More...
  diff --git a/class_l_r1110-members.html b/class_l_r1110-members.html index a73e56a9..f88ed263 100644 --- a/class_l_r1110-members.html +++ b/class_l_r1110-members.html @@ -173,8 +173,8 @@ $(document).ready(function(){initNavTree('class_l_r1110.html',''); initResizable setTCXO(float voltage, uint32_t delay=5000)LR11x0 setWhitening(bool enabled, uint16_t initial=0x01FF)LR11x0 setWiFiScanAction(void(*func)(void))LR11x0 - sleep(bool retainConfig=true, uint32_t sleepTime=0)LR11x0 - PhysicalLayer::sleep()PhysicalLayervirtual + sleep()LR11x0virtual + sleep(bool retainConfig, uint32_t sleepTime) (defined in LR11x0)LR11x0 standby() overrideLR11x0virtual standby(uint8_t mode, bool wakeup=true)LR11x0 PhysicalLayer::standby(uint8_t mode)PhysicalLayervirtual diff --git a/class_l_r1110.html b/class_l_r1110.html index 8d4fd149..0afcbea7 100644 --- a/class_l_r1110.html +++ b/class_l_r1110.html @@ -165,9 +165,12 @@ Public Member Functions int16_t standby (uint8_t mode, bool wakeup=true)  Sets the module to standby mode. More...
  -int16_t sleep (bool retainConfig=true, uint32_t sleepTime=0) - Sets the module to sleep mode. To wake the device up, call standby(). More...
-  +int16_t sleep () + Sets the module to sleep mode. To wake the device up, call standby(). More...
+  + +int16_t sleep (bool retainConfig, uint32_t sleepTime) +  void setIrqAction (void(*func)(void))  Sets interrupt service routine to call when IRQ1 activates. More...
  @@ -383,9 +386,6 @@ void int16_t transmit (const char *str, uint8_t addr=0)  C-string transmit method. More...
  -virtual int16_t sleep () - Sets module to sleep. More...
-  virtual int16_t standby (uint8_t mode)  Sets module to a specific standby mode. More...
  diff --git a/class_l_r1120-members.html b/class_l_r1120-members.html index 17a6ebd0..243a975b 100644 --- a/class_l_r1120-members.html +++ b/class_l_r1120-members.html @@ -173,8 +173,8 @@ $(document).ready(function(){initNavTree('class_l_r1120.html',''); initResizable setTCXO(float voltage, uint32_t delay=5000)LR11x0 setWhitening(bool enabled, uint16_t initial=0x01FF)LR11x0 setWiFiScanAction(void(*func)(void))LR11x0 - sleep(bool retainConfig=true, uint32_t sleepTime=0)LR11x0 - PhysicalLayer::sleep()PhysicalLayervirtual + sleep()LR11x0virtual + sleep(bool retainConfig, uint32_t sleepTime) (defined in LR11x0)LR11x0 standby() overrideLR11x0virtual standby(uint8_t mode, bool wakeup=true)LR11x0 PhysicalLayer::standby(uint8_t mode)PhysicalLayervirtual diff --git a/class_l_r1120.html b/class_l_r1120.html index 14b04746..1fa53dd8 100644 --- a/class_l_r1120.html +++ b/class_l_r1120.html @@ -166,9 +166,12 @@ Public Member Functions int16_t standby (uint8_t mode, bool wakeup=true)  Sets the module to standby mode. More...
  -int16_t sleep (bool retainConfig=true, uint32_t sleepTime=0) - Sets the module to sleep mode. To wake the device up, call standby(). More...
-  +int16_t sleep () + Sets the module to sleep mode. To wake the device up, call standby(). More...
+  + +int16_t sleep (bool retainConfig, uint32_t sleepTime) +  void setIrqAction (void(*func)(void))  Sets interrupt service routine to call when IRQ1 activates. More...
  @@ -384,9 +387,6 @@ void int16_t transmit (const char *str, uint8_t addr=0)  C-string transmit method. More...
  -virtual int16_t sleep () - Sets module to sleep. More...
-  virtual int16_t standby (uint8_t mode)  Sets module to a specific standby mode. More...
  diff --git a/class_l_r1121-members.html b/class_l_r1121-members.html index c9e6c8df..33970c90 100644 --- a/class_l_r1121-members.html +++ b/class_l_r1121-members.html @@ -174,8 +174,8 @@ $(document).ready(function(){initNavTree('class_l_r1121.html',''); initResizable setTCXO(float voltage, uint32_t delay=5000)LR11x0 setWhitening(bool enabled, uint16_t initial=0x01FF)LR11x0 setWiFiScanAction(void(*func)(void))LR11x0 - sleep(bool retainConfig=true, uint32_t sleepTime=0)LR11x0 - PhysicalLayer::sleep()PhysicalLayervirtual + sleep()LR11x0virtual + sleep(bool retainConfig, uint32_t sleepTime) (defined in LR11x0)LR11x0 standby() overrideLR11x0virtual standby(uint8_t mode, bool wakeup=true)LR11x0 PhysicalLayer::standby(uint8_t mode)PhysicalLayervirtual diff --git a/class_l_r1121.html b/class_l_r1121.html index fcc0aa69..81320d7c 100644 --- a/class_l_r1121.html +++ b/class_l_r1121.html @@ -170,9 +170,12 @@ Public Member Functions int16_t standby (uint8_t mode, bool wakeup=true)  Sets the module to standby mode. More...
  -int16_t sleep (bool retainConfig=true, uint32_t sleepTime=0) - Sets the module to sleep mode. To wake the device up, call standby(). More...
-  +int16_t sleep () + Sets the module to sleep mode. To wake the device up, call standby(). More...
+  + +int16_t sleep (bool retainConfig, uint32_t sleepTime) +  void setIrqAction (void(*func)(void))  Sets interrupt service routine to call when IRQ1 activates. More...
  @@ -388,9 +391,6 @@ void int16_t transmit (const char *str, uint8_t addr=0)  C-string transmit method. More...
  -virtual int16_t sleep () - Sets module to sleep. More...
-  virtual int16_t standby (uint8_t mode)  Sets module to a specific standby mode. More...
  diff --git a/class_l_r11x0-members.html b/class_l_r11x0-members.html index eec1cea7..1bd824fd 100644 --- a/class_l_r11x0-members.html +++ b/class_l_r11x0-members.html @@ -168,8 +168,8 @@ $(document).ready(function(){initNavTree('class_l_r11x0.html',''); initResizable setTCXO(float voltage, uint32_t delay=5000)LR11x0 setWhitening(bool enabled, uint16_t initial=0x01FF)LR11x0 setWiFiScanAction(void(*func)(void))LR11x0 - sleep(bool retainConfig=true, uint32_t sleepTime=0)LR11x0 - PhysicalLayer::sleep()PhysicalLayervirtual + sleep()LR11x0virtual + sleep(bool retainConfig, uint32_t sleepTime) (defined in LR11x0)LR11x0 standby() overrideLR11x0virtual standby(uint8_t mode, bool wakeup=true)LR11x0 PhysicalLayer::standby(uint8_t mode)PhysicalLayervirtual diff --git a/class_l_r11x0.html b/class_l_r11x0.html index 1a4031a5..27cc798b 100644 --- a/class_l_r11x0.html +++ b/class_l_r11x0.html @@ -149,9 +149,12 @@ Public Member Functions int16_t standby (uint8_t mode, bool wakeup=true)  Sets the module to standby mode. More...
  -int16_t sleep (bool retainConfig=true, uint32_t sleepTime=0) - Sets the module to sleep mode. To wake the device up, call standby(). More...
-  +int16_t sleep () + Sets the module to sleep mode. To wake the device up, call standby(). More...
+  + +int16_t sleep (bool retainConfig, uint32_t sleepTime) +  void setIrqAction (void(*func)(void))  Sets interrupt service routine to call when IRQ1 activates. More...
  @@ -367,9 +370,6 @@ void int16_t transmit (const char *str, uint8_t addr=0)  C-string transmit method. More...
  -virtual int16_t sleep () - Sets module to sleep. More...
-  virtual int16_t standby (uint8_t mode)  Sets module to a specific standby mode. More...
  @@ -2594,30 +2594,27 @@ bool  -

◆ sleep()

+ +

◆ sleep()

+ + + + + +
- - - - - + - - - - - - -
int16_t LR11x0::sleep (bool retainConfig = true,
) uint32_t sleepTime = 0 
)
+
+virtual

Sets the module to sleep mode. To wake the device up, call standby().

@@ -2630,6 +2627,8 @@ bool 
Returns
Status Codes
+

Reimplemented from PhysicalLayer.

+
diff --git a/class_l_r11x0.js b/class_l_r11x0.js index dbcb9082..3460bb87 100644 --- a/class_l_r11x0.js +++ b/class_l_r11x0.js @@ -65,7 +65,8 @@ var class_l_r11x0 = [ "setTCXO", "class_l_r11x0.html#a971b4ccd1d5479e9d72aa9649e8fef55", null ], [ "setWhitening", "class_l_r11x0.html#adcde55b8660c24cf5783942a4132786d", null ], [ "setWiFiScanAction", "class_l_r11x0.html#aff6060e116701c60e078d3d930723b4b", null ], - [ "sleep", "class_l_r11x0.html#a64d70a3341a6a8b32f9871cdcb719733", null ], + [ "sleep", "class_l_r11x0.html#ab0d389f1ffaccd7bf97e1e1d52c6136e", null ], + [ "sleep", "class_l_r11x0.html#ad2786a2f17af5769c772ebc73df88e1f", null ], [ "standby", "class_l_r11x0.html#a74c3f3f8409f1fd0f41347b7d3c7dc24", null ], [ "standby", "class_l_r11x0.html#a2d682ec2ca0ddf4da41a93dd8e728665", null ], [ "startChannelScan", "class_l_r11x0.html#a4f3bc362530b85dd643669705f03998d", null ], diff --git a/class_physical_layer.html b/class_physical_layer.html index a5111bae..eda9f1f7 100644 --- a/class_physical_layer.html +++ b/class_physical_layer.html @@ -1747,7 +1747,7 @@ class LoRaWANNode

Sets module to sleep.

Returns
Status Codes
-

Reimplemented in SX127x, Si443x, RF69, and nRF24.

+

Reimplemented in SX127x, Si443x, RF69, nRF24, SX128x, SX126x, and LR11x0.

diff --git a/class_s_t_m32_w_lx-members.html b/class_s_t_m32_w_lx-members.html index 9c4c5cb7..5d5be549 100644 --- a/class_s_t_m32_w_lx-members.html +++ b/class_s_t_m32_w_lx-members.html @@ -182,8 +182,8 @@ $(document).ready(function(){initNavTree('class_s_t_m32_w_lx.html',''); initResi setSyncWord(uint8_t *syncWord, size_t len) overrideSX126xvirtual setTCXO(float voltage, uint32_t delay=5000)SX126x setWhitening(bool enabled, uint16_t initial=0x01FF)SX126x - sleep(bool retainConfig=true)SX126x - PhysicalLayer::sleep()PhysicalLayervirtual + sleep()SX126xvirtual + sleep(bool retainConfig) (defined in SX126x)SX126x spectralScanAbort()SX126x spectralScanGetResult(uint16_t *results)SX126x spectralScanGetStatus()SX126x diff --git a/class_s_t_m32_w_lx.html b/class_s_t_m32_w_lx.html index 5221b55a..3de491c3 100644 --- a/class_s_t_m32_w_lx.html +++ b/class_s_t_m32_w_lx.html @@ -216,9 +216,12 @@ void int16_t scanChannel (uint8_t symbolNum, uint8_t detPeak, uint8_t detMin)  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. To wake the device up, call standby(). More...
-  +int16_t sleep () + Sets the module to sleep mode. To wake the device up, call standby(). More...
+  + +int16_t sleep (bool retainConfig) +  int16_t standby () override  Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator). More...
  @@ -477,9 +480,6 @@ void int16_t transmit (const char *str, uint8_t addr=0)  C-string transmit method. More...
  -virtual int16_t sleep () - Sets module to sleep. More...
-  virtual int16_t standby (uint8_t mode)  Sets module to a specific standby mode. More...
  diff --git a/class_s_x1261-members.html b/class_s_x1261-members.html index 9c324554..d817039a 100644 --- a/class_s_x1261-members.html +++ b/class_s_x1261-members.html @@ -175,8 +175,8 @@ $(document).ready(function(){initNavTree('class_s_x1261.html',''); initResizable setSyncWord(uint8_t *syncWord, size_t len) overrideSX126xvirtual setTCXO(float voltage, uint32_t delay=5000)SX126x setWhitening(bool enabled, uint16_t initial=0x01FF)SX126x - sleep(bool retainConfig=true)SX126x - PhysicalLayer::sleep()PhysicalLayervirtual + sleep()SX126xvirtual + sleep(bool retainConfig) (defined in SX126x)SX126x spectralScanAbort()SX126x spectralScanGetResult(uint16_t *results)SX126x spectralScanGetStatus()SX126x diff --git a/class_s_x1261.html b/class_s_x1261.html index a980419d..174b6c42 100644 --- a/class_s_x1261.html +++ b/class_s_x1261.html @@ -167,9 +167,12 @@ Public Member Functions int16_t scanChannel (uint8_t symbolNum, uint8_t detPeak, uint8_t detMin)  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. To wake the device up, call standby(). More...
-  +int16_t sleep () + Sets the module to sleep mode. To wake the device up, call standby(). More...
+  + +int16_t sleep (bool retainConfig) +  int16_t standby () override  Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator). More...
  @@ -428,9 +431,6 @@ void int16_t transmit (const char *str, uint8_t addr=0)  C-string transmit method. More...
  -virtual int16_t sleep () - Sets module to sleep. More...
-  virtual int16_t standby (uint8_t mode)  Sets module to a specific standby mode. More...
  diff --git a/class_s_x1262-members.html b/class_s_x1262-members.html index 222900cb..1fc2cc38 100644 --- a/class_s_x1262-members.html +++ b/class_s_x1262-members.html @@ -175,8 +175,8 @@ $(document).ready(function(){initNavTree('class_s_x1262.html',''); initResizable setSyncWord(uint8_t *syncWord, size_t len) overrideSX126xvirtual setTCXO(float voltage, uint32_t delay=5000)SX126x setWhitening(bool enabled, uint16_t initial=0x01FF)SX126x - sleep(bool retainConfig=true)SX126x - PhysicalLayer::sleep()PhysicalLayervirtual + sleep()SX126xvirtual + sleep(bool retainConfig) (defined in SX126x)SX126x spectralScanAbort()SX126x spectralScanGetResult(uint16_t *results)SX126x spectralScanGetStatus()SX126x diff --git a/class_s_x1262.html b/class_s_x1262.html index 322fc4fc..1e70a7a9 100644 --- a/class_s_x1262.html +++ b/class_s_x1262.html @@ -162,9 +162,12 @@ Public Member Functions int16_t scanChannel (uint8_t symbolNum, uint8_t detPeak, uint8_t detMin)  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. To wake the device up, call standby(). More...
-  +int16_t sleep () + Sets the module to sleep mode. To wake the device up, call standby(). More...
+  + +int16_t sleep (bool retainConfig) +  int16_t standby () override  Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator). More...
  @@ -423,9 +426,6 @@ void int16_t transmit (const char *str, uint8_t addr=0)  C-string transmit method. More...
  -virtual int16_t sleep () - Sets module to sleep. More...
-  virtual int16_t standby (uint8_t mode)  Sets module to a specific standby mode. More...
  diff --git a/class_s_x1268-members.html b/class_s_x1268-members.html index 7b40e82f..f7651cb1 100644 --- a/class_s_x1268-members.html +++ b/class_s_x1268-members.html @@ -175,8 +175,8 @@ $(document).ready(function(){initNavTree('class_s_x1268.html',''); initResizable setSyncWord(uint8_t *syncWord, size_t len) overrideSX126xvirtual setTCXO(float voltage, uint32_t delay=5000)SX126x setWhitening(bool enabled, uint16_t initial=0x01FF)SX126x - sleep(bool retainConfig=true)SX126x - PhysicalLayer::sleep()PhysicalLayervirtual + sleep()SX126xvirtual + sleep(bool retainConfig) (defined in SX126x)SX126x spectralScanAbort()SX126x spectralScanGetResult(uint16_t *results)SX126x spectralScanGetStatus()SX126x diff --git a/class_s_x1268.html b/class_s_x1268.html index 2e2f8a70..273e83ae 100644 --- a/class_s_x1268.html +++ b/class_s_x1268.html @@ -159,9 +159,12 @@ Public Member Functions int16_t scanChannel (uint8_t symbolNum, uint8_t detPeak, uint8_t detMin)  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. To wake the device up, call standby(). More...
-  +int16_t sleep () + Sets the module to sleep mode. To wake the device up, call standby(). More...
+  + +int16_t sleep (bool retainConfig) +  int16_t standby () override  Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator). More...
  @@ -420,9 +423,6 @@ void int16_t transmit (const char *str, uint8_t addr=0)  C-string transmit method. More...
  -virtual int16_t sleep () - Sets module to sleep. More...
-  virtual int16_t standby (uint8_t mode)  Sets module to a specific standby mode. More...
  diff --git a/class_s_x126x-members.html b/class_s_x126x-members.html index 0ab0cd49..c2d1f694 100644 --- a/class_s_x126x-members.html +++ b/class_s_x126x-members.html @@ -172,8 +172,8 @@ $(document).ready(function(){initNavTree('class_s_x126x.html',''); initResizable setSyncWord(uint8_t *syncWord, size_t len) overrideSX126xvirtual setTCXO(float voltage, uint32_t delay=5000)SX126x setWhitening(bool enabled, uint16_t initial=0x01FF)SX126x - sleep(bool retainConfig=true)SX126x - PhysicalLayer::sleep()PhysicalLayervirtual + sleep()SX126xvirtual + sleep(bool retainConfig) (defined in SX126x)SX126x spectralScanAbort()SX126x spectralScanGetResult(uint16_t *results)SX126x spectralScanGetStatus()SX126x diff --git a/class_s_x126x.html b/class_s_x126x.html index c5978084..c2585280 100644 --- a/class_s_x126x.html +++ b/class_s_x126x.html @@ -142,9 +142,12 @@ Public Member Functions int16_t scanChannel (uint8_t symbolNum, uint8_t detPeak, uint8_t detMin)  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. To wake the device up, call standby(). More...
-  +int16_t sleep () + Sets the module to sleep mode. To wake the device up, call standby(). More...
+  + +int16_t sleep (bool retainConfig) +  int16_t standby () override  Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator). More...
  @@ -403,9 +406,6 @@ void int16_t transmit (const char *str, uint8_t addr=0)  C-string transmit method. More...
  -virtual int16_t sleep () - Sets module to sleep. More...
-  virtual int16_t standby (uint8_t mode)  Sets module to a specific standby mode. More...
  @@ -2716,20 +2716,27 @@ bool  -

◆ sleep()

+ +

◆ sleep()

+ + + + + +
- - +
int16_t SX126x::sleep (bool retainConfig = true))
+
+virtual

Sets the module to sleep mode. To wake the device up, call standby().

@@ -2741,6 +2748,8 @@ bool 
Returns
Status Codes
+

Reimplemented from PhysicalLayer.

+
diff --git a/class_s_x126x.js b/class_s_x126x.js index b2db4dd2..83dbe2f3 100644 --- a/class_s_x126x.js +++ b/class_s_x126x.js @@ -71,7 +71,8 @@ var class_s_x126x = [ "setSyncWord", "class_s_x126x.html#a9d92dce566f8aefa836fe8f332e9560f", null ], [ "setTCXO", "class_s_x126x.html#a57bee6f4b3a3b7ec646ac8de347ee0d6", null ], [ "setWhitening", "class_s_x126x.html#ae500bad45638a47264b7e5955a93107d", null ], - [ "sleep", "class_s_x126x.html#afb5509f0705cdd971065251ed6b2fb4e", null ], + [ "sleep", "class_s_x126x.html#aecdecd788d254fdea92fde5037693fef", null ], + [ "sleep", "class_s_x126x.html#aad7e4df3e1ca20d524e1d776047e1013", null ], [ "spectralScanAbort", "class_s_x126x.html#a865397e1cca38bec2d055c047825ea07", null ], [ "spectralScanGetResult", "class_s_x126x.html#ae473773e5bed4b08452e80311bdb26f2", null ], [ "spectralScanGetStatus", "class_s_x126x.html#a5595fff99d76d50d711b8cdad98527c4", null ], diff --git a/class_s_x1280-members.html b/class_s_x1280-members.html index 1c64943e..cd230092 100644 --- a/class_s_x1280-members.html +++ b/class_s_x1280-members.html @@ -160,8 +160,8 @@ $(document).ready(function(){initNavTree('class_s_x1280.html',''); initResizable setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)SX128x PhysicalLayer::setSyncWord(uint8_t *sync, size_t len)PhysicalLayervirtual setWhitening(bool enabled)SX128x - sleep(bool retainConfig=true)SX128x - PhysicalLayer::sleep()PhysicalLayervirtual + sleep()SX128xvirtual + sleep(bool retainConfig) (defined in SX128x)SX128x standby() overrideSX128xvirtual standby(uint8_t mode, bool wakeup=false)SX128x PhysicalLayer::standby(uint8_t mode)PhysicalLayervirtual diff --git a/class_s_x1280.html b/class_s_x1280.html index 6fbc606f..40cc0e1f 100644 --- a/class_s_x1280.html +++ b/class_s_x1280.html @@ -159,9 +159,12 @@ Public Member Functions int16_t scanChannel () override  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. To wake the device up, call standby(). More...
-  +int16_t sleep () + Sets the module to sleep mode. To wake the device up, call standby(). More...
+  + +int16_t sleep (bool retainConfig) +  int16_t standby () override  Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator). More...
  @@ -331,9 +334,6 @@ void int16_t transmit (const char *str, uint8_t addr=0)  C-string transmit method. More...
  -virtual int16_t sleep () - Sets module to sleep. More...
-  virtual int16_t standby (uint8_t mode)  Sets module to a specific standby mode. More...
  diff --git a/class_s_x1281-members.html b/class_s_x1281-members.html index b2490d1f..1c52dd93 100644 --- a/class_s_x1281-members.html +++ b/class_s_x1281-members.html @@ -158,8 +158,8 @@ $(document).ready(function(){initNavTree('class_s_x1281.html',''); initResizable setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)SX128x PhysicalLayer::setSyncWord(uint8_t *sync, size_t len)PhysicalLayervirtual setWhitening(bool enabled)SX128x - sleep(bool retainConfig=true)SX128x - PhysicalLayer::sleep()PhysicalLayervirtual + sleep()SX128xvirtual + sleep(bool retainConfig) (defined in SX128x)SX128x standby() overrideSX128xvirtual standby(uint8_t mode, bool wakeup=false)SX128x PhysicalLayer::standby(uint8_t mode)PhysicalLayervirtual diff --git a/class_s_x1281.html b/class_s_x1281.html index 9ee9c918..4c8a1191 100644 --- a/class_s_x1281.html +++ b/class_s_x1281.html @@ -146,9 +146,12 @@ Public Member Functions int16_t scanChannel () override  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. To wake the device up, call standby(). More...
-  +int16_t sleep () + Sets the module to sleep mode. To wake the device up, call standby(). More...
+  + +int16_t sleep (bool retainConfig) +  int16_t standby () override  Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator). More...
  @@ -318,9 +321,6 @@ void int16_t transmit (const char *str, uint8_t addr=0)  C-string transmit method. More...
  -virtual int16_t sleep () - Sets module to sleep. More...
-  virtual int16_t standby (uint8_t mode)  Sets module to a specific standby mode. More...
  diff --git a/class_s_x1282-members.html b/class_s_x1282-members.html index c9437a76..2849c481 100644 --- a/class_s_x1282-members.html +++ b/class_s_x1282-members.html @@ -160,8 +160,8 @@ $(document).ready(function(){initNavTree('class_s_x1282.html',''); initResizable setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)SX128x PhysicalLayer::setSyncWord(uint8_t *sync, size_t len)PhysicalLayervirtual setWhitening(bool enabled)SX128x - sleep(bool retainConfig=true)SX128x - PhysicalLayer::sleep()PhysicalLayervirtual + sleep()SX128xvirtual + sleep(bool retainConfig) (defined in SX128x)SX128x standby() overrideSX128xvirtual standby(uint8_t mode, bool wakeup=false)SX128x PhysicalLayer::standby(uint8_t mode)PhysicalLayervirtual diff --git a/class_s_x1282.html b/class_s_x1282.html index 05e22ec7..a8bf6b75 100644 --- a/class_s_x1282.html +++ b/class_s_x1282.html @@ -163,9 +163,12 @@ Public Member Functions int16_t scanChannel () override  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. To wake the device up, call standby(). More...
-  +int16_t sleep () + Sets the module to sleep mode. To wake the device up, call standby(). More...
+  + +int16_t sleep (bool retainConfig) +  int16_t standby () override  Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator). More...
  @@ -335,9 +338,6 @@ void int16_t transmit (const char *str, uint8_t addr=0)  C-string transmit method. More...
  -virtual int16_t sleep () - Sets module to sleep. More...
-  virtual int16_t standby (uint8_t mode)  Sets module to a specific standby mode. More...
  diff --git a/class_s_x128x-members.html b/class_s_x128x-members.html index 95cd9c47..9007854c 100644 --- a/class_s_x128x-members.html +++ b/class_s_x128x-members.html @@ -158,8 +158,8 @@ $(document).ready(function(){initNavTree('class_s_x128x.html',''); initResizable setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)SX128x PhysicalLayer::setSyncWord(uint8_t *sync, size_t len)PhysicalLayervirtual setWhitening(bool enabled)SX128x - sleep(bool retainConfig=true)SX128x - PhysicalLayer::sleep()PhysicalLayervirtual + sleep()SX128xvirtual + sleep(bool retainConfig) (defined in SX128x)SX128x standby() overrideSX128xvirtual standby(uint8_t mode, bool wakeup=false)SX128x PhysicalLayer::standby(uint8_t mode)PhysicalLayervirtual diff --git a/class_s_x128x.html b/class_s_x128x.html index b795be56..c617d1d1 100644 --- a/class_s_x128x.html +++ b/class_s_x128x.html @@ -142,9 +142,12 @@ Public Member Functions int16_t scanChannel () override  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. To wake the device up, call standby(). More...
-  +int16_t sleep () + Sets the module to sleep mode. To wake the device up, call standby(). More...
+  + +int16_t sleep (bool retainConfig) +  int16_t standby () override  Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator). More...
  @@ -314,9 +317,6 @@ void int16_t transmit (const char *str, uint8_t addr=0)  C-string transmit method. More...
  -virtual int16_t sleep () - Sets module to sleep. More...
-  virtual int16_t standby (uint8_t mode)  Sets module to a specific standby mode. More...
  @@ -2150,20 +2150,27 @@ virtual void  - -

◆ sleep()

+ +

◆ sleep()

+ + + + + +
- - +
int16_t SX128x::sleep (bool retainConfig = true))
+
+virtual

Sets the module to sleep mode. To wake the device up, call standby().

@@ -2175,6 +2182,8 @@ virtual void 
Returns
Status Codes
+

Reimplemented from PhysicalLayer.

+
diff --git a/class_s_x128x.js b/class_s_x128x.js index 854763ab..c4aa3ebe 100644 --- a/class_s_x128x.js +++ b/class_s_x128x.js @@ -52,7 +52,8 @@ var class_s_x128x = [ "setSyncWord", "class_s_x128x.html#ad9584464d2e4cc09686cf4e83e65d3e0", null ], [ "setSyncWord", "class_s_x128x.html#a1bef6b6f3058be6b1681c78334342bc1", null ], [ "setWhitening", "class_s_x128x.html#a8b3eea268f21bf911b6eaf37c5eb0b5f", null ], - [ "sleep", "class_s_x128x.html#a1d15e13e15b060ddbbe84257d5fcb66f", null ], + [ "sleep", "class_s_x128x.html#a9bf5f068064539c8421a4a20cc3f89ab", null ], + [ "sleep", "class_s_x128x.html#a98ef7dc21647642b40baf8c0194788c4", null ], [ "standby", "class_s_x128x.html#a2be8cc6c3b61b59cb6a6ca4f6a030b45", null ], [ "standby", "class_s_x128x.html#a389aab93e24ec8c7cc9c14de90e5dfae", null ], [ "startChannelScan", "class_s_x128x.html#a948156af6e886bc46a6c6c5fb10a087a", null ], diff --git a/functions_func_s.html b/functions_func_s.html index ca9f07fa..e4304800 100644 --- a/functions_func_s.html +++ b/functions_func_s.html @@ -584,14 +584,14 @@ $(document).ready(function(){initNavTree('functions_func_s.html',''); initResiza : Si443x
  • sleep() -: LR11x0 +: LR11x0 , nRF24 , PhysicalLayer , RF69 , Si443x -, SX126x +, SX126x , SX127x -, SX128x +, SX128x
  • spectralScanAbort() : SX126x diff --git a/functions_s.html b/functions_s.html index 369f9597..f8608576 100644 --- a/functions_s.html +++ b/functions_s.html @@ -599,14 +599,14 @@ $(document).ready(function(){initNavTree('functions_s.html',''); initResizable() : RadioLibCRC
  • sleep() -: LR11x0 +: LR11x0 , nRF24 , PhysicalLayer , RF69 , Si443x -, SX126x +, SX126x , SX127x -, SX128x +, SX128x
  • spectralScanAbort() : SX126x diff --git a/navtreedata.js b/navtreedata.js index dbe847bd..48758d5f 100644 --- a/navtreedata.js +++ b/navtreedata.js @@ -51,10 +51,10 @@ var NAVTREEINDEX = [ "_a_f_s_k_8h_source.html", "class_l_r11x0.html#a1ec81f3625fdc8a3ef6c54a3804c3aa9", -"class_r_f69.html#a15fafb6c24a8b5721623be447628bbaa", -"class_s_x126x.html#a56f88f6a2b88ae6dbd3ad04b1950e7b2", -"class_s_x128x.html#a1bc3372c47a4e3c81ef15bee448ba6b6", -"functions_vars.html" +"class_r_f69.html#a0de2a07f264839cda945faebf7319e0e", +"class_s_x126x.html#a5595fff99d76d50d711b8cdad98527c4", +"class_s_x128x.html#a0759fb31b3ce5bf1c832259c9c2245ed", +"functions_type.html" ]; var SYNCONMSG = 'click to disable panel synchronisation'; diff --git a/navtreeindex1.js b/navtreeindex1.js index 0a7a8ed7..544b1b85 100644 --- a/navtreeindex1.js +++ b/navtreeindex1.js @@ -5,22 +5,22 @@ var NAVTREEINDEX1 = "class_l_r11x0.html#a25f5ee68b3c2638ae613c87ed1c3fc64":[3,0,27,57], "class_l_r11x0.html#a260c7f4ee4739e532ddb465a276205d3":[3,0,27,4], "class_l_r11x0.html#a288bcc309d3676bc0bbe620b7d89d994":[3,0,27,37], -"class_l_r11x0.html#a2d682ec2ca0ddf4da41a93dd8e728665":[3,0,27,67], -"class_l_r11x0.html#a3498e0e621f341e415145879989e0948":[3,0,27,75], +"class_l_r11x0.html#a2d682ec2ca0ddf4da41a93dd8e728665":[3,0,27,68], +"class_l_r11x0.html#a3498e0e621f341e415145879989e0948":[3,0,27,76], "class_l_r11x0.html#a3563453988a83d22dd07d4691543a300":[3,0,27,32], "class_l_r11x0.html#a3693359e5d106d6f57c23247c528cdd5":[3,0,27,13], "class_l_r11x0.html#a377c287f18c939c2b4da3241d8329e58":[3,0,27,35], -"class_l_r11x0.html#a3a1de95be55f7ecc1d26a7aa7983cdba":[3,0,27,78], -"class_l_r11x0.html#a3ccfd35d26960457214d2a0192d6b312":[3,0,27,82], -"class_l_r11x0.html#a3dd42f8d5569487ea74f004ca652a709":[3,0,27,77], +"class_l_r11x0.html#a3a1de95be55f7ecc1d26a7aa7983cdba":[3,0,27,79], +"class_l_r11x0.html#a3ccfd35d26960457214d2a0192d6b312":[3,0,27,83], +"class_l_r11x0.html#a3dd42f8d5569487ea74f004ca652a709":[3,0,27,78], "class_l_r11x0.html#a3f85d48547ebec0f5e4f2678f3213bc5":[3,0,27,3], "class_l_r11x0.html#a43318bfbed2be4a46e0b7e678d2e4d23":[3,0,27,1], "class_l_r11x0.html#a457f5dfe25385a329127f07abc4631a6":[3,0,27,25], "class_l_r11x0.html#a49116d006b60128fe6f73a6a868a6d18":[3,0,27,49], -"class_l_r11x0.html#a492b2d057dd803c3884fa1adc8e22534":[3,0,27,76], +"class_l_r11x0.html#a492b2d057dd803c3884fa1adc8e22534":[3,0,27,77], "class_l_r11x0.html#a4d18ad719be79c083f2b0ce77bbaa448":[3,0,27,5], -"class_l_r11x0.html#a4f3bc362530b85dd643669705f03998d":[3,0,27,68], -"class_l_r11x0.html#a548ab2acdf0e2a6c621be3a267119fcd":[3,0,27,74], +"class_l_r11x0.html#a4f3bc362530b85dd643669705f03998d":[3,0,27,69], +"class_l_r11x0.html#a548ab2acdf0e2a6c621be3a267119fcd":[3,0,27,75], "class_l_r11x0.html#a549ecc907732bca96dab27c433928740":[3,0,27,53], "class_l_r11x0.html#a551b82787288b0b14e4d3124e6744dc3":[3,0,27,44], "class_l_r11x0.html#a562f34a054e3374b812556df3b6eb421":[3,0,27,0], @@ -30,27 +30,27 @@ var NAVTREEINDEX1 = "class_l_r11x0.html#a5df4c1ed45bf59aa25bc400bcb5dc1ba":[3,0,27,15], "class_l_r11x0.html#a5ef83caa291e2d310d260a8ea140bc8e":[3,0,27,26], "class_l_r11x0.html#a605f5c74ce523abad256866abe133d2e":[3,0,27,51], -"class_l_r11x0.html#a64d70a3341a6a8b32f9871cdcb719733":[3,0,27,65], "class_l_r11x0.html#a6501ef362df1a5b71927cfe4e43c202d":[3,0,27,59], "class_l_r11x0.html#a681b20613f9213e98096f0407f8e418d":[3,0,27,6], "class_l_r11x0.html#a6a3034c91f5bce70c853ab1620725b3c":[3,0,27,38], "class_l_r11x0.html#a6cd2b2363501b2de064c9d1f32fabaa3":[3,0,27,22], -"class_l_r11x0.html#a74c3f3f8409f1fd0f41347b7d3c7dc24":[3,0,27,66], +"class_l_r11x0.html#a74c3f3f8409f1fd0f41347b7d3c7dc24":[3,0,27,67], "class_l_r11x0.html#a7ffa48f1b6aaaa3f48e4b51f8ada59d8":[3,0,27,60], "class_l_r11x0.html#a89b16d2231f588b67dc3aab0c0a467f4":[3,0,27,31], "class_l_r11x0.html#a8ae178a17f6e41b545b79cfffd3e2864":[3,0,27,47], "class_l_r11x0.html#a8c1def9a01021a52f5bb82c119a9ad35":[3,0,27,50], "class_l_r11x0.html#a8d3e5877dcd784c8e922f32ff773dc61":[3,0,27,30], "class_l_r11x0.html#a92299e41f839590008b4e344776838a1":[3,0,27,55], -"class_l_r11x0.html#a923654706eff5118ef6e84214e837f27":[3,0,27,72], +"class_l_r11x0.html#a923654706eff5118ef6e84214e837f27":[3,0,27,73], "class_l_r11x0.html#a95ddec84ae2fb19989c333d42d4dc5fa":[3,0,27,10], "class_l_r11x0.html#a96e4a220bbd3487423acfd217b479fe3":[3,0,27,9], "class_l_r11x0.html#a971b4ccd1d5479e9d72aa9649e8fef55":[3,0,27,62], "class_l_r11x0.html#a99ece57e55ee0001671165213b409a44":[3,0,27,39], -"class_l_r11x0.html#aa09eb53b0c32a5f229e14c46bfe45a4f":[3,0,27,69], +"class_l_r11x0.html#aa09eb53b0c32a5f229e14c46bfe45a4f":[3,0,27,70], "class_l_r11x0.html#aa5d7ae65666f8f9abcb7e9b169884a4a":[3,0,27,56], -"class_l_r11x0.html#aa6ce285cc1b76ce028db6442a421ed8d":[3,0,27,70], +"class_l_r11x0.html#aa6ce285cc1b76ce028db6442a421ed8d":[3,0,27,71], "class_l_r11x0.html#aaff9a5b9b7636693c98bd1c93a5863e5":[3,0,27,14], +"class_l_r11x0.html#ab0d389f1ffaccd7bf97e1e1d52c6136e":[3,0,27,65], "class_l_r11x0.html#ab167c4dc14e80d19f8b33d68c3f90d98":[3,0,27,8], "class_l_r11x0.html#ab1954e4733a7fbea4129d9a2de2285d9":[3,0,27,41], "class_l_r11x0.html#ab1ed8eafe4b23843a8b163949af279bb":[3,0,27,2], @@ -62,17 +62,18 @@ var NAVTREEINDEX1 = "class_l_r11x0.html#ac003cfe3a4dbd9bad1f01fd0147031d1":[3,0,27,48], "class_l_r11x0.html#ac1f541bdee1d983126ceae47940b8f9d":[3,0,27,21], "class_l_r11x0.html#ac2a8ece736198c966e3870dac09f4e87":[3,0,27,54], +"class_l_r11x0.html#ad2786a2f17af5769c772ebc73df88e1f":[3,0,27,66], "class_l_r11x0.html#ad5876b44020a0bd59f73186a912dbb60":[3,0,27,11], -"class_l_r11x0.html#ad59e37ce0606dc8051e40be9d14cfec3":[3,0,27,73], +"class_l_r11x0.html#ad59e37ce0606dc8051e40be9d14cfec3":[3,0,27,74], "class_l_r11x0.html#ad9046bccdb4ef60718e2e8ed2bd7f036":[3,0,27,18], -"class_l_r11x0.html#adcd56cf63e91449b6cd03782a69c3451":[3,0,27,80], +"class_l_r11x0.html#adcd56cf63e91449b6cd03782a69c3451":[3,0,27,81], "class_l_r11x0.html#adcde55b8660c24cf5783942a4132786d":[3,0,27,63], -"class_l_r11x0.html#ade5478296ebc7e02281c95609d5d75ab":[3,0,27,81], +"class_l_r11x0.html#ade5478296ebc7e02281c95609d5d75ab":[3,0,27,82], "class_l_r11x0.html#adf6895cbf7af7e00ea06c5b2b5040cb4":[3,0,27,58], -"class_l_r11x0.html#ae077957969f6274a53f63b314b6f1359":[3,0,27,79], +"class_l_r11x0.html#ae077957969f6274a53f63b314b6f1359":[3,0,27,80], "class_l_r11x0.html#ae1a8e8eda78113c47f1a865e63051bb5":[3,0,27,36], "class_l_r11x0.html#ae565dc2423ca7df13bf7ae48cce9ac8b":[3,0,27,12], -"class_l_r11x0.html#ae79c42c4ceceb7a6897731d01d365281":[3,0,27,71], +"class_l_r11x0.html#ae79c42c4ceceb7a6897731d01d365281":[3,0,27,72], "class_l_r11x0.html#aede2a1dd742516423d89c2e0645297e7":[3,0,27,7], "class_l_r11x0.html#af24ba794f71c4e37cd13d2f4dbec5bf7":[3,0,27,42], "class_l_r11x0.html#af441859fbeed4ee5d32519d26e94c68b":[3,0,27,29], @@ -248,6 +249,5 @@ var NAVTREEINDEX1 = "class_r_f69.html#a0526ce6ea3722fd258f96d9677a60853":[3,0,41,24], "class_r_f69.html#a09ba80f60ee7974011a4b4f6c18c6847":[3,0,41,75], "class_r_f69.html#a0c30202b2d52eb32f43066bc0f938638":[3,0,41,19], -"class_r_f69.html#a0d7b67499462777f7909860405ca6b62":[3,0,41,4], -"class_r_f69.html#a0de2a07f264839cda945faebf7319e0e":[3,0,41,18] +"class_r_f69.html#a0d7b67499462777f7909860405ca6b62":[3,0,41,4] }; diff --git a/navtreeindex2.js b/navtreeindex2.js index dcf5fd11..efdd5d10 100644 --- a/navtreeindex2.js +++ b/navtreeindex2.js @@ -1,5 +1,6 @@ var NAVTREEINDEX2 = { +"class_r_f69.html#a0de2a07f264839cda945faebf7319e0e":[3,0,41,18], "class_r_f69.html#a15fafb6c24a8b5721623be447628bbaa":[3,0,41,9], "class_r_f69.html#a1a6ecb5fcc42c49bc3d9032e9c5db07b":[3,0,41,46], "class_r_f69.html#a1b7598b87ffaabdbe733c47317fa91d8":[3,0,41,37], @@ -220,9 +221,9 @@ var NAVTREEINDEX2 = "class_s_x1268.html#af412a9361fe413b2d0c426100056d8c2":[3,0,62,4], "class_s_x1268.html#af6b041392136b599eec57085e2067a6f":[3,0,62,2], "class_s_x126x.html":[3,0,63], -"class_s_x126x.html#a001c4637f01ed6f0216cd6c4d7e10da3":[3,0,63,78], +"class_s_x126x.html#a001c4637f01ed6f0216cd6c4d7e10da3":[3,0,63,79], "class_s_x126x.html#a068d709ffb79ae66d718ffb76ffae997":[3,0,63,19], -"class_s_x126x.html#a077f180905ce4818cbdacad0cd9fe841":[3,0,63,83], +"class_s_x126x.html#a077f180905ce4818cbdacad0cd9fe841":[3,0,63,84], "class_s_x126x.html#a0a0df468eacc71c1b2a093ac06bfff51":[3,0,63,61], "class_s_x126x.html#a0da667fe702d7b4aafaa4bf7e69ea40d":[3,0,63,48], "class_s_x126x.html#a1623e7d5450c97ca092913ad79d62208":[3,0,63,56], @@ -232,22 +233,21 @@ var NAVTREEINDEX2 = "class_s_x126x.html#a1d8f4deb555844b24c2426dd86e69676":[3,0,63,47], "class_s_x126x.html#a21c263ce1a339faa74c568d9afb81cd2":[3,0,63,60], "class_s_x126x.html#a269c8e4ae0d21af88e9422ccf9708c1e":[3,0,63,26], -"class_s_x126x.html#a2af78b744b3e61d3857bed93c3b1bde1":[3,0,63,91], +"class_s_x126x.html#a2af78b744b3e61d3857bed93c3b1bde1":[3,0,63,92], "class_s_x126x.html#a2b3eb51117558c58384b03de4b7bfe60":[3,0,63,51], "class_s_x126x.html#a2cb5ed645ebcc6f3f17d77e32c2ccdd7":[3,0,63,62], "class_s_x126x.html#a2e500e5b6044ccab8f6b19af4ffa917c":[3,0,63,3], "class_s_x126x.html#a2f60df59c80241d98ce078c0417a7f08":[3,0,63,39], -"class_s_x126x.html#a2fa0384a529746811e2dcb2eeb4188ec":[3,0,63,77], +"class_s_x126x.html#a2fa0384a529746811e2dcb2eeb4188ec":[3,0,63,78], "class_s_x126x.html#a3350cbfab628956c1a456383ac7bb2b2":[3,0,63,32], "class_s_x126x.html#a34aea9413d71676c7a60fcf24017694a":[3,0,63,28], "class_s_x126x.html#a3563453988a83d22dd07d4691543a300":[3,0,63,31], "class_s_x126x.html#a3765f534418d4e0540c179621c019138":[3,0,63,12], "class_s_x126x.html#a37dab0ab3c4cab82e367971fc31588a6":[3,0,63,7], -"class_s_x126x.html#a3dd42f8d5569487ea74f004ca652a709":[3,0,63,88], +"class_s_x126x.html#a3dd42f8d5569487ea74f004ca652a709":[3,0,63,89], "class_s_x126x.html#a420c23bb1861646e29f44c0f4c646ee8":[3,0,63,15], -"class_s_x126x.html#a492b2d057dd803c3884fa1adc8e22534":[3,0,63,87], +"class_s_x126x.html#a492b2d057dd803c3884fa1adc8e22534":[3,0,63,88], "class_s_x126x.html#a4bbc29f5dc7253b7743599c68137df48":[3,0,63,38], "class_s_x126x.html#a4f514b341b8982650526c6d8e20fd1a4":[3,0,63,50], -"class_s_x126x.html#a514cabe74bbe3434d7e4f244c4077752":[3,0,63,53], -"class_s_x126x.html#a5595fff99d76d50d711b8cdad98527c4":[3,0,63,74] +"class_s_x126x.html#a514cabe74bbe3434d7e4f244c4077752":[3,0,63,53] }; diff --git a/navtreeindex3.js b/navtreeindex3.js index e520ebe4..509bb83f 100644 --- a/navtreeindex3.js +++ b/navtreeindex3.js @@ -1,27 +1,28 @@ var NAVTREEINDEX3 = { +"class_s_x126x.html#a5595fff99d76d50d711b8cdad98527c4":[3,0,63,75], "class_s_x126x.html#a56f88f6a2b88ae6dbd3ad04b1950e7b2":[3,0,63,9], "class_s_x126x.html#a57bee6f4b3a3b7ec646ac8de347ee0d6":[3,0,63,69], "class_s_x126x.html#a59b761a67d15cdbfdccd6a759f464d00":[3,0,63,23], "class_s_x126x.html#a59d443c02d4620cda32c63a00c6bcc22":[3,0,63,63], "class_s_x126x.html#a5ae69309ca0cf5f13c60f2d162916ff8":[3,0,63,59], -"class_s_x126x.html#a5b4f8a41b593436b8c7a2a2d46ac387e":[3,0,63,82], -"class_s_x126x.html#a66ad433561b02fe61b09afd735ce56cc":[3,0,63,80], +"class_s_x126x.html#a5b4f8a41b593436b8c7a2a2d46ac387e":[3,0,63,83], +"class_s_x126x.html#a66ad433561b02fe61b09afd735ce56cc":[3,0,63,81], "class_s_x126x.html#a6848afe4c16a47edb3e0b342a86ecdfd":[3,0,63,8], "class_s_x126x.html#a75c8d32cee712e0c940163446b98e587":[3,0,63,6], "class_s_x126x.html#a7603aa60ae8d975eb262a4b7e2aed1d0":[3,0,63,54], -"class_s_x126x.html#a7a1579e2557c36a4a34b09039c0d0c71":[3,0,63,76], +"class_s_x126x.html#a7a1579e2557c36a4a34b09039c0d0c71":[3,0,63,77], "class_s_x126x.html#a7cd95a5f2e39ae8fb1a3040e77fa21a3":[3,0,63,52], "class_s_x126x.html#a827a4754ea53388513d263e5d9171395":[3,0,63,67], -"class_s_x126x.html#a865397e1cca38bec2d055c047825ea07":[3,0,63,72], +"class_s_x126x.html#a865397e1cca38bec2d055c047825ea07":[3,0,63,73], "class_s_x126x.html#a8a18aee2bf05793aa29b5cf6b47bb435":[3,0,63,35], -"class_s_x126x.html#a8a3ad4e12df862ab18b326d9dba26d66":[3,0,63,75], +"class_s_x126x.html#a8a3ad4e12df862ab18b326d9dba26d66":[3,0,63,76], "class_s_x126x.html#a8e22d67b64953c8b4da779d87d563f3e":[3,0,63,13], "class_s_x126x.html#a8f971dca834be7e0470a9a9f0c01854e":[3,0,63,45], "class_s_x126x.html#a920aa76ff5f0f579424ef6de92e588c8":[3,0,63,64], -"class_s_x126x.html#a921aa8afb8d33b2660731c1f8d67664b":[3,0,63,90], -"class_s_x126x.html#a923654706eff5118ef6e84214e837f27":[3,0,63,84], -"class_s_x126x.html#a92c157efe751b4ae73d22ff44115285d":[3,0,63,92], +"class_s_x126x.html#a921aa8afb8d33b2660731c1f8d67664b":[3,0,63,91], +"class_s_x126x.html#a923654706eff5118ef6e84214e837f27":[3,0,63,85], +"class_s_x126x.html#a92c157efe751b4ae73d22ff44115285d":[3,0,63,93], "class_s_x126x.html#a936a40038e05740a528f2b53f8e17010":[3,0,63,2], "class_s_x126x.html#a95007639c2648a1dbb614493224606f1":[3,0,63,44], "class_s_x126x.html#a9a9b090eddcb811ee19b595debfab1df":[3,0,63,20], @@ -29,11 +30,12 @@ var NAVTREEINDEX3 = "class_s_x126x.html#a9d92dce566f8aefa836fe8f332e9560f":[3,0,63,68], "class_s_x126x.html#aa3c90f19cd141738ff013ae72f78f1bb":[3,0,63,5], "class_s_x126x.html#aa668babb0bd129b2facee9fd280525ab":[3,0,63,17], -"class_s_x126x.html#aab18364237ddac0c56aeaf63f08cf009":[3,0,63,89], +"class_s_x126x.html#aab18364237ddac0c56aeaf63f08cf009":[3,0,63,90], "class_s_x126x.html#aaca5a8fa8a3e634dd1b5b4c2bb5058d8":[3,0,63,0], +"class_s_x126x.html#aad7e4df3e1ca20d524e1d776047e1013":[3,0,63,72], "class_s_x126x.html#ab593887ad083a1d5affda7a42656749e":[3,0,63,27], "class_s_x126x.html#ab82617fa3fa9f21d4cd427314ecc4af8":[3,0,63,33], -"class_s_x126x.html#ab843614658a79db7aa24e48d5b6e84f1":[3,0,63,86], +"class_s_x126x.html#ab843614658a79db7aa24e48d5b6e84f1":[3,0,63,87], "class_s_x126x.html#ab9ce38cfeaa36ddcc2d82b2974d7088c":[3,0,63,1], "class_s_x126x.html#abc3a4f9213b2a7052e97c2e3a0bf45a5":[3,0,63,14], "class_s_x126x.html#abd8eea7e468db3d6064c19d4934d5034":[3,0,63,41], @@ -44,27 +46,27 @@ var NAVTREEINDEX3 = "class_s_x126x.html#acb1a1c51f207439880ae537f5ffeb17c":[3,0,63,30], "class_s_x126x.html#acb8611a9c3862dd1bfa73ef47b8f9b20":[3,0,63,37], "class_s_x126x.html#acbe2d75b1e2df8bcc58c4fd9d8e6e4f9":[3,0,63,18], -"class_s_x126x.html#ad59e37ce0606dc8051e40be9d14cfec3":[3,0,63,85], +"class_s_x126x.html#ad59e37ce0606dc8051e40be9d14cfec3":[3,0,63,86], "class_s_x126x.html#ad6274222ccf534e98e3cd17dfa1520d4":[3,0,63,58], -"class_s_x126x.html#ad6c81423768480e3bc04d636486241f8":[3,0,63,81], +"class_s_x126x.html#ad6c81423768480e3bc04d636486241f8":[3,0,63,82], "class_s_x126x.html#ad90a56cb55c5bb64037a0d412d84a80d":[3,0,63,57], -"class_s_x126x.html#ada0fe6c3d31885952b439135cf0c18f1":[3,0,63,94], +"class_s_x126x.html#ada0fe6c3d31885952b439135cf0c18f1":[3,0,63,95], "class_s_x126x.html#adec09cba71494bd927ad1da786606ca6":[3,0,63,25], "class_s_x126x.html#ae3db6b29c482d94eef8a43cd8b5751c0":[3,0,63,34], "class_s_x126x.html#ae46e08d579f4acbad029b4cd4f4fffaf":[3,0,63,49], -"class_s_x126x.html#ae473773e5bed4b08452e80311bdb26f2":[3,0,63,73], +"class_s_x126x.html#ae473773e5bed4b08452e80311bdb26f2":[3,0,63,74], "class_s_x126x.html#ae500bad45638a47264b7e5955a93107d":[3,0,63,70], "class_s_x126x.html#ae5993359ace652fbdc862eb23fdd263d":[3,0,63,65], -"class_s_x126x.html#ae731568798d03d9722a440fd6a23faf2":[3,0,63,93], +"class_s_x126x.html#ae731568798d03d9722a440fd6a23faf2":[3,0,63,94], +"class_s_x126x.html#aecdecd788d254fdea92fde5037693fef":[3,0,63,71], "class_s_x126x.html#aed0e7dcd60479c9db3d7a3408e7f396d":[3,0,63,42], "class_s_x126x.html#af30a581d31feae6f50c0591d1ee113f1":[3,0,63,46], "class_s_x126x.html#af38ba3d27ab2ac10c703eefa1c428913":[3,0,63,10], "class_s_x126x.html#afabefb1b214411198f3537e8afce898f":[3,0,63,22], -"class_s_x126x.html#afb5509f0705cdd971065251ed6b2fb4e":[3,0,63,71], "class_s_x126x.html#afc3a7a42c401b6c44e00cb6c5b9696f2":[3,0,63,11], "class_s_x126x.html#afd3113858966e878e9c67a1e710bd586":[3,0,63,43], "class_s_x126x.html#afdd901c5eac2ca8773d0977e2c493317":[3,0,63,16], -"class_s_x126x.html#aff8ec92d828421564322f13fb1c90223":[3,0,63,79], +"class_s_x126x.html#aff8ec92d828421564322f13fb1c90223":[3,0,63,80], "class_s_x1272.html":[3,0,64], "class_s_x1272.html#a03f7073d710f18aad79b7d46f2fda659":[3,0,64,23], "class_s_x1272.html#a0978cc9ecbb7b9d3a017c133506e57ac":[3,0,64,12], @@ -247,7 +249,5 @@ var NAVTREEINDEX3 = "class_s_x1281.html#a0dd7678cdf7fad9ecfc9139c5092f998":[3,0,72,0], "class_s_x1282.html":[3,0,73], "class_s_x1282.html#ae90b7dcd7167c4cbe20e33ced04e4232":[3,0,73,0], -"class_s_x128x.html":[3,0,74], -"class_s_x128x.html#a0759fb31b3ce5bf1c832259c9c2245ed":[3,0,74,35], -"class_s_x128x.html#a1984a405262f155f16a4759c5f6b0133":[3,0,74,45] +"class_s_x128x.html":[3,0,74] }; diff --git a/navtreeindex4.js b/navtreeindex4.js index f52e6600..89e058b0 100644 --- a/navtreeindex4.js +++ b/navtreeindex4.js @@ -1,8 +1,9 @@ var NAVTREEINDEX4 = { +"class_s_x128x.html#a0759fb31b3ce5bf1c832259c9c2245ed":[3,0,74,35], +"class_s_x128x.html#a1984a405262f155f16a4759c5f6b0133":[3,0,74,45], "class_s_x128x.html#a1bc3372c47a4e3c81ef15bee448ba6b6":[3,0,74,42], "class_s_x128x.html#a1bef6b6f3058be6b1681c78334342bc1":[3,0,74,50], -"class_s_x128x.html#a1d15e13e15b060ddbbe84257d5fcb66f":[3,0,74,52], "class_s_x128x.html#a1e6f938ce715dad9a6609bf56626a50d":[3,0,74,44], "class_s_x128x.html#a2326cf28c385b8dd709cb62c9f665000":[3,0,74,36], "class_s_x128x.html#a260b99d8427e089546e33084803d955a":[3,0,74,15], @@ -10,34 +11,36 @@ var NAVTREEINDEX4 = "class_s_x128x.html#a26d0d02e5e53a3172df9208fa343a3f1":[3,0,74,39], "class_s_x128x.html#a275a9a86934124eab4982ad52bf91aea":[3,0,74,1], "class_s_x128x.html#a2b424000856a9dc212f571d0e8890635":[3,0,74,12], -"class_s_x128x.html#a2be8cc6c3b61b59cb6a6ca4f6a030b45":[3,0,74,53], +"class_s_x128x.html#a2be8cc6c3b61b59cb6a6ca4f6a030b45":[3,0,74,54], "class_s_x128x.html#a2c4a24623c5fd27b3cc937e55783d709":[3,0,74,3], "class_s_x128x.html#a2f8427103d6609f3ac44b23fcca4f301":[3,0,74,28], "class_s_x128x.html#a32b7b674d63c36f15b7f58a2cb837a99":[3,0,74,25], "class_s_x128x.html#a3563453988a83d22dd07d4691543a300":[3,0,74,22], "class_s_x128x.html#a3837662441a9eb3f0a71f4f667db9e91":[3,0,74,40], -"class_s_x128x.html#a389aab93e24ec8c7cc9c14de90e5dfae":[3,0,74,54], +"class_s_x128x.html#a389aab93e24ec8c7cc9c14de90e5dfae":[3,0,74,55], "class_s_x128x.html#a390fd0749b316eed67da7b54f4f24735":[3,0,74,14], -"class_s_x128x.html#a3dd42f8d5569487ea74f004ca652a709":[3,0,74,62], +"class_s_x128x.html#a3dd42f8d5569487ea74f004ca652a709":[3,0,74,63], "class_s_x128x.html#a4587409a9b96a0c496cf12b3acac20c4":[3,0,74,10], "class_s_x128x.html#a46e7979288205689ea97f1c26d1da07e":[3,0,74,19], -"class_s_x128x.html#a492b2d057dd803c3884fa1adc8e22534":[3,0,74,61], -"class_s_x128x.html#a53892566b0259d348158efe3c3c3601a":[3,0,74,64], +"class_s_x128x.html#a492b2d057dd803c3884fa1adc8e22534":[3,0,74,62], +"class_s_x128x.html#a53892566b0259d348158efe3c3c3601a":[3,0,74,65], "class_s_x128x.html#a5ba683fbc4a46418ce3736f224fb55f2":[3,0,74,46], "class_s_x128x.html#a5cf9f188217bb10932cef65935b59da2":[3,0,74,5], -"class_s_x128x.html#a6083c3789671527e5aee5fd1b8723996":[3,0,74,57], +"class_s_x128x.html#a6083c3789671527e5aee5fd1b8723996":[3,0,74,58], "class_s_x128x.html#a6e45fbfaec7063e52e188f47a3a585a5":[3,0,74,41], "class_s_x128x.html#a6ed60dfbd142315bb4e1abd2555a470a":[3,0,74,4], -"class_s_x128x.html#a803eaca8bb7fdfa3570cf4aa95f8e729":[3,0,74,56], +"class_s_x128x.html#a803eaca8bb7fdfa3570cf4aa95f8e729":[3,0,74,57], "class_s_x128x.html#a8720a388d2cd10fac3112b89f4a80947":[3,0,74,37], "class_s_x128x.html#a8b3eea268f21bf911b6eaf37c5eb0b5f":[3,0,74,51], "class_s_x128x.html#a8d331080599e09ef0b11a77cffd6f13a":[3,0,74,20], -"class_s_x128x.html#a923654706eff5118ef6e84214e837f27":[3,0,74,58], +"class_s_x128x.html#a923654706eff5118ef6e84214e837f27":[3,0,74,59], "class_s_x128x.html#a9346490a6c56edcff2e12ae0369a8df5":[3,0,74,29], -"class_s_x128x.html#a948156af6e886bc46a6c6c5fb10a087a":[3,0,74,55], +"class_s_x128x.html#a948156af6e886bc46a6c6c5fb10a087a":[3,0,74,56], "class_s_x128x.html#a94b7fb26cc99385d30b0c98b76d8188d":[3,0,74,9], "class_s_x128x.html#a94bca43258b09217fb476a2d8db784bb":[3,0,74,23], +"class_s_x128x.html#a98ef7dc21647642b40baf8c0194788c4":[3,0,74,53], "class_s_x128x.html#a99491c705e88dddc820f884b778f1660":[3,0,74,34], +"class_s_x128x.html#a9bf5f068064539c8421a4a20cc3f89ab":[3,0,74,52], "class_s_x128x.html#a9ccbf51f8304f1041c8eef182be547a7":[3,0,74,0], "class_s_x128x.html#a9da544e4a6120f73a078b46c6138505a":[3,0,74,32], "class_s_x128x.html#aa4b1e0b96347011522e053f30202c0fe":[3,0,74,33], @@ -50,7 +53,7 @@ var NAVTREEINDEX4 = "class_s_x128x.html#ac79047a072a038194f3429a913e7aaee":[3,0,74,7], "class_s_x128x.html#ace5ede905bf85aada0c61b9cfaaea127":[3,0,74,2], "class_s_x128x.html#ad5789bd27d46b24f54aac9ca55ec9958":[3,0,74,47], -"class_s_x128x.html#ad59e37ce0606dc8051e40be9d14cfec3":[3,0,74,59], +"class_s_x128x.html#ad59e37ce0606dc8051e40be9d14cfec3":[3,0,74,60], "class_s_x128x.html#ad6570f33bae09bc8b7617f9da39033ac":[3,0,74,31], "class_s_x128x.html#ad9584464d2e4cc09686cf4e83e65d3e0":[3,0,74,49], "class_s_x128x.html#ad98c4526ef971f9aadb30e351a37eaf9":[3,0,74,43], @@ -59,8 +62,8 @@ var NAVTREEINDEX4 = "class_s_x128x.html#ae435f57132f76f4283abb870176acf54":[3,0,74,48], "class_s_x128x.html#ae7d3676df8f28c79b9bee23df884fa55":[3,0,74,17], "class_s_x128x.html#ae93c99c85deb950fe9bc7101142b5f6a":[3,0,74,30], -"class_s_x128x.html#aef221e7d463c5228ce00ed6934512848":[3,0,74,60], -"class_s_x128x.html#af253e1e45361de74aefd01a7c73c28f5":[3,0,74,63], +"class_s_x128x.html#aef221e7d463c5228ce00ed6934512848":[3,0,74,61], +"class_s_x128x.html#af253e1e45361de74aefd01a7c73c28f5":[3,0,74,64], "class_s_x128x.html#af2e1d173694a59082a22922a6f7d50a8":[3,0,74,21], "class_s_x128x.html#aff7d86352c98771595375e17d19a2a97":[3,0,74,26], "class_si4430.html":[3,0,49], @@ -212,8 +215,8 @@ var NAVTREEINDEX4 = "functions_enum.html":[3,3,4], "functions_eval.html":[3,3,5], "functions_f.html":[3,3,0,5], -"functions_func.html":[3,3,1], "functions_func.html":[3,3,1,0], +"functions_func.html":[3,3,1], "functions_func_b.html":[3,3,1,1], "functions_func_c.html":[3,3,1,2], "functions_func_d.html":[3,3,1,3], @@ -246,8 +249,5 @@ var NAVTREEINDEX4 = "functions_p.html":[3,3,0,14], "functions_r.html":[3,3,0,15], "functions_s.html":[3,3,0,16], -"functions_t.html":[3,3,0,17], -"functions_type.html":[3,3,3], -"functions_u.html":[3,3,0,18], -"functions_v.html":[3,3,0,19] +"functions_t.html":[3,3,0,17] }; diff --git a/navtreeindex5.js b/navtreeindex5.js index 9d23fc58..591b1449 100644 --- a/navtreeindex5.js +++ b/navtreeindex5.js @@ -1,5 +1,8 @@ var NAVTREEINDEX5 = { +"functions_type.html":[3,3,3], +"functions_u.html":[3,3,0,18], +"functions_v.html":[3,3,0,19], "functions_vars.html":[3,3,2], "functions_w.html":[3,3,0,20], "functions_x.html":[3,3,0,21], diff --git a/search/all_10.js b/search/all_10.js index 8c56b853..d910edfd 100644 --- a/search/all_10.js +++ b/search/all_10.js @@ -105,7 +105,7 @@ var searchData= ['si4432_502',['Si4432',['../class_si4432.html#afb1f1ae46d04788aa42f6276efd231ac',1,'Si4432::Si4432()'],['../class_si4432.html',1,'Si4432']]], ['si443x_503',['Si443x',['../class_si443x.html#ae7cfff2efebfa01c8a50a5cbbe8775b9',1,'Si443x::Si443x()'],['../class_si443x.html',1,'Si443x']]], ['size_504',['size',['../class_radio_lib_c_r_c.html#ad09b067c00cda1cc676c13602dee2f5a',1,'RadioLibCRC']]], - ['sleep_505',['sleep',['../class_physical_layer.html#af1bb9a5da26da8829795ebb72e9c666e',1,'PhysicalLayer::sleep()'],['../class_l_r11x0.html#a64d70a3341a6a8b32f9871cdcb719733',1,'LR11x0::sleep()'],['../classn_r_f24.html#a69b75e0889c609099487a43c8c3b6721',1,'nRF24::sleep()'],['../class_r_f69.html#adec9debf69f5ee846a5b6e34831ade3c',1,'RF69::sleep()'],['../class_si443x.html#ab0cc51d6b4264acf8e3e49a3a490dee9',1,'Si443x::sleep()'],['../class_s_x126x.html#afb5509f0705cdd971065251ed6b2fb4e',1,'SX126x::sleep()'],['../class_s_x127x.html#a1ff85ee7979da08b4e66316f1ba2c6a9',1,'SX127x::sleep()'],['../class_s_x128x.html#a1d15e13e15b060ddbbe84257d5fcb66f',1,'SX128x::sleep()']]], + ['sleep_505',['sleep',['../class_physical_layer.html#af1bb9a5da26da8829795ebb72e9c666e',1,'PhysicalLayer::sleep()'],['../class_l_r11x0.html#ab0d389f1ffaccd7bf97e1e1d52c6136e',1,'LR11x0::sleep()'],['../classn_r_f24.html#a69b75e0889c609099487a43c8c3b6721',1,'nRF24::sleep()'],['../class_r_f69.html#adec9debf69f5ee846a5b6e34831ade3c',1,'RF69::sleep()'],['../class_si443x.html#ab0cc51d6b4264acf8e3e49a3a490dee9',1,'Si443x::sleep()'],['../class_s_x126x.html#aecdecd788d254fdea92fde5037693fef',1,'SX126x::sleep()'],['../class_s_x127x.html#a1ff85ee7979da08b4e66316f1ba2c6a9',1,'SX127x::sleep()'],['../class_s_x128x.html#a9bf5f068064539c8421a4a20cc3f89ab',1,'SX128x::sleep()']]], ['spectralscanabort_506',['spectralScanAbort',['../class_s_x126x.html#a865397e1cca38bec2d055c047825ea07',1,'SX126x']]], ['spectralscangetresult_507',['spectralScanGetResult',['../class_s_x126x.html#ae473773e5bed4b08452e80311bdb26f2',1,'SX126x']]], ['spectralscangetstatus_508',['spectralScanGetStatus',['../class_s_x126x.html#a5595fff99d76d50d711b8cdad98527c4',1,'SX126x']]], diff --git a/search/functions_f.js b/search/functions_f.js index 56b8d4bf..1fd33487 100644 --- a/search/functions_f.js +++ b/search/functions_f.js @@ -101,7 +101,7 @@ var searchData= ['si4431_944',['Si4431',['../class_si4431.html#a332bfd2a32dea9ac0700bf172fe5b2d0',1,'Si4431']]], ['si4432_945',['Si4432',['../class_si4432.html#afb1f1ae46d04788aa42f6276efd231ac',1,'Si4432']]], ['si443x_946',['Si443x',['../class_si443x.html#ae7cfff2efebfa01c8a50a5cbbe8775b9',1,'Si443x']]], - ['sleep_947',['sleep',['../class_s_x127x.html#a1ff85ee7979da08b4e66316f1ba2c6a9',1,'SX127x::sleep()'],['../class_physical_layer.html#af1bb9a5da26da8829795ebb72e9c666e',1,'PhysicalLayer::sleep()'],['../class_s_x128x.html#a1d15e13e15b060ddbbe84257d5fcb66f',1,'SX128x::sleep()'],['../class_s_x126x.html#afb5509f0705cdd971065251ed6b2fb4e',1,'SX126x::sleep()'],['../class_si443x.html#ab0cc51d6b4264acf8e3e49a3a490dee9',1,'Si443x::sleep()'],['../class_r_f69.html#adec9debf69f5ee846a5b6e34831ade3c',1,'RF69::sleep()'],['../classn_r_f24.html#a69b75e0889c609099487a43c8c3b6721',1,'nRF24::sleep()'],['../class_l_r11x0.html#a64d70a3341a6a8b32f9871cdcb719733',1,'LR11x0::sleep()']]], + ['sleep_947',['sleep',['../class_s_x127x.html#a1ff85ee7979da08b4e66316f1ba2c6a9',1,'SX127x::sleep()'],['../class_physical_layer.html#af1bb9a5da26da8829795ebb72e9c666e',1,'PhysicalLayer::sleep()'],['../class_s_x128x.html#a9bf5f068064539c8421a4a20cc3f89ab',1,'SX128x::sleep()'],['../class_s_x126x.html#aecdecd788d254fdea92fde5037693fef',1,'SX126x::sleep()'],['../class_si443x.html#ab0cc51d6b4264acf8e3e49a3a490dee9',1,'Si443x::sleep()'],['../class_r_f69.html#adec9debf69f5ee846a5b6e34831ade3c',1,'RF69::sleep()'],['../classn_r_f24.html#a69b75e0889c609099487a43c8c3b6721',1,'nRF24::sleep()'],['../class_l_r11x0.html#ab0d389f1ffaccd7bf97e1e1d52c6136e',1,'LR11x0::sleep()']]], ['spectralscanabort_948',['spectralScanAbort',['../class_s_x126x.html#a865397e1cca38bec2d055c047825ea07',1,'SX126x']]], ['spectralscangetresult_949',['spectralScanGetResult',['../class_s_x126x.html#ae473773e5bed4b08452e80311bdb26f2',1,'SX126x']]], ['spectralscangetstatus_950',['spectralScanGetStatus',['../class_s_x126x.html#a5595fff99d76d50d711b8cdad98527c4',1,'SX126x']]],