From 1fa424c82a4c4b0dc952a9d2dfc55947fa61f7c8 Mon Sep 17 00:00:00 2001 From: jgromes Date: Fri, 19 Apr 2024 18:31:27 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=206fa4a?= =?UTF-8?q?a3ebbbb332a0f3d3b44b043f5f8f57a3cc5=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- _l_r11x0_8h_source.html | 505 +++++++++++++++++-------------- class_l_r1110-members.html | 84 +++--- class_l_r1110.html | 74 +++-- class_l_r11x0-members.html | 82 ++--- class_l_r11x0.html | 599 ++++++++++++++++++++++++++++++++++--- class_l_r11x0.js | 17 +- class_physical_layer.html | 14 +- functions_c.html | 1 + functions_d.html | 1 + functions_f.html | 1 + functions_func_c.html | 1 + functions_func_d.html | 1 + functions_func_f.html | 1 + functions_func_s.html | 50 ++-- functions_func_v.html | 1 + functions_s.html | 52 ++-- functions_v.html | 1 + navtreedata.js | 10 +- navtreeindex0.js | 46 +-- navtreeindex1.js | 68 ++--- navtreeindex2.js | 32 +- navtreeindex3.js | 32 +- navtreeindex4.js | 32 +- navtreeindex5.js | 17 +- search/all_10.js | 66 ++-- search/all_13.js | 2 +- search/all_2.js | 10 +- search/all_3.js | 2 +- search/all_5.js | 2 +- search/enums_0.js | 2 +- search/enumvalues_0.js | 12 +- search/functions_10.js | 12 +- search/functions_11.js | 4 +- search/functions_12.js | 4 +- search/functions_13.js | 6 +- search/functions_14.js | 2 +- search/functions_15.js | 4 +- search/functions_2.js | 4 +- search/functions_3.js | 2 +- search/functions_5.js | 2 +- search/functions_f.js | 245 +++++++-------- search/groups_0.js | 2 +- search/groups_1.js | 2 +- search/groups_2.js | 2 +- search/groups_3.js | 4 +- search/groups_4.js | 4 +- search/pages_0.js | 2 +- search/pages_1.js | 2 +- search/typedefs_0.js | 4 +- search/variables_0.js | 10 +- search/variables_1.js | 16 +- search/variables_10.js | 10 +- search/variables_11.js | 2 +- search/variables_12.js | 4 +- search/variables_13.js | 4 +- search/variables_14.js | 2 +- search/variables_2.js | 20 +- search/variables_3.js | 4 +- search/variables_4.js | 20 +- search/variables_5.js | 12 +- search/variables_6.js | 4 +- search/variables_7.js | 8 +- search/variables_8.js | 2 +- search/variables_9.js | 8 +- search/variables_a.js | 2 +- search/variables_b.js | 10 +- search/variables_c.js | 2 +- search/variables_d.js | 18 +- search/variables_e.js | 24 +- search/variables_f.js | 20 +- 70 files changed, 1498 insertions(+), 829 deletions(-) diff --git a/_l_r11x0_8h_source.html b/_l_r11x0_8h_source.html index 5a6ab33c..07fa9a7f 100644 --- a/_l_r11x0_8h_source.html +++ b/_l_r11x0_8h_source.html @@ -687,248 +687,292 @@ $(document).ready(function(){initNavTree('_l_r11x0_8h_source.html',''); initResi
746 
752  int16_t setSyncWord(uint8_t syncWord);
753 
-
759  int16_t setPreambleLength(size_t preambleLength) override;
+
759  int16_t setBitRate(float br);
760 
-
769  int16_t setTCXO(float voltage, uint32_t delay = 5000);
-
770 
-
779  int16_t setCRC(uint8_t len, uint16_t initial = 0x1D0F, uint16_t polynomial = 0x1021, bool inverted = true);
-
780 
-
786  int16_t invertIQ(bool enable) override;
-
787 
-
792  float getRSSI();
-
793 
-
798  float getSNR();
+
766  int16_t setFrequencyDeviation(float freqDev) override;
+
767 
+
774  int16_t setRxBandwidth(float rxBw);
+
775 
+
782  int16_t setSyncWord(uint8_t* syncWord, size_t len) override;
+
783 
+
791  int16_t setSyncBits(uint8_t *syncWord, uint8_t bitsLen);
+
792 
+
798  int16_t setNodeAddress(uint8_t nodeAddr);
799 
-
804  float getFrequencyError();
-
805 
-
811  size_t getPacketLength(bool update = true) override;
-
812 
-
818  size_t getPacketLength(bool update, uint8_t* offset);
-
819 
-
825  uint32_t getTimeOnAir(size_t len) override;
-
826 
-
831  float getDataRate() const;
-
832 
-
833 #if !RADIOLIB_GODMODE && !RADIOLIB_LOW_LEVEL
-
834  protected:
-
835 #endif
-
836  Module* getMod();
-
837 
-
838  // LR11x0 SPI command implementations
-
839  int16_t writeRegMem32(uint32_t addr, uint32_t* data, size_t len);
-
840  int16_t readRegMem32(uint32_t addr, uint32_t* data, size_t len);
-
841  int16_t writeBuffer8(uint8_t* data, size_t len);
-
842  int16_t readBuffer8(uint8_t* data, size_t len, size_t offset);
-
843  int16_t clearRxBuffer(void);
-
844  int16_t writeRegMemMask32(uint32_t addr, uint32_t mask, uint32_t data);
-
845 
-
846  int16_t getStatus(uint8_t* stat1, uint8_t* stat2, uint32_t* irq);
-
847  int16_t getVersion(uint8_t* hw, uint8_t* device, uint8_t* major, uint8_t* minor);
-
848  int16_t getErrors(uint16_t* err);
-
849  int16_t clearErrors(void);
-
850  int16_t calibrate(uint8_t params);
-
851  int16_t setRegMode(uint8_t mode);
-
852  int16_t calibImage(float freq1, float freq2);
-
853  int16_t setDioAsRfSwitch(uint8_t en, uint8_t stbyCfg, uint8_t rxCfg, uint8_t txCfg, uint8_t txHpCfg, uint8_t gnssCfg, uint8_t wifiCfg);
-
854  int16_t setDioIrqParams(uint32_t irq1, uint32_t irq2);
-
855  int16_t clearIrq(uint32_t irq);
-
856  int16_t configLfClock(uint8_t setup);
-
857  int16_t setTcxoMode(uint8_t tune, uint32_t delay);
-
858  int16_t reboot(bool stay);
-
859  int16_t getVbat(float* vbat);
-
860  int16_t getTemp(float* temp);
-
861  int16_t setFs(void);
-
862  int16_t getRandomNumber(uint32_t* rnd);
-
863  int16_t eraseInfoPage(void);
-
864  int16_t writeInfoPage(uint16_t addr, uint32_t* data, size_t len);
-
865  int16_t readInfoPage(uint16_t addr, uint32_t* data, size_t len);
-
866  int16_t getChipEui(uint8_t* eui);
-
867  int16_t getSemtechJoinEui(uint8_t* eui);
-
868  int16_t deriveRootKeysAndGetPin(uint8_t* pin);
-
869  int16_t enableSpiCrc(bool en);
-
870  int16_t driveDiosInSleepMode(bool en);
-
871 
-
872  int16_t resetStats(void);
-
873  int16_t getStats(uint16_t* nbPktReceived, uint16_t* nbPktCrcError, uint16_t* data1, uint16_t* data2);
-
874  int16_t getPacketType(uint8_t* type);
-
875  int16_t getRxBufferStatus(uint8_t* len, uint8_t* startOffset);
-
876  int16_t getPacketStatusLoRa(float* rssiPkt, float* snrPkt, float* signalRssiPkt);
-
877  int16_t getPacketStatusGFSK(float* rssiSync, float* rssiAvg, uint8_t* rxLen, uint8_t* stat);
-
878  int16_t getRssiInst(float* rssi);
-
879  int16_t setGfskSyncWord(uint8_t* sync);
-
880  int16_t setLoRaPublicNetwork(bool pub);
-
881  int16_t setRx(uint32_t timeout);
-
882  int16_t setTx(uint32_t timeout);
-
883  int16_t setRfFrequency(uint32_t rfFreq);
-
884  int16_t autoTxRx(uint32_t delay, uint8_t intMode, uint32_t timeout);
-
885  int16_t setCadParams(uint8_t symNum, uint8_t detPeak, uint8_t detMin, uint8_t cadExitMode, uint32_t timeout);
-
886  int16_t setPacketType(uint8_t type);
-
887  int16_t setModulationParamsLoRa(uint8_t sf, uint8_t bw, uint8_t cr, uint8_t ldro);
-
888  int16_t setModulationParamsGFSK(uint32_t br, uint8_t sh, uint8_t rxBw, uint32_t freqDev);
-
889  int16_t setModulationParamsLrFhss(uint32_t br, uint8_t sh);
-
890  int16_t setModulationParamsSigfox(uint32_t br, uint8_t sh);
-
891  int16_t setPacketParamsLoRa(uint16_t preambleLen, uint8_t hdrType, uint8_t payloadLen, uint8_t crcType, uint8_t invertIQ);
-
892  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);
-
893  int16_t setPacketParamsSigfox(uint8_t payloadLen, uint16_t rampUpDelay, uint16_t rampDownDelay, uint16_t bitNum);
-
894  int16_t setTxParams(int8_t pwr, uint8_t ramp);
-
895  int16_t setPacketAdrs(uint8_t node, uint8_t broadcast);
-
896  int16_t setRxTxFallbackMode(uint8_t mode);
-
897  int16_t setRxDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint8_t mode);
-
898  int16_t setPaConfig(uint8_t paSel, uint8_t regPaSupply, uint8_t paDutyCycle, uint8_t paHpSel);
-
899  int16_t stopTimeoutOnPreamble(bool stop);
-
900  int16_t setCad(void);
-
901  int16_t setTxCw(void);
-
902  int16_t setTxInfinitePreamble(void);
-
903  int16_t setLoRaSynchTimeout(uint8_t symbolNum);
-
904  int16_t setRangingAddr(uint32_t addr, uint8_t checkLen);
-
905  int16_t setRangingReqAddr(uint32_t addr);
-
906  int16_t getRangingResult(uint8_t type, float* res);
-
907  int16_t setRangingTxRxDelay(uint32_t delay);
-
908  int16_t setGfskCrcParams(uint32_t init, uint32_t poly);
-
909  int16_t setGfskWhitParams(uint16_t seed);
-
910  int16_t setRxBoosted(bool en);
-
911  int16_t setRangingParameter(uint8_t symbolNum);
-
912  int16_t setLoRaSyncWord(uint8_t sync);
-
913  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);
-
914  int16_t lrFhssSetSyncWord(uint32_t sync);
-
915  int16_t configBleBeacon(uint8_t chan, uint8_t* payload, size_t len);
-
916  int16_t getLoRaRxHeaderInfos(uint8_t* info);
-
917  int16_t bleBeaconSend(uint8_t chan, uint8_t* payload, size_t len);
+
806  int16_t setBroadcastAddress(uint8_t broadAddr);
+
807 
+
812  int16_t disableAddressFiltering();
+
813 
+
821  int16_t setDataShaping(uint8_t sh) override;
+
822 
+
828  int16_t setEncoding(uint8_t encoding) override;
+
829 
+
835  int16_t fixedPacketLengthMode(uint8_t len = RADIOLIB_LR11X0_MAX_PACKET_LENGTH);
+
836 
+
842  int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_LR11X0_MAX_PACKET_LENGTH);
+
843 
+
851  int16_t setWhitening(bool enabled, uint16_t initial = 0x01FF);
+
852 
+
858  int16_t setDataRate(DataRate_t dr) override;
+
859 
+
865  int16_t checkDataRate(DataRate_t dr) override;
+
866 
+
872  int16_t setPreambleLength(size_t preambleLength) override;
+
873 
+
882  int16_t setTCXO(float voltage, uint32_t delay = 5000);
+
883 
+
892  int16_t setCRC(uint8_t len, uint32_t initial = 0x00001D0FUL, uint32_t polynomial = 0x00001021UL, bool inverted = true);
+
893 
+
899  int16_t invertIQ(bool enable) override;
+
900 
+
905  float getRSSI();
+
906 
+
911  float getSNR();
+
912 
+
917  float getFrequencyError();
918 
-
919  int16_t wifiScan(uint8_t type, uint16_t mask, uint8_t acqMode, uint8_t nbMaxRes, uint8_t nbScanPerChan, uint16_t timeout, uint8_t abortOnTimeout);
-
920  int16_t wifiScanTimeLimit(uint8_t type, uint16_t mask, uint8_t acqMode, uint8_t nbMaxRes, uint16_t timePerChan, uint16_t timeout);
-
921  int16_t wifiCountryCode(uint16_t mask, uint8_t nbMaxRes, uint8_t nbScanPerChan, uint16_t timeout, uint8_t abortOnTimeout);
-
922  int16_t wifiCountryCodeTimeLimit(uint16_t mask, uint8_t nbMaxRes, uint16_t timePerChan, uint16_t timeout);
-
923  int16_t wifiGetNbResults(uint8_t* nbResults);
-
924  int16_t wifiReadResults(uint8_t index, uint8_t nbResults, uint8_t format, uint8_t* results);
-
925  int16_t wifiResetCumulTimings(void);
-
926  int16_t wifiReadCumulTimings(uint32_t* detection, uint32_t* capture, uint32_t* demodulation);
-
927  int16_t wifiGetNbCountryCodeResults(uint8_t* nbResults);
-
928  int16_t wifiReadCountryCodeResults(uint8_t index, uint8_t nbResults, uint8_t* results);
-
929  int16_t wifiCfgTimestampAPphone(uint32_t timestamp);
-
930  int16_t wifiReadVersion(uint8_t* major, uint8_t* minor);
-
931 
-
932  int16_t gnssSetConstellationToUse(uint8_t mask);
-
933  int16_t gnssReadConstellationToUse(uint8_t* mask);
-
934  int16_t gnssSetAlmanacUpdate(uint8_t mask);
-
935  int16_t gnssReadAlmanacUpdate(uint8_t* mask);
-
936  int16_t gnssReadVersion(uint8_t* fw, uint8_t* almanac);
-
937  int16_t gnssReadSupportedConstellations(uint8_t* mask);
-
938  int16_t gnssSetMode(uint8_t mode);
-
939  int16_t gnssAutonomous(uint32_t gpsTime, uint8_t resMask, uint8_t nbSvMask);
-
940  int16_t gnssAssisted(uint32_t gpsTime, uint8_t effort, uint8_t resMask, uint8_t nbSvMask);
-
941  int16_t gnssSetAssistancePosition(float lat, float lon);
-
942  int16_t gnssReadAssistancePosition(float* lat, float* lon);
-
943  int16_t gnssPushSolverMsg(uint8_t* payload, size_t len);
-
944  int16_t gnssPushDmMsg(uint8_t* payload, size_t len);
-
945  int16_t gnssGetContextStatus(uint8_t* fwVersion, uint32_t* almanacCrc, uint8_t* errCode, uint8_t* almUpdMask, uint8_t* freqSpace);
-
946  int16_t gnssGetNbSvDetected(uint8_t* nbSv);
-
947  int16_t gnssGetSvDetected(uint8_t* svId, uint8_t* snr, uint16_t* doppler, size_t nbSv);
-
948  int16_t gnssGetConsumption(uint32_t* cpu, uint32_t* radio);
-
949  int16_t gnssGetResultSize(uint16_t* size);
-
950  int16_t gnssReadResults(uint8_t* result, uint16_t size);
-
951  int16_t gnssAlmanacFullUpdateHeader(uint16_t date, uint32_t globalCrc);
-
952  int16_t gnssAlmanacFullUpdateSV(uint8_t svn, uint8_t* svnAlmanac);
-
953  int16_t gnssGetSvVisible(uint32_t time, float lat, float lon, uint8_t constellation, uint8_t* nbSv);
-
954 
-
955  int16_t cryptoSetKey(uint8_t keyId, uint8_t* key);
-
956  int16_t cryptoDeriveKey(uint8_t srcKeyId, uint8_t dstKeyId, uint8_t* key);
-
957  int16_t cryptoProcessJoinAccept(uint8_t decKeyId, uint8_t verKeyId, uint8_t lwVer, uint8_t* header, uint8_t* dataIn, size_t len, uint8_t* dataOut);
-
958  int16_t cryptoComputeAesCmac(uint8_t keyId, uint8_t* data, size_t len, uint32_t* mic);
-
959  int16_t cryptoVerifyAesCmac(uint8_t keyId, uint32_t micExp, uint8_t* data, size_t len, bool* result);
-
960  int16_t cryptoAesEncrypt01(uint8_t keyId, uint8_t* dataIn, size_t len, uint8_t* dataOut);
-
961  int16_t cryptoAesEncrypt(uint8_t keyId, uint8_t* dataIn, size_t len, uint8_t* dataOut);
-
962  int16_t cryptoAesDecrypt(uint8_t keyId, uint8_t* dataIn, size_t len, uint8_t* dataOut);
-
963  int16_t cryptoStoreToFlash(void);
-
964  int16_t cryptoRestoreFromFlash(void);
-
965  int16_t cryptoSetParam(uint8_t id, uint32_t value);
-
966  int16_t cryptoGetParam(uint8_t id, uint32_t* value);
-
967  int16_t cryptoCheckEncryptedFirmwareImage(uint32_t offset, uint32_t* data, size_t len);
-
968  int16_t cryptoCheckEncryptedFirmwareImageResult(bool* result);
-
969 
-
970  int16_t bootEraseFlash(void);
-
971  int16_t bootWriteFlashEncrypted(uint32_t offset, uint32_t* data, size_t len);
-
972  int16_t bootReboot(bool stay);
-
973  int16_t bootGetPin(uint8_t* pin);
-
974  int16_t bootGetChipEui(uint8_t* eui);
-
975  int16_t bootGetJoinEui(uint8_t* eui);
-
976 
-
977  int16_t SPIcommand(uint16_t cmd, bool write, uint8_t* data, size_t len, uint8_t* out = NULL, size_t outLen = 0);
-
978 
-
979 #if !RADIOLIB_GODMODE
-
980  protected:
-
981 #endif
-
982  uint8_t chipType;
-
983 
-
984 #if !RADIOLIB_GODMODE
-
985  private:
-
986 #endif
-
987  Module* mod;
-
988 
-
989  // cached LoRa parameters
-
990  uint8_t bandwidth = 0, spreadingFactor = 0, codingRate = 0, ldrOptimize = 0, crcTypeLoRa = 0, headerType = 0;
-
991  uint16_t preambleLengthLoRa = 0;
-
992  float bandwidthKhz = 0;
-
993  bool ldroAuto = true;
-
994  size_t implicitLen = 0;
-
995  bool invertIQEnabled = false;
-
996 
-
997  // cached GFSK parameters
-
998  float bitRateKbps = 0;
-
999  uint8_t bitRate = 0;
-
1000  uint8_t preambleDetLength = 0, rxBandwidth = 0, pulseShape = 0, crcTypeGFSK = 0, syncWordLength = 0, addrComp = 0, whitening = 0, packetType = 0;
-
1001  uint16_t preambleLengthGFSK = 0;
-
1002 
-
1003  float dataRateMeasured = 0;
-
1004 
-
1005  static int16_t SPIparseStatus(uint8_t in);
-
1006  static int16_t SPIcheckStatus(Module* mod);
-
1007  bool findChip(uint8_t ver);
-
1008  int16_t config(uint8_t modem);
-
1009 
-
1010  // common methods to avoid some copy-paste
-
1011  int16_t bleBeaconCommon(uint16_t cmd, uint8_t chan, uint8_t* payload, size_t len);
-
1012  int16_t writeCommon(uint16_t cmd, uint32_t addrOffset, uint32_t* data, size_t len);
-
1013  int16_t cryptoCommon(uint16_t cmd, uint8_t keyId, uint8_t* dataIn, size_t len, uint8_t* dataOut);
-
1014 };
-
1015 
-
1016 #endif
-
1017 
-
1018 #endif
+
924  size_t getPacketLength(bool update = true) override;
+
925 
+
931  size_t getPacketLength(bool update, uint8_t* offset);
+
932 
+
938  uint32_t getTimeOnAir(size_t len) override;
+
939 
+
944  float getDataRate() const;
+
945 
+
946 #if !RADIOLIB_GODMODE && !RADIOLIB_LOW_LEVEL
+
947  protected:
+
948 #endif
+
949  Module* getMod();
+
950 
+
951  // LR11x0 SPI command implementations
+
952  int16_t writeRegMem32(uint32_t addr, uint32_t* data, size_t len);
+
953  int16_t readRegMem32(uint32_t addr, uint32_t* data, size_t len);
+
954  int16_t writeBuffer8(uint8_t* data, size_t len);
+
955  int16_t readBuffer8(uint8_t* data, size_t len, size_t offset);
+
956  int16_t clearRxBuffer(void);
+
957  int16_t writeRegMemMask32(uint32_t addr, uint32_t mask, uint32_t data);
+
958 
+
959  int16_t getStatus(uint8_t* stat1, uint8_t* stat2, uint32_t* irq);
+
960  int16_t getVersion(uint8_t* hw, uint8_t* device, uint8_t* major, uint8_t* minor);
+
961  int16_t getErrors(uint16_t* err);
+
962  int16_t clearErrors(void);
+
963  int16_t calibrate(uint8_t params);
+
964  int16_t setRegMode(uint8_t mode);
+
965  int16_t calibImage(float freq1, float freq2);
+
966  int16_t setDioAsRfSwitch(uint8_t en, uint8_t stbyCfg, uint8_t rxCfg, uint8_t txCfg, uint8_t txHpCfg, uint8_t gnssCfg, uint8_t wifiCfg);
+
967  int16_t setDioIrqParams(uint32_t irq1, uint32_t irq2);
+
968  int16_t clearIrq(uint32_t irq);
+
969  int16_t configLfClock(uint8_t setup);
+
970  int16_t setTcxoMode(uint8_t tune, uint32_t delay);
+
971  int16_t reboot(bool stay);
+
972  int16_t getVbat(float* vbat);
+
973  int16_t getTemp(float* temp);
+
974  int16_t setFs(void);
+
975  int16_t getRandomNumber(uint32_t* rnd);
+
976  int16_t eraseInfoPage(void);
+
977  int16_t writeInfoPage(uint16_t addr, uint32_t* data, size_t len);
+
978  int16_t readInfoPage(uint16_t addr, uint32_t* data, size_t len);
+
979  int16_t getChipEui(uint8_t* eui);
+
980  int16_t getSemtechJoinEui(uint8_t* eui);
+
981  int16_t deriveRootKeysAndGetPin(uint8_t* pin);
+
982  int16_t enableSpiCrc(bool en);
+
983  int16_t driveDiosInSleepMode(bool en);
+
984 
+
985  int16_t resetStats(void);
+
986  int16_t getStats(uint16_t* nbPktReceived, uint16_t* nbPktCrcError, uint16_t* data1, uint16_t* data2);
+
987  int16_t getPacketType(uint8_t* type);
+
988  int16_t getRxBufferStatus(uint8_t* len, uint8_t* startOffset);
+
989  int16_t getPacketStatusLoRa(float* rssiPkt, float* snrPkt, float* signalRssiPkt);
+
990  int16_t getPacketStatusGFSK(float* rssiSync, float* rssiAvg, uint8_t* rxLen, uint8_t* stat);
+
991  int16_t getRssiInst(float* rssi);
+
992  int16_t setGfskSyncWord(uint8_t* sync);
+
993  int16_t setLoRaPublicNetwork(bool pub);
+
994  int16_t setRx(uint32_t timeout);
+
995  int16_t setTx(uint32_t timeout);
+
996  int16_t setRfFrequency(uint32_t rfFreq);
+
997  int16_t autoTxRx(uint32_t delay, uint8_t intMode, uint32_t timeout);
+
998  int16_t setCadParams(uint8_t symNum, uint8_t detPeak, uint8_t detMin, uint8_t cadExitMode, uint32_t timeout);
+
999  int16_t setPacketType(uint8_t type);
+
1000  int16_t setModulationParamsLoRa(uint8_t sf, uint8_t bw, uint8_t cr, uint8_t ldro);
+
1001  int16_t setModulationParamsGFSK(uint32_t br, uint8_t sh, uint8_t rxBw, uint32_t freqDev);
+
1002  int16_t setModulationParamsLrFhss(uint32_t br, uint8_t sh);
+
1003  int16_t setModulationParamsSigfox(uint32_t br, uint8_t sh);
+
1004  int16_t setPacketParamsLoRa(uint16_t preambleLen, uint8_t hdrType, uint8_t payloadLen, uint8_t crcType, uint8_t invertIQ);
+
1005  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);
+
1006  int16_t setPacketParamsSigfox(uint8_t payloadLen, uint16_t rampUpDelay, uint16_t rampDownDelay, uint16_t bitNum);
+
1007  int16_t setTxParams(int8_t pwr, uint8_t ramp);
+
1008  int16_t setPacketAdrs(uint8_t node, uint8_t broadcast);
+
1009  int16_t setRxTxFallbackMode(uint8_t mode);
+
1010  int16_t setRxDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint8_t mode);
+
1011  int16_t setPaConfig(uint8_t paSel, uint8_t regPaSupply, uint8_t paDutyCycle, uint8_t paHpSel);
+
1012  int16_t stopTimeoutOnPreamble(bool stop);
+
1013  int16_t setCad(void);
+
1014  int16_t setTxCw(void);
+
1015  int16_t setTxInfinitePreamble(void);
+
1016  int16_t setLoRaSynchTimeout(uint8_t symbolNum);
+
1017  int16_t setRangingAddr(uint32_t addr, uint8_t checkLen);
+
1018  int16_t setRangingReqAddr(uint32_t addr);
+
1019  int16_t getRangingResult(uint8_t type, float* res);
+
1020  int16_t setRangingTxRxDelay(uint32_t delay);
+
1021  int16_t setGfskCrcParams(uint32_t init, uint32_t poly);
+
1022  int16_t setGfskWhitParams(uint16_t seed);
+
1023  int16_t setRxBoosted(bool en);
+
1024  int16_t setRangingParameter(uint8_t symbolNum);
+
1025  int16_t setLoRaSyncWord(uint8_t sync);
+
1026  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);
+
1027  int16_t lrFhssSetSyncWord(uint32_t sync);
+
1028  int16_t configBleBeacon(uint8_t chan, uint8_t* payload, size_t len);
+
1029  int16_t getLoRaRxHeaderInfos(uint8_t* info);
+
1030  int16_t bleBeaconSend(uint8_t chan, uint8_t* payload, size_t len);
+
1031 
+
1032  int16_t wifiScan(uint8_t type, uint16_t mask, uint8_t acqMode, uint8_t nbMaxRes, uint8_t nbScanPerChan, uint16_t timeout, uint8_t abortOnTimeout);
+
1033  int16_t wifiScanTimeLimit(uint8_t type, uint16_t mask, uint8_t acqMode, uint8_t nbMaxRes, uint16_t timePerChan, uint16_t timeout);
+
1034  int16_t wifiCountryCode(uint16_t mask, uint8_t nbMaxRes, uint8_t nbScanPerChan, uint16_t timeout, uint8_t abortOnTimeout);
+
1035  int16_t wifiCountryCodeTimeLimit(uint16_t mask, uint8_t nbMaxRes, uint16_t timePerChan, uint16_t timeout);
+
1036  int16_t wifiGetNbResults(uint8_t* nbResults);
+
1037  int16_t wifiReadResults(uint8_t index, uint8_t nbResults, uint8_t format, uint8_t* results);
+
1038  int16_t wifiResetCumulTimings(void);
+
1039  int16_t wifiReadCumulTimings(uint32_t* detection, uint32_t* capture, uint32_t* demodulation);
+
1040  int16_t wifiGetNbCountryCodeResults(uint8_t* nbResults);
+
1041  int16_t wifiReadCountryCodeResults(uint8_t index, uint8_t nbResults, uint8_t* results);
+
1042  int16_t wifiCfgTimestampAPphone(uint32_t timestamp);
+
1043  int16_t wifiReadVersion(uint8_t* major, uint8_t* minor);
+
1044 
+
1045  int16_t gnssSetConstellationToUse(uint8_t mask);
+
1046  int16_t gnssReadConstellationToUse(uint8_t* mask);
+
1047  int16_t gnssSetAlmanacUpdate(uint8_t mask);
+
1048  int16_t gnssReadAlmanacUpdate(uint8_t* mask);
+
1049  int16_t gnssReadVersion(uint8_t* fw, uint8_t* almanac);
+
1050  int16_t gnssReadSupportedConstellations(uint8_t* mask);
+
1051  int16_t gnssSetMode(uint8_t mode);
+
1052  int16_t gnssAutonomous(uint32_t gpsTime, uint8_t resMask, uint8_t nbSvMask);
+
1053  int16_t gnssAssisted(uint32_t gpsTime, uint8_t effort, uint8_t resMask, uint8_t nbSvMask);
+
1054  int16_t gnssSetAssistancePosition(float lat, float lon);
+
1055  int16_t gnssReadAssistancePosition(float* lat, float* lon);
+
1056  int16_t gnssPushSolverMsg(uint8_t* payload, size_t len);
+
1057  int16_t gnssPushDmMsg(uint8_t* payload, size_t len);
+
1058  int16_t gnssGetContextStatus(uint8_t* fwVersion, uint32_t* almanacCrc, uint8_t* errCode, uint8_t* almUpdMask, uint8_t* freqSpace);
+
1059  int16_t gnssGetNbSvDetected(uint8_t* nbSv);
+
1060  int16_t gnssGetSvDetected(uint8_t* svId, uint8_t* snr, uint16_t* doppler, size_t nbSv);
+
1061  int16_t gnssGetConsumption(uint32_t* cpu, uint32_t* radio);
+
1062  int16_t gnssGetResultSize(uint16_t* size);
+
1063  int16_t gnssReadResults(uint8_t* result, uint16_t size);
+
1064  int16_t gnssAlmanacFullUpdateHeader(uint16_t date, uint32_t globalCrc);
+
1065  int16_t gnssAlmanacFullUpdateSV(uint8_t svn, uint8_t* svnAlmanac);
+
1066  int16_t gnssGetSvVisible(uint32_t time, float lat, float lon, uint8_t constellation, uint8_t* nbSv);
+
1067 
+
1068  int16_t cryptoSetKey(uint8_t keyId, uint8_t* key);
+
1069  int16_t cryptoDeriveKey(uint8_t srcKeyId, uint8_t dstKeyId, uint8_t* key);
+
1070  int16_t cryptoProcessJoinAccept(uint8_t decKeyId, uint8_t verKeyId, uint8_t lwVer, uint8_t* header, uint8_t* dataIn, size_t len, uint8_t* dataOut);
+
1071  int16_t cryptoComputeAesCmac(uint8_t keyId, uint8_t* data, size_t len, uint32_t* mic);
+
1072  int16_t cryptoVerifyAesCmac(uint8_t keyId, uint32_t micExp, uint8_t* data, size_t len, bool* result);
+
1073  int16_t cryptoAesEncrypt01(uint8_t keyId, uint8_t* dataIn, size_t len, uint8_t* dataOut);
+
1074  int16_t cryptoAesEncrypt(uint8_t keyId, uint8_t* dataIn, size_t len, uint8_t* dataOut);
+
1075  int16_t cryptoAesDecrypt(uint8_t keyId, uint8_t* dataIn, size_t len, uint8_t* dataOut);
+
1076  int16_t cryptoStoreToFlash(void);
+
1077  int16_t cryptoRestoreFromFlash(void);
+
1078  int16_t cryptoSetParam(uint8_t id, uint32_t value);
+
1079  int16_t cryptoGetParam(uint8_t id, uint32_t* value);
+
1080  int16_t cryptoCheckEncryptedFirmwareImage(uint32_t offset, uint32_t* data, size_t len);
+
1081  int16_t cryptoCheckEncryptedFirmwareImageResult(bool* result);
+
1082 
+
1083  int16_t bootEraseFlash(void);
+
1084  int16_t bootWriteFlashEncrypted(uint32_t offset, uint32_t* data, size_t len);
+
1085  int16_t bootReboot(bool stay);
+
1086  int16_t bootGetPin(uint8_t* pin);
+
1087  int16_t bootGetChipEui(uint8_t* eui);
+
1088  int16_t bootGetJoinEui(uint8_t* eui);
+
1089 
+
1090  int16_t SPIcommand(uint16_t cmd, bool write, uint8_t* data, size_t len, uint8_t* out = NULL, size_t outLen = 0);
+
1091 
+
1092 #if !RADIOLIB_GODMODE
+
1093  protected:
+
1094 #endif
+
1095  uint8_t chipType;
+
1096 
+
1097 #if !RADIOLIB_GODMODE
+
1098  private:
+
1099 #endif
+
1100  Module* mod;
+
1101 
+
1102  // cached LoRa parameters
+
1103  uint8_t bandwidth = 0, spreadingFactor = 0, codingRate = 0, ldrOptimize = 0, crcTypeLoRa = 0, headerType = 0;
+
1104  uint16_t preambleLengthLoRa = 0;
+
1105  float bandwidthKhz = 0;
+
1106  bool ldroAuto = true;
+
1107  size_t implicitLen = 0;
+
1108  bool invertIQEnabled = false;
+
1109 
+
1110  // cached GFSK parameters
+
1111  uint32_t bitRate = 0, frequencyDev = 0;
+
1112  uint8_t preambleDetLength = 0, rxBandwidth = 0, pulseShape = 0, crcTypeGFSK = 0, syncWordLength = 0, addrComp = 0, whitening = 0, packetType = 0, node = 0;
+
1113  uint16_t preambleLengthGFSK = 0;
+
1114 
+
1115  float dataRateMeasured = 0;
+
1116 
+
1117  static int16_t SPIparseStatus(uint8_t in);
+
1118  static int16_t SPIcheckStatus(Module* mod);
+
1119  bool findChip(uint8_t ver);
+
1120  int16_t config(uint8_t modem);
+
1121  int16_t setPacketMode(uint8_t mode, uint8_t len);
+
1122 
+
1123  // common methods to avoid some copy-paste
+
1124  int16_t bleBeaconCommon(uint16_t cmd, uint8_t chan, uint8_t* payload, size_t len);
+
1125  int16_t writeCommon(uint16_t cmd, uint32_t addrOffset, uint32_t* data, size_t len);
+
1126  int16_t cryptoCommon(uint16_t cmd, uint8_t keyId, uint8_t* dataIn, size_t len, uint8_t* dataOut);
+
1127 };
+
1128 
+
1129 #endif
+
1130 
+
1131 #endif
LR11x0
Definition: LR11x0.h:542
-
LR11x0::getIrqStatus
uint32_t getIrqStatus()
Reads the current IRQ status.
Definition: LR11x0.cpp:433
-
LR11x0::setPacketReceivedAction
void setPacketReceivedAction(void(*func)(void))
Sets interrupt service routine to call when a packet is received.
Definition: LR11x0.cpp:310
-
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:803
-
LR11x0::reset
int16_t reset()
Reset method. Will reset the chip to the default state using RST pin.
Definition: LR11x0.cpp:123
-
LR11x0::clearDio1Action
void clearDio1Action()
Clears interrupt service routine to call when DIO1 activates.
Definition: LR11x0.cpp:306
-
LR11x0::getTimeOnAir
uint32_t getTimeOnAir(size_t len) override
Get expected time-on-air for a given size of payload.
Definition: LR11x0.cpp:737
+
LR11x0::getIrqStatus
uint32_t getIrqStatus()
Reads the current IRQ status.
Definition: LR11x0.cpp:466
+
LR11x0::setBitRate
int16_t setBitRate(float br)
Sets GFSK bit rate. Allowed values range from 0.6 to 300.0 kbps.
Definition: LR11x0.cpp:613
+
LR11x0::setDataRate
int16_t setDataRate(DataRate_t dr) override
Set data.
Definition: LR11x0.cpp:882
+
LR11x0::setPacketReceivedAction
void setPacketReceivedAction(void(*func)(void))
Sets interrupt service routine to call when a packet is received.
Definition: LR11x0.cpp:343
+
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:1183
+
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:650
+
LR11x0::reset
int16_t reset()
Reset method. Will reset the chip to the default state using RST pin.
Definition: LR11x0.cpp:156
+
LR11x0::clearDio1Action
void clearDio1Action()
Clears interrupt service routine to call when DIO1 activates.
Definition: LR11x0.cpp:339
+
LR11x0::getTimeOnAir
uint32_t getTimeOnAir(size_t len) override
Get expected time-on-air for a given size of payload.
Definition: LR11x0.cpp:1117
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::XTAL
bool XTAL
Whether the module has an XTAL (true) or TCXO (false). Defaults to false.
Definition: LR11x0.h:559
-
LR11x0::getRSSI
float getRSSI()
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet. Only available for LoRa o...
Definition: LR11x0.cpp:683
+
LR11x0::getRSSI
float getRSSI()
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet. Only available for LoRa o...
Definition: LR11x0.cpp:1063
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:912
+
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:1006
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:543
-
LR11x0::clearPacketReceivedAction
void clearPacketReceivedAction()
Clears interrupt service routine to call when a packet is received.
Definition: LR11x0.cpp:314
-
LR11x0::standby
int16_t standby() override
Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator)...
Definition: LR11x0.cpp:262
-
LR11x0::setPacketSentAction
void setPacketSentAction(void(*func)(void))
Sets interrupt service routine to call when a packet is sent.
Definition: LR11x0.cpp:318
+
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:576
+
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:811
+
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:849
+
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:760
+
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:739
+
LR11x0::clearPacketReceivedAction
void clearPacketReceivedAction()
Clears interrupt service routine to call when a packet is received.
Definition: LR11x0.cpp:347
+
LR11x0::standby
int16_t standby() override
Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator)...
Definition: LR11x0.cpp:295
+
LR11x0::setPacketSentAction
void setPacketSentAction(void(*func)(void))
Sets interrupt service routine to call when a packet is sent.
Definition: LR11x0.cpp:351
+
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:845
LR11x0::begin
int16_t begin(float bw, uint8_t sf, uint8_t cr, uint8_t syncWord, uint16_t preambleLength, float tcxoVoltage)
Initialization method for LoRa modem.
Definition: LR11x0.cpp:16
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::setTCXO
int16_t setTCXO(float voltage, uint32_t delay=5000)
Sets TCXO (Temperature Compensated Crystal Oscillator) configuration.
Definition: LR11x0.cpp:593
-
LR11x0::setDio1Action
void setDio1Action(void(*func)(void))
Sets interrupt service routine to call when DIO1 activates.
Definition: LR11x0.cpp:302
-
LR11x0::setPreambleLength
int16_t setPreambleLength(size_t preambleLength) override
Sets preamble length for LoRa or FSK modem. Allowed values range from 1 to 65535.
Definition: LR11x0.cpp:580
-
LR11x0::startReceive
int16_t startReceive()
Interrupt-driven receive method with default parameters. Implemented for compatibility with PhysicalL...
Definition: LR11x0.cpp:389
-
LR11x0::finishTransmit
int16_t finishTransmit() override
Clean up after transmission is done.
Definition: LR11x0.cpp:381
+
LR11x0::setTCXO
int16_t setTCXO(float voltage, uint32_t delay=5000)
Sets TCXO (Temperature Compensated Crystal Oscillator) configuration.
Definition: LR11x0.cpp:951
+
LR11x0::setDio1Action
void setDio1Action(void(*func)(void))
Sets interrupt service routine to call when DIO1 activates.
Definition: LR11x0.cpp:335
+
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:934
+
LR11x0::startReceive
int16_t startReceive()
Interrupt-driven receive method with default parameters. Implemented for compatibility with PhysicalL...
Definition: LR11x0.cpp:422
+
LR11x0::finishTransmit
int16_t finishTransmit() override
Clean up after transmission is done.
Definition: LR11x0.cpp:414
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::beginGFSK
int16_t beginGFSK(float br, float freqDev, float rxBw, uint16_t preambleLength, float tcxoVoltage)
Initialization method for FSK modem.
Definition: LR11x0.cpp:84
-
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:486
-
LR11x0::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: LR11x0.cpp:718
-
LR11x0::clearPacketSentAction
void clearPacketSentAction()
Clears interrupt service routine to call when a packet is sent.
Definition: LR11x0.cpp:322
-
LR11x0::setCRC
int16_t setCRC(uint8_t len, uint16_t initial=0x1D0F, uint16_t polynomial=0x1021, bool inverted=true)
Sets CRC configuration.
Definition: LR11x0.cpp:648
-
LR11x0::getSNR
float getSNR()
Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem.
Definition: LR11x0.cpp:700
-
LR11x0::getFrequencyError
float getFrequencyError()
Gets frequency error of the latest received packet.
Definition: LR11x0.cpp:713
-
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:522
-
LR11x0::setSyncWord
int16_t setSyncWord(uint8_t syncWord)
Sets LoRa sync word.
Definition: LR11x0.cpp:576
-
LR11x0::invertIQ
int16_t invertIQ(bool enable) override
Enable/disable inversion of the I and Q signals.
Definition: LR11x0.cpp:670
+
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:519
+
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:630
+
LR11x0::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: LR11x0.cpp:1098
+
LR11x0::clearPacketSentAction
void clearPacketSentAction()
Clears interrupt service routine to call when a packet is sent.
Definition: LR11x0.cpp:355
+
LR11x0::getSNR
float getSNR()
Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem.
Definition: LR11x0.cpp:1080
+
LR11x0::getFrequencyError
float getFrequencyError()
Gets frequency error of the latest received packet.
Definition: LR11x0.cpp:1093
+
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:853
+
LR11x0::setWhitening
int16_t setWhitening(bool enabled, uint16_t initial=0x01FF)
Sets GFSK whitening parameters.
Definition: LR11x0.cpp:857
+
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:555
+
LR11x0::disableAddressFiltering
int16_t disableAddressFiltering()
Disables address filtering. Calling this method will also erase previously set addresses.
Definition: LR11x0.cpp:797
+
LR11x0::setSyncWord
int16_t setSyncWord(uint8_t syncWord)
Sets LoRa sync word.
Definition: LR11x0.cpp:609
+
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:779
+
LR11x0::invertIQ
int16_t invertIQ(bool enable) override
Enable/disable inversion of the I and Q signals.
Definition: LR11x0.cpp:1050
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
@@ -936,6 +980,7 @@ $(document).ready(function(){initNavTree('_l_r11x0_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::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
+
DataRate_t
Common data rate structure.
Definition: PhysicalLayer.h:38
diff --git a/class_l_r1110-members.html b/class_l_r1110-members.html index 5269acc4..06e1a076 100644 --- a/class_l_r1110-members.html +++ b/class_l_r1110-members.html @@ -95,13 +95,15 @@ $(document).ready(function(){initNavTree('class_l_r1110.html',''); initResizable beginGFSK(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)LR1110 LR11x0::beginGFSK(float br, float freqDev, float rxBw, uint16_t preambleLength, float tcxoVoltage)LR11x0 calculateRxTimeout(uint32_t timeoutUs)PhysicalLayervirtual - checkDataRate(DataRate_t dr)PhysicalLayervirtual + checkDataRate(DataRate_t dr) overrideLR11x0virtual clearChannelScanAction()PhysicalLayervirtual clearDio1Action()LR11x0 clearPacketReceivedAction()LR11x0virtual clearPacketSentAction()LR11x0virtual - dropSync()PhysicalLayer - finishTransmit() overrideLR11x0virtual + disableAddressFiltering()LR11x0 + dropSync()PhysicalLayer + finishTransmit() overrideLR11x0virtual + fixedPacketLengthMode(uint8_t len=RADIOLIB_LR11X0_MAX_PACKET_LENGTH)LR11x0 getChannelScanResult()PhysicalLayervirtual getDataRate() constLR11x0 getFreqStep() constPhysicalLayer @@ -131,48 +133,54 @@ $(document).ready(function(){initNavTree('class_l_r1110.html',''); initResizable reset()LR11x0 scanChannel()PhysicalLayervirtual setBandwidth(float bw)LR11x0 - setBitRate(float br)PhysicalLayervirtual - setChannelScanAction(void(*func)(void))PhysicalLayervirtual - setCodingRate(uint8_t cr, bool longInterleave=false)LR11x0 - setCRC(uint8_t len, uint16_t initial=0x1D0F, uint16_t polynomial=0x1021, bool inverted=true)LR11x0 - setDataRate(DataRate_t dr)PhysicalLayervirtual - setDataShaping(uint8_t sh)PhysicalLayervirtual - setDio1Action(void(*func)(void))LR11x0 - setDIOMapping(uint32_t pin, uint32_t value)PhysicalLayervirtual - setDirectAction(void(*func)(void))PhysicalLayervirtual - setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer - setEncoding(uint8_t encoding)PhysicalLayervirtual - setFrequency(float freq)LR1110virtual - setFrequency(float freq, bool calibrate, float band=4)LR1110 - setFrequencyDeviation(float freqDev)PhysicalLayervirtual + setBitRate(float br)LR11x0virtual + setBroadcastAddress(uint8_t broadAddr)LR11x0 + setChannelScanAction(void(*func)(void))PhysicalLayervirtual + setCodingRate(uint8_t cr, bool longInterleave=false)LR11x0 + setCRC(uint8_t len, uint32_t initial=0x00001D0FUL, uint32_t polynomial=0x00001021UL, bool inverted=true)LR11x0 + setDataRate(DataRate_t dr) overrideLR11x0virtual + setDataShaping(uint8_t sh) overrideLR11x0virtual + setDio1Action(void(*func)(void))LR11x0 + setDIOMapping(uint32_t pin, uint32_t value)PhysicalLayervirtual + setDirectAction(void(*func)(void))PhysicalLayervirtual + setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer + setEncoding(uint8_t encoding) overrideLR11x0virtual + setFrequency(float freq)LR1110virtual + setFrequency(float freq, bool calibrate, float band=4)LR1110 + setFrequencyDeviation(float freqDev) overrideLR11x0virtual + setNodeAddress(uint8_t nodeAddr)LR11x0 setOutputPower(int8_t power)LR1110virtual setOutputPower(int8_t power, bool forceHighPower)LR1110 setPacketReceivedAction(void(*func)(void))LR11x0virtual setPacketSentAction(void(*func)(void))LR11x0virtual setPreambleLength(size_t preambleLength) overrideLR11x0virtual - setSpreadingFactor(uint8_t sf, bool legacy=false)LR11x0 + setRxBandwidth(float rxBw)LR11x0 + setSpreadingFactor(uint8_t sf, bool legacy=false)LR11x0 + setSyncBits(uint8_t *syncWord, uint8_t bitsLen)LR11x0 setSyncWord(uint8_t syncWord)LR11x0 - PhysicalLayer::setSyncWord(uint8_t *sync, size_t len)PhysicalLayervirtual + setSyncWord(uint8_t *syncWord, size_t len) overrideLR11x0virtual setTCXO(float voltage, uint32_t delay=5000)LR11x0 - sleep(bool retainConfig=true, uint32_t sleepTime=0)LR11x0 - PhysicalLayer::sleep()PhysicalLayervirtual - standby() overrideLR11x0virtual - standby(uint8_t mode, bool wakeup=true)LR11x0 - PhysicalLayer::standby(uint8_t mode)PhysicalLayervirtual - startChannelScan()PhysicalLayervirtual - startDirect()PhysicalLayer - startReceive()LR11x0virtual - startReceive(uint32_t timeout, uint32_t irqFlags=RADIOLIB_LR11X0_IRQ_RX_DONE, size_t len=0)LR11x0 - PhysicalLayer::startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len)PhysicalLayervirtual - startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideLR11x0virtual - startTransmit(const char *str, uint8_t addr=0)LR11x0 - startTransmit(uint8_t *data, size_t len, uint8_t addr=0)LR11x0 - PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer - transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideLR11x0virtual - transmit(const char *str, uint8_t addr=0)LR11x0 - transmit(uint8_t *data, size_t len, uint8_t addr=0)LR11x0 - PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer - transmitDirect(uint32_t frf=0)PhysicalLayervirtual + setWhitening(bool enabled, uint16_t initial=0x01FF)LR11x0 + sleep(bool retainConfig=true, uint32_t sleepTime=0)LR11x0 + PhysicalLayer::sleep()PhysicalLayervirtual + standby() overrideLR11x0virtual + standby(uint8_t mode, bool wakeup=true)LR11x0 + PhysicalLayer::standby(uint8_t mode)PhysicalLayervirtual + startChannelScan()PhysicalLayervirtual + startDirect()PhysicalLayer + startReceive()LR11x0virtual + startReceive(uint32_t timeout, uint32_t irqFlags=RADIOLIB_LR11X0_IRQ_RX_DONE, size_t len=0)LR11x0 + PhysicalLayer::startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len)PhysicalLayervirtual + startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideLR11x0virtual + startTransmit(const char *str, uint8_t addr=0)LR11x0 + startTransmit(uint8_t *data, size_t len, uint8_t addr=0)LR11x0 + PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer + transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideLR11x0virtual + transmit(const char *str, uint8_t addr=0)LR11x0 + transmit(uint8_t *data, size_t len, uint8_t addr=0)LR11x0 + PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer + transmitDirect(uint32_t frf=0)PhysicalLayervirtual + variablePacketLengthMode(uint8_t maxLen=RADIOLIB_LR11X0_MAX_PACKET_LENGTH)LR11x0 XTALLR11x0 diff --git a/class_l_r1110.html b/class_l_r1110.html index ae9a96a1..fb0d4aaf 100644 --- a/class_l_r1110.html +++ b/class_l_r1110.html @@ -207,15 +207,60 @@ void int16_t setSyncWord (uint8_t syncWord)  Sets LoRa sync word. More...
  +int16_t setBitRate (float br) + Sets GFSK bit rate. Allowed values range from 0.6 to 300.0 kbps. More...
+  +int16_t setFrequencyDeviation (float freqDev) override + Sets GFSK frequency deviation. Allowed values range from 0.0 to 200.0 kHz. More...
+  +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.5, 23.4, 29.3, 39.0, 46.9, 58.6, 78.2, 93.8, 117.3, 156.2, 187.2, 234.3, 312.0, 373.6 and 467.0 kHz. More...
+  +int16_t setSyncWord (uint8_t *syncWord, size_t len) override + Sets GFSK sync word in the form of array of up to 8 bytes. More...
+  +int16_t setSyncBits (uint8_t *syncWord, uint8_t bitsLen) + Sets GFSK sync word in the form of array of up to 8 bytes. More...
+  +int16_t setNodeAddress (uint8_t nodeAddr) + Sets node address. Calling this method will also enable address filtering for node address only. More...
+  +int16_t setBroadcastAddress (uint8_t broadAddr) + Sets broadcast address. Calling this method will also enable address filtering for node and broadcast address. More...
+  +int16_t disableAddressFiltering () + Disables address filtering. Calling this method will also erase previously set addresses. More...
+  +int16_t setDataShaping (uint8_t sh) override + Sets time-bandwidth product of Gaussian filter applied for shaping. Allowed values are RADIOLIB_SHAPING_0_3, RADIOLIB_SHAPING_0_5, RADIOLIB_SHAPING_0_7 or RADIOLIB_SHAPING_1_0. Set to RADIOLIB_SHAPING_NONE to disable data shaping. More...
+  +int16_t setEncoding (uint8_t encoding) override + Sets transmission encoding. Available in GFSK mode only. Serves only as alias for PhysicalLayer compatibility. More...
+  +int16_t fixedPacketLengthMode (uint8_t len=RADIOLIB_LR11X0_MAX_PACKET_LENGTH) + Set modem in fixed packet length mode. Available in GFSK mode only. More...
+  +int16_t variablePacketLengthMode (uint8_t maxLen=RADIOLIB_LR11X0_MAX_PACKET_LENGTH) + Set modem in variable packet length mode. Available in GFSK mode only. More...
+  +int16_t setWhitening (bool enabled, uint16_t initial=0x01FF) + Sets GFSK whitening parameters. More...
+  +int16_t setDataRate (DataRate_t dr) override + Set data. More...
+  +int16_t checkDataRate (DataRate_t dr) override + Check the data rate can be configured by this module. More...
+  int16_t setPreambleLength (size_t preambleLength) override - Sets preamble length for LoRa or FSK modem. Allowed values range from 1 to 65535. More...
+ Sets preamble length for LoRa or GFSK modem. Allowed values range from 1 to 65535. More...
  int16_t setTCXO (float voltage, uint32_t delay=5000)  Sets TCXO (Temperature Compensated Crystal Oscillator) configuration. More...
  -int16_t setCRC (uint8_t len, uint16_t initial=0x1D0F, uint16_t polynomial=0x1021, bool inverted=true) - Sets CRC configuration. More...
-  +int16_t setCRC (uint8_t len, uint32_t initial=0x00001D0FUL, uint32_t polynomial=0x00001021UL, bool inverted=true) + Sets CRC configuration. More...
+  int16_t invertIQ (bool enable) override  Enable/disable inversion of the I and Q signals. More...
  @@ -283,27 +328,6 @@ void virtual int16_t receiveDirect ()  Enables direct reception mode on pins DIO1 (clock) and DIO2 (data). Must be implemented in module class. While in direct mode, the module will not be able to transmit or receive packets. Can only be activated in FSK mode. More...
  -virtual int16_t setBitRate (float br) - Sets FSK bit rate. Only available in FSK mode. Must be implemented in module class. More...
-  -virtual int16_t setFrequencyDeviation (float freqDev) - Sets FSK frequency deviation from carrier frequency. Only available in FSK mode. Must be implemented in module class. More...
-  -virtual int16_t setDataShaping (uint8_t sh) - Sets GFSK data shaping. Only available in FSK mode. Must be implemented in module class. More...
-  -virtual int16_t setEncoding (uint8_t encoding) - Sets FSK data encoding. Only available in FSK mode. Must be implemented in module class. More...
-  -virtual int16_t setSyncWord (uint8_t *sync, size_t len) - Set sync word. Must be implemented in module class if the module supports it. More...
-  -virtual int16_t setDataRate (DataRate_t dr) - Set data. Must be implemented in module class if the module supports it. More...
-  -virtual int16_t checkDataRate (DataRate_t dr) - Check the data rate can be configured by this module. Must be implemented in module class if the module supports it. More...
-  float getFreqStep () const  Gets the module frequency step size that was set in constructor. More...
  diff --git a/class_l_r11x0-members.html b/class_l_r11x0-members.html index 0e401086..4a270512 100644 --- a/class_l_r11x0-members.html +++ b/class_l_r11x0-members.html @@ -93,13 +93,15 @@ $(document).ready(function(){initNavTree('class_l_r11x0.html',''); initResizable begin(float bw, uint8_t sf, uint8_t cr, uint8_t syncWord, uint16_t preambleLength, float tcxoVoltage)LR11x0 beginGFSK(float br, float freqDev, float rxBw, uint16_t preambleLength, float tcxoVoltage)LR11x0 calculateRxTimeout(uint32_t timeoutUs)PhysicalLayervirtual - checkDataRate(DataRate_t dr)PhysicalLayervirtual + checkDataRate(DataRate_t dr) overrideLR11x0virtual clearChannelScanAction()PhysicalLayervirtual clearDio1Action()LR11x0 clearPacketReceivedAction()LR11x0virtual clearPacketSentAction()LR11x0virtual - dropSync()PhysicalLayer - finishTransmit() overrideLR11x0virtual + disableAddressFiltering()LR11x0 + dropSync()PhysicalLayer + finishTransmit() overrideLR11x0virtual + fixedPacketLengthMode(uint8_t len=RADIOLIB_LR11X0_MAX_PACKET_LENGTH)LR11x0 getChannelScanResult()PhysicalLayervirtual getDataRate() constLR11x0 getFreqStep() constPhysicalLayer @@ -128,46 +130,52 @@ $(document).ready(function(){initNavTree('class_l_r11x0.html',''); initResizable reset()LR11x0 scanChannel()PhysicalLayervirtual setBandwidth(float bw)LR11x0 - setBitRate(float br)PhysicalLayervirtual - setChannelScanAction(void(*func)(void))PhysicalLayervirtual - setCodingRate(uint8_t cr, bool longInterleave=false)LR11x0 - setCRC(uint8_t len, uint16_t initial=0x1D0F, uint16_t polynomial=0x1021, bool inverted=true)LR11x0 - setDataRate(DataRate_t dr)PhysicalLayervirtual - setDataShaping(uint8_t sh)PhysicalLayervirtual - setDio1Action(void(*func)(void))LR11x0 - setDIOMapping(uint32_t pin, uint32_t value)PhysicalLayervirtual - setDirectAction(void(*func)(void))PhysicalLayervirtual - setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer - setEncoding(uint8_t encoding)PhysicalLayervirtual - setFrequency(float freq)PhysicalLayervirtual - setFrequencyDeviation(float freqDev)PhysicalLayervirtual + setBitRate(float br)LR11x0virtual + setBroadcastAddress(uint8_t broadAddr)LR11x0 + setChannelScanAction(void(*func)(void))PhysicalLayervirtual + setCodingRate(uint8_t cr, bool longInterleave=false)LR11x0 + setCRC(uint8_t len, uint32_t initial=0x00001D0FUL, uint32_t polynomial=0x00001021UL, bool inverted=true)LR11x0 + setDataRate(DataRate_t dr) overrideLR11x0virtual + setDataShaping(uint8_t sh) overrideLR11x0virtual + setDio1Action(void(*func)(void))LR11x0 + setDIOMapping(uint32_t pin, uint32_t value)PhysicalLayervirtual + setDirectAction(void(*func)(void))PhysicalLayervirtual + setDirectSyncWord(uint32_t syncWord, uint8_t len)PhysicalLayer + setEncoding(uint8_t encoding) overrideLR11x0virtual + setFrequency(float freq)PhysicalLayervirtual + setFrequencyDeviation(float freqDev) overrideLR11x0virtual + setNodeAddress(uint8_t nodeAddr)LR11x0 setOutputPower(int8_t power)PhysicalLayervirtual setPacketReceivedAction(void(*func)(void))LR11x0virtual setPacketSentAction(void(*func)(void))LR11x0virtual setPreambleLength(size_t preambleLength) overrideLR11x0virtual - setSpreadingFactor(uint8_t sf, bool legacy=false)LR11x0 + setRxBandwidth(float rxBw)LR11x0 + setSpreadingFactor(uint8_t sf, bool legacy=false)LR11x0 + setSyncBits(uint8_t *syncWord, uint8_t bitsLen)LR11x0 setSyncWord(uint8_t syncWord)LR11x0 - PhysicalLayer::setSyncWord(uint8_t *sync, size_t len)PhysicalLayervirtual + setSyncWord(uint8_t *syncWord, size_t len) overrideLR11x0virtual setTCXO(float voltage, uint32_t delay=5000)LR11x0 - sleep(bool retainConfig=true, uint32_t sleepTime=0)LR11x0 - PhysicalLayer::sleep()PhysicalLayervirtual - standby() overrideLR11x0virtual - standby(uint8_t mode, bool wakeup=true)LR11x0 - PhysicalLayer::standby(uint8_t mode)PhysicalLayervirtual - startChannelScan()PhysicalLayervirtual - startDirect()PhysicalLayer - startReceive()LR11x0virtual - startReceive(uint32_t timeout, uint32_t irqFlags=RADIOLIB_LR11X0_IRQ_RX_DONE, size_t len=0)LR11x0 - PhysicalLayer::startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len)PhysicalLayervirtual - startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideLR11x0virtual - startTransmit(const char *str, uint8_t addr=0)LR11x0 - startTransmit(uint8_t *data, size_t len, uint8_t addr=0)LR11x0 - PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer - transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideLR11x0virtual - transmit(const char *str, uint8_t addr=0)LR11x0 - transmit(uint8_t *data, size_t len, uint8_t addr=0)LR11x0 - PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer - transmitDirect(uint32_t frf=0)PhysicalLayervirtual + setWhitening(bool enabled, uint16_t initial=0x01FF)LR11x0 + sleep(bool retainConfig=true, uint32_t sleepTime=0)LR11x0 + PhysicalLayer::sleep()PhysicalLayervirtual + standby() overrideLR11x0virtual + standby(uint8_t mode, bool wakeup=true)LR11x0 + PhysicalLayer::standby(uint8_t mode)PhysicalLayervirtual + startChannelScan()PhysicalLayervirtual + startDirect()PhysicalLayer + startReceive()LR11x0virtual + startReceive(uint32_t timeout, uint32_t irqFlags=RADIOLIB_LR11X0_IRQ_RX_DONE, size_t len=0)LR11x0 + PhysicalLayer::startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len)PhysicalLayervirtual + startTransmit(uint8_t *data, size_t len, uint8_t addr=0) overrideLR11x0virtual + startTransmit(const char *str, uint8_t addr=0)LR11x0 + startTransmit(uint8_t *data, size_t len, uint8_t addr=0)LR11x0 + PhysicalLayer::startTransmit(const char *str, uint8_t addr=0)PhysicalLayer + transmit(uint8_t *data, size_t len, uint8_t addr=0) overrideLR11x0virtual + transmit(const char *str, uint8_t addr=0)LR11x0 + transmit(uint8_t *data, size_t len, uint8_t addr=0)LR11x0 + PhysicalLayer::transmit(const char *str, uint8_t addr=0)PhysicalLayer + transmitDirect(uint32_t frf=0)PhysicalLayervirtual + variablePacketLengthMode(uint8_t maxLen=RADIOLIB_LR11X0_MAX_PACKET_LENGTH)LR11x0 XTALLR11x0 diff --git a/class_l_r11x0.html b/class_l_r11x0.html index fb6cf51c..9755ed0f 100644 --- a/class_l_r11x0.html +++ b/class_l_r11x0.html @@ -181,15 +181,60 @@ void int16_t setSyncWord (uint8_t syncWord)  Sets LoRa sync word. More...
  +int16_t setBitRate (float br) + Sets GFSK bit rate. Allowed values range from 0.6 to 300.0 kbps. More...
+  +int16_t setFrequencyDeviation (float freqDev) override + Sets GFSK frequency deviation. Allowed values range from 0.0 to 200.0 kHz. More...
+  +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.5, 23.4, 29.3, 39.0, 46.9, 58.6, 78.2, 93.8, 117.3, 156.2, 187.2, 234.3, 312.0, 373.6 and 467.0 kHz. More...
+  +int16_t setSyncWord (uint8_t *syncWord, size_t len) override + Sets GFSK sync word in the form of array of up to 8 bytes. More...
+  +int16_t setSyncBits (uint8_t *syncWord, uint8_t bitsLen) + Sets GFSK sync word in the form of array of up to 8 bytes. More...
+  +int16_t setNodeAddress (uint8_t nodeAddr) + Sets node address. Calling this method will also enable address filtering for node address only. More...
+  +int16_t setBroadcastAddress (uint8_t broadAddr) + Sets broadcast address. Calling this method will also enable address filtering for node and broadcast address. More...
+  +int16_t disableAddressFiltering () + Disables address filtering. Calling this method will also erase previously set addresses. More...
+  +int16_t setDataShaping (uint8_t sh) override + Sets time-bandwidth product of Gaussian filter applied for shaping. Allowed values are RADIOLIB_SHAPING_0_3, RADIOLIB_SHAPING_0_5, RADIOLIB_SHAPING_0_7 or RADIOLIB_SHAPING_1_0. Set to RADIOLIB_SHAPING_NONE to disable data shaping. More...
+  +int16_t setEncoding (uint8_t encoding) override + Sets transmission encoding. Available in GFSK mode only. Serves only as alias for PhysicalLayer compatibility. More...
+  +int16_t fixedPacketLengthMode (uint8_t len=RADIOLIB_LR11X0_MAX_PACKET_LENGTH) + Set modem in fixed packet length mode. Available in GFSK mode only. More...
+  +int16_t variablePacketLengthMode (uint8_t maxLen=RADIOLIB_LR11X0_MAX_PACKET_LENGTH) + Set modem in variable packet length mode. Available in GFSK mode only. More...
+  +int16_t setWhitening (bool enabled, uint16_t initial=0x01FF) + Sets GFSK whitening parameters. More...
+  +int16_t setDataRate (DataRate_t dr) override + Set data. More...
+  +int16_t checkDataRate (DataRate_t dr) override + Check the data rate can be configured by this module. More...
+  int16_t setPreambleLength (size_t preambleLength) override - Sets preamble length for LoRa or FSK modem. Allowed values range from 1 to 65535. More...
+ Sets preamble length for LoRa or GFSK modem. Allowed values range from 1 to 65535. More...
  int16_t setTCXO (float voltage, uint32_t delay=5000)  Sets TCXO (Temperature Compensated Crystal Oscillator) configuration. More...
  -int16_t setCRC (uint8_t len, uint16_t initial=0x1D0F, uint16_t polynomial=0x1021, bool inverted=true) - Sets CRC configuration. More...
-  +int16_t setCRC (uint8_t len, uint32_t initial=0x00001D0FUL, uint32_t polynomial=0x00001021UL, bool inverted=true) + Sets CRC configuration. More...
+  int16_t invertIQ (bool enable) override  Enable/disable inversion of the I and Q signals. More...
  @@ -260,30 +305,9 @@ void virtual int16_t setFrequency (float freq)  Sets carrier frequency. Must be implemented in module class. More...
  -virtual int16_t setBitRate (float br) - Sets FSK bit rate. Only available in FSK mode. Must be implemented in module class. More...
-  -virtual int16_t setFrequencyDeviation (float freqDev) - Sets FSK frequency deviation from carrier frequency. Only available in FSK mode. Must be implemented in module class. More...
-  -virtual int16_t setDataShaping (uint8_t sh) - Sets GFSK data shaping. Only available in FSK mode. Must be implemented in module class. More...
-  -virtual int16_t setEncoding (uint8_t encoding) - Sets FSK data encoding. Only available in FSK mode. Must be implemented in module class. More...
-  virtual int16_t setOutputPower (int8_t power)  Set output power. Must be implemented in module class if the module supports it. More...
  -virtual int16_t setSyncWord (uint8_t *sync, size_t len) - Set sync word. Must be implemented in module class if the module supports it. More...
-  -virtual int16_t setDataRate (DataRate_t dr) - Set data. Must be implemented in module class if the module supports it. More...
-  -virtual int16_t checkDataRate (DataRate_t dr) - Check the data rate can be configured by this module. Must be implemented in module class if the module supports it. More...
-  float getFreqStep () const  Gets the module frequency step size that was set in constructor. More...
  @@ -505,6 +529,63 @@ bool 
Returns
Status Codes
+ + + +

◆ checkDataRate()

+ +
+
+ + + + + +
+ + + + + + + + +
int16_t LR11x0::checkDataRate (DataRate_t dr)
+ 		+overridevirtual
+
+ +

Check the data rate can be configured by this module.

+
Parameters
+ + +
drData rate struct. Interpretation depends on currently active modem (GFSK or LoRa).
+
+
+
Returns
Status Codes
+ +

Reimplemented from PhysicalLayer.

+ +
+
+ +

◆ disableAddressFiltering()

+ +
+
+ + + + + + + +
int16_t LR11x0::disableAddressFiltering ()
+
+ +

Disables address filtering. Calling this method will also erase previously set addresses.

+
Returns
Status Codes
+
@@ -535,6 +616,33 @@ bool PhysicalLayer.

+ + + +

◆ fixedPacketLengthMode()

+ +
+
+ + + + + + + + +
int16_t LR11x0::fixedPacketLengthMode (uint8_t len = RADIOLIB_LR11X0_MAX_PACKET_LENGTH)
+
+ +

Set modem in fixed packet length mode. Available in GFSK mode only.

+
Parameters
+ + +
lenPacket length.
+
+
+
Returns
Status Codes
+
@@ -995,6 +1103,70 @@ bool 
Returns
Status Codes
+ + + +

◆ setBitRate()

+ +
+
+ + + + + +
+ + + + + + + + +
int16_t LR11x0::setBitRate (float br)
+ 		+virtual
+
+ +

Sets GFSK bit rate. Allowed values range from 0.6 to 300.0 kbps.

+
Parameters
+ + +
brFSK bit rate to be set in kbps.
+
+
+
Returns
Status Codes
+ +

Reimplemented from PhysicalLayer.

+ +
+
+ +

◆ setBroadcastAddress()

+ +
+
+ + + + + + + + +
int16_t LR11x0::setBroadcastAddress (uint8_t broadAddr)
+
+ +

Sets broadcast address. Calling this method will also enable address filtering for node and broadcast address.

+
Parameters
+ + +
broadAddrNode address to be set.
+
+
+
Returns
Status Codes
+
@@ -1035,8 +1207,8 @@ bool  -

◆ setCRC()

+ +

◆ setCRC()

@@ -1050,14 +1222,14 @@ bool  - uint16_t  - initial = 0x1D0F, + uint32_t  + initial = 0x00001D0FUL, - uint16_t  - polynomial = 0x1021, + uint32_t  + polynomial = 0x00001021UL, @@ -1077,14 +1249,88 @@ bool 
Parameters
- - - + + +
lenCRC length in bytes, Allowed values are 1 or 2, set to 0 to disable CRC.
initialInitial CRC value. FSK only. Defaults to 0x1D0F (CCIT CRC).
polynomialPolynomial for CRC calculation. FSK only. Defaults to 0x1021 (CCIT CRC).
invertedInvert CRC bytes. FSK only. Defaults to true (CCIT CRC).
initialInitial CRC value. GFSK only. Defaults to 0x1D0F (CCIT CRC).
polynomialPolynomial for CRC calculation. GFSK only. Defaults to 0x1021 (CCIT CRC).
invertedInvert CRC bytes. GFSK only. Defaults to true (CCIT CRC).
Returns
Status Codes
+
+
+ +

◆ setDataRate()

+ +
+
+ + + + + +
+ + + + + + + + +
int16_t LR11x0::setDataRate (DataRate_t dr)
+ 		+overridevirtual
+
+ +

Set data.

+
Parameters
+ + +
drData rate struct. Interpretation depends on currently active modem (GFSK or LoRa).
+
+
+
Returns
Status Codes
+ +

Reimplemented from PhysicalLayer.

+ +
+
+ +

◆ setDataShaping()

+ +
+
+ + + + + +
+ + + + + + + + +
int16_t LR11x0::setDataShaping (uint8_t sh)
+ 		+overridevirtual
+
+ +

Sets time-bandwidth product of Gaussian filter applied for shaping. Allowed values are RADIOLIB_SHAPING_0_3, RADIOLIB_SHAPING_0_5, RADIOLIB_SHAPING_0_7 or RADIOLIB_SHAPING_1_0. Set to RADIOLIB_SHAPING_NONE to disable data shaping.

+
Parameters
+ + +
shTime-bandwidth product of Gaussian filter to be set.
+
+
+
Returns
Status Codes
+ +

Reimplemented from PhysicalLayer.

+
@@ -1111,6 +1357,107 @@ bool  +

◆ setEncoding()

+ +
+
+ + + + + +
+ + + + + + + + +
int16_t LR11x0::setEncoding (uint8_t encoding)
+ 		+overridevirtual
+
+ +

Sets transmission encoding. Available in GFSK mode only. Serves only as alias for PhysicalLayer compatibility.

+
Parameters
+ + +
encodingEncoding to be used. Set to 0 for NRZ, and 2 for whitening.
+
+
+
Returns
Status Codes
+ +

Reimplemented from PhysicalLayer.

+ +
+
+ +

◆ setFrequencyDeviation()

+ +
+
+ + + + + +
+ + + + + + + + +
int16_t LR11x0::setFrequencyDeviation (float freqDev)
+ 		+overridevirtual
+
+ +

Sets GFSK frequency deviation. Allowed values range from 0.0 to 200.0 kHz.

+
Parameters
+ + +
freqDevGFSK frequency deviation to be set in kHz.
+
+
+
Returns
Status Codes
+ +

Reimplemented from PhysicalLayer.

+ +
+
+ +

◆ setNodeAddress()

+ +
+
+ + + + + + + + +
int16_t LR11x0::setNodeAddress (uint8_t nodeAddr)
+
+ +

Sets node address. Calling this method will also enable address filtering for node address only.

+
Parameters
+ + +
nodeAddrNode address to be set.
+
+
+
Returns
Status Codes
+
@@ -1209,10 +1556,10 @@ bool  -

Sets preamble length for LoRa or FSK modem. Allowed values range from 1 to 65535.

+

Sets preamble length for LoRa or GFSK modem. Allowed values range from 1 to 65535.

Parameters
- +
preambleLengthPreamble length to be set in symbols (LoRa) or bits (FSK).
preambleLengthPreamble length to be set in symbols (LoRa) or bits (GFSK).
@@ -1220,6 +1567,33 @@ bool PhysicalLayer.

+ + + +

◆ setRxBandwidth()

+ +
+
+ + + + + + + + +
int16_t LR11x0::setRxBandwidth (float rxBw)
+
+ +

Sets GFSK receiver bandwidth. Allowed values are 4.8, 5.8, 7.3, 9.7, 11.7, 14.6, 19.5, 23.4, 29.3, 39.0, 46.9, 58.6, 78.2, 93.8, 117.3, 156.2, 187.2, 234.3, 312.0, 373.6 and 467.0 kHz.

+
Parameters
+ + +
rxBwGFSK receiver bandwidth to be set in kHz.
+
+
+
Returns
Status Codes
+
@@ -1258,10 +1632,96 @@ bool 
Returns
Status Codes
+ + + +

◆ setSyncBits()

+ +
+
+ + + + + + + + + + + + + + + + + + +
int16_t LR11x0::setSyncBits (uint8_t * syncWord,
uint8_t bitsLen 
)
+
+ +

Sets GFSK sync word in the form of array of up to 8 bytes.

+
Parameters
+ + + +
syncWordGFSK sync word to be set.
bitsLenGFSK sync word length in bits. If length is not divisible by 8, least significant bits of syncWord will be ignored.
+
+
+
Returns
Status Codes
+ +
+
+ +

◆ setSyncWord() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
int16_t LR11x0::setSyncWord (uint8_t * syncWord,
size_t len 
)
+ 		+overridevirtual
+
+ +

Sets GFSK sync word in the form of array of up to 8 bytes.

+
Parameters
+ + + +
syncWordGFSK sync word to be set.
lenGFSK sync word length in bytes.
+
+
+
Returns
Status Codes
+ +

Reimplemented from PhysicalLayer.

+
-

◆ setSyncWord()

+

◆ setSyncWord() [2/2]

@@ -1323,6 +1783,44 @@ bool 
Returns
Status Codes
+
+
+ +

◆ setWhitening()

+ +
+
+ + + + + + + + + + + + + + + + + + +
int16_t LR11x0::setWhitening (bool enabled,
uint16_t initial = 0x01FF 
)
+
+ +

Sets GFSK whitening parameters.

+
Parameters
+ + + +
enabledTrue = Whitening enabled
initialInitial value used for the whitening LFSR in GFSK mode. By default set to 0x01FF for compatibility with SX127x and LoRaWAN.
+
+
+
Returns
Status Codes
+
@@ -1712,6 +2210,33 @@ bool PhysicalLayer.

+ + + +

◆ variablePacketLengthMode()

+ +
+
+ + + + + + + + +
int16_t LR11x0::variablePacketLengthMode (uint8_t maxLen = RADIOLIB_LR11X0_MAX_PACKET_LENGTH)
+
+ +

Set modem in variable packet length mode. Available in GFSK mode only.

+
Parameters
+ + +
maxLenMaximum packet length.
+
+
+
Returns
Status Codes
+
The documentation for this class was generated from the following files: