RadioLib
Universal wireless communication library for Arduino
Loading...
Searching...
No Matches
LR11x0.h
1#if !defined(_RADIOLIB_LR11X0_H)
2#define _RADIOLIB_LR11X0_H
3
4#include "../../TypeDef.h"
5
6#if !RADIOLIB_EXCLUDE_LR11X0
7
8#include "../../Module.h"
9
10#include "../LR11x0/LR_common.h"
11
12#include "LR11x0_commands.h"
13#include "LR11x0_registers.h"
14#include "LR11x0_types.h"
15
16// latest firmware versions, in the order LR1110, LR1120, LR1121
17#define RADIOLIB_LR11X0_FIRMWARE_LATEST { 0x0402, 0x0202, 0x0104 }
18
19// LR11X0 physical layer properties
20#define RADIOLIB_LR11X0_FREQUENCY_STEP_SIZE 1.0
21#define RADIOLIB_LR11X0_MAX_PACKET_LENGTH 255
22#define RADIOLIB_LR11X0_CRYSTAL_FREQ 32.0
23#define RADIOLIB_LR11X0_DIV_EXPONENT 25
24#define RADIOLIB_LR1110_LP_POUT_MIN -17
25#define RADIOLIB_LR1110_LP_POUT_MAX 14
26#define RADIOLIB_LR1110_HP_POUT_MIN -9
27#define RADIOLIB_LR1110_HP_POUT_MAX 22
28#define RADIOLIB_LR112X_LP_POUT_MIN -17
29#define RADIOLIB_LR112X_LP_POUT_MAX 14
30#define RADIOLIB_LR112X_HP_POUT_MIN -9
31#define RADIOLIB_LR112X_HP_POUT_MAX 22
32#define RADIOLIB_LR112X_HF_POUT_MIN -18
33#define RADIOLIB_LR112X_HF_POUT_MAX 13
34
40class LR11x0: public LRxxxx {
41 public:
42 // introduce PhysicalLayer overloads
49
54 explicit LR11x0(Module* mod);
55
78
85 RadioLibTCXOVoltage_t tcxoVoltage = Voltage1V6;
86
98 int16_t begin(uint32_t bw, uint8_t sf, uint8_t cr, uint8_t syncWord, uint16_t preambleLength, bool high = false);
99
108 int16_t beginGFSK(uint32_t br, uint32_t freqDev, uint32_t rxBw, uint16_t preambleLength);
109
117 int16_t beginLRFHSS(uint8_t bw, uint8_t cr, bool narrowGrid);
118
124 int16_t beginGNSS(uint8_t constellations = RADIOLIB_LR11X0_GNSS_CONSTELLATION_GPS | RADIOLIB_LR11X0_GNSS_CONSTELLATION_BEIDOU);
125
134 int16_t transmit(const uint8_t* data, size_t len, uint8_t addr = 0) override;
135
145 int16_t receive(uint8_t* data, size_t len, RadioLibTime_t timeout = 0) override;
146
152 int16_t transmitDirect(uint32_t frf = 0) override;
153
159 int16_t receiveDirect() override;
160
165 int16_t scanChannel() override;
166
172 int16_t scanChannel(const ChannelScanConfig_t &config) override;
173
179 int16_t standby() override;
180
187 int16_t standby(uint8_t mode) override;
188
196 int16_t standby(uint8_t mode, bool wakeup);
197
203 int16_t sleep() override;
204
212 int16_t sleep(bool retainConfig, uint32_t sleepTime);
213
214 // interrupt methods
215
222 int16_t startReceive() override;
223
236 int16_t startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, RadioLibIrqFlags_t irqFlags = RADIOLIB_IRQ_RX_DEFAULT_FLAGS, RadioLibIrqFlags_t irqMask = RADIOLIB_IRQ_RX_DEFAULT_MASK);
237
256 int16_t startReceiveDutyCycleAuto(uint16_t senderPreambleLength = 0, uint16_t minSymbols = 0, RadioLibIrqFlags_t irqFlags = RADIOLIB_IRQ_RX_DEFAULT_FLAGS, RadioLibIrqFlags_t irqMask = RADIOLIB_IRQ_RX_DEFAULT_MASK);
257
266 int16_t readData(uint8_t* data, size_t len) override;
267
272 int16_t finishReceive() override;
273
279 int16_t startChannelScan() override;
280
287 int16_t startChannelScan(const ChannelScanConfig_t &cfg) override;
288
293 int16_t getChannelScanResult() override;
294
295 // configuration methods
296
302 int16_t setBandwidth(uint32_t bw) override;
303
310 int16_t setBandwidth(uint32_t bw, bool high);
311
317 int16_t setSpreadingFactor(uint8_t sf) override;
318
325 int16_t setSpreadingFactor(uint8_t sf, bool legacy);
326
336 int16_t setCodingRate(uint8_t cr, bool longInterleave = false) override;
337
343 int16_t setSyncWord(uint8_t syncWord);
344
350 int16_t setBitRate(uint32_t br) override;
351
357 int16_t setFrequencyDeviation(uint32_t freqDev) override;
358
366 int16_t setRxBandwidth(uint32_t rxBw);
367
374 int16_t setSyncWord(uint8_t* syncWord, size_t len) override;
375
381 int16_t setNodeAddress(uint8_t nodeAddr);
382
389 int16_t setBroadcastAddress(uint8_t broadAddr);
390
395 int16_t disableAddressFiltering();
396
404 int16_t setDataShaping(uint8_t sh) override;
405
411 int16_t setEncoding(uint8_t encoding) override;
412
418 int16_t fixedPacketLengthMode(uint8_t len = RADIOLIB_LR11X0_MAX_PACKET_LENGTH);
419
425 int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_LR11X0_MAX_PACKET_LENGTH);
426
434 int16_t setWhitening(bool enabled, uint16_t initial = 0x01FF);
435
443 int16_t checkDataRate(DataRate_t dr, ModemType_t modem = RADIOLIB_MODEM_NONE) override;
444
452 int16_t setPreambleLength(size_t len, size_t detLen = 0xFFFFFFFF) override;
453
463 int16_t setTCXO(RadioLibTCXOVoltage_t voltage, uint32_t delay = 5000);
464
473 int16_t setCRC(uint8_t len, uint32_t initial = 0x00001D0FUL, uint32_t polynomial = 0x00001021UL, bool inverted = true);
474
480 int16_t invertIQ(bool enable) override;
481
486 float getRSSI() override;
487
495 float getRSSI(bool packet, bool skipReceive = false);
496
501 float getSNR() override;
502
507 float getVoltage();
508
513 float getTemperature();
514
520 size_t getPacketLength(bool update = true) override;
521
528 size_t getPacketLength(bool update, uint8_t* offset);
529
536 int16_t getLoRaRxHeaderInfo(uint8_t* cr, bool* hasCRC);
537
543 RadioLibTime_t getTimeOnAir(size_t len) override;
544
549 uint32_t getIrqFlags() override;
550
556 int16_t setIrqFlags(uint32_t irq) override;
557
563 int16_t clearIrqFlags(uint32_t irq) override;
564
569 uint8_t randomByte() override;
570
576 int16_t implicitHeader(size_t len);
577
582 int16_t explicitHeader();
583
588 int16_t setRegulatorLDO();
589
594 int16_t setRegulatorDCDC();
595
601 int16_t setRxBoostedGainMode(bool en);
602
620 int16_t setOutputPower(int8_t power, uint8_t paSel, uint8_t regPaSupply, uint8_t paDutyCycle, uint8_t paHpSel, uint8_t rampTime);
621
623 void setRfSwitchTable(const uint32_t (&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[]);
624
631 int16_t setStandbyXOSC(bool enable);
632
639 int16_t forceLDRO(bool enable);
640
646 int16_t autoLDRO();
647
657 int16_t setLrFhssConfig(uint8_t bw, uint8_t cr, bool narrowGrid, uint8_t hdrCount = 3, uint16_t hopSeed = 0x13A) override;
658
673 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);
674
679 void setWiFiScanAction(void (*func)(void));
680
684 void clearWiFiScanAction();
685
691 int16_t getWifiScanResultsCount(uint8_t* count);
692
702 int16_t getWifiScanResult(LR11x0WifiResult_t* result, uint8_t index, bool brief = false);
703
720 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);
721
727 int16_t getVersionInfo(LR11x0VersionInfo_t* info);
728
739 int16_t updateFirmware(const uint32_t* image, size_t size, bool nonvolatile = true);
740
745 int16_t isGnssScanCapable();
746
753 int16_t gnssScan(LR11x0GnssResult_t* res = NULL);
754
762
772 int16_t gnssDelayUntilSubframe(LR11x0GnssAlmanacStatus_t *stat, uint8_t constellation);
773
780 int16_t updateGnssAlmanac(uint8_t constellation);
781
788 int16_t getGnssPosition(LR11x0GnssPosition_t* pos, bool filtered = true);
789
796 int16_t getGnssSatellites(LR11x0GnssSatellite_t* sats, uint8_t numSats);
797
803 int16_t getModem(ModemType_t* modem) override;
804
806 int16_t getMode(RadioModeType_t* mode) override;
807
815 int16_t calibrateImageRejection(uint32_t freqMin, uint32_t freqMax);
816
818 int16_t stageMode(RadioModeType_t mode, RadioModeConfig_t* cfg) override;
819
821 int16_t launchMode() override;
822
824 int16_t writeTxBuffer(const uint8_t* data, size_t len) override;
825
827 int16_t clearTxBuffer() override;
828
829#if !RADIOLIB_GODMODE && !RADIOLIB_LOW_LEVEL
830 protected:
831#endif
832 Module* getMod() override;
833
834 // method that applies some magic workaround for specific bitrate, frequency deviation,
835 // receiver bandwidth and carrier frequencies for GFSK (and resets it in all other cases)
836 int16_t workaroundGFSK();
837
838 // LR11x0 SPI command implementations
839 int16_t writeRegMem32(uint32_t addr, const uint32_t* data, size_t len);
840 int16_t readRegMem32(uint32_t addr, uint32_t* data, size_t len);
841 int16_t writeBuffer8(const 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 getVersion(uint8_t* hw, uint8_t* device, uint8_t* major, uint8_t* minor);
847 int16_t getErrors(uint16_t* err);
848 int16_t clearErrors(void);
849 int16_t calibrate(uint8_t params);
850 int16_t setRegMode(uint8_t mode);
851 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);
852 int16_t setDioIrqParams(uint32_t irq1, uint32_t irq2);
853 int16_t setDioIrqParams(uint32_t irq);
854 int16_t clearIrqState(uint32_t irq);
855 int16_t configLfClock(uint8_t setup);
856 int16_t setTcxoMode(uint8_t tune, uint32_t delay);
857 int16_t reboot(bool stay);
858 int16_t getVbat(float* vbat);
859 int16_t getTemp(float* temp);
860 int16_t setFs(void);
861 int16_t getRandomNumber(uint32_t* rnd);
862 int16_t eraseInfoPage(void);
863 int16_t writeInfoPage(uint16_t addr, const uint32_t* data, size_t len);
864 int16_t readInfoPage(uint16_t addr, uint32_t* data, size_t len);
865 int16_t getChipEui(uint8_t* eui);
866 int16_t getSemtechJoinEui(uint8_t* eui);
867 int16_t deriveRootKeysAndGetPin(uint8_t* pin);
868 int16_t enableSpiCrc(bool en);
869 int16_t driveDiosInSleepMode(bool en);
870
871 int16_t resetStats(void);
872 int16_t getStats(uint16_t* nbPktReceived, uint16_t* nbPktCrcError, uint16_t* data1, uint16_t* data2);
873 int16_t getPacketType(uint8_t* type);
874 int16_t getRxBufferStatus(uint8_t* len, uint8_t* startOffset);
875 int16_t getPacketStatusLoRa(float* rssiPkt, float* snrPkt, float* signalRssiPkt);
876 int16_t getPacketStatusGFSK(float* rssiSync, float* rssiAvg, uint8_t* rxLen, uint8_t* stat);
877 int16_t getRssiInst(float* rssi);
878 int16_t setGfskSyncWord(uint8_t* sync);
879 int16_t setLoRaPublicNetwork(bool pub);
880 int16_t setRx(uint32_t timeout);
881 int16_t setTx(uint32_t timeout);
882 int16_t setRfFrequency(uint32_t rfFreq);
883 int16_t autoTxRx(uint32_t delay, uint8_t intMode, uint32_t timeout);
884 int16_t setCadParams(uint8_t symNum, uint8_t detPeak, uint8_t detMin, uint8_t cadExitMode, uint32_t timeout);
885 int16_t setPacketType(uint8_t type);
886 int16_t setModulationParamsLoRa(uint8_t sf, uint8_t bw, uint8_t cr, uint8_t ldro);
887 int16_t setModulationParamsGFSK(uint32_t br, uint8_t sh, uint8_t rxBw, uint32_t freqDev);
888 int16_t setModulationParamsLrFhss(uint32_t br, uint8_t sh);
889 int16_t setModulationParamsSigfox(uint32_t br, uint8_t sh);
890 int16_t setPacketParamsLoRa(uint16_t preambleLen, uint8_t hdrType, uint8_t payloadLen, uint8_t crcType, uint8_t invertIQ);
891 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);
892 int16_t setPacketParamsSigfox(uint8_t payloadLen, uint16_t rampUpDelay, uint16_t rampDownDelay, uint16_t bitNum);
893 int16_t setTxParams(int8_t pwr, uint8_t ramp);
894 int16_t setPacketAdrs(uint8_t node, uint8_t broadcast);
895 int16_t setRxTxFallbackMode(uint8_t mode);
896 int16_t setRxDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint8_t mode);
897 int16_t setPaConfig(uint8_t paSel, uint8_t regPaSupply, uint8_t paDutyCycle, uint8_t paHpSel);
898 int16_t stopTimeoutOnPreamble(bool stop);
899 int16_t setCad(void);
900 int16_t setTxCw(void);
901 int16_t setTxInfinitePreamble(void);
902 int16_t setLoRaSynchTimeout(uint16_t numSymbols);
903 int16_t setRangingAddr(uint32_t addr, uint8_t checkLen);
904 int16_t setRangingReqAddr(uint32_t addr);
905 int16_t getRangingResult(uint8_t type, float* res);
906 int16_t setRangingTxRxDelay(uint32_t delay);
907 int16_t setGfskCrcParams(uint32_t init, uint32_t poly);
908 int16_t setGfskWhitParams(uint16_t seed);
909 int16_t setRangingParameter(uint8_t symbolNum);
910 int16_t setRssiCalibration(const int8_t* tune, int16_t gainOffset);
911 int16_t setLoRaSyncWord(uint8_t sync);
912 int16_t lrFhssSetSyncWord(uint32_t sync);
913 int16_t configBleBeacon(uint8_t chan, const uint8_t* payload, size_t len);
914 int16_t bleBeaconSend(uint8_t chan, const uint8_t* payload, size_t len);
915
916 int16_t wifiScan(uint8_t type, uint16_t mask, uint8_t acqMode, uint8_t nbMaxRes, uint8_t nbScanPerChan, uint16_t timeout, uint8_t abortOnTimeout);
917 int16_t wifiScanTimeLimit(uint8_t type, uint16_t mask, uint8_t acqMode, uint8_t nbMaxRes, uint16_t timePerChan, uint16_t timeout);
918 int16_t wifiCountryCode(uint16_t mask, uint8_t nbMaxRes, uint8_t nbScanPerChan, uint16_t timeout, uint8_t abortOnTimeout);
919 int16_t wifiCountryCodeTimeLimit(uint16_t mask, uint8_t nbMaxRes, uint16_t timePerChan, uint16_t timeout);
920 int16_t wifiGetNbResults(uint8_t* nbResults);
921 int16_t wifiReadResults(uint8_t index, uint8_t nbResults, uint8_t format, uint8_t* results);
922 int16_t wifiResetCumulTimings(void);
923 int16_t wifiReadCumulTimings(uint32_t* detection, uint32_t* capture, uint32_t* demodulation);
924 int16_t wifiGetNbCountryCodeResults(uint8_t* nbResults);
925 int16_t wifiReadCountryCodeResults(uint8_t index, uint8_t nbResults, uint8_t* results);
926 int16_t wifiCfgTimestampAPphone(uint32_t timestamp);
927 int16_t wifiReadVersion(uint8_t* major, uint8_t* minor);
928
929 int16_t gnssReadRssi(int8_t* rssi);
930 int16_t gnssSetConstellationToUse(uint8_t mask);
931 int16_t gnssReadConstellationToUse(uint8_t* mask);
932 int16_t gnssSetAlmanacUpdate(uint8_t mask);
933 int16_t gnssReadAlmanacUpdate(uint8_t* mask);
934 int16_t gnssSetFreqSearchSpace(uint8_t freq);
935 int16_t gnssReadFreqSearchSpace(uint8_t* freq);
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, int16_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, const uint8_t* svnAlmanac);
953 int16_t gnssAlmanacReadAddrSize(uint32_t* addr, uint16_t* size);
954 int16_t gnssAlmanacReadSV(uint8_t svId, uint8_t* almanac);
955 int16_t gnssGetNbSvVisible(uint32_t time, float lat, float lon, uint8_t constellation, uint8_t* nbSv);
956 int16_t gnssGetSvVisible(uint8_t nbSv, uint8_t** svId, int16_t** doppler, int16_t** dopplerErr);
957 int16_t gnssPerformScan(uint8_t effort, uint8_t resMask, uint8_t nbSvMax);
958 int16_t gnssReadLastScanModeLaunched(uint8_t* lastScanMode);
959 int16_t gnssFetchTime(uint8_t effort, uint8_t opt);
960 int16_t gnssReadTime(uint8_t* err, uint32_t* time, uint32_t* nbUs, uint32_t* timeAccuracy);
961 int16_t gnssResetTime(void);
962 int16_t gnssResetPosition(void);
963 int16_t gnssReadWeekNumberRollover(uint8_t* status, uint8_t* rollover);
964 int16_t gnssReadDemodStatus(int8_t* status, uint8_t* info);
965 int16_t gnssReadCumulTiming(uint32_t* timing, uint8_t* constDemod);
966 int16_t gnssSetTime(uint32_t time, uint16_t accuracy);
967 int16_t gnssReadDopplerSolverRes(uint8_t* error, uint8_t* nbSvUsed, float* lat, float* lon, uint16_t* accuracy, uint16_t* xtal, float* latFilt, float* lonFilt, uint16_t* accuracyFilt, uint16_t* xtalFilt);
968 int16_t gnssReadDelayResetAP(uint32_t* delay);
969 int16_t gnssAlmanacUpdateFromSat(uint8_t effort, uint8_t bitMask);
970 int16_t gnssReadAlmanacStatus(uint8_t* status);
971 int16_t gnssReadKeepSyncStatus(uint8_t mask, uint8_t* nbSvVisible, uint32_t* elapsed);
972 int16_t gnssConfigAlmanacUpdatePeriod(uint8_t bitMask, uint8_t svType, uint16_t period);
973 int16_t gnssReadAlmanacUpdatePeriod(uint8_t bitMask, uint8_t svType, uint16_t* period);
974 int16_t gnssConfigDelayResetAP(uint32_t delay);
975 int16_t gnssGetSvWarmStart(uint8_t bitMask, uint8_t* sv, uint8_t nbVisSat);
976 int16_t gnssReadWarmStartStatus(uint8_t bitMask, uint8_t* nbVisSat, uint32_t* timeElapsed);
977 int16_t gnssGetSvSync(uint8_t mask, uint8_t nbSv, uint8_t* syncList);
978 int16_t gnssWriteBitMaskSatActivated(uint8_t bitMask, uint32_t* bitMaskActivated0, uint32_t* bitMaskActivated1);
979 void gnssAbort();
980
981 int16_t cryptoSetKey(uint8_t keyId, const uint8_t* key);
982 int16_t cryptoDeriveKey(uint8_t srcKeyId, uint8_t dstKeyId, const uint8_t* key);
983 int16_t cryptoProcessJoinAccept(uint8_t decKeyId, uint8_t verKeyId, uint8_t lwVer, const uint8_t* header, const uint8_t* dataIn, size_t len, uint8_t* dataOut);
984 int16_t cryptoComputeAesCmac(uint8_t keyId, const uint8_t* data, size_t len, uint32_t* mic);
985 int16_t cryptoVerifyAesCmac(uint8_t keyId, uint32_t micExp, const uint8_t* data, size_t len, bool* result);
986 int16_t cryptoAesEncrypt01(uint8_t keyId, const uint8_t* dataIn, size_t len, uint8_t* dataOut);
987 int16_t cryptoAesEncrypt(uint8_t keyId, const uint8_t* dataIn, size_t len, uint8_t* dataOut);
988 int16_t cryptoAesDecrypt(uint8_t keyId, const uint8_t* dataIn, size_t len, uint8_t* dataOut);
989 int16_t cryptoStoreToFlash(void);
990 int16_t cryptoRestoreFromFlash(void);
991 int16_t cryptoSetParam(uint8_t id, uint32_t value);
992 int16_t cryptoGetParam(uint8_t id, uint32_t* value);
993 int16_t cryptoCheckEncryptedFirmwareImage(uint32_t offset, const uint32_t* data, size_t len, bool nonvolatile);
994 int16_t cryptoCheckEncryptedFirmwareImageResult(bool* result);
995
996 int16_t bootEraseFlash(void);
997 int16_t bootWriteFlashEncrypted(uint32_t offset, const uint32_t* data, size_t len, bool nonvolatile);
998 int16_t bootGetHash(uint8_t hash[RADIOLIB_LR11X0_HASH_LEN]);
999 int16_t bootReboot(bool stay);
1000 int16_t bootGetPin(uint8_t* pin);
1001 int16_t bootGetChipEui(uint8_t* eui);
1002 int16_t bootGetJoinEui(uint8_t* eui);
1003
1004#if !RADIOLIB_GODMODE
1005 protected:
1006#endif
1007 uint8_t chipType = 0;
1008 OpMode_t txMode = LR11x0::MODE_TX;
1009
1010#if !RADIOLIB_GODMODE
1011 private:
1012#endif
1013 // version info, to avoid calling methods that are not implemented by specific FW versions
1014 uint8_t versionDevice = 0;
1015 uint16_t versionCombined = 0;
1016
1017 uint8_t wifiScanMode = 0;
1018 bool gnss = false;
1019 bool standbyXOSC = false;
1020 int16_t modSetup(uint8_t modem);
1021 bool findChip(uint8_t ver);
1022 int16_t config(uint8_t modem);
1023 int16_t setPacketMode(uint8_t mode, uint8_t len);
1024 int16_t startCad(uint8_t symbolNum, uint8_t detPeak, uint8_t detMin, uint8_t exitMode, RadioLibTime_t timeout);
1025 int16_t setHeaderType(uint8_t hdrType, size_t len = 0xFF);
1026
1027 // common methods to avoid some copy-paste
1028 int16_t bleBeaconCommon(uint16_t cmd, uint8_t chan, const uint8_t* payload, size_t len);
1029 int16_t cryptoCommon(uint16_t cmd, uint8_t keyId, const uint8_t* dataIn, size_t len, uint8_t* dataOut);
1030};
1031
1032#endif
1033
1034#endif
float getSNR() override
Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem.
Definition LR11x0.cpp:1135
int16_t startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, RadioLibIrqFlags_t irqFlags=RADIOLIB_IRQ_RX_DEFAULT_FLAGS, RadioLibIrqFlags_t irqMask=RADIOLIB_IRQ_RX_DEFAULT_MASK)
Interrupt-driven receive method where the device mostly sleeps and periodically wakes to listen....
Definition LR11x0.cpp:376
int16_t setRxBandwidth(uint32_t rxBw)
Sets GFSK receiver bandwidth. Allowed values are 4.8, 5.8, 7.3, 9.7, 11.7, 14.6, 19....
Definition LR11x0.cpp:730
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 LR11x0.cpp:1244
int16_t getGnssPosition(LR11x0GnssPosition_t *pos, bool filtered=true)
Get GNSS position. Called after gnssScan to retrieve the position calculated by the internal solver.
Definition LR11x0_gnss.cpp:214
int16_t setRegulatorDCDC()
Set regulator mode to DC-DC.
Definition LR11x0.cpp:1225
int16_t getChannelScanResult() override
Read the channel scan result.
Definition LR11x0.cpp:537
int16_t receive(uint8_t *data, size_t len, RadioLibTime_t timeout=0) override
Blocking binary receive method. Overloads for string-based transmissions are implemented in PhysicalL...
Definition LR11x0.cpp:206
int16_t readData(uint8_t *data, size_t len) override
Reads data received after calling startReceive method. When the packet length is not known in advance...
Definition LR11x0.cpp:433
uint32_t getIrqFlags() override
Read currently active IRQ flags.
Definition LR11x0.cpp:1195
int16_t setOutputPower(int8_t power, uint8_t paSel, uint8_t regPaSupply, uint8_t paDutyCycle, uint8_t paHpSel, uint8_t rampTime)
Sets output power. Allowed values are in range from -9 to 22 dBm (high-power PA), -17 to 14 dBm (low-...
Definition LR11x0.cpp:1234
int16_t transmit(const uint8_t *data, size_t len, uint8_t addr=0) override
Blocking binary transmit method. Overloads for string-based transmissions are implemented in Physical...
Definition LR11x0.cpp:149
OpMode_t
Custom operation modes for LR11x0. Needed because LR11x0 has several modems (sub-GHz,...
Definition LR11x0.h:60
@ MODE_TX_HP
Definition LR11x0.h:70
@ MODE_END_OF_TABLE
Definition LR11x0.h:62
@ MODE_WIFI
Definition LR11x0.h:76
@ MODE_GNSS
Definition LR11x0.h:74
@ MODE_TX
Definition LR11x0.h:68
@ MODE_RX
Definition LR11x0.h:66
@ MODE_STBY
Definition LR11x0.h:64
@ MODE_TX_HF
Definition LR11x0.h:72
int16_t finishReceive() override
Clean up after reception is done.
Definition LR11x0.cpp:478
int16_t beginGNSS(uint8_t constellations=RADIOLIB_LR11X0_GNSS_CONSTELLATION_GPS|RADIOLIB_LR11X0_GNSS_CONSTELLATION_BEIDOU)
Initialization method for GNSS scanning.
Definition LR11x0.cpp:119
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_wifi.cpp:7
int16_t explicitHeader()
Set explicit header mode for future reception/transmission.
Definition LR11x0.cpp:1217
int16_t clearTxBuffer() override
Discard a payload previously written by writeTxBuffer. On radios whose transmit buffer is simply over...
Definition LR11x0.cpp:1617
int16_t setStandbyXOSC(bool enable)
Set standby mode to be used. XOSC standby uses more power, but allows faster switching between Rx and...
Definition LR11x0.cpp:1289
int16_t setBandwidth(uint32_t bw) override
Sets LoRa bandwidth. Allowed values are 62.5, 125.0, 250.0 and 500.0 kHz.
Definition LR11x0.cpp:560
int16_t getWifiScanResult(LR11x0WifiResult_t *result, uint8_t index, bool brief=false)
Retrieve passive WiFi scan result.
Definition LR11x0_wifi.cpp:71
int16_t beginLRFHSS(uint8_t bw, uint8_t cr, bool narrowGrid)
Initialization method for LR-FHSS modem.
Definition LR11x0.cpp:99
int16_t setBitRate(uint32_t br) override
Sets GFSK bit rate. Allowed values range from 600 bps to 300 kbps.
Definition LR11x0.cpp:688
int16_t startChannelScan() override
Interrupt-driven channel activity detection method. IRQ1 will be activated when LoRa preamble is dete...
Definition LR11x0.cpp:487
int16_t calibrateImageRejection(uint32_t freqMin, uint32_t freqMax)
Perform image rejection calibration for the specified frequency band. WARNING: Use at your own risk!...
Definition LR11x0_commands.cpp:139
int16_t writeTxBuffer(const uint8_t *data, size_t len) override
Write a payload into the transmit buffer without staging or starting a transmission....
Definition LR11x0.cpp:1606
int16_t setTCXO(RadioLibTCXOVoltage_t voltage, uint32_t delay=5000)
Sets TCXO (Temperature Compensated Crystal Oscillator) configuration.
Definition LR11x0.cpp:1007
int16_t setCRC(uint8_t len, uint32_t initial=0x00001D0FUL, uint32_t polynomial=0x00001021UL, bool inverted=true)
Sets CRC configuration.
Definition LR11x0.cpp:1043
LR11x0(Module *mod)
Default constructor.
Definition LR11x0.cpp:8
int16_t setFrequencyDeviation(uint32_t freqDev) override
Sets GFSK frequency deviation. Allowed values range from 0 to 200 kHz.
Definition LR11x0.cpp:709
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:882
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:920
int16_t getWifiScanResultsCount(uint8_t *count)
Get number of WiFi scan results after the scan is finished.
Definition LR11x0_wifi.cpp:57
int16_t setNodeAddress(uint8_t nodeAddr)
Sets node address. Calling this method will also enable address filtering for node address only.
Definition LR11x0.cpp:828
int16_t setIrqFlags(uint32_t irq) override
Set interrupt on IRQ pin to be sent on a specific IRQ bit (e.g. RxTimeout, CadDone).
Definition LR11x0.cpp:1199
int16_t stageMode(RadioModeType_t mode, RadioModeConfig_t *cfg) override
Stage mode of the radio to be launched later using launchMode.
Definition LR11x0.cpp:1481
int16_t scanChannel() override
Performs scan for LoRa transmission in the current channel. Detects both preamble and payload.
Definition LR11x0.cpp:294
float getRSSI() override
Gets RSSI (Received Signal Strength Indicator) of the last received packet. Only available for LoRa o...
Definition LR11x0.cpp:1102
int16_t getGnssAlmanacStatus(LR11x0GnssAlmanacStatus_t *stat)
Read information about the almanac.
Definition LR11x0_gnss.cpp:121
int16_t standby() override
Sets the module to standby mode (overload for PhysicalLayer compatibility). Uses 13 MHz RC oscillator...
Definition LR11x0.cpp:324
int16_t setLrFhssConfig(uint8_t bw, uint8_t cr, bool narrowGrid, uint8_t hdrCount=3, uint16_t hopSeed=0x13A) override
Sets LR-FHSS configuration.
Definition LR11x0.cpp:1329
int16_t isGnssScanCapable()
Method to check whether the device is capable of performing a GNSS scan.
Definition LR11x0_gnss.cpp:7
int16_t startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=0, RadioLibIrqFlags_t irqFlags=RADIOLIB_IRQ_RX_DEFAULT_FLAGS, RadioLibIrqFlags_t irqMask=RADIOLIB_IRQ_RX_DEFAULT_MASK)
Calls startReceiveDutyCycle with rxPeriod and sleepPeriod set so the unit shouldn't miss any messages...
Definition LR11x0.cpp:411
float getTemperature()
Read the temperature.
Definition LR11x0.cpp:1158
int16_t beginGFSK(uint32_t br, uint32_t freqDev, uint32_t rxBw, uint16_t preambleLength)
Initialization method for FSK modem.
Definition LR11x0.cpp:58
uint8_t randomByte() override
Get one truly random byte from RSSI noise.
Definition LR11x0.cpp:1207
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:916
int16_t checkDataRate(DataRate_t dr, ModemType_t modem=RADIOLIB_MODEM_NONE) override
Check the data rate can be configured by this module.
Definition LR11x0.cpp:954
int16_t setRegulatorLDO()
Set regulator mode to LDO.
Definition LR11x0.cpp:1221
int16_t updateGnssAlmanac(uint8_t constellation)
Perform almanac update. Must be called immediately after gnssDelayUntilSubframe.
Definition LR11x0_gnss.cpp:184
int16_t getGnssSatellites(LR11x0GnssSatellite_t *sats, uint8_t numSats)
Get GNSS satellites found during the last scan.
Definition LR11x0_gnss.cpp:234
int16_t clearIrqFlags(uint32_t irq) override
Clear interrupt on a specific IRQ bit (e.g. RxTimeout, CadDone).
Definition LR11x0.cpp:1203
int16_t startReceive() override
Interrupt-driven receive method with default parameters. Implemented for compatibility with PhysicalL...
Definition LR11x0.cpp:372
int16_t autoLDRO()
Re-enables automatic LDRO configuration. Only available in LoRa mode. After calling this method,...
Definition LR11x0.cpp:1317
int16_t setCodingRate(uint8_t cr, bool longInterleave=false) override
Sets LoRa coding rate denominator. Allowed values range from 4 to 8. Note that a value of 4 means no ...
Definition LR11x0.cpp:640
int16_t launchMode() override
Launch previously staged mode.
Definition LR11x0.cpp:1623
int16_t setRxBoostedGainMode(bool en)
Enables or disables Rx Boosted Gain mode (additional Rx gain for increased power consumption).
Definition LR11x0.cpp:1229
int16_t updateFirmware(const uint32_t *image, size_t size, bool nonvolatile=true)
Method to upload new firmware image to the device. The device will be automatically erased,...
Definition LR11x0.cpp:1371
int16_t gnssDelayUntilSubframe(LR11x0GnssAlmanacStatus_t *stat, uint8_t constellation)
Blocking wait until the next subframe with almanac data is available. Used to control timing during a...
Definition LR11x0_gnss.cpp:160
int16_t setPreambleLength(size_t len, size_t detLen=0xFFFFFFFF) override
Sets preamble length for LoRa or GFSK modem. Allowed values range from 1 to 65535.
Definition LR11x0.cpp:980
int16_t implicitHeader(size_t len)
Set implicit header mode for future reception/transmission.
Definition LR11x0.cpp:1213
RadioLibTime_t getTimeOnAir(size_t len) override
Get expected time-on-air for a given size of payload.
Definition LR11x0.cpp:1189
int16_t setSpreadingFactor(uint8_t sf) override
Sets LoRa spreading factor. Allowed values range from 5 to 12.
Definition LR11x0.cpp:613
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition LR11x0.cpp:1168
int16_t getVersionInfo(LR11x0VersionInfo_t *info)
Retrieve LR11x0 hardware, device and firmware version information.
Definition LR11x0.cpp:1351
void clearWiFiScanAction()
Clears interrupt service routine to call when a WiFi scan is completed.
Definition LR11x0_wifi.cpp:53
int16_t sleep() override
Sets the module to sleep mode. To wake the device up, call standby(). Overload with warm start enable...
Definition LR11x0.cpp:346
int16_t gnssScan(LR11x0GnssResult_t *res=NULL)
Performs GNSS scan.
Definition LR11x0_gnss.cpp:53
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:924
int16_t setWhitening(bool enabled, uint16_t initial=0x01FF)
Sets GFSK whitening parameters.
Definition LR11x0.cpp:928
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_wifi.cpp:145
int16_t getMode(RadioModeType_t *mode) override
Read the operating mode the radio is in, as the chip reports it. Unlike PhysicalLayer::stagedMode,...
Definition LR11x0.cpp:1451
int16_t transmitDirect(uint32_t frf=0) override
Starts direct mode transmission.
Definition LR11x0.cpp:271
int16_t forceLDRO(bool enable)
Forces LoRa low data rate optimization. Only available in LoRa mode. After calling this method,...
Definition LR11x0.cpp:1302
int16_t receiveDirect() override
Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as LR11x0 series does...
Definition LR11x0.cpp:286
int16_t disableAddressFiltering()
Disables address filtering. Calling this method will also erase previously set addresses.
Definition LR11x0.cpp:867
int16_t setSyncWord(uint8_t syncWord)
Sets LoRa sync word.
Definition LR11x0.cpp:676
int16_t begin(uint32_t bw, uint8_t sf, uint8_t cr, uint8_t syncWord, uint16_t preambleLength, bool high=false)
Initialization method for LoRa modem.
Definition LR11x0.cpp:24
int16_t setBroadcastAddress(uint8_t broadAddr)
Sets broadcast address. Calling this method will also enable address filtering for node and broadcast...
Definition LR11x0.cpp:848
int16_t invertIQ(bool enable) override
Enable/disable inversion of the I and Q signals.
Definition LR11x0.cpp:1089
int16_t getLoRaRxHeaderInfo(uint8_t *cr, bool *hasCRC)
Get LoRa header information from last received packet. Only valid in explicit header mode.
Definition LR11x0_commands.cpp:682
float getVoltage()
Read the supply voltage on the Vbat pin.
Definition LR11x0.cpp:1148
int16_t getModem(ModemType_t *modem) override
Get modem currently in use by the radio.
Definition LR11x0.cpp:1429
void setWiFiScanAction(void(*func)(void))
Sets interrupt service routine to call when a WiFi scan is completed.
Definition LR11x0_wifi.cpp:49
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition Module.h:74
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:83
@ MODE_TX
Transmission mode.
Definition Module.h:120
@ MODE_IDLE
Idle mode.
Definition Module.h:114
@ MODE_RX
Receive mode.
Definition Module.h:117
@ MODE_END_OF_TABLE
End of table marker, use END_OF_MODE_TABLE constant instead. Value is zero to ensure zero-initialized...
Definition Module.h:111
virtual int16_t startReceive()
Sets module to received mode using its default configuration.
Definition PhysicalLayer.cpp:131
virtual int16_t readData(uint8_t *data, size_t len)
Reads data that was received after calling startReceive method.
Definition PhysicalLayer.cpp:235
int16_t transmit(const char *str, uint8_t addr=0)
C-string transmit method.
Definition PhysicalLayer.cpp:53
int16_t startTransmit(const char *str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition PhysicalLayer.cpp:157
virtual int16_t setOutputPower(int8_t power)
Set output power. Must be implemented in module class if the module supports it.
Definition PhysicalLayer.cpp:305
virtual int16_t receive(uint8_t *data, size_t len, RadioLibTime_t timeout=0)
Binary receive method. Must be implemented in module class.
Definition PhysicalLayer.cpp:111
RadioLibTCXOVoltage_t tcxoVoltage
TCXO reference voltage to be set on DIO3. Defaults to 1.6 V. If you are seeing -706/-707 error codes,...
Definition LR11x0.h:85
unsigned long RadioLibTime_t
Type used for durations in RadioLib.
Definition TypeDef.h:783
uint32_t RadioLibIrqFlags_t
Type used for radio-agnostic IRQ flags. IRQ to enable corresponds to the bit index (RadioLibIrq_t)....
Definition TypeDef.h:789
Structure to save information about the GNSS almanac. This is not the actual almanac,...
Definition LR11x0_types.h:211
Structure to report position from LR11x0 internal solver.
Definition LR11x0_types.h:161
Structure to report information results of a GNSS scan.
Definition LR11x0_types.h:146
Structure to save information about a satellite found during GNSS scan.
Definition LR11x0_types.h:179
Structure to report information about versions of the LR11x0 hardware and firmware.
Definition LR11x0_types.h:116
Structure to save result of passive WiFi scan. This result only saves the basic information.
Definition LR11x0_types.h:19
Description of RF switch pin states for a single mode. See setRfSwitchTable for details.
Definition Module.h:90
Common channel scan configuration structure.
Definition PhysicalLayer.h:168
Common data rate structure.
Definition PhysicalLayer.h:74
Definition PhysicalLayer.h:214