CANTramModule.h

Go to the documentation of this file.

#ifndef CANTRAMMODULE_H
#define CANTRAMMODULE_H
 
#include <Arduino.h>
#include "Interface.h"
#include "Debug.h"

class CANTramModule {
    public:
        CANTramModule() = default;

        virtual ~CANTramModule() = default;
        
        virtual String getHWType() const = 0;

        virtual String getHWVersion() const = 0;

        virtual String getFWVersion() const = 0;
        
        virtual uint8_t getGPIODemand() const = 0;

        virtual uint8_t getGPIOSupply() const = 0;

        virtual bool reset();

        uint8_t getSlot() const { return SLOT; }

        uint8_t getGPIOStart() const { return GPIO_START; }

        virtual void cycle(uint8_t* response){
            DEBUG_PRINTLN("[CANTramModule] cycle() called on module " + getHWType() + " in slot " + String(SLOT));
        }
        
        virtual bool attachModule(uint8_t slot, uint8_t gpioStart);

        virtual bool provideGPIOs() = 0;

        virtual bool requestGPIOs() = 0;

        virtual bool provideHardwareResources() = 0;

        virtual bool requestHardwareResources() = 0;

        virtual bool addInterfaces() = 0;

        virtual bool preInitialize() { return true; }
        virtual bool initialize() = 0;
        
        virtual Interface** getInterfaces() = 0;

        virtual size_t getInterfaceCount() = 0;
 
    protected:
        uint8_t SLOT = 0;
        uint8_t GPIO_START = 0;
};
 
#endif