IoAbstractionWire.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 _IOABSTRACTION_IOABSTRACTIONWIRE_H_
#define _IOABSTRACTION_IOABSTRACTIONWIRE_H_
 
//
// An addition mode for devices that support LED controlled output, where the output is a controlled current source
//
#define LED_CURRENT_OUTPUT 0x99
#define AW9523_LED_OUTPUT LED_CURRENT_OUTPUT
 
#include "PlatformDeterminationWire.h"
#include "IoAbstraction.h"
#include "AnalogDeviceAbstraction.h"
 
class PCF8574IoAbstraction : public BasicIoAbstraction {
public:
    enum { NEEDS_WRITE_FLAG, PINS_CONFIGURED_READ_FLAG, PCF8575_16BIT_FLAG, INVERTED_LOGIC };
private:
    WireType wireImpl;
    uint8_t address;
    uint8_t lastRead[2];
    uint8_t toWrite[2];
    uint8_t flags;
    uint8_t interruptPin;
public:
    PCF8574IoAbstraction(uint8_t addr, uint8_t interruptPin, WireType wireInstance = nullptr, bool mode16bit = false, bool invertedLogic = false);
    virtual ~PCF8574IoAbstraction() { }
 
    void overrideReadFlag() { bitWrite(flags, PINS_CONFIGURED_READ_FLAG, true); }
 
    void pinDirection(pinid_t pin, uint8_t mode) override;
 
    void writeValue(pinid_t pin, uint8_t value) override;
 
    uint8_t readValue(pinid_t pin) override;
 
    void writePort(pinid_t pin, uint8_t port) override;
 
    uint8_t readPort(pinid_t pin) override;
 
    void attachInterrupt(pinid_t pin, RawIntHandler intHandler, uint8_t mode) override;
 
    bool runLoop() override;
};
 
class Standard16BitDevice : public BasicIoAbstraction {
protected:
    uint16_t lastRead;
    uint16_t toWrite;
    uint8_t  flags;
    virtual void initDevice()=0;
public:
    Standard16BitDevice();
    ~Standard16BitDevice() override = default;
 
    void writeValue(pinid_t pin, uint8_t value) override;
    uint8_t readValue(pinid_t pin) override;
    void writePort(pinid_t pin, uint8_t port) override;
    uint8_t readPort(pinid_t pin) override;
    void clearChangeFlags();
    void setReadPort(int port);
    bool isReadPortSet(int port) const;
    bool isWritePortSet(int port) const;
    bool isInitNeeded() const;
    void markInitialised();
};
 
enum Mcp23xInterruptMode {
    NOT_ENABLED = 0, ACTIVE_HIGH_OPEN = 0b110, ACTIVE_LOW_OPEN = 0b100, ACTIVE_HIGH = 0b010, ACTIVE_LOW = 0b000 
};
 
class MCP23017IoAbstraction : public Standard16BitDevice {
private:
    WireType wireImpl;
    uint8_t  address;
    pinid_t  intPinA;
    pinid_t  intPinB;
    uint8_t  intMode;
public:
    MCP23017IoAbstraction(uint8_t address, Mcp23xInterruptMode intMode,  pinid_t intPinA, pinid_t intPinB, WireType wireImpl = nullptr);
    explicit MCP23017IoAbstraction(uint8_t address, WireType wireImpl = nullptr);
 
    MCP23017IoAbstraction(uint8_t address, Mcp23xInterruptMode intMode, pinid_t intPinA, WireType wireImpl = nullptr);
 
 
    ~MCP23017IoAbstraction() override = default;
 
    void pinDirection(pinid_t pin, uint8_t mode) override;
 
    void attachInterrupt(pinid_t pin, RawIntHandler intHandler, uint8_t mode) override;
    
    bool runLoop() override;
    
    void setInvertInputPin(pinid_t pin, bool shouldInvert);
 
    void resetDevice(int resetPin);
 
private:
    void initDevice() override;
};
 
class AW9523IoAbstraction : public Standard16BitDevice {
private:
    WireType wireImpl;
    uint8_t i2cAddress;
    pinid_t interruptPin;
public:
    enum AW9523CurrentControl: uint8_t { FULL_CURRENT = 0, CURRENT_THREE_QUARTER = 1, CURRENT_HALF = 2, CURRENT_QUARTER = 3 };
 
    explicit AW9523IoAbstraction(uint8_t addr, pinid_t intPin = IO_PIN_NOT_DEFINED, WireType wirePtr = nullptr);
    ~AW9523IoAbstraction() override = default;
 
    uint8_t deviceId();
 
 
    void pinDirection(pinid_t pin, uint8_t mode) override;
 
    void attachInterrupt(pinid_t pin, RawIntHandler intHandler, uint8_t mode) override;
 
    bool runLoop() override;
 
    void setPinLedCurrent(pinid_t pin, uint8_t pwr);
 
    void writeGlobalControl(bool pushPullP0, AW9523CurrentControl maxCurrentMode = FULL_CURRENT);
 
    void softwareReset();
private:
    void initDevice() override;
};
 
class AW9523AnalogAbstraction : public AnalogDevice {
private:
    AW9523IoAbstraction& theAbstraction;
public:
    explicit AW9523AnalogAbstraction(AW9523IoAbstraction &abs): theAbstraction(abs) {}
 
    int getMaximumRange(AnalogDirection direction, pinid_t pin) override { return 255; }
 
    int getBitDepth(AnalogDirection direction, pinid_t pin) override { return 8; }
 
    void initPin(pinid_t pin, AnalogDirection direction) override;
 
    unsigned int getCurrentValue(pinid_t pin) override { return -1; }
 
    float getCurrentFloat(pinid_t pin) override { return NAN; }
 
    void setCurrentValue(pinid_t pin, unsigned int newValue) override { theAbstraction.setPinLedCurrent(pin, newValue); }
 
    void setCurrentFloat(pinid_t pin, float newValue) override { theAbstraction.setPinLedCurrent(pin, (uint8_t)(newValue * 255.0F)); }
};
 
//
// These definitions help with accessing the various registers, and provide default values and layouts for the MPR121
// You can use many of them with the read/write register functions if you need to directly access the chips registers.
// Only a subset of the available operations are directly handled within IoAbstraction directly, but this gives you
// access to the rest.
//
#define MPR121_FIRST_GPIO 4
#define MPR121_TOTAL_PINS 13
#define MPR121_PROXIMITY_PIN 12
 
#define MPR121_TOUCH_STATUS_16 0x00
#define MPR121_OOR_STATUS_16 0x02
#define MPR121_ELECTRODE_DATA_2ND 0x04
#define MPR121_BASELINE_DATA_3RD 0x1E
#define MPR121_MHD_RISING 0x2B
#define MPR121_NHD_RISING 0x2C
#define MPR121_NCL_RISING 0x2D
#define MPR121_FDL_RISING 0x2E
#define MPR121_MHD_FALLING 0x2F
#define MPR121_NHD_FALLING 0x30
#define MPR121_NCL_FALLING 0x31
#define MPR121_FDL_FALLING 0x32
#define MPR121_NHD_TOUCHED 0x33
#define MPR121_NCL_TOUCHED 0x34
#define MPR121_FDL_TOUCHED 0x35
#define MPR121_TCH_REL_THRESHOLD 0x41
#define MPR121_DEBOUNCE_REG 0x5B
#define MPR121_AFE_CONFIG_1 0x5C
#define MPR121_AFE_CONFIG_2 0x5D
#define MPR121_ELECTRODE_CONFIG 0x5E
#define MPR121_ELECTRODE_CURRENT_0 0x5F
#define MPR121_CHARGE_TIME_0 0x6C
#define MPR121_GPIO_CONTROL_0 0x73
#define MPR121_GPIO_CONTROL_1 0x74
#define MPR121_GPIO_DATA 0x75
#define MPR121_GPIO_DIRECTION_0 0x76
#define MPR121_GPIO_ENABLE 0x77
#define MPR121_GPIO_DATA_SET 0x78
#define MPR121_GPIO_DATA_CLEAR 0x79
#define MPR121_GPIO_DATA_TOGGLE 0x7A
#define MPR121_AUTO_CONFIG_0 0x7B
#define MPR121_AUTO_CONFIG_1 0x7C
#define MPR121_UPPER_LIMIT 0x7D
#define MPR121_LOWER_LIMIT 0x7E
#define MPR121_TARGET_LIMIT 0x7F
#define MPR121_SOFT_RESET 0x80
#define MPR121_SOFT_RESET_VALUE 0x63
#define MPR121_LED_PWM_0 0x81
#define MPR121_LED_PWM_1 0x82
#define MPR121_LED_PWM_2 0x83
#define MPR121_LED_PWM_3 0x84
 
enum MPR121ConfigType: uint8_t { MPR121_MANUAL_CONFIG, MPR121_AUTO_CONFIG };
 
class MPR121IoAbstraction : public Standard16BitDevice {
private:
    WireType wireImpl;
    uint8_t i2cAddress;
    pinid_t interruptPin;
    pinid_t maximumTouchPin = 0;
public:
    explicit MPR121IoAbstraction(uint8_t addr, pinid_t intPin = IO_PIN_NOT_DEFINED, WireType wirePtr = nullptr);
    ~MPR121IoAbstraction() override = default;
 
    void begin(int maxTouchPin, MPR121ConfigType configType, uint8_t configReg1 = 0x10, uint8_t configReg2 = 0x20);
 
    void pinDirection(pinid_t pin, uint8_t mode) override;
 
    void attachInterrupt(pinid_t pin, RawIntHandler intHandler, uint8_t mode) override;
 
    bool runLoop() override;
 
    void electrodeSettingsForPin(pinid_t pin, uint8_t touchThreshold, uint8_t releaseThreshold, uint8_t current=0, uint8_t chargeTime=0);
 
    uint16_t getOutOfRangeRegister();
 
    void configureDebounce(uint8_t debounceTouch, uint8_t debounceRelease);
 
    uint16_t read2ndFilteredData(uint8_t pin);
 
    void setPinLedCurrent(pinid_t pin, uint8_t pwr);
 
    void softwareReset();
    void initDevice() override { /* ignored */ }
 
    void writeReg8(uint8_t reg, uint8_t data);
    void writeReg16(uint8_t reg, uint16_t data);
    uint8_t readReg8(uint8_t reg);
    uint16_t readReg16(uint8_t reg);
protected:
    void enableTouchSupportOnPin(pinid_t pin);
};
 
class MPR121AnalogAbstraction : public AnalogDevice {
private:
    MPR121IoAbstraction& theAbstraction;
public:
    explicit MPR121AnalogAbstraction(MPR121IoAbstraction &abs): theAbstraction(abs) {}
 
    int getMaximumRange(AnalogDirection direction, pinid_t pin) override { return 255; }
 
    int getBitDepth(AnalogDirection direction, pinid_t pin) override { return 8; }
 
    void initPin(pinid_t pin, AnalogDirection direction) override;
 
    unsigned int getCurrentValue(pinid_t pin) override { return theAbstraction.read2ndFilteredData(pin) >> 2; }
 
    float getCurrentFloat(pinid_t pin) override { return theAbstraction.read2ndFilteredData(pin) / 1024.0F; }
 
    void setCurrentValue(pinid_t pin, unsigned int newValue) override { theAbstraction.setPinLedCurrent(pin, newValue >> 4); }
 
    void setCurrentFloat(pinid_t pin, float newValue) override { theAbstraction.setPinLedCurrent(pin, (uint8_t)(newValue * 15.0F)); }
};
 
// to remain compatible with old code
#define ioFrom8754 ioFrom8575
 
IoAbstractionRef ioFrom8574(uint8_t addr, pinid_t interruptPin, WireType wireImpl, bool invertedLogic = false);
 
IoAbstractionRef ioFrom8575(uint8_t addr, pinid_t interruptPin, WireType wireImpl, bool invertedLogic = false);
 
IoAbstractionRef ioFrom23017(pinid_t addr, WireType wireImpl);
 
IoAbstractionRef ioFrom23017(uint8_t addr, Mcp23xInterruptMode intMode, pinid_t interruptPin, WireType wireImpl);
 
IoAbstractionRef ioFrom23017IntPerPort(pinid_t addr, Mcp23xInterruptMode intMode, pinid_t interruptPinA, pinid_t interruptPinB, WireType wireImpl);
 
inline IoAbstractionRef ioFrom8574(uint8_t addr, pinid_t interruptPin = 0xff, bool invertedLogic = false) {
    return ioFrom8574(addr, interruptPin, defaultWireTypePtr, invertedLogic);
};
 
inline IoAbstractionRef ioFrom8575(uint8_t addr, pinid_t interruptPin = 0xff, bool invertedLogic = false) {
    return ioFrom8575(addr, interruptPin, defaultWireTypePtr, invertedLogic);
};
 
inline IoAbstractionRef ioFrom23017IntPerPort(uint8_t addr, Mcp23xInterruptMode intMode, pinid_t interruptPinA, pinid_t interruptPinB) {
    return ioFrom23017IntPerPort(addr, intMode, interruptPinA, interruptPinB, defaultWireTypePtr);
}
 
inline IoAbstractionRef ioFrom23017(uint8_t addr, Mcp23xInterruptMode intMode, pinid_t interruptPin) {
    return ioFrom23017(addr, intMode, interruptPin, defaultWireTypePtr);
}
 
inline IoAbstractionRef ioFrom23017(pinid_t addr) {
    return ioFrom23017(addr, defaultWireTypePtr);
}
 
#endif /* _IOABSTRACTION_IOABSTRACTIONWIRE_H_ */