OutputDefinition.h

Go to the documentation of this file.

#ifndef OUTPUTDEFINITION_H
#define OUTPUTDEFINITION_H
 
#include <Arduino.h>
#include "Debug.h"

 
class OutputProvider; // Forward declaration    

class OutputDefinition {
    public:
        OutputDefinition(bool isShift, uint8_t pinOrBit, bool adc, bool pwm, bool inputOnly, OutputProvider* provider) :
            isShift(isShift), pinOrBit(pinOrBit), adc(adc), pwm(pwm), inputOnly(inputOnly), provider(provider)
             {}
 
        enum ConfigurationMode {
            MODE_INPUT,
            MODE_OUTPUT,
            MODE_PWM,
            MODE_INPUT_PULLUP,
            MODE_NONE
        };
        const String ConfigurationModeToString(ConfigurationMode mode) {
            switch(mode) {
                case MODE_INPUT: return "INPUT";
                case MODE_OUTPUT: return "OUTPUT";
                case MODE_PWM: return "PWM";
                case MODE_INPUT_PULLUP: return "INPUT_PULLUP";
                case MODE_NONE: return "NONE";
                default: return "UNKNOWN";
            }
        }
        const bool isShift;
        const uint8_t pinOrBit;
        const bool adc;
        const bool pwm;
        const bool inputOnly;
        ConfigurationMode mode = MODE_NONE; //default to output mode
        
        OutputProvider* provider;
        bool initialValue = LOW;

        String toString() {
            return String("OutputDefinition(isShift=") + (isShift ? "true" : "false") +
                   ", pinOrBit=" + String(pinOrBit) +
                   ", adc=" + (adc ? "true" : "false") +
                   ", pwm=" + (pwm ? "true" : "false") +
                   ", inputOnly=" + (inputOnly ? "true" : "false") + ")";
        }
};

class OutputProvider {
    public:
        virtual bool configureOutput(OutputDefinition* def, OutputDefinition::ConfigurationMode mode) = 0;
 

        virtual bool setOutput(OutputDefinition* def, bool state) = 0; //Returns true if successful

        virtual bool getOutput(OutputDefinition* def) = 0; //Returns current state

        virtual void enableOutputs(bool state=true){    //Append this method in derived classes to actually enable the outputs
            if(state == outputsEnabled){    //If state is already as requested, do nothing
                return;
            }
            outputsEnabled = state;
            INFO_PRINTLN("[OutputProvider] Outputs enabled set to: " + String(state)); 
            
        }

        virtual void disableOutputs(){
            enableOutputs(false);
        }
    private:
        bool outputsEnabled = false;
    };

class PWMOutputProvider : public OutputProvider {
    public:
        virtual bool setPWM(OutputDefinition* def, uint16_t value) = 0; //Returns true if successful

        virtual bool registerPWMChannel(OutputDefinition* def) = 0; //Returns true if successful
};
 
#endif