From f40d57d8bde35ef7b075a602e65ec213a7058b2f Mon Sep 17 00:00:00 2001 From: peteGSX <97784652+peteGSX@users.noreply.github.com> Date: Fri, 1 Sep 2023 08:44:32 +1000 Subject: [PATCH] Add DCC type, EXTT broadcast from driver --- DCCEXParser.cpp | 55 ++++++++++++++-------------- IODevice.cpp | 7 ++++ IODevice.h | 5 +++ IO_EXTurntable.cpp | 16 +++++++++ Turntables.cpp | 90 +++++++++++++++++++++++++++++++++++++--------- Turntables.h | 29 ++++++++++++--- 6 files changed, 152 insertions(+), 50 deletions(-) diff --git a/DCCEXParser.cpp b/DCCEXParser.cpp index 24a7914..7473c26 100644 --- a/DCCEXParser.cpp +++ b/DCCEXParser.cpp @@ -708,7 +708,7 @@ void DCCEXParser::parseOne(Print *stream, byte *com, RingStream * ringStream) StringFormatter::send(stream, F(" %d X"), id); } else { uint8_t pos = tto->getPosition(); - uint8_t type = tto->getType(); + uint8_t type = tto->isEXTT(); uint8_t posCount = tto->getPositionCount(); const FSH *todesc = NULL; #ifdef EXRAIL_ACTIVE @@ -1075,22 +1075,29 @@ bool DCCEXParser::parseI(Print *stream, int16_t params, int16_t p[]) return Turntable::printAll(stream); case 1: // broadcast type and current position - return false; + { + Turntable *tto = Turntable::get(p[0]); + if (tto) { + bool type = tto->isEXTT(); + uint8_t position = tto->getPosition(); + StringFormatter::send(stream, F("\n"), type, position); + } else { + return false; + } + } + return true; case 2: // - rotate to position for DCC turntables { + Turntable *tto = Turntable::get(p[0]); if (p[1] == HASH_KEYWORD_DCC) { // Create a DCC turntable - DIAG(F("Create DCC turntable %d"), p[0]); - } else { // Otherwise move a DCC turntable + if (tto) return false; + if (!DCCTurntable::create(p[0])) return false; Turntable *tto = Turntable::get(p[0]); + tto->addPosition(0); + } else { // Otherwise move a DCC turntable if (tto) { - if (tto->getPosition() == p[1]) return true; - uint16_t value = tto->getPositionValue(p[1]); - if (value) { - DIAG(F("Rotate DCC turntable %d to position %d"), p[0], p[1]); - } else { - return false; - } + if (!tto->setPosition(p[0], p[1])) return false; } else { return false; } @@ -1100,34 +1107,24 @@ bool DCCEXParser::parseI(Print *stream, int16_t params, int16_t p[]) case 3: { + Turntable *tto = Turntable::get(p[0]); + if (!tto) return false; if (p[1] == HASH_KEYWORD_ADD) { // add position value to turntable - Turntable *tto = Turntable::get(p[0]); - if (tto) { - tto->addPosition(p[2]); - StringFormatter::send(stream, F("\n")); - } else { - return false; - } + tto->addPosition(p[2]); + StringFormatter::send(stream, F("\n")); } else { // rotate to position for EX-Turntable - Turntable *tto = Turntable::get(p[0]); - if (tto) { - if (!tto->setPosition(p[0], p[1], p[2])) return false; - } else { - return false; - } + if (!tto->setPosition(p[0], p[1], p[2])) return false; } } return true; - case 5: // create an EXTT turntable + case 4: // create an EXTT turntable { if (p[1] == HASH_KEYWORD_EXTT) { if (Turntable::get(p[0])) return false; - if (!EXTTTurntable::create(p[0], (VPIN)p[2], (uint8_t)p[3])) return false; + if (!EXTTTurntable::create(p[0], (VPIN)p[2])) return false; Turntable *tto = Turntable::get(p[0]); - tto->addPosition(p[4]); - } else if (params > 3 && params < 39 && p[1] == HASH_KEYWORD_DCC) { - DIAG(F("Create DCC turntable %d at base address %d with %d positions"), p[0], p[2], params - 2); + tto->addPosition(p[3]); } else { return false; } diff --git a/IODevice.cpp b/IODevice.cpp index 2ed21b6..e811fff 100644 --- a/IODevice.cpp +++ b/IODevice.cpp @@ -176,6 +176,13 @@ bool IODevice::exists(VPIN vpin) { return findDevice(vpin) != NULL; } +// Return the status of the device att vpin. +uint8_t IODevice::getStatus(VPIN vpin) { + IODevice *dev = findDevice(vpin); + if (!dev) return false; + return dev->_deviceState; +} + // check whether the pin supports notification. If so, then regular _read calls are not required. bool IODevice::hasCallback(VPIN vpin) { IODevice *dev = findDevice(vpin); diff --git a/IODevice.h b/IODevice.h index d2c80a4..a03a64d 100644 --- a/IODevice.h +++ b/IODevice.h @@ -154,6 +154,9 @@ public: // exists checks whether there is a device owning the specified vpin static bool exists(VPIN vpin); + // getStatus returns the state of the device at the specified vpin + static uint8_t getStatus(VPIN vpin); + // Enable shared interrupt on specified pin for GPIO extender modules. The extender module // should pull down this pin when requesting a scan. The pin may be shared by multiple modules. // Without the shared interrupt, input states are scanned periodically to detect changes on @@ -405,9 +408,11 @@ private: void _begin() override; void _loop(unsigned long currentMicros) override; int _read(VPIN vpin) override; + void _broadcastStatus (VPIN vpin, uint8_t status); void _writeAnalogue(VPIN vpin, int value, uint8_t activity, uint16_t duration) override; void _display() override; uint8_t _stepperStatus; + uint8_t _previousStatus; }; ///////////////////////////////////////////////////////////////////////////////////////////////////// diff --git a/IO_EXTurntable.cpp b/IO_EXTurntable.cpp index 8c7057b..fc1f9c1 100644 --- a/IO_EXTurntable.cpp +++ b/IO_EXTurntable.cpp @@ -34,6 +34,8 @@ #include "IODevice.h" #include "I2CManager.h" #include "DIAG.h" +#include "Turntables.h" +#include "CommandDistributor.h" void EXTurntable::create(VPIN firstVpin, int nPins, I2CAddress I2CAddress) { new EXTurntable(firstVpin, nPins, I2CAddress); @@ -44,6 +46,8 @@ EXTurntable::EXTurntable(VPIN firstVpin, int nPins, I2CAddress I2CAddress) { _firstVpin = firstVpin; _nPins = nPins; _I2CAddress = I2CAddress; + _stepperStatus = 0; + _previousStatus = 0; addDevice(this); } @@ -80,10 +84,22 @@ int EXTurntable::_read(VPIN vpin) { if (_stepperStatus > 1) { return false; } else { + if (_stepperStatus != _previousStatus) { + _broadcastStatus(vpin, _stepperStatus); + _previousStatus = _stepperStatus; + } return _stepperStatus; } } +// If a status change has occurred for a turntable object, broadcast it +void EXTurntable::_broadcastStatus (VPIN vpin, uint8_t status) { + Turntable *tto = Turntable::getByVpin(vpin); + if (tto) { + CommandDistributor::broadcastTurntable(tto->getId(), tto->getPosition(), status); + } +} + // writeAnalogue to send the steps and activity to Turntable-EX. // Sends 3 bytes containing the MSB and LSB of the step count, and activity. // value contains the steps, bit shifted to MSB + LSB. diff --git a/Turntables.cpp b/Turntables.cpp index a0419b1..3e33d2b 100644 --- a/Turntables.cpp +++ b/Turntables.cpp @@ -57,13 +57,6 @@ void Turntable::add(Turntable *tto) { turntablelistHash++; } -// Find turntable from list -Turntable *Turntable::get(uint16_t id) { - for (Turntable *tto = _firstTurntable; tto != NULL; tto = tto->_nextTurntable) - if (tto->_turntableData.id == id) return tto; - return NULL; -} - // Add a position void Turntable::addPosition(uint16_t value) { _turntablePositions.insert(value); @@ -95,16 +88,39 @@ uint8_t Turntable::getPositionCount() { /* * Public static functions */ +// Find turntable from list +Turntable *Turntable::get(uint16_t id) { + for (Turntable *tto = _firstTurntable; tto != nullptr; tto = tto->_nextTurntable) + if (tto->_turntableData.id == id) return tto; + return NULL; +} + +// Find turntable via Vpin +Turntable *Turntable::getByVpin(VPIN vpin) { + for (Turntable *tto = _firstTurntable; tto != nullptr; tto = tto->_nextTurntable) { + if (tto->isEXTT()) { + EXTTTurntable *exttTto = static_cast(tto); + if (exttTto->getVpin() == vpin) { + return tto; + } + } + } + return nullptr; +} + +// Broadcast position changes bool Turntable::setPositionStateOnly(uint16_t id, uint8_t position, bool moving) { Turntable *tto = get(id); if (!tto) return false; - CommandDistributor::broadcastTurntable(id, position, moving); + // Only need to broadcast from here if it's a DCC type, device driver broadcasts EXTT + if (!tto->isEXTT()) { CommandDistributor::broadcastTurntable(id, position, moving); } #if defined(EXRAIL_ACTIVE) // RMFT2::turntableEvent(id, position); #endif return true; } +// Initiate a turntable move bool Turntable::setPosition(uint16_t id, uint8_t position, uint8_t activity) { #if defined(DIAG_IO) DIAG(F("Turntable(%d, %d)"), id, position); @@ -116,12 +132,12 @@ bool Turntable::setPosition(uint16_t id, uint8_t position, uint8_t activity) { if (ok) { // Broadcast a position change only if non zero has been set, or home/calibration sent if (position > 0 || (position == 0 && (activity == 2 || activity == 3))) { - if (tto->getType() == TURNTABLE_EXTT) { + tto->_turntableData.position = position; + if (tto->isEXTT()) { tto->setPositionStateOnly(id, position, 1); } else { tto->setPositionStateOnly(id, position, 0); } - tto->_turntableData.position = position; } } return ok; @@ -132,38 +148,39 @@ bool Turntable::setPosition(uint16_t id, uint8_t position, uint8_t activity) { * *************************************************************************************/ // Private constructor -EXTTTurntable::EXTTTurntable(uint16_t id, VPIN vpin, uint8_t i2caddress) : +EXTTTurntable::EXTTTurntable(uint16_t id, VPIN vpin) : Turntable(id, TURNTABLE_EXTT) { _exttTurntableData.vpin = vpin; - _exttTurntableData.i2caddress = i2caddress; } +using DevState = IODevice::DeviceStateEnum; + // Create function - Turntable *EXTTTurntable::create(uint16_t id, VPIN vpin, uint8_t i2caddress) { + Turntable *EXTTTurntable::create(uint16_t id, VPIN vpin) { #ifndef IO_NO_HAL Turntable *tto = get(id); if (tto) { if (tto->isType(TURNTABLE_EXTT)) { EXTTTurntable *extt = (EXTTTurntable *)tto; extt->_exttTurntableData.vpin = vpin; - extt->_exttTurntableData.i2caddress = i2caddress; return tto; } } - tto = (Turntable *)new EXTTTurntable(id, vpin, i2caddress); + if (!IODevice::exists(vpin)) return nullptr; + if (IODevice::getStatus(vpin) == DevState::DEVSTATE_FAILED) return nullptr; + tto = (Turntable *)new EXTTTurntable(id, vpin); DIAG(F("Turntable 0x%x size %d size %d"), tto, sizeof(Turntable), sizeof(struct TurntableData)); return tto; #else (void)id; - (void)i2caddress; (void)vpin; return NULL; #endif } void EXTTTurntable::print(Print *stream) { - StringFormatter::send(stream, F("\n"), _turntableData.id, _exttTurntableData.vpin, _exttTurntableData.i2caddress); + StringFormatter::send(stream, F("\n"), _turntableData.id, _exttTurntableData.vpin); } // EX-Turntable specific code for moving to the specified position @@ -185,4 +202,43 @@ EXTTTurntable::EXTTTurntable(uint16_t id, VPIN vpin, uint8_t i2caddress) : return true; } +/************************************************************************************* + * DCCTurntable - DCC Turntable device. + * + *************************************************************************************/ +// Private constructor +DCCTurntable::DCCTurntable(uint16_t id) : Turntable(id, TURNTABLE_DCC) {} + +// Create function + Turntable *DCCTurntable::create(uint16_t id) { +#ifndef IO_NO_HAL + Turntable *tto = get(id); + if (!tto) { + tto = (Turntable *)new DCCTurntable(id); + DIAG(F("Turntable 0x%x size %d size %d"), tto, sizeof(Turntable), sizeof(struct TurntableData)); + } + return tto; +#else + (void)id; + return NULL; +#endif + } + + void DCCTurntable::print(Print *stream) { + StringFormatter::send(stream, F("\n"), _turntableData.id); + } + + // EX-Turntable specific code for moving to the specified position + bool DCCTurntable::setPositionInternal(uint8_t position, uint8_t activity) { +#ifndef IO_NO_HAL + int16_t value = getPositionValue(position); + if (position == 0 || !value) return false; // Return false if it's not a valid position + // Set position via device driver + // DCC activate function here +#else + (void)position; +#endif + return true; + } + #endif diff --git a/Turntables.h b/Turntables.h index d59bc80..e318724 100644 --- a/Turntables.h +++ b/Turntables.h @@ -135,6 +135,7 @@ protected: public: static Turntable *get(uint16_t id); + static Turntable *getByVpin(VPIN vpin); /* * Static data @@ -148,7 +149,7 @@ public: inline bool isHidden() { return _turntableData.hidden; } inline void setHidden(bool h) {_turntableData.hidden=h; } inline bool isType(uint8_t type) { return _turntableData.turntableType == type; } - inline uint8_t getType() { return _turntableData.turntableType; } + inline bool isEXTT() const { return _turntableData.turntableType == TURNTABLE_EXTT; } inline uint16_t getId() { return _turntableData.id; } inline Turntable *next() { return _nextTurntable; } void printState(Print *stream); @@ -193,16 +194,16 @@ private: // EXTTTurntableData contains device specific data struct EXTTTurntableData { VPIN vpin; - uint8_t i2caddress; } _exttTurntableData; // Constructor - EXTTTurntable(uint16_t id, VPIN vpin, uint8_t i2caddress); + EXTTTurntable(uint16_t id, VPIN vpin); public: // Create function - static Turntable *create(uint16_t id, VPIN vpin, uint8_t i2caddress); + static Turntable *create(uint16_t id, VPIN vpin); void print(Print *stream) override; + VPIN getVpin() const { return _exttTurntableData.vpin; } protected: // EX-Turntable specific code for setting position @@ -210,6 +211,26 @@ protected: }; +/************************************************************************************* + * DCCTurntable - DCC accessory Turntable device. + * + *************************************************************************************/ +class DCCTurntable : public Turntable { +private: + // Constructor + DCCTurntable(uint16_t id); + +public: + // Create function + static Turntable *create(uint16_t id); + void print(Print *stream) override; + +protected: + // DCC specific code for setting position + bool setPositionInternal(uint8_t position, uint8_t activity=0) override; + +}; + #endif #endif