RadioLib/_l_r2021_8h_source.html

#if !defined(RADIOLIB_LR2021_H)

#define RADIOLIB_LR2021_H


#include "../../TypeDef.h"


#if !RADIOLIB_EXCLUDE_LR2021


#include "../../Module.h"


#include "../../protocols/PhysicalLayer/PhysicalLayer.h"

#include "../LR11x0/LR_common.h"

#include "LR2021_commands.h"

#include "LR2021_types.h"


// LR2021 physical layer properties

#define RADIOLIB_LR2021_FREQUENCY_STEP_SIZE                     1.0

#define RADIOLIB_LR2021_MAX_PACKET_LENGTH                       255

#define RADIOLIB_LR2021_CRYSTAL_FREQ                            32.0

#define RADIOLIB_LR2021_DIV_EXPONENT                            25


class LR2021: public LRxxxx {

  public:

    // introduce PhysicalLayer overloads

    using PhysicalLayer::transmit;

    using PhysicalLayer::receive;

    using PhysicalLayer::startTransmit;

    using PhysicalLayer::startReceive;

    using PhysicalLayer::readData;


    LR2021(Module* mod); // cppcheck-suppress noExplicitConstructor


    uint32_t irqDioNum = 5;


    bool fastCad = false;


    enum OpMode_t {

        MODE_END_OF_TABLE = Module::MODE_END_OF_TABLE,

        MODE_STBY = Module::MODE_IDLE,

        MODE_RX = Module::MODE_RX,

        MODE_TX = Module::MODE_TX,

        MODE_RX_HF,

        MODE_TX_HF,

    };


    float tcxoVoltage = 1.6;


    // basic methods


    int16_t begin(const ConfigLoRa_t& config);


    int16_t begin(float freq = 434.0, float bw = 125.0, uint8_t sf = 9, uint8_t cr = 7, uint8_t syncWord = RADIOLIB_LR2021_LORA_SYNC_WORD_PRIVATE, int8_t power = 10, uint16_t preambleLength = 8, float tcxoVoltage = 1.6);


    int16_t beginGFSK(const ConfigFSK_t& config);


    int16_t beginGFSK(float freq = 434.0, float br = 4.8, float freqDev = 5.0, float rxBw = 153.8, int8_t power = 10, uint16_t preambleLength = 16, float tcxoVoltage = 1.6);


    int16_t beginOOK(const ConfigOOK_t& config);


    int16_t beginOOK(float freq = 434.0, float br = 4.8, float rxBw = 153.8, int8_t power = 10, uint16_t preambleLength = 16, float tcxoVoltage = 1.6);


    int16_t beginLRFHSS(const ConfigLRFHSS_t& config);


    int16_t beginLRFHSS(float freq = 434.0, uint8_t bw = RADIOLIB_LRXXXX_LR_FHSS_BW_722_66, uint8_t cr = RADIOLIB_LRXXXX_LR_FHSS_CR_2_3, bool narrowGrid = true, int8_t power = 10, float tcxoVoltage = 1.6);


    int16_t beginFLRC(const ConfigFLRC_t& config);


    int16_t beginFLRC(float freq = 434.0, uint16_t br = 650, uint8_t cr = RADIOLIB_LR2021_FLRC_CR_2_3, int8_t pwr = 10, uint16_t preambleLength = 16, uint8_t dataShaping = RADIOLIB_SHAPING_0_5, float tcxoVoltage = 1.6);


    int16_t transmit(const uint8_t* data, size_t len, uint8_t addr = 0) override;


    int16_t receive(uint8_t* data, size_t len, RadioLibTime_t timeout = 0) override;


    int16_t transmitDirect(uint32_t frf = 0) override;


    int16_t receiveDirect() override;


    int16_t scanChannel() override;


    int16_t scanChannel(const ChannelScanConfig_t &config) override;


    int16_t standby() override;


    int16_t standby(uint8_t mode) override;


    int16_t standby(uint8_t mode, bool wakeup);


    int16_t sleep() override;


    int16_t sleep(bool retainConfig, uint32_t sleepTime);


    size_t getPacketLength(bool update = true) override;


    // interrupt methods


    int16_t finishTransmit() override;


    int16_t startReceive() override;


    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);


    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);


    int16_t readData(uint8_t* data, size_t len) override;


    int16_t finishReceive() override;


    int16_t startChannelScan() override;


    int16_t startChannelScan(const ChannelScanConfig_t &cfg) override;


    int16_t getChannelScanResult() override;


    uint32_t getIrqFlags() override;


    int16_t setIrqFlags(uint32_t irq) override;


    int16_t clearIrqFlags(uint32_t irq) override;


    int16_t setModem(ModemType_t modem) override;


    // configuration methods


    int16_t setFrequency(float freq) override;


    int16_t setFrequency(float freq, bool skipCalibration);


    int16_t setOutputPower(int8_t power) override;


    int16_t setOutputPower(int8_t power, uint32_t rampTimeUs);


    void setPaTable(LR2021PaTableEntry_t* table, bool highFreq);


    int16_t setStandbyXOSC(bool enable);


    int16_t checkOutputPower(int8_t power, int8_t* clipped) override;


    void setRfSwitchTable(const uint32_t (&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[]);


    int16_t forceLDRO(bool enable);


    int16_t autoLDRO();


    int16_t setBandwidth(float bw);


    int16_t setSpreadingFactor(uint8_t sf, bool legacy = false);


    int16_t setCodingRate(uint8_t cr, bool longInterleave = false);


    int16_t setSyncWord(uint8_t syncWord);


    int16_t setPreambleLength(size_t preambleLength) override;


    int16_t setTCXO(float voltage, uint32_t delay = 1000000);


    int16_t setCRC(uint8_t len, uint32_t initial = 0x00001D0FUL, uint32_t polynomial = 0x00001021UL, bool inverted = true);


    int16_t invertIQ(bool enable) override;


    int16_t setBitRate(float br) override;


    int16_t setFrequencyDeviation(float freqDev) override;


    int16_t setRxBandwidth(float rxBw);


    int16_t setSyncWord(uint8_t* syncWord, size_t len) override;


    int16_t setNodeAddress(uint8_t nodeAddr);


    int16_t setBroadcastAddress(uint8_t broadAddr);


    int16_t disableAddressFiltering();


    int16_t setDataShaping(uint8_t sh) override;


    int16_t setEncoding(uint8_t encoding) override;


    int16_t fixedPacketLengthMode(uint8_t len = RADIOLIB_LR2021_MAX_PACKET_LENGTH);


    int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_LR2021_MAX_PACKET_LENGTH);


    int16_t setWhitening(bool enabled, uint16_t initial = 0x01FF);


    int16_t setDataRate(DataRate_t dr, ModemType_t modem = RADIOLIB_MODEM_NONE) override;


    int16_t checkDataRate(DataRate_t dr, ModemType_t modem = RADIOLIB_MODEM_NONE) override;


    int16_t setLrFhssConfig(uint8_t bw, uint8_t cr, uint8_t hdrCount = 3, uint16_t hopSeed = 0x13A);


    int16_t setRxBoostedGainMode(uint8_t level);


    RadioLibTime_t getTimeOnAir(size_t len) override;


    int16_t getModem(ModemType_t* modem) override;


    int16_t getMode(RadioModeType_t* mode) override;


    int16_t stageMode(RadioModeType_t mode, RadioModeConfig_t* cfg) override;


    int16_t launchMode() override;


    int16_t writeTxBuffer(const uint8_t* data, size_t len) override;


    int16_t clearTxBuffer() override;


    float getVoltage(uint8_t bits = 13);


    float getTemperature(uint8_t source, uint8_t bits = 13);


    float getRSSI() override;


    float getRSSI(bool packet, bool skipReceive = false);


    float getSNR() override;


    uint8_t randomByte() override;


    int16_t implicitHeader(size_t len);


    int16_t explicitHeader();


    int16_t ookDetector(uint16_t pattern = 0x0285, uint8_t len = 16, uint8_t repeats = 0, bool syncRaw = false, bool rising = false, uint8_t sofLen = 0);


    int16_t setOokDetectionThreshold(int16_t level);


    int16_t setSideDetector(const LR2021LoRaSideDetector_t* cfg, size_t numDetectors);


    int16_t setGain(uint8_t gain);


    int16_t getLoRaPacketStatus(uint8_t* cr, bool* crc, uint8_t* packetLen = NULL, float* snrPacket = NULL, float* rssiPacket = NULL, float* rssiSignalPacket = NULL, uint8_t* detector = NULL);


    int16_t getLoRaRxHeaderInfo(uint8_t* cr, bool* hasCRC);


    int16_t getErrors(uint16_t* err);


    int16_t getLoRaRxStats(uint16_t* pktRxTotal, uint16_t* pktCrcError, uint16_t* headerCrcError, uint16_t* falseSynch);


    int16_t getRangingStats(uint16_t* exchangeValid, uint16_t* requestValid, uint16_t* responseDone, uint16_t* timeout, uint16_t* requestDiscarded);


    int16_t getGfskRxStats(uint16_t* packetRx, uint16_t* packetCrcError, uint16_t* lenError, uint16_t* preambleDet, uint16_t* syncOk, uint16_t* syncFail, uint16_t* timeout);


    int16_t getOqpskRxStats(uint16_t* packetRx, uint16_t* crcError, uint16_t* lenError);


    int16_t getFlrcRxStats(uint16_t* packetRx, uint16_t* packetCrcError, uint16_t* lenError);


    int16_t getOokRxStats(uint16_t* packetRx, uint16_t* crcError, uint16_t* lenError);


    int16_t setRegulatorLDO();


    int16_t setRegulatorDCDC();


#if !RADIOLIB_GODMODE && !RADIOLIB_LOW_LEVEL

  protected:

#endif

    Module* getMod() override;


#if !RADIOLIB_GODMODE

  protected:

#endif


#if !RADIOLIB_GODMODE

  private:

#endif

    uint8_t gainModeLf = RADIOLIB_LR2021_RX_BOOST_LF;

    uint8_t gainModeHf = RADIOLIB_LR2021_RX_BOOST_HF;


    bool standbyXOSC = false;


    // cached FLRC parameters

    uint16_t bitRateFlrc = 0;

    uint8_t codingRateFlrc = 0;


    // pointers to PA lookup tables - may be overridden by the user

    LR2021PaTableEntry_t* paOptTable[2] = { nullptr, nullptr };


    int16_t modSetup(float freq, uint8_t modem);

    bool findChip(void);

    int16_t config(uint8_t modem);

    int16_t setPacketMode(uint8_t mode, uint8_t len);

    int16_t startCad(uint8_t symbolNum, uint8_t detPeak, bool fast, uint8_t exitMode, RadioLibTime_t timeout);


    // chip control commands

    int16_t readRadioRxFifo(uint8_t* data, size_t len);

    int16_t writeRadioTxFifo(const uint8_t* data, size_t len);

    int16_t writeRegMem32(uint32_t addr, const uint32_t* data, size_t len);

    int16_t writeRegMemMask32(uint32_t addr, uint32_t mask, uint32_t data);

    int16_t readRegMem32(uint32_t addr, uint32_t* data, size_t len);

    int16_t setFs(void);

    int16_t setAdditionalRegToRetain(uint8_t slot, uint32_t addr);

    int16_t setRx(uint32_t timeout);

    int16_t setTx(uint32_t timeout);

    int16_t setRxTxFallbackMode(uint8_t mode);

    int16_t setRxDutyCycle(uint32_t rxMaxTime, uint32_t cycleTime, uint8_t mode);

    int16_t autoTxRx(uint32_t delay, uint8_t mode, uint32_t timeout);

    int16_t getRxPktLength(uint16_t* len);

    int16_t resetRxStats(void);

    int16_t setDefaultRxTxTimeout(uint32_t rxTimeout, uint32_t txTimeout);

    int16_t setRegMode(uint8_t mode);

    int16_t calibrate(uint8_t blocks);

    int16_t calibrateFrontEnd(const uint16_t freq[3]);

    int16_t getVbat(uint8_t resolution, uint16_t* vbat);

    int16_t getTemp(uint8_t source, uint8_t resolution, float* temp);

    int16_t setEolConfig(bool enable, uint8_t trim);

    int16_t getRandomNumber(uint32_t* rnd);

    int16_t getVersion(uint8_t* major, uint8_t* minor);

    int16_t clearErrors(void);

    int16_t setDioFunction(uint8_t dio, uint8_t func, uint8_t pullDrive);

    int16_t setDioRfSwitchConfig(uint8_t dio, uint8_t func);

    int16_t setDioIrqConfig(uint8_t dio, uint32_t irq);

    int16_t clearIrqState(uint32_t irq);

    int16_t getAndClearIrqStatus(uint32_t* irq);

    int16_t configFifoIrq(uint8_t rxFifoIrq, uint8_t txFifoIrq, uint16_t rxHighThreshold, uint16_t txLowThreshold, uint16_t rxLowThreshold, uint16_t txHighThreshold);

    int16_t getFifoIrqFlags(uint8_t* rxFifoFlags, uint8_t* txFifoFlags);

    int16_t clearFifoIrqFlags(uint8_t rxFifoFlags, uint8_t txFifoFlags);

    int16_t getAndClearFifoIrqFlags(uint8_t* rxFifoFlags, uint8_t* txFifoFlags);

    int16_t getRxFifoLevel(uint16_t* level);

    int16_t getTxFifoLevel(uint16_t* level);

    int16_t clearRxFifo(void);

    int16_t clearTxFifo(void);

    int16_t configLfClock(uint8_t cfg);

    int16_t configClkOutputs(uint8_t scaling);

    int16_t setTcxoMode(uint8_t tune, uint32_t startTime);

    int16_t setXoscCpTrim(uint8_t xta, uint8_t xtb, uint8_t startTime);

    int16_t activatePram(void);

    int16_t checkPramLoaded(bool* loaded);

    int16_t getPramVersion(uint16_t* version);


    // radio frequency front end commands

    int16_t setRfFrequency(uint32_t rfFreq);

    int16_t setRxPath(uint8_t rxPath, uint8_t rxBoost);

    int16_t getRssiInst(float* rssi);

    int16_t setRssiCalibration(uint8_t rxPath, const uint16_t gain[RADIOLIB_LR2021_GAIN_TABLE_LENGTH], const uint8_t noiseFloor[RADIOLIB_LR2021_GAIN_TABLE_LENGTH]);

    int16_t setTimestampSource(uint8_t index, uint8_t source);

    int16_t getTimestampValue(uint8_t index, uint32_t* timestamp);

    int16_t setCca(uint32_t duration, uint8_t gain);

    int16_t getCcaResult(float* rssiMin, float* rssiMax, float* rssiAvg);

    int16_t setCadParams(uint32_t cadTimeout, uint8_t threshold, uint8_t exitMode, uint32_t trxTimeout);

    int16_t setCad(void);

    int16_t selPa(uint8_t pa);

    int16_t setPaConfig(uint8_t pa, uint8_t paLfMode, uint8_t paLfDutyCycle, uint8_t paLfSlices, uint8_t paHfDutyCycle);

    int16_t setTxParams(int8_t txPower, uint8_t rampTime);


    // modem configuration commands

    int16_t setPacketType(uint8_t packetType);

    int16_t getPacketType(uint8_t* packetType);


    // LoRa commands

    int16_t setLoRaModulationParams(uint8_t sf, uint8_t bw, uint8_t cr, uint8_t ldro);

    int16_t setLoRaPacketParams(uint16_t preambleLen, uint8_t hdrType, uint8_t payloadLen, uint8_t crcType, uint8_t invertIQ);

    int16_t setLoRaSynchTimeout(uint8_t numSymbols, bool format);

    int16_t setLoRaSyncword(uint8_t syncword);

    int16_t setLoRaSideDetConfig(uint8_t* configs, size_t numSideDets);

    int16_t setLoRaSideDetSyncword(uint8_t* syncwords, size_t numSideDets);

    int16_t setLoRaCadParams(uint8_t numSymbols, bool preambleOnly, uint8_t pnrDelta, uint8_t cadExitMode, uint32_t timeout, uint8_t detPeak);

    int16_t setLoRaCad(void);

    int16_t setLoRaAddress(uint8_t addrLen, uint8_t addrPos, const uint8_t* addr);

    int16_t setLoRaHopping(uint8_t hopCtrl, uint16_t hopPeriod, const uint32_t* freqHops, size_t numFreqHops);

    int16_t setLoRaTxSync(uint8_t function, uint8_t dioNum);

    int16_t setLoRaSideDetCad(const uint8_t* pnrDelta, const uint8_t* detPeak, size_t numSideDets);

    int16_t setLoRaHeaderType(uint8_t hdrType, size_t len = RADIOLIB_LR2021_MAX_PACKET_LENGTH);


    // ranging commands

    int16_t setRangingAddr(uint32_t addr, uint8_t checkLen);

    int16_t setRangingReqAddr(uint32_t addr);

    int16_t getRangingResult(uint8_t type, uint32_t* rng1, uint8_t* rssi1, uint32_t* rng2);

    int16_t setRangingTxRxDelay(uint32_t delay);

    int16_t setRangingParams(bool spyMode, uint8_t nbSymbols);


    // GFSK commands

    int16_t setGfskModulationParams(uint32_t bitRate, uint8_t pulseShape, uint8_t rxBw, uint32_t freqDev);

    int16_t setGfskPacketParams(uint16_t preambleLen, uint8_t preambleDetect, bool longPreamble, bool pldLenBits, uint8_t addrComp, uint8_t packetFormat, uint16_t payloadLen, uint8_t crc, uint8_t dcFree);

    int16_t setGfskWhiteningParams(uint8_t whitenType, uint16_t init);

    int16_t setGfskCrcParams(uint32_t poly, uint32_t init);

    int16_t setGfskSyncword(const uint8_t* syncWord, size_t syncWordLen, bool msbFirst);

    int16_t setGfskAddress(uint8_t addrNode, uint8_t addrBroadcast);

    int16_t getGfskPacketStatus(uint16_t* packetLen, float* rssiAvg, float* rssiSync, bool* addrMatchNode, bool* addrMatchBroadcast, float* lqi);


    // OQPSK commands

    int16_t setOqpskParams(uint8_t mode, uint8_t rxBw, uint8_t payloadLen, uint16_t preambleLen, bool addrFilt, bool fcsManual);

    int16_t getOqpskPacketStatus(uint8_t* rxHeader, uint16_t* payloadLen, float* rssiAvg, float* rssiSync, float* lqi);

    int16_t setOqpskPacketLen(uint8_t len);

    int16_t setOqpskAddress(const uint8_t longDestAddr[8], uint16_t shortDestAddr, uint16_t panId, uint8_t transId);


    // BPSK commands

    int16_t setBpskModulationParams(uint32_t bitRate, uint8_t pulseShape, bool diff, uint8_t diffInit);

    int16_t setBpskPacketParams(uint8_t payloadLen, uint8_t mode, bool sigFoxControlMsg, uint8_t sigFoxRank);


    // FLRC commands

    int16_t setFlrcModulationParams(uint8_t brBw, uint8_t cr, uint8_t pulseShape);

    int16_t setFlrcPacketParams(uint8_t agcPreambleLen, uint8_t syncWordLen, uint8_t syncWordTx, uint8_t syncMatch, bool fixedLength, uint8_t crc, uint16_t payloadLen);

    int16_t getFlrcPacketStatus(uint16_t* packetLen, float* rssiAvg, float* rssiSync, uint8_t* syncWordNum);

    int16_t setFlrcSyncWord(uint8_t syncWordNum, uint32_t syncWord);


    // LR-FHSS commands

    int16_t lrFhssSetSyncword(uint32_t syncWord);

    //int16_t readLrFhssHoppingTable(LR2021LrFhssHopTableEntry_t* hopTable[40], size_t* hopTableLen);

    //int16_t writeLrFhssHoppingTable(LR2021LrFhssHopTableEntry_t* hopTable[40], size_t hopTableLen);


    // OOK commands

    int16_t setOokModulationParams(uint32_t bitRate, uint8_t pulseShape, uint8_t rxBw, uint8_t depth);

    int16_t setOokPacketParams(uint16_t preambleLen, uint8_t addrComp, uint8_t packetFormat, uint16_t payloadLen, uint8_t crc, uint8_t manchester);

    int16_t setOokCrcParams(uint32_t poly, uint32_t init);

    int16_t setOokSyncword(const uint8_t* syncWord, size_t syncWordLen, bool msbFirst);

    int16_t setOokAddress(uint8_t addrNode, uint8_t addrBroadcast);

    int16_t getOokPacketStatus(uint16_t* packetLen, float* rssiAvg, float* rssiHigh, bool* addrMatchNode, bool* addrMatchBroadcast, float* lqi);

    int16_t setOokDetector(uint16_t preamblePattern, uint8_t patternLen, uint8_t patternNumRepeaters, bool syncWordRaw, bool sofDelimiterRising, uint8_t sofDelimiterLen);

    int16_t setOokWhiteningParams(uint8_t bitIdx, uint16_t poly, uint16_t init);


    // test commands

    int16_t setTxTestMode(uint8_t mode);


    // port of semtech's workaround

    int16_t setDCDCworkaround();

    int16_t resetDCDCworkaround();

};


#endif


#endif

LR2021::setBitRate
int16_t setBitRate(float br) override
Sets GFSK bit rate. Allowed values range from 0.5 to 2000.0 kbps.
Definition LR2021_config.cpp:566

LR2021::setSyncWord
int16_t setSyncWord(uint8_t syncWord)
Sets LoRa sync word.
Definition LR2021_config.cpp:397

LR2021::receive
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 LR2021.cpp:317

LR2021::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 LR2021_config.cpp:639

LR2021::readData
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 LR2021.cpp:566

LR2021::sleep
int16_t sleep() override
Sets the module to sleep mode. To wake the device up, call standby(). Overload with warm start enable...
Definition LR2021.cpp:458

LR2021::LR2021
LR2021(Module *mod)
Default constructor.
Definition LR2021.cpp:8

LR2021::getLoRaPacketStatus
int16_t getLoRaPacketStatus(uint8_t *cr, bool *crc, uint8_t *packetLen=NULL, float *snrPacket=NULL, float *rssiPacket=NULL, float *rssiSignalPacket=NULL, uint8_t *detector=NULL)
Read status of the last received packet. Each parameter can be set to NULL if the caller is not inten...
Definition LR2021_cmds_lora.cpp:82

LR2021::setPaTable
void setPaTable(LR2021PaTableEntry_t *table, bool highFreq)
Sets custom PA configuration table.
Definition LR2021_config.cpp:178

LR2021::begin
int16_t begin(const ConfigLoRa_t &config)
Initialization method for LoRa modem.
Definition LR2021.cpp:24

LR2021::receiveDirect
int16_t receiveDirect() override
Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as LR2021 does not su...
Definition LR2021.cpp:399

LR2021::getLoRaRxHeaderInfo
int16_t getLoRaRxHeaderInfo(uint8_t *cr, bool *hasCRC)
Get LoRa header information from last received packet. Implementation based on getLoRaPacketStatus.
Definition LR2021.cpp:1248

LR2021::setStandbyXOSC
int16_t setStandbyXOSC(bool enable)
Set standby mode to be used. XOSC standby uses more power, but allows faster switching between Rx and...
Definition LR2021_config.cpp:182

LR2021::clearIrqFlags
int16_t clearIrqFlags(uint32_t irq) override
Clear interrupt on a specific IRQ bit (e.g. RxTimeout, CadDone).
Definition LR2021.cpp:703

LR2021::setDataRate
int16_t setDataRate(DataRate_t dr, ModemType_t modem=RADIOLIB_MODEM_NONE) override
Set data rate.
Definition LR2021_config.cpp:869

LR2021::checkDataRate
int16_t checkDataRate(DataRate_t dr, ModemType_t modem=RADIOLIB_MODEM_NONE) override
Check the data rate can be configured by this module.
Definition LR2021_config.cpp:921

LR2021::autoLDRO
int16_t autoLDRO()
Re-enables automatic LDRO configuration. Only available in LoRa mode. After calling this method,...
Definition LR2021_config.cpp:255

LR2021::writeTxBuffer
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 LR2021.cpp:1123

LR2021::beginFLRC
int16_t beginFLRC(const ConfigFLRC_t &config)
Initialization method for FLRC modem.
Definition LR2021.cpp:203

LR2021::setTCXO
int16_t setTCXO(float voltage, uint32_t delay=1000000)
Sets TCXO (Temperature Compensated Crystal Oscillator) configuration.
Definition LR2021_config.cpp:444

LR2021::disableAddressFiltering
int16_t disableAddressFiltering()
Disables address filtering. Calling this method will also erase previously set addresses.
Definition LR2021_config.cpp:1090

LR2021::setBroadcastAddress
int16_t setBroadcastAddress(uint8_t broadAddr)
Sets broadcast address. Calling this method will also enable address filtering for node and broadcast...
Definition LR2021_config.cpp:1071

LR2021::checkOutputPower
int16_t checkOutputPower(int8_t power, int8_t *clipped) override
Check if output power is configurable. This method is needed for compatibility with PhysicalLayer::ch...
Definition LR2021_config.cpp:195

LR2021::scanChannel
int16_t scanChannel() override
Performs scan for LoRa transmission in the current channel. Detects both preamble and payload.
Definition LR2021.cpp:407

LR2021::getIrqFlags
uint32_t getIrqFlags() override
Read currently active IRQ flags.
Definition LR2021.cpp:695

LR2021::beginOOK
int16_t beginOOK(const ConfigOOK_t &config)
Initialization method for OOK modem.
Definition LR2021.cpp:123

LR2021::getRangingStats
int16_t getRangingStats(uint16_t *exchangeValid, uint16_t *requestValid, uint16_t *responseDone, uint16_t *timeout, uint16_t *requestDiscarded)
Get ranging Rx statistics.
Definition LR2021_cmds_ranging.cpp:44

LR2021::getRSSI
float getRSSI() override
Gets received signal strength indicator. Overload with packet mode enabled for PhysicalLayer compatib...
Definition LR2021.cpp:1195

LR2021::setCodingRate
int16_t setCodingRate(uint8_t cr, bool longInterleave=false)
Sets LoRa coding rate denominator. Allowed values range from 4 to 8. Note that a value of 4 means no ...
Definition LR2021_config.cpp:351

LR2021::setOokDetectionThreshold
int16_t setOokDetectionThreshold(int16_t level)
Set OOK detection threshold.
Definition LR2021_config.cpp:1117

LR2021::setCRC
int16_t setCRC(uint8_t len, uint32_t initial=0x00001D0FUL, uint32_t polynomial=0x00001021UL, bool inverted=true)
Sets CRC configuration.
Definition LR2021_config.cpp:495

LR2021::explicitHeader
int16_t explicitHeader()
Set explicit header mode for future reception/transmission.
Definition LR2021_config.cpp:1047

LR2021::getOokRxStats
int16_t getOokRxStats(uint16_t *packetRx, uint16_t *crcError, uint16_t *lenError)
Get OOK Rx statistics.
Definition LR2021_cmds_ook.cpp:62

LR2021::forceLDRO
int16_t forceLDRO(bool enable)
Forces LoRa low data rate optimization. Only available in LoRa mode. After calling this method,...
Definition LR2021_config.cpp:240

LR2021::getChannelScanResult
int16_t getChannelScanResult() override
Read the channel scan result.
Definition LR2021.cpp:672

LR2021::setFrequency
int16_t setFrequency(float freq) override
Sets carrier frequency. Allowed values are in range from 150.0 to 960.0 MHz, 1900 - 2200 MHz and 2400...
Definition LR2021_config.cpp:84

LR2021::getErrors
int16_t getErrors(uint16_t *err)
Get internal error bits.
Definition LR2021_cmds_chip_control.cpp:205

LR2021::startChannelScan
int16_t startChannelScan() override
Interrupt-driven channel activity detection method. IRQ1 will be activated when LoRa preamble is dete...
Definition LR2021.cpp:627

LR2021::transmitDirect
int16_t transmitDirect(uint32_t frf=0) override
Starts direct mode transmission.
Definition LR2021.cpp:384

LR2021::variablePacketLengthMode
int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_LR2021_MAX_PACKET_LENGTH)
Set modem in variable packet length mode. Available in GFSK mode only.
Definition LR2021_config.cpp:832

LR2021::setEncoding
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Available in GFSK mode only. Serves only as alias for PhysicalLayer compa...
Definition LR2021_config.cpp:787

LR2021::launchMode
int16_t launchMode() override
Launch previously staged mode.
Definition LR2021.cpp:1142

LR2021::invertIQ
int16_t invertIQ(bool enable) override
Enable/disable inversion of the I and Q signals.
Definition LR2021_config.cpp:552

LR2021::getMode
int16_t getMode(RadioModeType_t *mode) override
Read the operating mode the radio is in, as the chip reports it. Unlike PhysicalLayer::stagedMode,...
Definition LR2021.cpp:954

LR2021::setBandwidth
int16_t setBandwidth(float bw)
Sets LoRa bandwidth. Allowed values are 31.25, 41.67, 62.5, 83.34, 125.0, 101.56, 203....
Definition LR2021_config.cpp:267

LR2021::OpMode_t
OpMode_t
Custom operation modes for LR2021. Needed because LR2021 has several modems (sub-GHz,...
Definition LR2021.h:58

LR2021::MODE_END_OF_TABLE
@ MODE_END_OF_TABLE
Definition LR2021.h:60

LR2021::MODE_RX
@ MODE_RX
Definition LR2021.h:64

LR2021::MODE_RX_HF
@ MODE_RX_HF
Definition LR2021.h:68

LR2021::MODE_STBY
@ MODE_STBY
Definition LR2021.h:62

LR2021::MODE_TX_HF
@ MODE_TX_HF
Definition LR2021.h:70

LR2021::MODE_TX
@ MODE_TX
Definition LR2021.h:66

LR2021::setWhitening
int16_t setWhitening(bool enabled, uint16_t initial=0x01FF)
Sets GFSK whitening parameters.
Definition LR2021_config.cpp:836

LR2021::finishTransmit
int16_t finishTransmit() override
Clean up after transmission is done.
Definition LR2021.cpp:495

LR2021::transmit
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 LR2021.cpp:257

LR2021::getTimeOnAir
RadioLibTime_t getTimeOnAir(size_t len) override
Get expected time-on-air for a given size of payload.
Definition LR2021.cpp:883

LR2021::setGain
int16_t setGain(uint8_t gain)
Sets gain of receiver LNA (low-noise amplifier). Can be set to any integer in range 1 to 13,...
Definition LR2021_config.cpp:1200

LR2021::beginGFSK
int16_t beginGFSK(const ConfigFSK_t &config)
Initialization method for FSK modem.
Definition LR2021.cpp:69

LR2021::getModem
int16_t getModem(ModemType_t *modem) override
Get modem currently in use by the radio.
Definition LR2021.cpp:932

LR2021::fixedPacketLengthMode
int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_LR2021_MAX_PACKET_LENGTH)
Set modem in fixed packet length mode. Available in GFSK mode only.
Definition LR2021_config.cpp:828

LR2021::getOqpskRxStats
int16_t getOqpskRxStats(uint16_t *packetRx, uint16_t *crcError, uint16_t *lenError)
Get OQPSK Rx statistics.
Definition LR2021_cmds_oqpsk.cpp:19

LR2021::setDataShaping
int16_t setDataShaping(uint8_t sh) override
Sets time-bandwidth product of Gaussian filter applied for shaping. Allowed values are RADIOLIB_SHAPI...
Definition LR2021_config.cpp:749

LR2021::getLoRaRxStats
int16_t getLoRaRxStats(uint16_t *pktRxTotal, uint16_t *pktCrcError, uint16_t *headerCrcError, uint16_t *falseSynch)
Get LoRa Rx statistics.
Definition LR2021_cmds_lora.cpp:72

LR2021::getVoltage
float getVoltage(uint8_t bits=13)
Read the supply voltage on the Vbat pin.
Definition LR2021.cpp:1169

LR2021::finishReceive
int16_t finishReceive() override
Clean up after reception is done.
Definition LR2021.cpp:618

LR2021::standby
int16_t standby() override
Sets the module to standby mode (overload for PhysicalLayer compatibility). Uses 13 MHz RC oscillator...
Definition LR2021.cpp:436

LR2021::setRfSwitchTable
void setRfSwitchTable(const uint32_t(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition LR2021_config.cpp:213

LR2021::startReceiveDutyCycleAuto
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 LR2021.cpp:544

LR2021::setModem
int16_t setModem(ModemType_t modem) override
Set modem for the radio to use. Will perform full reset and reconfigure the radio using its default p...
Definition LR2021.cpp:707

LR2021::setNodeAddress
int16_t setNodeAddress(uint8_t nodeAddr)
Sets node address. Calling this method will also enable address filtering for node address only.
Definition LR2021_config.cpp:1051

LR2021::setPreambleLength
int16_t setPreambleLength(size_t preambleLength) override
Sets preamble length for LoRa or GFSK modem. Allowed values range from 1 to 65535.
Definition LR2021_config.cpp:409

LR2021::setOutputPower
int16_t setOutputPower(int8_t power) override
Sets output power. Allowed values are in range from -9 to 22 dBm (sub-GHz PA) or -19 to 12 dBm (high-...
Definition LR2021_config.cpp:144

LR2021::setSideDetector
int16_t setSideDetector(const LR2021LoRaSideDetector_t *cfg, size_t numDetectors)
Configure LoRa side detector, which enables to detect mutiple spreading factors and receive one of th...
Definition LR2021_config.cpp:1122

LR2021::setSpreadingFactor
int16_t setSpreadingFactor(uint8_t sf, bool legacy=false)
Sets LoRa spreading factor. Allowed values range from 5 to 12.
Definition LR2021_config.cpp:326

LR2021::setRegulatorDCDC
int16_t setRegulatorDCDC()
Set regulator mode to DC-DC.
Definition LR2021_cmds_chip_control.cpp:344

LR2021::clearTxBuffer
int16_t clearTxBuffer() override
Discard a payload previously written by writeTxBuffer. On radios whose transmit buffer is simply over...
Definition LR2021.cpp:1138

LR2021::implicitHeader
int16_t implicitHeader(size_t len)
Set implicit header mode for future reception/transmission.
Definition LR2021_config.cpp:1043

LR2021::startReceive
int16_t startReceive() override
Interrupt-driven receive method with default parameters. Implemented for compatibility with PhysicalL...
Definition LR2021.cpp:503

LR2021::beginLRFHSS
int16_t beginLRFHSS(const ConfigLRFHSS_t &config)
Initialization method for LR-FHSS modem.
Definition LR2021.cpp:172

LR2021::setRxBoostedGainMode
int16_t setRxBoostedGainMode(uint8_t level)
Enables or disables Rx Boosted Gain mode (additional Rx gain for increased power consumption).
Definition LR2021_config.cpp:968

LR2021::setRegulatorLDO
int16_t setRegulatorLDO()
Set regulator mode to LDO.
Definition LR2021_cmds_chip_control.cpp:340

LR2021::startReceiveDutyCycle
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 LR2021.cpp:507

LR2021::getSNR
float getSNR() override
Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem.
Definition LR2021.cpp:1231

LR2021::getFlrcRxStats
int16_t getFlrcRxStats(uint16_t *packetRx, uint16_t *packetCrcError, uint16_t *lenError)
Get FLRC Rx statistics.
Definition LR2021_cmds_flrc.cpp:28

LR2021::stageMode
int16_t stageMode(RadioModeType_t mode, RadioModeConfig_t *cfg) override
Stage mode of the radio to be launched later using launchMode.
Definition LR2021.cpp:984

LR2021::setFrequencyDeviation
int16_t setFrequencyDeviation(float freqDev) override
Sets GFSK frequency deviation. Allowed values range from 0.6 to 500.0 kHz.
Definition LR2021_config.cpp:618

LR2021::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition LR2021.cpp:480

LR2021::randomByte
uint8_t randomByte() override
Get one truly random byte from RSSI noise.
Definition LR2021.cpp:1242

LR2021::setIrqFlags
int16_t setIrqFlags(uint32_t irq) override
Set interrupt on DIO1 to be sent on a specific IRQ bit (e.g. RxTimeout, CadDone).
Definition LR2021.cpp:699

LR2021::ookDetector
int16_t ookDetector(uint16_t pattern=0x0285, uint8_t len=16, uint8_t repeats=0, bool syncRaw=false, bool rising=false, uint8_t sofLen=0)
Set OOK detector properties. The default values are set to allow ADS-B reception.
Definition LR2021_config.cpp:1105

LR2021::getTemperature
float getTemperature(uint8_t source, uint8_t bits=13)
Read the temperature.
Definition LR2021.cpp:1182

LR2021::setLrFhssConfig
int16_t setLrFhssConfig(uint8_t bw, uint8_t cr, uint8_t hdrCount=3, uint16_t hopSeed=0x13A)
Sets LR-FHSS configuration.
Definition LR2021_config.cpp:947

LR2021::getGfskRxStats
int16_t getGfskRxStats(uint16_t *packetRx, uint16_t *packetCrcError, uint16_t *lenError, uint16_t *preambleDet, uint16_t *syncOk, uint16_t *syncFail, uint16_t *timeout)
Get GFSK Rx statistics.
Definition LR2021_cmds_gfsk.cpp:66

Module
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition Module.h:74

Module::RFSWITCH_MAX_PINS
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code. Note: It is not recommended to use this c...
Definition Module.h:83

Module::MODE_TX
@ MODE_TX
Transmission mode.
Definition Module.h:120

Module::MODE_IDLE
@ MODE_IDLE
Idle mode.
Definition Module.h:114

Module::MODE_RX
@ MODE_RX
Receive mode.
Definition Module.h:117

Module::MODE_END_OF_TABLE
@ 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

PhysicalLayer::startReceive
virtual int16_t startReceive()
Sets module to received mode using its default configuration.
Definition PhysicalLayer.cpp:131

PhysicalLayer::readData
virtual int16_t readData(uint8_t *data, size_t len)
Reads data that was received after calling startReceive method.
Definition PhysicalLayer.cpp:225

PhysicalLayer::transmit
int16_t transmit(const char *str, uint8_t addr=0)
C-string transmit method.
Definition PhysicalLayer.cpp:53

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:156

PhysicalLayer::receive
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

RADIOLIB_SHAPING_0_5
#define RADIOLIB_SHAPING_0_5
Gaussian shaping filter, BT = 0.5.
Definition TypeDef.h:27

LR2021::fastCad
bool fastCad
Determines the type of Lora CAD to perform, either "standard" CAD (same as is implemented LR11x0,...
Definition LR2021.h:52

LR2021::irqDioNum
uint32_t irqDioNum
Which DIO pin is to be used as the interrupt pin.
Definition LR2021.h:44

LR2021::tcxoVoltage
float tcxoVoltage
TCXO reference voltage to be set on DIO3. Defaults to 1.6 V. If you are seeing -706/-707 error codes,...
Definition LR2021.h:79

RadioLibTime_t
unsigned long RadioLibTime_t
Type used for durations in RadioLib.
Definition TypeDef.h:761

RadioLibIrqFlags_t
uint32_t RadioLibIrqFlags_t
Type used for radio-agnostic IRQ flags. IRQ to enable corresponds to the bit index (RadioLibIrq_t)....
Definition TypeDef.h:767

ConfigFLRC_t
Definition PhysicalLayer.h:348

ConfigFSK_t
Definition PhysicalLayer.h:298

ConfigLRFHSS_t
Definition PhysicalLayer.h:335

ConfigLoRa_t
Definition PhysicalLayer.h:280

ConfigOOK_t
Definition PhysicalLayer.h:322

LR2021LoRaSideDetector_t
Structure to configure multi-SF detection.
Definition LR2021_types.h:26

Module::RfSwitchMode_t
Description of RF switch pin states for a single mode. See setRfSwitchTable for details.
Definition Module.h:90

ChannelScanConfig_t
Common channel scan configuration structure.
Definition PhysicalLayer.h:165

DataRate_t
Common data rate structure.
Definition PhysicalLayer.h:74

RadioModeConfig_t
Definition PhysicalLayer.h:208