Merge 4ad07e01ee into 14724aeb2a

DCC.cpp

@@ -389,25 +389,6 @@ void DCC::writeCVByteMain(int cab, int cv, byte bValue)  {
   DCCWaveform::mainTrack.schedulePacket(b, nB, 4);
 }
 
-//
-// readCVByteMain: Read a byte with PoM on main.
-// This requires Railcom active 
-//
-void DCC::readCVByteMain(int cab, int cv, ACK_CALLBACK callback)  {
-  byte b[5];
-  byte nB = 0;
-  if (cab > HIGHEST_SHORT_ADDR)
-    b[nB++] = highByte(cab) | 0xC0;    // convert train number into a two-byte address
-
-  b[nB++] = lowByte(cab);
-  b[nB++] = cv1(READ_BYTE_MAIN, cv); // any CV>1023 will become modulus(1024) due to bit-mask of 0x03
-  b[nB++] = cv2(cv);
-  b[nB++] = 0;
-
-  DCCWaveform::mainTrack.schedulePacket(b, nB, 4);
-  Railcom::anticipate(cab,cv,callback);
-}
-
 //
 // writeCVBitMain: Write a bit of a byte with PoM on main. This writes
 // the 5 byte sized packet to implement this DCC function
@@ -916,42 +897,6 @@ DCC::LOCO DCC::speedTable[MAX_LOCOS];
 int DCC::lastLocoReminder = 0;
 int DCC::highestUsedReg = 0;
 
-void DCC::setLocoInBlock(int loco, uint16_t blockid, bool exclusive) {
-  // update block loco is in, tell exrail leaving old block, and entering new.
-
-  // NOTE: The loco table scanning is really inefficient and needs rewriting
-  //   This was done once in the momentum poc.  
-  #ifdef EXRAIL_ACTIVE
-  int reg=lookupSpeedTable(loco,true);
-  if (reg<0) return;
-  auto oldBlock=speedTable[reg].blockOccupied; 
-  if (oldBlock==blockid) return; 
-  if (oldBlock) RMFT2::blockEvent(oldBlock,loco,false);
-  speedTable[reg].blockOccupied=blockid;
-  if (blockid) RMFT2::blockEvent(blockid,loco,true);
-
-  if (exclusive) {
-    for (int reg = 0; reg <= highestUsedReg; reg++) {
-       if (speedTable[reg].loco!=loco &&  speedTable[reg].blockOccupied==blockid) {
-        RMFT2::blockEvent(blockid,speedTable[reg].loco,false);
-        speedTable[reg].blockOccupied=0;
-      }
-  }
-  }
-  #endif 
-}
-
-void DCC::clearBlock(uint16_t blockid) {
-  // Railcom reports block empty... tell Exrail about all leavers 
-  #ifdef EXRAIL_ACTIVE
-  for (int reg = 0; reg <= highestUsedReg; reg++) {
-       if (speedTable[reg].blockOccupied==blockid) {
-        RMFT2::blockEvent(blockid,speedTable[reg].loco,false);
-        speedTable[reg].blockOccupied=0;
-      }
-  }
-  #endif 
-}
 
 void DCC::displayCabList(Print * stream) {
 
@@ -959,9 +904,8 @@ void DCC::displayCabList(Print * stream) {
     for (int reg = 0; reg <= highestUsedReg; reg++) {
        if (speedTable[reg].loco>0) {
         used ++;
-        StringFormatter::send(stream,F("cab=%d, speed=%d, dir=%c blk=%d\n"),
-           speedTable[reg].loco,  speedTable[reg].speedCode & 0x7f,(speedTable[reg].speedCode & 0x80) ? 'F':'R',
-           speedTable[reg].blockOccupied);
+        StringFormatter::send(stream,F("cab=%d, speed=%d, dir=%c \n"),
+           speedTable[reg].loco,  speedTable[reg].speedCode & 0x7f,(speedTable[reg].speedCode & 0x80) ? 'F':'R');
        }
      }
      StringFormatter::send(stream,F("Used=%d, max=%d\n"),used,MAX_LOCOS);

DCC.h

@@ -64,8 +64,6 @@ public:
   static uint8_t getThrottleFrequency(int cab);
   static bool getThrottleDirection(int cab);
   static void writeCVByteMain(int cab, int cv, byte bValue);
-  static void readCVByteMain(int cab, int cv, ACK_CALLBACK callback);
-  
   static void writeCVBitMain(int cab, int cv, byte bNum, bool bValue);
   static void setFunction(int cab, byte fByte, byte eByte);
   static bool setFn(int cab, int16_t functionNumber, bool on);
@@ -104,14 +102,12 @@ public:
     byte speedCode;
     byte groupFlags;
     uint32_t functions;
-    uint16_t blockOccupied; // railcom detected block 
   };
  static LOCO speedTable[MAX_LOCOS];
  static int lookupSpeedTable(int locoId, bool autoCreate=true);
  static byte cv1(byte opcode, int cv);
  static byte cv2(int cv);
- static void setLocoInBlock(int locoid, uint16_t blockid, bool exclusive);
- static void clearBlock(uint16_t blockid);
+ 
 private:
   static byte loopStatus;
   static void setThrottle2(uint16_t cab, uint8_t speedCode);
@@ -130,7 +126,6 @@ private:
   // NMRA codes #
   static const byte SET_SPEED = 0x3f;
   static const byte WRITE_BYTE_MAIN = 0xEC;
-  static const byte READ_BYTE_MAIN = 0xE4;
   static const byte WRITE_BIT_MAIN = 0xE8;
   static const byte WRITE_BYTE = 0x7C;
   static const byte VERIFY_BYTE = 0x74;

DCCEXParser.cpp

@@ -78,8 +78,8 @@ Once a new OPCODE is decided upon, update this list.
   P, Write DCC packet
   q, Sensor deactivated
   Q, Sensor activated
-  r, Read cv on main (Railcom)
-  R, Read CVs response r
+  r, Broadcast address read on programming track
+  R, Read CVs
   s, Display status
   S, Sensor configuration
   t, Cab/loco update command
@@ -482,16 +482,6 @@ void DCCEXParser::parseOne(Print *stream, byte *com, RingStream * ringStream)
       DCC::writeCVByteMain(p[0], p[1], p[2]);
       return;
 
-#ifdef HAS_ENOUGH_MEMORY    
-    case 'r': // READ CV on MAIN <r CAB CV>  Requires Railcom
-      if (params != 2)
-	break;
-      if (!DCCWaveform::isRailcom()) break;
-      if (!stashCallback(stream, p, ringStream)) break;
-      DCC::readCVByteMain(p[0], p[1],callback_r);
-      return;
-#endif      
-
     case 'b': // WRITE CV BIT ON MAIN <b CAB CV BIT VALUE>
       if (params != 4)
 	break;
@@ -1136,7 +1126,7 @@ bool DCCEXParser::parseC(Print *stream, int16_t params, int16_t p[]) {
         DCC::setGlobalSpeedsteps(128);
 	DIAG(F("128 Speedsteps"));
         return true;
-#if defined(HAS_ENOUGH_MEMORY) 
+#if defined(HAS_ENOUGH_MEMORY) && !defined(ARDUINO_ARCH_UNO)
     case "RAILCOM"_hk:
         {   // <C RAILCOM ON|OFF|DEBUG >
             if (params<2) return false;
@@ -1221,10 +1211,6 @@ bool DCCEXParser::parseD(Print *stream, int16_t params, int16_t p[])
         return true;
 
 #ifdef HAS_ENOUGH_MEMORY
-    case "RAILCOM"_hk: // <D RAILCOM ON/OFF>
-        Diag::RAILCOM = onOff;
-        return true;
-
     case "WIFI"_hk: // <D WIFI ON/OFF>
         Diag::WIFI = onOff;
         return true;
@@ -1432,12 +1418,6 @@ void DCCEXParser::callback_R(int16_t result)
     commitAsyncReplyStream();
 }
 
-void DCCEXParser::callback_r(int16_t result)
-{
-    StringFormatter::send(getAsyncReplyStream(), F("<r %d %d %d >\n"), stashP[0], stashP[1], result);
-    commitAsyncReplyStream();
-}
-
 void DCCEXParser::callback_Rloco(int16_t result) {
   const FSH * detail;
   if (result<=0) {

DCCEXParser.h

@@ -68,8 +68,7 @@ struct DCCEXParser
     static void callback_W(int16_t result);
     static void callback_W4(int16_t result);
     static void callback_B(int16_t result);        
-    static void callback_R(int16_t result); // prog
-    static void callback_r(int16_t result); // main
+    static void callback_R(int16_t result);
     static void callback_Rloco(int16_t result);
     static void callback_Wloco(int16_t result);
     static void callback_Wconsist(int16_t result);

DCCRMT.cpp

@@ -103,7 +103,7 @@ void IRAM_ATTR interrupt(rmt_channel_t channel, void *t) {
     DCCTimer::updateMinimumFreeMemoryISR(0);
 }
 
-RMTChannel::RMTChannel(Pinpair pins, bool isMain) {
+RMTChannel::RMTChannel(pinpair pins, bool isMain) {
   byte ch;
   byte plen;
 
@@ -272,7 +272,7 @@ bool RMTChannel::addPin(byte pin, bool inverted) {
   if (err != ESP_OK) return false;
   return true;
 }
-bool RMTChannel::addPin(Pinpair pins) {
+bool RMTChannel::addPin(pinpair pins) {
   return addPin(pins.pin) && addPin(pins.invpin, true);
 }
 #endif //ESP32

DCCRMT.h

@@ -23,7 +23,7 @@
 #include "driver/rmt.h"
 #include "soc/rmt_reg.h"
 #include "soc/rmt_struct.h"
-#include "Pinpair.h" // for class Pinpair
+#include "MotorDriver.h" // for class pinpair
 
 // make calculations easy and set up for microseconds
 #define RMT_CLOCK_DIVIDER 80
@@ -32,9 +32,9 @@
 
 class RMTChannel {
  public:
-  RMTChannel(Pinpair pins, bool isMain);
+  RMTChannel(pinpair pins, bool isMain);
   bool addPin(byte pin, bool inverted=0);
-  bool addPin(Pinpair pins);
+  bool addPin(pinpair pins);
   void IRAM_ATTR RMTinterrupt();
   void RMTprefill();
   //int RMTfillData(dccPacket packet);

DCCTimerAVR.cpp

@@ -57,59 +57,66 @@ void DCCTimer::begin(INTERRUPT_CALLBACK callback) {
     TCCR1B = _BV(WGM13) | _BV(CS10);     // Mode 8, clock select 1
     TIMSK1 = _BV(TOIE1); // Enable Software interrupt
     interrupts();
-//diagnostic    pinMode(4,OUTPUT);
   }
 
 
 void DCCTimer::startRailcomTimer(byte brakePin) {
-  (void) brakePin; // Ignored... works on pin 9 only 
-  // diagnostic digitalWrite(4,HIGH);   
-
   /* The Railcom timer is started in such a way that it 
-     - First triggers 58+29 uS after the previous TIMER1 tick. 
+     - First triggers 28uS after the last TIMER1 tick. 
        This provides an accurate offset (in High Accuracy mode)
        for the start of the Railcom cutout.
-     - Sets the Railcom pin high at first tick and subsequent ticks 
-       until its reset to setting pin 9 low at next tick.
+     - Sets the Railcom pin high at first tick, 
+       because its been setup with 100% PWM duty cycle.
         
      - Cycles at 436uS so the second tick is the 
         correct distance from the cutout.
         
-     - Waveform code is responsible for resetting 
-       any time between the first and second tick.
+     - Waveform code is responsible for altering the PWM 
+       duty cycle to 0% any time between the first and last tick.
        (there will be 7 DCC timer1 ticks in which to do this.)
     
     */
+  (void) brakePin; // Ignored... works on pin 9 only 
   const int cutoutDuration = 430; // Desired interval in microseconds
-  const int cycle=cutoutDuration/2;
   
-  const byte RailcomFudge0=58+58+29;
+  // Set up Timer2 for CTC mode (Clear Timer on Compare Match)
+  TCCR2A = 0; // Clear Timer2 control register A
+  TCCR2B = 0; // Clear Timer2 control register B
+  TCNT2 = 0;  // Initialize Timer2 counter value to 0
+   // Configure Phase and Frequency Correct PWM mode
+   TCCR2A =  (1 << COM2B1); // enable pwm on pin 9
+   TCCR2A |= (1 << WGM20);
+  
+   
+  // Set Timer 2 prescaler to 32
+  TCCR2B = (1 << CS21) | (1 << CS20); // 32 prescaler
+
+  // Set the compare match value for desired interval
+  OCR2A = (F_CPU / 1000000) * cutoutDuration / 64 - 1;
+
+  // Calculate the compare match value for desired duty cycle
+  OCR2B = OCR2A+1;  // set duty cycle to 100%= OCR2A)
 
-  // Set Timer2 to CTC mode with set on compare match
-  TCCR2A = (1 << WGM21) | (1 << COM2B0) | (1 << COM2B1);
-  // Prescaler of 32
-  TCCR2B =  (1 << CS21) | (1 << CS20); 
-  OCR2A = cycle-1; // Compare match value for 430 uS
   // Enable Timer2 output on pin 9 (OC2B)
   DDRB |= (1 << DDB1);
-
-  // RailcomFudge2 is the expected time from idealised 
-  // setup call (at previous DCC timer interrupt) to the cutout. 
-  // This value should be reduced to reflect the Timer1 value
-  // measuring the time since the previous hardware interrupt
-  byte tcfudge=TCNT1/16; 
-  TCNT2=cycle-RailcomFudge0/2+tcfudge/2;
-
+  // TODO Fudge TCNT2 to sync with last tcnt1 tick + 28uS
 
  // Previous TIMER1 Tick was at rising end-of-packet bit
  // Cutout starts half way through first preamble
  // that is 2.5 * 58uS later.
+ // TCNT1 ticks 8 times / microsecond
+ // auto microsendsToFirstRailcomTick=(58+58+29)-(TCNT1/8);
+  // set the railcom timer counter allowing for phase-correct
+
+  // CHris's NOTE: 
+  // I dont kniow quite how this calculation works out but
+  // it does seems to get a good answer. 
+
+  TCNT2=193 + (ICR1 - TCNT1)/8;
 }
 
 void DCCTimer::ackRailcomTimer() {
-  // Change Timer2 to CTC mode with RESET pin 9 on next compare match
-  TCCR2A = (1 << WGM21) | (1 << COM2B1);
-  // diagnostic digitalWrite(4,LOW);
+  OCR2B= 0x00;  // brake pin pwm duty cycle 0 at next tick
 }
 
 

DCCWaveform.cpp

@@ -24,13 +24,14 @@
 #ifndef ARDUINO_ARCH_ESP32
   // This code is replaced entirely on an ESP32
 #include <Arduino.h>
+
 #include "DCCWaveform.h"
 #include "TrackManager.h"
 #include "DCCTimer.h"
 #include "DCCACK.h"
 #include "DIAG.h"
 
-bool DCCWaveform::cutoutNextTime=false;
+
 DCCWaveform  DCCWaveform::mainTrack(PREAMBLE_BITS_MAIN, true);
 DCCWaveform  DCCWaveform::progTrack(PREAMBLE_BITS_PROG, false);
 
@@ -70,18 +71,9 @@ void DCCWaveform::loop() {
 
 #pragma GCC push_options
 #pragma GCC optimize ("-O3")
-
 void DCCWaveform::interruptHandler() {
   // call the timer edge sensitive actions for progtrack and maintrack
   // member functions would be cleaner but have more overhead
-  #if defined(HAS_ENOUGH_MEMORY)
-  if (cutoutNextTime) {
-    cutoutNextTime=false;
-    railcomSampleWindow=false; // about to cutout, stop reading railcom data.
-    railcomCutoutCounter++;
-    DCCTimer::startRailcomTimer(9);
-  }
-  #endif
   byte sigMain=signalTransform[mainTrack.state];
   byte sigProg=TrackManager::progTrackSyncMain? sigMain : signalTransform[progTrack.state];
   
@@ -124,23 +116,18 @@ DCCWaveform::DCCWaveform( byte preambleBits, bool isMain) {
   bits_sent = 0;
 }
     
-bool DCCWaveform::railcomPossible=false;     // High accuracy only    
 volatile bool DCCWaveform::railcomActive=false;     // switched on by user
 volatile bool DCCWaveform::railcomDebug=false;     // switched on by user
-volatile bool DCCWaveform::railcomSampleWindow=false; // true during packet transmit
-volatile byte DCCWaveform::railcomCutoutCounter=0;    // cyclic cutout
-volatile byte DCCWaveform::railcomLastAddressHigh=0;
-volatile byte DCCWaveform::railcomLastAddressLow=0;
 
 bool DCCWaveform::setRailcom(bool on, bool debug) {
-  if (on && railcomPossible) {
+  if (on) {
+    // TODO check possible
     railcomActive=true;
     railcomDebug=debug;
   }
   else {
     railcomActive=false;
     railcomDebug=false;
-    railcomSampleWindow=false;
   } 
   return railcomActive;
 }
@@ -153,37 +140,14 @@ void DCCWaveform::interrupt2() {
   //        or WAVE_HIGH_0 for a 0 bit.
   if (remainingPreambles > 0 ) {
     state=WAVE_MID_1;  // switch state to trigger LOW on next interrupt
-    
     remainingPreambles--;
   
     // As we get to the end of the preambles, open the reminder window.
     // This delays any reminder insertion until the last moment so
     // that the reminder doesn't block a more urgent packet. 
-    reminderWindowOpen=transmitRepeats==0 && remainingPreambles<10 && remainingPreambles>1;
-    if (remainingPreambles==1)
-      promotePendingPacket();
-
-#if defined(HAS_ENOUGH_MEMORY)   
-    else if (isMainTrack && railcomActive) {
-      if (remainingPreambles==(requiredPreambles-1)) {
-        // First look if we need to start a railcom cutout on next interrupt
-        cutoutNextTime= true;
-      } else if (remainingPreambles==(requiredPreambles-12)) {
-        // cutout has ended so its now possible to poll the railcom detectors
-        // requiredPreambles is one higher that preamble length so
-        // if preamble length is 16 then this evaluates to 5
-        // Remember address bytes of last sent packet so that Railcom can
-        // work out where the channel2 data came from.
-        railcomLastAddressHigh=transmitPacket[0];
-        railcomLastAddressLow =transmitPacket[1];
-        railcomSampleWindow=true;
-      } else if (remainingPreambles==(requiredPreambles-3)) {
-        // cutout can be ended when read
-        // see above for requiredPreambles
-        DCCTimer::ackRailcomTimer();
-      }
-    }
-#endif    
+    reminderWindowOpen=transmitRepeats==0 && remainingPreambles<4 && remainingPreambles>1;
+    if (remainingPreambles==1) promotePendingPacket();
+    else if (remainingPreambles==10 && isMainTrack && railcomActive) DCCTimer::ackRailcomTimer();
     // Update free memory diagnostic as we don't have anything else to do this time.
     // Allow for checkAck and its called functions using 22 bytes more.
     else DCCTimer::updateMinimumFreeMemoryISR(22); 
@@ -207,6 +171,12 @@ void DCCWaveform::interrupt2() {
       bytes_sent = 0;
       // preamble for next packet will start...
       remainingPreambles = requiredPreambles;
+      
+      // set the railcom coundown to trigger half way 
+      // through the first preamble bit.
+      // Note.. we are still sending the last packet bit
+      //    and we then have to allow for the packet end bit
+      if (isMainTrack && railcomActive) DCCTimer::startRailcomTimer(9);
       }
   }  
 }
@@ -260,41 +230,31 @@ void DCCWaveform::promotePendingPacket() {
       // Fortunately reset and idle packets are the same length
       // Note: If railcomDebug is on, then we send resets to the main
       //       track instead of idles. This means that all data will be zeros
-      //       and only the presets will be ones, making it much
+      //       and only the porersets will be ones, making it much
       //       easier to read on a logic analyser.
       memcpy( transmitPacket, (isMainTrack && (!railcomDebug)) ? idlePacket : resetPacket, sizeof(idlePacket));
       transmitLength = sizeof(idlePacket);
       transmitRepeats = 0;
       if (getResets() < 250) sentResetsSincePacket++; // only place to increment (private!)
 }
-#endif //not ARDUINO_ARCH_ESP32
+#endif
 
 #ifdef ARDUINO_ARCH_ESP32
 #include "DCCWaveform.h"
-#include "TrackManager.h"
 #include "DCCACK.h"
-#include "Pinpair.h"
 
 DCCWaveform  DCCWaveform::mainTrack(PREAMBLE_BITS_MAIN, true);
 DCCWaveform  DCCWaveform::progTrack(PREAMBLE_BITS_PROG, false);
 RMTChannel *DCCWaveform::rmtMainChannel = NULL;
 RMTChannel *DCCWaveform::rmtProgChannel = NULL;
 
-bool DCCWaveform::railcomPossible=false;     // High accuracy only    
-volatile bool DCCWaveform::railcomActive=false;     // switched on by user
-volatile bool DCCWaveform::railcomDebug=false;     // switched on by user
-volatile bool DCCWaveform::railcomSampleWindow=false; // true during packet transmit
-volatile byte DCCWaveform::railcomCutoutCounter=0;    // cyclic cutout
-volatile byte DCCWaveform::railcomLastAddressHigh=0;
-volatile byte DCCWaveform::railcomLastAddressLow=0;
-
 DCCWaveform::DCCWaveform(byte preambleBits, bool isMain) {
   isMainTrack = isMain;
   requiredPreambles = preambleBits;
 }
 void DCCWaveform::begin() {
   for(const auto& md: TrackManager::getMainDrivers()) {
-    Pinpair p = md->getSignalPin();
+    pinpair p = md->getSignalPin();
     if(rmtMainChannel) {
       //DIAG(F("added pins %d %d to MAIN channel"), p.pin, p.invpin);
       rmtMainChannel->addPin(p); // add pin to existing main channel
@@ -305,7 +265,7 @@ void DCCWaveform::begin() {
   }
   MotorDriver *md = TrackManager::getProgDriver();
   if (md) {
-    Pinpair p = md->getSignalPin();
+    pinpair p = md->getSignalPin();
     if (rmtProgChannel) {
       //DIAG(F("added pins %d %d to PROG channel"), p.pin, p.invpin);
       rmtProgChannel->addPin(p); // add pin to existing prog channel
@@ -363,9 +323,7 @@ void IRAM_ATTR DCCWaveform::loop() {
 }
 
 bool DCCWaveform::setRailcom(bool on, bool debug) {
-  // todo
-  (void)on;
-  (void)debug;
+  // TODO... ESP32 railcom waveform
   return false;
 }
 

DCCWaveform.h

@@ -23,9 +23,11 @@
  */
 #ifndef DCCWaveform_h
 #define DCCWaveform_h
+
+#include "MotorDriver.h"
 #ifdef ARDUINO_ARCH_ESP32
 #include "DCCRMT.h"
-//#include "TrackManager.h"
+#include "TrackManager.h"
 #endif
 
 
@@ -84,29 +86,7 @@ class DCCWaveform {
     bool isReminderWindowOpen();
     void promotePendingPacket();
     static bool setRailcom(bool on, bool debug);
-    inline static bool isRailcom() {
-      return railcomActive;
-    };
-    inline static byte getRailcomCutoutCounter() {
-      return railcomCutoutCounter;
-    };
-    inline static bool isRailcomSampleWindow() {
-      return railcomSampleWindow;
-    };
-    inline static bool isRailcomPossible() {
-      return railcomPossible;
-    };
-    inline static void setRailcomPossible(bool yes) {
-      railcomPossible=yes;
-      if (!yes) setRailcom(false,false);
-    };
-    inline static uint16_t getRailcomLastLocoAddress() {
-      // first 2 bits 00=short loco, 11=long loco , 01/10 = accessory
-      byte addressType=railcomLastAddressHigh & 0xC0;
-      if (addressType==0xC0) return ((railcomLastAddressHigh & 0x3f)<<8) | railcomLastAddressLow;
-      if (addressType==0x00) return railcomLastAddressHigh & 0x3F;
-      return 0; 
-    }
+    static bool isRailcom() {return railcomActive;}
     
   private:
 #ifndef ARDUINO_ARCH_ESP32
@@ -132,13 +112,9 @@ class DCCWaveform {
     byte pendingPacket[MAX_PACKET_SIZE+1]; // +1 for checksum
     byte pendingLength;
     byte pendingRepeats;
-    static bool railcomPossible; // High accuracy mode only
     static volatile bool railcomActive;     // switched on by user
     static volatile bool railcomDebug;     // switched on by user
-    static volatile bool railcomSampleWindow; // when safe to sample
-    static volatile byte railcomCutoutCounter; // incremented for each cutout
-    static volatile byte railcomLastAddressHigh,railcomLastAddressLow;
-    static bool cutoutNextTime;   // railcom
+    
 #ifdef ARDUINO_ARCH_ESP32
   static RMTChannel *rmtMainChannel;
   static RMTChannel *rmtProgChannel;

EXRAIL2.cpp

@@ -87,8 +87,6 @@ LookList *  RMFT2::onClockLookup=NULL;
 LookList *  RMFT2::onRotateLookup=NULL;
 #endif
 LookList *  RMFT2::onOverloadLookup=NULL;
-LookList *  RMFT2::onBlockEnterLookup=NULL;
-LookList *  RMFT2::onBlockExitLookup=NULL;
 byte * RMFT2::routeStateArray=nullptr; 
 const FSH  * * RMFT2::routeCaptionArray=nullptr; 
 int16_t * RMFT2::stashArray=nullptr;
@@ -133,11 +131,11 @@ int16_t LookList::find(int16_t value) {
 void LookList::chain(LookList * chain) {
   m_chain=chain;
 }
-void LookList::handleEvent(const FSH* reason,int16_t id, int16_t loco) {
+void LookList::handleEvent(const FSH* reason,int16_t id) {
   // New feature... create multiple ONhandlers
   for (int i=0;i<m_size;i++) 
     if (m_lookupArray[i]==id)
-       RMFT2::startNonRecursiveTask(reason,id,m_resultArray[i],loco);
+       RMFT2::startNonRecursiveTask(reason,id,m_resultArray[i]);
 }
 
 
@@ -205,12 +203,6 @@ LookList* RMFT2::LookListLoader(OPCODE op1, OPCODE op2, OPCODE op3) {
   onRotateLookup=LookListLoader(OPCODE_ONROTATE);
 #endif
   onOverloadLookup=LookListLoader(OPCODE_ONOVERLOAD);
-
-  if (compileFeatures & FEATURE_BLOCK) {
-    onBlockEnterLookup=LookListLoader(OPCODE_ONBLOCKENTER);
-    onBlockExitLookup=LookListLoader(OPCODE_ONBLOCKEXIT);
-  }
-
   // onLCCLookup is not the same so not loaded here. 
 
   // Second pass startup, define any turnouts or servos, set signals red
@@ -387,7 +379,7 @@ char RMFT2::getRouteType(int16_t id) {
 }
 
 
-RMFT2::RMFT2(int progCtr, int16_t _loco) {
+RMFT2::RMFT2(int progCtr) {
   progCounter=progCtr;
 
   // get an unused  task id from the flags table
@@ -400,7 +392,9 @@ RMFT2::RMFT2(int progCtr, int16_t _loco) {
     }
   }
   delayTime=0;
-  loco=_loco;
+  loco=0;
+  speedo=0;
+  forward=true;
   invert=false;
   blinkState=not_blink_task;
   stackDepth=0;
@@ -418,10 +412,7 @@ RMFT2::RMFT2(int progCtr, int16_t _loco) {
 
 
 RMFT2::~RMFT2() {
-  // estop my loco if this is not an ONevent 
-  // (prevents DONE stopping loco at the end of an
-  //   ONBLOCKENTER or ONBLOCKEXIT )
-  if (loco>0 && this->onEventStartPosition==-1) DCC::setThrottle(loco,1,DCC::getThrottleDirection(loco));
+  driveLoco(1); // ESTOP my loco if any
   setFlag(taskId,0,TASK_FLAG); // we are no longer using this id
   if (next==this)
     loopTask=NULL;
@@ -437,9 +428,23 @@ RMFT2::~RMFT2() {
 void RMFT2::createNewTask(int route, uint16_t cab) {
       int pc=routeLookup->find(route);
       if (pc<0) return;
-      new RMFT2(pc,cab);
+      RMFT2* task=new RMFT2(pc);
+      task->loco=cab;
 }
 
+void RMFT2::driveLoco(byte speed) {
+  if (loco<=0) return;  // Prevent broadcast!
+  //if (diag) DIAG(F("EXRAIL drive %d %d %d"),loco,speed,forward^invert);
+ /* TODO.....
+ power on appropriate track if DC or main if dcc
+  if (TrackManager::getMainPowerMode()==POWERMODE::OFF) {
+    TrackManager::setMainPower(POWERMODE::ON);
+  }
+  **********/
+
+  DCC::setThrottle(loco,speed, forward^invert);
+  speedo=speed;
+}
 
 bool RMFT2::readSensor(uint16_t sensorId) {
   // Exrail operands are unsigned but we need the signed version as inserted by the macros.
@@ -494,7 +499,7 @@ bool RMFT2::skipIfBlock() {
   if (cv & LONG_ADDR_MARKER) {               // maker bit indicates long addr
     progtrackLocoId = cv ^ LONG_ADDR_MARKER; // remove marker bit to get real long addr
     if (progtrackLocoId <= HIGHEST_SHORT_ADDR ) {     // out of range for long addr
-      DIAG(F("Long addr %d <= %d unsupported\n"), progtrackLocoId, HIGHEST_SHORT_ADDR);
+      DIAG(F("Long addr %d <= %d unsupported"), progtrackLocoId, HIGHEST_SHORT_ADDR);
       progtrackLocoId = -1;
     }
   } else {
@@ -502,15 +507,6 @@ bool RMFT2::skipIfBlock() {
   }
 }
 
-void RMFT2::pause() {
-  if (loco)
-    pauseSpeed=DCC::getThrottleSpeedByte(loco);
-}
-void RMFT2::resume() {
-  if (loco)
-    DCC::setThrottle(loco,pauseSpeed & 0x7f, pauseSpeed & 0x80);
-}
-
 void RMFT2::loop() {
   if (compileFeatures & FEATURE_SENSOR) 
       EXRAILSensor::checkAll();
@@ -575,19 +571,18 @@ void RMFT2::loop2() {
 #endif
 
   case OPCODE_REV:
-    if (loco) DCC::setThrottle(loco,operand,invert);
+    forward = false;
+    driveLoco(operand);
     break;
     
   case OPCODE_FWD:
-    if (loco) DCC::setThrottle(loco,operand,!invert);
+      forward = true;
+      driveLoco(operand);
       break;
       
   case OPCODE_SPEED:
-    if (loco) DCC::setThrottle(loco,operand,DCC::getThrottleDirection(loco));
-    break;
-  
-  case OPCODE_ESTOPALL:
-    DCC::setThrottle(0,1,1); // all locos speed=1
+    forward=DCC::getThrottleDirection(loco)^invert;
+    driveLoco(operand);
     break;
     
   case OPCODE_FORGET:
@@ -599,11 +594,12 @@ void RMFT2::loop2() {
 
   case OPCODE_INVERT_DIRECTION:
     invert= !invert;
+    driveLoco(speedo);
     break;
     
   case OPCODE_RESERVE:
     if (getFlag(operand,SECTION_FLAG)) {
-      if (loco) DCC::setThrottle(loco,0,DCC::getThrottleDirection(loco));
+      driveLoco(0);
       delayMe(500);
       return;
     }
@@ -702,10 +698,6 @@ void RMFT2::loop2() {
      break; 
 
   case OPCODE_PAUSE:
-    // all tasks save their speed bytes
-    pause();
-    for (RMFT2 * t=next; t!=this;t=t->next) t->pause();
-    
     DCC::setThrottle(0,1,true);  // pause all locos on the track
     pausingTask=this;
     break;
@@ -714,10 +706,6 @@ void RMFT2::loop2() {
     if (loco) DCC::writeCVByteMain(loco, operand, getOperand(1));
     break;
 
-  case OPCODE_XPOM:
-    DCC::writeCVByteMain(operand, getOperand(1), getOperand(2));
-    break;
-
   case OPCODE_POWEROFF:
     TrackManager::setPower(POWERMODE::OFF);
     TrackManager::setJoin(false);
@@ -754,8 +742,8 @@ void RMFT2::loop2() {
 
   case OPCODE_RESUME:
     pausingTask=NULL;
-    resume();
-    for (RMFT2 * t=next; t!=this;t=t->next) t->resume();
+    driveLoco(speedo);
+    for (RMFT2 * t=next; t!=this;t=t->next) if (t->loco >0) t->driveLoco(t->speedo);
     break;
     
   case OPCODE_IF: // do next operand if sensor set
@@ -866,7 +854,8 @@ void RMFT2::loop2() {
     
   case OPCODE_DRIVE:
     {
-      // Non functional but reserved 
+      byte analogSpeed=IODevice::readAnalogue(operand) *127 / 1024;
+      if (speedo!=analogSpeed) driveLoco(analogSpeed);
       break;
     }
     
@@ -956,6 +945,8 @@ void RMFT2::loop2() {
     // which is intended so it can be checked
     // from within EXRAIL
     loco=progtrackLocoId;
+    speedo=0;
+    forward=true;
     invert=false;
     break;
 #endif
@@ -977,13 +968,16 @@ void RMFT2::loop2() {
     {
       int newPc=routeLookup->find(getOperand(1));
       if (newPc<0) break;
-      new RMFT2(newPc,operand); // create new task
+      RMFT2* newtask=new RMFT2(newPc); // create new task
+      newtask->loco=operand;
     }
     break;
     
   case OPCODE_SETLOCO:
     {
       loco=operand;
+      speedo=0;
+      forward=true;
       invert=false;
     }
     break;
@@ -1117,8 +1111,7 @@ void RMFT2::loop2() {
   case OPCODE_ONROTATE:
 #endif
   case OPCODE_ONOVERLOAD:
-  case OPCODE_ONBLOCKENTER:
-  case OPCODE_ONBLOCKEXIT:
+  
     break;
     
   default:
@@ -1310,14 +1303,6 @@ void RMFT2::activateEvent(int16_t addr, bool activate) {
   else onDeactivateLookup->handleEvent(F("DEACTIVATE"),addr);
 }
 
-void RMFT2::blockEvent(int16_t block, int16_t loco, bool entering) {
-  if (compileFeatures & FEATURE_BLOCK) {
-  // Hunt for an ONBLOCKENTER/ONBLOCKEXIT for this accessory
-  if (entering)  onBlockEnterLookup->handleEvent(F("BLOCKENTER"),block,loco);
-  else onBlockExitLookup->handleEvent(F("BLOCKEXIT"),block,loco);
-  }
-}
-
 void RMFT2::changeEvent(int16_t vpin, bool change) {
   // Hunt for an ONCHANGE for this sensor
   if (change)  onChangeLookup->handleEvent(F("CHANGE"),vpin);
@@ -1373,11 +1358,11 @@ void RMFT2::killBlinkOnVpin(VPIN pin, uint16_t count) {
   }
 }
   
-void RMFT2::startNonRecursiveTask(const FSH* reason, int16_t id,int pc, uint16_t loco) {  
+void RMFT2::startNonRecursiveTask(const FSH* reason, int16_t id,int pc) {  
   // Check we dont already have a task running this handler
   RMFT2 * task=loopTask;
   while(task) {
-    if (task->onEventStartPosition==pc && task->loco==loco) {
+    if (task->onEventStartPosition==pc) {
       DIAG(F("Recursive ON%S(%d)"),reason, id);
       return;
     }
@@ -1385,7 +1370,7 @@ void RMFT2::startNonRecursiveTask(const FSH* reason, int16_t id,int pc, uint16_t
     if (task==loopTask) break;
   }
   
-  task=new RMFT2(pc,loco);  // new task starts at this instruction
+  task=new RMFT2(pc);  // new task starts at this instruction
   task->onEventStartPosition=pc; // flag for recursion detector
 }
 

EXRAIL2.h

@@ -77,8 +77,6 @@ enum OPCODE : byte {OPCODE_THROW,OPCODE_CLOSE,OPCODE_TOGGLE_TURNOUT,
              OPCODE_STASH,OPCODE_CLEAR_STASH,OPCODE_CLEAR_ALL_STASH,OPCODE_PICKUP_STASH,
              OPCODE_ONBUTTON,OPCODE_ONSENSOR,             
              OPCODE_NEOPIXEL,
-             OPCODE_ONBLOCKENTER,OPCODE_ONBLOCKEXIT,
-             OPCODE_ESTOPALL,OPCODE_XPOM,
              // OPcodes below this point are skip-nesting IF operations
              // placed here so that they may be skipped as a group
              // see skipIfBlock()
@@ -138,7 +136,6 @@ enum SignalType {
   static const byte FEATURE_STASH = 0x08;
   static const byte FEATURE_BLINK = 0x04;
   static const byte FEATURE_SENSOR = 0x02;
-  static const byte FEATURE_BLOCK = 0x01;
   
  
   // Flag bits for status of hardware and TPL
@@ -165,7 +162,7 @@ class LookList {
     int16_t findPosition(int16_t value); // finds index 
     int16_t size();
     void stream(Print * _stream); 
-    void handleEvent(const FSH* reason,int16_t id, int16_t loco=0);
+    void handleEvent(const FSH* reason,int16_t id);
 
   private:
      int16_t m_size;
@@ -179,7 +176,8 @@ class LookList {
    public:
     static void begin();
     static void loop();
-    RMFT2(int progCounter, int16_t cab=0);
+    RMFT2(int progCounter);
+    RMFT2(int route, uint16_t cab);
     ~RMFT2();
     static void readLocoCallback(int16_t cv);
     static void createNewTask(int route, uint16_t cab);
@@ -189,7 +187,6 @@ class LookList {
     static void clockEvent(int16_t clocktime, bool change);
     static void rotateEvent(int16_t id, bool change);
     static void powerEvent(int16_t track, bool overload);
-    static void blockEvent(int16_t block, int16_t loco, bool entering);
     static bool signalAspectEvent(int16_t address, byte aspect );    
     // Throttle Info Access functions built by exrail macros 
   static const byte rosterNameCount;
@@ -203,7 +200,7 @@ class LookList {
   static const FSH *  getRosterFunctions(int16_t id);
   static const FSH *  getTurntableDescription(int16_t id);
   static const FSH *  getTurntablePositionDescription(int16_t turntableId, uint8_t positionId);
-  static void startNonRecursiveTask(const FSH* reason, int16_t id,int pc, uint16_t loco=0);
+  static void startNonRecursiveTask(const FSH* reason, int16_t id,int pc);
   static bool readSensor(uint16_t sensorId);
   static bool isSignal(int16_t id,char rag);
   static SIGNAL_DEFINITION getSignalSlot(int16_t slotno); 
@@ -227,6 +224,7 @@ private:
     static RMFT2 * loopTask;
     static RMFT2 * pausingTask;
     void delayMe(long millisecs);
+    void driveLoco(byte speedo);
     bool skipIfBlock();
     bool readLoco();
     void loop2();
@@ -235,8 +233,6 @@ private:
     void printMessage2(const FSH * msg);
     void thrungeString(uint32_t strfar, thrunger mode, byte id=0);
     uint16_t getOperand(byte n); 
-    void pause();
-    void resume();
     
    static bool diag;
    static const  HIGHFLASH3  byte RouteCode[];
@@ -258,9 +254,6 @@ private:
    static LookList * onRotateLookup;
 #endif
    static LookList * onOverloadLookup;
-   static LookList * onBlockEnterLookup;
-   static LookList * onBlockExitLookup;
-   
    
    static const int countLCCLookup;
    static int onLCCLookup[];
@@ -285,8 +278,9 @@ private:
     byte  taskId;
     BlinkState blinkState; // includes AT_TIMEOUT flag. 
     uint16_t loco;
+    bool forward;
     bool invert;
-    byte pauseSpeed;
+    byte speedo;
     int onEventStartPosition;
     byte stackDepth;
     int callStack[MAX_STACK_DEPTH];

EXRAIL2MacroReset.h

@@ -60,7 +60,6 @@
 #undef ENDIF  
 #undef ENDTASK
 #undef ESTOP
-#undef ESTOPALL
 #undef EXRAIL
 #undef EXTT_TURNTABLE
 #undef FADE
@@ -111,8 +110,6 @@
 #undef ONACTIVATE
 #undef ONACTIVATEL
 #undef ONAMBER
-#undef ONBLOCKENTER
-#undef ONBLOCKEXIT
 #undef ONDEACTIVATE
 #undef ONDEACTIVATEL 
 #undef ONCLOSE
@@ -197,7 +194,6 @@
 #undef XFOFF
 #undef XFON
 #undef XFTOGGLE
-#undef XPOM
 
 #ifndef RMFT2_UNDEF_ONLY
 #define ACTIVATE(addr,subaddr)
@@ -236,7 +232,6 @@
 #define ENDIF  
 #define ENDTASK
 #define ESTOP 
-#define ESTOPALL
 #define EXRAIL
 #define EXTT_TURNTABLE(id,vpin,home,description...)
 #define FADE(pin,value,ms)
@@ -286,8 +281,6 @@
 #define ONACTIVATE(addr,subaddr)
 #define ONACTIVATEL(linear)
 #define ONAMBER(signal_id) 
-#define ONBLOCKENTER(blockid)
-#define ONBLOCKEXIT(blockid)
 #define ONTIME(value)
 #define ONCLOCKTIME(hours,mins)
 #define ONCLOCKMINS(mins)
@@ -372,6 +365,5 @@
 #define XFOFF(cab,func)
 #define XFON(cab,func)
 #define XFTOGGLE(cab,func)
-#define XPOM(cab,cv,value)
 
 #endif

EXRAIL2Parser.cpp

@@ -210,15 +210,6 @@ void RMFT2::ComandFilter(Print * stream, byte & opcode, byte & paramCount, int16
         default:
             break;
         }
-	break;
-
-  case 'K': // <K blockid loco>  Block enter
-  case 'k': // <k blockid loco>  Block exit
-        if (paramCount!=2) break;
-        blockEvent(p[0],p[1],opcode=='K');
-        opcode=0;
-        break; 
-  
   default:  // other commands pass through
     break;
   }
@@ -237,9 +228,11 @@ bool RMFT2::parseSlash(Print * stream, byte & paramCount, int16_t p[]) {
 			    );
       }
       else {
-      StringFormatter::send(stream,F("\nID=%d,PC=%d,LOCO=%d %c"),
+      StringFormatter::send(stream,F("\nID=%d,PC=%d,LOCO=%d%c,SPEED=%d%c"),
 			    (int)(task->taskId),task->progCounter,task->loco,
-			    task->invert?'I':' '
+			    task->invert?'I':' ',
+			    task->speedo,
+			    task->forward?'F':'R'
 			    );
       }
       task=task->next;
@@ -283,25 +276,17 @@ bool RMFT2::parseSlash(Print * stream, byte & paramCount, int16_t p[]) {
   switch (p[0]) {
   case "PAUSE"_hk: // </ PAUSE>
     if (paramCount!=1) return false;
-    { // pause all tasks 
-      RMFT2 * task=loopTask;
-      while(task) {
-	      task->pause();
-	      task=task->next;
-	      if (task==loopTask) break;
-      }
-    }
-    DCC::setThrottle(0,1,true);  // stop all locos on the track
+    DCC::setThrottle(0,1,true);  // pause all locos on the track
     pausingTask=(RMFT2 *)1; // Impossible task address
     return true;
     
   case "RESUME"_hk: // </ RESUME>
     if (paramCount!=1) return false;
     pausingTask=NULL;
-    { // resume all tasks
+    {
       RMFT2 * task=loopTask;
       while(task) {
-	      task->resume();
+	if (task->loco) task->driveLoco(task->speedo);
 	task=task->next;
 	if (task==loopTask) break;
       }
@@ -316,7 +301,8 @@ bool RMFT2::parseSlash(Print * stream, byte & paramCount, int16_t p[]) {
       uint16_t cab=(paramCount==2)? 0 : p[1];
       int pc=routeLookup->find(route);
       if (pc<0) return false;
-      new RMFT2(pc,cab);
+      RMFT2* task=new RMFT2(pc);
+      task->loco=cab;
     }
     return true;
     

EXRAIL3.cpp

@@ -1,6 +0,0 @@
-// file exists to break #include dependency loop
-#include "EXRAIL2.h"
-#include "EXRAIL3.h"
-void RMFT3::blockEvent(int16_t block, int16_t loco, bool entering)  {
-    RMFT2::blockEvent(block,loco,entering);
-};

EXRAIL3.h

@@ -1,5 +0,0 @@
-// file exists to break #include dependency loop
-class RMFT3 {
-    public:
-     static void blockEvent(int16_t block, int16_t loco, bool entering);   
-};

EXRAILMacros.h

@@ -230,10 +230,6 @@ bool exrailHalSetup() {
 #define ONBUTTON(vpin) | FEATURE_SENSOR
 #undef ONSENSOR
 #define ONSENSOR(vpin) | FEATURE_SENSOR
-#undef ONBLOCKENTER
-#define ONBLOCKENTER(blockid) | FEATURE_BLOCK
-#undef ONBLOCKEXIT
-#define ONBLOCKEXIT(blockid) | FEATURE_BLOCK
 
 const byte RMFT2::compileFeatures = 0
    #include "myAutomation.h"
@@ -516,7 +512,6 @@ int RMFT2::onLCCLookup[RMFT2::countLCCLookup];
 #define ENDIF  OPCODE_ENDIF,0,0,
 #define ENDTASK OPCODE_ENDTASK,0,0,
 #define ESTOP OPCODE_SPEED,V(1), 
-#define ESTOPALL OPCODE_ESTOPALL,0,0, 
 #define EXRAIL
 #ifndef IO_NO_HAL
 #define EXTT_TURNTABLE(id,vpin,home,description...) OPCODE_EXTTTURNTABLE,V(id),OPCODE_PAD,V(vpin),OPCODE_PAD,V(home),
@@ -579,8 +574,6 @@ int RMFT2::onLCCLookup[RMFT2::countLCCLookup];
 #define ONACTIVATE(addr,subaddr) OPCODE_ONACTIVATE,V(addr<<2|subaddr),
 #define ONACTIVATEL(linear) OPCODE_ONACTIVATE,V(linear+3),
 #define ONAMBER(signal_id) OPCODE_ONAMBER,V(signal_id),
-#define ONBLOCKENTER(block_id) OPCODE_ONBLOCKENTER,V(block_id),
-#define ONBLOCKEXIT(block_id) OPCODE_ONBLOCKEXIT,V(block_id),
 #define ONCLOSE(turnout_id) OPCODE_ONCLOSE,V(turnout_id),
 #define ONLCC(sender,event) OPCODE_ONLCC,V(event),\
         OPCODE_PAD,V((((uint64_t)sender)>>32)&0xFFFF),\
@@ -672,7 +665,6 @@ int RMFT2::onLCCLookup[RMFT2::countLCCLookup];
 #define XFOFF(cab,func) OPCODE_XFOFF,V(cab),OPCODE_PAD,V(func),
 #define XFON(cab,func) OPCODE_XFON,V(cab),OPCODE_PAD,V(func),
 #define XFTOGGLE(cab,func) OPCODE_XFTOGGLE,V(cab),OPCODE_PAD,V(func),
-#define XPOM(cab,cv,value) OPCODE_XPOM,V(cab),OPCODE_PAD,V(cv),OPCODE_PAD,V(value),
 
 // Build RouteCode
 const int StringMacroTracker2=__COUNTER__;

GITHUB_SHA.h

@@ -1 +1 @@
-#define GITHUB_SHA "devel-railcom2-202409282036Z"
+#define GITHUB_SHA "devel-202411091200Z"

IODevice.h

@@ -559,6 +559,18 @@ protected:
 
 };
 
-#include "IODeviceList.h"
+#include "IO_MCP23008.h"
+#include "IO_MCP23017.h"
+#include "IO_PCF8574.h"
+#include "IO_PCF8575.h"
+#include "IO_PCA9555.h"
+#include "IO_duinoNodes.h"
+#include "IO_EXIOExpander.h"
+#include "IO_trainbrains.h"
+#include "IO_EncoderThrottle.h"
+#include "IO_TCA8418.h"
+#include "IO_NeoPixel.h"
+#include "IO_TM1638.h"
+#include "IO_EXSensorCAM.h"
 
 #endif // iodevice_h

IODeviceList.h

@@ -1,37 +0,0 @@
-/*
- *  © 2024, Chris Harlow. All rights reserved.
- *
- *  This file is part of CommandStation-EX
- *
- *  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/>.
-*/
-/* 
-This is the list of HAL drivers automatically included by IODevice.h
-It has been moved here to be easier to maintain than editing IODevice.h
-*/
-#include "IO_MCP23008.h"
-#include "IO_MCP23017.h"
-#include "IO_PCF8574.h"
-#include "IO_PCF8575.h"
-#include "IO_PCA9555.h"
-#include "IO_duinoNodes.h"
-#include "IO_EXIOExpander.h"
-#include "IO_trainbrains.h"
-#include "IO_EncoderThrottle.h"
-#include "IO_TCA8418.h"
-#include "IO_NeoPixel.h"
-#include "IO_I2CRailcom.h"
-#include "IO_TM1638.h"
-#include "IO_EXSensorCAM.h"
-#include "IO_DS1307.h"

IO_DS1307.cpp

@@ -1,143 +0,0 @@
-/*
- *  © 2024, Chris Harlow. All rights reserved.
- *
- *  This file is part of CommandStation-EX
- *
- *  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_DS1307 device driver is used to interface a standalone realtime clock. 
-* The clock will announce every minute (which will trigger EXRAIL ONTIME events).
-* Seconds, and Day/date info is ignored, except that the announced hhmm time
-* will attempt to synchronize with the 0 seconds of the clock. 
-* An analog read in EXRAIL (IFGTE(vpin, value) etc will check against the hh*60+mm time.
-* The clock can be easily set by an analog write to the vpin using 24 hr clock time
-* with the command <z vpin hh mm ss> 
-*/
-
-#include "IO_DS1307.h"
-#include "I2CManager.h"
-#include "DIAG.h"
-#include "CommandDistributor.h"
-
-uint8_t d2b(uint8_t d) {
-     return (d >> 4)*10 + (d & 0x0F);  
-}
-
-void DS1307::create(VPIN vpin, I2CAddress i2cAddress) {
-    if (checkNoOverlap(vpin, 1, i2cAddress)) new DS1307(vpin, i2cAddress);
-  }
- 
-    
-  // Constructor
-    DS1307::DS1307(VPIN vpin,I2CAddress i2cAddress){
-      _firstVpin = vpin;
-      _nPins = 1;
-     _I2CAddress = i2cAddress;
-     addDevice(this);
-    }
-
-uint32_t DS1307::getTime() {
-    // Obtain ss,mm,hh buffers from device
-    uint8_t readBuffer[3];
-    const uint8_t writeBuffer[1]={0};
-
-    // address register 0 for read. 
-    I2CManager.write(_I2CAddress, writeBuffer, 1);
-    if (I2CManager.read(_I2CAddress, readBuffer, 3) != I2C_STATUS_OK) {
-       _deviceState=DEVSTATE_FAILED;
-       return 0;
-    } 
-    _deviceState=DEVSTATE_NORMAL;
-
-    if (debug) {
-      static const char hexchars[]="0123456789ABCDEF";
-      USB_SERIAL.print(F("<*RTC"));
-        for (int i=2;i>=0;i--) {
-          USB_SERIAL.write(' ');  
-          USB_SERIAL.write(hexchars[readBuffer[i]>>4]);
-          USB_SERIAL.write(hexchars[readBuffer[i]& 0x0F ]);
-        }
-        StringFormatter::send(&USB_SERIAL,F(" %d *>\n"),_deviceState);
-      }
-    
-    if (readBuffer[0] & 0x80) {
-        _deviceState=DEVSTATE_INITIALISING;
-        DIAG(F("DS1307 clock in standby"));
-        return 0; // clock is not running
-    }
-    // convert device format to seconds since midnight
-    uint8_t ss=d2b(readBuffer[0]  & 0x7F);
-    uint8_t mm=d2b(readBuffer[1]);
-    uint8_t hh=d2b(readBuffer[2] & 0x3F);
-    return (hh*60ul +mm)*60ul +ss;     
-}
-
-void DS1307::_begin()  {
-  // Initialise  device and sync loop() to zero seconds
-    I2CManager.begin(); 
-    auto tstamp=getTime();
-    if (_deviceState==DEVSTATE_NORMAL) {
-        byte seconds=tstamp%60;
-        delayUntil(micros() + ((60-seconds) * 1000000));
-    }
-    _display(); 
-}
-
-// Processing loop to obtain clock time.
-// This self-synchronizes to the next minute tickover
-void DS1307::_loop(unsigned long currentMicros) { 
-    auto time=getTime();
-    if (_deviceState==DEVSTATE_NORMAL) {
-       byte ss=time%60;
-       CommandDistributor::setClockTime(time/60, 1, 1);      
-       delayUntil(currentMicros + ((60-ss) * 1000000));  
-    }
-}
-
-
-  // Display device driver info.
-  void DS1307::_display()  {
-    auto tstamp=getTime();
-    byte ss=tstamp%60;
-    tstamp/=60;
-    byte mm=tstamp%60;
-    byte hh=tstamp/60;
-    DIAG(F("DS1307 on I2C:%s vpin %d %d:%d:%d %S"), 
-      _I2CAddress.toString(), _firstVpin,
-      hh,mm,ss,
-     (_deviceState==DEVSTATE_FAILED) ? F("OFFLINE") : F(""));
-  }
-
-  // allow user to set the clock 
-  void DS1307::_writeAnalogue(VPIN vpin, int hh, uint8_t mm, uint16_t ss)  {  
-    (void) vpin;
-    uint8_t writeBuffer[3];
-    writeBuffer[0]=1; // write mm,hh first 
-    writeBuffer[1]=((mm/10)<<4) + (mm % 10);  
-    writeBuffer[2]=((hh/10)<<4) + (hh % 10);  
-    I2CManager.write(_I2CAddress, writeBuffer, 3);
-    writeBuffer[0]=0; // write ss  
-    writeBuffer[1]=((ss/10)<<4) + (ss % 10);  
-    I2CManager.write(_I2CAddress, writeBuffer, 2);
-    _loop(micros()); // resync with seconds rollover
-  }
-   
-  // Method to read analogue hh*60+mm time 
-   int DS1307::_readAnalogue(VPIN vpin) { 
-    (void)vpin; 
-    return getTime()/60;
-  };
-

IO_DS1307.h

@@ -1,54 +0,0 @@
-/*
- *  © 2024, Chris Harlow. All rights reserved.
- *
- *  This file is part of CommandStation-EX
- *
- *  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_DS1307 device driver is used to interface a standalone realtime clock. 
-* The clock will announce every minute (which will trigger EXRAIL ONTIME events).
-* Seconds, and Day/date info is ignored, except that the announced hhmm time
-* will attempt to synchronize with the 0 seconds of the clock. 
-* An analog read in EXRAIL (IFGTE(vpin, value) etc will check against the hh*60+mm time.
-* The clock can be easily set by an analog write to the vpin using 24 hr clock time
-* with the command <z vpin hh mm ss> 
-*/
-
-#ifndef IO_DS1307_h
-#define IO_DS1307_h
-
-
-#include "IODevice.h"
-
-class DS1307 : public IODevice {
-public: 
-  static const bool debug=false; 
-  static void create(VPIN vpin, I2CAddress i2cAddress);
- 
-    
-private:
-  
-  // Constructor
-    DS1307(VPIN vpin,I2CAddress i2cAddress);
-    uint32_t getTime();
-    void _begin() override;
-    void _display() override;
-    void _loop(unsigned long currentMicros) override;
-    int _readAnalogue(VPIN vpin) override;
-    void _writeAnalogue(VPIN vpin, int hh, uint8_t mm, uint16_t ss)  override;
-};
- 
-#endif

IO_I2CRailcom.h

@@ -1,321 +0,0 @@
-   /*
- *  © 2024, Henk Kruisbrink & Chris Harlow. All rights reserved.
- *  © 2023, Neil McKechnie. All rights reserved.
- *  
- *  This file is part of DCC++EX API
- *
- *  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/>.
- */
-
-/*
- * 
- * Dec 2023, Added NXP SC16IS752 I2C Dual UART
- * The SC16IS752 has 64 bytes TX & RX FIFO buffer
- * First version without interrupts from I2C UART and only RX/TX are used, interrupts may not be
- * needed as the RX Fifo holds the reply 
- * 
- * Jan 2024, Issue with using both UARTs simultaniously, the secod uart seems to work  but the first transmit 
- * corrupt data. This need more analysis and experimenatation. 
- * Will push this driver to the dev branch with the uart fixed to 0 
- * Both SC16IS750 (single uart) and SC16IS752 (dual uart, but only uart 0 is enable)
- * 
- * myHall.cpp configuration syntax:
- * 
- * I2CRailcom::create(1st vPin, vPins, I2C address);
- * 
- * myAutomation configuration
- *  HAL(I2CRailcom, 1st vPin, vPins, I2C address)
- * Parameters:
- * 1st vPin     : First virtual pin that EX-Rail can control to play a sound, use PLAYSOUND command (alias of ANOUT)
- * vPins        : Total number of virtual pins allocated (2 vPins are supported, one for each UART)
- *                1st vPin for UART 0, 2nd for UART 1
- * I2C Address  : I2C address of the serial controller, in 0x format
- */
-
-#ifndef IO_I2CRailcom_h
-#define IO_I2CRailcom_h
-#include "IODevice.h"
-#include "I2CManager.h"
-#include "DIAG.h"
-#include "DCCWaveform.h"
-#include "Railcom.h"
-
-// Debug and diagnostic defines, enable too many will result in slowing the driver
-#define DIAG_I2CRailcom
-
-class I2CRailcom : public IODevice {
-private: 
-  // SC16IS752 defines
-  uint8_t _UART_CH=0x00; // channel 0 or 1 flips each loop if npins>1
-  byte _inbuf[12];
-  byte _outbuf[2];
-  byte cutoutCounter[2]; 
-  Railcom * _channelMonitors[2]; 
-public:
-  // Constructor
-   I2CRailcom(VPIN firstVpin, int nPins, I2CAddress i2cAddress){
-    _firstVpin = firstVpin;
-    _nPins = nPins;
-    _I2CAddress = i2cAddress;
-    _channelMonitors[0]=new Railcom(firstVpin);
-    if (nPins>1) _channelMonitors[1]=new Railcom(firstVpin+1);
-    addDevice(this);
-   } 
-  
-public:
-  static void create(VPIN firstVpin, int nPins, I2CAddress i2cAddress) {
-    if (nPins>2) nPins=2;
-    if (checkNoOverlap(firstVpin, nPins, i2cAddress)) 
-     new I2CRailcom(firstVpin, nPins, i2cAddress); 
-    }
-
-  void _begin() override {
-    I2CManager.setClock(1000000); // TODO do we need this?
-    I2CManager.begin();
-    auto exists=I2CManager.exists(_I2CAddress);
-    DIAG(F("I2CRailcom: %s UART%S detected"), 
-           _I2CAddress.toString(), exists?F(""):F(" NOT"));
-    if (!exists) return;
-  
-    _UART_CH=0;
-    Init_SC16IS752(); // Initialize UART0    
-    if (_nPins>1) {
-      _UART_CH=1;
-      Init_SC16IS752(); // Initialize UART1
-    }
-    
-    if (_deviceState==DEVSTATE_INITIALISING) _deviceState=DEVSTATE_NORMAL;
-    _display();
-    }
-  
-  
-  void _loop(unsigned long currentMicros) override {
-    // Read responses from device
-    if (_deviceState!=DEVSTATE_NORMAL) return;
-
-    // return if in cutout or cutout very soon.  
-    if (!DCCWaveform::isRailcomSampleWindow()) return; 
-    
-    // IF we have 2 channels, flip channels each loop
-    if (_nPins>1) _UART_CH=_UART_CH?0:1;
-
-    // have we read this cutout already?
-    auto cut=DCCWaveform::getRailcomCutoutCounter();
-    if (cutoutCounter[_UART_CH]==cut) return; 
-    cutoutCounter[_UART_CH]=cut; 
-    
-    // Read incoming raw Railcom data, and process accordingly
-
-    auto inlength = UART_ReadRegister(REG_RXLV);
-    
-    if (inlength> sizeof(_inbuf)) inlength=sizeof(_inbuf); 
-    _inbuf[0]=0;
-    if (inlength>0) {
-      // Read data buffer from UART
-      _outbuf[0]=(byte)(REG_RHR << 3 | _UART_CH << 1);
-      I2CManager.read(_I2CAddress, _inbuf, inlength, _outbuf, 1); 
-    }
-    // HK: Reset FIFO at end of read cycle
-    UART_WriteRegister(REG_FCR, 0x07,false);
-    
-    // Ask Railcom to interpret the raw data
-    _channelMonitors[_UART_CH]->process(_inbuf,inlength);
-  }
-          
- 
-  void _display() override {
-    DIAG(F("I2CRailcom: Configured on Vpins:%u-%u %S"), _firstVpin, _firstVpin+_nPins-1,
-      (_deviceState!=DEVSTATE_NORMAL) ? F("OFFLINE") : F(""));
-  }
-  
-private: 
-
-
-  // SC16IS752 functions
-  // Initialise SC16IS752 only for this channel
-  // First a software reset
-  // Enable FIFO and clear TX & RX FIFO
-  // Need to set the following registers
-  // IOCONTROL set bit 1 and 2 to 0 indicating that they are GPIO
-  // IODIR set all bit to 1 indicating al are output
-  // IOSTATE set only bit 0 to 1 for UART 0, or only bit 1 for UART 1  // 
-  // LCR bit 7=0 divisor latch (clock division registers DLH & DLL, they store 16 bit divisor), 
-  //     WORD_LEN, STOP_BIT, PARITY_ENA and PARITY_TYPE
-  // MCR bit 7=0 clock divisor devide-by-1 clock input
-  // DLH most significant part of divisor
-  // DLL least significant part of divisor
-  //
-  // BAUD_RATE, WORD_LEN, STOP_BIT, PARITY_ENA and PARITY_TYPE have been defined and initialized
-  //
-  // Communication parameters 8 bit, No parity, 1 stopbit
-  static const uint8_t WORD_LEN = 0x03;    // Value LCR bit 0,1
-  static const uint8_t STOP_BIT = 0x00;    // Value LCR bit 2 
-  static const uint8_t PARITY_ENA = 0x00;  // Value LCR bit 3
-  static const uint8_t PARITY_TYPE = 0x00; // Value LCR bit 4
-  static const uint32_t BAUD_RATE = 250000;
-  static const uint8_t PRESCALER = 0x01;   // Value MCR bit 7  
-  static const unsigned long SC16IS752_XTAL_FREQ_RAILCOM = 16000000; // Baud rate for Railcom signal
-  static const uint16_t _divisor = (SC16IS752_XTAL_FREQ_RAILCOM / PRESCALER) / (BAUD_RATE * 16);  
-     
-  void Init_SC16IS752(){ 
-   if (_UART_CH==0) { // HK: Currently fixed on ch 0
-      // only reset on channel 0}
-      UART_WriteRegister(REG_IOCONTROL, 0x08,false); // UART Software reset
-       //_deviceState=DEVSTATE_INITIALISING;  // ignores error during reset which seems normal. // HK: this line is moved to below
-      auto iocontrol_readback = UART_ReadRegister(REG_IOCONTROL);
-      if (iocontrol_readback == 0x00){
-        _deviceState=DEVSTATE_INITIALISING;
-        DIAG(F("I2CRailcom: %s SRESET readback: 0x%x"),_I2CAddress.toString(), iocontrol_readback);
-      } else {
-                DIAG(F("I2CRailcom: %s SRESET: 0x%x"),_I2CAddress.toString(), iocontrol_readback);
-             }
-   } 
-   // HK:
-   // You write 0x08 to the IOCONTROL register, setting bit 3 (SRESET), as per datasheet 8.18:
-   // "Software Reset. A write to this bit will reset the device. Once the
-   // device is reset this bit is automatically set to logic 0"
-   // So you can not readback the val you have written as this has changed.
-   // I've added an extra UART_ReadRegister(REG_IOCONTROL) and check if the return value is 0x00
-   // then set _deviceState=DEVSTATE_INITIALISING;
-   
-  
-    // HK: only do clear FIFO at end of Init_SC16IS752
-    //UART_WriteRegister(REG_FCR, 0x07,false); // Reset FIFO, clear RX & TX FIFO (write only)
-    
-    UART_WriteRegister(REG_MCR, 0x00); // Set MCR to all 0, includes Clock divisor
-    
-    //UART_WriteRegister(REG_LCR, 0x80); // Divisor latch enabled
-    
-    UART_WriteRegister(REG_LCR, 0x80 | WORD_LEN | STOP_BIT | PARITY_ENA | PARITY_TYPE); // Divisor latch enabled and comm parameters set
-    UART_WriteRegister(REG_DLL, (uint8_t)_divisor);  // Write DLL
-    UART_WriteRegister(REG_DLH, (uint8_t)(_divisor >> 8)); // Write DLH
-    auto lcr_readback = UART_ReadRegister(REG_LCR);
-    lcr_readback = lcr_readback & 0x7F;
-    UART_WriteRegister(REG_LCR, lcr_readback); // Divisor latch disabled
-    
-    //UART_WriteRegister(REG_LCR,  WORD_LEN | STOP_BIT | PARITY_ENA | PARITY_TYPE); // Divisor latch disabled
-    
-    UART_WriteRegister(REG_FCR, 0x07,false); // Reset FIFO, clear RX & TX FIFO (write only)
-
-    #ifdef DIAG_I2CRailcom
-    // HK: Test to see if internal loopback works and if REG_RXLV increment to at least 0x01
-    // Set REG_MCR bit 4 to 1, Enable Loopback
-    UART_WriteRegister(REG_MCR, 0x10);
-    UART_WriteRegister(REG_THR, 0x88, false); // Send 0x88
-    auto inlen = UART_ReadRegister(REG_RXLV);
-    if (inlen == 0){
-        DIAG(F("I2CRailcom: Loopback test: %s/%d failed"),_I2CAddress.toString(), _UART_CH);
-        } else {          
-            DIAG(F("Railcom: Loopback test: %s/%d RX Fifo lvl: 0x%x"),_I2CAddress.toString(), _UART_CH, inlen); 
-            _outbuf[0]=(byte)(REG_RHR << 3 | _UART_CH << 1);
-            I2CManager.read(_I2CAddress, _inbuf, inlen, _outbuf, 1); 
-          #ifdef DIAG_I2CRailcom_data
-            DIAG(F("Railcom: Loopback test: %s/%d RX FIFO Data"), _I2CAddress.toString(), _UART_CH);
-            for (int i = 0; i < inlen; i++){
-            DIAG(F("Railcom: Loopback data [0x%x]: 0x%x"), i, _inbuf[i]);
-            //DIAG(F("[0x%x]: 0x%x"), i, _inbuf[i]);  
-            }
-          #endif          
-        }
-    UART_WriteRegister(REG_MCR, 0x00); // Set REG_MCR back to 0x00
-    #endif
-
-    #ifdef DIAG_I2CRailcom
-    // Sent some data to check if UART baudrate is set correctly, check with logic analyzer on TX pin
-    UART_WriteRegister(REG_THR, 9, false);
-    DIAG(F("I2CRailcom: UART %s/%d Test TX = 0x09"),_I2CAddress.toString(), _UART_CH);
-    #endif
-    
-    if (_deviceState==DEVSTATE_INITIALISING) {
-      DIAG(F("I2CRailcom: UART %d init complete"),_UART_CH);
-    }
-   // HK: final FIFO reset 
-   UART_WriteRegister(REG_FCR, 0x07,false); // Reset FIFO, clear RX & TX FIFO (write only)
-  
-  }
-
-  
-  
-
-  void UART_WriteRegister(uint8_t reg, uint8_t val, bool readback=true){
-    _outbuf[0] = (byte)( reg << 3 | _UART_CH << 1);
-    _outbuf[1]=val;
-    auto status=I2CManager.write(_I2CAddress, _outbuf, (uint8_t)2);
-    if(status!=I2C_STATUS_OK) {
-      DIAG(F("I2CRailcom: %s/%d write reg=0x%x,data=0x%x,I2Cstate=%d"),
-       _I2CAddress.toString(), _UART_CH, reg, val, status);
-       _deviceState=DEVSTATE_FAILED;
-    }
-    if (readback) {    // Read it back to cross check
-      auto readback=UART_ReadRegister(reg);
-      if (readback!=val) {
-        DIAG(F("I2CRailcom readback: %s/%d reg:0x%x write=0x%x read=0x%x"),_I2CAddress.toString(),_UART_CH,reg,val,readback);
-      }
-    }
-  }
-
- 
-  uint8_t UART_ReadRegister(uint8_t reg){
-     _outbuf[0] = (byte)(reg << 3 | _UART_CH << 1); // _outbuffer[0] has now UART_REG and UART_CH
-     _inbuf[0]=0;
-     auto status=I2CManager.read(_I2CAddress, _inbuf, 1, _outbuf, 1);    
-    if (status!=I2C_STATUS_OK) {
-       DIAG(F("I2CRailcom read: %s/%d read reg=0x%x,I2Cstate=%d"),
-       _I2CAddress.toString(), _UART_CH, reg, status);  
-       _deviceState=DEVSTATE_FAILED;
-    }
-    return _inbuf[0]; 
-  }
-
-// SC16IS752 General register set (from the datasheet)
-enum : uint8_t {
-    REG_RHR       = 0x00, // FIFO Read
-    REG_THR       = 0x00, // FIFO Write
-    REG_IER       = 0x01, // Interrupt Enable Register R/W
-    REG_FCR       = 0x02, // FIFO Control Register Write
-    REG_IIR       = 0x02, // Interrupt Identification Register Read
-    REG_LCR       = 0x03, // Line Control Register R/W
-    REG_MCR       = 0x04, // Modem Control Register R/W
-    REG_LSR       = 0x05, // Line Status Register Read
-    REG_MSR       = 0x06, // Modem Status Register Read
-    REG_SPR       = 0x07, // Scratchpad Register R/W
-    REG_TCR       = 0x06, // Transmission Control Register R/W
-    REG_TLR       = 0x07, // Trigger Level Register R/W    
-    REG_TXLV      = 0x08, // Transmitter FIFO Level register Read
-    REG_RXLV      = 0x09, // Receiver FIFO Level register Read
-    REG_IODIR     = 0x0A, // Programmable I/O pins Direction register R/W
-    REG_IOSTATE   = 0x0B, // Programmable I/O pins State register R/W
-    REG_IOINTENA  = 0x0C, // I/O Interrupt Enable register R/W
-    REG_IOCONTROL = 0x0E, // I/O Control register R/W
-    REG_EFCR      = 0x0F, // Extra Features Control Register R/W
-  };
-
-// SC16IS752 Special register set
-enum : uint8_t{
-    REG_DLL       = 0x00, // Division registers R/W
-    REG_DLH       = 0x01, // Division registers R/W
-  };
-
-// SC16IS752 Enhanced regiter set
-enum : uint8_t{
-    REG_EFR       = 0X02, // Enhanced Features Register R/W
-    REG_XON1      = 0x04, // R/W
-    REG_XON2      = 0x05, // R/W
-    REG_XOFF1     = 0x06, // R/W
-    REG_XOFF2     = 0x07, // R/W
-  };
-
-};
-
-#endif // IO_I2CRailcom_h

IO_Modbus.cpp

@@ -1,5 +1,6 @@
 /*
  *  © 2024, Travis Farmer. All rights reserved.
+ *  © 2024, Chris Bulliner. All rights reserved. https://github.com/CMB27
  *  
  *  This file is part of DCC++EX API
  *

IO_Modbus.h

@@ -1,5 +1,6 @@
 /*
  *  © 2024, Travis Farmer. All rights reserved.
+ *  © 2024, Chris Bulliner. All rights reserved. https://github.com/CMB27
  *   
  *  This file is part of DCC++EX API
  *
@@ -406,7 +407,6 @@ public:
     return NULL;
   }
 };
-#else
-#error "You have included IO_Modbus on an unsupported board!"
+
 #endif
 #endif // IO_MODBUS_H

MotorDriver.h

@@ -136,9 +136,21 @@ enum TRACK_MODE : byte {
 
 // Virtualised Motor shield 1-track hardware Interface
 
-#include "Pinpair.h" // for class Pinpair
+#ifndef UNUSED_PIN     // sync define with the one in MotorDrivers.h
+#define UNUSED_PIN 255 // inside uint8_t
+#endif
 #define MAX_PIN 254
 
+class pinpair {
+public:
+  pinpair(byte p1, byte p2) {
+    pin = p1;
+    invpin = p2;
+  };
+  byte pin = UNUSED_PIN;
+  byte invpin = UNUSED_PIN;
+};
+
 #if defined(__IMXRT1062__) || defined(ARDUINO_ARCH_ESP8266) || defined(ARDUINO_ARCH_ESP32) || defined(ARDUINO_ARCH_SAMD) || defined(ARDUINO_ARCH_STM32)
 typedef uint32_t portreg_t;
 #else
@@ -209,7 +221,7 @@ class MotorDriver {
 	  pinMode(signalPin2, INPUT);
       }
     };
-    inline Pinpair getSignalPin() { return Pinpair(signalPin,signalPin2); };
+    inline pinpair getSignalPin() { return pinpair(signalPin,signalPin2); };
     inline int8_t getBrakePinSigned() { return invertBrake ? -brakePin : brakePin; };
     void setDCSignal(byte speedByte, uint8_t frequency=0);
     void throttleInrush(bool on);
@@ -285,7 +297,7 @@ class MotorDriver {
     else
       invertPhase = 0;
 #if defined(ARDUINO_ARCH_ESP32)
-    Pinpair p = getSignalPin();
+    pinpair p = getSignalPin();
     uint32_t *outreg = (uint32_t *)(GPIO_FUNC0_OUT_SEL_CFG_REG + 4*p.pin);
     if (invertPhase) // set or clear the invert bit in the gpio out register
       *outreg |=  ((uint32_t)0x1 << GPIO_FUNC0_OUT_INV_SEL_S);

Pinpair.h

@@ -1,14 +0,0 @@
-#pragma once
-#ifndef UNUSED_PIN     // sync define with the one in MotorDrivers.h
-#define UNUSED_PIN 255 // inside uint8_t
-#endif
-class Pinpair {
-public:
-  Pinpair(byte p1, byte p2) {
-    pin = p1;
-    invpin = p2;
-  };
-  byte pin = UNUSED_PIN;
-  byte invpin = UNUSED_PIN;
-};
-

Railcom.cpp

@@ -1,255 +0,0 @@
-/*
- *  SEE ADDITIONAL COPYRIGHT ATTRIBUTION BELOW
- *  © 2024 Chris Harlow
- *  All rights reserved.
- *  
- *  This file is part of DCC-EX
- *
- *  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/>.
- */
-
-/** Sections of this code (the decode table constants) 
- * are taken from openmrn
- *  https://github.com/bakerstu/openmrn/blob/master/src/dcc/RailCom.cxx
- * under the following copyright.
- * 
- * Copyright (c) 2014, Balazs Racz
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are  permitted provided that the following conditions are met:
- *
- *  - Redistributions of source code must retain the above copyright notice,
- *    this list of conditions and the following disclaimer.
- *
- *  - Redistributions in binary form must reproduce the above copyright notice,
- *    this list of conditions and the following disclaimer in the documentation
- *    and/or other materials provided with the distribution.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
- * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
- * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
- * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
- * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
- * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
- * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
- * POSSIBILITY OF SUCH DAMAGE.
- **/
-
-#include "Railcom.h"
-#include "defines.h"
-#include "FSH.h"
-#include "DCC.h"
-#include "DIAG.h"
-
-
-
-  /** Table for 8-to-6 decoding of railcom data. This table can be indexed by the
-   * 8-bit value read from the railcom channel, and the return value will be
-   * either a 6-bit number, or one of the defined Railcom constrantrs. If the
-   * value is invalid, the INV constant is returned. */
-    
-    // These values appear in the railcom_decode table to mean special symbols.
-    static constexpr uint8_t
-        // highest valid 6-bit value 
-        MAX_VALID = 0x3F,
-         /// invalid value (not conforming to the 4bit weighting requirement)
-        INV = 0xff,
-        /// Railcom ACK; the decoder received the message ok. NOTE: There are
-        /// two codepoints that map to this.
-        ACK = 0xfe,
-        /// The decoder rejected the packet.
-        NACK = 0xfd,
-        /// The decoder is busy; send the packet again. This is typically
-        /// returned when a POM CV write is still pending; the caller must
-        /// re-try sending the packet later.
-        RCBUSY = 0xfc,
-
-        /// Reserved for future expansion.
-        RESVD1 = 0xfb,
-        /// Reserved for future expansion.
-        RESVD2 = 0xfa;
-
-const uint8_t HIGHFLASH decode[256] =
-    // 0|8     1|9     2|a     3|b     4|c     5|d     6|e     7|f  
-{      INV,    INV,    INV,    INV,    INV,    INV,    INV,    INV, // 0
-       INV,    INV,    INV,    INV,    INV,    INV,    INV,    ACK, // 0
-       INV,    INV,    INV,    INV,    INV,    INV,    INV,   0x33, // 1
-       INV,    INV,    INV,   0x34,    INV,   0x35,   0x36,    INV, // 1
-       INV,    INV,    INV,    INV,    INV,    INV,    INV,   0x3A, // 2
-       INV,    INV,    INV,   0x3B,    INV,   0x3C,   0x37,    INV, // 2
-       INV,    INV,    INV,   0x3F,    INV,   0x3D,   0x38,    INV, // 3
-       INV,   0x3E,   0x39,    INV,   NACK,    INV,    INV,    INV, // 3
-       INV,    INV,    INV,    INV,    INV,    INV,    INV,   0x24, // 4
-       INV,    INV,    INV,   0x23,    INV,   0x22,   0x21,    INV, // 4
-       INV,    INV,    INV,   0x1F,    INV,   0x1E,   0x20,    INV, // 5
-       INV,   0x1D,   0x1C,    INV,   0x1B,    INV,    INV,    INV, // 5
-       INV,    INV,    INV,   0x19,    INV,   0x18,   0x1A,    INV, // 6
-       INV,   0x17,   0x16,    INV,   0x15,    INV,    INV,    INV, // 6
-       INV,   0x25,   0x14,    INV,   0x13,    INV,    INV,    INV, // 7
-      0x32,    INV,    INV,    INV,    INV,    INV,    INV,    INV, // 7
-       INV,    INV,    INV,    INV,    INV,    INV,    INV, RESVD2, // 8
-       INV,    INV,    INV,   0x0E,    INV,   0x0D,   0x0C,    INV, // 8
-       INV,    INV,    INV,   0x0A,    INV,   0x09,   0x0B,    INV, // 9
-       INV,   0x08,   0x07,    INV,   0x06,    INV,    INV,    INV, // 9
-       INV,    INV,    INV,   0x04,    INV,   0x03,   0x05,    INV, // a
-       INV,   0x02,   0x01,    INV,   0x00,    INV,    INV,    INV, // a
-       INV,   0x0F,   0x10,    INV,   0x11,    INV,    INV,    INV, // b
-      0x12,    INV,    INV,    INV,    INV,    INV,    INV,    INV, // b
-       INV,    INV,    INV, RESVD1,    INV,   0x2B,   0x30,    INV, // c
-       INV,   0x2A,   0x2F,    INV,   0x31,    INV,    INV,    INV, // c
-       INV,   0x29,   0x2E,    INV,   0x2D,    INV,    INV,    INV, // d
-      0x2C,    INV,    INV,    INV,    INV,    INV,    INV,    INV, // d
-       INV, RCBUSY,   0x28,    INV,   0x27,    INV,    INV,    INV, // e
-      0x26,    INV,    INV,    INV,    INV,    INV,    INV,    INV, // e
-       ACK,    INV,    INV,    INV,    INV,    INV,    INV,    INV, // f
-       INV,    INV,    INV,    INV,    INV,    INV,    INV,    INV, // f       
-};
-   /// Packet identifiers from Mobile Decoders.
-    enum RailcomMobilePacketId
-    {
-        RMOB_POM = 0,
-        RMOB_ADRHIGH = 1,
-        RMOB_ADRLOW = 2,
-        RMOB_EXT = 3,
-        RMOB_DYN = 7,
-        RMOB_XPOM0 = 8,
-        RMOB_XPOM1 = 9,
-        RMOB_XPOM2 = 10,
-        RMOB_XPOM3 = 11,
-        RMOB_SUBID = 12,
-        RMOB_LOGON_ASSIGN_FEEDBACK = 13,
-        RMOB_LOGON_ENABLE_FEEDBACK = 15,
-};
-
-// each railcom block is represented by an instance of this class.
-// The blockvpin is the vpin associated with this block for the purposes of 
-// a HAL driver for the railcom detection and the EXRAIL ONBLOCKENTER/ONBLOCKEXIT
-
-Railcom::Railcom(uint16_t blockvpin) {
-    haveHigh=false;
-    haveLow=false;
-    packetsWithNoData=0;
-    lastChannel1Loco=0;
-    vpin=blockvpin;
-}
-uint16_t Railcom::expectLoco=0;
-uint16_t Railcom::expectCV=0;
-unsigned long Railcom::expectWait=0;
-ACK_CALLBACK Railcom::expectCallback=0;
-
-
-// Process is called by a raw data collector. 
-void Railcom::process(uint8_t * inbound, uint8_t length) {
-    
-   
-    if (length<2 || (inbound[0]==0 && inbound[1]==0)) {
-        noData();
-        return;
-    }
-
-    
-    if (Diag::RAILCOM) {
-      static const char hexchars[]="0123456789ABCDEF";
-      if (length>2) {  
-        USB_SERIAL.print(F("<*R "));
-        for (byte i=0;i<length;i++) {
-          if (i==2) Serial.write(' ');
-          USB_SERIAL.write(hexchars[inbound[i]>>4]);
-          USB_SERIAL.write(hexchars[inbound[i]& 0x0F ]);
-        }
-        USB_SERIAL.print(F(" *>\n"));
-      }
-    }
-
-    if (expectCV && DCCWaveform::getRailcomLastLocoAddress()==expectLoco) {
-        if (length>=4) {
-            auto v2=GETHIGHFLASH(decode,inbound[2]);
-            auto v3=GETHIGHFLASH(decode,inbound[3]);
-            uint16_t packet=(v2<<6) | (v3 & 0x3f);
-            // packet is 12 bits TTTTDDDDDDDD
-            byte type=(packet>>8) & 0x0F;   
-            byte data= packet & 0xFF;
-            if (type==RMOB_POM) {
-                // DIAG(F("POM READ loco=%d cv(%d)=%d/0x%x"), expectLoco, expectCV,data,data);
-                expectCallback(data);
-                expectCV=0;
-            }
-        }
-        
-    } 
-
-    if (expectCV && (millis()-expectWait)> POM_READ_TIMEOUT) { // still waiting 
-                expectCallback(-1);
-                expectCV=0;
-    }
-
- 
-    auto v1=GETHIGHFLASH(decode,inbound[0]);
-    auto v2=(length>1) ? GETHIGHFLASH(decode,inbound[1]):INV;
-    uint16_t packet=(v1<<6) | (v2 & 0x3f);
-    // packet is 12 bits TTTTDDDDDDDD
-    byte type=(packet>>8) & 0x0F;   
-    byte data= packet & 0xFF;
-    if (type==RMOB_ADRHIGH) {
-        holdoverHigh=data;
-        haveHigh=true;
-        packetsWithNoData=0;
-        }
-    else if (type==RMOB_ADRLOW) {
-        holdoverLow=data;
-        haveLow=true;
-        packetsWithNoData=0;
-        }
-     else {
-        // channel1 is unreadable or not loco address so maybe multiple locos in block
-        if (length>2 && GETHIGHFLASH(decode,inbound[0])!=INV) {
-            // it looks like we have channel2 data
-            auto thisLoco=DCCWaveform::getRailcomLastLocoAddress();
-            if (Diag::RAILCOM) DIAG(F("c2=%d"),thisLoco);
-            if (thisLoco==lastChannel1Loco) return; 
-            if (thisLoco) DCC::setLocoInBlock(thisLoco,vpin,false); // this loco is in block, but not exclusive 
-            return;
-        }
-        // channel1 no good and no channel2 
-        noData();
-        return;           
-    }    
-    if (haveHigh && haveLow) {
-        uint16_t thisLoco=((holdoverHigh<<8)| holdoverLow) & 0x7FFF; // drop top bit
-        if (thisLoco!=lastChannel1Loco) {
-            // the exclusive DCC call is quite expensive, we dont want to call it every packet
-            if (Diag::RAILCOM) DIAG(F("h=%x l=%xc1=%d"),holdoverHigh, holdoverLow,thisLoco);
-            DCC::setLocoInBlock(thisLoco,vpin,true); // only this loco is in block
-            lastChannel1Loco=thisLoco; 
-        }
-    }
-}
-
-
-void Railcom::noData() {
-    if (packetsWithNoData>MAX_WAIT_FOR_GLITCH) return; 
-    if (packetsWithNoData==MAX_WAIT_FOR_GLITCH) {
-            // treat as no loco
-            haveHigh=false;
-            haveLow=false;
-            lastChannel1Loco=0;
-            // Previous locos (if any) is exiting block  
-            DCC::clearBlock(vpin);
-        }
-        packetsWithNoData++;
-}

Railcom.h

@@ -1,57 +0,0 @@
-/*
- *  © 2024 Chris Harlow
- *  All rights reserved.
- *  
- *  This file is part of DCC-EX
- *
- *  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/>.
- */
-
-#ifndef Railcom_h
-#define Railcom_h
-#include "Arduino.h"
-
-typedef void (*ACK_CALLBACK)(int16_t result);
-
-class Railcom {
-  public:
-    Railcom(uint16_t vpin);
-
-    /* returns -1: Call again next packet
-                0: No loco on track
-               >0: loco id
-    */
-  void process(uint8_t * inbound,uint8_t length);
-  static void anticipate(uint16_t loco, uint16_t cv, ACK_CALLBACK callback) { 
-    expectLoco=loco;
-    expectCV=cv;
-    expectWait=millis(); // start of timeout 
-    expectCallback=callback;
-    };
-  
-  private:
-  static const unsigned long POM_READ_TIMEOUT=500; // as per spec
-  static uint16_t expectCV,expectLoco;
-  static unsigned long expectWait;
-  static ACK_CALLBACK expectCallback;
-  void noData();
-  uint16_t vpin;
- uint8_t holdoverHigh,holdoverLow;
- bool haveHigh,haveLow; 
- uint8_t packetsWithNoData; 
- uint16_t lastChannel1Loco; 
- static const byte MAX_WAIT_FOR_GLITCH=20; // number of dead or empty packets before assuming loco=0 
-};
-
-#endif

Release_Notes/Railcom.md

@@ -1,75 +0,0 @@
-Railcom implementation notes, Chris Harlow Oct 2024
-
-Railcom support is in 3 parts
-1. Generation of the DCC waveform with a Railcom cutout.
-2. Accessing the railcom feedback from a loco using hardware detectors
-3. Utilising the feedback to do something useful.
-
-DCC Waveform Railcom cutout depends on using suitable motor shields (EX8874 primarily) as the standard Arduino shield is not suitable. (Too high resistance during cutout)
-The choice of track management also depends on wiring all the MAIN tracks to use the same signal and brake pins. This allows separate track power management but prevents switching a single track from MAIN to PROG or DC... 
-Some CPUs require very specific choice of brake pins etc to match their internal timer register architecture.
-
-- MEGA.. The default shield setting for an EX8874 is suitable for Railcom on Channel A (MAIN) 
-- ESP32 .. not yet supported.
-- Nucleo ... TBA 
-
-Enabling the Railcom Cutout requires a `<C RAILCOM ON>` command. This can be added to myAutomation using `PARSE("<C RAILCOM ON>")`
-Code to calculate the cutout position and provide synchronization for the sampling is in `DCCWaveform.cpp` (not ESP32)
-and in general a global search for "railcom" will show all code changes that have been made to support this.
-
-Code to actually implement the timing of the cutout is hihjly cpu dependent and can be found in gthe various implementations of `DCCTimer.h`. At this time only `DCCTimerAVR.cpp`has implemented this.  
-
-
-Reading Railcom data:
-  A new HAL handler (`IO_I2CRailcom.h`)has been added to process input from a 2-block railcom reader (Refer Henk) which operates as a 2 channel UART accessible over I2C. The reader(s) sit between the CS and the track and collect railcom data from locos during the cutout.
-  After the cutout the HAL driver reads the UARTs over I2C and passes the raw data to the CS logic (`Railcom.cpp`)for analysis.
-
-  Each 2-block reader is described in myAutomation like `HAL(I2CRailcom,10000,2,0x48)`  which will assign 2 channels on i2c address 0x48 with vpin numbers 10000 and 10001. If you only use the first channel in the reader, just asign one pin instead of two.
-  (Implementation notes.. potentially other readers are possible with suitable HAL drivers. There are however several touch-points with the code DCC Waveform code which helps the HAL driver to understand when the data is safe to sample, and how to interpret responses when the sender is unknown. )
-
-Making use of Railcom data
-
- Exrail has two additional event handlers which can capture locos entering and exiting blocks. These handlers are started with the loco information already set, so for example:
- ```
- ONBLOCKENTER(10000) 
-    // a loco has entered block 10000 
-    FON(0)  // turn the light on
-    FON(1)  // make a lot of noise
-    SPEED(20) // slow down
-    DONE 
- 
- ONBLOCKEXIT(10000) 
-    // a loco has left block 10000 
-    FOFF(0)  // turn the light off
-    FOFF(1)  // stop the noise
-    SPEED(50) // speed up again
-    DONE 
-    ```
-
-    Note that the Railcom interpretation code is capable of detecting multiple locos in the same block at the same time and will create separate exrail tasks for each one.
-     There is however one minor loophole in the block exit logic...
-      If THREE or more locos are in the same block and ONE of them leaves, then ONBLOCKEXIT will not fire until 
-      EITHER - The leaving loco enters another railcom block
-      OR     - only ONE loco remains in the block just left.
-
-      To further support block management in railcom, two additional serial commands are available
-
-      `<K block loco >` to simulate a loco entering a block, and trigger any ONBLOCKENTER
-      `<k block loco >` to simulate a loco leaving a block, and trigger and ONBLOCKEXIT
-
-
-   Reading CV values on MAIN.
-
-      Railcom allows for the facility to read loco cv values while on the main track. This is considerably faster than PROG track access but depends on the loco being in a Railcom monitored block. 
-
-      To read from prog Track we use `<R cv>` response is `<r value>` 
-
-      To read from main track use `<r loco cv>`
-        response is `<r loco cv value>`  
-
-
-Additional EXRAIL features in Railcom Branch:
-  - ESTAOPALL  stops all locos immediately
-  - XPOM(cab,cv,value) POM write cv to sepcific loco
-     (POM(cv,value) already writes cv to current loco)
-     

StringFormatter.cpp

@@ -27,8 +27,6 @@ bool Diag::WIFI=false;
 bool Diag::WITHROTTLE=false;
 bool Diag::ETHERNET=false;
 bool Diag::LCN=false;
-bool Diag::RAILCOM=false;
-
 
  
 void StringFormatter::diag( const FSH* input...) {

StringFormatter.h

@@ -30,7 +30,6 @@ class Diag {
   static bool WITHROTTLE;
   static bool ETHERNET;
   static bool LCN;
-  static bool RAILCOM;
   
 };
 

TrackManager.cpp

@@ -218,7 +218,7 @@ bool TrackManager::setTrackMode(byte trackToSet, TRACK_MODE mode, int16_t dcAddr
 
 #ifdef ARDUINO_ARCH_ESP32
     // remove pin from MUX matrix and turn it off
-    Pinpair p = track[trackToSet]->getSignalPin();
+    pinpair p = track[trackToSet]->getSignalPin();
     //DIAG(F("Track=%c remove  pin %d"),trackToSet+'A', p.pin);
     gpio_reset_pin((gpio_num_t)p.pin);
     if (p.invpin != UNUSED_PIN) {
@@ -334,8 +334,7 @@ bool TrackManager::setTrackMode(byte trackToSet, TRACK_MODE mode, int16_t dcAddr
 	canDo &= track[t]->trackPWM;
       }
     }
-    if (canDo) DIAG(F("HA mode")); 
-    else {
+    if (!canDo) {
       // if we discover that HA mode was globally impossible
       // we must adjust the trackPWM capabilities
       FOR_EACH_TRACK(t) {
@@ -344,7 +343,6 @@ bool TrackManager::setTrackMode(byte trackToSet, TRACK_MODE mode, int16_t dcAddr
       }
       DCCTimer::clearPWM(); // has to be AFTER trackPWM changes because if trackPWM==true this is undone for  that track
     }
-    DCCWaveform::setRailcomPossible(canDo);
 #else
     // For ESP32 we just reinitialize the DCC Waveform
     DCCWaveform::begin();