1
0
mirror of https://github.com/DCC-EX/CommandStation-EX.git synced 2024-11-23 08:06:13 +01:00
CommandStation-EX/IO_EXIOExpander.h
2022-12-09 14:41:48 +10:00

88 lines
2.8 KiB
C++

/*
* © 2021, Peter Cole. All rights reserved.
*
* This file is part of EX-CommandStation
*
* This is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* It is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with CommandStation. If not, see <https://www.gnu.org/licenses/>.
*/
/*
* The IO_EX-IOExpander.h device driver integrates with one or more EX-IOExpander devices.
* This device driver will configure the device and all I/O ports on startup, along with
* interacting with the device for all input/output duties.
*/
#ifndef IO_EX_IOEXPANDER_H
#define IO_EX_IOEXPANDER_H
#include "IO_GPIOBase.h"
#include "FSH.h"
#if __has_include ("myPinMap.h")
#include "myPinMap.h"
#else
#warning myPinMap.h not found. Using defaults from myPinMap.example.h
#include "myPinMap.example.h"
#endif
/////////////////////////////////////////////////////////////////////////////////////////////////////
/*
* IODevice subclass for EX-IOExpander.
*/
class EXIOExpander : public IODevice {
public:
static void create(VPIN vpin, int nPins, uint8_t i2cAddress) {
if (checkNoOverlap(vpin, nPins, i2cAddress)) new EXIOExpander(vpin, nPins, i2cAddress);
}
private:
// Constructor
EXIOExpander(VPIN firstVpin, int nPins, uint8_t i2cAddress) {
_firstVpin = firstVpin;
_nPins = nPins;
_i2cAddress = i2cAddress;
addDevice(this);
}
void _begin() {
// Initialise EX-IOExander device
if (I2CManager.exists(_i2cAddress)) {
#ifdef DIAG_IO
_display();
#endif
} else {
DIAG(F("EX-IOExpander device not found, I2C:%x"), _i2cAddress);
_deviceState = DEVSTATE_FAILED;
}
}
void _display() override {
DIAG(F("EX-IOExpander I2C:x%x Configured on Vpins:%d-%d %S"), _i2cAddress, _firstVpin, _firstVpin+_nPins-1,
_deviceState == DEVSTATE_FAILED ? F("OFFLINE") : F(""));
}
uint8_t _i2cAddress;
enum {
REG_EXIOINIT = 0x00, // Flag to initialise setup procedure
REG_EXIODPIN = 0x01, // Flag we're sending digital pin assignments
REG_EXIOAPIN = 0x02, // Flag we're sending analogue pin assignments
REG_EXIORDY = 0x03, // Flag we have completed setup procedure, also for EX-IO to ACK setup
REG_EXIODDIR = 0x04, // Flag we're sending digital pin direction configuration
REG_EXIODPUP = 0x05, // Flag we're sending digital pin pullup configuration
};
};
#endif