RFM95.hpp

Go to the documentation of this file.

 
#ifndef RFM95_HPP
#define RFM95_HPP
 
#include "CH341SPI.hpp"
#include "SPIInterface.hpp"
#include <cstdint>
#include <vector>
#include <string>
#include <chrono>
#include <thread>
#include <memory>
 
class RFM95
{
public:
    // RFM95 Register Addresses
    static constexpr uint8_t REG_FIFO = 0x00;
    static constexpr uint8_t REG_OP_MODE = 0x01;
    static constexpr uint8_t REG_FRF_MSB = 0x06;
    static constexpr uint8_t REG_FRF_MID = 0x07;
    static constexpr uint8_t REG_FRF_LSB = 0x08;
    static constexpr uint8_t REG_PA_CONFIG = 0x09;
    static constexpr uint8_t REG_PA_RAMP = 0x0A;
    static constexpr uint8_t REG_OCP = 0x0B;
    static constexpr uint8_t REG_LNA = 0x0C;
    static constexpr uint8_t REG_FIFO_ADDR_PTR = 0x0D;
    static constexpr uint8_t REG_FIFO_TX_BASE_ADDR = 0x0E;
    static constexpr uint8_t REG_FIFO_RX_BASE_ADDR = 0x0F;
    static constexpr uint8_t REG_FIFO_RX_CURRENT_ADDR = 0x10;
    static constexpr uint8_t REG_IRQ_FLAGS_MASK = 0x11;
    static constexpr uint8_t REG_IRQ_FLAGS = 0x12;
    static constexpr uint8_t REG_RX_NB_BYTES = 0x13;
    static constexpr uint8_t REG_PKT_SNR_VALUE = 0x19;
    static constexpr uint8_t REG_PKT_RSSI_VALUE = 0x1A;
    static constexpr uint8_t REG_MODEM_CONFIG_1 = 0x1D;
    static constexpr uint8_t REG_MODEM_CONFIG_2 = 0x1E;
    static constexpr uint8_t REG_PREAMBLE_MSB = 0x20;
    static constexpr uint8_t REG_PREAMBLE_LSB = 0x21;
    static constexpr uint8_t REG_PAYLOAD_LENGTH = 0x22;
    static constexpr uint8_t REG_MODEM_CONFIG_3 = 0x26;
    static constexpr uint8_t REG_FREQ_ERROR_MSB = 0x28;
    static constexpr uint8_t REG_FREQ_ERROR_MID = 0x29;
    static constexpr uint8_t REG_FREQ_ERROR_LSB = 0x2A;
    static constexpr uint8_t REG_RSSI_WIDEBAND = 0x2C;
    static constexpr uint8_t REG_DETECTION_OPTIMIZE = 0x31;
    static constexpr uint8_t REG_INVERTIQ = 0x33;
    static constexpr uint8_t REG_DETECTION_THRESHOLD = 0x37;
    static constexpr uint8_t REG_SYNC_WORD = 0x39;
    static constexpr uint8_t REG_INVERTIQ2 = 0x3B;
    static constexpr uint8_t REG_DIO_MAPPING_1 = 0x40;
    static constexpr uint8_t REG_DIO_MAPPING_2 = 0x41;
    static constexpr uint8_t REG_VERSION = 0x42;
    static constexpr uint8_t REG_PA_DAC = 0x4D;
 
    // RFM95 Operation Modes
    static constexpr uint8_t MODE_SLEEP = 0x00;
    static constexpr uint8_t MODE_STDBY = 0x01;
    static constexpr uint8_t MODE_TX = 0x03;
    static constexpr uint8_t MODE_RX_CONTINUOUS = 0x05;
    static constexpr uint8_t MODE_RX_SINGLE = 0x06;
 
    // PA Config
    static constexpr uint8_t PA_BOOST = 0x80;
 
    // IRQ Flags
    static constexpr uint8_t IRQ_CAD_DONE_MASK = 0x01;
    static constexpr uint8_t IRQ_CAD_DETECTED_MASK = 0x02;
    static constexpr uint8_t IRQ_RX_TIMEOUT_MASK = 0x04;
    static constexpr uint8_t IRQ_TX_DONE_MASK = 0x08;
    static constexpr uint8_t IRQ_VALID_HEADER_MASK = 0x10;
    static constexpr uint8_t IRQ_PAYLOAD_CRC_ERROR_MASK = 0x20;
    static constexpr uint8_t IRQ_RX_DONE_MASK = 0x40;
    static constexpr uint8_t IRQ_TX_TIMEOUT_MASK = 0x80;
 
    // DIO Mapping
    static constexpr uint8_t DIO0_RX_DONE = 0x00;
    static constexpr uint8_t DIO0_TX_DONE = 0x40;
    static constexpr uint8_t DIO1_RX_TIMEOUT = 0x00;
    static constexpr uint8_t DIO3_TX_DONE = 0x40; // 01 para DIO3
    static constexpr uint8_t DIO4_RX_DONE = 0x00; // 00 para DIO4
    static constexpr uint8_t DIO_TX_PIN = 0x03;
    static constexpr uint8_t DIO_RX_PIN = 0x04;
 
    RFM95(int device_index = 0);
 
    RFM95(std::unique_ptr<SPIInterface> spi_interface);
 
    ~RFM95();
 
    bool begin();
 
    void end();
 
    void setFrequency(float freq_mhz);
 
    float getFrequency();
 
    void setTxPower(int level, bool use_pa_boost = true);
 
    int getTxPower();
 
    void setSpreadingFactor(int sf);
 
    int getSpreadingFactor();
 
    void setBandwidth(float bw_khz);
 
    float getBandwidth();
 
    void setCodingRate(int denominator);
 
    int getCodingRate();
 
    void setPreambleLength(int length);
 
    int getPreambleLength();
 
    void setInvertIQ(bool invert = false);
 
    bool getInvertIQ();
 
    void setSyncWord(uint8_t sync_word);
 
    uint8_t getSyncWord();
 
    void setLNA(int lna_gain = -1, bool lna_boost = true);
 
    uint8_t getLNA();
 
    void setAutoAGC(bool enable);
 
    bool getAutoAGC();
 
    void clearIRQFlags();
 
    uint8_t getIRQFlags();
 
    void clearIRQFlagTxDone();
 
    void clearIRQFlagRxDone();
 
    bool getRxDone();
 
    bool getTxDone();
 
    bool getRxError();
 
    bool getValidHeader();
 
    bool getCADDone();
 
    bool getCADDetected();
 
    bool getPayloadCRCError();
 
    void setLoRaMode(bool enable = true);
 
    bool send(const std::vector<uint8_t> &data, bool invert_iq = false);
 
    std::vector<uint8_t> receive(float timeout = 5.0, bool invert_iq = false);
 
    void setContinuousReceive();
 
    void standbyMode();
 
    void sleepMode();
 
    void resetPtrRx();
 
    uint8_t getFifoRxCurrentAddr();
 
    uint8_t getRxNbBytes();
 
    std::vector<uint8_t> readPayload();
 
    float getRSSI();
 
    float getSNR();
 
    uint8_t readRegister(uint8_t address);
 
    void writeRegister(uint8_t address, uint8_t value);
 
    void receiveMode();
 
    void setDIOMapping(uint8_t _dio3 = 0x40, uint8_t _dio4 = 0x00);
 
    bool calibrateTemperature(float actual_temp);
 
    float readTemperature();
 
    bool setBeaconMode(int interval_ms, const std::vector<uint8_t> &payload);
 
    void stopBeaconMode();
 
    void checkOperatingMode();
 
    void checkIRQFlags();
 
    void printRegisters();
 
    bool testCommunication();
 
    uint8_t readVersionRegister();
 
private:
    std::unique_ptr<SPIInterface> spi; 
};
 
#endif // RFM95_HPP