RFInterface.h

Go to the documentation of this file.

 
#ifndef DEFAULTRF_INTERFACE_H_
#define DEFAULTRF_INTERFACE_H_
 
#include "meshFrame.h"
 
typedef enum{
    RFI_NONE = 0,
    RFI_NRF24L01 = 1
    //... TODO add other interface types if needed
}RFIType;
 
class RFInterface{
public:
 
    RFInterface(const uint8_t maxFrameLength, const RFIType interfaceType, const bool canCheckInterference, const uint8_t maxChannelNumber, const uint8_t minChannelNumber, const uint8_t maxPowerValue, const uint8_t minPowerValue, const bool canSetSpeed, const uint32_t baseFrequency, ThreadLock *_lock);
 
    virtual ~RFInterface() = 0;
 
    virtual bool init() = 0;
 
    virtual bool deInit() = 0;
 
    virtual bool hasError() = 0;
 
    virtual bool send(uint8_t* data, uint8_t dataSize) = 0;
 
    virtual bool recv(uint8_t* data, uint8_t& dataSize, int8_t& rssi) = 0;
 
    virtual uint8_t available() = 0;
 
    virtual bool sleep() = 0;
 
    virtual bool wakeUp() = 0;
 
    virtual bool checkInterference() = 0;
 
    virtual bool setChannel(uint8_t channel) = 0;
 
    virtual bool setPower(uint8_t power) = 0;
 
    virtual bool setFullSpeed(bool enableFullSpeed) = 0;
 
    virtual bool setReceiveInterruptCallback(void(*InterruptCallback)(void)) = 0;
 
    virtual bool interruptHandle() = 0;
 
    virtual void handle() = 0;
 
    virtual void printDetails(OSTREAM *stream) = 0;
 
    virtual uint8_t scanChannels(uint8_t startChannel, uint8_t endChannel, uint8_t retries = 50, OSTREAM *stream = NULL) = 0;
 
    virtual uint8_t scanChannels(uint8_t startChannel, uint8_t endChannel, OSTREAM *stream = NULL) = 0;
 
    virtual bool scanChannelsWorking() = 0;
 
    virtual uint32_t getChannelsWidth() = 0;
 
#ifndef RF_NO_INTERNAL_TMP_BUFFER
 
    virtual uint8_t* getInternalTemporaryBuffer() = 0;
#endif 
 
 
    const uint8_t MaxFrameLength;
 
    const RFIType InterfaceType;
 
    const bool CanCheckInterference:1;
 
    const uint8_t MaxChannelNumber;
 
    const uint8_t MinChannelNumber;
 
    const uint8_t MaxPowerValue;
 
    const uint8_t MinPowerValue;
 
    const bool CanSetSpeed:1;
 
    const uint32_t BaseFrequency;
 
    ThreadLock* lock;
 
 
 
#ifdef SIMULATION
    virtual uint32_t millis() = 0;
    virtual uint32_t micros() = 0;
    virtual uint64_t micros64() = 0;
    virtual void delay(uint32_t time) = 0;
    virtual void delayMicroseconds(uint32_t time) = 0;
    virtual std::chrono::nanoseconds PauseSimulationTimer() = 0;
    virtual void ResumeSimulationTimer() = 0;
    virtual std::mutex& GetStreamMutex() = 0;
    virtual std::mutex& GetMutex() = 0;
    virtual bool isLogOnly() = 0;
    virtual void logTableChange(std::string& descriptor, TableChangeType changeType, const char* data) = 0;
    virtual void OnScanResponse(const MeshNetScanResult& result) = 0;
#endif // SIMULATION
 
};
 
 
#endif /* DEFAULTRF_INTERFACE_H_ */