AnalogDeviceAbstraction.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018 https://www.thecoderscorner.com (Dave Cherry).
 * This product is licensed under an Apache license, see the LICENSE file in the top-level directory.
 */
 
#ifndef _ANALOG_DEVICE_ABSTRACTION_H_
#define _ANALOG_DEVICE_ABSTRACTION_H_
 
#include "PlatformDetermination.h"
#include "BasicIoAbstraction.h"


enum AnalogDirection { DIR_IN, DIR_OUT, DIR_PWM };

class AnalogDevice {
public:
    virtual int getMaximumRange(AnalogDirection direction, pinid_t pin)=0;

    virtual int getBitDepth(AnalogDirection direction, pinid_t pin) = 0;

    virtual void initPin(pinid_t pin, AnalogDirection direction) = 0;

    virtual unsigned int getCurrentValue(pinid_t pin)=0;
 
    /*
     * Returns the current value on the ADC as a float between
     * 0 and 1.
     */
    virtual float getCurrentFloat(pinid_t pin) = 0;

    virtual void setCurrentValue(pinid_t pin, unsigned int newValue)=0;

    virtual void setCurrentFloat(pinid_t pin, float newValue)=0;
 
};
 
#if defined(IOA_USE_MBED)
#include "mbed/MbedAnalogDevice.h"
#elif defined(ESP32)
# include "esp32/ESP32AnalogDevice.h"
#elif defined(IOA_USE_ARDUINO)
#include "arduino/ArduinoAnalogDevice.h"
#elif defined(BUILD_FOR_PICO_CMAKE)
#include "pico/picoAnalogDevice.h"
#endif

AnalogDevice* internalAnalogIo();
 
#define asAnalogRef(x) (&(x))
 
#endif //_ANALOG_DEVICE_ABSTRACTION_H_