PhysicalLayer.h

#if !defined(_RADIOLIB_PHYSICAL_LAYER_H)
#define _RADIOLIB_PHYSICAL_LAYER_H
 
#include "../../TypeDef.h"
#include "../../Module.h"
 
// data rate structure interpretation in case LoRa is used
struct LoRaRate_t {
  uint8_t spreadingFactor;
  float bandwidth;
  uint8_t codingRate;
};
 
// data rate structure interpretation in case FSK is used
struct FSKRate_t {
  float bitRate;
  float freqDev;
};
 
// common data rate
union DataRate_t {
  LoRaRate_t lora;
  FSKRate_t fsk;
};
 
class PhysicalLayer {
  public:
 
    // constructor
 
    PhysicalLayer(float step, size_t maxLen);
 
    // basic methods
 
    #if defined(RADIOLIB_BUILD_ARDUINO)
    int16_t transmit(__FlashStringHelper* fstr, uint8_t addr = 0);
 
    int16_t transmit(String& str, uint8_t addr = 0);
    #endif
 
    int16_t transmit(const char* str, uint8_t addr = 0);
 
    virtual int16_t transmit(uint8_t* data, size_t len, uint8_t addr = 0);
 
    #if defined(RADIOLIB_BUILD_ARDUINO)
    int16_t receive(String& str, size_t len = 0);
    #endif
 
    virtual int16_t sleep();
 
    virtual int16_t standby();
 
    virtual int16_t standby(uint8_t mode);
 
    virtual int16_t startReceive();
 
    virtual int16_t startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len);
 
    virtual int16_t receive(uint8_t* data, size_t len);
 
    #if defined(RADIOLIB_BUILD_ARDUINO)
    int16_t startTransmit(String& str, uint8_t addr = 0);
    #endif
 
    int16_t startTransmit(const char* str, uint8_t addr = 0);
 
    virtual int16_t startTransmit(uint8_t* data, size_t len, uint8_t addr = 0);
 
    virtual int16_t finishTransmit();
 
    #if defined(RADIOLIB_BUILD_ARDUINO)
    int16_t readData(String& str, size_t len = 0);
    #endif
 
    virtual int16_t readData(uint8_t* data, size_t len);
 
    virtual int16_t transmitDirect(uint32_t frf = 0);
 
    virtual int16_t receiveDirect();
 
    // configuration methods
 
    virtual int16_t setFrequency(float freq);
 
    virtual int16_t setBitRate(float br);
 
    virtual int16_t setFrequencyDeviation(float freqDev);
 
    virtual int16_t setDataShaping(uint8_t sh);
 
    virtual int16_t setEncoding(uint8_t encoding);
 
    virtual int16_t invertIQ(bool enable);
 
    virtual int16_t setOutputPower(int8_t power);
 
    virtual int16_t setSyncWord(uint8_t* sync, size_t len);
 
    virtual int16_t setPreambleLength(size_t len);
    
    virtual int16_t setDataRate(DataRate_t dr);
 
    float getFreqStep() const;
 
    virtual size_t getPacketLength(bool update = true);
 
    virtual float getRSSI();
 
    virtual float getSNR();
 
    virtual uint32_t getTimeOnAir(size_t len);
 
    virtual uint32_t calculateRxTimeout(uint32_t timeoutUs);
 
    virtual int16_t irqRxDoneRxTimeout(uint16_t &irqFlags, uint16_t &irqMask);
 
    virtual bool isRxTimeout();
 
    virtual int16_t startChannelScan();
 
    virtual int16_t getChannelScanResult();
 
    virtual int16_t scanChannel();
 
    int32_t random(int32_t max);
 
    int32_t random(int32_t min, int32_t max);
 
    virtual uint8_t randomByte();
 
    int16_t startDirect();
 
    #if !RADIOLIB_EXCLUDE_DIRECT_RECEIVE
    int16_t setDirectSyncWord(uint32_t syncWord, uint8_t len);
 
    virtual void setDirectAction(void (*func)(void));
 
    virtual void readBit(uint32_t pin);
 
    int16_t available();
 
    void dropSync();
 
    uint8_t read(bool drop = true);
    #endif
 
    virtual int16_t setDIOMapping(uint32_t pin, uint32_t value);
 
    virtual void setPacketReceivedAction(void (*func)(void));
 
    virtual void clearPacketReceivedAction();
 
    virtual void setPacketSentAction(void (*func)(void));
 
    virtual void clearPacketSentAction();
    
    virtual void setChannelScanAction(void (*func)(void));
 
    virtual void clearChannelScanAction();
 
    #if RADIOLIB_INTERRUPT_TIMING
 
    void setInterruptSetup(void (*func)(uint32_t));
 
    void setTimerFlag();
 
    #endif
 
#if !RADIOLIB_EXCLUDE_DIRECT_RECEIVE
  protected:
    void updateDirectBuffer(uint8_t bit);
#endif
 
#if !RADIOLIB_GODMODE
  private:
#endif
    float freqStep;
    size_t maxPacketLength;
 
    #if !RADIOLIB_EXCLUDE_DIRECT_RECEIVE
    uint8_t bufferBitPos;
    uint8_t bufferWritePos;
    uint8_t bufferReadPos;
    uint8_t buffer[RADIOLIB_STATIC_ARRAY_SIZE];
    uint32_t syncBuffer;
    uint32_t directSyncWord;
    uint8_t directSyncWordLen;
    uint32_t directSyncWordMask;
    bool gotSync;
    #endif
 
    virtual Module* getMod() = 0;
 
    // allow specific classes access the private getMod method
    friend class AFSKClient;
    friend class RTTYClient;
    friend class MorseClient;
    friend class HellClient;
    friend class SSTVClient;
    friend class AX25Client;
    friend class FSK4Client;
    friend class PagerClient;
    friend class BellClient;
    friend class FT8Client;
    friend class LoRaWANNode;
};
 
#endif