SX1272.h

#if !defined(_RADIOLIB_SX1272_H)
#define _RADIOLIB_SX1272_H
 
#include "../../TypeDef.h"
 
#if !RADIOLIB_EXCLUDE_SX127X
 
#include "../../Module.h"
#include "SX127x.h"
 
// SX1272 specific register map
#define RADIOLIB_SX1272_REG_AGC_REF                             0x43
#define RADIOLIB_SX1272_REG_AGC_THRESH_1                        0x44
#define RADIOLIB_SX1272_REG_AGC_THRESH_2                        0x45
#define RADIOLIB_SX1272_REG_AGC_THRESH_3                        0x46
#define RADIOLIB_SX1272_REG_PLL_HOP                             0x4B
#define RADIOLIB_SX1272_REG_TCXO                                0x58
#define RADIOLIB_SX1272_REG_PA_DAC                              0x5A
#define RADIOLIB_SX1272_REG_PLL                                 0x5C
#define RADIOLIB_SX1272_REG_PLL_LOW_PN                          0x5E
#define RADIOLIB_SX1272_REG_FORMER_TEMP                         0x6C
#define RADIOLIB_SX1272_REG_BIT_RATE_FRAC                       0x70
 
// SX1272 LoRa modem settings
// RADIOLIB_SX1272_REG_FRF_MSB + REG_FRF_MID + REG_FRF_LSB
#define RADIOLIB_SX1272_FRF_MSB                                 0xE4        //  7     0   carrier frequency setting: f_RF = (F(XOSC) * FRF)/2^19
#define RADIOLIB_SX1272_FRF_MID                                 0xC0        //  7     0       where F(XOSC) = 32 MHz
#define RADIOLIB_SX1272_FRF_LSB                                 0x00        //  7     0             FRF = 3 byte value of FRF registers
 
// RADIOLIB_SX127X_REG_MODEM_CONFIG_1
#define RADIOLIB_SX1272_BW_125_00_KHZ                           0b00000000  //  7     6   bandwidth:  125 kHz
#define RADIOLIB_SX1272_BW_250_00_KHZ                           0b01000000  //  7     6               250 kHz
#define RADIOLIB_SX1272_BW_500_00_KHZ                           0b10000000  //  7     6               500 kHz
#define RADIOLIB_SX1272_CR_4_4                                  0b00000000  //  5     3   error coding rate:  4/4 (undocumented)
#define RADIOLIB_SX1272_CR_4_5                                  0b00001000  //  5     3                       4/5
#define RADIOLIB_SX1272_CR_4_6                                  0b00010000  //  5     3                       4/6
#define RADIOLIB_SX1272_CR_4_7                                  0b00011000  //  5     3                       4/7
#define RADIOLIB_SX1272_CR_4_8                                  0b00100000  //  5     3                       4/8
#define RADIOLIB_SX1272_HEADER_EXPL_MODE                        0b00000000  //  2     2   explicit header mode
#define RADIOLIB_SX1272_HEADER_IMPL_MODE                        0b00000100  //  2     2   implicit header mode
#define RADIOLIB_SX1272_RX_CRC_MODE_OFF                         0b00000000  //  1     1   CRC disabled
#define RADIOLIB_SX1272_RX_CRC_MODE_ON                          0b00000010  //  1     1   CRC enabled
#define RADIOLIB_SX1272_LOW_DATA_RATE_OPT_OFF                   0b00000000  //  0     0   low data rate optimization disabled
#define RADIOLIB_SX1272_LOW_DATA_RATE_OPT_ON                    0b00000001  //  0     0   low data rate optimization enabled, mandatory for SF 11 and 12 with BW 125 kHz
 
// RADIOLIB_SX127X_REG_MODEM_CONFIG_2
#define RADIOLIB_SX1272_AGC_AUTO_OFF                            0b00000000  //  2     2   LNA gain set by REG_LNA
#define RADIOLIB_SX1272_AGC_AUTO_ON                             0b00000100  //  2     2   LNA gain set by internal AGC loop
 
// RADIOLIB_SX127X_REG_VERSION
#define RADIOLIB_SX1272_CHIP_VERSION                            0x22
 
// SX1272 FSK modem settings
// RADIOLIB_SX127X_REG_OP_MODE
#define RADIOLIB_SX1272_NO_SHAPING                              0b00000000  //  4     3   data shaping: no shaping (default)
#define RADIOLIB_SX1272_FSK_GAUSSIAN_1_0                        0b00001000  //  4     3                 FSK modulation Gaussian filter, BT = 1.0
#define RADIOLIB_SX1272_FSK_GAUSSIAN_0_5                        0b00010000  //  4     3                 FSK modulation Gaussian filter, BT = 0.5
#define RADIOLIB_SX1272_FSK_GAUSSIAN_0_3                        0b00011000  //  4     3                 FSK modulation Gaussian filter, BT = 0.3
#define RADIOLIB_SX1272_OOK_FILTER_BR                           0b00001000  //  4     3                 OOK modulation filter, f_cutoff = BR
#define RADIOLIB_SX1272_OOK_FILTER_2BR                          0b00010000  //  4     3                 OOK modulation filter, f_cutoff = 2*BR
 
// RADIOLIB_SX127X_REG_PA_RAMP
#define RADIOLIB_SX1272_LOW_PN_TX_PLL_OFF                       0b00010000  //  4     4   use standard PLL in transmit mode (default)
#define RADIOLIB_SX1272_LOW_PN_TX_PLL_ON                        0b00000000  //  4     4   use lower phase noise PLL in transmit mode
 
// RADIOLIB_SX127X_REG_SYNC_CONFIG
#define RADIOLIB_SX1272_FIFO_FILL_CONDITION_SYNC_ADDRESS        0b00000000  //  3     3   FIFO will be filled when sync address interrupt occurs (default)
#define RADIOLIB_SX1272_FIFO_FILL_CONDITION_ALWAYS              0b00001000  //  3     3   FIFO will be filled as long as this bit is set
 
// RADIOLIB_SX1272_REG_AGC_REF
#define RADIOLIB_SX1272_AGC_REFERENCE_LEVEL                     0x13        //  5     0   floor reference for AGC thresholds: AgcRef = -174 + 10*log(2*RxBw) + 8 + AGC_REFERENCE_LEVEL [dBm]
 
// RADIOLIB_SX1272_REG_AGC_THRESH_1
#define RADIOLIB_SX1272_AGC_STEP_1                              0x0E        //  4     0   1st AGC threshold
 
// RADIOLIB_SX1272_REG_AGC_THRESH_2
#define RADIOLIB_SX1272_AGC_STEP_2                              0x50        //  7     4   2nd AGC threshold
#define RADIOLIB_SX1272_AGC_STEP_3                              0x0B        //  4     0   3rd AGC threshold
 
// RADIOLIB_SX1272_REG_AGC_THRESH_3
#define RADIOLIB_SX1272_AGC_STEP_4                              0xD0        //  7     4   4th AGC threshold
#define RADIOLIB_SX1272_AGC_STEP_5                              0x0B        //  4     0   5th AGC threshold
 
// RADIOLIB_SX1272_REG_PLL_LOW_PN
#define RADIOLIB_SX1272_PLL_LOW_PN_BANDWIDTH_75_KHZ             0b00000000  //  7     6   low phase noise PLL bandwidth: 75 kHz
#define RADIOLIB_SX1272_PLL_LOW_PN_BANDWIDTH_150_KHZ            0b01000000  //  7     6                                  150 kHz
#define RADIOLIB_SX1272_PLL_LOW_PN_BANDWIDTH_225_KHZ            0b10000000  //  7     6                                  225 kHz
#define RADIOLIB_SX1272_PLL_LOW_PN_BANDWIDTH_300_KHZ            0b11000000  //  7     6                                  300 kHz (default)
 
class SX1272: public SX127x {
  public:
 
    // constructor
 
    SX1272(Module* mod); // cppcheck-suppress noExplicitConstructor
 
    // basic methods
 
    virtual int16_t begin(const ConfigLoRa_t& config);
 
    virtual int16_t begin(float freq = 915.0, float bw = 125.0, uint8_t sf = 9, uint8_t cr = 7, uint8_t syncWord = RADIOLIB_SX127X_SYNC_WORD, int8_t power = 10, uint16_t preambleLength = 8, uint8_t gain = 0);
 
    int16_t beginFSK(const ConfigFSK_t& config);
 
    int16_t beginFSK(float freq = 915.0, float br = 4.8, float freqDev = 5.0, float rxBw = 125.0, int8_t power = 10, uint16_t preambleLength = 16, bool enableOOK = false);
 
    void reset() override;
 
    // configuration methods
 
    int16_t setFrequency(float freq) override;
 
    int16_t setBandwidth(float bw);
 
    virtual int16_t setSpreadingFactor(uint8_t sf);
 
    int16_t setCodingRate(uint8_t cr);
 
    int16_t setBitRate(float br) override;
    
    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 setOutputPower(int8_t power) override;
 
    int16_t setOutputPower(int8_t power, bool forceRfo);
 
    int16_t checkOutputPower(int8_t power, int8_t* clipped) override;
 
    int16_t checkOutputPower(int8_t power, int8_t* clipped, bool useRfo);
 
    int16_t setGain(uint8_t gain);
 
    int16_t setDataShaping(uint8_t sh) override;
 
    int16_t setDataShapingOOK(uint8_t sh);
 
    float getRSSI() override;
 
    float getRSSI(bool packet, bool skipReceive = false);
 
    int16_t setCRC(bool enable, bool mode = false);
 
    int16_t forceLDRO(bool enable);
 
    int16_t autoLDRO();
 
    int16_t implicitHeader(size_t len);
 
    int16_t explicitHeader();
    
    int16_t setModem(ModemType_t modem) override;
 
#if !RADIOLIB_GODMODE
  protected:
#endif
    int16_t setBandwidthRaw(uint8_t newBandwidth);
    int16_t setSpreadingFactorRaw(uint8_t newSpreadingFactor);
    int16_t setCodingRateRaw(uint8_t newCodingRate);
 
    int16_t configFSK() override;
    void errataFix(bool rx) override;
 
};
 
#endif
 
#endif