CommInterface.h

Go to the documentation of this file.

 
#ifndef COMMINTERFACE_H
#define COMMINTERFACE_H
#ifdef ARDUINO
    #include <Arduino.h>    // include Arduino-Library for platformIO-build 
#else
    #include <mockArduino.h>
    using namespace arduinoMocking;
#endif
 
#include<CharArray.h>
#include<ErrorState.h>
 
class CommInterfaceBase: public ErrorState
{
public:
    virtual void setup_interface(){};
 
    virtual void sendNewFrame(CharArray* sendFrame){};
 
    virtual bool finishedSending(){};
 
    virtual void getReceivedFrame(CharArray* destFrameBuffer){};
 
    virtual bool receivedNewFrame(){};
 
    CommInterfaceBase(): ErrorState(){};
 
    ~CommInterfaceBase(){};
};
 
template<typename interface_type>                                       
class CommInterface: public CommInterfaceBase{
    protected:
        interface_type* interface;                       
 
        CharArray* sendBuffer = nullptr;                              
 
        CharArray* receiveBuffer = nullptr;                           
 
        virtual bool send() = 0;                                       
        
 
        virtual bool receive() = 0;                                     
 
    public:
        CommInterface(interface_type* interface, uint32_t baudrate): interface(interface){}; 
 
        void sendNewFrame(CharArray* sendFrame){
            if (sendBuffer == nullptr)
            {
                sendBuffer = sendFrame;                                 // set the send-buffer-ptr to the Frame, that has to be sent 
            }
        };
 
        bool finishedSending(){
            return sendBuffer==nullptr;
        };
 
        void getReceivedFrame(CharArray* externalRecBuffer){
            receiveBuffer = externalRecBuffer;                            // set the receive-buffer-ptr to the destination, the next received Frame should be stored at 
        };
 
        bool receivedNewFrame(){
            return receiveBuffer==nullptr;
        };
 
        virtual void receiveCycle(){                                     
            // Receiving
            if (receive()) {
                receiveBuffer = nullptr;                                
            };
        };
        
        virtual void sendCycle(){   
            // Sending
            if (send()){
                sendBuffer = nullptr;                                   
            }; 
        };
};
#endif // COMMINTERFACE_H