DC via power pin 3rd part

.gitignore

@@ -7,11 +7,15 @@ Release/*
 .pio/
 .vscode/
 config.h
+.vscode/*
+# mySetup.h
 mySetup.cpp
 myHal.cpp
+# myAutomation.h
 myFilter.cpp
+# myAutomation.h
+# myLayout.h
 my*.h
 !my*.example.h
-compile_commands.json
-newcode.txt.old
-UserAddin.txt
+.vscode/extensions.json
+.vscode/extensions.json

.vscode/extensions.json

@@ -0,0 +1,10 @@
+{
+    // See http://go.microsoft.com/fwlink/?LinkId=827846
+    // for the documentation about the extensions.json format
+    "recommendations": [
+        "platformio.platformio-ide"
+    ],
+    "unwantedRecommendations": [
+        "ms-vscode.cpptools-extension-pack"
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,12 @@
+{
+    "files.associations": {
+        "array": "cpp",
+        "deque": "cpp",
+        "string": "cpp",
+        "unordered_map": "cpp",
+        "vector": "cpp",
+        "string_view": "cpp",
+        "initializer_list": "cpp",
+        "cstdint": "cpp"
+    }
+}

CommandDistributor.cpp

@@ -2,7 +2,6 @@
  *  © 2022 Harald Barth
  *  © 2020-2021 Chris Harlow
  *  © 2020 Gregor Baues
- *  © 2022 Colin Murdoch
  *  All rights reserved.
  *
  *  This file is part of CommandStation-EX
@@ -49,7 +48,7 @@ template<typename... Targs> void CommandDistributor::broadcastReply(clientType t
 // on a single USB connection config, write direct to Serial and ignore flush/shove
 template<typename... Targs> void CommandDistributor::broadcastReply(clientType type, Targs... msg){
   (void)type; //shut up compiler warning
-  StringFormatter::send(&USB_SERIAL, msg...);
+  StringFormatter::send(&Serial, msg...);
 }
 #endif 
 
@@ -105,7 +104,6 @@ void  CommandDistributor::parse(byte clientId,byte * buffer, RingStream * stream
 void CommandDistributor::forget(byte clientId) {
   if (clients[clientId]==WITHROTTLE_TYPE) WiThrottle::forget(clientId);
   clients[clientId]=NONE_TYPE;
-  if (virtualLCDClient==clientId) virtualLCDClient=RingStream::NO_CLIENT;
 }
 #endif 
 
@@ -162,10 +160,6 @@ void  CommandDistributor::broadcastTurnout(int16_t id, bool isClosed ) {
 #endif
 }
 
-void CommandDistributor::broadcastTurntable(int16_t id, uint8_t position, bool moving) {
-  broadcastReply(COMMAND_TYPE, F("<I %d %d %d>\n"), id, position, moving);
-}
-
 void  CommandDistributor::broadcastClockTime(int16_t time, int8_t rate) {
   // The JMRI clock command is of the form : PFT65871<;>4
   // The CS broadcast is of the form "<jC mmmm nn" where mmmm is time minutes and dd speed
@@ -173,7 +167,7 @@ void  CommandDistributor::broadcastClockTime(int16_t time, int8_t rate) {
   // be safe for both types.
   broadcastReply(COMMAND_TYPE, F("<jC %d %d>\n"),time, rate);
 #ifdef CD_HANDLE_RING
-  broadcastReply(WITHROTTLE_TYPE, F("PFT%l<;>%d\n"), (int32_t)time*60, rate);
+  broadcastReply(WITHROTTLE_TYPE, F("PFT%d<;>%d\n"), time*60, rate);
 #endif
 }
 
@@ -185,7 +179,10 @@ void CommandDistributor::setClockTime(int16_t clocktime, int8_t clockrate, byte
   {
     case 1:
       if (clocktime != lastclocktime){
-        // CAH. DIAG removed because LCD does it anyway. 
+        if (Diag::CMD) {                    
+          DIAG(F("Clock Command Received"));
+          DIAG(F("Received Clock Time is: %d at rate: %d"), clocktime, clockrate);
+        }
         LCD(6,F("Clk Time:%d Sp %d"), clocktime, clockrate);
         // look for an event for this time
         RMFT2::clockEvent(clocktime,1);
@@ -210,162 +207,32 @@ int16_t CommandDistributor::retClockTime() {
 void  CommandDistributor::broadcastLoco(byte slot) {
   DCC::LOCO * sp=&DCC::speedTable[slot];
   broadcastReply(COMMAND_TYPE, F("<l %d %d %d %l>\n"), sp->loco,slot,sp->speedCode,sp->functions);
-#ifdef SABERTOOTH
-  if (Serial2 && sp->loco == SABERTOOTH) {
-    static uint8_t rampingmode = 0;
-    bool direction = (sp->speedCode & 0x80) !=0; // true for forward
-    int32_t speed = sp->speedCode & 0x7f;
-    if (speed == 1) { // emergency stop
-      if (rampingmode != 1) {
-	rampingmode = 1;
-	Serial2.print("R1: 0\r\n");
-	Serial2.print("R2: 0\r\n");
-      }
-      Serial2.print("MD: 0\r\n");
-    } else {
-      if (speed != 0) {
-        // speed is here 2 to 127
-	speed = (speed - 1) * 1625 / 100;
-	speed = speed * (direction ? 1 : -1);
-	// speed is here -2047 to 2047
-      }
-      if (rampingmode != 2) {
-	rampingmode = 2;
-	Serial2.print("R1: 2047\r\n");
-	Serial2.print("R2: 2047\r\n");
-      }
-      Serial2.print("M1: ");
-      Serial2.print(speed);
-      Serial2.print("\r\n");
-      Serial2.print("M2: ");
-      Serial2.print(speed);
-      Serial2.print("\r\n");
-    }
-  }
-#endif
 #ifdef CD_HANDLE_RING
   WiThrottle::markForBroadcast(sp->loco);
 #endif
 }
 
 void  CommandDistributor::broadcastPower() {
-  char pstr[] = "? x";
-  for(byte t=0; t<TrackManager::MAX_TRACKS; t++)
-    if (TrackManager::getPower(t, pstr))
-      broadcastReply(COMMAND_TYPE, F("<p%s>\n"),pstr);
-
-  byte trackcount=0;
-  byte oncount=0;
-  byte offcount=0;
-  for(byte t=0; t<TrackManager::MAX_TRACKS; t++) {
-    if (TrackManager::isActive(t)) {
-      trackcount++;
-      // do not call getPower(t) unless isActive(t)!
-      if (TrackManager::getPower(t) == POWERMODE::ON)
-	oncount++;
-      else
-	offcount++;
-    }
-  }
-  //DIAG(F("t=%d on=%d off=%d"), trackcount, oncount, offcount);
-
-  char state='2';
-  if (oncount==0 || offcount == trackcount)
-    state = '0';
-  else if (oncount == trackcount) {
-    state = '1';
-  }
-
-  // additional info about MAIN, PROG and JOIN
   bool main=TrackManager::getMainPower()==POWERMODE::ON;
   bool prog=TrackManager::getProgPower()==POWERMODE::ON;
   bool join=TrackManager::isJoined();
-  //DIAG(F("m=%d p=%d j=%d"), main, prog, join);
   const FSH * reason=F("");
-  if (join) {
-    reason = F(" JOIN"); // with space at start so we can append without space
-    broadcastReply(COMMAND_TYPE, F("<p1 %S>\n"),reason);
-  } else {
-    if (main) {
-      //reason = F("MAIN");
-      broadcastReply(COMMAND_TYPE, F("<p1 MAIN>\n"));
-    }
-    if (prog) {
-      //reason = F("PROG");
-      broadcastReply(COMMAND_TYPE, F("<p1 PROG>\n"));
-    }
-  }
-
-  if (state != '2')
-    broadcastReply(COMMAND_TYPE, F("<p%c>\n"),state);
+  char state='1';
+  if (main && prog && join) reason=F(" JOIN");
+  else if (main && prog);
+  else if (main) reason=F(" MAIN");
+  else if (prog) reason=F(" PROG");
+  else state='0';
+  broadcastReply(COMMAND_TYPE, F("<p%c%S>\n"),state,reason);
 #ifdef CD_HANDLE_RING
-  // send '1' if all main are on, otherwise global state (which in that case is '0' or '2')
-  broadcastReply(WITHROTTLE_TYPE, F("PPA%c\n"), main?'1': state);
+  broadcastReply(WITHROTTLE_TYPE, F("PPA%c\n"), main?'1':'0');
 #endif
-
-  LCD(2,F("Power %S%S"),state=='1'?F("On"): ( state=='0'? F("Off") : F("SC") ),reason);
+  LCD(2,F("Power %S%S"),state=='1'?F("On"):F("Off"),reason);  
 }
 
-void CommandDistributor::broadcastRaw(clientType type, char * msg) {
-  broadcastReply(type, F("%s"),msg);
+void CommandDistributor::broadcastText(const FSH * msg) {
+  broadcastReply(COMMAND_TYPE, F("<I %S>\n"),msg);
+#ifdef CD_HANDLE_RING
+  broadcastReply(WITHROTTLE_TYPE, F("Hm%S\n"), msg);
+#endif
 }
-
-void CommandDistributor::broadcastTrackState(const FSH* format, byte trackLetter, const FSH *modename, int16_t dcAddr) {
-  broadcastReply(COMMAND_TYPE, format, trackLetter, modename, dcAddr);
-}
-
-void  CommandDistributor::broadcastRouteState(uint16_t routeId, byte state ) {
-  broadcastReply(COMMAND_TYPE, F("<jB %d %d>\n"),routeId,state);
-}
-
-void  CommandDistributor::broadcastRouteCaption(uint16_t routeId, const FSH* caption ) {
-  broadcastReply(COMMAND_TYPE, F("<jB %d \"%S\">\n"),routeId,caption);
-}
-
-Print * CommandDistributor::getVirtualLCDSerial(byte screen, byte row) {
-  Print * stream=virtualLCDSerial;
-  #ifdef  CD_HANDLE_RING
-  rememberVLCDClient=RingStream::NO_CLIENT;
-  if (!stream && virtualLCDClient!=RingStream::NO_CLIENT) {
-    // If we are broadcasting from a wifi/eth process we need to complete its output
-    // before merging broadcasts in the ring, then reinstate it in case
-    // the process continues to output to its client.
-    if ((rememberVLCDClient = ring->peekTargetMark()) != RingStream::NO_CLIENT) {
-      ring->commit();
-    }
-    ring->mark(virtualLCDClient);   
-    stream=ring; 
-  }
-  #endif
-  if (stream) StringFormatter::send(stream,F("<@ %d %d \""), screen,row);
-  return stream;  
-}
-
-void CommandDistributor::commitVirtualLCDSerial() {
-  #ifdef  CD_HANDLE_RING
-  if (virtualLCDClient!=RingStream::NO_CLIENT) {
-    StringFormatter::send(ring,F("\">\n"));
-    ring->commit();
-    if (rememberVLCDClient!=RingStream::NO_CLIENT) ring->mark(rememberVLCDClient);
-    return;  
-   }
-  #endif
-  StringFormatter::send(virtualLCDSerial,F("\">\n"));  
-}
-
-void CommandDistributor::setVirtualLCDSerial(Print * stream) {
-  #ifdef  CD_HANDLE_RING
-  virtualLCDClient=RingStream::NO_CLIENT;
-  if (stream && stream->availableForWrite()==RingStream::THIS_IS_A_RINGSTREAM) {
-     virtualLCDClient=((RingStream *) stream)->peekTargetMark();
-     virtualLCDSerial=nullptr;
-     return;
-  }      
-    #endif
-  virtualLCDSerial=stream;
-}
-
-Print* CommandDistributor::virtualLCDSerial=&USB_SERIAL;
-byte CommandDistributor::virtualLCDClient=0xFF;
-byte CommandDistributor::rememberVLCDClient=0;
-

CommandDistributor.h

@@ -2,8 +2,6 @@
  *  © 2022 Harald Barth
  *  © 2020-2021 Chris Harlow
  *  © 2020 Gregor Baues
- *  © 2022 Colin Murdoch
- * 
  *  All rights reserved.
  *
  *  This file is part of CommandStation-EX
@@ -35,9 +33,8 @@
 #endif 
 
 class CommandDistributor {
-public:
-  enum clientType: byte {NONE_TYPE,COMMAND_TYPE,WITHROTTLE_TYPE};
 private:
+  enum clientType: byte {NONE_TYPE,COMMAND_TYPE,WITHROTTLE_TYPE};
   static void broadcastToClients(clientType type);
   static StringBuffer * broadcastBufferWriter;
   #ifdef CD_HANDLE_RING
@@ -49,26 +46,14 @@ public :
   static void broadcastLoco(byte slot);
   static void broadcastSensor(int16_t id, bool value);
   static void broadcastTurnout(int16_t id, bool isClosed);
-  static void broadcastTurntable(int16_t id, uint8_t position, bool moving);
   static void broadcastClockTime(int16_t time, int8_t rate);
   static void setClockTime(int16_t time, int8_t rate, byte opt);
   static int16_t retClockTime();
   static void broadcastPower();
-  static void broadcastRaw(clientType type,char * msg);
-  static void broadcastTrackState(const FSH* format,byte trackLetter, const FSH* modename, int16_t dcAddr);
+  static void broadcastText(const FSH * msg);
   template<typename... Targs> static void broadcastReply(clientType type, Targs... msg);
   static void forget(byte clientId);
-  static void broadcastRouteState(uint16_t routeId,byte state);
-  static void broadcastRouteCaption(uint16_t routeId,const FSH * caption);
   
-  // Handling code for virtual LCD receiver.
-  static Print * getVirtualLCDSerial(byte screen, byte row);
-  static void commitVirtualLCDSerial();
-  static void setVirtualLCDSerial(Print * stream); 
-  private:
-    static Print * virtualLCDSerial;
-    static byte virtualLCDClient;
-    static byte rememberVLCDClient;
 };
 
 #endif

CommandStation-EX.ino

@@ -30,7 +30,6 @@
  *  © 2021 Neil McKechnie
  *  © 2020-2021 Chris Harlow, Harald Barth, David Cutting,
  *  Fred Decker, Gregor Baues, Anthony W - Dayton
- *  © 2023 Nathan Kellenicki
  *  All rights reserved.
  *
  *  This file is part of CommandStation-EX
@@ -50,7 +49,6 @@
  */
 
 #include "DCCEX.h"
-#include "Display_Implementation.h"
 
 #ifdef CPU_TYPE_ERROR
 #error CANNOT COMPILE - DCC++ EX ONLY WORKS WITH THE ARCHITECTURES LISTED IN defines.h
@@ -76,45 +74,40 @@ void setup()
 
   DIAG(F("License GPLv3 fsf.org (c) dcc-ex.com"));
 
-// If user has defined a startup delay, delay here before starting IO
-#if defined(STARTUP_DELAY)
-  DIAG(F("Delaying startup for %dms"), STARTUP_DELAY);
-  delay(STARTUP_DELAY);
-#endif
-
-// Initialise HAL layer before reading EEprom or setting up MotorDrivers 
-  IODevice::begin();
-
-  // As the setup of a motor shield may require a read of the current sense input from the ADC,
-  // let's make sure to initialise the ADCee class!
-  ADCee::begin();
-  // Set up MotorDrivers early to initialize all pins
-  TrackManager::Setup(MOTOR_SHIELD_TYPE);
-
-  DISPLAY_START (
-    // This block is still executed for DIAGS if display not in use
-    LCD(0,F("DCC-EX v" VERSION));
+  CONDITIONAL_LCD_START {
+    // This block is still executed for DIAGS if LCD not in use
+    LCD(0,F("DCC++ EX v%S"),F(VERSION));
     LCD(1,F("Lic GPLv3"));
-  );
+  }
 
   // Responsibility 2: Start all the communications before the DCC engine
   // Start the WiFi interface on a MEGA, Uno cannot currently handle WiFi
   // Start Ethernet if it exists
 #ifndef ARDUINO_ARCH_ESP32
 #if WIFI_ON
-  WifiInterface::setup(WIFI_SERIAL_LINK_SPEED, F(WIFI_SSID), F(WIFI_PASSWORD), F(WIFI_HOSTNAME), IP_PORT, WIFI_CHANNEL, WIFI_FORCE_AP);
+  WifiInterface::setup(WIFI_SERIAL_LINK_SPEED, F(WIFI_SSID), F(WIFI_PASSWORD), F(WIFI_HOSTNAME), IP_PORT, WIFI_CHANNEL);
 #endif // WIFI_ON
 #else
   // ESP32 needs wifi on always
-  WifiESP::setup(WIFI_SSID, WIFI_PASSWORD, WIFI_HOSTNAME, IP_PORT, WIFI_CHANNEL, WIFI_FORCE_AP);
+  WifiESP::setup(WIFI_SSID, WIFI_PASSWORD, WIFI_HOSTNAME, IP_PORT, WIFI_CHANNEL);
 #endif // ARDUINO_ARCH_ESP32
 
 #if ETHERNET_ON
   EthernetInterface::setup();
 #endif // ETHERNET_ON
-  
+
+  // Initialise HAL layer before reading EEprom or setting up MotorDrivers 
+  IODevice::begin();
+
+  // As the setup of a motor shield may require a read of the current sense input from the ADC,
+  // let's make sure to initialise the ADCee class!
+  ADCee::begin();
   // Responsibility 3: Start the DCC engine.
-  DCC::begin();
+  // Note: this provides DCC with two motor drivers, main and prog, which handle the motor shield(s)
+  // Standard supported devices have pre-configured macros but custome hardware installations require
+  //  detailed pin mappings and may also require modified subclasses of the MotorDriver to implement specialist logic.
+  // STANDARD_MOTOR_SHIELD, POLOLU_MOTOR_SHIELD, FIREBOX_MK1, FIREBOX_MK1S are pre defined in MotorShields.h
+  TrackManager::Setup(MOTOR_SHIELD_TYPE);
 
   // Start RMFT aka EX-RAIL (ignored if no automnation)
   RMFT::begin();
@@ -167,8 +160,7 @@ void loop()
   LCN::loop();
   #endif
 
-  // Display refresh
-  DisplayInterface::loop();
+  LCDDisplay::loop();  // ignored if LCD not in use
 
   // Handle/update IO devices.
   IODevice::loop();

DCC.cpp

@@ -60,7 +60,8 @@ const byte FN_GROUP_5=0x10;
 FSH* DCC::shieldName=NULL;
 byte DCC::globalSpeedsteps=128;
 
-void DCC::begin() {
+void DCC::begin(const FSH * motorShieldName) {
+  shieldName=(FSH *)motorShieldName;
   StringFormatter::send(&USB_SERIAL,F("<iDCC-EX V-%S / %S / %S G-%S>\n"), F(VERSION), F(ARDUINO_TYPE), shieldName, F(GITHUB_SHA));
 #ifndef DISABLE_EEPROM
   // Load stuff from EEprom
@@ -122,7 +123,7 @@ void DCC::setThrottle2( uint16_t cab, byte speedCode)  {
   DCCWaveform::mainTrack.schedulePacket(b, nB, 0);
 }
 
-void DCC::setFunctionInternal(int cab, byte byte1, byte byte2, byte count) {
+void DCC::setFunctionInternal(int cab, byte byte1, byte byte2) {
   // DIAG(F("setFunctionInternal %d %x %x"),cab,byte1,byte2);
   byte b[4];
   byte nB = 0;
@@ -133,7 +134,7 @@ void DCC::setFunctionInternal(int cab, byte byte1, byte byte2, byte count) {
   if (byte1!=0) b[nB++] = byte1;
   b[nB++] = byte2;
 
-  DCCWaveform::mainTrack.schedulePacket(b, nB, count);
+  DCCWaveform::mainTrack.schedulePacket(b, nB, 0);
 }
 
 // returns speed steps 0 to 127 (1 == emergency stop)
@@ -575,11 +576,9 @@ void DCC::setLocoId(int id,ACK_CALLBACK callback) {
 
 void DCC::forgetLoco(int cab) {  // removes any speed reminders for this loco
   setThrottle2(cab,1); // ESTOP this loco if still on track
-  int reg=lookupSpeedTable(cab, false);
-  if (reg>=0) {
-    speedTable[reg].loco=0;
-    setThrottle2(cab,1); // ESTOP if this loco still on track
-  }
+  int reg=lookupSpeedTable(cab);
+  if (reg>=0) speedTable[reg].loco=0;
+  setThrottle2(cab,1); // ESTOP if this loco still on track
 }
 void DCC::forgetAllLocos() {  // removes all speed reminders
   setThrottle2(0,1); // ESTOP all locos still on track
@@ -595,7 +594,7 @@ void DCC::loop()  {
 
 void DCC::issueReminders() {
   // if the main track transmitter still has a pending packet, skip this time around.
-  if (!DCCWaveform::mainTrack.isReminderWindowOpen()) return;
+  if ( DCCWaveform::mainTrack.getPacketPending()) return;
   // Move to next loco slot.  If occupied, send a reminder.
   int reg = lastLocoReminder+1;
   if (reg > highestUsedReg) reg = 0;  // Go to start of table
@@ -619,39 +618,24 @@ bool DCC::issueReminder(int reg) {
          break;
        case 1: // remind function group 1 (F0-F4)
           if (flags & FN_GROUP_1)
-#ifndef DISABLE_FUNCTION_REMINDERS
-	    setFunctionInternal(loco,0, 128 | ((functions>>1)& 0x0F) | ((functions & 0x01)<<4),0); // 100D DDDD
-#else
-	    setFunctionInternal(loco,0, 128 | ((functions>>1)& 0x0F) | ((functions & 0x01)<<4),2);
-          flags&= ~FN_GROUP_1;  // dont send them again
-#endif
+              setFunctionInternal(loco,0, 128 | ((functions>>1)& 0x0F) | ((functions & 0x01)<<4)); // 100D DDDD
           break;
        case 2: // remind function group 2 F5-F8
           if (flags & FN_GROUP_2)
-#ifndef DISABLE_FUNCTION_REMINDERS
-  	    setFunctionInternal(loco,0, 176 | ((functions>>5)& 0x0F),0);                           // 1011 DDDD
-#else
-	    setFunctionInternal(loco,0, 176 | ((functions>>5)& 0x0F),2);
-          flags&= ~FN_GROUP_2;  // dont send them again
-#endif
+              setFunctionInternal(loco,0, 176 | ((functions>>5)& 0x0F));                           // 1011 DDDD
           break;
        case 3: // remind function group 3 F9-F12
           if (flags & FN_GROUP_3)
-#ifndef DISABLE_FUNCTION_REMINDERS
-	    setFunctionInternal(loco,0, 160 | ((functions>>9)& 0x0F),0);                           // 1010 DDDD
-#else
-	    setFunctionInternal(loco,0, 160 | ((functions>>9)& 0x0F),2);
-          flags&= ~FN_GROUP_3;  // dont send them again
-#endif
+              setFunctionInternal(loco,0, 160 | ((functions>>9)& 0x0F));                           // 1010 DDDD
           break;
        case 4: // remind function group 4 F13-F20
           if (flags & FN_GROUP_4)
-	    setFunctionInternal(loco,222, ((functions>>13)& 0xFF),2);
+              setFunctionInternal(loco,222, ((functions>>13)& 0xFF));
           flags&= ~FN_GROUP_4;  // dont send them again
           break;
        case 5: // remind function group 5 F21-F28
           if (flags & FN_GROUP_5)
-	    setFunctionInternal(loco,223, ((functions>>21)& 0xFF),2);
+              setFunctionInternal(loco,223, ((functions>>21)& 0xFF));
           flags&= ~FN_GROUP_5;  // dont send them again
           break;
       }
@@ -707,7 +691,7 @@ void  DCC::updateLocoReminder(int loco, byte speedCode) {
 
   if (loco==0) {
      // broadcast stop/estop but dont change direction
-     for (int reg = 0; reg <= highestUsedReg; reg++) {
+     for (int reg = 0; reg < highestUsedReg; reg++) {
        if (speedTable[reg].loco==0) continue;
        byte newspeed=(speedTable[reg].speedCode & 0x80) |  (speedCode & 0x7f);
        if (speedTable[reg].speedCode != newspeed) {

DCC.h

@@ -51,10 +51,7 @@ const byte MAX_LOCOS = 30;
 class DCC
 {
 public:
-  static inline void setShieldName(const FSH * motorShieldName) {
-    shieldName=(FSH *)motorShieldName;
-  };
-  static void begin();
+  static void begin(const FSH * motorShieldName);
   static void loop();
 
   // Public DCC API functions
@@ -109,7 +106,7 @@ private:
   static byte loopStatus;
   static void setThrottle2(uint16_t cab, uint8_t speedCode);
   static void updateLocoReminder(int loco, byte speedCode);
-  static void setFunctionInternal(int cab, byte fByte, byte eByte, byte count);
+  static void setFunctionInternal(int cab, byte fByte, byte eByte);
   static bool issueReminder(int reg);
   static int lastLocoReminder;
   static int highestUsedReg;

DCCACK.cpp

@@ -152,7 +152,7 @@ byte DCCACK::getAck() {
       return(0);  // pending set off but not detected means no ACK.   
 }
 
-#ifndef DISABLE_PROG
+
 void DCCACK::loop() {
   while (ackManagerProg) {
     byte opcode=GETFLASH(ackManagerProg);
@@ -351,7 +351,7 @@ void DCCACK::callback(int value) {
 
     switch (callbackState) {
       case AFTER_READ:
-         if (ackManagerRejoin && !autoPowerOff) {
+         if (ackManagerRejoin && autoPowerOff) {
                 progDriver->setPower(POWERMODE::OFF);
                 callbackStart=millis();
                 callbackState=WAITING_30;
@@ -414,7 +414,7 @@ void DCCACK::callback(int value) {
           (ackManagerCallback)( value);
     }
 }
-#endif
+
 
 void DCCACK::checkAck(byte sentResetsSincePacket) {
     if (!ackPending) return; 

DCCEX.h

@@ -40,7 +40,7 @@
 #if ETHERNET_ON == true
 #include "EthernetInterface.h"
 #endif
-#include "Display_Implementation.h"
+#include "LCD_Implementation.h"
 #include "LCN.h"
 #include "IODevice.h"
 #include "Turnouts.h"
@@ -49,7 +49,6 @@
 #include "CommandDistributor.h"
 #include "TrackManager.h"
 #include "DCCTimer.h"    
-#include "KeywordHasher.h"
 #include "EXRAIL.h"
     
 #endif

DCCEXParser.cpp

@@ -3,11 +3,10 @@
  *  © 2021 Neil McKechnie
  *  © 2021 Mike S
  *  © 2021 Herb Morton
- *  © 2020-2023 Harald Barth
+ *  © 2020-2022 Harald Barth
  *  © 2020-2021 M Steve Todd
  *  © 2020-2021 Fred Decker
  *  © 2020-2021 Chris Harlow
- *  © 2022 Colin Murdoch
  *  All rights reserved.
  *  
  *  This file is part of CommandStation-EX
@@ -25,79 +24,6 @@
  *  You should have received a copy of the GNU General Public License
  *  along with CommandStation.  If not, see <https://www.gnu.org/licenses/>.
  */
-
-/*
-List of single character OPCODEs in use for reference.
-
-When determining a new OPCODE for a new feature, refer to this list as the source of truth.
-
-Once a new OPCODE is decided upon, update this list.
-
-  Character, Usage
-  /, |EX-R| interactive commands
-  -, Remove from reminder table
-  =, |TM| configuration
-  !, Emergency stop
-  @, Reserved for future use - LCD messages to JMRI
-  #, Request number of supported cabs/locos; heartbeat
-  +, WiFi AT commands
-  ?, Reserved for future use
-  0, Track power off
-  1, Track power on
-  a, DCC accessory control
-  A,
-  b, Write CV bit on main
-  B, Write CV bit
-  c, Request current command
-  C, configure the CS
-  d,
-  D, Diagnostic commands
-  e, Erase EEPROM
-  E, Store configuration in EEPROM
-  f, Loco decoder function control (deprecated)
-  F, Loco decoder function control
-  g,
-  G,
-  h,
-  H, Turnout state broadcast
-  i, Server details string
-  I, Turntable object command, control, and broadcast
-  j, Throttle responses
-  J, Throttle queries
-  k, Reserved for future use - Potentially Railcom
-  K, Reserved for future use - Potentially Railcom
-  l, Loco speedbyte/function map broadcast
-  L, Reserved for LCC interface (implemented in EXRAIL)
-  m,
-  M, Write DCC packet
-  n,
-  N,
-  o,
-  O, Output broadcast
-  p, Broadcast power state
-  P, Write DCC packet
-  q, Sensor deactivated
-  Q, Sensor activated
-  r, Broadcast address read on programming track
-  R, Read CVs
-  s, Display status
-  S, Sensor configuration
-  t, Cab/loco update command
-  T, Turnout configuration/control
-  u, Reserved for user commands
-  U, Reserved for user commands
-  v,
-  V, Verify CVs
-  w, Write CV on main
-  W, Write CV
-  x,
-  X, Invalid command
-  y,
-  Y, Output broadcast
-  z,
-  Z, Output configuration/control
-*/
-
 #include "StringFormatter.h"
 #include "DCCEXParser.h"
 #include "DCC.h"
@@ -114,19 +40,57 @@ Once a new OPCODE is decided upon, update this list.
 #include "TrackManager.h"
 #include "DCCTimer.h"
 #include "EXRAIL2.h"
-#include "Turntables.h"
-#include "version.h"
-#include "KeywordHasher.h"
 
 // This macro can't be created easily as a portable function because the
 // flashlist requires a far pointer for high flash access. 
 #define SENDFLASHLIST(stream,flashList)                 \
     for (int16_t i=0;;i+=sizeof(flashList[0])) {                            \
         int16_t value=GETHIGHFLASHW(flashList,i);       \
-        if (value==INT16_MAX) break;                            \
-        StringFormatter::send(stream,F(" %d"),value);	\
+        if (value==0) break;                            \
+        StringFormatter::send(stream,F(" %d"),value);   \
     }                                   
 
+
+// These keywords are used in the <1> command. The number is what you get if you use the keyword as a parameter.
+// To discover new keyword numbers , use the <$ YOURKEYWORD> command
+const int16_t HASH_KEYWORD_PROG = -29718;
+const int16_t HASH_KEYWORD_MAIN = 11339;
+const int16_t HASH_KEYWORD_JOIN = -30750;
+const int16_t HASH_KEYWORD_CABS = -11981;
+const int16_t HASH_KEYWORD_RAM = 25982;
+const int16_t HASH_KEYWORD_CMD = 9962;
+const int16_t HASH_KEYWORD_ACK = 3113;
+const int16_t HASH_KEYWORD_ON = 2657;
+const int16_t HASH_KEYWORD_DCC = 6436;
+const int16_t HASH_KEYWORD_SLOW = -17209;
+const int16_t HASH_KEYWORD_PROGBOOST = -6353;
+#ifndef DISABLE_EEPROM
+const int16_t HASH_KEYWORD_EEPROM = -7168;
+#endif
+const int16_t HASH_KEYWORD_LIMIT = 27413;
+const int16_t HASH_KEYWORD_MAX = 16244;
+const int16_t HASH_KEYWORD_MIN = 15978;
+const int16_t HASH_KEYWORD_RESET = 26133;
+const int16_t HASH_KEYWORD_RETRY = 25704;
+const int16_t HASH_KEYWORD_SPEED28 = -17064;
+const int16_t HASH_KEYWORD_SPEED128 = 25816;
+const int16_t HASH_KEYWORD_SERVO=27709;
+const int16_t HASH_KEYWORD_TT=2688;
+const int16_t HASH_KEYWORD_VPIN=-415;
+const int16_t HASH_KEYWORD_A='A';
+const int16_t HASH_KEYWORD_C='C';
+const int16_t HASH_KEYWORD_R='R';
+const int16_t HASH_KEYWORD_T='T';
+const int16_t HASH_KEYWORD_X='X';
+const int16_t HASH_KEYWORD_LCN = 15137;
+const int16_t HASH_KEYWORD_HAL = 10853;
+const int16_t HASH_KEYWORD_SHOW = -21309;
+const int16_t HASH_KEYWORD_ANIN = -10424;
+const int16_t HASH_KEYWORD_ANOUT = -26399;
+const int16_t HASH_KEYWORD_WIFI = -5583;
+const int16_t HASH_KEYWORD_ETHERNET = -30767;
+const int16_t HASH_KEYWORD_WIT = 31594;
+
 int16_t DCCEXParser::stashP[MAX_COMMAND_PARAMS];
 bool DCCEXParser::stashBusy;
 Print *DCCEXParser::stashStream = NULL;
@@ -162,10 +126,8 @@ int16_t DCCEXParser::splitValues(int16_t result[MAX_COMMAND_PARAMS], const byte
         case 1: // skipping spaces before a param
             if (hot == ' ')
                 break;
-            if (hot == '\0')
-	      return -1;
-	    if (hot == '>')
-	      return parameterCount;
+            if (hot == '\0' || hot == '>')
+                return parameterCount;
             state = 2;
             continue;
 
@@ -228,9 +190,9 @@ void DCCEXParser::setAtCommandCallback(AT_COMMAND_CALLBACK callback)
 // Parse an F() string 
 void DCCEXParser::parse(const FSH * cmd) {
       DIAG(F("SETUP(\"%S\")"),cmd);
-      int size=STRLEN_P((char *)cmd)+1; 
+      int size=strlen_P((char *)cmd)+1; 
       char buffer[size];
-      STRCPY_P(buffer,(char *)cmd);
+      strcpy_P(buffer,(char *)cmd);
       parse(&USB_SERIAL,(byte *)buffer,NULL);
 }
 
@@ -252,25 +214,17 @@ void DCCEXParser::parse(Print *stream,  byte *com,  RingStream *ringStream) {
 
 void DCCEXParser::parseOne(Print *stream, byte *com, RingStream * ringStream)
 {
-#ifdef DISABLE_PROG
-    (void)ringStream;
-#endif
 #ifndef DISABLE_EEPROM
     (void)EEPROM; // tell compiler not to warn this is unused
 #endif
-    byte params = 0;
     if (Diag::CMD)
         DIAG(F("PARSING:%s"), com);
     int16_t p[MAX_COMMAND_PARAMS];
     while (com[0] == '<' || com[0] == ' ')
         com++; // strip off any number of < or spaces
     byte opcode = com[0];
-    int16_t splitnum = splitValues(p, com, opcode=='M' || opcode=='P');
-    if (splitnum < 0 || splitnum >= MAX_COMMAND_PARAMS) // if arguments are broken, leave but via printing <X>
-      goto out;
-    // Because of check above we are now inside byte size
-    params = splitnum;
-
+    byte params = splitValues(p, com, opcode=='M' || opcode=='P');
+    
     if (filterCallback)
         filterCallback(stream, opcode, params, p);
     if (filterRMFTCallback && opcode!='\0')
@@ -329,8 +283,6 @@ void DCCEXParser::parseOne(Print *stream, byte *com, RingStream * ringStream)
 
         if (direction < 0 || direction > 1)
             break; // invalid direction code
-	if (cab > 10239 || cab < 0)
-	    break; // beyond DCC range
 
         DCC::setThrottle(cab, tspeed, direction);
         if (params == 4) // send obsolete format T response
@@ -390,20 +342,6 @@ void DCCEXParser::parseOne(Print *stream, byte *com, RingStream * ringStream)
             return;
         break;
 
-    case 'z':  // direct pin manipulation
-        if (p[0]==0) break; 
-        if (params==1) {  // <z vpin | -vpin> 
-            if (p[0]>0) IODevice::write(p[0],HIGH);
-            else IODevice::write(-p[0],LOW);
-            return;
-        }
-        if (params>=2 && params<=4) { // <z vpin ana;og profile duration> 
-            // unused params default to 0           
-            IODevice::writeAnalogue(p[0],p[1],p[2],p[3]);
-            return;
-        }
-        break; 
-
     case 'Z': // OUTPUT <Z ...>
         if (parseZ(stream, params, p))
             return;
@@ -414,24 +352,16 @@ void DCCEXParser::parseOne(Print *stream, byte *com, RingStream * ringStream)
             return;
         break;
 
-#ifndef DISABLE_PROG
     case 'w': // WRITE CV on MAIN <w CAB CV VALUE>
-      if (params != 3)
-	break;
-      DCC::writeCVByteMain(p[0], p[1], p[2]);
-      return;
+        DCC::writeCVByteMain(p[0], p[1], p[2]);
+        return;
 
     case 'b': // WRITE CV BIT ON MAIN <b CAB CV BIT VALUE>
-      if (params != 4)
-	break;
-      DCC::writeCVBitMain(p[0], p[1], p[2], p[3]);
-      return;
-#endif
+        DCC::writeCVBitMain(p[0], p[1], p[2], p[3]);
+        return;
 
     case 'M': // WRITE TRANSPARENT DCC PACKET MAIN <M REG X1 ... X9>
-#ifndef DISABLE_PROG
     case 'P': // WRITE TRANSPARENT DCC PACKET PROG <P REG X1 ... X9>
-#endif
         // NOTE: this command was parsed in HEX instead of decimal
         params--; // drop REG
         if (params<1) break;
@@ -446,18 +376,15 @@ void DCCEXParser::parseOne(Print *stream, byte *com, RingStream * ringStream)
         }
         return;
         
-#ifndef DISABLE_PROG
     case 'W': // WRITE CV ON PROG <W CV VALUE CALLBACKNUM CALLBACKSUB>
-        if (!stashCallback(stream, p, ringStream))
-	    break;
+            if (!stashCallback(stream, p, ringStream))
+                break;
         if (params == 1) // <W id> Write new loco id (clearing consist and managing short/long)
             DCC::setLocoId(p[0],callback_Wloco);
         else if (params == 4)  // WRITE CV ON PROG <W CV VALUE [CALLBACKNUM] [CALLBACKSUB]>
             DCC::writeCVByte(p[0], p[1], callback_W4);
-        else if (params == 2)  // WRITE CV ON PROG <W CV VALUE>
+        else  // WRITE CV ON PROG <W CV VALUE>
             DCC::writeCVByte(p[0], p[1], callback_W);
-	else
-            break;
         return;
 
     case 'V': // VERIFY CV ON PROG <V CV VALUE> <V CV BIT 0|1>
@@ -477,11 +404,9 @@ void DCCEXParser::parseOne(Print *stream, byte *com, RingStream * ringStream)
         }
         break;
 
-    case 'B': // WRITE CV BIT ON PROG  <B CV BIT VALUE CALLBACKNUM CALLBACKSUB> or <B CV BIT VALUE>
-        if (params != 3 && params != 5)
-	  break;
+    case 'B': // WRITE CV BIT ON PROG <B CV BIT VALUE CALLBACKNUM CALLBACKSUB>
         if (!stashCallback(stream, p, ringStream))
-	  break;
+            break;
         DCC::writeCVBit(p[0], p[1], p[2], callback_B);
         return;
 
@@ -508,88 +433,88 @@ void DCCEXParser::parseOne(Print *stream, byte *com, RingStream * ringStream)
             return;
         }
         break;
-#endif
 
     case '1': // POWERON <1   [MAIN|PROG|JOIN]>
         {
-	  if (params > 1) break;
-	  if (params==0) { // All
-	    TrackManager::setTrackPower(TRACK_MODE_ALL, POWERMODE::ON);
+        bool main=false;
+        bool prog=false;
+        bool join=false;
+        if (params > 1) break;
+        if (params==0 || MotorDriver::commonFaultPin) { // <1> or tracks can not be handled individually
+            main=true;
+            prog=true;
+        }
+	if (params==1) {
+	  if (p[0] == HASH_KEYWORD_JOIN) {  // <1 JOIN>
+            main=true;
+            prog=true;
+            join=true;
 	  }
-	  if (params==1) {
-	    if (p[0]=="MAIN"_hk) { // <1 MAIN>
-	      TrackManager::setTrackPower(TRACK_MODE_MAIN, POWERMODE::ON);
-            }
-#ifndef DISABLE_PROG
-            else if (p[0] == "JOIN"_hk) {  // <1 JOIN>
-	      TrackManager::setJoin(true);
-	      TrackManager::setTrackPower(TRACK_MODE_MAIN|TRACK_MODE_PROG, POWERMODE::ON);
-            }
-            else if (p[0]=="PROG"_hk) { // <1 PROG>
-	      TrackManager::setJoin(false);
-	      TrackManager::setTrackPower(TRACK_MODE_PROG, POWERMODE::ON);
-            }
-#endif
-            else if (p[0] >= "A"_hk && p[0] <= "H"_hk) { // <1 A-H>
-	      byte t = (p[0] - 'A');
-	      TrackManager::setTrackPower(POWERMODE::ON, t);
-	      //StringFormatter::send(stream, F("<p1 %c>\n"), t+'A');
-            }
-	    else break; // will reply <X>
+	  else if (p[0]==HASH_KEYWORD_MAIN) { // <1 MAIN>
+            main=true;
 	  }
-	  //TrackManager::streamTrackState(NULL,t);
-          
-	  return;
+	  else if (p[0]==HASH_KEYWORD_PROG) { // <1 PROG>
+            prog=true;
+	  }
+	  else break; // will reply <X>
 	}
-            
+        if (main) TrackManager::setMainPower(POWERMODE::ON);
+        if (prog) TrackManager::setProgPower(POWERMODE::ON);
+        TrackManager::setJoin(join);
+
+        CommandDistributor::broadcastPower();
+        return;
+        }
+
     case '0': // POWEROFF <0 [MAIN | PROG] >
         {
-	  if (params > 1) break;
-	  if (params==0) { // All
-	    TrackManager::setJoin(false);
-	    TrackManager::setTrackPower(TRACK_MODE_ALL, POWERMODE::OFF);
+        bool main=false;
+        bool prog=false;
+        if (params > 1) break;
+        if (params==0 || MotorDriver::commonFaultPin) { // <0> or tracks can not be handled individually
+	  main=true;
+	  prog=true;
+        }
+	if (params==1) {
+	  if (p[0]==HASH_KEYWORD_MAIN) { // <0 MAIN>
+	    main=true;
 	  }
-	  if (params==1) {
-	    if (p[0]=="MAIN"_hk) { // <0 MAIN>
-	      TrackManager::setJoin(false);
-	      TrackManager::setTrackPower(TRACK_MODE_MAIN, POWERMODE::OFF);
-	    }
-#ifndef DISABLE_PROG
-            else if (p[0]=="PROG"_hk) { // <0 PROG>
-	      TrackManager::progTrackBoosted=false;  // Prog track boost mode will not outlive prog track off
-	      TrackManager::setTrackPower(TRACK_MODE_PROG, POWERMODE::OFF);
-            }
-#endif
-	    else if (p[0] >= "A"_hk && p[0] <= "H"_hk) { // <1 A-H>
-	      byte t = (p[0] - 'A');
-	      TrackManager::setJoin(false);
-	      TrackManager::setTrackPower(POWERMODE::OFF, t);
-	      //StringFormatter::send(stream, F("<p0 %c>\n"), t+'A');
-	    }
-	    else break; // will reply <X>
+	  else if (p[0]==HASH_KEYWORD_PROG) { // <0 PROG>
+	    prog=true;
 	  }
-	  return;
+	  else break; // will reply <X>
 	}
 
+        if (main) TrackManager::setMainPower(POWERMODE::OFF);
+        if (prog) {
+            TrackManager::progTrackBoosted=false;  // Prog track boost mode will not outlive prog track off
+            TrackManager::setProgPower(POWERMODE::OFF);
+        }
+        TrackManager::setJoin(false);
+
+        CommandDistributor::broadcastPower();
+        return;
+        }
+
     case '!': // ESTOP ALL  <!>
         DCC::setThrottle(0,1,1); // this broadcasts speed 1(estop) and sets all reminders to speed 1.
         return;
 
     case 'c': // SEND METER RESPONSES <c>
-        // No longer useful because of multiple tracks See <JG> and <JI>
-        if (params>0) break;
-        TrackManager::reportObsoleteCurrent(stream);
-        return;
+        // No longer supported because of multiple tracks                               <c MeterName value C/V unit min max res warn>
+        break;
 
     case 'Q': // SENSORS <Q>
         Sensor::printAll(stream);
         return;
 
-    case 's': // STATUS <s>
+    case 's': // <s>
         StringFormatter::send(stream, F("<iDCC-EX V-%S / %S / %S G-%S>\n"), F(VERSION), F(ARDUINO_TYPE), DCC::getMotorShieldName(), F(GITHUB_SHA));
         CommandDistributor::broadcastPower(); // <s> is the only "get power status" command we have
         Turnout::printAll(stream); //send all Turnout states
+        Output::printAll(stream);  //send all Output  states
         Sensor::printAll(stream);  //send all Sensor  states
+        // TODO Send stats of  speed reminders table
         return;       
 
 #ifndef DISABLE_EEPROM
@@ -606,18 +531,14 @@ void DCCEXParser::parseOne(Print *stream, byte *com, RingStream * ringStream)
     case ' ': // < >
         StringFormatter::send(stream, F("\n"));
         return;
-    case 'C': // CONFIG <C [params]>
-        if (parseC(stream, params, p))
-            return;
-        break;
-#ifndef DISABLE_DIAG
-    case 'D': // DIAG <D [params]>
+
+    case 'D': // < >
         if (parseD(stream, params, p))
             return;
-        break;
-#endif
-    case '=': // TRACK MANAGER CONTROL <= [params]>
-        if (TrackManager::parseEqualSign(stream, params, p))
+        return;
+
+    case '=': // <= Track manager control  >
+        if (TrackManager::parseJ(stream, params, p))
             return;
         break;
 
@@ -654,7 +575,7 @@ void DCCEXParser::parseOne(Print *stream, byte *com, RingStream * ringStream)
             //if ((params<1) | (params>2)) break; // <J>
             int16_t id=(params==2)?p[1]:0;
             switch(p[0]) {
-                case "C"_hk: // <JC mmmm nn> sets time and speed
+                case HASH_KEYWORD_C: // <JC mmmm nn> sets time and speed
                     if (params==1) { // <JC> returns latest time
                         int16_t x = CommandDistributor::retClockTime();
                         StringFormatter::send(stream, F("<jC %d>\n"), x);
@@ -662,48 +583,40 @@ void DCCEXParser::parseOne(Print *stream, byte *com, RingStream * ringStream)
                     }
                     CommandDistributor::setClockTime(p[1], p[2], 1);
                     return;
-                
-                case "G"_hk: // <JG> current gauge limits
-                    if (params>1) break;
-                    TrackManager::reportGauges(stream);   // <g limit...limit>     
-                    return;
-                
-                case "I"_hk: // <JI> current values
-                    if (params>1) break;
-                    TrackManager::reportCurrent(stream);   // <g limit...limit>     
-                    return;
 
-                case "A"_hk: // <JA> intercepted by EXRAIL// <JA> returns automations/routes
-                    if (params!=1) break; // <JA>
-                    StringFormatter::send(stream, F("<jA>\n"));
-                    return;
- 
-                case "M"_hk: // <JM> intercepted by EXRAIL
-                    if (params>1) break; // invalid cant do
-                    // <JM> requests stash size so say none.
-                    StringFormatter::send(stream,F("<jM 0>\n")); 
-                    return;
- 
-            case "R"_hk: // <JR> returns rosters 
+                case HASH_KEYWORD_A: // <JA> returns automations/routes
+                    StringFormatter::send(stream, F("<jA"));
+                    if (params==1) {// <JA>
+#ifdef EXRAIL_ACTIVE
+                        SENDFLASHLIST(stream,RMFT2::routeIdList)
+                        SENDFLASHLIST(stream,RMFT2::automationIdList)
+#endif
+                    }
+                    else {  // <JA id>
+                        StringFormatter::send(stream,F(" %d %c \"%S\""), 
+                                        id, 
+#ifdef EXRAIL_ACTIVE
+                                        RMFT2::getRouteType(id), // A/R
+                                        RMFT2::getRouteDescription(id)
+#else  
+                                        'X',F("")
+#endif                                        
+                                        );
+                    }
+                    StringFormatter::send(stream, F(">\n"));      
+                    return; 
+            case HASH_KEYWORD_R: // <JR> returns rosters 
                 StringFormatter::send(stream, F("<jR"));
 #ifdef EXRAIL_ACTIVE
                 if (params==1) {
                     SENDFLASHLIST(stream,RMFT2::rosterIdList)
                 }
-                else {
-                    auto rosterName= RMFT2::getRosterName(id);
-                    if (!rosterName) rosterName=F("");
-
-                    auto functionNames= RMFT2::getRosterFunctions(id);
-                    if (!functionNames) functionNames=RMFT2::getRosterFunctions(0);
-                    if (!functionNames) functionNames=F("");
-                    StringFormatter::send(stream,F(" %d \"%S\" \"%S\""), 
-					                            id, rosterName, functionNames);
-                }
+                else StringFormatter::send(stream,F(" %d \"%S\" \"%S\""), 
+                    id, RMFT2::getRosterName(id), RMFT2::getRosterFunctions(id));
 #endif          
                 StringFormatter::send(stream, F(">\n"));      
                 return; 
-            case "T"_hk: // <JT> returns turnout list 
+            case HASH_KEYWORD_T: // <JT> returns turnout list 
                 StringFormatter::send(stream, F("<jT"));
                 if (params==1) { // <JT>
                     for ( Turnout * t=Turnout::first(); t; t=t->next()) { 
@@ -728,94 +641,20 @@ void DCCEXParser::parseOne(Print *stream, byte *com, RingStream * ringStream)
                 }
                 StringFormatter::send(stream, F(">\n"));
                 return;
-// No turntables without HAL support
-#ifndef IO_NO_HAL
-            case "O"_hk: // <JO returns turntable list
-                StringFormatter::send(stream, F("<jO"));
-                if (params==1) { // <JO>
-                    for (Turntable * tto=Turntable::first(); tto; tto=tto->next()) { 
-                        if (tto->isHidden()) continue;          
-                        StringFormatter::send(stream, F(" %d"),tto->getId());
-                    }
-                    StringFormatter::send(stream, F(">\n"));
-                } else {    // <JO id>
-                    Turntable *tto=Turntable::get(id);
-                    if (!tto || tto->isHidden()) {
-                        StringFormatter::send(stream, F(" %d X>\n"), id);
-                    } else {
-                        uint8_t pos = tto->getPosition();
-                        uint8_t type = tto->isEXTT();
-                        uint8_t posCount = tto->getPositionCount();
-                        const FSH *todesc = NULL;
-#ifdef EXRAIL_ACTIVE
-                        todesc = RMFT2::getTurntableDescription(id);
-#endif
-                        if (todesc == NULL) todesc = F("");
-                        StringFormatter::send(stream, F(" %d %d %d %d \"%S\">\n"), id, type, pos, posCount, todesc);
-                    }
-                }
-                return;
-            case "P"_hk: // <JP id> returns turntable position list for the turntable id
-                if (params==2) { // <JP id>
-                    Turntable *tto=Turntable::get(id);
-                    if (!tto || tto->isHidden()) {
-                        StringFormatter::send(stream, F(" %d X>\n"), id);
-                    } else {
-                        uint8_t posCount = tto->getPositionCount();
-                        const FSH *tpdesc = NULL;
-                        for (uint8_t p = 0; p < posCount; p++) {
-                            StringFormatter::send(stream, F("<jP"));
-                            int16_t angle = tto->getPositionAngle(p);
-#ifdef EXRAIL_ACTIVE
-                            tpdesc = RMFT2::getTurntablePositionDescription(id, p);
-#endif
-                            if (tpdesc == NULL) tpdesc = F("");
-                            StringFormatter::send(stream, F(" %d %d %d \"%S\""), id, p, angle, tpdesc);
-                            StringFormatter::send(stream, F(">\n"));
-                        }
-                    }
-                } else {
-                    StringFormatter::send(stream, F("<jP X>\n"));
-                }
-                return;
-#endif
             default: break;    
             }  // switch(p[1])
         break; // case J
         }
 
-// No turntables without HAL support
-#ifndef IO_NO_HAL
-    case 'I': // TURNTABLE  <I ...>
-        if (parseI(stream, params, p))
-            return;
-        break;
-#endif
-
-    case 'L': // LCC interface implemented in EXRAIL parser
-        break; // Will <X> if not intercepted by EXRAIL 
-
-#ifndef DISABLE_VDPY
-    case '@': // JMRI saying "give me virtual LCD msgs"
-        CommandDistributor::setVirtualLCDSerial(stream);
-        StringFormatter::send(stream,
-            F("<@ 0 0 \"DCC-EX v" VERSION "\">\n"
-               "<@ 0 1 \"Lic GPLv3\">\n"));
-        return; 
-#endif
     default: //anything else will diagnose and drop out to <X>
-      if (opcode >= ' ' && opcode <= '~') {
         DIAG(F("Opcode=%c params=%d"), opcode, params);
         for (int i = 0; i < params; i++)
             DIAG(F("p[%d]=%d (0x%x)"), i, p[i], p[i]);
-      } else {
-	DIAG(F("Unprintable %x"), opcode);
-      }
-      break;
+        break;
 
     } // end of opcode switch
 
-out:// Any fallout here sends an <X>
+    // Any fallout here sends an <X>
     StringFormatter::send(stream, F("<X>\n"));
 }
 
@@ -922,14 +761,14 @@ bool DCCEXParser::parseT(Print *stream, int16_t params, int16_t p[])
           switch (p[1]) {
             // Turnout messages use 1=throw, 0=close.
             case 0:
-            case "C"_hk:
+            case HASH_KEYWORD_C:
               state = true;
               break;
             case 1:
-            case "T"_hk:
+            case HASH_KEYWORD_T:
               state= false;
               break;
-            case "X"_hk:
+            case HASH_KEYWORD_X:
 	    {
               Turnout *tt = Turnout::get(p[0]);
               if (tt) {
@@ -946,14 +785,14 @@ bool DCCEXParser::parseT(Print *stream, int16_t params, int16_t p[])
         }
 
     default: // Anything else is some kind of turnout create function.
-      if (params == 6 && p[1] == "SERVO"_hk) { // <T id SERVO n n n n>
+      if (params == 6 && p[1] == HASH_KEYWORD_SERVO) { // <T id SERVO n n n n>
         if (!ServoTurnout::create(p[0], (VPIN)p[2], (uint16_t)p[3], (uint16_t)p[4], (uint8_t)p[5]))
           return false;
       } else 
-      if (params == 3 && p[1] == "VPIN"_hk) { // <T id VPIN n>
+      if (params == 3 && p[1] == HASH_KEYWORD_VPIN) { // <T id VPIN n>
         if (!VpinTurnout::create(p[0], p[2])) return false;
       } else 
-      if (params >= 3 && p[1] == "DCC"_hk) {
+      if (params >= 3 && p[1] == HASH_KEYWORD_DCC) {
         // <T id DCC addr subadd>   0<=addr<=511, 0<=subadd<=3 (like <a> command).<T>
         if (params==4 && p[2]>=0 && p[2]<512 && p[3]>=0 && p[3]<4) { // <T id DCC n m>
           if (!DCCTurnout::create(p[0], p[2], p[3])) return false;
@@ -1012,225 +851,116 @@ bool DCCEXParser::parseS(Print *stream, int16_t params, int16_t p[])
     return false;
 }
 
-bool DCCEXParser::parseC(Print *stream, int16_t params, int16_t p[]) {
-    (void)stream; // arg not used, maybe later?
-    if (params == 0)
-        return false;
-    switch (p[0])
-    {
-#ifndef DISABLE_PROG
-    case "PROGBOOST"_hk:
-        TrackManager::progTrackBoosted=true;
-	    return true;
-#endif
-    case "RESET"_hk:
-        DCCTimer::reset();
-        break; // and <X> if we didnt restart
-    case "SPEED28"_hk:
-        DCC::setGlobalSpeedsteps(28);
-	DIAG(F("28 Speedsteps"));
-        return true;
-
-    case "SPEED128"_hk:
-        DCC::setGlobalSpeedsteps(128);
-	DIAG(F("128 Speedsteps"));
-        return true;
-
-#ifndef DISABLE_PROG
-    case "ACK"_hk: // <D ACK ON/OFF> <D ACK [LIMIT|MIN|MAX|RETRY] Value>
-	if (params >= 3) {
-	    if (p[1] == "LIMIT"_hk) {
-	      DCCACK::setAckLimit(p[2]);
-	      LCD(1, F("Ack Limit=%dmA"), p[2]);  // <D ACK LIMIT 42>
-	    } else if (p[1] == "MIN"_hk) {
-	      DCCACK::setMinAckPulseDuration(p[2]);
-	      LCD(0, F("Ack Min=%uus"), p[2]);  //   <D ACK MIN 1500>
-	    } else if (p[1] == "MAX"_hk) {
-	      DCCACK::setMaxAckPulseDuration(p[2]);
-	      LCD(0, F("Ack Max=%uus"), p[2]);  //   <D ACK MAX 9000>
-	    } else if (p[1] == "RETRY"_hk) {
-	      if (p[2] >255) p[2]=3;
-	      LCD(0, F("Ack Retry=%d Sum=%d"), p[2], DCCACK::setAckRetry(p[2]));  //   <D ACK RETRY 2>
-	    }
-	} else {
-      bool onOff = (params > 0) && (p[1] == 1 || p[1] == "ON"_hk); // dont care if other stuff or missing... just means off
-    
-	  DIAG(F("Ack diag %S"), onOff ? F("on") : F("off"));
-	  Diag::ACK = onOff;
-	}
-        return true;
-#endif
-
-default: // invalid/unknown
-      break;
-    }
-    return false;
-}
-
 bool DCCEXParser::parseD(Print *stream, int16_t params, int16_t p[])
 {
     if (params == 0)
         return false;
-    bool onOff = (params > 0) && (p[1] == 1 || p[1] == "ON"_hk); // dont care if other stuff or missing... just means off
+    bool onOff = (params > 0) && (p[1] == 1 || p[1] == HASH_KEYWORD_ON); // dont care if other stuff or missing... just means off
     switch (p[0])
     {
-    case "CABS"_hk: // <D CABS>
+    case HASH_KEYWORD_CABS: // <D CABS>
         DCC::displayCabList(stream);
         return true;
 
-    case "RAM"_hk: // <D RAM>
-        DIAG(F("Free memory=%d"), DCCTimer::getMinimumFreeMemory());
+    case HASH_KEYWORD_RAM: // <D RAM>
+        StringFormatter::send(stream, F("Free memory=%d\n"), DCCTimer::getMinimumFreeMemory());
+        break;
+
+    case HASH_KEYWORD_ACK: // <D ACK ON/OFF> <D ACK [LIMIT|MIN|MAX|RETRY] Value>
+	if (params >= 3) {
+	    if (p[1] == HASH_KEYWORD_LIMIT) {
+	      DCCACK::setAckLimit(p[2]);
+	      LCD(1, F("Ack Limit=%dmA"), p[2]);  // <D ACK LIMIT 42>
+	    } else if (p[1] == HASH_KEYWORD_MIN) {
+	      DCCACK::setMinAckPulseDuration(p[2]);
+	      LCD(0, F("Ack Min=%uus"), p[2]);  //   <D ACK MIN 1500>
+	    } else if (p[1] == HASH_KEYWORD_MAX) {
+	      DCCACK::setMaxAckPulseDuration(p[2]);
+	      LCD(0, F("Ack Max=%uus"), p[2]);  //   <D ACK MAX 9000>
+	    } else if (p[1] == HASH_KEYWORD_RETRY) {
+	      if (p[2] >255) p[2]=3;
+	      LCD(0, F("Ack Retry=%d Sum=%d"), p[2], DCCACK::setAckRetry(p[2]));  //   <D ACK RETRY 2>
+	    }
+	} else {
+	  StringFormatter::send(stream, F("Ack diag %S\n"), onOff ? F("on") : F("off"));
+	  Diag::ACK = onOff;
+	}
         return true;
 
-    case "CMD"_hk: // <D CMD ON/OFF>
+    case HASH_KEYWORD_CMD: // <D CMD ON/OFF>
         Diag::CMD = onOff;
         return true;
 
 #ifdef HAS_ENOUGH_MEMORY
-    case "WIFI"_hk: // <D WIFI ON/OFF>
+    case HASH_KEYWORD_WIFI: // <D WIFI ON/OFF>
         Diag::WIFI = onOff;
         return true;
 
-    case "ETHERNET"_hk: // <D ETHERNET ON/OFF>
+    case HASH_KEYWORD_ETHERNET: // <D ETHERNET ON/OFF>
         Diag::ETHERNET = onOff;
         return true;
 
-    case "WIT"_hk: // <D WIT ON/OFF>
+    case HASH_KEYWORD_WIT: // <D WIT ON/OFF>
         Diag::WITHROTTLE = onOff;
         return true;
 
-    case "LCN"_hk: // <D LCN ON/OFF>
+    case HASH_KEYWORD_LCN: // <D LCN ON/OFF>
         Diag::LCN = onOff;
         return true;
 #endif
+
+    case HASH_KEYWORD_PROGBOOST:
+        TrackManager::progTrackBoosted=true;
+	    return true;
+
+    case HASH_KEYWORD_RESET:
+        DCCTimer::reset();
+        break; // and <X> if we didnt restart 
+    
+
 #ifndef DISABLE_EEPROM
-    case "EEPROM"_hk: // <D EEPROM NumEntries>
+    case HASH_KEYWORD_EEPROM: // <D EEPROM NumEntries>
 	if (params >= 2)
 	    EEStore::dump(p[1]);
 	return true;
 #endif
-    case "SERVO"_hk:  // <D SERVO vpin position [profile]>
 
-    case "ANOUT"_hk:  // <D ANOUT vpin position [profile]>
+    case HASH_KEYWORD_SPEED28:
+        DCC::setGlobalSpeedsteps(28);
+	StringFormatter::send(stream, F("28 Speedsteps"));
+        return true;
+
+    case HASH_KEYWORD_SPEED128:
+        DCC::setGlobalSpeedsteps(128);
+	StringFormatter::send(stream, F("128 Speedsteps"));
+        return true;
+
+    case HASH_KEYWORD_SERVO:  // <D SERVO vpin position [profile]>
+    case HASH_KEYWORD_ANOUT:  // <D ANOUT vpin position [profile]>
         IODevice::writeAnalogue(p[1], p[2], params>3 ? p[3] : 0);
-        return true;
+        break;
 
-    case "ANIN"_hk:   // <D ANIN vpin>  Display analogue input value
-        DIAG(F("VPIN=%u value=%d"), p[1], IODevice::readAnalogue(p[1]));
-        return true;
+    case HASH_KEYWORD_ANIN:   // <D ANIN vpin>  Display analogue input value
+        DIAG(F("VPIN=%d value=%d"), p[1], IODevice::readAnalogue(p[1]));
+        break;
 
-#if !defined(IO_NO_HAL)
-    case "HAL"_hk: 
-        if (p[1] == "SHOW"_hk) 
+#if !defined(IO_MINIMAL_HAL)
+    case HASH_KEYWORD_HAL: 
+        if (p[1] == HASH_KEYWORD_SHOW) 
           IODevice::DumpAll();
-        else if (p[1] == "RESET"_hk)
-          IODevice::reset();
-        return true;
+        break;
 #endif
 
-    case "TT"_hk:     // <D TT vpin steps activity>
+    case HASH_KEYWORD_TT:     // <D TT vpin steps activity>
         IODevice::writeAnalogue(p[1], p[2], params>3 ? p[3] : 0);
-        return true;
+        break;
 
     default: // invalid/unknown
-        return parseC(stream, params, p);
+        break;
     }
     return false;
 }
 
-// ==========================
-// Turntable - no support if no HAL
-// <I> - list all
-// <I id> - broadcast type and current position
-// <I id DCC> - create DCC - This is TBA
-// <I id steps> - operate (DCC)
-// <I id steps activity> - operate (EXTT)
-// <I id ADD position value> - add position
-// <I id EXTT i2caddress vpin home> - create EXTT
-#ifndef IO_NO_HAL
-bool DCCEXParser::parseI(Print *stream, int16_t params, int16_t p[])
-{
-    switch (params)
-    {
-    case 0: // <I> list turntable objects
-        return Turntable::printAll(stream);
-
-    case 1: // <I id> broadcast type and current position
-        {    
-            Turntable *tto = Turntable::get(p[0]);
-            if (tto) {
-                bool type = tto->isEXTT();
-                uint8_t position = tto->getPosition();
-                StringFormatter::send(stream, F("<I %d %d>\n"), type, position);
-            } else {
-                return false;
-            }
-        }
-        return true;
-    
-    case 2: // <I id position> - rotate a DCC turntable
-        {
-            Turntable *tto = Turntable::get(p[0]);
-            if (tto && !tto->isEXTT()) {
-                if (!tto->setPosition(p[0], p[1])) return false;
-            } else {
-                return false;
-            }
-        }
-        return true;
-
-    case 3: // <I id position activity> | <I id DCC home> - rotate to position for EX-Turntable or create DCC turntable
-        {
-            Turntable *tto = Turntable::get(p[0]);
-            if (p[1] == "DCC"_hk) {
-                if (tto || p[2] < 0 || p[2] > 3600) return false;
-                if (!DCCTurntable::create(p[0])) return false;
-                Turntable *tto = Turntable::get(p[0]);
-                tto->addPosition(0, 0, p[2]);
-                StringFormatter::send(stream, F("<I>\n"));
-            } else {
-                if (!tto) return false;
-                if (!tto->isEXTT()) return false;
-                if (!tto->setPosition(p[0], p[1], p[2])) return false;
-            }
-        }
-        return true;
-    
-    case 4: // <I id EXTT vpin home> create an EXTT turntable
-        {
-            Turntable *tto = Turntable::get(p[0]);
-            if (p[1] == "EXTT"_hk) {
-                if (tto || p[3] < 0 || p[3] > 3600) return false;
-                if (!EXTTTurntable::create(p[0], (VPIN)p[2])) return false;
-                Turntable *tto = Turntable::get(p[0]);
-                tto->addPosition(0, 0, p[3]);
-                StringFormatter::send(stream, F("<I>\n"));
-            } else {
-                return false;
-            }
-        }
-        return true;
-    
-    case 5: // <I id ADD position value angle> add a position
-        {
-            Turntable *tto = Turntable::get(p[0]);
-            if (p[1] == "ADD"_hk) {
-                // tto must exist, no more than 48 positions, angle 0 - 3600
-                if (!tto || p[2] > 48 || p[4] < 0 || p[4] > 3600) return false;
-                tto->addPosition(p[2], p[3], p[4]);
-                StringFormatter::send(stream, F("<I>\n"));
-            } else {
-                return false;
-            }
-        }
-        return true;
-    
-    default:    // Anything else is invalid
-        return false;
-    }
-}
-#endif
-
 // CALLBACKS must be static
 bool DCCEXParser::stashCallback(Print *stream, int16_t p[MAX_COMMAND_PARAMS], RingStream * ringStream)
 {

DCCEXParser.h

@@ -24,7 +24,6 @@
 #include <Arduino.h>
 #include "FSH.h"
 #include "RingStream.h"
-#include "defines.h"
 
 typedef void (*FILTER_CALLBACK)(Print * stream, byte & opcode, byte & paramCount, int16_t p[]);
 typedef void (*AT_COMMAND_CALLBACK)(HardwareSerial * stream,const byte * command);
@@ -46,17 +45,13 @@ struct DCCEXParser
     static int16_t splitValues( int16_t result[MAX_COMMAND_PARAMS], const byte * command, bool usehex);
      
     static bool parseT(Print * stream, int16_t params, int16_t p[]);
-    static bool parseZ(Print * stream, int16_t params, int16_t p[]);
-    static bool parseS(Print * stream, int16_t params, int16_t p[]);
-    static bool parsef(Print * stream, int16_t params, int16_t p[]);
-    static bool parseC(Print * stream, int16_t params, int16_t p[]);
-    static bool parseD(Print * stream, int16_t params, int16_t p[]);
-#ifndef IO_NO_HAL
-    static bool parseI(Print * stream, int16_t params, int16_t p[]);
-#endif
+     static bool parseZ(Print * stream, int16_t params, int16_t p[]);
+     static bool parseS(Print * stream,  int16_t params, int16_t p[]);
+     static bool parsef(Print * stream,  int16_t params, int16_t p[]);
+     static bool parseD(Print * stream,  int16_t params, int16_t p[]);
 
-    static Print * getAsyncReplyStream();
-    static void commitAsyncReplyStream();
+     static Print * getAsyncReplyStream();
+     static void commitAsyncReplyStream();
 
     static bool stashBusy;
     static byte stashTarget;

DCCRMT.cpp

@@ -1,5 +1,5 @@
 /*
- *  © 2021-2024, Harald Barth.
+ *  © 2021-2022, Harald Barth.
  *  
  *  This file is part of DCC-EX
  *
@@ -25,18 +25,6 @@
 #include "DCCWaveform.h" // for MAX_PACKET_SIZE
 #include "soc/gpio_sig_map.h"
 
-// check for right type of ESP32
-#include "soc/soc_caps.h"
-#ifndef SOC_RMT_MEM_WORDS_PER_CHANNEL
-#error This symobol should be defined
-#endif
-#if SOC_RMT_MEM_WORDS_PER_CHANNEL < 64
-#warning This is not an ESP32-WROOM but some other unsupported variant
-#warning You are outside of the DCC-EX supported hardware
-#endif
-
-static const byte RMT_CHAN_PER_DCC_CHAN = 2;
-
 // Number of bits resulting out of X bytes of DCC payload data
 // Each byte has one bit extra and at the end we have one EOF marker
 #define DATA_LEN(X) ((X)*9+1)
@@ -87,30 +75,12 @@ void IRAM_ATTR interrupt(rmt_channel_t channel, void *t) {
 RMTChannel::RMTChannel(pinpair pins, bool isMain) {
   byte ch;
   byte plen;
-
-  // Below we check if the DCC packet actually fits into the RMT hardware
-  // Currently MAX_PACKET_SIZE = 5 so with checksum there are
-  // MAX_PACKET_SIZE+1 data packets. Each need DATA_LEN (9) bits.
-  // To that we add the preamble length, the fencepost DCC end bit
-  // and the RMT EOF marker.
-  // SOC_RMT_MEM_WORDS_PER_CHANNEL is either 64 (original WROOM) or
-  // 48 (all other ESP32 like the -C3 or -S2
-  // The formula to get the possible MAX_PACKET_SIZE is
-  //
-  // ALLOCATED = RMT_CHAN_PER_DCC_CHAN * SOC_RMT_MEM_WORDS_PER_CHANNEL
-  // MAX_PACKET_SIZE = floor((ALLOCATED - PREAMBLE_LEN - 2)/9 - 1)
-  //
-
   if (isMain) {
     ch = 0;
     plen = PREAMBLE_BITS_MAIN;
-    static_assert (DATA_LEN(MAX_PACKET_SIZE+1) + PREAMBLE_BITS_MAIN + 2 <= RMT_CHAN_PER_DCC_CHAN * SOC_RMT_MEM_WORDS_PER_CHANNEL,
-		  "Number of DCC packet bits greater than ESP32 RMT memory available");
   } else {
-    ch = RMT_CHAN_PER_DCC_CHAN; // number == offset
+    ch = 2;
     plen = PREAMBLE_BITS_PROG;
-    static_assert (DATA_LEN(MAX_PACKET_SIZE+1) + PREAMBLE_BITS_PROG + 2 <= RMT_CHAN_PER_DCC_CHAN * SOC_RMT_MEM_WORDS_PER_CHANNEL,
-		   "Number of DCC packet bits greater than ESP32 RMT memory available");
   }
     
   // preamble
@@ -145,7 +115,7 @@ RMTChannel::RMTChannel(pinpair pins, bool isMain) {
   // data: max packet size today is 5 + checksum
   maxDataLen = DATA_LEN(MAX_PACKET_SIZE+1);  // plus checksum
   data = (rmt_item32_t*)malloc(maxDataLen*sizeof(rmt_item32_t));
-
+  
   rmt_config_t config;
   // Configure the RMT channel for TX
   bzero(&config, sizeof(rmt_config_t));
@@ -153,10 +123,20 @@ RMTChannel::RMTChannel(pinpair pins, bool isMain) {
   config.channel = channel = (rmt_channel_t)ch;
   config.clk_div = RMT_CLOCK_DIVIDER;
   config.gpio_num = (gpio_num_t)pins.pin;
-  config.mem_block_num = RMT_CHAN_PER_DCC_CHAN;
-  // use config
+  config.mem_block_num = 2; // With longest DCC packet 11 inc checksum (future expansion)
+                            // number of bits needed is 22preamble + start +
+                            // 11*9 + extrazero + EOT = 124
+                            // 2 mem block of 64 RMT items should be enough
+
   ESP_ERROR_CHECK(rmt_config(&config));
   addPin(pins.invpin, true);
+  /*
+  // test: config another gpio pin
+  gpio_num_t gpioNum = (gpio_num_t)(pin-1);
+  PIN_FUNC_SELECT(GPIO_PIN_MUX_REG[gpioNum], PIN_FUNC_GPIO);
+  gpio_set_direction(gpioNum, GPIO_MODE_OUTPUT);
+  gpio_matrix_out(gpioNum, RMT_SIG_OUT0_IDX, 0, 0);
+  */
   
   // NOTE: ESP_INTR_FLAG_IRAM is *NOT* included in this bitmask
   ESP_ERROR_CHECK(rmt_driver_install(config.channel, 0, ESP_INTR_FLAG_LOWMED|ESP_INTR_FLAG_SHARED));
@@ -214,10 +194,8 @@ int RMTChannel::RMTfillData(const byte buffer[], byte byteCount, byte repeatCoun
   setDCCBit1(data + bitcounter-1);     // overwrite previous zero bit with one bit
   setEOT(data + bitcounter++);         // EOT marker
   dataLen = bitcounter;
-  noInterrupts();                      // keep dataReady and dataRepeat consistnet to each other
   dataReady = true;
   dataRepeat = repeatCount+1;         // repeatCount of 0 means send once
-  interrupts();
   return 0;
 }
 
@@ -234,8 +212,6 @@ void IRAM_ATTR RMTChannel::RMTinterrupt() {
   if (dataReady) {            // if we have new data, fill while preamble is running
     rmt_fill_tx_items(channel, data, dataLen, preambleLen-1);
     dataReady = false;
-    if (dataRepeat == 0)       // all data should go out at least once
-      DIAG(F("Channel %d DCC signal lost data"), channel);
   }
   if (dataRepeat > 0)         // if a repeat count was specified, work on that
     dataRepeat--;

DCCTimer.h

@@ -1,7 +1,7 @@
 /*
  *  © 2022-2023 Paul M. Antoine
  *  © 2021 Mike S
- *  © 2021-2023 Harald Barth
+ *  © 2021-2022 Harald Barth
  *  © 2021 Fred Decker
  *  All rights reserved.
  *  
@@ -62,9 +62,6 @@ class DCCTimer {
   static bool isPWMPin(byte pin);
   static void setPWM(byte pin, bool high);
   static void clearPWM();
-  static void DCCEXanalogWriteFrequency(uint8_t pin, uint32_t frequency);
-  static void DCCEXanalogWrite(uint8_t pin, int value);
-
 // Update low ram level.  Allow for extra bytes to be specified
 // by estimation or inspection, that may be used by other 
 // called subroutines.  Must be called with interrupts disabled.
@@ -125,14 +122,8 @@ private:
   // On platforms that scan, it is called from waveform ISR
   // only on a regular basis.
   static void scan();
-  #if defined (ARDUINO_ARCH_STM32)
-  // bit array of used pins (max 32)
-  static uint32_t usedpins;
-#else
   // bit array of used pins (max 16)
   static uint16_t usedpins;
-#endif
-  static uint8_t highestPin;
   // cached analog values (malloc:ed to actual number of ADC channels)
   static int *analogvals;
   // friend so that we can call scan() and begin()

DCCTimerAVR.cpp

@@ -1,6 +1,6 @@
 /*
  *  © 2021 Mike S
- *  © 2021-2023 Harald Barth
+ *  © 2021-2022 Harald Barth
  *  © 2021 Fred Decker
  *  © 2021 Chris Harlow
  *  © 2021 David Cutting
@@ -29,9 +29,6 @@
 #include <avr/boot.h> 
 #include <avr/wdt.h>
 #include "DCCTimer.h"
-#ifdef DEBUG_ADC
-#include "TrackManager.h"
-#endif
 INTERRUPT_CALLBACK interruptHandler=0;
 
   // Arduino nano, uno, mega etc
@@ -126,14 +123,13 @@ void DCCTimer::reset() {
 }
 
 #if defined(ARDUINO_AVR_MEGA) || defined(ARDUINO_AVR_MEGA2560)
-#define NUM_ADC_INPUTS 16
+#define NUM_ADC_INPUTS 15
 #else
-#define NUM_ADC_INPUTS 8
+#define NUM_ADC_INPUTS 7
 #endif
 uint16_t ADCee::usedpins = 0;
-uint8_t ADCee::highestPin = 0;
 int * ADCee::analogvals = NULL;
-static bool ADCusesHighPort = false;
+bool ADCusesHighPort = false;
 
 /*
  * Register a new pin to be scanned
@@ -142,17 +138,16 @@ static bool ADCusesHighPort = false;
  */
 int ADCee::init(uint8_t pin) {
   uint8_t id = pin - A0;
-  if (id >= NUM_ADC_INPUTS)
+  if (id > NUM_ADC_INPUTS)
     return -1023;
   if (id > 7)
     ADCusesHighPort = true;
   pinMode(pin, INPUT);
   int value = analogRead(pin);
   if (analogvals == NULL)
-    analogvals = (int *)calloc(NUM_ADC_INPUTS, sizeof(int));
+    analogvals = (int *)calloc(NUM_ADC_INPUTS+1, sizeof(int));
   analogvals[id] = value;
   usedpins |= (1<<id);
-  if (id > highestPin) highestPin = id;
   return value;
 }
 int16_t ADCee::ADCmax() {
@@ -162,15 +157,13 @@ int16_t ADCee::ADCmax() {
  * Read function ADCee::read(pin) to get value instead of analogRead(pin)
  */
 int ADCee::read(uint8_t pin, bool fromISR) {
+  (void)fromISR; // AVR does ignore this arg
   uint8_t id = pin - A0;
   if ((usedpins & (1<<id) ) == 0)
     return -1023;
   // we do not need to check (analogvals == NULL)
   // because usedpins would still be 0 in that case
-  if (!fromISR) noInterrupts();
-  int a = analogvals[id];
-  if (!fromISR) interrupts();
-  return a;
+  return analogvals[id];
 }
 /*
  * Scan function that is called from interrupt
@@ -178,8 +171,8 @@ int ADCee::read(uint8_t pin, bool fromISR) {
 #pragma GCC push_options
 #pragma GCC optimize ("-O3")
 void ADCee::scan() {
-  static byte id = 0;       // id and mask are the same thing but it is faster to
-  static uint16_t mask = 1; // increment and shift instead to calculate mask from id
+  static byte id = 0;        // id and mask are the same thing but it is faster to 
+  static uint16_t mask = 1;  // increment and shift instead to calculate mask from id
   static bool waiting = false;
 
   if (waiting) {
@@ -193,13 +186,11 @@ void ADCee::scan() {
     bitSet(ADCSRA, ADIF);
     analogvals[id] = (high << 8) | low;
     // advance at least one track
-#ifdef DEBUG_ADC
-    if (id == 1) TrackManager::track[1]->setBrake(0);
-#endif
+    // for scope debug TrackManager::track[1]->setBrake(0);
     waiting = false;
     id++;
     mask = mask << 1;
-    if (id > highestPin) {
+    if (id == NUM_ADC_INPUTS+1) {
       id = 0;
       mask = 1;
     }
@@ -221,17 +212,15 @@ void ADCee::scan() {
 #endif
 	ADMUX=(1<<REFS0)|(id & 0x07); //select AVCC as reference and set MUX
 	bitSet(ADCSRA,ADSC); // start conversion
-#ifdef DEBUG_ADC
-	if (id == 1) TrackManager::track[1]->setBrake(1);
-#endif
+	// for scope debug TrackManager::track[1]->setBrake(1);
 	waiting = true;
 	return;
       }
       id++;
       mask = mask << 1;
-      if (id > highestPin) {
-      	id = 0;
-	      mask = 1;
+      if (id == NUM_ADC_INPUTS+1) {
+	id = 0;
+	mask = 1;
       }
     }
   }

DCCTimerESP.cpp

@@ -83,26 +83,18 @@ int DCCTimer::freeMemory() {
 #include <soc/sens_struct.h>
 #undef ADC_INPUT_MAX_VALUE
 #define ADC_INPUT_MAX_VALUE 4095 // 12 bit ADC
-
-#ifdef ARDUINO_ESP32S3_DEV
-#define pinToADC1Channel(X) (adc1_channel_t)((X)-1)
-#define MY_SAR_REG sar_meas1_ctrl2
-#else
 #define pinToADC1Channel(X) (adc1_channel_t)(((X) > 35) ? (X)-36 : (X)-28)
-#define MY_SAR_REG sar_meas_start1
-#endif
 
 int IRAM_ATTR local_adc1_get_raw(int channel) {
   uint16_t adc_value;
-  SENS.MY_SAR_REG.sar1_en_pad = (1 << channel); // only one channel is selected
+  SENS.sar_meas_start1.sar1_en_pad = (1 << channel); // only one channel is selected
   while (SENS.sar_slave_addr1.meas_status != 0);
-  SENS.MY_SAR_REG.meas1_start_sar = 0;
-  SENS.MY_SAR_REG.meas1_start_sar = 1;
-  while (SENS.MY_SAR_REG.meas1_done_sar == 0);
-  adc_value = SENS.MY_SAR_REG.meas1_data_sar;
+  SENS.sar_meas_start1.meas1_start_sar = 0;
+  SENS.sar_meas_start1.meas1_start_sar = 1;
+  while (SENS.sar_meas_start1.meas1_done_sar == 0);
+  adc_value = SENS.sar_meas_start1.meas1_data_sar;
   return adc_value;
 }
-#undef MY_SAR_REG
 
 #include "DCCTimer.h"
 INTERRUPT_CALLBACK interruptHandler=0;
@@ -158,45 +150,6 @@ int DCCTimer::freeMemory() {
 void DCCTimer::reset() {
    ESP.restart();
 }
-
-#include "esp32-hal.h"
-#include "soc/soc_caps.h"
-
-
-#ifdef SOC_LEDC_SUPPORT_HS_MODE
-#define LEDC_CHANNELS           (SOC_LEDC_CHANNEL_NUM<<1)
-#else
-#define LEDC_CHANNELS           (SOC_LEDC_CHANNEL_NUM)
-#endif
-
-static int8_t pin_to_channel[SOC_GPIO_PIN_COUNT] = { 0 };
-static int cnt_channel = LEDC_CHANNELS;
-
-void DCCTimer::DCCEXanalogWriteFrequency(uint8_t pin, uint32_t frequency) {
-  if (pin < SOC_GPIO_PIN_COUNT) {
-    if (pin_to_channel[pin] != 0) {
-      ledcSetup(pin_to_channel[pin], frequency, 8);
-    }
-  }
-}
-
-void DCCTimer::DCCEXanalogWrite(uint8_t pin, int value) {
-  if (pin < SOC_GPIO_PIN_COUNT) {
-    if (pin_to_channel[pin] == 0) {
-      if (!cnt_channel) {
-          log_e("No more PWM channels available! All %u already used", LEDC_CHANNELS);
-          return;
-      }
-      pin_to_channel[pin] = --cnt_channel;
-      ledcSetup(cnt_channel, 1000, 8);
-      ledcAttachPin(pin, cnt_channel);
-    } else {
-      ledcAttachPin(pin, pin_to_channel[pin]);
-    }
-    ledcWrite(pin_to_channel[pin], value);
-  }
-}
-
 int ADCee::init(uint8_t pin) {
   pinMode(pin, ANALOG);
   adc1_config_width(ADC_WIDTH_BIT_12);

DCCTimerSAMD.cpp

@@ -162,7 +162,7 @@ uint16_t ADCee::usedpins = 0;
 int * ADCee::analogvals = NULL;
 
 int ADCee::init(uint8_t pin) {
-  uint8_t id = pin - A0;
+  uint id = pin - A0;
   int value = 0;
 
   if (id > NUM_ADC_INPUTS)
@@ -210,7 +210,7 @@ int ADCee::read(uint8_t pin, bool fromISR) {
 #pragma GCC push_options
 #pragma GCC optimize ("-O3")
 void ADCee::scan() {
-  static uint8_t id = 0;        // id and mask are the same thing but it is faster to 
+  static uint id = 0;        // id and mask are the same thing but it is faster to 
   static uint16_t mask = 1;  // increment and shift instead to calculate mask from id
   static bool waiting = false;
 

DCCTimerSTM32.cpp

@@ -1,8 +1,7 @@
 /*
- *  © 2023 Neil McKechnie
- *  © 2022-2023 Paul M. Antoine
+ *  © 2022 Paul M. Antoine
  *  © 2021 Mike S
- *  © 2021, 2023 Harald Barth
+ *  © 2021 Harald Barth
  *  © 2021 Fred Decker
  *  © 2021 Chris Harlow
  *  © 2021 David Cutting
@@ -30,157 +29,34 @@
 #ifdef ARDUINO_ARCH_STM32
 
 #include "DCCTimer.h"
-#ifdef DEBUG_ADC
-#include "TrackManager.h"
-#endif
-#include "DIAG.h"
 
-#if defined(ARDUINO_NUCLEO_F401RE) || defined(ARDUINO_NUCLEO_F411RE)
-// Nucleo-64 boards don't have additional serial ports defined by default
+#if defined(ARDUINO_NUCLEO_F411RE)
+// Nucleo-64 boards don't have Serial1 defined by default
 HardwareSerial Serial1(PB7, PA15);  // Rx=PB7, Tx=PA15 -- CN7 pins 17 and 21 - F411RE
 // Serial2 is defined to use USART2 by default, but is in fact used as the diag console
 // via the debugger on the Nucleo-64. It is therefore unavailable for other DCC-EX uses like WiFi, DFPlayer, etc.
 // Let's define Serial6 as an additional serial port (the only other option for the Nucleo-64s)
 HardwareSerial Serial6(PA12, PA11);  // Rx=PA12, Tx=PA11 -- CN10 pins 12 and 14 - F411RE
 #elif defined(ARDUINO_NUCLEO_F446RE)
-// Nucleo-64 boards don't have additional serial ports defined by default
-// On the F446RE, Serial1 isn't really useable as it's Rx/Tx pair sit on already used D2/D10 pins
-// HardwareSerial Serial1(PA10, PB6);  // Rx=PA10 (D2), Tx=PB6 (D10) -- CN10 pins 17 and 9 - F446RE 
+// Nucleo-64 boards don't have Serial1 defined by default
+HardwareSerial Serial1(PA10, PB6);  // Rx=PA10, Tx=PB6 -- CN10 pins 33 and 17 - F446RE 
 // Serial2 is defined to use USART2 by default, but is in fact used as the diag console
 // via the debugger on the Nucleo-64. It is therefore unavailable for other DCC-EX uses like WiFi, DFPlayer, etc.
-// On the F446RE, Serial3 and Serial5 are easy to use:
-HardwareSerial Serial3(PC11, PC10);  // Rx=PC11, Tx=PC10 -- USART3 - F446RE
-HardwareSerial Serial5(PD2, PC12);  // Rx=PD2, Tx=PC12 -- UART5 - F446RE
-// On the F446RE, Serial4 and Serial6 also use pins we can't readily map while using the Arduino pins
-#elif defined(ARDUINO_NUCLEO_F412ZG) || defined(ARDUINO_NUCLEO_F413ZH) || defined(ARDUINO_NUCLEO_F446ZE) || \
-      defined(ARDUINO_NUCLEO_F429ZI) || defined(ARDUINO_NUCLEO_F439ZI)
+#elif defined(ARDUINO_NUCLEO_F412ZG) || defined(ARDUINO_NUCLEO_F429ZI) || defined(ARDUINO_NUCLEO_F446ZE)
 // Nucleo-144 boards don't have Serial1 defined by default
-HardwareSerial Serial6(PG9, PG14);  // Rx=PG9, Tx=PG14 -- USART6
-HardwareSerial Serial5(PD2, PC12);  // Rx=PD2, Tx=PC12 -- UART5
-#if !defined(ARDUINO_NUCLEO_F412ZG)
-  HardwareSerial Serial2(PD6, PD5);  // Rx=PD6, Tx=PD5 -- UART5
-#endif  
-// Serial3 is defined to use USART3 by default, but is in fact used as the diag console
-// via the debugger on the Nucleo-144. It is therefore unavailable for other DCC-EX uses like WiFi, DFPlayer, etc.
+HardwareSerial Serial1(PG9, PG14);  // Rx=PG9, Tx=PG14 -- D0, D1 - F412ZG/F446ZE
 #else
-#error STM32 board selected is not yet explicitly supported - so Serial1 peripheral is not defined
+#warning Serial1 not defined
 #endif
 
-///////////////////////////////////////////////////////////////////////////////////////////////
-// Experimental code for High Accuracy (HA) DCC Signal mode
-// Warning - use of TIM2 and TIM3 can affect the use of analogWrite() function on certain pins,
-// which is used by the DC motor types.
-///////////////////////////////////////////////////////////////////////////////////////////////
-
-// INTERRUPT_CALLBACK interruptHandler=0;
-// // Let's use STM32's timer #2 which supports hardware pulse generation on pin D13.
-// // Also, timer #3 will do hardware pulses on pin D12. This gives
-// // accurate timing, independent of the latency of interrupt handling.
-// // We only need to interrupt on one of these (TIM2), the other will just generate
-// // pulses.
-// HardwareTimer timer(TIM2);
-// HardwareTimer timerAux(TIM3);
-// static bool tim2ModeHA = false;
-// static bool tim3ModeHA = false;
-
-// // Timer IRQ handler
-// void Timer_Handler() {
-//   interruptHandler();
-// }
-
-// void DCCTimer::begin(INTERRUPT_CALLBACK callback) {
-//   interruptHandler=callback;
-//   noInterrupts();
-
-//   // adc_set_sample_rate(ADC_SAMPLETIME_480CYCLES);
-//   timer.pause();
-//   timerAux.pause();
-//   timer.setPrescaleFactor(1);
-//   timer.setOverflow(DCC_SIGNAL_TIME, MICROSEC_FORMAT);
-//   timer.attachInterrupt(Timer_Handler);
-//   timer.refresh();
-//   timerAux.setPrescaleFactor(1);
-//   timerAux.setOverflow(DCC_SIGNAL_TIME, MICROSEC_FORMAT);
-//   timerAux.refresh();
-  
-//   timer.resume();
-//   timerAux.resume();
-
-//   interrupts();
-// }
-
-// bool DCCTimer::isPWMPin(byte pin) {
-//   // Timer 2 Channel 1 controls pin D13, and Timer3 Channel 1 controls D12.
-//   //  Enable the appropriate timer channel.
-//   switch (pin) {
-//     case 12:
-//       return true;
-//     case 13:
-//       return true;
-//     default:
-//       return false;
-//   }
-// }
-
-// void DCCTimer::setPWM(byte pin, bool high) {
-//   // Set the timer so that, at the next counter overflow, the requested
-//   // pin state is activated automatically before the interrupt code runs.
-//   // TIM2 is timer, TIM3 is timerAux.
-//   switch (pin) {
-//     case 12:
-//       if (!tim3ModeHA) {
-//         timerAux.setMode(1, TIMER_OUTPUT_COMPARE_INACTIVE, D12);
-//         tim3ModeHA = true;
-//       }
-//       if (high) 
-//         TIM3->CCMR1 = (TIM3->CCMR1 & ~TIM_CCMR1_OC1M_Msk) | TIM_CCMR1_OC1M_0;
-//       else
-//         TIM3->CCMR1 = (TIM3->CCMR1 & ~TIM_CCMR1_OC1M_Msk) | TIM_CCMR1_OC1M_1;
-//       break;
-//     case 13:
-//       if (!tim2ModeHA) {
-//         timer.setMode(1, TIMER_OUTPUT_COMPARE_INACTIVE, D13);
-//         tim2ModeHA = true;
-//       }
-//       if (high) 
-//         TIM2->CCMR1 = (TIM2->CCMR1 & ~TIM_CCMR1_OC1M_Msk) | TIM_CCMR1_OC1M_0;
-//       else
-//         TIM2->CCMR1 = (TIM2->CCMR1 & ~TIM_CCMR1_OC1M_Msk) | TIM_CCMR1_OC1M_1;
-//       break;
-//   }   
-// }
-
-// void DCCTimer::clearPWM() {
-//   timer.setMode(1, TIMER_OUTPUT_COMPARE_INACTIVE, NC);
-//   tim2ModeHA = false;
-//   timerAux.setMode(1, TIMER_OUTPUT_COMPARE_INACTIVE, NC);  
-//   tim3ModeHA = false;
-// }
-///////////////////////////////////////////////////////////////////////////////////////////////
-
 INTERRUPT_CALLBACK interruptHandler=0;
-
-// On STM32F4xx models that have them, Timers 6 and 7 have no PWM output capability,
-// so are good choices for general timer duties - they are used for tone and servo
-// in stm32duino so we shall usurp those as DCC-EX doesn't use tone or servo libs.
-// NB: the F401, F410 and F411 do **not** have Timer 6 or 7, so we use Timer 11
-#ifndef DCC_EX_TIMER
-#if defined(TIM6)
-#define DCC_EX_TIMER TIM6
-#elif defined(TIM7)
-#define DCC_EX_TIMER TIM7
-#elif defined(TIM11)
-#define DCC_EX_TIMER TIM11
-#else
-#warning This STM32F4XX variant does not have Timers 6,7 or 11!!
-#endif
-#endif // ifndef DCC_EX_TIMER
-
-HardwareTimer dcctimer(DCC_EX_TIMER);
-void DCCTimer_Handler() __attribute__((interrupt));
+// Let's use STM32's timer #11 until disabused of this notion
+// Timer #11 is used for "servo" library, but as DCC-EX is not using
+// this libary, we should be free and clear.
+HardwareTimer timer(TIM11);
 
 // Timer IRQ handler
-void DCCTimer_Handler() {
+void Timer11_Handler() {
   interruptHandler();
 }
 
@@ -188,24 +64,22 @@ void DCCTimer::begin(INTERRUPT_CALLBACK callback) {
   interruptHandler=callback;
   noInterrupts();
 
-  dcctimer.pause();
-  dcctimer.setPrescaleFactor(1);
+  // adc_set_sample_rate(ADC_SAMPLETIME_480CYCLES);
+  timer.pause();
+  timer.setPrescaleFactor(1);
 //  timer.setOverflow(CLOCK_CYCLES * 2);
-  dcctimer.setOverflow(DCC_SIGNAL_TIME, MICROSEC_FORMAT);
-  // dcctimer.attachInterrupt(Timer11_Handler);
-  dcctimer.attachInterrupt(DCCTimer_Handler);
-  dcctimer.setInterruptPriority(0, 0); // Set highest preemptive priority!
-  dcctimer.refresh();
-  dcctimer.resume();
+  timer.setOverflow(DCC_SIGNAL_TIME, MICROSEC_FORMAT);
+  timer.attachInterrupt(Timer11_Handler);
+  timer.refresh();
+  timer.resume();
 
   interrupts();
 }
 
 bool DCCTimer::isPWMPin(byte pin) {
-  //TODO: STM32 whilst this call to digitalPinHasPWM will reveal which pins can do PWM,
+  //TODO: SAMD whilst this call to digitalPinHasPWM will reveal which pins can do PWM,
   //      there's no support yet for High Accuracy, so for now return false
   //  return digitalPinHasPWM(pin);
-  (void) pin;
   return false;
 }
 
@@ -220,9 +94,9 @@ void DCCTimer::clearPWM() {
 }
 
 void   DCCTimer::getSimulatedMacAddress(byte mac[6]) {
-  volatile uint32_t *serno1 = (volatile uint32_t *)UID_BASE;
-  volatile uint32_t *serno2 = (volatile uint32_t *)UID_BASE+4;
-  // volatile uint32_t *serno3 = (volatile uint32_t *)UID_BASE+8;
+  volatile uint32_t *serno1 = (volatile uint32_t *)0x1FFF7A10;
+  volatile uint32_t *serno2 = (volatile uint32_t *)0x1FFF7A14;
+  // volatile uint32_t *serno3 = (volatile uint32_t *)0x1FFF7A18;
 
   volatile uint32_t m1 = *serno1;
   volatile uint32_t m2 = *serno2;
@@ -257,128 +131,28 @@ void DCCTimer::reset() {
     while(true) {};
 }
 
-// TODO: rationalise the size of these... could really use sparse arrays etc.
-static HardwareTimer * pin_timer[100] = {0};
-static uint32_t channel_frequency[100] = {0};
-static uint32_t pin_channel[100] = {0};
-
-// Using the HardwareTimer library API included in stm32duino core to handle PWM duties
-// TODO: in order to use the HA code above which Neil kindly wrote, we may have to do something more
-// sophisticated about detecting any clash between the timer we'd like to use for PWM and the ones
-// currently used for HA so they don't interfere with one another. For now we'll just make PWM
-// work well... then work backwards to integrate with HA mode if we can.
-void DCCTimer::DCCEXanalogWriteFrequency(uint8_t pin, uint32_t frequency)
-{
-  if (pin_timer[pin] == NULL) {
-    // Automatically retrieve TIM instance and channel associated to pin
-    // This is used to be compatible with all STM32 series automatically.
-    TIM_TypeDef *Instance = (TIM_TypeDef *)pinmap_peripheral(digitalPinToPinName(pin), PinMap_PWM);
-    if (Instance == NULL) {
-      // We shouldn't get here (famous last words) as it ought to have been caught by brakeCanPWM()!
-      DIAG(F("DCCEXanalogWriteFrequency::Pin %d has no PWM function!"), pin);
-      return;
-    }
-    pin_channel[pin] = STM_PIN_CHANNEL(pinmap_function(digitalPinToPinName(pin), PinMap_PWM));
-
-    // Instantiate HardwareTimer object. Thanks to 'new' instantiation,
-    // HardwareTimer is not destructed when setup function is finished.
-    pin_timer[pin] = new HardwareTimer(Instance);
-    // Configure and start PWM
-    // MyTim->setPWM(channel, pin, 5, 10, NULL, NULL); // No callback required, we can simplify the function call
-    if (pin_timer[pin] != NULL)
-    {
-      pin_timer[pin]->setPWM(pin_channel[pin], pin, frequency, 0); // set frequency in Hertz, 0% dutycycle
-      DIAG(F("DCCEXanalogWriteFrequency::Pin %d on Timer %d, frequency %d"), pin, pin_channel[pin], frequency);
-    }
-    else
-      DIAG(F("DCCEXanalogWriteFrequency::failed to allocate HardwareTimer instance!"));
-  }
-  else
-  {
-    // Frequency change request
-    if (frequency != channel_frequency[pin])
-    {
-      pinmap_pinout(digitalPinToPinName(pin), PinMap_TIM); // ensure the pin has been configured!
-      pin_timer[pin]->setOverflow(frequency, HERTZ_FORMAT); // Just change the frequency if it's already running!
-      DIAG(F("DCCEXanalogWriteFrequency::setting frequency to %d"), frequency);
-    }
-  }
-  channel_frequency[pin] = frequency;
-  return;
-}
-
-void DCCTimer::DCCEXanalogWrite(uint8_t pin, int value) {
-    // Calculate percentage duty cycle from value given
-    uint32_t duty_cycle = (value * 100 / 256) + 1;
-    if (pin_timer[pin] != NULL) {
-      // if (duty_cycle == 100)
-      // {
-      //   pin_timer[pin]->pauseChannel(pin_channel[pin]);
-      //   DIAG(F("DCCEXanalogWrite::Pausing timer channel on pin %d"), pin);
-      // }
-      // else
-      // {
-        pinmap_pinout(digitalPinToPinName(pin), PinMap_TIM); // ensure the pin has been configured!
-        // pin_timer[pin]->resumeChannel(pin_channel[pin]);
-        pin_timer[pin]->setCaptureCompare(pin_channel[pin], duty_cycle, PERCENT_COMPARE_FORMAT); // DCC_EX_PWM_FREQ Hertz, duty_cycle% dutycycle
-        DIAG(F("DCCEXanalogWrite::Pin %d, value %d, duty cycle %d"), pin, value, duty_cycle);
-      // }
-    }
-    else
-      DIAG(F("DCCEXanalogWrite::Pin %d is not configured for PWM!"), pin);
-}
-
-
-// Now we can handle more ADCs, maybe this works!
 #define NUM_ADC_INPUTS NUM_ANALOG_INPUTS
 
-uint32_t ADCee::usedpins = 0;         // Max of 32 ADC input channels!
-uint8_t ADCee::highestPin = 0;        // Highest pin to scan
-int * ADCee::analogvals = NULL;       // Array of analog values last captured
-uint32_t * analogchans = NULL;        // Array of channel numbers to be scanned
-// bool adc1configured = false;
-ADC_TypeDef * * adcchans = NULL;      // Array to capture which ADC is each input channel on
+// TODO: may need to use uint32_t on STMF4xx variants with > 16 analog inputs!
+uint16_t ADCee::usedpins = 0;
+int * ADCee::analogvals = NULL;
+uint32_t * analogchans = NULL;
+bool adc1configured = false;
 
-int16_t ADCee::ADCmax()
-{
-    return 4095;
+int16_t ADCee::ADCmax() {
+  return 4095;
 }
 
 int ADCee::init(uint8_t pin) {
-
+  uint id = pin - A0;
   int value = 0;
-  PinName stmpin = analogInputToPinName(pin);
-  if (stmpin == NC) // do not continue if this is not an analog pin at all
-    return -1024;   // some silly value as error
+  PinName stmpin = digitalPin[analogInputPin[id]];
+  uint32_t stmgpio = stmpin / 16; // 16-bits per GPIO port group on STM32
+  uint32_t adcchan =  STM_PIN_CHANNEL(pinmap_function(stmpin, PinMap_ADC)); // find ADC channel (only valid for ADC1!)
+  GPIO_TypeDef * gpioBase;
 
-  uint32_t stmgpio = STM_PORT(stmpin); // converts to the GPIO port (16-bits per port group on STM32)
-  uint32_t adcchan =  STM_PIN_CHANNEL(pinmap_function(stmpin, PinMap_ADC)); // find ADC input channel
-  ADC_TypeDef *adc = (ADC_TypeDef *)pinmap_find_peripheral(stmpin, PinMap_ADC); // find which ADC this pin is on ADC1/2/3 etc.
-  int adcnum = 1;
-  if (adc == ADC1)
-    DIAG(F("ADCee::init(): found pin %d on ADC1"), pin);
-// Checking for ADC2 and ADC3 being defined helps cater for more variants later
-#if defined(ADC2)
-  else if (adc == ADC2)
-  {
-    DIAG(F("ADCee::init(): found pin %d on ADC2"), pin);
-    adcnum = 2;
-  }
-#endif
-#if defined(ADC3)
-  else if (adc == ADC3)
-  {
-    DIAG(F("ADCee::init(): found pin %d on ADC3"), pin);
-    adcnum = 3;
-  }
-#endif
-  else DIAG(F("ADCee::init(): found pin %d on unknown ADC!"), pin);
-
-    // Port config - find which port we're on and power it up
-    GPIO_TypeDef *gpioBase;
-
-    switch (stmgpio)
-    {
+  // Port config - find which port we're on and power it up
+  switch(stmgpio) {
     case 0x00:
         RCC->AHB1ENR |= RCC_AHB1ENR_GPIOAEN; //Power up PORTA
         gpioBase = GPIOA;
@@ -391,62 +165,31 @@ int ADCee::init(uint8_t pin) {
         RCC->AHB1ENR |= RCC_AHB1ENR_GPIOCEN; //Power up PORTC
         gpioBase = GPIOC;
         break;
-    case 0x03:
-        RCC->AHB1ENR |= RCC_AHB1ENR_GPIODEN; //Power up PORTD
-        gpioBase = GPIOD;
-        break;
-    case 0x04:
-        RCC->AHB1ENR |= RCC_AHB1ENR_GPIOEEN; //Power up PORTE
-        gpioBase = GPIOE;
-        break;
-#if defined(GPIOF)
-    case 0x05:
-        RCC->AHB1ENR |= RCC_AHB1ENR_GPIOFEN; //Power up PORTF
-        gpioBase = GPIOF;
-        break;
-#endif
-    default:
-      return -1023; // some silly value as error
   }
 
-  // Set pin mux mode to analog input, the 32 bit port mode register has 2 bits per pin
-  gpioBase->MODER |= (0b011 << (STM_PIN(stmpin) << 1)); // Set pin mux to analog mode (binary 11)
+  // Set pin mux mode to analog input
+  gpioBase->MODER |= (0b011 << (stmpin << 1)); // Set pin mux to analog mode
 
   // Set the sampling rate for that analog input
-  // This is F411x specific! Different on for example F334
-  // STM32F11xC/E Reference manual
-  // 11.12.4 ADC sample time register 1 (ADC_SMPR1) (channels 10 to 18)
-  // 11.12.5 ADC sample time register 2 (ADC_SMPR2) (channels 0 to 9)
-  if (adcchan > 18)
-    return -1022; // silly value as error
   if (adcchan < 10)
-    adc->SMPR2 |= (0b111 << (adcchan * 3)); // Channel sampling rate 480 cycles
+    ADC1->SMPR2 |= (0b111 << (adcchan * 3)); // Channel sampling rate 480 cycles
   else
-    adc->SMPR1 |= (0b111 << ((adcchan - 10) * 3)); // Channel sampling rate 480 cycles
+    ADC1->SMPR1 |= (0b111 << ((adcchan - 10) * 3)); // Channel sampling rate 480 cycles
 
   // Read the inital ADC value for this analog input
-  adc->SQR3 = adcchan;           // 1st conversion in regular sequence
-  adc->CR2 |= ADC_CR2_SWSTART;   //(1 << 30);                     // Start 1st conversion SWSTART
-  while(!(adc->SR & (1 << 1)));  // Wait until conversion is complete
-  value = adc->DR;               // Read value from register
+  ADC1->SQR3 = adcchan;           // 1st conversion in regular sequence
+  ADC1->CR2 |= (1 << 30);         // Start 1st conversion SWSTART
+  while(!(ADC1->SR & (1 << 1)));  // Wait until conversion is complete
+  value = ADC1->DR;               // Read value from register
 
-  uint8_t id = pin - PNUM_ANALOG_BASE;
-  // if (id > 15) { // today we have not enough bits in the mask to support more
-  //   return -1021;
-  // }
-
-  if (analogvals == NULL) {  // allocate analogvals, analogchans and adcchans if this is the first invocation of init
+  if (analogvals == NULL)
+  {
     analogvals = (int *)calloc(NUM_ADC_INPUTS+1, sizeof(int));
     analogchans = (uint32_t *)calloc(NUM_ADC_INPUTS+1, sizeof(uint32_t));
-    adcchans = (ADC_TypeDef **)calloc(NUM_ADC_INPUTS+1, sizeof(ADC_TypeDef));
   }
   analogvals[id] = value;     // Store sampled value
   analogchans[id] = adcchan;  // Keep track of which ADC channel is used for reading this pin
-  adcchans[id] = adc;         // Keep track of which ADC this channel is on
-  usedpins |= (1 << id);                // This pin is now ready
-  if (id > highestPin) highestPin = id; // Store our highest pin in use
-
-  DIAG(F("ADCee::init(): value=%d, ADC%d: channel=%d, id=%d"), value, adcnum, adcchan, id);
+  usedpins |= (1 << id);      // This pin is now ready
 
   return value;
 }
@@ -455,7 +198,7 @@ int ADCee::init(uint8_t pin) {
  * Read function ADCee::read(pin) to get value instead of analogRead(pin)
  */
 int ADCee::read(uint8_t pin, bool fromISR) {
-  uint8_t id = pin - PNUM_ANALOG_BASE;
+  uint8_t id = pin - A0;
   // Was this pin initialised yet?
   if ((usedpins & (1<<id) ) == 0)
     return -1023;
@@ -470,27 +213,22 @@ int ADCee::read(uint8_t pin, bool fromISR) {
 #pragma GCC push_options
 #pragma GCC optimize ("-O3")
 void ADCee::scan() {
-  static uint8_t id = 0;     // id and mask are the same thing but it is faster to
+  static uint id = 0;        // id and mask are the same thing but it is faster to 
   static uint16_t mask = 1;  // increment and shift instead to calculate mask from id
   static bool waiting = false;
-  static ADC_TypeDef *adc;
 
-  adc = adcchans[id];
-  if (waiting)
-  {
+  if (waiting) {
     // look if we have a result
-    if (!(adc->SR & (1 << 1)))
+    if (!(ADC1->SR & (1 << 1)))
       return; // no result, continue to wait
     // found value
-    analogvals[id] = adc->DR;
+    analogvals[id] = ADC1->DR;
     // advance at least one track
-#ifdef DEBUG_ADC
-    if (id == 1) TrackManager::track[1]->setBrake(0);
-#endif
+    // for scope debug TrackManager::track[1]->setBrake(0);
     waiting = false;
     id++;
     mask = mask << 1;
-    if (id > highestPin) { // the 1 has been shifted out
+    if (id == NUM_ADC_INPUTS+1) {
       id = 0;
       mask = 1;
     }
@@ -501,21 +239,18 @@ void ADCee::scan() {
     // look for a valid track to sample or until we are around
     while (true) {
       if (mask  & usedpins) {
-        // start new ADC aquire on id
-        adc = adcchans[id];
-        adc->SQR3 = analogchans[id]; // 1st conversion in regular sequence
-        adc->CR2 |= (1 << 30);       // Start 1st conversion SWSTART
-#ifdef DEBUG_ADC
-	if (id == 1) TrackManager::track[1]->setBrake(1);
-#endif
-	waiting = true;
-	return;
+    	  // start new ADC aquire on id
+        ADC1->SQR3 = analogchans[id]; //1st conversion in regular sequence
+        ADC1->CR2 |= (1 << 30); //Start 1st conversion SWSTART
+	      // for scope debug TrackManager::track[1]->setBrake(1);
+	      waiting = true;
+	      return;
       }
       id++;
       mask = mask << 1;
-      if (id > highestPin) {
-      	id = 0;
-      	mask = 1;
+      if (id == NUM_ADC_INPUTS+1) {
+	      id = 0;
+	      mask = 1;
       }
     }
   }
@@ -525,83 +260,19 @@ void ADCee::scan() {
 void ADCee::begin() {
   noInterrupts();
   //ADC1 config sequence
-  RCC->APB2ENR |= RCC_APB2ENR_ADC1EN; // Enable ADC1 clock
+  // TODO: currently defaults to ADC1, may need more to handle other members of STM32F4xx family
+  RCC->APB2ENR |= (1 << 8); //Enable ADC1 clock (Bit8) 
   // Set ADC prescaler - DIV8 ~ 40ms, DIV6 ~ 30ms, DIV4 ~ 20ms, DIV2 ~ 11ms
   ADC->CCR = (0 << 16); // Set prescaler 0=DIV2, 1=DIV4, 2=DIV6, 3=DIV8
   ADC1->CR1 &= ~(1 << 8); //SCAN mode disabled (Bit8)
   ADC1->CR1 &= ~(3 << 24); //12bit resolution (Bit24,25 0b00)
   ADC1->SQR1 = (1 << 20); //Set number of conversions projected (L[3:0] 0b0001) -> 1 conversion
-  // Disable the DMA controller for ADC1
-  ADC1->CR2 &= ~ADC_CR2_DMA;
   ADC1->CR2 &= ~(1 << 1); //Single conversion
   ADC1->CR2 &= ~(1 << 11); //Right alignment of data bits bit12....bit0
   ADC1->SQR1 &= ~(0x3FFFFFFF); //Clear whole 1st 30bits in register
   ADC1->SQR2 &= ~(0x3FFFFFFF); //Clear whole 1st 30bits in register
   ADC1->SQR3 &= ~(0x3FFFFFFF); //Clear whole 1st 30bits in register
   ADC1->CR2 |= (1 << 0); // Switch on ADC1
-  // Wait for ADC1 to become ready (calibration complete)
-  while (!(ADC1->CR2 & ADC_CR2_ADON)) {
-  }
-#if defined(ADC2)
-  // Enable the ADC2 clock
-  RCC->APB2ENR |= RCC_APB2ENR_ADC2EN;
-
-  // Initialize ADC2
-  ADC2->CR1 = 0; // Disable all channels
-  ADC2->CR2 = 0; // Clear CR2 register
-
-  ADC2->CR1 &= ~(1 << 8); //SCAN mode disabled (Bit8)
-  ADC2->CR1 &= ~(3 << 24); //12bit resolution (Bit24,25 0b00)
-  ADC2->SQR1 = (1 << 20); //Set number of conversions projected (L[3:0] 0b0001) -> 1 conversion
-  ADC2->CR2 &= ~ADC_CR2_DMA;   // Disable the DMA controller for ADC3
-  ADC2->CR2 &= ~(1 << 1); //Single conversion
-  ADC2->CR2 &= ~(1 << 11); //Right alignment of data bits bit12....bit0
-  ADC2->SQR1 &= ~(0x3FFFFFFF); //Clear whole 1st 30bits in register
-  ADC2->SQR2 &= ~(0x3FFFFFFF); //Clear whole 1st 30bits in register
-  ADC2->SQR3 &= ~(0x3FFFFFFF); //Clear whole 1st 30bits in register
-
-  // Enable the ADC
-  ADC2->CR2 |= ADC_CR2_ADON;
-
-  // Wait for ADC2 to become ready (calibration complete)
-  while (!(ADC2->CR2 & ADC_CR2_ADON)) {
-  }
-
-  // Perform ADC3 calibration (optional)
-  // ADC3->CR2 |= ADC_CR2_CAL;
-  // while (ADC3->CR2 & ADC_CR2_CAL) {
-  // }
-#endif
-#if defined(ADC3)
-  // Enable the ADC3 clock
-  RCC->APB2ENR |= RCC_APB2ENR_ADC3EN;
-
-  // Initialize ADC3
-  ADC3->CR1 = 0; // Disable all channels
-  ADC3->CR2 = 0; // Clear CR2 register
-
-  ADC3->CR1 &= ~(1 << 8); //SCAN mode disabled (Bit8)
-  ADC3->CR1 &= ~(3 << 24); //12bit resolution (Bit24,25 0b00)
-  ADC3->SQR1 = (1 << 20); //Set number of conversions projected (L[3:0] 0b0001) -> 1 conversion
-  ADC3->CR2 &= ~ADC_CR2_DMA;   // Disable the DMA controller for ADC3
-  ADC3->CR2 &= ~(1 << 1); //Single conversion
-  ADC3->CR2 &= ~(1 << 11); //Right alignment of data bits bit12....bit0
-  ADC3->SQR1 &= ~(0x3FFFFFFF); //Clear whole 1st 30bits in register
-  ADC3->SQR2 &= ~(0x3FFFFFFF); //Clear whole 1st 30bits in register
-  ADC3->SQR3 &= ~(0x3FFFFFFF); //Clear whole 1st 30bits in register
-
-  // Enable the ADC
-  ADC3->CR2 |= ADC_CR2_ADON;
-
-  // Wait for ADC3 to become ready (calibration complete)
-  while (!(ADC3->CR2 & ADC_CR2_ADON)) {
-  }
-
-  // Perform ADC3 calibration (optional)
-  // ADC3->CR2 |= ADC_CR2_CAL;
-  // while (ADC3->CR2 & ADC_CR2_CAL) {
-  // }
-#endif
   interrupts();
 }
-#endif
+#endif

DCCWaveform.cpp

@@ -106,7 +106,6 @@ void DCCWaveform::interruptHandler() {
 DCCWaveform::DCCWaveform( byte preambleBits, bool isMain) {
   isMainTrack = isMain;
   packetPending = false;
-  reminderWindowOpen = false;
   memcpy(transmitPacket, idlePacket, sizeof(idlePacket));
   state = WAVE_START;
   // The +1 below is to allow the preamble generator to create the stop bit
@@ -128,15 +127,9 @@ void DCCWaveform::interrupt2() {
   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<4 && remainingPreambles>1;
-    if (remainingPreambles==1) promotePendingPacket();
     // 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); 
+    DCCTimer::updateMinimumFreeMemoryISR(22); 
     return;
   }
 
@@ -155,9 +148,30 @@ void DCCWaveform::interrupt2() {
     if (bytes_sent >= transmitLength) {
       // end of transmission buffer... repeat or switch to next message
       bytes_sent = 0;
-      // preamble for next packet will start...
       remainingPreambles = requiredPreambles;
+
+      if (transmitRepeats > 0) {
+        transmitRepeats--;
       }
+      else if (packetPending) {
+        // Copy pending packet to transmit packet
+        // a fixed length memcpy is faster than a variable length loop for these small lengths
+        // for (int b = 0; b < pendingLength; b++) transmitPacket[b] = pendingPacket[b];
+        memcpy( transmitPacket, pendingPacket, sizeof(pendingPacket));
+        
+        transmitLength = pendingLength;
+        transmitRepeats = pendingRepeats;
+        packetPending = false;
+        clearResets();
+      }
+      else {
+        // Fortunately reset and idle packets are the same length
+        memcpy( transmitPacket, isMainTrack ? idlePacket : resetPacket, sizeof(idlePacket));
+        transmitLength = sizeof(idlePacket);
+        transmitRepeats = 0;
+        if (getResets() < 250) sentResetsSincePacket++; // only place to increment (private!)
+      }
+    }
   }  
 }
 #pragma GCC pop_options
@@ -179,39 +193,8 @@ void DCCWaveform::schedulePacket(const byte buffer[], byte byteCount, byte repea
   packetPending = true;
   clearResets();
 }
-
-bool DCCWaveform::isReminderWindowOpen() {
-  return reminderWindowOpen && ! packetPending;
-}
-
-void DCCWaveform::promotePendingPacket() {
-    // fill the transmission packet from the pending packet
-    
-    // Just keep going if repeating  
-    if (transmitRepeats > 0) {
-        transmitRepeats--;
-        return;
-      }
-
-    if (packetPending) {
-        // Copy pending packet to transmit packet
-        // a fixed length memcpy is faster than a variable length loop for these small lengths
-        // for (int b = 0; b < pendingLength; b++) transmitPacket[b] = pendingPacket[b];
-        memcpy( transmitPacket, pendingPacket, sizeof(pendingPacket));
-        
-        transmitLength = pendingLength;
-        transmitRepeats = pendingRepeats;
-        packetPending = false;
-        clearResets();
-        return;
-      }
-      
-      // nothing to do, just send idles or resets
-      // Fortunately reset and idle packets are the same length
-      memcpy( transmitPacket, isMainTrack ? idlePacket : resetPacket, sizeof(idlePacket));
-      transmitLength = sizeof(idlePacket);
-      transmitRepeats = 0;
-      if (getResets() < 250) sentResetsSincePacket++; // only place to increment (private!)
+bool DCCWaveform::getPacketPending() {
+  return packetPending;
 }
 #endif
 
@@ -264,9 +247,6 @@ void DCCWaveform::schedulePacket(const byte buffer[], byte byteCount, byte repea
   pendingPacket[byteCount] = checksum;
   pendingLength = byteCount + 1;
   pendingRepeats = repeats;
-// DIAG repeated commands (accesories)
-//  if (pendingRepeats > 0)
-//    DIAG(F("Repeats=%d on %s track"), pendingRepeats, isMainTrack ? "MAIN" : "PROG");
   // The resets will be zero not only now but as well repeats packets into the future
   clearResets(repeats+1);
   {
@@ -283,15 +263,15 @@ void DCCWaveform::schedulePacket(const byte buffer[], byte byteCount, byte repea
   }
 }
 
-bool DCCWaveform::isReminderWindowOpen() {
+bool DCCWaveform::getPacketPending() {
   if(isMainTrack) {
     if (rmtMainChannel == NULL)
-      return false;
-    return !rmtMainChannel->busy();
+      return true;
+    return rmtMainChannel->busy();
   } else {
     if (rmtProgChannel == NULL)
-      return false;
-    return !rmtProgChannel->busy();
+      return true;
+    return rmtProgChannel->busy();
   }
 }
 void IRAM_ATTR DCCWaveform::loop() {

DCCWaveform.h

@@ -2,7 +2,7 @@
  *  © 2021 M Steve Todd
  *  © 2021 Mike S
  *  © 2021 Fred Decker
- *  © 2020-2024 Harald Barth
+ *  © 2020-2021 Harald Barth
  *  © 2020-2021 Chris Harlow
  *  All rights reserved.
  *  
@@ -33,9 +33,9 @@
 
 
 // Number of preamble bits.
-const byte PREAMBLE_BITS_MAIN = 16;
-const byte PREAMBLE_BITS_PROG = 22;
-const byte MAX_PACKET_SIZE = 5;     // NMRA standard extended packets, payload size WITHOUT checksum.
+const int   PREAMBLE_BITS_MAIN = 16;
+const int   PREAMBLE_BITS_PROG = 22;
+const byte   MAX_PACKET_SIZE = 5;  // NMRA standard extended packets, payload size WITHOUT checksum.
 
 
 // The WAVE_STATE enum is deliberately numbered because a change of order would be catastrophic
@@ -76,13 +76,11 @@ class DCCWaveform {
     };
 #endif
     void schedulePacket(const byte buffer[], byte byteCount, byte repeats);
-    bool isReminderWindowOpen();
-    void promotePendingPacket();
+    bool getPacketPending();
     
   private:
 #ifndef ARDUINO_ARCH_ESP32
     volatile bool packetPending;
-    volatile bool reminderWindowOpen;
     volatile byte sentResetsSincePacket;
 #else
     volatile uint32_t resetPacketBase;

DIAG.h

@@ -24,5 +24,4 @@
 #include "StringFormatter.h"
 #define DIAG  StringFormatter::diag
 #define LCD   StringFormatter::lcd
-#define SCREEN  StringFormatter::lcd2
 #endif

Display.cpp

@@ -1,219 +0,0 @@
-/*
- *  © 2021, Chris Harlow, Neil McKechnie. 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/>.
- */
-
-// CAUTION: the device dependent parts of this class are created in the .ini
-// using LCD_Implementation.h
-
-/* The strategy for drawing the screen is as follows.
- *  1) There are up to eight rows of text to be displayed.
- *  2) Blank rows of text are ignored.
- *  3) If there are more non-blank rows than screen lines,
- *     then all of the rows are displayed, with the rest of the
- *     screen being blank.
- *  4) If there are fewer non-blank rows than screen lines,
- *     then a scrolling strategy is adopted so that, on each screen
- *     refresh, a different subset of the rows is presented.
- *  5) On each entry into loop2(), a single operation is sent to the 
- *     screen; this may be a position command or a character for
- *     display.  This spreads the onerous work of updating the screen
- *     and ensures that other loop() functions in the application are
- *     not held up significantly.  The exception to this is when 
- *     the loop2() function is called with force=true, where 
- *     a screen update is executed to completion.  This is normally
- *     only done during start-up.
- *  The scroll mode is selected by defining SCROLLMODE as 0, 1 or 2
- *  in the config.h.
- *  #define SCROLLMODE 0 is scroll continuous (fill screen if poss),
- *  #define SCROLLMODE 1 is by page (alternate between pages),
- *  #define SCROLLMODE 2 is by row (move up 1 row at a time).
-
- */
-
-#include "Display.h"
-
-// Constructor - allocates device driver.
-Display::Display(DisplayDevice *deviceDriver) {
-  _deviceDriver = deviceDriver;
-  // Get device dimensions in characters (e.g. 16x2).
-  numScreenColumns = _deviceDriver->getNumCols();
-  numScreenRows = _deviceDriver->getNumRows();
-  for (uint8_t row = 0; row < MAX_CHARACTER_ROWS; row++) 
-    rowBuffer[row][0] = '\0';
-  
-  addDisplay(0);  // Add this display as display number 0
-};
-
-void Display::begin() {
-  _deviceDriver->begin();
-  _deviceDriver->clearNative();
-}
-
-void Display::_clear() {
-  _deviceDriver->clearNative();
-  for (uint8_t row = 0; row < MAX_CHARACTER_ROWS; row++) 
-    rowBuffer[row][0] = '\0';
-}
-
-void Display::_setRow(uint8_t line) {
-  hotRow = line;
-  hotCol = 0;
-  rowBuffer[hotRow][0] = '\0';  // Clear existing text
-}
-
-size_t Display::_write(uint8_t b) {
-  if (hotRow >= MAX_CHARACTER_ROWS || hotCol >= MAX_CHARACTER_COLS) return -1;
-  rowBuffer[hotRow][hotCol] = b;
-  hotCol++;
-  rowBuffer[hotRow][hotCol] = '\0';
-  return 1;
-}
-
-// Refresh screen completely (will block until complete). Used
-// during start-up.
-void Display::_refresh() {
-  loop2(true);
-}
-
-// On normal loop entries, loop will only make one output request on each
-// entry, to avoid blocking while waiting for the I2C.
-void Display::_displayLoop() {
-  // If output device is busy, don't do anything on this loop
-  // This avoids blocking while waiting for the device to complete.
-  if (!_deviceDriver->isBusy()) loop2(false);
-}
-
-Display *Display::loop2(bool force) {
-  unsigned long currentMillis = millis();
-
-  if (!force) {
-    // See if we're in the time between updates
-    if ((currentMillis - lastScrollTime) < DISPLAY_SCROLL_TIME)
-      return NULL;
-  } else {
-    // force full screen update from the beginning.
-    rowFirst = 0;
-    rowCurrent = 0;
-    bufferPointer = 0;
-    noMoreRowsToDisplay = false;
-    slot = 0;
-  }
-
-  do {
-    if (bufferPointer == 0) {
-      // Search for non-blank row
-      while (!noMoreRowsToDisplay) {
-        if (!isCurrentRowBlank()) break;
-        moveToNextRow();
-        if (rowCurrent == rowFirst) noMoreRowsToDisplay = true;  
-      }
-
-      if (noMoreRowsToDisplay) {
-        // No non-blank lines left, so draw blank line
-        buffer[0] = '\0';
-      } else {
-        // Non-blank line found, so copy it (including terminator)
-        for (uint8_t i = 0; i <= MAX_CHARACTER_COLS; i++)
-          buffer[i] = rowBuffer[rowCurrent][i];
-      }
-      _deviceDriver->setRowNative(slot);  // Set position for display
-      charIndex = 0;
-      bufferPointer = &buffer[0];
-    } else {
-      // Write next character, or a space to erase current position.
-      char ch = *bufferPointer;
-      if (ch) {
-        _deviceDriver->writeNative(ch);
-        bufferPointer++;
-      } else {
-        _deviceDriver->writeNative(' ');
-      }
-
-      if (++charIndex >= MAX_CHARACTER_COLS) {
-        // Screen slot completed, move to next nonblank row
-        bufferPointer = 0;
-        for (;;) {
-          moveToNextRow();
-          if (rowCurrent == rowFirst) {
-            noMoreRowsToDisplay = true;
-            break;
-          }  
-          if (!isCurrentRowBlank()) break;
-        }
-        // Move to next screen slot, if available
-        slot++;
-        if (slot >= numScreenRows) {
-          // Last slot on screen written, so get ready for next screen update.
-#if SCROLLMODE==0
-          // Scrollmode 0 scrolls continuously.  If the rows fit on the screen,
-          // then restart at row 0, but otherwise continue with the row
-          // after the last one displayed.
-          if (countNonBlankRows() <= numScreenRows)
-            rowCurrent = 0;
-          rowFirst = rowCurrent;
-#elif SCROLLMODE==1
-          // Scrollmode 1 scrolls by page, so if the last page has just completed then
-          // next time restart with row 0.
-          if (noMoreRowsToDisplay) 
-            rowFirst = rowCurrent = 0;
-#else
-          // Scrollmode 2 scrolls by row.  If the rows don't fit on the screen,
-          // then start one row further on next time.  If they do fit, then 
-          // show them in order and start next page at row 0.
-          if (countNonBlankRows() <= numScreenRows) {
-            rowFirst = rowCurrent = 0;
-          } else {
-            // Find first non-blank row after the previous first row
-            rowCurrent = rowFirst;
-            do {
-              moveToNextRow();
-            } while (isCurrentRowBlank());
-            rowFirst = rowCurrent;
-          }
-#endif
-          noMoreRowsToDisplay = false;
-          slot = 0;
-          lastScrollTime = currentMillis;
-          return NULL;
-        }
-      }
-    }
-  } while (force);
-
-  return NULL;
-}
-
-bool Display::isCurrentRowBlank() {
-  return (rowBuffer[rowCurrent][0] == '\0');
-}
-
-void Display::moveToNextRow() {
-  // Skip blank rows
-  if (++rowCurrent >= MAX_CHARACTER_ROWS) 
-      rowCurrent = 0;
-}
-
-uint8_t Display::countNonBlankRows() {
-  uint8_t count = 0;
-  for (uint8_t rowNumber=0; rowNumber<MAX_CHARACTER_ROWS; rowNumber++) {
-    if (rowBuffer[rowNumber][0] != '\0')
-      count++;
-  }
-  return count;
-}
-  

Display.h

@@ -1,79 +0,0 @@
-/*
- *  © 2021, Chris Harlow, Neil McKechnie. 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/>.
- */
-#ifndef Display_h
-#define Display_h
-#include <Arduino.h>
-#include "defines.h"
-#include "DisplayInterface.h"
-
-// Allow maximum message length to be overridden from config.h
-#if !defined(MAX_MSG_SIZE)
-#define MAX_MSG_SIZE 20 
-#endif
-
-// Set default scroll mode (overridable in config.h)
-#if !defined(SCROLLMODE) 
-#define SCROLLMODE 1
-#endif
-
-// This class is created in Display_Implementation.h
-
-class Display : public DisplayInterface {
-public:
-  Display(DisplayDevice *deviceDriver);
-#if !defined (MAX_CHARACTER_ROWS)
-  static const int MAX_CHARACTER_ROWS = 8;
-#endif
-  static const int MAX_CHARACTER_COLS = MAX_MSG_SIZE;
-  static const long DISPLAY_SCROLL_TIME = 3000;  // 3 seconds
-
-private:
-  DisplayDevice *_deviceDriver;
-
-  unsigned long lastScrollTime = 0;
-  uint8_t hotRow = 0;
-  uint8_t hotCol = 0;
-  uint8_t slot = 0;
-  uint8_t rowFirst = 0;
-  uint8_t rowCurrent = 0;
-  uint8_t charIndex = 0;
-  char buffer[MAX_CHARACTER_COLS + 1];
-  char* bufferPointer = 0;
-  bool noMoreRowsToDisplay = false;
-  uint16_t numScreenRows;
-  uint16_t numScreenColumns = MAX_CHARACTER_COLS;
-
-  char rowBuffer[MAX_CHARACTER_ROWS][MAX_CHARACTER_COLS+1];
-
-public:
-  void begin() override;  
-  void _clear() override;
-  void _setRow(uint8_t line) override;
-  size_t _write(uint8_t b) override;
-  void _refresh() override;
-  void _displayLoop() override;
-  Display *loop2(bool force);
-  bool findNonBlankRow();
-  bool isCurrentRowBlank();
-  void moveToNextRow();
-  uint8_t countNonBlankRows();
-
-};
-
-#endif

DisplayInterface.cpp

@@ -21,7 +21,4 @@
 
 #include "DisplayInterface.h"
 
-// Install null display driver initially - will be replaced if required.
-DisplayInterface *DisplayInterface::_displayHandler = new DisplayInterface();
-
-uint8_t DisplayInterface::_selectedDisplayNo = 255;
+DisplayInterface *DisplayInterface::lcdDisplay = 0;

DisplayInterface.h

@@ -25,75 +25,13 @@
 
 // Definition of base class for displays.  The base class does nothing.
 class DisplayInterface : public Print {
-protected:
-  static DisplayInterface *_displayHandler;
-  static uint8_t _selectedDisplayNo;  // Nothing selected.
-  DisplayInterface *_nextHandler = NULL;
-  uint8_t _displayNo = 0;
-
 public:
-  // Add display object to list of displays
-  void addDisplay(uint8_t displayNo) {
-    _nextHandler = _displayHandler;
-    _displayHandler = this;
-    _displayNo = displayNo;
-  }
-  static DisplayInterface *getDisplayHandler() {
-    return _displayHandler;
-  }
-  uint8_t getDisplayNo() {
-    return _displayNo;
-  }
+  virtual DisplayInterface* loop2(bool force) { (void)force; return NULL; };
+  virtual void setRow(byte line) { (void)line; };
+  virtual void clear() {};
+  virtual size_t write(uint8_t c) { (void)c; return 0; };
 
-  // The next functions are to provide compatibility with calls to the LCD function
-  // which does not specify a display number.  These always apply to display '0'.
-  static void refresh() { refresh(0); };
-  static void setRow(uint8_t line) { setRow(0, line); };
-  static void clear() { clear(0); };
-
-  // Additional functions to support multiple displays.  These perform a
-  // multicast to all displays that match the selected displayNo.
-  // Display number zero is the default one.
-  static void setRow(uint8_t displayNo, uint8_t line) { 
-    _selectedDisplayNo = displayNo;
-    for (DisplayInterface *p = _displayHandler; p!=0; p=p->_nextHandler) { 
-      if (displayNo == p->_displayNo) p->_setRow(line);
-    }
-  }
-  size_t write (uint8_t c) override {
-    for (DisplayInterface *p = _displayHandler; p!=0; p=p->_nextHandler) 
-      if (_selectedDisplayNo == p->_displayNo) p->_write(c);
-    return _displayHandler ? 1 : 0;
-  }
-  static void clear(uint8_t displayNo) { 
-    for (DisplayInterface *p = _displayHandler; p!=0; p=p->_nextHandler) 
-      if (displayNo == p->_displayNo) p->_clear();
-  }
-  static void refresh(uint8_t displayNo) {
-    for (DisplayInterface *p = _displayHandler; p!=0; p=p->_nextHandler)
-      if (displayNo == p->_displayNo) p->_refresh();
-  }
-  static void loop() {
-    for (DisplayInterface *p = _displayHandler; p!=0; p=p->_nextHandler) 
-      p->_displayLoop();
-  };
-  // The following are overridden within the specific device class
-  virtual void begin() {};
-  virtual size_t _write(uint8_t c) { (void)c; return 0; };
-  virtual void _setRow(uint8_t line) { (void)line; }
-  virtual void _clear() {}
-  virtual void _refresh() {}
-  virtual void _displayLoop() {}
+  static DisplayInterface *lcdDisplay;
 };
 
-class DisplayDevice {
-public:
-  virtual bool begin() { return true; }
-  virtual void clearNative() = 0;
-  virtual void setRowNative(uint8_t line) = 0;
-  virtual size_t writeNative(uint8_t c) = 0;
-  virtual bool isBusy() = 0;
-  virtual uint16_t getNumRows() = 0;
-  virtual uint16_t getNumCols() = 0;
-};
 #endif

ESP32-fixes.cpp

@@ -0,0 +1,61 @@
+/*
+ *  © 2022 Harald Barth
+ *  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/>.
+ */
+#ifdef ARDUINO_ARCH_ESP32
+#include <Arduino.h>
+#include "ESP32-fixes.h"
+
+#include "esp32-hal.h"
+#include "soc/soc_caps.h"
+
+
+#ifdef SOC_LEDC_SUPPORT_HS_MODE
+#define LEDC_CHANNELS           (SOC_LEDC_CHANNEL_NUM<<1)
+#else
+#define LEDC_CHANNELS           (SOC_LEDC_CHANNEL_NUM)
+#endif
+
+static int8_t pin_to_channel[SOC_GPIO_PIN_COUNT] = { 0 };
+static int cnt_channel = LEDC_CHANNELS;
+
+void DCCEXanalogWriteFrequency(uint8_t pin, uint32_t frequency) {
+  if (pin < SOC_GPIO_PIN_COUNT) {
+    if (pin_to_channel[pin] != 0) {
+      ledcSetup(pin_to_channel[pin], frequency, 8);
+    }
+  }
+}
+
+void DCCEXanalogWrite(uint8_t pin, int value) {
+  if (pin < SOC_GPIO_PIN_COUNT) {
+    if (pin_to_channel[pin] == 0) {
+      if (!cnt_channel) {
+          log_e("No more PWM channels available! All %u already used", LEDC_CHANNELS);
+          return;
+      }
+      pin_to_channel[pin] = --cnt_channel;
+      ledcAttachPin(pin, cnt_channel);
+      ledcSetup(cnt_channel, 1000, 8);
+    } else {
+      ledcAttachPin(pin, pin_to_channel[pin]);
+    }
+    ledcWrite(pin_to_channel[pin], value);
+  }
+}
+#endif

ESP32-fixes.h

@@ -0,0 +1,26 @@
+/*
+ *  © 2022 Harald Barth
+ *  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/>.
+ */
+#ifdef ARDUINO_ARCH_ESP32
+#pragma once
+#include <Arduino.h>
+void DCCEXanalogWriteFrequency(uint8_t pin, uint32_t frequency);
+void DCCEXanalogWrite(uint8_t pin, int value);
+#endif
+

EXRAIL2.cpp

@@ -1,8 +1,7 @@
 /*
  *  © 2021 Neil McKechnie
  *  © 2021-2023 Harald Barth
- *  © 2020-2023 Chris Harlow
- *  © 2022-2023 Colin Murdoch
+ *  © 2020-2022 Chris Harlow
  *  All rights reserved.
  *  
  *  This file is part of CommandStation-EX
@@ -25,8 +24,8 @@
    F1. [DONE] DCC accessory packet opcodes (short and long form)
    F2. [DONE] ONAccessory catchers 
    F3. [DONE] Turnout descriptions for Withrottle
-   F4. [DONE] Oled announcements (depends on HAL)
-   F5. [DONE] Withrottle roster info
+   F4. Oled announcements (depends on HAL)
+   F5. Withrottle roster info
    F6. Multi-occupancy semaphore
    F7. [DONE see AUTOSTART] Self starting sequences
    F8. Park/unpark
@@ -52,9 +51,23 @@
 #include "Turnouts.h"
 #include "CommandDistributor.h"
 #include "TrackManager.h"
-#include "Turntables.h"
-#include "IODevice.h"
 
+// Command parsing keywords
+const int16_t HASH_KEYWORD_EXRAIL=15435;    
+const int16_t HASH_KEYWORD_ON = 2657;
+const int16_t HASH_KEYWORD_START=23232;
+const int16_t HASH_KEYWORD_RESERVE=11392;
+const int16_t HASH_KEYWORD_FREE=-23052;
+const int16_t HASH_KEYWORD_LATCH=1618;  
+const int16_t HASH_KEYWORD_UNLATCH=1353;
+const int16_t HASH_KEYWORD_PAUSE=-4142;
+const int16_t HASH_KEYWORD_RESUME=27609;
+const int16_t HASH_KEYWORD_KILL=5218;
+const int16_t HASH_KEYWORD_ALL=3457;
+const int16_t HASH_KEYWORD_ROUTES=-3702;
+const int16_t HASH_KEYWORD_RED=26099;
+const int16_t HASH_KEYWORD_AMBER=18713;
+const int16_t HASH_KEYWORD_GREEN=-31493;
 
 // One instance of RMFT clas is used for each "thread" in the automation.
 // Each thread manages a loco on a journey through the layout, and/or may manage a scenery automation.
@@ -69,8 +82,8 @@ RMFT2 * RMFT2::pausingTask=NULL; // Task causing a PAUSE.
  // when pausingTask is set, that is the ONLY task that gets any service,
  // and all others will have their locos stopped, then resumed after the pausing task resumes.
 byte RMFT2::flags[MAX_FLAGS];
-Print * RMFT2::LCCSerial=0;
-LookList *  RMFT2::routeLookup=NULL;
+
+LookList *  RMFT2::sequenceLookup=NULL;
 LookList *  RMFT2::onThrowLookup=NULL;
 LookList *  RMFT2::onCloseLookup=NULL;
 LookList *  RMFT2::onActivateLookup=NULL;
@@ -80,14 +93,9 @@ LookList *  RMFT2::onAmberLookup=NULL;
 LookList *  RMFT2::onGreenLookup=NULL;
 LookList *  RMFT2::onChangeLookup=NULL;
 LookList *  RMFT2::onClockLookup=NULL;
-#ifndef IO_NO_HAL
-LookList *  RMFT2::onRotateLookup=NULL;
-#endif
-LookList *  RMFT2::onOverloadLookup=NULL;
-byte * RMFT2::routeStateArray=nullptr; 
-const FSH  * * RMFT2::routeCaptionArray=nullptr; 
-int16_t * RMFT2::stashArray=nullptr;
-int16_t RMFT2::maxStashId=0;
+
+#define GET_OPCODE GETHIGHFLASH(RMFT2::RouteCode,progCounter)
+#define SKIPOP progCounter+=3
 
 // getOperand instance version, uses progCounter from instance.
 uint16_t RMFT2::getOperand(byte n) {
@@ -97,15 +105,17 @@ uint16_t RMFT2::getOperand(byte n) {
 // getOperand static version, must be provided prog counter from loop etc.
 uint16_t RMFT2::getOperand(int progCounter,byte n) {
   int offset=progCounter+1+(n*3);
-  byte lsb=GETHIGHFLASH(RouteCode,offset);
-  byte msb=GETHIGHFLASH(RouteCode,offset+1);
-  return msb<<8|lsb;
+  if (offset&1) {
+       byte lsb=GETHIGHFLASH(RouteCode,offset);
+       byte msb=GETHIGHFLASH(RouteCode,offset+1);
+       return msb<<8|lsb;
+  }
+  return GETHIGHFLASHW(RouteCode,offset);
 }
 
 LookList::LookList(int16_t size) {
   m_size=size;
   m_loaded=0;
-  m_chain=nullptr;
   if (size) {
     m_lookupArray=new int16_t[size];
     m_resultArray=new int16_t[size];
@@ -123,35 +133,8 @@ int16_t LookList::find(int16_t value) {
   for (int16_t i=0;i<m_size;i++) {
     if (m_lookupArray[i]==value) return m_resultArray[i];
   }
-  return m_chain ?  m_chain->find(value)  :-1;
-}
-void LookList::chain(LookList * chain) {
-  m_chain=chain;
-}
-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]);
-}
-
-
-void LookList::stream(Print * _stream) {
-  for (int16_t i=0;i<m_size;i++) {
-    _stream->print(" ");
-    _stream->print(m_lookupArray[i]);
-  }
-}
-
-int16_t LookList::findPosition(int16_t value) {
-  for (int16_t i=0;i<m_size;i++) {
-    if (m_lookupArray[i]==value) return i;
-  }
   return -1;
 }
-int16_t LookList::size() {
-   return m_size;
-}
 
 LookList* RMFT2::LookListLoader(OPCODE op1, OPCODE op2, OPCODE op3) {
   int progCounter;
@@ -184,36 +167,25 @@ LookList* RMFT2::LookListLoader(OPCODE op1, OPCODE op2, OPCODE op3) {
   for (int f=0;f<MAX_FLAGS;f++) flags[f]=0;
   
   // create lookups
-  routeLookup=LookListLoader(OPCODE_ROUTE, OPCODE_AUTOMATION);
-  routeLookup->chain(LookListLoader(OPCODE_SEQUENCE));
-  if (compileFeatures && FEATURE_ROUTESTATE) {
-    routeStateArray=(byte *)calloc(routeLookup->size(),sizeof(byte));
-    routeCaptionArray=(const FSH * *)calloc(routeLookup->size(),sizeof(const FSH *));
-  }
+  sequenceLookup=LookListLoader(OPCODE_ROUTE, OPCODE_AUTOMATION,OPCODE_SEQUENCE);
   onThrowLookup=LookListLoader(OPCODE_ONTHROW);
   onCloseLookup=LookListLoader(OPCODE_ONCLOSE);
   onActivateLookup=LookListLoader(OPCODE_ONACTIVATE);
   onDeactivateLookup=LookListLoader(OPCODE_ONDEACTIVATE);
-  onChangeLookup=LookListLoader(OPCODE_ONCHANGE);
-  onClockLookup=LookListLoader(OPCODE_ONTIME);
-#ifndef IO_NO_HAL
-  onRotateLookup=LookListLoader(OPCODE_ONROTATE);
-#endif
-  onOverloadLookup=LookListLoader(OPCODE_ONOVERLOAD);
-  // onLCCLookup is not the same so not loaded here. 
-
-  // Second pass startup, define any turnouts or servos, set signals red
-  // add sequences onRoutines to the lookups
-if (compileFeatures & FEATURE_SIGNAL) {
   onRedLookup=LookListLoader(OPCODE_ONRED);
   onAmberLookup=LookListLoader(OPCODE_ONAMBER);
   onGreenLookup=LookListLoader(OPCODE_ONGREEN);
+  onChangeLookup=LookListLoader(OPCODE_ONCHANGE);
+  onClockLookup=LookListLoader(OPCODE_ONTIME);
+
+
+  // Second pass startup, define any turnouts or servos, set signals red
+  // add sequences onRoutines to the lookups
   for (int sigslot=0;;sigslot++) {
     VPIN sigid=GETHIGHFLASHW(RMFT2::SignalDefinitions,sigslot*8);
     if (sigid==0) break;  // end of signal list
     doSignal(sigid & SIGNAL_ID_MASK, SIGNAL_RED);
   }
-  }
 
   int progCounter;
   for (progCounter=0;; SKIPOP){
@@ -225,28 +197,21 @@ if (compileFeatures & FEATURE_SIGNAL) {
     case OPCODE_AT:
     case OPCODE_ATTIMEOUT2:
     case OPCODE_AFTER:
-    case OPCODE_AFTEROVERLOAD:
     case OPCODE_IF:
     case OPCODE_IFNOT: {
       int16_t pin = (int16_t)operand;
       if (pin<0) pin = -pin;
-      DIAG(F("EXRAIL input VPIN %u"),pin);
+      DIAG(F("EXRAIL input vpin %d"),pin);
       IODevice::configureInput((VPIN)pin,true);
       break;
     }
-    case OPCODE_STASH:
-    case OPCODE_CLEAR_STASH:
-    case OPCODE_PICKUP_STASH: {
-      maxStashId=max(maxStashId,((int16_t)operand));
-      break;
-    }
 
     case OPCODE_ATGTE:
     case OPCODE_ATLT:
     case OPCODE_IFGTE:
     case OPCODE_IFLT:
     case OPCODE_DRIVE: {
-      DIAG(F("EXRAIL analog input VPIN %u"),(VPIN)operand);
+      DIAG(F("EXRAIL analog input vpin %d"),(VPIN)operand);
       IODevice::configureAnalogIn((VPIN)operand);
       break;
     }
@@ -275,43 +240,11 @@ if (compileFeatures & FEATURE_SIGNAL) {
       setTurnoutHiddenState(VpinTurnout::create(id,pin));
       break;
     }
-
-#ifndef IO_NO_HAL
-    case OPCODE_DCCTURNTABLE: {
-      VPIN id=operand;
-      int home=getOperand(progCounter,1);
-      setTurntableHiddenState(DCCTurntable::create(id));
-      Turntable *tto=Turntable::get(id);
-      tto->addPosition(0,0,home);
-      break;
-    }
-
-    case OPCODE_EXTTTURNTABLE: {
-      VPIN id=operand;
-      VPIN pin=getOperand(progCounter,1);
-      int home=getOperand(progCounter,3);
-      setTurntableHiddenState(EXTTTurntable::create(id,pin));
-      Turntable *tto=Turntable::get(id);
-      tto->addPosition(0,0,home);
-      break;
-    }
-
-    case OPCODE_TTADDPOSITION: {
-      VPIN id=operand;
-      int position=getOperand(progCounter,1);
-      int value=getOperand(progCounter,2);
-      int angle=getOperand(progCounter,3);
-      Turntable *tto=Turntable::get(id);
-      tto->addPosition(position,value,angle);
-      break;
-    }
-#endif
-
+        
     case OPCODE_AUTOSTART:
       // automatically create a task from here at startup.
-      // Removed if (progCounter>0) check 4.2.31 because 
-      // default start it top of file is now removed. .   
-      new RMFT2(progCounter);
+      // but we will do one at 0 anyway by default.
+      if (progCounter>0) new RMFT2(progCounter);
       break;
       
     default: // Ignore
@@ -319,42 +252,196 @@ if (compileFeatures & FEATURE_SIGNAL) {
     }
   }
   SKIPOP; // include ENDROUTES opcode
-  
-  if (compileFeatures & FEATURE_STASH) {
-    // create the stash array from the highest id found
-    if (maxStashId>0) stashArray=(int16_t*)calloc(maxStashId+1, sizeof(int16_t));
-     //TODO check EEPROM and fetch stashArray
-  }
-  
-  DIAG(F("EXRAIL %db, fl=%d, stash=%d"),progCounter,MAX_FLAGS, maxStashId);
 
-  // Removed for 4.2.31  new RMFT2(0); // add the startup route
+  DIAG(F("EXRAIL %db, fl=%d"),progCounter,MAX_FLAGS);
+
+  new RMFT2(0); // add the startup route
   diag=saved_diag;
 }
 
 void RMFT2::setTurnoutHiddenState(Turnout * t) {
-  // turnout descriptions are in low flash F strings
-  const FSH *desc = getTurnoutDescription(t->getId());
-  if (desc) t->setHidden(GETFLASH(desc)==0x01);
+  // turnout descriptions are in low flash F strings 
+  t->setHidden(GETFLASH(getTurnoutDescription(t->getId()))==0x01);     
 }
 
-#ifndef IO_NO_HAL
-void RMFT2::setTurntableHiddenState(Turntable * tto) {
-  const FSH *desc = getTurntableDescription(tto->getId());
-  if (desc) tto->setHidden(GETFLASH(desc)==0x01);
-}
-#endif
-
 char RMFT2::getRouteType(int16_t id) {
-  int16_t progCounter=routeLookup->find(id);
-  if (progCounter>=0) {
-    byte type=GET_OPCODE; 
-    if (type==OPCODE_ROUTE) return 'R';
-    if (type==OPCODE_AUTOMATION) return 'A';
+  for (int16_t i=0;;i+=2) {
+    int16_t rid= GETHIGHFLASHW(routeIdList,i);
+    if (rid==id) return 'R';
+    if (rid==0) break;
+  }
+  for (int16_t i=0;;i+=2) {
+    int16_t rid= GETHIGHFLASHW(automationIdList,i);
+    if (rid==id) return 'A';
+    if (rid==0) break;
   }
   return 'X';
+}   
+// This filter intercepts <> commands to do the following:
+// - Implement RMFT specific commands/diagnostics
+// - Reject/modify JMRI commands that would interfere with RMFT processing
+void RMFT2::ComandFilter(Print * stream, byte & opcode, byte & paramCount, int16_t p[]) {
+  (void)stream; // avoid compiler warning if we don't access this parameter
+  bool reject=false;
+  switch(opcode) {
+    
+  case 'D':
+    if (p[0]==HASH_KEYWORD_EXRAIL) { // <D EXRAIL ON/OFF>
+      diag = paramCount==2 && (p[1]==HASH_KEYWORD_ON || p[1]==1);
+      opcode=0;
+    }
+        break;
+	
+  case '/':  // New EXRAIL command
+    reject=!parseSlash(stream,paramCount,p);
+    opcode=0;
+    break;
+    
+  default:  // other commands pass through
+    break;
+  }
+  if (reject) {
+    opcode=0;
+    StringFormatter::send(stream,F("<X>"));
+  }
 }
 
+bool RMFT2::parseSlash(Print * stream, byte & paramCount, int16_t p[]) {
+
+  if (paramCount==0) { // STATUS
+    StringFormatter::send(stream, F("<* EXRAIL STATUS"));
+    RMFT2 * task=loopTask;
+    while(task) {
+      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->speedo,
+			    task->forward?'F':'R'
+			    );
+      task=task->next;
+      if (task==loopTask) break;
+    }
+    // Now stream the flags
+    for (int id=0;id<MAX_FLAGS; id++) {
+      byte flag=flags[id];
+      if (flag & ~TASK_FLAG & ~SIGNAL_MASK) { // not interested in TASK_FLAG only. Already shown above
+	      StringFormatter::send(stream,F("\nflags[%d] "),id);
+	      if (flag & SECTION_FLAG) StringFormatter::send(stream,F(" RESERVED"));
+	      if (flag & LATCH_FLAG) StringFormatter::send(stream,F(" LATCHED"));
+      }
+    }
+    // do the signals
+    // flags[n] represents the state of the nth signal in the table 
+    for (int sigslot=0;;sigslot++) {
+      VPIN sigid=GETHIGHFLASHW(RMFT2::SignalDefinitions,sigslot*8);
+      if (sigid==0) break; // end of signal list 
+      byte flag=flags[sigslot] & SIGNAL_MASK; // obtain signal flags for this id
+      StringFormatter::send(stream,F("\n%S[%d]"), 
+        (flag == SIGNAL_RED)? F("RED") : (flag==SIGNAL_GREEN) ? F("GREEN") : F("AMBER"),
+        sigid & SIGNAL_ID_MASK); 
+    } 
+    
+    StringFormatter::send(stream,F(" *>\n"));
+    return true;
+  }
+  switch (p[0]) {
+  case HASH_KEYWORD_PAUSE: // </ PAUSE>
+    if (paramCount!=1) return false;
+    DCC::setThrottle(0,1,true);  // pause all locos on the track
+    pausingTask=(RMFT2 *)1; // Impossible task address
+    return true;
+    
+  case HASH_KEYWORD_RESUME: // </ RESUME>
+    if (paramCount!=1) return false;
+    pausingTask=NULL;
+    {
+      RMFT2 * task=loopTask;
+      while(task) {
+	if (task->loco) task->driveLoco(task->speedo);
+	task=task->next;
+	if (task==loopTask) break;
+      }
+    }
+    return true;
+    
+    
+  case HASH_KEYWORD_START: // </ START [cab] route >
+    if (paramCount<2 || paramCount>3) return false;
+    {
+      int route=(paramCount==2) ? p[1] : p[2];
+      uint16_t cab=(paramCount==2)? 0 : p[1];
+      int pc=sequenceLookup->find(route);
+      if (pc<0) return false;
+      RMFT2* task=new RMFT2(pc);
+      task->loco=cab;
+    }
+    return true;
+    
+  default:
+    break;
+  }
+
+  // check KILL ALL here, otherwise the next validation confuses ALL with a flag  
+  if (p[0]==HASH_KEYWORD_KILL && p[1]==HASH_KEYWORD_ALL) {
+    while (loopTask) loopTask->kill(F("KILL ALL")); // destructor changes loopTask
+    return true;   
+  }
+
+  // all other / commands take 1 parameter
+  if (paramCount!=2 ) return false;
+  
+  switch (p[0]) {
+  case HASH_KEYWORD_KILL: // Kill taskid|ALL
+    {
+    if ( p[1]<0  || p[1]>=MAX_FLAGS) return false;
+    RMFT2 * task=loopTask;
+      while(task) {
+	      if (task->taskId==p[1]) {
+	        task->kill(F("KILL"));
+	        return  true;
+	      }
+	      task=task->next;
+	      if (task==loopTask) break;
+      }
+    }
+    return false;
+    
+  case HASH_KEYWORD_RESERVE:  // force reserve a section
+    return setFlag(p[1],SECTION_FLAG);
+    
+  case HASH_KEYWORD_FREE:  // force free a section
+    return setFlag(p[1],0,SECTION_FLAG);
+    
+  case HASH_KEYWORD_LATCH:
+    return setFlag(p[1], LATCH_FLAG);
+    
+  case HASH_KEYWORD_UNLATCH:
+    return setFlag(p[1], 0, LATCH_FLAG);
+ 
+  case HASH_KEYWORD_RED:
+    doSignal(p[1],SIGNAL_RED);
+    return true;
+ 
+  case HASH_KEYWORD_AMBER:
+    doSignal(p[1],SIGNAL_AMBER);
+    return true;
+ 
+  case HASH_KEYWORD_GREEN:
+    doSignal(p[1],SIGNAL_GREEN);
+    return true;
+    
+  default:
+    return false;
+  }
+}
+
+
+// This emits Routes and Automations to Withrottle
+// Automations are given a state to set the button to "handoff" which implies
+// handing over the loco to the automation.
+// Routes are given "Set" buttons and do not cause the loco to be handed over.
+
+
 
 RMFT2::RMFT2(int progCtr) {
   progCounter=progCtr;
@@ -403,7 +490,7 @@ RMFT2::~RMFT2() {
 }
 
 void RMFT2::createNewTask(int route, uint16_t cab) {
-      int pc=routeLookup->find(route);
+      int pc=sequenceLookup->find(route);
       if (pc<0) return;
       RMFT2* task=new RMFT2(pc);
       task->loco=cab;
@@ -416,6 +503,7 @@ void RMFT2::driveLoco(byte speed) {
  power on appropriate track if DC or main if dcc
   if (TrackManager::getMainPowerMode()==POWERMODE::OFF) {
     TrackManager::setMainPower(POWERMODE::ON);
+    CommandDistributor::broadcastPower();
   }
   **********/
 
@@ -511,14 +599,6 @@ void RMFT2::loop2() {
     Turnout::setClosed(operand, true);
     break;
 
-#ifndef IO_NO_HAL
-  case OPCODE_ROTATE:
-    uint8_t activity;
-    activity=getOperand(2);
-    Turntable::setPosition(operand,getOperand(1),activity);
-    break;
-#endif
-
   case OPCODE_REV:
     forward = false;
     driveLoco(operand);
@@ -530,7 +610,6 @@ void RMFT2::loop2() {
       break;
       
   case OPCODE_SPEED:
-    forward=DCC::getThrottleDirection(loco)^invert;
     driveLoco(operand);
     break;
     
@@ -604,17 +683,7 @@ void RMFT2::loop2() {
     }
     if (millis()-waitAfter < 500 ) return;
     break;
-
-  case OPCODE_AFTEROVERLOAD: // waits for the power to be turned back on - either by power routine or button
-    if (!TrackManager::isPowerOn(operand)) {
-      // reset timer to half a second and keep waiting
-      waitAfter=millis();
-      delayMe(50);
-      return;
-    }
-    if (millis()-waitAfter < 500 ) return;
-    break;
-
+    
   case OPCODE_LATCH:
     setFlag(operand,LATCH_FLAG);
     break;
@@ -635,28 +704,15 @@ void RMFT2::loop2() {
     DCC::setThrottle(0,1,true);  // pause all locos on the track
     pausingTask=this;
     break;
-
+    
   case OPCODE_POM:
     if (loco) DCC::writeCVByteMain(loco, operand, getOperand(1));
     break;
-
+    
   case OPCODE_POWEROFF:
     TrackManager::setPower(POWERMODE::OFF);
     TrackManager::setJoin(false);
-    break;
-  
-  case OPCODE_SET_POWER:
-      // operand is TRACK_POWER , trackid
-        //byte thistrack=getOperand(1);
-        switch (operand) {
-          case TRACK_POWER_0:
-            TrackManager::setTrackPower(POWERMODE::OFF, getOperand(1));
-          break;
-          case TRACK_POWER_1:
-            TrackManager::setTrackPower(POWERMODE::ON, getOperand(1));
-          break;
-        }
-
+    CommandDistributor::broadcastPower();
     break;
 
   case OPCODE_SET_TRACK:
@@ -664,7 +720,7 @@ void RMFT2::loop2() {
       // If DC/DCX use  my loco for DC address 
       {
         TRACK_MODE mode = (TRACK_MODE)(operand>>8);
-        int16_t cab=(mode & TRACK_MODE_DC) ? loco : 0;
+        int16_t cab=(mode==TRACK_MODE_DC || mode==TRACK_MODE_DCX) ? loco : 0;
         TrackManager::setTrackMode(operand & 0x0F, mode, cab);
       }
       break; 
@@ -731,13 +787,7 @@ void RMFT2::loop2() {
   case OPCODE_IFCLOSED:
     skipIf=Turnout::isThrown(operand);
     break;
-
-#ifndef IO_NO_HAL
-  case OPCODE_IFTTPOSITION: // do block if turntable at this position
-    skipIf=Turntable::getPosition(operand)!=(int)getOperand(1);
-    break;
-#endif
-
+    
   case OPCODE_ENDIF:
     break;
     
@@ -802,7 +852,7 @@ void RMFT2::loop2() {
   }
     
   case OPCODE_FOLLOW:
-    progCounter=routeLookup->find(operand);
+    progCounter=sequenceLookup->find(operand);
     if (progCounter<0) kill(F("FOLLOW unknown"), operand);
     return;
     
@@ -812,7 +862,7 @@ void RMFT2::loop2() {
       return;
     }
     callStack[stackDepth++]=progCounter+3;
-    progCounter=routeLookup->find(operand);
+    progCounter=sequenceLookup->find(operand);
     if (progCounter<0) kill(F("CALL unknown"),operand);
     return;
     
@@ -833,16 +883,23 @@ void RMFT2::loop2() {
     while(loopTask) loopTask->kill(F("KILLALL"));
     return;
 
-#ifndef DISABLE_PROG
   case OPCODE_JOIN:
     TrackManager::setPower(POWERMODE::ON);
     TrackManager::setJoin(true);
+    CommandDistributor::broadcastPower();
     break;
-
+    
+  case OPCODE_POWERON:
+    TrackManager::setMainPower(POWERMODE::ON);
+    TrackManager::setJoin(false);
+    CommandDistributor::broadcastPower();
+    break;
+    
   case OPCODE_UNJOIN:
     TrackManager::setJoin(false);
+    CommandDistributor::broadcastPower();
     break;
-
+    
   case OPCODE_READ_LOCO1: // READ_LOCO is implemented as 2 separate opcodes
     progtrackLocoId=LOCO_ID_WAITING;  // Nothing found yet
     DCC::getLocoId(readLocoCallback);
@@ -863,16 +920,10 @@ void RMFT2::loop2() {
     forward=true;
     invert=false;
     break;
-#endif
-
-  case OPCODE_POWERON:
-    TrackManager::setMainPower(POWERMODE::ON);
-    TrackManager::setJoin(false);
-    break;
     
   case OPCODE_START:
     {
-      int newPc=routeLookup->find(operand);
+      int newPc=sequenceLookup->find(operand);
       if (newPc<0) break;
       new RMFT2(newPc);
     }
@@ -880,7 +931,7 @@ void RMFT2::loop2() {
     
   case OPCODE_SENDLOCO:  // cab, route
     {
-      int newPc=routeLookup->find(getOperand(1));
+      int newPc=sequenceLookup->find(getOperand(1));
       if (newPc<0) break;
       RMFT2* newtask=new RMFT2(newPc); // create new task
       newtask->loco=operand;
@@ -895,21 +946,7 @@ void RMFT2::loop2() {
       invert=false;
     }
     break;
-
-  case OPCODE_LCC:  // short form LCC
-      if ((compileFeatures & FEATURE_LCC) && LCCSerial) 
-          StringFormatter::send(LCCSerial,F("<L x%h>"),(uint16_t)operand);
-       break; 
-
-  case OPCODE_LCCX: // long form LCC
-       if ((compileFeatures & FEATURE_LCC) && LCCSerial)
-            StringFormatter::send(LCCSerial,F("<L x%h%h%h%h>\n"),
-                 getOperand(progCounter,1),
-                 getOperand(progCounter,2),
-                 getOperand(progCounter,3),
-                 getOperand(progCounter,0)
-                 );    
-        break;  
+    
     
   case OPCODE_SERVO: // OPCODE_SERVO,V(vpin),OPCODE_PAD,V(position),OPCODE_PAD,V(profile),OPCODE_PAD,V(duration)
     IODevice::writeAnalogue(operand,getOperand(1),getOperand(2),getOperand(3));
@@ -921,60 +958,11 @@ void RMFT2::loop2() {
       return;
     }
     break;
-
-#ifndef IO_NO_HAL
-  case OPCODE_WAITFORTT:  // OPCODE_WAITFOR,V(turntable_id)
-    if (Turntable::ttMoving(operand)) {
-      delayMe(100);
-      return;
-    }
-    break;
-#endif
-
+    
   case OPCODE_PRINT:
     printMessage(operand);
     break;
-  case OPCODE_ROUTE_HIDDEN:
-    manageRouteState(operand,2);
-    break;   
-  case OPCODE_ROUTE_INACTIVE:
-    manageRouteState(operand,0);
-    break;   
-  case OPCODE_ROUTE_ACTIVE:
-    manageRouteState(operand,1);
-    break;   
-  case OPCODE_ROUTE_DISABLED:
-    manageRouteState(operand,4);
-    break;   
-
-  case OPCODE_STASH:
-    if (compileFeatures & FEATURE_STASH) 
-      stashArray[operand] = invert? -loco : loco;
-    break; 
-
-  case OPCODE_CLEAR_STASH:
-    if (compileFeatures & FEATURE_STASH) 
-      stashArray[operand] = 0;
-    break; 
-       
-  case OPCODE_CLEAR_ALL_STASH:
-    if (compileFeatures & FEATURE_STASH) 
-      for (int i=0;i<=maxStashId;i++) stashArray[operand]=0;
-    break;
-
-  case OPCODE_PICKUP_STASH:
-    if (compileFeatures & FEATURE_STASH) {
-      int16_t x=stashArray[operand];
-      if (x>=0) {
-        loco=x;
-        invert=false;
-        break;
-      }
-      loco=-x;
-      invert=true;
-    }
-    break;
-  
+    
   case OPCODE_ROUTE:
   case OPCODE_AUTOMATION:
   case OPCODE_SEQUENCE:
@@ -987,7 +975,6 @@ void RMFT2::loop2() {
   case OPCODE_SERVOTURNOUT: // Turnout definition ignored at runtime
   case OPCODE_PINTURNOUT: // Turnout definition ignored at runtime
   case OPCODE_ONCLOSE: // Turnout event catchers ignored here
-  case OPCODE_ONLCC:   // LCC event catchers ignored here 
   case OPCODE_ONTHROW:
   case OPCODE_ONACTIVATE: // Activate event catchers ignored here
   case OPCODE_ONDEACTIVATE:
@@ -996,13 +983,6 @@ void RMFT2::loop2() {
   case OPCODE_ONGREEN:
   case OPCODE_ONCHANGE:
   case OPCODE_ONTIME:
-#ifndef IO_NO_HAL
-  case OPCODE_DCCTURNTABLE: // Turntable definition ignored at runtime
-  case OPCODE_EXTTTURNTABLE:  // Turntable definition ignored at runtime
-  case OPCODE_TTADDPOSITION:  // Turntable position definition ignored at runtime
-  case OPCODE_ONROTATE:
-#endif
-  case OPCODE_ONOVERLOAD:
   
     break;
     
@@ -1057,14 +1037,13 @@ int16_t RMFT2::getSignalSlot(int16_t id) {
 }
 
 /* static */ void RMFT2::doSignal(int16_t id,char rag) {
-  if (!(compileFeatures & FEATURE_SIGNAL)) return; // dont compile code below
   if (diag) DIAG(F(" doSignal %d %x"),id,rag);
   
   // Schedule any event handler for this signal change.
   // Thjis will work even without a signal definition. 
-  if (rag==SIGNAL_RED) onRedLookup->handleEvent(F("RED"),id);
-  else if (rag==SIGNAL_GREEN) onGreenLookup->handleEvent(F("GREEN"),id);
-  else onAmberLookup->handleEvent(F("AMBER"),id);
+  if (rag==SIGNAL_RED) handleEvent(F("RED"),onRedLookup,id);
+  else if (rag==SIGNAL_GREEN) handleEvent(F("GREEN"), onGreenLookup,id);
+  else handleEvent(F("AMBER"), onAmberLookup,id);
   
   int16_t sigslot=getSignalSlot(id);
   if (sigslot<0) return; 
@@ -1125,7 +1104,6 @@ int16_t RMFT2::getSignalSlot(int16_t id) {
 }
 
 /* static */ bool RMFT2::isSignal(int16_t id,char rag) {
-  if (!(compileFeatures & FEATURE_SIGNAL)) return false; 
   int16_t sigslot=getSignalSlot(id);
   if (sigslot<0) return false; 
   return (flags[sigslot] & SIGNAL_MASK) == rag;
@@ -1133,49 +1111,33 @@ int16_t RMFT2::getSignalSlot(int16_t id) {
 
 void RMFT2::turnoutEvent(int16_t turnoutId, bool closed) {
   // Hunt for an ONTHROW/ONCLOSE for this turnout
-  if (closed)  onCloseLookup->handleEvent(F("CLOSE"),turnoutId);
-  else onThrowLookup->handleEvent(F("THROW"),turnoutId);
+  if (closed)  handleEvent(F("CLOSE"),onCloseLookup,turnoutId);
+  else handleEvent(F("THROW"),onThrowLookup,turnoutId);
 }
 
 
 void RMFT2::activateEvent(int16_t addr, bool activate) {
   // Hunt for an ONACTIVATE/ONDEACTIVATE for this accessory
-  if (activate)  onActivateLookup->handleEvent(F("ACTIVATE"),addr);
-  else onDeactivateLookup->handleEvent(F("DEACTIVATE"),addr);
+  if (activate)  handleEvent(F("ACTIVATE"),onActivateLookup,addr);
+  else handleEvent(F("DEACTIVATE"),onDeactivateLookup,addr);
 }
 
 void RMFT2::changeEvent(int16_t vpin, bool change) {
   // Hunt for an ONCHANGE for this sensor
-  if (change)  onChangeLookup->handleEvent(F("CHANGE"),vpin);
+  if (change)  handleEvent(F("CHANGE"),onChangeLookup,vpin);
 }
 
-#ifndef IO_NO_HAL
-void RMFT2::rotateEvent(int16_t turntableId, bool change) {
-  // Hunt or an ONROTATE for this turntable
-  if (change) onRotateLookup->handleEvent(F("ROTATE"),turntableId);
-}
-#endif
-
 void RMFT2::clockEvent(int16_t clocktime, bool change) {
   // Hunt for an ONTIME for this time
   if (Diag::CMD)
    DIAG(F("Looking for clock event at : %d"), clocktime);
-  if (change) {
-    onClockLookup->handleEvent(F("CLOCK"),clocktime);
-    onClockLookup->handleEvent(F("CLOCK"),25*60+clocktime%60);
-  }
+  if (change)  handleEvent(F("CLOCK"),onClockLookup,clocktime);
 } 
 
-void RMFT2::powerEvent(int16_t track, bool overload) {
-  // Hunt for an ONOVERLOAD for this item
-  if (Diag::CMD)
-   DIAG(F("Looking for Power event on track : %c"), track);
-  if (overload) {
-    onOverloadLookup->handleEvent(F("POWER"),track);
-  }
-}
-
-void RMFT2::startNonRecursiveTask(const FSH* reason, int16_t id,int pc) {  
+void RMFT2::handleEvent(const FSH* reason,LookList* handlers, int16_t id) {
+  int pc= handlers->find(id);
+  if (pc<0) return;
+  
   // Check we dont already have a task running this handler
   RMFT2 * task=loopTask;
   while(task) {
@@ -1203,11 +1165,11 @@ void RMFT2::thrungeString(uint32_t strfar, thrunger mode, byte id) {
    // Find out where the string is going 
    switch (mode) {
     case thrunge_print:
-         StringFormatter::send(&USB_SERIAL,F("<* EXRAIL(%d) "),loco);
-         stream=&USB_SERIAL;
+         StringFormatter::send(&Serial,F("<* EXRAIL(%d) "),loco);
+         stream=&Serial;
          break;
 
-    case thrunge_serial: stream=&USB_SERIAL; break;  
+    case thrunge_serial: stream=&Serial; break;  
     case thrunge_serial1: 
          #ifdef SERIAL1_COMMANDS
          stream=&Serial1; 
@@ -1238,6 +1200,7 @@ void RMFT2::thrungeString(uint32_t strfar, thrunger mode, byte id) {
          stream=&Serial6; 
          #endif
          break;
+  // TODO  more serials for SAMx case thrunge_serial4: stream=&Serial4; break;
     case thrunge_lcn: 
       #if defined(LCN_SERIAL) 
       stream=&LCN_SERIAL;
@@ -1246,7 +1209,6 @@ void RMFT2::thrungeString(uint32_t strfar, thrunger mode, byte id) {
     case thrunge_parse:
     case thrunge_broadcast:
     case thrunge_lcd:
-    default:    // thrunge_lcd+1, ...
          if (!buffer) buffer=new StringBuffer();
          buffer->flush();
          stream=buffer;
@@ -1270,50 +1232,19 @@ void RMFT2::thrungeString(uint32_t strfar, thrunger mode, byte id) {
   // and decide what to do next
    switch (mode) {
     case thrunge_print:
-         StringFormatter::send(&USB_SERIAL,F(" *>\n"));
+         StringFormatter::send(&Serial,F(" *>\n"));
          break;
     // TODO  more serials for SAMx case thrunge_serial4: stream=&Serial4; break;
     case thrunge_parse: 
-      DCCEXParser::parseOne(&USB_SERIAL,(byte*)buffer->getString(),NULL);
+      DCCEXParser::parseOne(&Serial,(byte*)buffer->getString(),NULL);
       break;
     case thrunge_broadcast:
-      CommandDistributor::broadcastRaw(CommandDistributor::COMMAND_TYPE,buffer->getString());
-      break;
-    case thrunge_withrottle:
-      CommandDistributor::broadcastRaw(CommandDistributor::WITHROTTLE_TYPE,buffer->getString());
+  // TODO     CommandDistributor::broadcastText(buffer->getString());
       break;
     case thrunge_lcd:
          LCD(id,F("%s"),buffer->getString());
          break;
-    default:  // thrunge_lcd+1, ...
-      if (mode > thrunge_lcd) 
-        SCREEN(mode-thrunge_lcd, id, F("%s"),buffer->getString());  // print to other display
-      break;       
+
+     default: break;       
     }
 }
-
-void RMFT2::manageRouteState(uint16_t id, byte state) {
-  if (compileFeatures && FEATURE_ROUTESTATE) {
-    // Route state must be maintained for when new throttles connect.
-    // locate route id in the Routes lookup
-    int16_t position=routeLookup->findPosition(id);
-    if (position<0) return; 
-    // set state beside it 
-    if (routeStateArray[position]==state) return; 
-    routeStateArray[position]=state;
-    CommandDistributor::broadcastRouteState(id,state);
-  }
-}
-void RMFT2::manageRouteCaption(uint16_t id,const FSH* caption) {
-  if (compileFeatures && FEATURE_ROUTESTATE) {
-    // Route state must be maintained for when new throttles connect.
-    // locate route id in the Routes lookup
-    int16_t position=routeLookup->findPosition(id);
-    if (position<0) return; 
-    // set state beside it 
-    if (routeCaptionArray[position]==caption) return; 
-    routeCaptionArray[position]=caption;
-    CommandDistributor::broadcastRouteCaption(id,caption);
-  }
-}
-  

EXRAIL2.h

@@ -1,7 +1,6 @@
 /*
  *  © 2021 Neil McKechnie
  *  © 2020-2022 Chris Harlow
- *  © 2022-2023 Colin Murdoch
  *  © 2023 Harald Barth
  *  All rights reserved.
  *  
@@ -25,7 +24,6 @@
 #include "FSH.h"
 #include "IODevice.h"
 #include "Turnouts.h"
-#include "Turntables.h"
    
 // The following are the operation codes (or instructions) for a kind of virtual machine.
 // Each instruction is normally 3 bytes long with an operation code followed by a parameter.
@@ -36,8 +34,7 @@
 enum OPCODE : byte {OPCODE_THROW,OPCODE_CLOSE,
              OPCODE_FWD,OPCODE_REV,OPCODE_SPEED,OPCODE_INVERT_DIRECTION,
              OPCODE_RESERVE,OPCODE_FREE,
-             OPCODE_AT,OPCODE_AFTER,
-             OPCODE_AFTEROVERLOAD,OPCODE_AUTOSTART,
+             OPCODE_AT,OPCODE_AFTER,OPCODE_AUTOSTART,
              OPCODE_ATGTE,OPCODE_ATLT,
              OPCODE_ATTIMEOUT1,OPCODE_ATTIMEOUT2,
              OPCODE_LATCH,OPCODE_UNLATCH,OPCODE_SET,OPCODE_RESET,
@@ -47,10 +44,7 @@ enum OPCODE : byte {OPCODE_THROW,OPCODE_CLOSE,
              OPCODE_RED,OPCODE_GREEN,OPCODE_AMBER,OPCODE_DRIVE,
              OPCODE_SERVO,OPCODE_SIGNAL,OPCODE_TURNOUT,OPCODE_WAITFOR,
              OPCODE_PAD,OPCODE_FOLLOW,OPCODE_CALL,OPCODE_RETURN,
-#ifndef DISABLE_PROG
-             OPCODE_JOIN,OPCODE_UNJOIN,OPCODE_READ_LOCO1,OPCODE_READ_LOCO2,
-#endif
-             OPCODE_POM,
+             OPCODE_JOIN,OPCODE_UNJOIN,OPCODE_READ_LOCO1,OPCODE_READ_LOCO2,OPCODE_POM,
              OPCODE_START,OPCODE_SETLOCO,OPCODE_SENDLOCO,OPCODE_FORGET,
              OPCODE_PAUSE, OPCODE_RESUME,OPCODE_POWEROFF,OPCODE_POWERON,
              OPCODE_ONCLOSE, OPCODE_ONTHROW, OPCODE_SERVOTURNOUT, OPCODE_PINTURNOUT,
@@ -59,18 +53,11 @@ enum OPCODE : byte {OPCODE_THROW,OPCODE_CLOSE,
              OPCODE_ROSTER,OPCODE_KILLALL,
              OPCODE_ROUTE,OPCODE_AUTOMATION,OPCODE_SEQUENCE,
              OPCODE_ENDTASK,OPCODE_ENDEXRAIL,
-             OPCODE_SET_TRACK,OPCODE_SET_POWER,
+             OPCODE_SET_TRACK,
              OPCODE_ONRED,OPCODE_ONAMBER,OPCODE_ONGREEN,
              OPCODE_ONCHANGE,
              OPCODE_ONCLOCKTIME,
              OPCODE_ONTIME,
-             OPCODE_TTADDPOSITION,OPCODE_DCCTURNTABLE,OPCODE_EXTTTURNTABLE,
-             OPCODE_ONROTATE,OPCODE_ROTATE,OPCODE_WAITFORTT,
-             OPCODE_LCC,OPCODE_LCCX,OPCODE_ONLCC,
-             OPCODE_ONOVERLOAD,
-             OPCODE_ROUTE_ACTIVE,OPCODE_ROUTE_INACTIVE,OPCODE_ROUTE_HIDDEN,
-             OPCODE_ROUTE_DISABLED,
-             OPCODE_STASH,OPCODE_CLEAR_STASH,OPCODE_CLEAR_ALL_STASH,OPCODE_PICKUP_STASH,
 
              // OPcodes below this point are skip-nesting IF operations
              // placed here so that they may be skipped as a group
@@ -83,28 +70,16 @@ enum OPCODE : byte {OPCODE_THROW,OPCODE_CLOSE,
              OPCODE_IFRANDOM,OPCODE_IFRESERVE,
              OPCODE_IFCLOSED,OPCODE_IFTHROWN,
              OPCODE_IFRE,
-             OPCODE_IFLOCO,
-             OPCODE_IFTTPOSITION
+             OPCODE_IFLOCO
              };
 
-// Ensure thrunge_lcd is put last as there may be more than one display, 
-// sequentially numbered from thrunge_lcd.
 enum thrunger: byte {
-  thrunge_print, thrunge_broadcast, thrunge_withrottle,
-  thrunge_serial,thrunge_parse,
+  thrunge_print, thrunge_broadcast, thrunge_serial,thrunge_parse,
   thrunge_serial1, thrunge_serial2, thrunge_serial3,
   thrunge_serial4, thrunge_serial5, thrunge_serial6,
-  thrunge_lcn, 
-  thrunge_lcd,  // Must be last!!
-  };
+  thrunge_lcd, thrunge_lcn};
+
 
-  // Flag bits for compile time features.
-  static const byte FEATURE_SIGNAL= 0x80;
-  static const byte FEATURE_LCC   = 0x40;
-  static const byte FEATURE_ROSTER= 0x20;
-  static const byte FEATURE_ROUTESTATE= 0x10;
-  static const byte FEATURE_STASH = 0x08;
-  
  
   // Flag bits for status of hardware and TPL
   static const byte SECTION_FLAG = 0x80;
@@ -124,20 +99,13 @@ enum thrunger: byte {
 class LookList {
   public: 
     LookList(int16_t size);
-    void chain(LookList* chainTo);
     void add(int16_t lookup, int16_t result);
-    int16_t find(int16_t value); // finds result value
-    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 find(int16_t value);
   private:
      int16_t m_size;
      int16_t m_loaded;
      int16_t * m_lookupArray;
-     int16_t * m_resultArray;
-     LookList* m_chain;     
+     int16_t * m_resultArray;     
 };
 
  class RMFT2 {
@@ -153,8 +121,6 @@ class LookList {
     static void activateEvent(int16_t addr, bool active);
     static void changeEvent(int16_t id, bool change);
     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 const int16_t SERVO_SIGNAL_FLAG=0x4000;
     static const int16_t ACTIVE_HIGH_SIGNAL_FLAG=0x2000;
     static const int16_t DCC_SIGNAL_FLAG=0x1000;
@@ -169,10 +135,7 @@ class LookList {
   static const FSH *  getTurnoutDescription(int16_t id);
   static const FSH *  getRosterName(int16_t id);
   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);
-      
+    
 private: 
     static void ComandFilter(Print * stream, byte & opcode, byte & paramCount, int16_t p[]);
     static bool parseSlash(Print * stream, byte & paramCount, int16_t p[]) ;
@@ -184,11 +147,9 @@ private:
     static bool isSignal(int16_t id,char rag); 
     static int16_t getSignalSlot(int16_t id);
     static void setTurnoutHiddenState(Turnout * t);
-    #ifndef IO_NO_HAL
-    static void setTurntableHiddenState(Turntable * tto);
-    #endif
     static LookList* LookListLoader(OPCODE op1,
                       OPCODE op2=OPCODE_ENDEXRAIL,OPCODE op3=OPCODE_ENDEXRAIL);
+    static void handleEvent(const FSH* reason,LookList* handlers, int16_t id);
     static uint16_t getOperand(int progCounter,byte n);
     static RMFT2 * loopTask;
     static RMFT2 * pausingTask;
@@ -205,11 +166,10 @@ private:
     uint16_t getOperand(byte n); 
     
    static bool diag;
-   static const  HIGHFLASH3  byte RouteCode[];
+   static const  HIGHFLASH  byte RouteCode[];
    static const  HIGHFLASH  int16_t SignalDefinitions[];
    static byte flags[MAX_FLAGS];
-   static Print * LCCSerial;
-   static LookList * routeLookup;
+   static LookList * sequenceLookup;
    static LookList * onThrowLookup;
    static LookList * onCloseLookup;
    static LookList * onActivateLookup;
@@ -219,20 +179,6 @@ private:
    static LookList * onGreenLookup;
    static LookList * onChangeLookup;
    static LookList * onClockLookup;
-#ifndef IO_NO_HAL
-   static LookList * onRotateLookup;
-#endif
-   static LookList * onOverloadLookup;
-   
-   static const int countLCCLookup;
-   static int onLCCLookup[];
-   static const byte compileFeatures;
-   static void manageRouteState(uint16_t id, byte state);
-   static void manageRouteCaption(uint16_t id, const FSH* caption);
-   static byte * routeStateArray;
-   static const FSH ** routeCaptionArray;
-   static int16_t * stashArray;
-   static int16_t maxStashId;
     
   // Local variables - exist for each instance/task 
     RMFT2 *next;   // loop chain 
@@ -254,27 +200,4 @@ private:
     byte stackDepth;
     int callStack[MAX_STACK_DEPTH];
 };
-
-#define GET_OPCODE GETHIGHFLASH(RMFT2::RouteCode,progCounter)
-#define SKIPOP progCounter+=3
-
-// IO_I2CDFPlayer commands and values
-enum  : uint8_t{
-    DF_PLAY          = 0x0F,
-    DF_VOL           = 0x06,
-    DF_FOLDER        = 0x2B, // Not a DFPlayer command, used to set folder nr where audio file is
-    DF_REPEATPLAY    = 0x08,
-    DF_STOPPLAY      = 0x16,
-    DF_EQ            = 0x07, // Set equaliser, require parameter NORMAL, POP, ROCK, JAZZ, CLASSIC or BASS
-    DF_RESET         = 0x0C,
-    DF_DACON         = 0x1A,
-    DF_SETAM         = 0x2A, // Set audio mixer 1 or 2 for this DFPLayer   
-    DF_NORMAL        = 0x00, // Equalizer parameters
-    DF_POP           = 0x01,
-    DF_ROCK          = 0x02,
-    DF_JAZZ          = 0x03,
-    DF_CLASSIC       = 0x04,
-    DF_BASS          = 0x05,
-  };
-
 #endif

EXRAIL2MacroReset.h

@@ -1,6 +1,5 @@
 /*
  *  © 2020-2022 Chris Harlow. All rights reserved.
- *  © 2022-2023 Colin Murdoch
  *  © 2023 Harald Barth
  *  
  *  This file is part of CommandStation-EX
@@ -27,10 +26,8 @@
 #undef ACTIVATE
 #undef ACTIVATEL
 #undef AFTER
-#undef AFTEROVERLOAD
 #undef ALIAS
 #undef AMBER
-#undef ANOUT
 #undef AT
 #undef ATGTE
 #undef ATLT
@@ -39,11 +36,8 @@
 #undef AUTOSTART
 #undef BROADCAST
 #undef CALL 
-#undef CLEAR_STASH
-#undef CLEAR_ALL_STASH
 #undef CLOSE 
 #undef DCC_SIGNAL
-#undef DCC_TURNTABLE
 #undef DEACTIVATE
 #undef DEACTIVATEL
 #undef DELAY
@@ -55,9 +49,8 @@
 #undef ENDEXRAIL 
 #undef ENDIF  
 #undef ENDTASK
-#undef ESTOP
-#undef EXRAIL
-#undef EXTT_TURNTABLE
+#undef ESTOP 
+#undef EXRAIL  
 #undef FADE
 #undef FOFF
 #undef FOLLOW 
@@ -67,7 +60,6 @@
 #undef FWD 
 #undef GREEN
 #undef HAL
-#undef HAL_IGNORE_DEFAULTS
 #undef IF 
 #undef IFAMBER
 #undef IFCLOSED
@@ -81,16 +73,12 @@
 #undef IFRESERVE
 #undef IFTHROWN
 #undef IFTIMEOUT
-#undef IFTTPOSITION
 #undef IFRE
 #undef INVERT_DIRECTION 
 #undef JOIN 
 #undef KILLALL
 #undef LATCH 
 #undef LCD 
-#undef SCREEN
-#undef LCC 
-#undef LCCX 
 #undef LCN 
 #undef MOVETT
 #undef ONACTIVATE
@@ -99,24 +87,17 @@
 #undef ONDEACTIVATE
 #undef ONDEACTIVATEL 
 #undef ONCLOSE
-#undef ONLCC
 #undef ONTIME
 #undef ONCLOCKTIME
-#undef ONCLOCKMINS
-#undef ONOVERLOAD
 #undef ONGREEN
 #undef ONRED
-#undef ONROTATE
 #undef ONTHROW 
 #undef ONCHANGE
 #undef PARSE
 #undef PAUSE
-#undef PICKUP_STASH
 #undef PIN_TURNOUT 
 #undef PRINT
-#ifndef DISABLE_PROG
 #undef POM
-#endif
 #undef POWEROFF
 #undef POWERON
 #undef READ_LOCO 
@@ -126,15 +107,8 @@
 #undef RESUME 
 #undef RETURN 
 #undef REV
-#undef ROSTER
-#undef ROTATE
-#undef ROTATE_DCC
+#undef ROSTER 
 #undef ROUTE
-#undef ROUTE_ACTIVE
-#undef ROUTE_INACTIVE
-#undef ROUTE_HIDDEN
-#undef ROUTE_DISABLED
-#undef ROUTE_CAPTION
 #undef SENDLOCO 
 #undef SEQUENCE 
 #undef SERIAL 
@@ -150,28 +124,19 @@
 #undef SERVO_SIGNAL
 #undef SET
 #undef SET_TRACK
-#undef SET_POWER
 #undef SETLOCO 
 #undef SIGNAL 
 #undef SIGNALH 
 #undef SPEED 
 #undef START 
-#undef STASH
-#undef STEALTH
 #undef STOP 
-#undef THROW
-#undef TT_ADDPOSITION
+#undef THROW  
 #undef TURNOUT 
-#undef TURNOUTL
 #undef UNJOIN
 #undef UNLATCH 
 #undef VIRTUAL_SIGNAL
 #undef VIRTUAL_TURNOUT
 #undef WAITFOR
-#ifndef IO_NO_HAL
-#undef WAITFORTT
-#endif
-#undef WITHROTTLE
 #undef XFOFF
 #undef XFON
 
@@ -179,10 +144,8 @@
 #define ACTIVATE(addr,subaddr)
 #define ACTIVATEL(addr)
 #define AFTER(sensor_id)
-#define AFTEROVERLOAD(track_id)
 #define ALIAS(name,value...)
 #define AMBER(signal_id)
-#define ANOUT(vpin,value,param1,param2)
 #define AT(sensor_id)
 #define ATGTE(sensor_id,value) 
 #define ATLT(sensor_id,value) 
@@ -190,12 +153,9 @@
 #define AUTOMATION(id,description) 
 #define AUTOSTART
 #define BROADCAST(msg)
-#define CALL(route)
-#define CLEAR_STASH(id)
-#define CLEAR_ALL_STASH(id)
+#define CALL(route) 
 #define CLOSE(id) 
 #define DCC_SIGNAL(id,add,subaddr)
-#define DCC_TURNTABLE(id,home,description)
 #define DEACTIVATE(addr,subaddr)
 #define DEACTIVATEL(addr)
 #define DELAY(mindelay)
@@ -208,8 +168,7 @@
 #define ENDIF  
 #define ENDTASK
 #define ESTOP 
-#define EXRAIL
-#define EXTT_TURNTABLE(id,vpin,home,description)
+#define EXRAIL  
 #define FADE(pin,value,ms)
 #define FOFF(func)
 #define FOLLOW(route) 
@@ -219,7 +178,6 @@
 #define FWD(speed) 
 #define GREEN(signal_id)
 #define HAL(haltype,params...)
-#define HAL_IGNORE_DEFAULTS
 #define IF(sensor_id) 
 #define IFAMBER(signal_id)
 #define IFCLOSED(turnout_id) 
@@ -233,16 +191,12 @@
 #define IFTHROWN(turnout_id) 
 #define IFRESERVE(block)
 #define IFTIMEOUT
-#define IFTTPOSITION(turntable_id,position)
 #define IFRE(sensor_id,value)
 #define INVERT_DIRECTION 
 #define JOIN 
 #define KILLALL
-#define LATCH(sensor_id)
-#define LCC(eventid) 
-#define LCCX(senderid,eventid) 
-#define LCD(row,msg)
-#define SCREEN(display,row,msg)
+#define LATCH(sensor_id) 
+#define LCD(row,msg) 
 #define LCN(msg) 
 #define MOVETT(id,steps,activity)
 #define ONACTIVATE(addr,subaddr)
@@ -250,25 +204,18 @@
 #define ONAMBER(signal_id) 
 #define ONTIME(value)
 #define ONCLOCKTIME(hours,mins)
-#define ONCLOCKMINS(mins)
-#define ONOVERLOAD(track_id)
 #define ONDEACTIVATE(addr,subaddr)
 #define ONDEACTIVATEL(linear) 
 #define ONCLOSE(turnout_id)
-#define ONLCC(sender,event)
 #define ONGREEN(signal_id) 
-#define ONRED(signal_id)
-#define ONROTATE(turntable_id)
+#define ONRED(signal_id) 
 #define ONTHROW(turnout_id) 
 #define ONCHANGE(sensor_id)
 #define PAUSE
 #define PIN_TURNOUT(id,pin,description...) 
 #define PRINT(msg) 
 #define PARSE(msg)
-#define PICKUP_STASH(id)
-#ifndef DISABLE_PROG
 #define POM(cv,value)
-#endif
 #define POWEROFF
 #define POWERON
 #define READ_LOCO 
@@ -278,15 +225,8 @@
 #define RESUME 
 #define RETURN 
 #define REV(speed) 
-#define ROTATE(turntable_id,position,activity)
-#define ROTATE_DCC(turntable_id,position)
-#define ROSTER(cab,name,funcmap...)
 #define ROUTE(id,description)
-#define ROUTE_ACTIVE(id)
-#define ROUTE_INACTIVE(id)
-#define ROUTE_HIDDEN(id)
-#define ROUTE_DISABLED(id)
-#define ROUTE_CAPTION(id,caption)
+#define ROSTER(cab,name,funcmap...)
 #define SENDLOCO(cab,route) 
 #define SEQUENCE(id) 
 #define SERIAL(msg) 
@@ -302,28 +242,19 @@
 #define SERVO_TURNOUT(id,pin,activeAngle,inactiveAngle,profile,description...) 
 #define SET(pin) 
 #define SET_TRACK(track,mode)
-#define SET_POWER(track,onoff)
 #define SETLOCO(loco) 
 #define SIGNAL(redpin,amberpin,greenpin) 
 #define SIGNALH(redpin,amberpin,greenpin) 
 #define SPEED(speed) 
-#define START(route)
-#define STASH(id) 
-#define STEALTH(code...)
+#define START(route) 
 #define STOP 
-#define THROW(id)
-#define TT_ADDPOSITION(turntable_id,position,value,angle,description...)
+#define THROW(id)  
 #define TURNOUT(id,addr,subaddr,description...) 
-#define TURNOUTL(id,addr,description...) 
 #define UNJOIN 
 #define UNLATCH(sensor_id) 
 #define VIRTUAL_SIGNAL(id) 
 #define VIRTUAL_TURNOUT(id,description...) 
 #define WAITFOR(pin)
-#ifndef IO_NO_HAL
-#define WAITFORTT(turntable_id)
-#endif
-#define WITHROTTLE(msg)
 #define XFOFF(cab,func)
 #define XFON(cab,func)
 #endif

EXRAIL2Parser.cpp

@@ -1,310 +0,0 @@
-/*
- *  © 2021 Neil McKechnie
- *  © 2021-2023 Harald Barth
- *  © 2020-2023 Chris Harlow
- *  © 2022-2023 Colin Murdoch
- *  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 file is an extension of the RMFT2 class 
-//  normally found in EXRAIL2.cpp
-
-#include <Arduino.h>
-#include "defines.h"
-#include "EXRAIL2.h"
-#include "DCC.h"
-#include "KeywordHasher.h"
-
-// This filter intercepts <> commands to do the following:
-// - Implement RMFT specific commands/diagnostics
-// - Reject/modify JMRI commands that would interfere with RMFT processing
-
-void RMFT2::ComandFilter(Print * stream, byte & opcode, byte & paramCount, int16_t p[]) {
-  (void)stream; // avoid compiler warning if we don't access this parameter
-  bool reject=false;
-  switch(opcode) {
-    
-  case 'D':
-    if (p[0]=="EXRAIL"_hk) { // <D EXRAIL ON/OFF>
-      diag = paramCount==2 && (p[1]=="ON"_hk || p[1]==1);
-      opcode=0;
-    }
-    break;
-	
-  case '/':  // New EXRAIL command
-    reject=!parseSlash(stream,paramCount,p);
-    opcode=0;
-    break;
-  
-  case 'L':
-    // This entire code block is compiled out if LLC macros not used 
-    if (!(compileFeatures & FEATURE_LCC)) return;
-
-    if (paramCount==0) {  //<L>  LCC adapter introducing self
-      LCCSerial=stream;   // now we know where to send events we raise
-
-      // loop through all possible sent events 
-      for (int progCounter=0;; SKIPOP) {
-        byte opcode=GET_OPCODE;
-        if (opcode==OPCODE_ENDEXRAIL) break;
-        if (opcode==OPCODE_LCC)  StringFormatter::send(stream,F("<LS x%h>\n"),getOperand(progCounter,0));   
-        if (opcode==OPCODE_LCCX) { // long form LCC
-           StringFormatter::send(stream,F("<LS x%h%h%h%h>\n"),
-                 getOperand(progCounter,1),
-                 getOperand(progCounter,2),
-                 getOperand(progCounter,3),
-                 getOperand(progCounter,0)
-                 );        
-        }}
-      
-      // we stream the hex events we wish to listen to
-      // and at the same time build the event index looku.
-      
-      
-      int eventIndex=0;
-      for (int progCounter=0;; SKIPOP) {
-        byte opcode=GET_OPCODE;
-        if (opcode==OPCODE_ENDEXRAIL) break;
-        if (opcode==OPCODE_ONLCC) {
-           onLCCLookup[eventIndex]=progCounter; // TODO skip...
-           StringFormatter::send(stream,F("<LL %d x%h%h%h:%h>\n"),
-                 eventIndex,
-                 getOperand(progCounter,1),
-                 getOperand(progCounter,2),
-                 getOperand(progCounter,3),
-                 getOperand(progCounter,0)
-                 );   
-           eventIndex++;      
-        }
-      }
-      StringFormatter::send(stream,F("<LR>\n")); // Ready to rumble
-      opcode=0;
-      break;
-    }
-    if (paramCount==1) {  // <L eventid> LCC event arrived from adapter
-        int16_t eventid=p[0];
-        reject=eventid<0 || eventid>=countLCCLookup;
-        if (!reject)  startNonRecursiveTask(F("LCC"),eventid,onLCCLookup[eventid]);
-        opcode=0;
-    }
-    break; 
-    
-    case 'J':  // throttle info commands
-        if (paramCount<1) return; 
-        switch(p[0]) {
-          case "A"_hk: // <JA> returns automations/routes
-            if (paramCount==1) {// <JA>
-              StringFormatter::send(stream, F("<jA"));
-              routeLookup->stream(stream);
-              StringFormatter::send(stream, F(">\n"));
-              opcode=0;
-              return; 
-            }
-            if (paramCount==2) {  // <JA id>
-              int16_t id=p[1];
-              StringFormatter::send(stream,F("<jA %d %c \"%S\">\n"), 
-                id, getRouteType(id), getRouteDescription(id));
-              
-              if (compileFeatures & FEATURE_ROUTESTATE) {
-                // Send any non-default button states or captions
-                int16_t statePos=routeLookup->findPosition(id);
-                if (statePos>=0) {
-                 if (routeStateArray[statePos]) 
-                 StringFormatter::send(stream,F("<jB %d %d>\n"), id, routeStateArray[statePos]);
-                  if (routeCaptionArray[statePos]) 
-                  StringFormatter::send(stream,F("<jB %d \"%S\">\n"), id,routeCaptionArray[statePos]);
-                }
-              }
-              opcode=0;
-              return;
-            }
-            break;
-        case "M"_hk:
-            // NOTE: we only need to handle valid calls here because 
-            // DCCEXParser has to have code to handle the <J<> cases where
-            // exrail isnt involved anyway. 
-            // This entire code block is compiled out if STASH macros not used 
-          if (!(compileFeatures & FEATURE_STASH)) return;
-          if (paramCount==1) { // <JM>
-              StringFormatter::send(stream,F("<jM %d>\n"),maxStashId);
-              opcode=0;
-              break;
-            } 
-          if (paramCount==2) {  // <JM id>
-              if (p[1]<=0 || p[1]>maxStashId) break;
-              StringFormatter::send(stream,F("<jM %d %d>\n"),
-                    p[1],stashArray[p[1]]);
-               opcode=0;     
-               break;    
-          } 
-          if (paramCount==3) {  // <JM id cab>
-              if (p[1]<=0 || p[1]>maxStashId) break;
-              stashArray[p[1]]=p[2];
-              opcode=0;
-              break;      
-          }
-          break; 
-
-        default:
-            break;
-        }
-  default:  // other commands pass through
-    break;
-  }
-}
-
-bool RMFT2::parseSlash(Print * stream, byte & paramCount, int16_t p[]) {
-
-  if (paramCount==0) { // STATUS
-    StringFormatter::send(stream, F("<* EXRAIL STATUS"));
-    RMFT2 * task=loopTask;
-    while(task) {
-      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->speedo,
-			    task->forward?'F':'R'
-			    );
-      task=task->next;
-      if (task==loopTask) break;
-    }
-    // Now stream the flags
-    for (int id=0;id<MAX_FLAGS; id++) {
-      byte flag=flags[id];
-      if (flag & ~TASK_FLAG & ~SIGNAL_MASK) { // not interested in TASK_FLAG only. Already shown above
-	      StringFormatter::send(stream,F("\nflags[%d] "),id);
-	      if (flag & SECTION_FLAG) StringFormatter::send(stream,F(" RESERVED"));
-	      if (flag & LATCH_FLAG) StringFormatter::send(stream,F(" LATCHED"));
-      }
-    }
-
-    if (compileFeatures & FEATURE_SIGNAL) {
-      // do the signals
-      // flags[n] represents the state of the nth signal in the table 
-      for (int sigslot=0;;sigslot++) {
-        VPIN sigid=GETHIGHFLASHW(RMFT2::SignalDefinitions,sigslot*8);
-        if (sigid==0) break; // end of signal list 
-        byte flag=flags[sigslot] & SIGNAL_MASK; // obtain signal flags for this id
-        StringFormatter::send(stream,F("\n%S[%d]"), 
-          (flag == SIGNAL_RED)? F("RED") : (flag==SIGNAL_GREEN) ? F("GREEN") : F("AMBER"),
-          sigid & SIGNAL_ID_MASK); 
-      } 
-    }
-
-    if (compileFeatures & FEATURE_STASH) {
-      for (int i=1;i<=maxStashId;i++) {
-        if (stashArray[i])
-          StringFormatter::send(stream,F("\nSTASH[%d] Loco=%d"),
-              i, stashArray[i]); 
-      } 
-    }
-    
-    StringFormatter::send(stream,F(" *>\n"));
-    return true;
-  }
-  switch (p[0]) {
-  case "PAUSE"_hk: // </ PAUSE>
-    if (paramCount!=1) return false;
-    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;
-    {
-      RMFT2 * task=loopTask;
-      while(task) {
-	if (task->loco) task->driveLoco(task->speedo);
-	task=task->next;
-	if (task==loopTask) break;
-      }
-    }
-    return true;
-    
-    
-  case "START"_hk: // </ START [cab] route >
-    if (paramCount<2 || paramCount>3) return false;
-    {
-      int route=(paramCount==2) ? p[1] : p[2];
-      uint16_t cab=(paramCount==2)? 0 : p[1];
-      int pc=routeLookup->find(route);
-      if (pc<0) return false;
-      RMFT2* task=new RMFT2(pc);
-      task->loco=cab;
-    }
-    return true;
-    
-  default:
-    break;
-  }
-
-  // check KILL ALL here, otherwise the next validation confuses ALL with a flag  
-  if (p[0]=="KILL"_hk && p[1]=="ALL"_hk) {
-    while (loopTask) loopTask->kill(F("KILL ALL")); // destructor changes loopTask
-    return true;   
-  }
-
-  // all other / commands take 1 parameter
-  if (paramCount!=2 ) return false;
-  
-  switch (p[0]) {
-  case "KILL"_hk: // Kill taskid|ALL
-    {
-    if ( p[1]<0  || p[1]>=MAX_FLAGS) return false;
-    RMFT2 * task=loopTask;
-      while(task) {
-	      if (task->taskId==p[1]) {
-	        task->kill(F("KILL"));
-	        return  true;
-	      }
-	      task=task->next;
-	      if (task==loopTask) break;
-      }
-    }
-    return false;
-    
-  case "RESERVE"_hk:  // force reserve a section
-    return setFlag(p[1],SECTION_FLAG);
-    
-  case "FREE"_hk:  // force free a section
-    return setFlag(p[1],0,SECTION_FLAG);
-    
-  case "LATCH"_hk:
-    return setFlag(p[1], LATCH_FLAG);
-    
-  case "UNLATCH"_hk:
-    return setFlag(p[1], 0, LATCH_FLAG);
- 
-  case "RED"_hk:
-    doSignal(p[1],SIGNAL_RED);
-    return true;
- 
-  case "AMBER"_hk:
-    doSignal(p[1],SIGNAL_AMBER);
-    return true;
- 
-  case "GREEN"_hk:
-    doSignal(p[1],SIGNAL_GREEN);
-    return true;
-    
-  default:
-    return false;
-  }
-}
-

EXRAILMacros.h

@@ -1,7 +1,6 @@
 /*
  *  © 2021 Neil McKechnie
  *  © 2020-2022 Chris Harlow
- *  © 2022-2023 Colin Murdoch
  *  © 2023 Harald Barth
  *  All rights reserved.
  *  
@@ -46,7 +45,7 @@
 // Descriptive texts for routes and animations are created in a sepaerate function which
 // can be called to emit a list of routes/automatuions in a form suitable for Withrottle. 
  
-// PRINT(msg), LCD(row,msg) and SCREEN(display,row,msg) are implemented in a separate pass to create 
+// PRINT(msg) and LCD(row,msg) is implemented in a separate pass to create 
 // a getMessageText(id) function.  
 
 // CAUTION: The macros below are multiple passed over myAutomation.h
@@ -54,164 +53,41 @@
 
 // helper macro for turnout descriptions, creates NULL for missing description
 #define O_DESC(id, desc) case id: return ("" desc)[0]?F("" desc):NULL;
-// helper macro for turntable descriptions, creates NULL for missing description
-#define T_DESC(tid,pid,desc) if(turntableId==tid && positionId==pid) return ("" desc)[0]?F("" desc):NULL;
 // helper macro for turnout description as HIDDEN 
 #define HIDDEN "\x01"
 
-// PLAYSOUND is alias of ANOUT to make the user experience of a Conductor beter for
-// playing sounds with IO_I2CDFPlayer
-#define PLAYSOUND ANOUT
-
 // helper macro to strip leading zeros off time inputs
 // (10#mins)%100)
 #define STRIP_ZERO(value) 10##value%100
 
-// These constants help EXRAIL macros convert Track Power e.g. SET_POWER(A ON|OFF).
-//const byte TRACK_POWER_0=0, TRACK_POWER_OFF=0;    
-//const byte TRACK_POWER_1=1, TRACK_POWER_ON=1;   
-
-
 // Pass 1 Implements aliases 
 #include "EXRAIL2MacroReset.h"
 #undef ALIAS
 #define ALIAS(name,value...) const int name= 1##value##0 ==10 ? -__COUNTER__  : value##0/10; 
 #include "myAutomation.h"
 
-// Pass 1d Detect sequence duplicates.
-// This pass generates no runtime data or code 
-#include "EXRAIL2MacroReset.h"
-#undef AUTOMATION
-#define AUTOMATION(id, description) id,
-#undef ROUTE
-#define ROUTE(id, description) id,
-#undef SEQUENCE
-#define SEQUENCE(id) id,
-constexpr int16_t compileTimeSequenceList[]={
-   #include "myAutomation.h"
-   0
-   };
-constexpr int16_t stuffSize=sizeof(compileTimeSequenceList)/sizeof(int16_t) - 1;
-
-
-// Compile time function to check for sequence nos.
-constexpr bool hasseq(const int16_t value, const uint16_t pos=0 ) {
-    return pos>=stuffSize? false :
-          compileTimeSequenceList[pos]==value 
-       || hasseq(value,pos+1); 
-}
-
-// Compile time function to check for duplicate sequence nos.
-constexpr bool hasdup(const int16_t value, const uint16_t pos ) {
-    return pos>=stuffSize? false :
-          compileTimeSequenceList[pos]==value 
-       || hasseq(value,pos+1) 
-       || hasdup(compileTimeSequenceList[pos],pos+1);
-}
-
-
-static_assert(!hasdup(compileTimeSequenceList[0],1),"Duplicate SEQUENCE/ROUTE/AUTOMATION detected");
-
-//pass 1s static asserts to
-//  - check call and follows etc for existing sequence numbers
-//  - check range on LATCH/UNLATCH
-// This pass generates no runtime data or code 
-#include "EXRAIL2MacroReset.h"
-#undef CALL
-#define CALL(id) static_assert(hasseq(id),"Sequence not found");
-#undef FOLLOW
-#define FOLLOW(id)  static_assert(hasseq(id),"Sequence not found");
-#undef START
-#define START(id)  static_assert(hasseq(id),"Sequence not found");
-#undef SENDLOCO
-#define SENDLOCO(cab,id) static_assert(hasseq(id),"Sequence not found");
-#undef LATCH
-#define LATCH(id) static_assert(id>=0 && id<MAX_FLAGS,"Id out of valid range 0-255" );
-#undef UNLATCH
-#define UNLATCH(id) static_assert(id>=0 && id<MAX_FLAGS,"Id out of valid range 0-255" );
-#undef RESERVE
-#define RESERVE(id) static_assert(id>=0 && id<MAX_FLAGS,"Id out of valid range 0-255" );
-#undef FREE
-#define FREE(id) static_assert(id>=0 && id<MAX_FLAGS,"Id out of valid range 0-255" );
-#undef SPEED
-#define SPEED(speed) static_assert(speed>=0 && speed<128,"Speed out of valid range 0-127");
-#undef FWD
-#define FWD(speed) static_assert(speed>=0 && speed<128,"Speed out of valid range 0-127");
-#undef REV
-#define REV(speed) static_assert(speed>=0 && speed<128,"Speed out of valid range 0-127");
-
-#include "myAutomation.h"
-
-// Pass 1h Implements HAL macro by creating exrailHalSetup function
-// Also allows creating EXTurntable object
+// Pass 1h Implements HAL macro by creating exrailHalSetup function 
 #include "EXRAIL2MacroReset.h"
 #undef HAL
 #define HAL(haltype,params...)  haltype::create(params);
-#undef HAL_IGNORE_DEFAULTS
-#define HAL_IGNORE_DEFAULTS ignore_defaults=true;
-bool exrailHalSetup() {
-   bool ignore_defaults=false;
+void exrailHalSetup() {
    #include "myAutomation.h"
-   return ignore_defaults;
 }
 
-// Pass 1c detect compile time featurtes
-#include "EXRAIL2MacroReset.h"
-#undef SIGNAL
-#define SIGNAL(redpin,amberpin,greenpin) | FEATURE_SIGNAL 
-#undef SIGNALH
-#define SIGNALH(redpin,amberpin,greenpin) | FEATURE_SIGNAL 
-#undef SERVO_SIGNAL
-#define SERVO_SIGNAL(vpin,redval,amberval,greenval) | FEATURE_SIGNAL 
-#undef DCC_SIGNAL
-#define DCC_SIGNAL(id,addr,subaddr) | FEATURE_SIGNAL
-#undef VIRTUAL_SIGNAL
-#define VIRTUAL_SIGNAL(id) | FEATURE_SIGNAL
-
-#undef LCC
-#define LCC(eventid)  | FEATURE_LCC
-#undef LCCX
-#define LCCX(senderid,eventid) | FEATURE_LCC 
-#undef ONLCC
-#define ONLCC(senderid,eventid) | FEATURE_LCC
-#undef ROUTE_ACTIVE
-#define ROUTE_ACTIVE(id) | FEATURE_ROUTESTATE
-#undef ROUTE_INACTIVE
-#define ROUTE_INACTIVE(id) | FEATURE_ROUTESTATE
-#undef ROUTE_HIDDEN
-#define ROUTE_HIDDEN(id) | FEATURE_ROUTESTATE
-#undef ROUTE_DISABLED
-#define ROUTE_DISABLED(id) | FEATURE_ROUTESTATE
-#undef ROUTE_CAPTION
-#define ROUTE_CAPTION(id,caption) | FEATURE_ROUTESTATE
-
-#undef CLEAR_STASH
-#define CLEAR_STASH(id) | FEATURE_STASH
-#undef CLEAR_ALL_STASH
-#define CLEAR_ALL_STASH | FEATURE_STASH
-#undef PICKUP_STASH
-#define PICKUP_STASH(id) | FEATURE_STASH
-#undef STASH
-#define STASH(id) | FEATURE_STASH
-
-const byte RMFT2::compileFeatures = 0
-   #include "myAutomation.h"
-;
-
 // Pass 2 create throttle route list 
 #include "EXRAIL2MacroReset.h"
 #undef ROUTE
 #define ROUTE(id, description) id,
-const int16_t HIGHFLASH  RMFT2::routeIdList[]= {
+const int16_t HIGHFLASH RMFT2::routeIdList[]= {
     #include "myAutomation.h"
-    INT16_MAX};
+    0}; 
 // Pass 2a create throttle automation list 
 #include "EXRAIL2MacroReset.h"
 #undef AUTOMATION
 #define AUTOMATION(id, description) id,
 const int16_t HIGHFLASH RMFT2::automationIdList[]= {
     #include "myAutomation.h"
-    INT16_MAX};
+    0}; 
 
 // Pass 3 Create route descriptions:
 #undef ROUTE
@@ -244,12 +120,6 @@ const int StringMacroTracker1=__COUNTER__;
 #define PRINT(msg) THRUNGE(msg,thrunge_print)
 #undef LCN
 #define LCN(msg)   THRUNGE(msg,thrunge_lcn)
-#undef ROUTE_CAPTION
-#define ROUTE_CAPTION(id,caption) \
-case (__COUNTER__ - StringMacroTracker1) : {\
-   manageRouteCaption(id,F(caption));\
-   return;\
-   }
 #undef SERIAL
 #define SERIAL(msg)   THRUNGE(msg,thrunge_serial)
 #undef SERIAL1
@@ -272,20 +142,7 @@ case (__COUNTER__ - StringMacroTracker1) : {\
          tmode=thrunge_lcd; \
          lcdid=id;\
          break;\
-      }
-#undef SCREEN
-#define SCREEN(display,id,msg)  \
-     case (__COUNTER__ - StringMacroTracker1) : {\
-         static const char HIGHFLASH thrunge[]=msg;\
-         strfar=(uint32_t)GETFARPTR(thrunge);\
-         tmode=(thrunger)(thrunge_lcd+display); \
-         lcdid=id;\
-         break;\
       } 
-#undef STEALTH
-#define STEALTH(code...) case (__COUNTER__ - StringMacroTracker1) : {code} return; 
-#undef WITHROTTLE
-#define WITHROTTLE(msg) THRUNGE(msg,thrunge_withrottle)
 
 void  RMFT2::printMessage(uint16_t id) { 
   thrunger tmode;
@@ -303,8 +160,6 @@ void  RMFT2::printMessage(uint16_t id) {
 #include "EXRAIL2MacroReset.h"
 #undef TURNOUT
 #define TURNOUT(id,addr,subaddr,description...) O_DESC(id,description)
-#undef TURNOUTL
-#define TURNOUTL(id,addr,description...) O_DESC(id,description)
 #undef PIN_TURNOUT
 #define PIN_TURNOUT(id,pin,description...) O_DESC(id,description)
 #undef SERVO_TURNOUT
@@ -320,35 +175,10 @@ const FSH * RMFT2::getTurnoutDescription(int16_t turnoutid) {
      return NULL;
 }
 
-// Pass to get turntable descriptions (optional)
-#include "EXRAIL2MacroReset.h"
-#undef DCC_TURNTABLE
-#define DCC_TURNTABLE(id,home,description...) O_DESC(id,description)
-#undef EXTT_TURNTABLE
-#define EXTT_TURNTABLE(id,vpin,home,description...) O_DESC(id,description)
-
-const FSH * RMFT2::getTurntableDescription(int16_t turntableId) {
-   switch (turntableId) {
-      #include "myAutomation.h"
-   default:break;
-   }
-   return NULL;
-}
-
-// Pass to get turntable position descriptions (optional)
-#include "EXRAIL2MacroReset.h"
-#undef TT_ADDPOSITION
-#define TT_ADDPOSITION(turntable_id,position,value,home,description...) T_DESC(turntable_id,position,description)
-
-const FSH * RMFT2::getTurntablePositionDescription(int16_t turntableId, uint8_t positionId) {
-   #include "myAutomation.h"
-   return NULL;
-}
-
 // Pass 6: Roster IDs (count)
 #include "EXRAIL2MacroReset.h"
 #undef ROSTER
-#define ROSTER(cabid,name,funcmap...) +(cabid <= 0 ? 0 : 1)
+#define ROSTER(cabid,name,funcmap...) +1
 const byte RMFT2::rosterNameCount=0
    #include "myAutomation.h"
    ;
@@ -359,7 +189,7 @@ const byte RMFT2::rosterNameCount=0
 #define ROSTER(cabid,name,funcmap...) cabid,
 const int16_t HIGHFLASH  RMFT2::rosterIdList[]={
    #include "myAutomation.h"
-   INT16_MAX};
+   0};
 
 // Pass 7: Roster names getter
 #include "EXRAIL2MacroReset.h"
@@ -381,7 +211,7 @@ const FSH * RMFT2::getRosterFunctions(int16_t id) {
       #include "myAutomation.h"
    default: break; 
    }   
-   return NULL;
+   return F("");
 } 
 
 // Pass 8 Signal definitions
@@ -401,16 +231,6 @@ const  HIGHFLASH  int16_t RMFT2::SignalDefinitions[] = {
     #include "myAutomation.h"
     0,0,0,0 };
 
-// Pass 9 ONLCC counter and lookup array
-#include "EXRAIL2MacroReset.h"
-#undef ONLCC
-#define ONLCC(sender,event) +1 
-
-const int RMFT2::countLCCLookup=0
-#include "myAutomation.h"
-;
-int RMFT2::onLCCLookup[RMFT2::countLCCLookup];
-
 // Last Pass : create main routes table
 // Only undef the macros, not dummy them.  
 #define  RMFT2_UNDEF_ONLY
@@ -424,10 +244,8 @@ int RMFT2::onLCCLookup[RMFT2::countLCCLookup];
 #define ACTIVATE(addr,subaddr) OPCODE_DCCACTIVATE,V(addr<<3 | subaddr<<1 | 1),
 #define ACTIVATEL(addr) OPCODE_DCCACTIVATE,V((addr+3)<<1 | 1),
 #define AFTER(sensor_id) OPCODE_AT,V(sensor_id),OPCODE_AFTER,V(sensor_id),
-#define AFTEROVERLOAD(track_id) OPCODE_AFTEROVERLOAD,V(TRACK_NUMBER_##track_id),
 #define ALIAS(name,value...) 
 #define AMBER(signal_id) OPCODE_AMBER,V(signal_id),
-#define ANOUT(vpin,value,param1,param2) OPCODE_SERVO,V(vpin),OPCODE_PAD,V(value),OPCODE_PAD,V(param1),OPCODE_PAD,V(param2),
 #define AT(sensor_id) OPCODE_AT,V(sensor_id),
 #define ATGTE(sensor_id,value) OPCODE_ATGTE,V(sensor_id),OPCODE_PAD,V(value),  
 #define ATLT(sensor_id,value) OPCODE_ATLT,V(sensor_id),OPCODE_PAD,V(value),  
@@ -436,12 +254,7 @@ int RMFT2::onLCCLookup[RMFT2::countLCCLookup];
 #define AUTOSTART OPCODE_AUTOSTART,0,0,
 #define BROADCAST(msg) PRINT(msg)
 #define CALL(route) OPCODE_CALL,V(route),
-#define CLEAR_STASH(id) OPCODE_CLEAR_STASH,V(id),
-#define CLEAR_ALL_STASH OPCODE_CLEAR_ALL_STASH,V(0),
 #define CLOSE(id)  OPCODE_CLOSE,V(id),
-#ifndef IO_NO_HAL
-#define DCC_TURNTABLE(id,home,description...) OPCODE_DCCTURNTABLE,V(id),OPCODE_PAD,V(home),
-#endif
 #define DEACTIVATE(addr,subaddr) OPCODE_DCCACTIVATE,V(addr<<3 | subaddr<<1),
 #define DEACTIVATEL(addr) OPCODE_DCCACTIVATE,V((addr+3)<<1),
 #define DELAY(ms) ms<30000?OPCODE_DELAYMS:OPCODE_DELAY,V(ms/(ms<30000?1L:100L)),
@@ -455,10 +268,7 @@ int RMFT2::onLCCLookup[RMFT2::countLCCLookup];
 #define ENDIF  OPCODE_ENDIF,0,0,
 #define ENDTASK OPCODE_ENDTASK,0,0,
 #define ESTOP OPCODE_SPEED,V(1), 
-#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),
-#endif
+#define EXRAIL 
 #define FADE(pin,value,ms) OPCODE_SERVO,V(pin),OPCODE_PAD,V(value),OPCODE_PAD,V(PCA9685::ProfileType::UseDuration|PCA9685::NoPowerOff),OPCODE_PAD,V(ms/100L),
 #define FOFF(func) OPCODE_FOFF,V(func),
 #define FOLLOW(route) OPCODE_FOLLOW,V(route),
@@ -468,7 +278,6 @@ int RMFT2::onLCCLookup[RMFT2::countLCCLookup];
 #define FWD(speed) OPCODE_FWD,V(speed),
 #define GREEN(signal_id) OPCODE_GREEN,V(signal_id),
 #define HAL(haltype,params...)
-#define HAL_IGNORE_DEFAULTS
 #define IF(sensor_id) OPCODE_IF,V(sensor_id),
 #define IFAMBER(signal_id) OPCODE_IFAMBER,V(signal_id),
 #define IFCLOSED(turnout_id) OPCODE_IFCLOSED,V(turnout_id),
@@ -482,51 +291,29 @@ int RMFT2::onLCCLookup[RMFT2::countLCCLookup];
 #define IFRESERVE(block) OPCODE_IFRESERVE,V(block),
 #define IFTHROWN(turnout_id) OPCODE_IFTHROWN,V(turnout_id),
 #define IFTIMEOUT OPCODE_IFTIMEOUT,0,0,
-#ifndef IO_NO_HAL
-#define IFTTPOSITION(id,position) OPCODE_IFTTPOSITION,V(id),OPCODE_PAD,V(position),
-#endif
 #define IFRE(sensor_id,value) OPCODE_IFRE,V(sensor_id),OPCODE_PAD,V(value),
 #define INVERT_DIRECTION OPCODE_INVERT_DIRECTION,0,0,
 #define JOIN OPCODE_JOIN,0,0,
 #define KILLALL OPCODE_KILLALL,0,0,
 #define LATCH(sensor_id) OPCODE_LATCH,V(sensor_id),
-#define LCC(eventid) OPCODE_LCC,V(eventid),
-#define LCCX(sender,event) OPCODE_LCCX,V(event),\
-        OPCODE_PAD,V((((uint64_t)sender)>>32)&0xFFFF),\
-        OPCODE_PAD,V((((uint64_t)sender)>>16)&0xFFFF),\
-        OPCODE_PAD,V((((uint64_t)sender)>>0)&0xFFFF),  
 #define LCD(id,msg) PRINT(msg)
-#define SCREEN(display,id,msg) PRINT(msg)
-#define STEALTH(code...) PRINT(dummy)
 #define LCN(msg) PRINT(msg)
 #define MOVETT(id,steps,activity) OPCODE_SERVO,V(id),OPCODE_PAD,V(steps),OPCODE_PAD,V(EXTurntable::activity),OPCODE_PAD,V(0),
 #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 ONCLOSE(turnout_id) OPCODE_ONCLOSE,V(turnout_id),
-#define ONLCC(sender,event) OPCODE_ONLCC,V(event),\
-        OPCODE_PAD,V((((uint64_t)sender)>>32)&0xFFFF),\
-        OPCODE_PAD,V((((uint64_t)sender)>>16)&0xFFFF),\
-        OPCODE_PAD,V((((uint64_t)sender)>>0)&0xFFFF),        
 #define ONTIME(value) OPCODE_ONTIME,V(value),  
 #define ONCLOCKTIME(hours,mins) OPCODE_ONTIME,V((STRIP_ZERO(hours)*60)+STRIP_ZERO(mins)),
-#define ONCLOCKMINS(mins) ONCLOCKTIME(25,mins)
-#define ONOVERLOAD(track_id) OPCODE_ONOVERLOAD,V(TRACK_NUMBER_##track_id),
 #define ONDEACTIVATE(addr,subaddr) OPCODE_ONDEACTIVATE,V(addr<<2|subaddr),
 #define ONDEACTIVATEL(linear) OPCODE_ONDEACTIVATE,V(linear+3),
 #define ONGREEN(signal_id) OPCODE_ONGREEN,V(signal_id),
 #define ONRED(signal_id) OPCODE_ONRED,V(signal_id),
-#ifndef IO_NO_HAL
-#define ONROTATE(id) OPCODE_ONROTATE,V(id),
-#endif
 #define ONTHROW(turnout_id) OPCODE_ONTHROW,V(turnout_id),
 #define ONCHANGE(sensor_id) OPCODE_ONCHANGE,V(sensor_id),
 #define PAUSE OPCODE_PAUSE,0,0,
-#define PICKUP_STASH(id) OPCODE_PICKUP_STASH,V(id),
-#define PIN_TURNOUT(id,pin,description...) OPCODE_PINTURNOUT,V(id),OPCODE_PAD,V(pin),
-#ifndef DISABLE_PROG
+#define PIN_TURNOUT(id,pin,description...) OPCODE_PINTURNOUT,V(id),OPCODE_PAD,V(pin), 
 #define POM(cv,value) OPCODE_POM,V(cv),OPCODE_PAD,V(value),
-#endif
 #define POWEROFF OPCODE_POWEROFF,0,0,
 #define POWERON OPCODE_POWERON,0,0,
 #define PRINT(msg) OPCODE_PRINT,V(__COUNTER__ - StringMacroTracker2),
@@ -539,16 +326,7 @@ int RMFT2::onLCCLookup[RMFT2::countLCCLookup];
 #define RETURN OPCODE_RETURN,0,0,
 #define REV(speed) OPCODE_REV,V(speed),
 #define ROSTER(cabid,name,funcmap...)
-#ifndef IO_NO_HAL
-#define ROTATE(id,position,activity) OPCODE_ROTATE,V(id),OPCODE_PAD,V(position),OPCODE_PAD,V(EXTurntable::activity),
-#define ROTATE_DCC(id,position) OPCODE_ROTATE,V(id),OPCODE_PAD,V(position),OPCODE_PAD,V(0),
-#endif
 #define ROUTE(id, description)  OPCODE_ROUTE, V(id), 
-#define ROUTE_ACTIVE(id)  OPCODE_ROUTE_ACTIVE,V(id),
-#define ROUTE_INACTIVE(id)  OPCODE_ROUTE_INACTIVE,V(id),
-#define ROUTE_HIDDEN(id)  OPCODE_ROUTE_HIDDEN,V(id),
-#define ROUTE_DISABLED(id)  OPCODE_ROUTE_DISABLED,V(id),
-#define ROUTE_CAPTION(id,caption) PRINT(caption)
 #define SENDLOCO(cab,route) OPCODE_SENDLOCO,V(cab),OPCODE_PAD,V(route),
 #define SEQUENCE(id)  OPCODE_SEQUENCE, V(id), 
 #define SERIAL(msg) PRINT(msg)
@@ -564,43 +342,31 @@ int RMFT2::onLCCLookup[RMFT2::countLCCLookup];
 #define SERVO_TURNOUT(id,pin,activeAngle,inactiveAngle,profile,description...) OPCODE_SERVOTURNOUT,V(id),OPCODE_PAD,V(pin),OPCODE_PAD,V(activeAngle),OPCODE_PAD,V(inactiveAngle),OPCODE_PAD,V(PCA9685::ProfileType::profile),
 #define SET(pin) OPCODE_SET,V(pin),
 #define SET_TRACK(track,mode)  OPCODE_SET_TRACK,V(TRACK_MODE_##mode  <<8 | TRACK_NUMBER_##track),
-#define SET_POWER(track,onoff) OPCODE_SET_POWER,V(TRACK_POWER_##onoff),OPCODE_PAD, V(TRACK_NUMBER_##track),
 #define SETLOCO(loco) OPCODE_SETLOCO,V(loco),
 #define SIGNAL(redpin,amberpin,greenpin) 
 #define SIGNALH(redpin,amberpin,greenpin) 
 #define SPEED(speed) OPCODE_SPEED,V(speed),
-#define START(route) OPCODE_START,V(route), 
-#define STASH(id) OPCODE_STASH,V(id), 
+#define START(route) OPCODE_START,V(route),
 #define STOP OPCODE_SPEED,V(0), 
 #define THROW(id)  OPCODE_THROW,V(id),
-#ifndef IO_NO_HAL
-#define TT_ADDPOSITION(id,position,value,angle,description...) OPCODE_TTADDPOSITION,V(id),OPCODE_PAD,V(position),OPCODE_PAD,V(value),OPCODE_PAD,V(angle),
-#endif
 #define TURNOUT(id,addr,subaddr,description...) OPCODE_TURNOUT,V(id),OPCODE_PAD,V(addr),OPCODE_PAD,V(subaddr),
-#define TURNOUTL(id,addr,description...) TURNOUT(id,(addr-1)/4+1,(addr-1)%4, description)
 #define UNJOIN OPCODE_UNJOIN,0,0,
 #define UNLATCH(sensor_id) OPCODE_UNLATCH,V(sensor_id),
 #define VIRTUAL_SIGNAL(id) 
 #define VIRTUAL_TURNOUT(id,description...) OPCODE_PINTURNOUT,V(id),OPCODE_PAD,V(0), 
-#define WITHROTTLE(msg) PRINT(msg)
 #define WAITFOR(pin) OPCODE_WAITFOR,V(pin),
-#ifndef IO_NO_HAL
-#define WAITFORTT(turntable_id) OPCODE_WAITFORTT,V(turntable_id),
-#endif
 #define XFOFF(cab,func) OPCODE_XFOFF,V(cab),OPCODE_PAD,V(func),
 #define XFON(cab,func) OPCODE_XFON,V(cab),OPCODE_PAD,V(func),
 
 // Build RouteCode
 const int StringMacroTracker2=__COUNTER__;
-const  HIGHFLASH3  byte RMFT2::RouteCode[] = {
+const  HIGHFLASH  byte RMFT2::RouteCode[] = {
     #include "myAutomation.h"
     OPCODE_ENDTASK,0,0,OPCODE_ENDEXRAIL,0,0 };
 
 // Restore normal code LCD & SERIAL  macro
 #undef LCD
 #define LCD   StringFormatter::lcd
-#undef SCREEN
-#define SCREEN  StringFormatter::lcd2
 #undef SERIAL
 #define SERIAL  0x0
 #endif

EthernetInterface.cpp

@@ -47,10 +47,6 @@ void EthernetInterface::setup()
 };
 
 
-#ifdef IP_ADDRESS
-static IPAddress myIP(IP_ADDRESS);
-#endif
-
 /**
  * @brief Aquire IP Address from DHCP and start server
  * 
@@ -63,15 +59,15 @@ EthernetInterface::EthernetInterface()
     DCCTimer::getSimulatedMacAddress(mac);
     connected=false;
    
-#ifdef IP_ADDRESS
-    Ethernet.begin(mac, myIP);
-#else
+    #ifdef IP_ADDRESS
+    Ethernet.begin(mac, IP_ADDRESS);
+    #else
     if (Ethernet.begin(mac) == 0)
     {
         DIAG(F("Ethernet.begin FAILED"));
         return;
     } 
-#endif
+    #endif
     if (Ethernet.hardwareStatus() == EthernetNoHardware) {
       DIAG(F("Ethernet shield not found or W5100"));
     }
@@ -140,7 +136,7 @@ bool EthernetInterface::checkLink() {
       DIAG(F("Ethernet cable connected"));
       connected=true;
       #ifdef IP_ADDRESS
-      Ethernet.setLocalIP(myIP);      // for static IP, set it again
+      setLocalIP(IP_ADDRESS);               // for static IP, set it again
       #endif
       IPAddress ip = Ethernet.localIP();    // look what IP was obtained (dynamic or static)
       server = new EthernetServer(IP_PORT); // Ethernet Server listening on default port IP_PORT

FSH.h

@@ -47,16 +47,11 @@
 typedef __FlashStringHelper FSH;
 #define FLASH PROGMEM
 #define GETFLASH(addr) pgm_read_byte_near(addr)
-#define STRCPY_P strcpy_P
-#define STRCMP_P strcmp_P
-#define STRNCPY_P strncpy_P
-#define STRNCMP_P strncmp_P
-#define STRLEN_P strlen_P
+
 
 #if defined(ARDUINO_AVR_MEGA) || defined(ARDUINO_AVR_MEGA2560)
 // AVR_MEGA memory deliberately placed at end of link may need _far functions
 #define HIGHFLASH __attribute__((section(".fini2")))
-#define HIGHFLASH3 __attribute__((section(".fini3")))
 #define GETFARPTR(data) pgm_get_far_address(data)
 #define GETHIGHFLASH(data,offset) pgm_read_byte_far(GETFARPTR(data)+offset)
 #define GETHIGHFLASHW(data,offset) pgm_read_word_far(GETFARPTR(data)+offset)
@@ -64,7 +59,6 @@ typedef __FlashStringHelper FSH;
 // AVR_UNO/NANO runtime does not support _far functions so just use _near equivalent
 // as there is no progmem above 32kb anyway.
 #define HIGHFLASH PROGMEM
-#define HIGHFLASH3 PROGMEM
 #define GETFARPTR(data) ((uint32_t)(data))
 #define GETHIGHFLASH(data,offset) pgm_read_byte_near(GETFARPTR(data)+(offset))
 #define GETHIGHFLASHW(data,offset) pgm_read_word_near(GETFARPTR(data)+(offset))
@@ -82,15 +76,9 @@ typedef __FlashStringHelper FSH;
 typedef char FSH; 
 #define FLASH
 #define HIGHFLASH
-#define HIGHFLASH3
 #define GETFARPTR(data) ((uint32_t)(data))
 #define GETFLASH(addr) (*(const byte *)(addr))
 #define GETHIGHFLASH(data,offset)  (*(const byte *)(GETFARPTR(data)+offset))
 #define GETHIGHFLASHW(data,offset) (*(const uint16_t *)(GETFARPTR(data)+offset))
-#define STRCPY_P strcpy
-#define STRCMP_P strcmp
-#define STRNCPY_P strncpy
-#define STRNCMP_P strncmp
-#define STRLEN_P strlen
 #endif
 #endif

GITHUB_SHA.h

@@ -1 +1 @@
-#define GITHUB_SHA "devel-202402071454Z"
+#define GITHUB_SHA "devel-202302131946Z"

I2CManager.cpp

@@ -1,6 +1,6 @@
 /*
- *  © 2023, Neil McKechnie
  *  © 2022 Paul M Antoine
+ *  © 2021, Neil McKechnie
  *  All rights reserved.
  *
  *  This file is part of CommandStation-EX
@@ -35,127 +35,28 @@
 #elif defined(ARDUINO_ARCH_SAMD)
 #include "I2CManager_NonBlocking.h"
 #include "I2CManager_SAMD.h"      // SAMD21 for now... SAMD51 as well later
-#elif defined(ARDUINO_ARCH_STM32)
-#include "I2CManager_NonBlocking.h"
-#include "I2CManager_STM32.h"      // STM32F411RE for now... more later
 #else
 #define I2C_USE_WIRE
 #include "I2CManager_Wire.h"      // Other platforms
 #endif
 
 
-// Helper function for listing device types
-static const FSH * guessI2CDeviceType(uint8_t address) {
-  if (address >= 0x20 && address <= 0x26)
-    return F("GPIO Expander");
-  else if (address == 0x27)
-    return F("GPIO Expander or LCD Display");
-  else if (address == 0x29)
-    return F("Time-of-flight sensor");
-  else if (address >= 0x3c && address <= 0x3d)
-    return F("OLED Display");
-  else if (address >= 0x48 && address <= 0x57) // SC16IS752x UART detection
-    return F("SC16IS75x UART");
-  else if (address >= 0x48 && address <= 0x4f)
-    return F("Analogue Inputs or PWM");
-  else if (address >= 0x40 && address <= 0x4f)
-    return F("PWM");
-  else if (address >= 0x50 && address <= 0x5f) 
-    return F("EEPROM"); 
-  else if (address == 0x68) 
-    return F("Real-time clock"); 
-  else if (address >= 0x70 && address <= 0x77)
-    return F("I2C Mux");
-  else
-    return F("?");
-}
-
 // If not already initialised, initialise I2C
 void I2CManagerClass::begin(void) {
+  //setTimeout(25000); // 25 millisecond timeout
   if (!_beginCompleted) {
     _beginCompleted = true;
-
-    // Check for short-circuit or floating lines (no pull-up) on I2C before enabling I2C
-    const FSH *message = F("WARNING: Check I2C %S line for short/pullup");
-    pinMode(SDA, INPUT);
-    if (!digitalRead(SDA))
-      DIAG(message, F("SDA"));
-    pinMode(SCL, INPUT);
-    if (!digitalRead(SCL))
-      DIAG(message, F("SCL"));
-
-    // Now initialise I2C
     _initialise();
 
-    #if defined(I2C_USE_WIRE)
-    DIAG(F("I2CManager: Using Wire library"));
-    #endif
-
-    // Probe and list devices.  Use standard mode 
-    //  (clock speed 100kHz) for best device compatibility.
-    _setClock(100000);
-    uint32_t originalTimeout = _timeout;
-    setTimeout(1000);       // use 1ms timeout for probes
-
-  #if defined(I2C_EXTENDED_ADDRESS)
-    // First count the multiplexers and switch off all subbuses
-    _muxCount = 0;
-    for (uint8_t muxNo=I2CMux_0; muxNo <= I2CMux_7; muxNo++) {
-      if (I2CManager.muxSelectSubBus({(I2CMux)muxNo, SubBus_None})==I2C_STATUS_OK)
-        _muxCount++;
-    }
-  #endif
-
-    // Enumerate devices that are visible
+    // Probe and list devices.
     bool found = false;
-    for (uint8_t addr=0x08; addr<0x78; addr++) {
+    for (byte addr=1; addr<127; addr++) {
       if (exists(addr)) {
         found = true; 
-        DIAG(F("I2C Device found at 0x%x, %S?"), addr, guessI2CDeviceType(addr));
+        DIAG(F("I2C Device found at x%x"), addr);
       }
     }
-
-#if defined(I2C_EXTENDED_ADDRESS)
-    // Enumerate all I2C devices that are connected via multiplexer, 
-    // i.e. that respond when only one multiplexer has one subBus enabled
-    // and the device doesn't respond when the mux subBus is disabled.
-    // If any probes time out, then assume that the subbus is dead and
-    // don't do any more on that subbus.
-    for (uint8_t muxNo=I2CMux_0; muxNo <= I2CMux_7; muxNo++) {
-      uint8_t muxAddr = I2C_MUX_BASE_ADDRESS + muxNo;
-      if (exists(muxAddr)) {
-        // Select Mux Subbus
-        for (uint8_t subBus=0; subBus<=SubBus_No; subBus++) {
-          muxSelectSubBus({(I2CMux)muxNo, (I2CSubBus)subBus});
-          for (uint8_t addr=0x08; addr<0x78; addr++) {
-            uint8_t status = checkAddress(addr);
-            if (status == I2C_STATUS_OK) {
-              // De-select subbus
-              muxSelectSubBus({(I2CMux)muxNo, SubBus_None});
-              if (!exists(addr)) {
-                // Device responds when subbus selected but not when
-                // subbus disabled - ergo it must be on subbus!
-                found = true; 
-                DIAG(F("I2C Device found at {I2CMux_%d,SubBus_%d,0x%x}, %S?"), 
-                  muxNo, subBus, addr, guessI2CDeviceType(addr));
-              }
-              // Re-select subbus
-              muxSelectSubBus({(I2CMux)muxNo, (I2CSubBus)subBus});
-            } else if (status == I2C_STATUS_TIMEOUT) {
-              // Bus stuck, skip to next one.
-              break;
-            }
-          }
-        }
-        // Deselect all subBuses for this mux.  Otherwise its devices will continue to
-        // respond when other muxes are being probed.
-        I2CManager.muxSelectSubBus({(I2CMux)muxNo, SubBus_None});  // Deselect Mux
-      } 
-    }
-#endif
     if (!found) DIAG(F("No I2C Devices found"));
-    _setClock(_clockSpeed);
-    setTimeout(originalTimeout);      // set timeout back to original
   }
 }
 
@@ -164,35 +65,31 @@ void I2CManagerClass::begin(void) {
 void I2CManagerClass::setClock(uint32_t speed) {
   if (speed < _clockSpeed && !_clockSpeedFixed) {
     _clockSpeed = speed;
-    DIAG(F("I2C clock speed set to %l Hz"), _clockSpeed);
   }
   _setClock(_clockSpeed);
 }
 
-// Force clock speed to that specified.
+// Force clock speed to that specified.  It can then only 
+// be overridden by calling Wire.setClock directly.
 void I2CManagerClass::forceClock(uint32_t speed) {
-  _clockSpeed = speed;
-  _clockSpeedFixed = true;
-  _setClock(_clockSpeed);
-  DIAG(F("I2C clock speed forced to %l Hz"), _clockSpeed);
+  if (!_clockSpeedFixed) {
+    _clockSpeed = speed;
+    _clockSpeedFixed = true;
+    _setClock(_clockSpeed);
+  }
 }
 
 // Check if specified I2C address is responding (blocking operation)
 // Returns I2C_STATUS_OK (0) if OK, or error code.
-// Suppress retries.  If it doesn't respond first time it's out of the running.
-uint8_t I2CManagerClass::checkAddress(I2CAddress address) {
-  I2CRB rb;
-  rb.setWriteParams(address, NULL, 0);
-  rb.suppressRetries(true);
-  queueRequest(&rb);
-  return rb.wait();
+uint8_t I2CManagerClass::checkAddress(uint8_t address) {
+  return write(address, NULL, 0);
 }
 
 
 /***************************************************************************
  *  Write a transmission to I2C using a list of data (blocking operation)
  ***************************************************************************/
-uint8_t I2CManagerClass::write(I2CAddress address, uint8_t nBytes, ...) {
+uint8_t I2CManagerClass::write(uint8_t address, uint8_t nBytes, ...) {
   uint8_t buffer[nBytes];
   va_list args;
   va_start(args, nBytes);
@@ -205,7 +102,7 @@ uint8_t I2CManagerClass::write(I2CAddress address, uint8_t nBytes, ...) {
 /***************************************************************************
  *  Initiate a write to an I2C device (blocking operation)
  ***************************************************************************/
-uint8_t I2CManagerClass::write(I2CAddress i2cAddress, const uint8_t writeBuffer[], uint8_t writeLen) {
+uint8_t I2CManagerClass::write(uint8_t i2cAddress, const uint8_t writeBuffer[], uint8_t writeLen) {
   I2CRB req;
   uint8_t status = write(i2cAddress, writeBuffer, writeLen, &req);
   return finishRB(&req, status);
@@ -214,7 +111,7 @@ uint8_t I2CManagerClass::write(I2CAddress i2cAddress, const uint8_t writeBuffer[
 /***************************************************************************
  *  Initiate a write from PROGMEM (flash) to an I2C device (blocking operation)
  ***************************************************************************/
-uint8_t I2CManagerClass::write_P(I2CAddress i2cAddress, const uint8_t * data, uint8_t dataLen) {
+uint8_t I2CManagerClass::write_P(uint8_t i2cAddress, const uint8_t * data, uint8_t dataLen) {
   I2CRB req;
   uint8_t status = write_P(i2cAddress, data, dataLen, &req);
   return finishRB(&req, status);
@@ -223,7 +120,7 @@ uint8_t I2CManagerClass::write_P(I2CAddress i2cAddress, const uint8_t * data, ui
 /***************************************************************************
  *  Initiate a write (optional) followed by a read from the I2C device (blocking operation)
  ***************************************************************************/
-uint8_t I2CManagerClass::read(I2CAddress i2cAddress, uint8_t *readBuffer, uint8_t readLen, 
+uint8_t I2CManagerClass::read(uint8_t i2cAddress, uint8_t *readBuffer, uint8_t readLen, 
     const uint8_t *writeBuffer, uint8_t writeLen)
 {
   I2CRB req;
@@ -234,7 +131,7 @@ uint8_t I2CManagerClass::read(I2CAddress i2cAddress, uint8_t *readBuffer, uint8_
 /***************************************************************************
  *  Overload of read() to allow command to be specified as a series of bytes (blocking operation)
  ***************************************************************************/
-uint8_t I2CManagerClass::read(I2CAddress address, uint8_t readBuffer[], uint8_t readSize, 
+uint8_t I2CManagerClass::read(uint8_t address, uint8_t readBuffer[], uint8_t readSize, 
                                   uint8_t writeSize, ...) {
   va_list args;
   // Copy the series of bytes into an array.
@@ -265,7 +162,7 @@ const FSH *I2CManagerClass::getErrorMessage(uint8_t status) {
     case I2C_STATUS_NEGATIVE_ACKNOWLEDGE: return F("No response from device (address NAK)");
     case I2C_STATUS_TRANSMIT_ERROR: return F("Transmit error (data NAK)");
     case I2C_STATUS_OTHER_TWI_ERROR: return F("Other Wire/TWI error");
-    case I2C_STATUS_TIMEOUT: return F("I2C bus timeout");
+    case I2C_STATUS_TIMEOUT: return F("Timeout");
     case I2C_STATUS_ARBITRATION_LOST: return F("Arbitration lost");
     case I2C_STATUS_BUS_ERROR: return F("I2C bus error");
     case I2C_STATUS_UNEXPECTED_ERROR: return F("Unexpected error");
@@ -279,40 +176,46 @@ const FSH *I2CManagerClass::getErrorMessage(uint8_t status) {
  ***************************************************************************/
 I2CManagerClass I2CManager = I2CManagerClass();
 
-// Buffer for conversion of I2CAddress to char*.
-/* static */ char I2CAddress::addressBuffer[30];
 
 /////////////////////////////////////////////////////////////////////////////
 // Helper functions associated with I2C Request Block
 /////////////////////////////////////////////////////////////////////////////
 
 /***************************************************************************
- *  Block waiting for request to complete, and return completion status.
- *  Timeout monitoring is performed in the I2CManager.loop() function.
+ *  Block waiting for request block to complete, and return completion status.
+ *  Since such a loop could potentially last for ever if the RB status doesn't
+ *  change, we set a high limit (1sec, 1000ms) on the wait time and, if it
+ *  hasn't changed by that time we assume it's not going to, and just return
+ *  a timeout status.  This means that CS will not lock up.
  ***************************************************************************/
 uint8_t I2CRB::wait() {
-  while (status==I2C_STATUS_PENDING) {
+  unsigned long waitStart = millis();
+  do {
     I2CManager.loop();
-  };
+    // Rather than looping indefinitely, let's set a very high timeout (1s).
+    if ((millis() - waitStart) > 1000UL) { 
+      DIAG(F("I2C TIMEOUT I2C:x%x I2CRB:x%x"), i2cAddress, this);
+      status = I2C_STATUS_TIMEOUT;
+      // Note that, although the timeout is posted, the request may yet complete.
+      // TODO: Ideally we would like to cancel the request.
+      return status;
+    }
+  } while (status==I2C_STATUS_PENDING);
   return status;
 }
 
 /***************************************************************************
  *  Check whether request is still in progress.
- *  Timeout monitoring is performed in the I2CManager.loop() function.
  ***************************************************************************/
 bool I2CRB::isBusy() {
-  if (status==I2C_STATUS_PENDING) {
-    I2CManager.loop();
-    return true;
-  } else
-    return false;
+  I2CManager.loop();
+  return (status==I2C_STATUS_PENDING);
 }
 
 /***************************************************************************
  *  Helper functions to fill the I2CRequest structure with parameters.
  ***************************************************************************/
-void I2CRB::setReadParams(I2CAddress i2cAddress, uint8_t *readBuffer, uint8_t readLen) {
+void I2CRB::setReadParams(uint8_t i2cAddress, uint8_t *readBuffer, uint8_t readLen) {
   this->i2cAddress = i2cAddress;
   this->writeLen = 0;
   this->readBuffer = readBuffer;
@@ -321,7 +224,7 @@ void I2CRB::setReadParams(I2CAddress i2cAddress, uint8_t *readBuffer, uint8_t re
   this->status = I2C_STATUS_OK;
 }
 
-void I2CRB::setRequestParams(I2CAddress i2cAddress, uint8_t *readBuffer, uint8_t readLen, 
+void I2CRB::setRequestParams(uint8_t i2cAddress, uint8_t *readBuffer, uint8_t readLen, 
     const uint8_t *writeBuffer, uint8_t writeLen) {
   this->i2cAddress = i2cAddress;
   this->writeBuffer = writeBuffer;
@@ -332,7 +235,7 @@ void I2CRB::setRequestParams(I2CAddress i2cAddress, uint8_t *readBuffer, uint8_t
   this->status = I2C_STATUS_OK;
 }
 
-void I2CRB::setWriteParams(I2CAddress i2cAddress, const uint8_t *writeBuffer, uint8_t writeLen) {
+void I2CRB::setWriteParams(uint8_t i2cAddress, const uint8_t *writeBuffer, uint8_t writeLen) {
   this->i2cAddress = i2cAddress;
   this->writeBuffer = writeBuffer;
   this->writeLen = writeLen;
@@ -341,28 +244,3 @@ void I2CRB::setWriteParams(I2CAddress i2cAddress, const uint8_t *writeBuffer, ui
   this->status = I2C_STATUS_OK;
 }
 
-void I2CRB::suppressRetries(bool suppress) {
-  if (suppress)
-    this->operation |= OPERATION_NORETRY;
-  else
-    this->operation &= ~OPERATION_NORETRY;
-}
-
-
-// Helper function for converting a uint8_t to four characters (e.g. 0x23).
-void I2CAddress::toHex(const uint8_t value, char *buffer) {
-  char *ptr = buffer;
-  // Just display hex value, two digits.
-  *ptr++ = '0';
-  *ptr++ = 'x';
-  uint8_t bits = (value >> 4) & 0xf;
-  *ptr++ = bits > 9 ? bits-10+'a' : bits+'0';
-  bits = value & 0xf;
-  *ptr++ = bits > 9 ? bits-10+'a' : bits+'0';
-}
-
-#if !defined(I2C_EXTENDED_ADDRESS) 
-
-/* static */ bool I2CAddress::_addressWarningDone = false;
-
-#endif

I2CManager.h

@@ -1,6 +1,6 @@
 /*
- *  © 2023, Neil McKechnie. All rights reserved.
  *  © 2022 Paul M Antoine
+ *  © 2021, Neil McKechnie. All rights reserved.
  *
  *  This file is part of CommandStation-EX
  *
@@ -23,15 +23,13 @@
 
 #include <inttypes.h>
 #include "FSH.h"
-#include "defines.h"
-#include "DIAG.h"
 
 /* 
  * Manager for I2C communications.  For portability, it allows use 
  * of the Wire class, but also has a native implementation for AVR
  * which supports non-blocking queued I/O requests.
  * 
- * Helps to avoid calling Wire.begin() multiple times (which is not
+ * Helps to avoid calling Wire.begin() multiple times (which is not)
  * entirely benign as it reinitialises).
  * 
  * Also helps to avoid the Wire clock from being set, by another device
@@ -78,12 +76,12 @@
  * Timeout monitoring is possible, but requires that the following call is made
  * reasonably frequently in the program's loop() function:
  *  I2CManager.loop();
- * So that the application doesn't need to do this explicitly, this call is performed
- * from the I2CRB::isBusy() or I2CRB::wait() functions.
  * 
  */
 
 /* 
+ * Future enhancement possibility:
+ *
  *  I2C Multiplexer (e.g. TCA9547, TCA9548)
  * 
  *  A multiplexer offers a way of extending the address range of I2C devices.  For example, GPIO extenders use address range 0x20-0x27
@@ -96,10 +94,15 @@
  *  Thirdly, the multiplexer offers the ability to use mixed-speed devices more effectively, by allowing high-speed devices to be
  *  put on a different bus to low-speed devices, enabling the software to switch the I2C speed on-the-fly between I2C transactions.
  * 
+ *  Changes required:  Increase the size of the I2CAddress field in the IODevice class from uint8_t to uint16_t.
+ *  The most significant byte would contain a '1' bit flag, the multiplexer number (0-7) and bus number (0-7).  Then, when performing
+ *  an I2C operation, the I2CManager would check this byte and, if zero, do what it currently does.  If the byte is non-zero, then
+ *  that means the device is connected via a multiplexer so the I2C transaction should be preceded by a select command issued to the
+ *  relevant multiplexer.
  * 
  *  Non-interrupting I2C:
  * 
- *  Non-blocking I2C may be operated without interrupts (undefine I2C_USE_INTERRUPTS).  Instead, the I2C state
+ *  I2C may be operated without interrupts (undefine I2C_USE_INTERRUPTS).  Instead, the I2C state
  *  machine handler, currently invoked from the interrupt service routine, is invoked from the loop() function.
  *  The speed at which I2C operations can be performed then becomes highly dependent on the frequency that 
  *  the loop() function is called, and may be adequate under some circumstances.  
@@ -108,13 +111,6 @@
  * 
  */
 
-// Maximum number of retries on an I2C operation.
-// A value of zero will disable retries.
-// Maximum value is 254 (unsigned byte counter)
-// Note that timeout failures are not retried, but any timeout
-// configured applies to each try separately.
-#define MAX_I2C_RETRIES 2
-
 // Add following line to config.h to enable Wire library instead of native I2C drivers
 //#define I2C_USE_WIRE
 
@@ -126,233 +122,6 @@
 #define I2C_USE_INTERRUPTS
 #endif
 
-// I2C Extended Address support I2C Multiplexers and allows various properties to be 
-// associated with an I2C address such as the MUX and SubBus.  In the future, this
-// may be extended to include multiple buses, and other features. 
-// Uncomment to enable extended address.
-//
-
-//#define I2C_EXTENDED_ADDRESS
-
-/////////////////////////////////////////////////////////////////////////////////////
-// Extended I2C Address type to facilitate extended I2C addresses including
-// I2C multiplexer support.
-/////////////////////////////////////////////////////////////////////////////////////
-
-// Currently only one bus supported, and one instance of I2CManager to handle it.
-enum I2CBus : uint8_t {
-    I2CBus_0 = 0,
-};
-
-// Currently I2CAddress supports one I2C bus, with up to eight
-// multipexers (MUX) attached.  Each MUX can have up to eight sub-buses.
-enum I2CMux : uint8_t {
-  I2CMux_0 = 0,
-  I2CMux_1 = 1,
-  I2CMux_2 = 2,
-  I2CMux_3 = 3,
-  I2CMux_4 = 4,
-  I2CMux_5 = 5,
-  I2CMux_6 = 6,
-  I2CMux_7 = 7,
-  I2CMux_None = 255,   // Address doesn't need mux switching
-};
-  
-enum I2CSubBus : uint8_t {
-  SubBus_0 = 0,        // Enable individual sub-buses...
-  SubBus_1 = 1,
-#if !defined(I2CMUX_PCA9542)
-  SubBus_2 = 2,
-  SubBus_3 = 3,
-#if !defined(I2CMUX_PCA9544)
-  SubBus_4 = 4,
-  SubBus_5 = 5,
-  SubBus_6 = 6,
-  SubBus_7 = 7,
-#endif
-#endif
-  SubBus_No,           // Number of subbuses (highest + 1)
-  SubBus_None = 254,   // Disable all sub-buses on selected mux
-  SubBus_All = 255,    // Enable all sub-buses (not supported by some multiplexers)
-};
-
-// Type to hold I2C address
-#if defined(I2C_EXTENDED_ADDRESS)
-
-// First MUX address (they range between 0x70-0x77).
-#define I2C_MUX_BASE_ADDRESS 0x70
-
-// Currently I2C address supports one I2C bus, with up to eight
-// multiplexers (MUX) attached.  Each MUX can have up to eight sub-buses.
-// This structure could be extended in the future (if there is a need) 
-// to support 10-bit I2C addresses, different I2C clock speed for each
-// sub-bus, multiple I2C buses, and other features not yet thought of.
-struct I2CAddress {
-private:
-  // Fields
-  I2CBus _busNumber;
-  I2CMux _muxNumber;
-  I2CSubBus _subBus;
-  uint8_t _deviceAddress;
-  static char addressBuffer[];
-public:
-  // Constructors
-  // For I2CAddress "{I2CBus_0, Mux_0, SubBus_0, 0x23}" syntax.
-  I2CAddress(const I2CBus busNumber, const I2CMux muxNumber, const I2CSubBus subBus, const uint8_t deviceAddress) {
-    _busNumber = busNumber;
-    _muxNumber = muxNumber;
-    _subBus = subBus;
-    _deviceAddress = deviceAddress;
-  }
-
-  // Basic constructor
-  I2CAddress() : I2CAddress(I2CMux_None, SubBus_None, 0) {}
-
-  // For I2CAddress "{Mux_0, SubBus_0, 0x23}" syntax.
-  I2CAddress(const I2CMux muxNumber, const I2CSubBus subBus, const uint8_t deviceAddress) :
-    I2CAddress(I2CBus_0, muxNumber, subBus, deviceAddress) {}
-
-  // For I2CAddress in form "{SubBus_0, 0x23}" - assume Mux0 (0x70)
-  I2CAddress(I2CSubBus subBus, uint8_t deviceAddress) : 
-    I2CAddress(I2CMux_0, subBus, deviceAddress) {}
-
-  // Conversion from uint8_t to I2CAddress
-  // For I2CAddress in form "0x23"
-  // (device assumed to be on the main I2C bus).
-  I2CAddress(const uint8_t deviceAddress) : 
-    I2CAddress(I2CMux_None, SubBus_None, deviceAddress) {}
-    
-  // Conversion from uint8_t to I2CAddress
-  // For I2CAddress in form "{I2CBus_1, 0x23}"
-  // (device not connected via multiplexer).
-  I2CAddress(const I2CBus bus, const uint8_t deviceAddress) : 
-    I2CAddress(bus, I2CMux_None, SubBus_None, deviceAddress) {}
-
-  // For I2CAddress in form "{I2CMux_0, SubBus_0}" (mux selector)
-  I2CAddress(const I2CMux muxNumber, const I2CSubBus subBus) :
-    I2CAddress(muxNumber, subBus, 0x00) {}
-
-  // For I2CAddress in form "{i2cAddress, deviceAddress}"
-  // where deviceAddress is to be on the same subbus as i2cAddress.
-  I2CAddress(I2CAddress firstAddress, uint8_t newDeviceAddress) :
-    I2CAddress(firstAddress._muxNumber, firstAddress._subBus, newDeviceAddress) {}
-
-  // Conversion operator from I2CAddress to uint8_t
-  // For "uint8_t address = i2cAddress;" syntax
-  // (device assumed to be on the main I2C bus or on a currently selected subbus.
-  operator uint8_t () const { return _deviceAddress; }
-
-  // Conversion from I2CAddress to char* (uses static storage so only 
-  // one conversion can be done at a time).  So don't call it twice in a
-  // single DIAG statement for example.
-  const char* toString() { 
-    char *ptr = addressBuffer;
-    if (_muxNumber != I2CMux_None) {
-      strcpy_P(ptr, (const char*)F("{I2CMux_"));
-      ptr += 8;
-      *ptr++ = '0' + _muxNumber;
-      strcpy_P(ptr, (const char*)F(",Subbus_"));
-      ptr += 8;
-      if (_subBus == SubBus_None) {
-        strcpy_P(ptr, (const char*)F("None"));
-        ptr += 4;
-      } else if (_subBus == SubBus_All) {
-        strcpy_P(ptr, (const char*)F("All"));
-        ptr += 3;
-      } else 
-        *ptr++ = '0' + _subBus;
-      *ptr++ = ',';
-    }
-    toHex(_deviceAddress, ptr);
-    ptr += 4;
-    if (_muxNumber != I2CMux_None)
-      *ptr++ = '}';
-    *ptr = 0; // terminate string
-    return addressBuffer;
-  }
-
-  // Comparison operator
-  int operator == (I2CAddress &a) const {
-    if (_deviceAddress != a._deviceAddress) 
-      return false; // Different device address so no match
-    if (_muxNumber == I2CMux_None || a._muxNumber == I2CMux_None)
-      return true;  // Same device address, one or other on main bus
-    if (_subBus == SubBus_None || a._subBus == SubBus_None) 
-      return true;  // Same device address, one or other on main bus
-    if (_muxNumber != a._muxNumber) 
-      return false; // Connected to a subbus on a different mux
-    if (_subBus != a._subBus)
-      return false;  // different subbus
-    return true;  // Same address on same mux and same subbus
-  }
-  // Field accessors
-  I2CMux muxNumber() { return _muxNumber; }
-  I2CSubBus subBus() { return _subBus; }
-  uint8_t deviceAddress() { return _deviceAddress; }
-
-private:
-  // Helper function for converting byte to four-character hex string (e.g. 0x23).
-  void toHex(const uint8_t value, char *buffer);
-};
-
-#else
-struct I2CAddress {
-private:
-  uint8_t _deviceAddress;
-  static char addressBuffer[];
-public:
-  // Constructors
-  I2CAddress(const uint8_t deviceAddress) {
-    _deviceAddress = deviceAddress;
-  }
-  I2CAddress(I2CMux, I2CSubBus, const uint8_t deviceAddress) {
-    addressWarning();
-    _deviceAddress = deviceAddress;
-  }
-  I2CAddress(I2CSubBus, const uint8_t deviceAddress) {
-    addressWarning();
-    _deviceAddress = deviceAddress;
-  }
-
-  // Basic constructor
-  I2CAddress() : I2CAddress(0) {}
-
-  // Conversion operator from I2CAddress to uint8_t
-  // For "uint8_t address = i2cAddress;" syntax
-  operator uint8_t () const { return _deviceAddress; }
-
-  // Conversion from I2CAddress to char* (uses static storage so only 
-  // one conversion can be done at a time).  So don't call it twice in a
-  // single DIAG statement for example.
-  const char* toString () { 
-    char *ptr = addressBuffer;
-    // Just display hex value, two digits.
-    toHex(_deviceAddress, ptr);
-    ptr += 4;
-    *ptr = 0; // terminate string
-    return addressBuffer;
-  }
-
-  // Comparison operator
-  int operator == (I2CAddress &a) const {
-    if (_deviceAddress != a._deviceAddress) 
-      return false; // Different device address so no match
-    return true;  // Same address on same mux and same subbus
-  }
-private:
-  // Helper function for converting byte to four-character hex string (e.g. 0x23).
-  void toHex(const uint8_t value, char *buffer);
-  void addressWarning() {
-    if (!_addressWarningDone) {
-      DIAG(F("WARNIING: Extended I2C address used but not supported in this configuration"));
-      _addressWarningDone = true;
-    }
-  }    
-  static bool _addressWarningDone;
-};
-#endif // I2C_EXTENDED_ADDRESS
-
-
 // Status codes for I2CRB structures.
 enum : uint8_t {
   // Codes used by Wire and by native drivers
@@ -375,7 +144,6 @@ enum : uint8_t {
   I2C_STATE_ACTIVE=253,
   I2C_STATE_FREE=254,
   I2C_STATE_CLOSING=255,
-  I2C_STATE_COMPLETED=252,
 };
 
 typedef enum : uint8_t
@@ -384,8 +152,6 @@ typedef enum : uint8_t
   OPERATION_REQUEST = 2,
   OPERATION_SEND = 3,
   OPERATION_SEND_P = 4,
-  OPERATION_NORETRY = 0x80,  // OR with operation to suppress retries.
-  OPERATION_MASK = 0x7f,  // mask for extracting the operation code
 } OperationEnum;
 
 
@@ -404,19 +170,18 @@ public:
   uint8_t wait();
   bool isBusy();
 
-  void setReadParams(I2CAddress i2cAddress, uint8_t *readBuffer, uint8_t readLen);
-  void setRequestParams(I2CAddress i2cAddress, uint8_t *readBuffer, uint8_t readLen, const uint8_t *writeBuffer, uint8_t writeLen);
-  void setWriteParams(I2CAddress i2cAddress, const uint8_t *writeBuffer, uint8_t writeLen);
-  void suppressRetries(bool suppress);
+  void setReadParams(uint8_t i2cAddress, uint8_t *readBuffer, uint8_t readLen);
+  void setRequestParams(uint8_t i2cAddress, uint8_t *readBuffer, uint8_t readLen, const uint8_t *writeBuffer, uint8_t writeLen);
+  void setWriteParams(uint8_t i2cAddress, const uint8_t *writeBuffer, uint8_t writeLen);
 
   uint8_t writeLen;
   uint8_t readLen;
   uint8_t operation;
-  I2CAddress i2cAddress;
+  uint8_t i2cAddress;
   uint8_t *readBuffer;
   const uint8_t *writeBuffer;
 #if !defined(I2C_USE_WIRE)
-  I2CRB *nextRequest;  // Used by non-blocking devices for I2CRB queue management.
+  I2CRB *nextRequest;
 #endif
 };
 
@@ -430,33 +195,26 @@ public:
   void setClock(uint32_t speed);
   // Force clock speed 
   void forceClock(uint32_t speed);
-  // setTimeout sets the timout value for I2C transactions (milliseconds).
-  void setTimeout(unsigned long);
   // Check if specified I2C address is responding.
-  uint8_t checkAddress(I2CAddress address);
-  inline bool exists(I2CAddress address) {
+  uint8_t checkAddress(uint8_t address);
+  inline bool exists(uint8_t address) {
     return checkAddress(address)==I2C_STATUS_OK;
   }
-  // Select/deselect Mux Sub-Bus (if using legacy addresses, just checks address)
-  // E.g. muxSelectSubBus({I2CMux_0, SubBus_3});
-  uint8_t muxSelectSubBus(I2CAddress address) {
-    return checkAddress(address);
-  }
   // Write a complete transmission to I2C from an array in RAM
-  uint8_t write(I2CAddress address, const uint8_t buffer[], uint8_t size);
-  uint8_t write(I2CAddress address, const uint8_t buffer[], uint8_t size, I2CRB *rb);
+  uint8_t write(uint8_t address, const uint8_t buffer[], uint8_t size);
+  uint8_t write(uint8_t address, const uint8_t buffer[], uint8_t size, I2CRB *rb);
   // Write a complete transmission to I2C from an array in Flash
-  uint8_t write_P(I2CAddress address, const uint8_t buffer[], uint8_t size);
-  uint8_t write_P(I2CAddress address, const uint8_t buffer[], uint8_t size, I2CRB *rb);
+  uint8_t write_P(uint8_t address, const uint8_t buffer[], uint8_t size);
+  uint8_t write_P(uint8_t address, const uint8_t buffer[], uint8_t size, I2CRB *rb);
   // Write a transmission to I2C from a list of bytes.
-  uint8_t write(I2CAddress address, uint8_t nBytes, ...);
+  uint8_t write(uint8_t address, uint8_t nBytes, ...);
   // Write a command from an array in RAM and read response
-  uint8_t read(I2CAddress address, uint8_t readBuffer[], uint8_t readSize, 
+  uint8_t read(uint8_t address, uint8_t readBuffer[], uint8_t readSize, 
     const uint8_t writeBuffer[]=NULL, uint8_t writeSize=0);
-  uint8_t read(I2CAddress address, uint8_t readBuffer[], uint8_t readSize, 
+  uint8_t read(uint8_t address, uint8_t readBuffer[], uint8_t readSize, 
     const uint8_t writeBuffer[], uint8_t writeSize, I2CRB *rb);
   // Write a command from an arbitrary list of bytes and read response
-  uint8_t read(I2CAddress address, uint8_t readBuffer[], uint8_t readSize, 
+  uint8_t read(uint8_t address, uint8_t readBuffer[], uint8_t readSize, 
     uint8_t writeSize, ...);
   void queueRequest(I2CRB *req);
 
@@ -473,37 +231,18 @@ public:
 private:
   bool _beginCompleted = false;
   bool _clockSpeedFixed = false;
-  uint8_t retryCounter;  // Count of retries
-  // Clock speed must be no higher than 400kHz on AVR. Higher is possible on 4809, SAMD
-  // and STM32 but most popular I2C devices are 400kHz so in practice the higher speeds
-  // will not be useful.  The speed can be overridden by I2CManager::forceClock().
-  uint32_t _clockSpeed = I2C_FREQ;  
-  // Default timeout 100ms on I2C request block completion.
-  // A full 32-byte transmission takes about 8ms at 100kHz,
-  // so this value allows lots of headroom.  
-  // It can be modified by calling I2CManager.setTimeout() function.
-  // When retries are enabled, the timeout applies to each
-  // try, and failure from timeout does not get retried.
-  // A value of 0 means disable timeout monitoring.
-  uint32_t _timeout = 100000UL;
-    
+#if defined(__arm__)
+  uint32_t _clockSpeed = 32000000L;  // 3.2MHz max on SAMD and STM32
+#else
+  uint32_t _clockSpeed = 400000L;  // 400kHz max on Arduino.
+#endif
+
   // Finish off request block by waiting for completion and posting status.
   uint8_t finishRB(I2CRB *rb, uint8_t status);
 
   void _initialise();
   void _setClock(unsigned long);
 
-#if defined(I2C_EXTENDED_ADDRESS)
-// Count of I2C multiplexers found when initialising.  If there is only one
-// MUX then the subbus does not need de-selecting after use; however, if there
-// are two or more, then the subbus must be deselected to avoid multiple
-// sub-bus legs on different multiplexers being accessible simultaneously.
-private:
-  uint8_t _muxCount = 0;
-public:
-  uint8_t getMuxCount() { return _muxCount; }
-#endif
-
 #if !defined(I2C_USE_WIRE)
     // I2CRB structs are queued on the following two links.
     // If there are no requests, both are NULL.
@@ -513,58 +252,42 @@ public:
     // Within the queue, each request's nextRequest field points to the 
     // next request, or NULL.
     // Mark volatile as they are updated by IRC and read/written elsewhere.
-private:
-    I2CRB * volatile queueHead = NULL;
-    I2CRB * volatile queueTail = NULL;
+    static I2CRB * volatile queueHead;
+    static I2CRB * volatile queueTail;
+    static volatile uint8_t state;
 
-    // State is set to I2C_STATE_FREE when the interrupt handler has finished
-    // the current request and is ready to complete.
-    uint8_t state = I2C_STATE_FREE;
-
-    // CompletionStatus may be set by the interrupt handler at any time but is
-    // not written to the I2CRB until the state is I2C_STATE_FREE.
-    uint8_t completionStatus = I2C_STATUS_OK;
-    uint8_t overallStatus = I2C_STATUS_OK;
-
-    I2CRB * currentRequest = NULL;
-    uint8_t txCount = 0;
-    uint8_t rxCount = 0;
-    uint8_t bytesToSend = 0;
-    uint8_t bytesToReceive = 0;
-    uint8_t operation = 0;
-    uint32_t startTime = 0;
-    uint8_t muxPhase = 0;
-    uint8_t muxAddress = 0;
-    uint8_t muxData[1];
-    uint8_t deviceAddress;
-    const uint8_t *sendBuffer;
-    uint8_t *receiveBuffer;
-    uint8_t transactionState = 0;
-  
-    volatile uint32_t pendingClockSpeed = 0;
+    static I2CRB * volatile currentRequest;
+    static volatile uint8_t txCount;
+    static volatile uint8_t rxCount;
+    static volatile uint8_t bytesToSend;
+    static volatile uint8_t bytesToReceive;
+    static volatile uint8_t operation;
+    static volatile unsigned long startTime;
 
+    static unsigned long timeout; // Transaction timeout in microseconds.  0=disabled.
+    
     void startTransaction();
     
     // Low-level hardware manipulation functions.
-    void I2C_init();
-    void I2C_setClock(unsigned long i2cClockSpeed);
-    void I2C_handleInterrupt();
-    void I2C_sendStart();
-    void I2C_sendStop();
-    void I2C_close();
+    static void I2C_init();
+    static void I2C_setClock(unsigned long i2cClockSpeed);
+    static void I2C_handleInterrupt();
+    static void I2C_sendStart();
+    static void I2C_sendStop();
+    static void I2C_close();
     
   public:
+    // setTimeout sets the timout value for I2C transactions.
+    // TODO: Get I2C timeout working before uncommenting the code below.
+    void setTimeout(unsigned long value) { (void)value; /* timeout = value; */ };
+
     // handleInterrupt needs to be public to be called from the ISR function!
-    void handleInterrupt();
+    static void handleInterrupt();
 #endif
 
 
 };
 
-// Pointer to class instance (Note: if there is more than one bus, each will have
-// its own instance of I2CManager, selected by the queueRequest function from
-// the I2CBus field within the request block's I2CAddress).
 extern I2CManagerClass I2CManager;
 
-
 #endif

I2CManager_AVR.h

@@ -1,5 +1,5 @@
 /*
- *  © 2023, Neil McKechnie. All rights reserved.
+ *  © 2021, Neil McKechnie. All rights reserved.
  *
  *  This file is part of CommandStation-EX
  *
@@ -22,7 +22,6 @@
 
 #include <Arduino.h>
 #include "I2CManager.h"
-#include "I2CManager_NonBlocking.h"   // to satisfy intellisense
 
 #include <avr/io.h>
 #include <avr/interrupt.h>
@@ -95,13 +94,12 @@ void I2CManagerClass::I2C_init()
  *  Initiate a start bit for transmission.
  ***************************************************************************/
 void I2CManagerClass::I2C_sendStart() {
-  rxCount = 0;
-  txCount = 0;
-  // We may have already triggered a stop bit in the same run as this.  To avoid
-  // clearing that bit before the stop bit has been sent, we can either wait for
-  // it to complete or we can OR the bit onto the existing bits.
-  TWCR |= (1<<TWEN)|ENABLE_TWI_INTERRUPT|(1<<TWINT)|(1<<TWEA)|(1<<TWSTA);  // Send Start
-
+  bytesToSend = currentRequest->writeLen;
+  bytesToReceive = currentRequest->readLen;
+  // We may have initiated a stop bit before this without waiting for it.
+  // Wait for stop bit to be sent before sending start.
+  while (TWCR & (1<<TWSTO)) {}
+  TWCR = (1<<TWEN)|ENABLE_TWI_INTERRUPT|(1<<TWINT)|(1<<TWEA)|(1<<TWSTA);  // Send Start
 }
 
 /***************************************************************************
@@ -109,7 +107,7 @@ void I2CManagerClass::I2C_sendStart() {
  ***************************************************************************/
 void I2CManagerClass::I2C_sendStop() {
   TWDR = 0xff;  // Default condition = SDA released
-  TWCR = (1<<TWEN)|(1<<TWINT)|(1<<TWSTO);  // Send Stop
+  TWCR = (1<<TWEN)|(1<<TWINT)|(1<<TWEA)|(1<<TWSTO);  // Send Stop
 }
 
 /***************************************************************************
@@ -117,8 +115,9 @@ void I2CManagerClass::I2C_sendStop() {
  ***************************************************************************/
 void I2CManagerClass::I2C_close() {
   // disable TWI
+  I2C_sendStop();
+  while (TWCR & (1<<TWSTO)) {}
   TWCR = (1<<TWINT);                 // clear any interrupt and stop twi.
-  delayMicroseconds(10);  // Wait for things to stabilise (hopefully)
 }
 
 /***************************************************************************
@@ -126,51 +125,37 @@ void I2CManagerClass::I2C_close() {
  *  if I2C_USE_INTERRUPTS isn't defined, from the I2CManagerClass::loop() function
  *  (and therefore, indirectly, from I2CRB::wait() and I2CRB::isBusy()).
  ***************************************************************************/
-
 void I2CManagerClass::I2C_handleInterrupt() {
   if (!(TWCR & (1<<TWINT))) return;  // Nothing to do.
 
   uint8_t twsr = TWSR & 0xF8;
 
-
-  // Main I2C interrupt handler, used for the device communications.
-  // The following variables are used:
-  //    bytesToSend, bytesToReceive (R/W)
-  //    txCount, rxCount (W)
-  //    deviceAddress (R)
-  //    sendBuffer, receiveBuffer (R)
-  //    operation (R)
-  //    state, completionStatus (W)
-  // 
   // Cases are ordered so that the most frequently used ones are tested first.
   switch (twsr) {
     case TWI_MTX_DATA_ACK:      // Data byte has been transmitted and ACK received
     case TWI_MTX_ADR_ACK:       // SLA+W has been transmitted and ACK received
       if (bytesToSend) {  // Send first.
         if (operation == OPERATION_SEND_P)
-          TWDR = GETFLASH(sendBuffer + (txCount++));
+          TWDR = GETFLASH(currentRequest->writeBuffer + (txCount++));
         else
-          TWDR = sendBuffer[txCount++];
+          TWDR = currentRequest->writeBuffer[txCount++];
         bytesToSend--;
-        TWCR = (1<<TWEN)|ENABLE_TWI_INTERRUPT|(1<<TWINT);
+        TWCR = (1<<TWEN)|ENABLE_TWI_INTERRUPT|(1<<TWINT)|(1<<TWEA);
       } else if (bytesToReceive) {  // All sent, anything to receive?
-        // Don't need to wait for stop, as the interface won't send the start until
-        // any in-progress stop condition from previous interrupts has been sent.
-        TWCR = (1<<TWEN)|ENABLE_TWI_INTERRUPT|(1<<TWINT)|(1<<TWSTA);  // Send Start
-      } else {  
-         // Nothing left to send or receive
+        while (TWCR & (1<<TWSTO)) {}    // Wait for stop to be sent
+        TWCR = (1<<TWEN)|ENABLE_TWI_INTERRUPT|(1<<TWINT)|(1<<TWEA)|(1<<TWSTA);  // Send Start
+      } else {  // Nothing left to send or receive
+        TWDR = 0xff;  // Default condition = SDA released
         TWCR = (1<<TWEN)|(1<<TWINT)|(1<<TWEA)|(1<<TWSTO);  // Send Stop
-        state = I2C_STATE_COMPLETED;
+        state = I2C_STATUS_OK;
       }
       break;
-
     case TWI_MRX_DATA_ACK:      // Data byte has been received and ACK transmitted
       if (bytesToReceive > 0) {
-        receiveBuffer[rxCount++] = TWDR;
+        currentRequest->readBuffer[rxCount++] = TWDR;
         bytesToReceive--;
       }
       /* fallthrough */
-
     case TWI_MRX_ADR_ACK:      // SLA+R has been sent and ACK received
       if (bytesToReceive <= 1) {
         TWCR = (1<<TWEN)|ENABLE_TWI_INTERRUPT|(1<<TWINT); // Send NACK after next reception
@@ -179,51 +164,45 @@ void I2CManagerClass::I2C_handleInterrupt() {
         TWCR = (1<<TWEN)|ENABLE_TWI_INTERRUPT|(1<<TWINT)|(1<<TWEA);
       }
       break;
-
     case TWI_MRX_DATA_NACK:     // Data byte has been received and NACK transmitted
       if (bytesToReceive > 0) {
-        receiveBuffer[rxCount++] = TWDR;
+        currentRequest->readBuffer[rxCount++] = TWDR;
         bytesToReceive--;
       }
       TWCR = (1<<TWEN)|(1<<TWINT)|(1<<TWEA)|(1<<TWSTO);  // Send Stop
-      state = I2C_STATE_COMPLETED;
+      state = I2C_STATUS_OK;
       break;
-
     case TWI_START:             // START has been transmitted  
     case TWI_REP_START:         // Repeated START has been transmitted
       // Set up address and R/W
       if (operation == OPERATION_READ || (operation==OPERATION_REQUEST && !bytesToSend))
-        TWDR = (deviceAddress << 1) | 1; // SLA+R
+        TWDR = (currentRequest->i2cAddress << 1) | 1; // SLA+R
       else
-        TWDR = (deviceAddress << 1) | 0; // SLA+W
+        TWDR = (currentRequest->i2cAddress << 1) | 0; // SLA+W
       TWCR = (1<<TWEN)|ENABLE_TWI_INTERRUPT|(1<<TWINT)|(1<<TWEA);
       break;
-
     case TWI_MTX_ADR_NACK:      // SLA+W has been transmitted and NACK received
     case TWI_MRX_ADR_NACK:      // SLA+R has been transmitted and NACK received
     case TWI_MTX_DATA_NACK:     // Data byte has been transmitted and NACK received
+      TWDR = 0xff;  // Default condition = SDA released
       TWCR = (1<<TWEN)|(1<<TWINT)|(1<<TWEA)|(1<<TWSTO);  // Send Stop
-      completionStatus = I2C_STATUS_NEGATIVE_ACKNOWLEDGE;
-      state = I2C_STATE_COMPLETED;
+      state = I2C_STATUS_NEGATIVE_ACKNOWLEDGE;
       break;
-
     case TWI_ARB_LOST:          // Arbitration lost
       // Restart transaction from start.
       I2C_sendStart();
       break;
-
     case TWI_BUS_ERROR:         // Bus error due to an illegal START or STOP condition
     default:
       TWDR = 0xff;  // Default condition = SDA released
       TWCR = (1<<TWEN)|(1<<TWINT)|(1<<TWEA)|(1<<TWSTO);  // Send Stop
-      completionStatus = I2C_STATUS_TRANSMIT_ERROR;
-      state = I2C_STATE_COMPLETED;
+      state = I2C_STATUS_TRANSMIT_ERROR;
   }
 }
 
 #if defined(I2C_USE_INTERRUPTS)
 ISR(TWI_vect) {
-  I2CManager.handleInterrupt();
+  I2CManagerClass::handleInterrupt();
 }
 #endif
 

I2CManager_Mega4809.h

@@ -1,5 +1,5 @@
 /*
- *  © 2023, Neil McKechnie. All rights reserved.
+ *  © 2021, Neil McKechnie. All rights reserved.
  *
  *  This file is part of CommandStation-EX
  *
@@ -28,21 +28,21 @@
  ***************************************************************************/
 void I2CManagerClass::I2C_setClock(unsigned long i2cClockSpeed) {
   uint16_t t_rise;
-  if (i2cClockSpeed < 200000)
+  if (i2cClockSpeed < 200000) {
+    i2cClockSpeed = 100000;
     t_rise = 1000;
-  else if (i2cClockSpeed < 800000)
+  } else if (i2cClockSpeed < 800000) {
+    i2cClockSpeed = 400000;
     t_rise = 300;
-  else
+  } else if (i2cClockSpeed < 1200000) {
+    i2cClockSpeed = 1000000;
     t_rise = 120;
-
-  if (t_rise == 120)
-    TWI0.CTRLA |= TWI_FMPEN_bm;
-  else
-    TWI0.CTRLA &= ~TWI_FMPEN_bm;
-  
+  } else {
+    i2cClockSpeed = 100000;
+    t_rise = 1000;
+  }
   uint32_t baud = (F_CPU_CORRECTED / i2cClockSpeed - F_CPU_CORRECTED / 1000 / 1000
     * t_rise / 1000 - 10) / 2;
-  if (baud > 255) baud = 255;  // ~30kHz
   TWI0.MBAUD = (uint8_t)baud;
 }
 
@@ -54,13 +54,13 @@ void I2CManagerClass::I2C_init()
   pinMode(PIN_WIRE_SDA, INPUT_PULLUP);
   pinMode(PIN_WIRE_SCL, INPUT_PULLUP);
   PORTMUX.TWISPIROUTEA |= TWI_MUX;
-  I2C_setClock(I2C_FREQ);
 
 #if defined(I2C_USE_INTERRUPTS)
   TWI0.MCTRLA = TWI_RIEN_bm | TWI_WIEN_bm | TWI_ENABLE_bm;
 #else
   TWI0.MCTRLA = TWI_ENABLE_bm;
 #endif
+  I2C_setClock(I2C_FREQ);
   TWI0.MSTATUS = TWI_BUSSTATE_IDLE_gc;
 }
 
@@ -68,8 +68,8 @@ void I2CManagerClass::I2C_init()
  *  Initiate a start bit for transmission, followed by address and R/W
  ***************************************************************************/
 void I2CManagerClass::I2C_sendStart() {
-  txCount = 0;
-  rxCount = 0;
+  bytesToSend = currentRequest->writeLen;
+  bytesToReceive = currentRequest->readLen;
 
   // If anything to send, initiate write.  Otherwise initiate read.
   if (operation == OPERATION_READ || ((operation == OPERATION_REQUEST) && !bytesToSend))
@@ -89,10 +89,7 @@ void I2CManagerClass::I2C_sendStop() {
  *  Close I2C down
  ***************************************************************************/
 void I2CManagerClass::I2C_close() {
-
-  TWI0.MCTRLA &= ~(TWI_RIEN_bm | TWI_WIEN_bm | TWI_ENABLE_bm);        // Switch off I2C
-  TWI0.MSTATUS = TWI_BUSSTATE_UNKNOWN_gc;
-  delayMicroseconds(10);  // Wait for things to stabilise (hopefully)
+  I2C_sendStop();
 }
 
 /***************************************************************************
@@ -108,42 +105,46 @@ void I2CManagerClass::I2C_handleInterrupt() {
     I2C_sendStart();   // Reinitiate request
   } else if (currentStatus & TWI_BUSERR_bm) {
     // Bus error
-    completionStatus = I2C_STATUS_BUS_ERROR;
-    state = I2C_STATE_COMPLETED;
+    state = I2C_STATUS_BUS_ERROR;
     TWI0.MSTATUS = currentStatus; // clear all flags
   } else if (currentStatus & TWI_WIF_bm) {
     // Master write completed
     if (currentStatus & TWI_RXACK_bm) {
       // Nacked, send stop.
       TWI0.MCTRLB = TWI_MCMD_STOP_gc;
-      completionStatus = I2C_STATUS_NEGATIVE_ACKNOWLEDGE;
-      state = I2C_STATE_COMPLETED;
-
+      state = I2C_STATUS_NEGATIVE_ACKNOWLEDGE;
     } else if (bytesToSend) {
-      // Acked, so send next byte (don't need to use GETFLASH)
-      TWI0.MDATA = sendBuffer[txCount++];
+      // Acked, so send next byte
+      if (currentRequest->operation == OPERATION_SEND_P)
+        TWI0.MDATA = GETFLASH(currentRequest->writeBuffer + (txCount++));
+      else
+        TWI0.MDATA = currentRequest->writeBuffer[txCount++];
       bytesToSend--;
     } else if (bytesToReceive) {
-      // Last sent byte acked and no more to send.  Send repeated start, address and read bit.
-      TWI0.MADDR = (deviceAddress << 1) | 1;
+        // Last sent byte acked and no more to send.  Send repeated start, address and read bit.
+        TWI0.MADDR = (currentRequest->i2cAddress << 1) | 1;
     } else {
       // No more data to send/receive. Initiate a STOP condition.
       TWI0.MCTRLB = TWI_MCMD_STOP_gc;
-      state = I2C_STATE_COMPLETED;
+      state = I2C_STATUS_OK;  // Done
     }
   } else if (currentStatus & TWI_RIF_bm) {
     // Master read completed without errors
     if (bytesToReceive) {
-      receiveBuffer[rxCount++] = TWI0.MDATA;  // Store received byte
+      currentRequest->readBuffer[rxCount++] = TWI0.MDATA;  // Store received byte
       bytesToReceive--;
-    } 
+    } else { 
+      // Buffer full, issue nack/stop
+      TWI0.MCTRLB = TWI_ACKACT_bm | TWI_MCMD_STOP_gc;
+      state = I2C_STATUS_OK;
+    }
     if (bytesToReceive) {
       // More bytes to receive, issue ack and start another read
       TWI0.MCTRLB = TWI_MCMD_RECVTRANS_gc;
     } else {
       // Transaction finished, issue NACK and STOP.
       TWI0.MCTRLB = TWI_ACKACT_bm | TWI_MCMD_STOP_gc;
-      state = I2C_STATE_COMPLETED;
+      state = I2C_STATUS_OK;
     }
   }
 }
@@ -153,7 +154,7 @@ void I2CManagerClass::I2C_handleInterrupt() {
  *  Interrupt handler.
  ***************************************************************************/
 ISR(TWI0_TWIM_vect) {
-  I2CManager.handleInterrupt();
+  I2CManagerClass::handleInterrupt();
 }
 
 #endif

I2CManager_NonBlocking.h

@@ -1,6 +1,6 @@
 /*
- *  © 2023, Neil McKechnie
  *  © 2022 Paul M Antoine
+ *  © 2021, Neil McKechnie
  *  All rights reserved.
  *
  *  This file is part of CommandStation-EX
@@ -24,47 +24,51 @@
 
 #include <Arduino.h>
 #include "I2CManager.h"
-
-// Support for atomic isolation (i.e. a block with interrupts disabled).
-// E.g. 
-//       ATOMIC_BLOCK() {
-//         doSomethingWithInterruptsDisabled();
-//       }
-// This has the advantage over simple noInterrupts/Interrupts that the
-// original interrupt state is restored when the block finishes.
-//
-// (This should really be defined in an include file somewhere more global, so 
-// it can replace use of noInterrupts/interrupts in other parts of DCC-EX.
-//
-static inline uint8_t _deferInterrupts(void) {
-  noInterrupts();
-  return 1;
+#if defined(I2C_USE_INTERRUPTS)
+// atomic.h isn't available on SAMD, and likely others too...
+#if defined(__AVR__)
+#include <util/atomic.h>
+#elif defined(__arm__)
+// Helper assembly language functions
+static __inline__ uint8_t my_iSeiRetVal(void)
+{
+    __asm__ __volatile__ ("cpsie i" ::);
+    return 1;
 }
-static inline void _conditionalEnableInterrupts(bool *wasEnabled) {
-  if (*wasEnabled) interrupts();
-}
-#define ATOMIC_BLOCK(x) \
-for (bool _int_saved __attribute__((__cleanup__(_conditionalEnableInterrupts))) \
-            =_getInterruptState(),_ToDo=_deferInterrupts(); _ToDo; _ToDo=0)
 
-#if defined(__AVR__) // Nano, Uno, Mega2580, NanoEvery, etc.
-  static inline bool _getInterruptState(void) {
-    return bitRead(SREG, SREG_I);  // true if enabled, false if disabled
-  }
-#elif defined(__arm__)  // STM32, SAMD, Teensy
-  static inline bool _getInterruptState( void ) {
-    uint32_t reg;
-    __asm__ __volatile__ ("MRS %0, primask" : "=r" (reg) );
-    return !(reg & 1);  // true if interrupts enabled, false otherwise
-  }
-#else
-  #warning "ATOMIC_BLOCK() not defined for this target type, I2C interrupts disabled"
-  #define ATOMIC_BLOCK(x) // expand to nothing.
-  #ifdef I2C_USE_INTERRUPTS
-    #undef I2C_USE_INTERRUPTS
-  #endif
+static __inline__ uint8_t my_iCliRetVal(void)
+{
+    __asm__ __volatile__ ("cpsid i" ::);
+    return 1;
+}
+
+static __inline__ void my_iRestore(const  uint32_t *__s)
+{
+    uint32_t res = *__s;
+    __asm__ __volatile__ ("MSR primask, %0" : : "r" (res) );
+}
+
+static __inline__ uint32_t my_iGetIReg( void )
+{
+        uint32_t reg;
+        __asm__ __volatile__ ("MRS %0, primask" : "=r" (reg) );
+        return reg;
+}
+// Macros for atomic isolation
+#define MY_ATOMIC_RESTORESTATE uint32_t _sa_saved                           \
+    __attribute__((__cleanup__(my_iRestore))) = my_iGetIReg()
+
+#define ATOMIC()                                                         \
+for ( MY_ATOMIC_RESTORESTATE, _done =  my_iCliRetVal();                   \
+    _done; _done = 0 )
+
+#define ATOMIC_BLOCK(x) ATOMIC()
+#define ATOMIC_RESTORESTATE
+#endif
+#else
+#define ATOMIC_BLOCK(x) 
+#define ATOMIC_RESTORESTATE
 #endif
-
 
 // This module is only compiled if I2C_USE_WIRE is not defined, so undefine it here
 // to get intellisense to work correctly.
@@ -72,14 +76,6 @@ for (bool _int_saved __attribute__((__cleanup__(_conditionalEnableInterrupts)))
 #undef I2C_USE_WIRE
 #endif
 
-enum MuxPhase: uint8_t {
-  MuxPhase_OFF = 0,
-  MuxPhase_PROLOG,
-  MuxPhase_PAYLOAD,
-  MuxPhase_EPILOG,
-} ;
-
-
 /***************************************************************************
  * Initialise the I2CManagerAsync class.
  ***************************************************************************/
@@ -88,82 +84,31 @@ void I2CManagerClass::_initialise()
   queueHead = queueTail = NULL;
   state = I2C_STATE_FREE;
   I2C_init();
-  _setClock(_clockSpeed);
 }
 
 /***************************************************************************
  *  Set I2C clock speed.  Normally 100000 (Standard) or 400000 (Fast)
  *   on Arduino.  Mega4809 supports 1000000 (Fast+) too.
- *   This function saves the desired clock speed and the startTransaction
- *   function acts on it before a new transaction, to avoid speed changes
- *   during an I2C transaction.
  ***************************************************************************/
 void I2CManagerClass::_setClock(unsigned long i2cClockSpeed) {
-  pendingClockSpeed = i2cClockSpeed;
+  I2C_setClock(i2cClockSpeed);
 }
 
 /***************************************************************************
- * Start an I2C transaction, if the I2C interface is free and
+ * Helper function to start operations, if the I2C interface is free and
  * there is a queued request to be processed.
- * If there's an I2C clock speed change pending, then implement it before 
- * starting the operation.
  ***************************************************************************/
-void I2CManagerClass::startTransaction() {
-  ATOMIC_BLOCK() {
+void I2CManagerClass::startTransaction() { 
+  ATOMIC_BLOCK(ATOMIC_RESTORESTATE) {
     if ((state == I2C_STATE_FREE) && (queueHead != NULL)) {
       state = I2C_STATE_ACTIVE;
-      completionStatus = I2C_STATUS_OK;
-      // Check for pending clock speed change
-      if (pendingClockSpeed) {
-        // We're about to start a new I2C transaction, so set clock now.
-        I2C_setClock(pendingClockSpeed);
-        pendingClockSpeed = 0;
-      }
-      startTime = micros();
       currentRequest = queueHead;
       rxCount = txCount = 0;
-
+      // Copy key fields to static data for speed.
+      operation = currentRequest->operation;
       // Start the I2C process going.
-#if defined(I2C_EXTENDED_ADDRESS)
-      I2CMux muxNumber = currentRequest->i2cAddress.muxNumber();
-      if (muxNumber != I2CMux_None) {
-        muxPhase = MuxPhase_PROLOG;
-        uint8_t subBus = currentRequest->i2cAddress.subBus();
-        muxData[0] = (subBus == SubBus_All) ? 0xff :
-                     (subBus == SubBus_None) ? 0x00 :
-#if defined(I2CMUX_PCA9547)
-                      0x08 | subBus;
-#elif defined(I2CMUX_PCA9542) || defined(I2CMUX_PCA9544)
-                      0x04 | subBus;   // NB Only 2 or 4 subbuses respectively
-#else
-                      // Default behaviour for most MUXs is to use a mask
-                      // with a bit set for the subBus to be enabled
-                      1 << subBus;
-#endif
-        deviceAddress = I2C_MUX_BASE_ADDRESS + muxNumber;
-        sendBuffer = &muxData[0];
-        bytesToSend = 1;
-        bytesToReceive = 0;
-        operation = OPERATION_SEND;
-      } else {
-        // Send/receive payload for device only.
-        muxPhase = MuxPhase_OFF;
-        deviceAddress = currentRequest->i2cAddress;
-        sendBuffer = currentRequest->writeBuffer;
-        bytesToSend = currentRequest->writeLen;
-        receiveBuffer = currentRequest->readBuffer;
-        bytesToReceive = currentRequest->readLen;
-        operation = currentRequest->operation & OPERATION_MASK;
-      } 
-#else
-      deviceAddress = currentRequest->i2cAddress;
-      sendBuffer = currentRequest->writeBuffer;
-      bytesToSend = currentRequest->writeLen;
-      receiveBuffer = currentRequest->readBuffer;
-      bytesToReceive = currentRequest->readLen;
-      operation = currentRequest->operation & OPERATION_MASK;
-#endif
       I2C_sendStart();
+      startTime = micros();
     }
   }
 }
@@ -172,13 +117,10 @@ void I2CManagerClass::startTransaction() {
  *  Function to queue a request block and initiate operations.
  ***************************************************************************/
 void I2CManagerClass::queueRequest(I2CRB *req) {
-
-  if (((req->operation & OPERATION_MASK) == OPERATION_READ) && req->readLen == 0)
-    return;  // Ignore null read
-
   req->status = I2C_STATUS_PENDING;
   req->nextRequest = NULL;
-  ATOMIC_BLOCK() {
+
+  ATOMIC_BLOCK(ATOMIC_RESTORESTATE) {
     if (!queueTail) 
       queueHead = queueTail = req;  // Only item on queue
     else
@@ -188,11 +130,10 @@ void I2CManagerClass::queueRequest(I2CRB *req) {
 
 }
 
-
 /***************************************************************************
  *  Initiate a write to an I2C device (non-blocking operation)
  ***************************************************************************/
-uint8_t I2CManagerClass::write(I2CAddress i2cAddress, const uint8_t *writeBuffer, uint8_t writeLen, I2CRB *req) {
+uint8_t I2CManagerClass::write(uint8_t i2cAddress, const uint8_t *writeBuffer, uint8_t writeLen, I2CRB *req) {
   // Make sure previous request has completed.
   req->wait();
   req->setWriteParams(i2cAddress, writeBuffer, writeLen);
@@ -203,7 +144,7 @@ uint8_t I2CManagerClass::write(I2CAddress i2cAddress, const uint8_t *writeBuffer
 /***************************************************************************
  *  Initiate a write from PROGMEM (flash) to an I2C device (non-blocking operation)
  ***************************************************************************/
-uint8_t I2CManagerClass::write_P(I2CAddress i2cAddress, const uint8_t * writeBuffer, uint8_t writeLen, I2CRB *req) {
+uint8_t I2CManagerClass::write_P(uint8_t i2cAddress, const uint8_t * writeBuffer, uint8_t writeLen, I2CRB *req) {
   // Make sure previous request has completed.
   req->wait();
   req->setWriteParams(i2cAddress, writeBuffer, writeLen);
@@ -216,7 +157,7 @@ uint8_t I2CManagerClass::write_P(I2CAddress i2cAddress, const uint8_t * writeBuf
  *  Initiate a read from the I2C device, optionally preceded by a write 
  *   (non-blocking operation)
  ***************************************************************************/
-uint8_t I2CManagerClass::read(I2CAddress i2cAddress, uint8_t *readBuffer, uint8_t readLen, 
+uint8_t I2CManagerClass::read(uint8_t i2cAddress, uint8_t *readBuffer, uint8_t readLen, 
     const uint8_t *writeBuffer, uint8_t writeLen, I2CRB *req)
 {
   // Make sure previous request has completed.
@@ -226,54 +167,31 @@ uint8_t I2CManagerClass::read(I2CAddress i2cAddress, uint8_t *readBuffer, uint8_
   return I2C_STATUS_OK;
 }
 
-/***************************************************************************
- *  Set I2C timeout value in microseconds.  The timeout applies to the entire
- *   I2CRB request, e.g. where a write+read is performed, the timer is not
- *   reset before the read.
- ***************************************************************************/
-void I2CManagerClass::setTimeout(unsigned long value) { 
-  _timeout = value; 
-};
-
 /***************************************************************************
  * checkForTimeout() function, called from isBusy() and wait() to cancel
- * requests that are taking too long to complete.  Such faults
+ * requests that are taking too long to complete.
+ * This function doesn't fully work as intended so is not currently called.
+ * Instead we check for an I2C hang-up and report an error from
+ * I2CRB::wait(), but we aren't able to recover from the hang-up.  Such faults
  * may be caused by an I2C wire short for example.
  ***************************************************************************/
 void I2CManagerClass::checkForTimeout() {
-  ATOMIC_BLOCK() {
+  unsigned long currentMicros = micros();
+  ATOMIC_BLOCK(ATOMIC_RESTORESTATE) {
     I2CRB *t = queueHead;
-    if (state==I2C_STATE_ACTIVE && t!=0 && t==currentRequest && _timeout > 0) {
+    if (state==I2C_STATE_ACTIVE && t!=0 && t==currentRequest && timeout > 0) {
       // Check for timeout
-      int32_t elapsed = micros() - startTime;
-      if (elapsed > (int32_t)_timeout) { 
-#ifdef DIAG_IO
-        //DIAG(F("I2CManager Timeout on %s"), t->i2cAddress.toString());
-#endif
+      if (currentMicros - startTime > timeout) { 
         // Excessive time. Dequeue request
         queueHead = t->nextRequest;
         if (!queueHead) queueTail = NULL;
         currentRequest = NULL;
-        bytesToReceive = bytesToSend = 0;
         // Post request as timed out.
         t->status = I2C_STATUS_TIMEOUT;
         // Reset TWI interface so it is able to continue
         // Try close and init, not entirely satisfactory but sort of works...
         I2C_close();  // Shutdown and restart twi interface
-
-        // If SDA is stuck low, issue up to 9 clock pulses to attempt to free it.
-        pinMode(SCL, INPUT_PULLUP);
-        pinMode(SDA, INPUT_PULLUP);
-        for (int i=0; !digitalRead(SDA) && i<9; i++) {
-          digitalWrite(SCL, 0); 
-          pinMode(SCL, OUTPUT);         // Force clock low
-          delayMicroseconds(10);        // ... for 5us
-          pinMode(SCL, INPUT_PULLUP);   // ... then high
-          delayMicroseconds(10);        // ... for 5us (100kHz Clock)
-        }
-        // Whether that's succeeded or not, now try reinitialising.
         I2C_init();
-        _setClock(_clockSpeed);
         state = I2C_STATE_FREE;
         
         // Initiate next queued request if any.
@@ -290,8 +208,10 @@ void I2CManagerClass::loop() {
 #if !defined(I2C_USE_INTERRUPTS)
   handleInterrupt();
 #endif
-  // Call function to monitor for stuck I2C operations.
-  checkForTimeout();
+  // Timeout is now reported in I2CRB::wait(), not here.
+  // I've left the code, commented out, as a reminder to look at this again
+  // in the future.
+  //checkForTimeout();
 }
 
 /***************************************************************************
@@ -303,85 +223,43 @@ void I2CManagerClass::handleInterrupt() {
   // Update hardware state machine
   I2C_handleInterrupt();
 
+  // Enable interrupts to minimise effect on other interrupt code
+  interrupts();
+
   // Check if current request has completed.  If there's a current request
   // and state isn't active then state contains the completion status of the request.
-  if (state == I2C_STATE_COMPLETED && currentRequest != NULL && currentRequest == queueHead) {
-    // Operation has completed.
-    if (completionStatus == I2C_STATUS_OK || ++retryCounter > MAX_I2C_RETRIES
-      || currentRequest->operation & OPERATION_NORETRY) 
-    {
-      // Status is OK, or has failed and retry count exceeded, or failed and retries disabled.
-#if defined(I2C_EXTENDED_ADDRESS)
-      if (muxPhase == MuxPhase_PROLOG ) {
-        overallStatus = completionStatus;
-        uint8_t rbAddress = currentRequest->i2cAddress.deviceAddress();
-        if (completionStatus == I2C_STATUS_OK && rbAddress != 0) {
-          // Mux request OK, start handling application request.
-          muxPhase = MuxPhase_PAYLOAD;
-          deviceAddress = rbAddress;
-          sendBuffer = currentRequest->writeBuffer;
-          bytesToSend = currentRequest->writeLen;
-          receiveBuffer = currentRequest->readBuffer;
-          bytesToReceive = currentRequest->readLen;
-          operation = currentRequest->operation & OPERATION_MASK;
-          state = I2C_STATE_ACTIVE;
-          I2C_sendStart();
-          return;
-        } 
-      } else if (muxPhase == MuxPhase_PAYLOAD) {
-        // Application request completed, now send epilogue to mux
-        overallStatus = completionStatus;
-        currentRequest->nBytes = rxCount;  // Save number of bytes read into rb
-        if (_muxCount == 1) {
-          // Only one MUX, don't need to deselect subbus
-          muxPhase = MuxPhase_OFF;
-        } else {
-          muxPhase = MuxPhase_EPILOG;
-          deviceAddress = I2C_MUX_BASE_ADDRESS + currentRequest->i2cAddress.muxNumber();
-          muxData[0] = 0x00;
-          sendBuffer = &muxData[0];
-          bytesToSend = 1;
-          bytesToReceive = 0;
-          operation = OPERATION_SEND;
-          state = I2C_STATE_ACTIVE;
-          I2C_sendStart();
-          return;
-        }
-      } else if (muxPhase == MuxPhase_EPILOG) {
-        // Epilog finished, ignore completionStatus
-        muxPhase = MuxPhase_OFF;
-      } else
-        overallStatus = completionStatus;
-#else
-      overallStatus = completionStatus;
-      currentRequest->nBytes = rxCount;
-#endif
-          
-      // Remove completed request from head of queue
+  if (state != I2C_STATE_ACTIVE && currentRequest != NULL) {
+    // Remove completed request from head of queue
+    ATOMIC_BLOCK(ATOMIC_RESTORESTATE) {
       I2CRB * t = queueHead;
-      if (t == currentRequest) {
+      if (t == queueHead) {
         queueHead = t->nextRequest;
         if (!queueHead) queueTail = queueHead;
-        t->status = overallStatus;
+        t->nBytes = rxCount;
+        t->status = state;
         
         // I2C state machine is now free for next request
         currentRequest = NULL;
         state = I2C_STATE_FREE;
-      }
-      retryCounter = 0;
-    } else {
-      // Status is failed and retry permitted.
-      // Retry previous request.
-      state = I2C_STATE_FREE;  
-    }
-  }
 
-  if (state == I2C_STATE_FREE && queueHead != NULL) {
-    // Allow any pending interrupts before starting the next request.
-    //interrupts();
-    // Start next request
-    I2CManager.startTransaction();
+        // Start next request (if any)
+        I2CManager.startTransaction();
+      }
+    }
   }
 }
 
+// Fields in I2CManager class specific to Non-blocking implementation.
+I2CRB * volatile I2CManagerClass::queueHead = NULL;
+I2CRB * volatile I2CManagerClass::queueTail = NULL;
+I2CRB * volatile I2CManagerClass::currentRequest = NULL;
+volatile uint8_t I2CManagerClass::state = I2C_STATE_FREE;
+volatile uint8_t I2CManagerClass::txCount;
+volatile uint8_t I2CManagerClass::rxCount;
+volatile uint8_t I2CManagerClass::operation;
+volatile uint8_t I2CManagerClass::bytesToSend;
+volatile uint8_t I2CManagerClass::bytesToReceive;
+volatile unsigned long I2CManagerClass::startTime;
+unsigned long I2CManagerClass::timeout = 0;
+
 #endif

I2CManager_SAMD.h

@@ -1,6 +1,6 @@
 /*
  *  © 2022 Paul M Antoine
- *  © 2023, Neil McKechnie
+ *  © 2021, Neil McKechnie
  *  All rights reserved.
  *
  *  This file is part of CommandStation-EX
@@ -38,7 +38,7 @@
  ***************************************************************************/
 #if defined(I2C_USE_INTERRUPTS) && defined(ARDUINO_SAMD_ZERO)
 void SERCOM3_Handler() {
-  I2CManager.handleInterrupt();
+  I2CManagerClass::handleInterrupt();
 }
 #endif
 
@@ -46,16 +46,14 @@ void SERCOM3_Handler() {
 Sercom *s = SERCOM3;
 
 /***************************************************************************
- *  Set I2C clock speed register.  This should only be called outside of
- *  a transmission.  The I2CManagerClass::_setClock() function ensures 
- *  that it is only called at the beginning of an I2C transaction.
+ *  Set I2C clock speed register.
  ***************************************************************************/
 void I2CManagerClass::I2C_setClock(uint32_t i2cClockSpeed) {
 
   // Calculate a rise time appropriate to the requested bus speed
   int t_rise;
   if (i2cClockSpeed < 200000L) {
-    i2cClockSpeed = 100000L;    // NB: this overrides a "force clock" of lower than 100KHz!
+    i2cClockSpeed = 100000L;
     t_rise = 1000;
   } else if (i2cClockSpeed < 800000L) {
     i2cClockSpeed = 400000L;
@@ -68,9 +66,6 @@ void I2CManagerClass::I2C_setClock(uint32_t i2cClockSpeed) {
     t_rise = 1000;
   }
 
-  // Wait while the bus is busy
-  while (s->I2CM.STATUS.bit.BUSSTATE != 0x1);
-
   // Disable the I2C master mode and wait for sync
   s->I2CM.CTRLA.bit.ENABLE = 0 ;
   while (s->I2CM.SYNCBUSY.bit.ENABLE != 0);
@@ -85,6 +80,8 @@ void I2CManagerClass::I2C_setClock(uint32_t i2cClockSpeed) {
   // Setting bus idle mode and wait for sync
   s->I2CM.STATUS.bit.BUSSTATE = 1 ;
   while (s->I2CM.SYNCBUSY.bit.SYSOP != 0);
+
+  return;
 }
 
 /***************************************************************************
@@ -110,8 +107,8 @@ void I2CManagerClass::I2C_init()
   s->I2CM.CTRLA.reg =  SERCOM_I2CM_CTRLA_MODE( I2C_MASTER_OPERATION )/* |
                             SERCOM_I2CM_CTRLA_SCLSM*/ ;
 
-  // Enable Smart mode (but not Quick Command)
-  s->I2CM.CTRLB.reg =  SERCOM_I2CM_CTRLB_SMEN;
+  // Enable Smart mode and Quick Command
+  s->I2CM.CTRLB.reg =  SERCOM_I2CM_CTRLB_SMEN | SERCOM_I2CM_CTRLB_QCEN;
 
 #if defined(I2C_USE_INTERRUPTS)
   // Setting NVIC
@@ -144,33 +141,30 @@ void I2CManagerClass::I2C_init()
 	PORT->Group[g_APinDescription[PIN_WIRE_SCL].ulPort].PINCFG[g_APinDescription[PIN_WIRE_SCL].ulPin].reg =  
 		PORT_PINCFG_DRVSTR | PORT_PINCFG_PULLEN | PORT_PINCFG_PMUXEN;  
   PORT->Group[g_APinDescription[PIN_WIRE_SDA].ulPort].PINCFG[g_APinDescription[PIN_WIRE_SDA].ulPin].reg = 
-	  PORT_PINCFG_DRVSTR | PORT_PINCFG_PULLEN | PORT_PINCFG_PMUXEN;
+		PORT_PINCFG_DRVSTR | PORT_PINCFG_PULLEN | PORT_PINCFG_PMUXEN;
 }
 
 /***************************************************************************
  *  Initiate a start bit for transmission.
  ***************************************************************************/
 void I2CManagerClass::I2C_sendStart() {
+  bytesToSend = currentRequest->writeLen;
+  bytesToReceive = currentRequest->readLen;
 
-  // Set counters here in case this is a retry.
-  txCount = 0;
-  rxCount = 0;
-
-  // On a single-master I2C bus, the start bit won't be sent until the bus 
-  // state goes to IDLE so we can request it without waiting.  On a 
-  // multi-master bus, the bus may be BUSY under control of another master, 
-  // in which case we can avoid some arbitration failures by waiting until
-  // the bus state is IDLE.  We don't do that here.
+  // We may have initiated a stop bit before this without waiting for it.
+  // Wait for stop bit to be sent before sending start.
+  while (s->I2CM.STATUS.bit.BUSSTATE == 0x2);
 
   // If anything to send, initiate write.  Otherwise initiate read.
   if (operation == OPERATION_READ || ((operation == OPERATION_REQUEST) && !bytesToSend))
   {
-    // Send start and address with read flag (1) or'd in
-    s->I2CM.ADDR.bit.ADDR = (deviceAddress << 1) | 1;
+    // Send start and address with read/write flag or'd in
+    s->I2CM.ADDR.bit.ADDR = (currentRequest->i2cAddress << 1) | 1;
   }
   else {
-    // Send start and address with write flag (0) or'd in
-    s->I2CM.ADDR.bit.ADDR = (deviceAddress << 1ul) | 0;
+    // Wait while the I2C bus is BUSY
+    while (s->I2CM.STATUS.bit.BUSSTATE != 0x1);
+    s->I2CM.ADDR.bit.ADDR = (currentRequest->i2cAddress << 1ul) | 0;
   }
 }
 
@@ -186,13 +180,6 @@ void I2CManagerClass::I2C_sendStop() {
  ***************************************************************************/
 void I2CManagerClass::I2C_close() {
   I2C_sendStop();
-  // Disable the I2C master mode and wait for sync
-  s->I2CM.CTRLA.bit.ENABLE = 0 ;
-  // Wait for up to 500us only.
-  unsigned long startTime = micros();
-  while (s->I2CM.SYNCBUSY.bit.ENABLE != 0) {
-    if (micros() - startTime >= 500UL) break;
-  }
 }
 
 /***************************************************************************
@@ -207,39 +194,49 @@ void I2CManagerClass::I2C_handleInterrupt() {
     I2C_sendStart();   // Reinitiate request
   } else if (s->I2CM.STATUS.bit.BUSERR) {
     // Bus error
-    completionStatus = I2C_STATUS_BUS_ERROR;
-    state = I2C_STATE_COMPLETED;  // Completed with error
+    state = I2C_STATUS_BUS_ERROR;
   } else if (s->I2CM.INTFLAG.bit.MB) {
     // Master write completed
     if (s->I2CM.STATUS.bit.RXNACK) {
       // Nacked, send stop.
       I2C_sendStop();
-      completionStatus = I2C_STATUS_NEGATIVE_ACKNOWLEDGE;
-      state = I2C_STATE_COMPLETED;  // Completed with error
+      state = I2C_STATUS_NEGATIVE_ACKNOWLEDGE;
     } else if (bytesToSend) {
       // Acked, so send next byte
-      s->I2CM.DATA.bit.DATA = sendBuffer[txCount++];
+      if (currentRequest->operation == OPERATION_SEND_P)
+        s->I2CM.DATA.bit.DATA = GETFLASH(currentRequest->writeBuffer + (txCount++));
+      else
+        s->I2CM.DATA.bit.DATA = currentRequest->writeBuffer[txCount++];
       bytesToSend--;
     } else if (bytesToReceive) {
       // Last sent byte acked and no more to send.  Send repeated start, address and read bit.
-      s->I2CM.ADDR.bit.ADDR = (deviceAddress << 1) | 1;
+        s->I2CM.ADDR.bit.ADDR = (currentRequest->i2cAddress << 1) | 1;
     } else {
-      // No more data to send/receive. Initiate a STOP condition
+      // No more data to send/receive. Initiate a STOP condition.
       I2C_sendStop();
-      state = I2C_STATE_COMPLETED;  // Completed OK
+      state = I2C_STATUS_OK; // Done
     }
   } else if (s->I2CM.INTFLAG.bit.SB) {
     // Master read completed without errors
-    if (bytesToReceive == 1) {
-      s->I2CM.CTRLB.bit.ACKACT = 1;  // NAK final byte
-      I2C_sendStop();  // send stop
-      receiveBuffer[rxCount++] = s->I2CM.DATA.bit.DATA;  // Store received byte
-      bytesToReceive = 0;
-      state = I2C_STATE_COMPLETED;  // Completed OK
-    } else if (bytesToReceive) {
-      s->I2CM.CTRLB.bit.ACKACT = 0;  // ACK all but final byte
-      receiveBuffer[rxCount++] = s->I2CM.DATA.bit.DATA;  // Store received byte
+    if (bytesToReceive) {
+      currentRequest->readBuffer[rxCount++] = s->I2CM.DATA.bit.DATA;  // Store received byte
       bytesToReceive--;
+    } else { 
+      // Buffer full, issue nack/stop
+      s->I2CM.CTRLB.bit.ACKACT = 1;
+      I2C_sendStop();
+      state = I2C_STATUS_OK;
+    }
+    if (bytesToReceive) {
+      // PMA - I think Smart Mode means we have nothing to do...
+      // More bytes to receive, issue ack and start another read
+    }
+    else
+    {
+      // Transaction finished, issue NACK and STOP.
+      s->I2CM.CTRLB.bit.ACKACT = 1;
+      I2C_sendStop();
+      state = I2C_STATUS_OK;
     }
   }
 }

I2CManager_STM32.h

@@ -1,519 +0,0 @@
-/*
- *  © 2022-23 Paul M Antoine
- *  © 2023, Neil McKechnie
- *  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/>.
- */
-
-#ifndef I2CMANAGER_STM32_H
-#define I2CMANAGER_STM32_H
-
-#include <Arduino.h>
-#include "I2CManager.h"
-#include "I2CManager_NonBlocking.h"   // to satisfy intellisense
-
-#include <wiring_private.h>
-#include "stm32f4xx_hal_rcc.h"
-
-/*****************************************************************************
- *  STM32F4xx I2C native driver support
- * 
- *  Nucleo-64 and Nucleo-144 boards all use I2C1 as the default I2C peripheral
- *  Later we may wish to support other STM32 boards, allow use of an alternate
- *  I2C bus, or more than one I2C bus on the STM32 architecture 
- *****************************************************************************/
-#if defined(I2C_USE_INTERRUPTS) && defined(ARDUINO_ARCH_STM32)
-#if defined(ARDUINO_NUCLEO_F401RE) || defined(ARDUINO_NUCLEO_F411RE) || defined(ARDUINO_NUCLEO_F446RE) \
-    || defined(ARDUINO_NUCLEO_F412ZG) || defined(ARDUINO_NUCLEO_F413ZH) \
-    || defined(ARDUINO_NUCLEO_F429ZI) || defined(ARDUINO_NUCLEO_F446ZE)
-// Assume I2C1 for now - default I2C bus on Nucleo-F411RE and likely all Nucleo-64
-// and Nucleo-144 variants
-I2C_TypeDef *s = I2C1;
-
-// In init we will ask the STM32 HAL layer for the configured APB1 clock frequency in Hz
-uint32_t APB1clk1; // Peripheral Input Clock speed in Hz.
-uint32_t i2c_MHz;  // Peripheral Input Clock speed in MHz.
-
-// IRQ handler for I2C1, replacing the weak definition in the STM32 HAL 
-extern "C" void I2C1_EV_IRQHandler(void) {
-  I2CManager.handleInterrupt();
-}
-extern "C" void I2C1_ER_IRQHandler(void) {
-  I2CManager.handleInterrupt();
-}
-#else
-#warning STM32 board selected is not yet supported - so I2C1 peripheral is not defined
-#endif
-#endif
-
-// Peripheral Input Clock speed in MHz.
-// For STM32F446RE, the speed is 45MHz.  Ideally, this should be determined
-// at run-time from the APB1 clock, as it can vary from STM32 family to family.
-// #define I2C_PERIPH_CLK 45
-
-// I2C SR1 Status Register #1 bit definitions for convenience
-// #define I2C_SR1_SMBALERT  (1<<15)   // SMBus alert
-// #define I2C_SR1_TIMEOUT   (1<<14)   // Timeout of Tlow error
-// #define I2C_SR1_PECERR    (1<<12)   // PEC error in reception
-// #define I2C_SR1_OVR       (1<<11)   // Overrun/Underrun error
-// #define I2C_SR1_AF        (1<<10)   // Acknowledge failure
-// #define I2C_SR1_ARLO      (1<<9)    // Arbitration lost (master mode)
-// #define I2C_SR1_BERR      (1<<8)    // Bus error (misplaced start or stop condition)
-// #define I2C_SR1_TxE       (1<<7)    // Data register empty on transmit
-// #define I2C_SR1_RxNE      (1<<6)    // Data register not empty on receive
-// #define I2C_SR1_STOPF     (1<<4)    // Stop detection (slave mode)
-// #define I2C_SR1_ADD10     (1<<3)    // 10 bit header sent
-// #define I2C_SR1_BTF       (1<<2)    // Byte transfer finished - data transfer done
-// #define I2C_SR1_ADDR      (1<<1)    // Address sent (master) or matched (slave)
-// #define I2C_SR1_SB        (1<<0)    // Start bit (master mode) 1=start condition generated
-
-// I2C CR1 Control Register #1 bit definitions for convenience
-// #define I2C_CR1_SWRST     (1<<15)   // Software reset - places peripheral under reset
-// #define I2C_CR1_ALERT     (1<<13)   // SMBus alert assertion
-// #define I2C_CR1_PEC       (1<<12)   // Packet Error Checking transfer in progress
-// #define I2C_CR1_POS       (1<<11)   // Acknowledge/PEC Postion (for data reception in PEC mode)
-// #define I2C_CR1_ACK       (1<<10)   // Acknowledge enable - ACK returned after byte is received (address or data)
-// #define I2C_CR1_STOP      (1<<9)    // STOP generated
-// #define I2C_CR1_START     (1<<8)    // START generated
-// #define I2C_CR1_NOSTRETCH (1<<7)    // Clock stretching disable (slave mode)
-// #define I2C_CR1_ENGC      (1<<6)    // General call (broadcast) enable (address 00h is ACKed)
-// #define I2C_CR1_ENPEC     (1<<5)    // PEC Enable
-// #define I2C_CR1_ENARP     (1<<4)    // ARP enable (SMBus)
-// #define I2C_CR1_SMBTYPE   (1<<3)    // SMBus type, 1=host, 0=device
-// #define I2C_CR1_SMBUS     (1<<1)    // SMBus mode, 1=SMBus, 0=I2C
-// #define I2C_CR1_PE        (1<<0)    // I2C Peripheral enable
-
-// States of the STM32 I2C driver state machine
-enum {TS_IDLE,TS_START,TS_W_ADDR,TS_W_DATA,TS_W_STOP,TS_R_ADDR,TS_R_DATA,TS_R_STOP};
-
-
-/***************************************************************************
- *  Set I2C clock speed register.  This should only be called outside of
- *  a transmission.  The I2CManagerClass::_setClock() function ensures 
- *  that it is only called at the beginning of an I2C transaction.
- ***************************************************************************/
-void I2CManagerClass::I2C_setClock(uint32_t i2cClockSpeed) {
-  // Calculate a rise time appropriate to the requested bus speed
-  // Use 10x the rise time spec to enable integer divide of 50ns clock period
-  uint16_t t_rise;
-
-  while (s->CR1 & I2C_CR1_STOP);  // Prevents lockup by guarding further
-                                  // writes to CR1 while STOP is being executed!
-
-  // Disable the I2C device, as TRISE can only be programmed whilst disabled
-  s->CR1 &= ~(I2C_CR1_PE);  // Disable I2C
-  s->CR1 |= I2C_CR1_SWRST;  // reset the I2C
-  asm("nop");    // wait a bit... suggestion from online!
-  s->CR1 &= ~(I2C_CR1_SWRST); // Normal operation
-
-  if (i2cClockSpeed > 100000UL)
-  {
-    // if (i2cClockSpeed > 400000L)
-    //   i2cClockSpeed = 400000L;
-
-    t_rise = 300;  // nanoseconds
-  }
-  else
-  {
-    // i2cClockSpeed = 100000L;
-    t_rise = 1000;  // nanoseconds
-  }
-  // Configure the rise time register - max allowed tRISE is 1000ns,
-  // so value = 1000ns * I2C_PERIPH_CLK MHz / 1000 + 1.
-  s->TRISE = (t_rise * i2c_MHz / 1000) + 1;
-
-  // Bit 15: I2C Master mode, 0=standard, 1=Fast Mode
-  // Bit 14: Duty, fast mode duty cycle (use 2:1)
-  // Bit 11-0: FREQR
-  // if (i2cClockSpeed > 400000UL) {
-  //   // In fast mode plus, I2C period is 3 * CCR * TPCLK1.
-  //   // s->CCR &= ~(0x3000); // Clear all bits except 12 and 13 which must remain per reset value
-  //   s->CCR = APB1clk1 / 3 / i2cClockSpeed; // Set I2C clockspeed to start!
-  //   s->CCR |= 0xC000; // We need Fast Mode AND DUTY bits set
-  // } else {
-    // In standard and fast mode, I2C period is 2 * CCR * TPCLK1
-    s->CCR &= ~(0x3000); // Clear all bits except 12 and 13 which must remain per reset value
-    s->CCR |= (APB1clk1 / 2 / i2cClockSpeed); // Set I2C clockspeed to start!
-    // s->CCR |= (i2c_MHz * 500 / (i2cClockSpeed / 1000)); // Set I2C clockspeed to start!
-    // if (i2cClockSpeed > 100000UL)
-    //     s->CCR |= 0xC000; // We need Fast Mode bits set as well
-  // }
-
-  // DIAG(F("I2C_init() peripheral clock is now: %d, full reg is %x"), (s->CR2 & 0xFF), s->CR2);
-  // DIAG(F("I2C_init() peripheral CCR is now: %d"), s->CCR);
-  // DIAG(F("I2C_init() peripheral TRISE is now: %d"), s->TRISE);
-
-  // Enable the I2C master mode
-  s->CR1 |= I2C_CR1_PE;  // Enable I2C
-}
-
-/***************************************************************************
- *  Initialise I2C registers.
- ***************************************************************************/
-void I2CManagerClass::I2C_init()
-{
-  // Query the clockspeed from the STM32 HAL layer
-  APB1clk1 = HAL_RCC_GetPCLK1Freq();
-  i2c_MHz = APB1clk1 / 1000000UL;
-  // DIAG(F("I2C_init() peripheral clock speed is: %d"), i2c_MHz);
-  // Enable clocks
-  RCC->APB1ENR |= RCC_APB1ENR_I2C1EN;//(1 << 21); // Enable I2C CLOCK
-  // Reset the I2C1 peripheral to initial state
-  RCC->APB1RSTR |=  RCC_APB1RSTR_I2C1RST;
-	RCC->APB1RSTR &= ~RCC_APB1RSTR_I2C1RST;
-  // Standard I2C pins are SCL on PB8 and SDA on PB9
-  RCC->AHB1ENR |= (1<<1);   // Enable GPIOB CLOCK for PB8/PB9
-  // Bits (17:16)= 1:0 --> Alternate Function for Pin PB8;
-  // Bits (19:18)= 1:0 --> Alternate Function for Pin PB9
-  GPIOB->MODER &= ~((3<<(8*2)) | (3<<(9*2)));    // Clear all MODER bits for PB8 and PB9
-  GPIOB->MODER |= (2<<(8*2)) | (2<<(9*2));    // PB8 and PB9 set to ALT function
-  GPIOB->OTYPER |= (1<<8) | (1<<9);           // PB8 and PB9 set to open drain output capability
-  GPIOB->OSPEEDR |= (3<<(8*2)) | (3<<(9*2));  // PB8 and PB9 set to High Speed mode
-  GPIOB->PUPDR &= ~((3<<(8*2)) | (3<<(9*2))); // Clear all PUPDR bits for PB8 and PB9
-  GPIOB->PUPDR |= (1<<(8*2)) | (1<<(9*2));    // PB8 and PB9 set to pull-up capability
-  // Alt Function High register routing pins PB8 and PB9 for I2C1:
-  // Bits (3:2:1:0) = 0:1:0:0 --> AF4 for pin PB8
-  // Bits (7:6:5:4) = 0:1:0:0 --> AF4 for pin PB9
-  GPIOB->AFR[1] &= ~((15<<0) | (15<<4));      // Clear all AFR bits for PB8 on low nibble, PB9 on next nibble up
-  GPIOB->AFR[1] |= (4<<0) | (4<<4);           // PB8 on low nibble, PB9 on next nibble up
-
-  // Software reset the I2C peripheral
-  I2C1->CR1 &= ~I2C_CR1_PE; // Disable I2C1 peripheral
-  s->CR1 |= I2C_CR1_SWRST;  // reset the I2C
-  asm("nop");    // wait a bit... suggestion from online!
-  s->CR1 &= ~(I2C_CR1_SWRST); // Normal operation
-
-  // Clear all bits in I2C CR2 register except reserved bits
-  s->CR2 &= 0xE000;
-
-  // Set I2C peripheral clock frequency
-  // s->CR2 |= I2C_PERIPH_CLK;
-  s->CR2 |= i2c_MHz;
-  // DIAG(F("I2C_init() peripheral clock is now: %d"), s->CR2);
-
-  // set own address to 00 - not used in master mode
-  I2C1->OAR1 = (1 << 14); // bit 14 should be kept at 1 according to the datasheet
-
-#if defined(I2C_USE_INTERRUPTS)
-  // Setting NVIC
-  NVIC_SetPriority(I2C1_EV_IRQn, 1);  // Match default priorities
-  NVIC_EnableIRQ(I2C1_EV_IRQn);
-  NVIC_SetPriority(I2C1_ER_IRQn, 1);  // Match default priorities
-  NVIC_EnableIRQ(I2C1_ER_IRQn);
-
-  // CR2 Interrupt Settings
-  // Bit 15-13: reserved
-  // Bit 12: LAST - DMA last transfer
-  // Bit 11: DMAEN - DMA enable
-  // Bit 10: ITBUFEN - Buffer interrupt enable
-  // Bit 9: ITEVTEN - Event interrupt enable
-  // Bit 8: ITERREN - Error interrupt enable
-  // Bit 7-6: reserved
-  // Bit 5-0: FREQ - Peripheral clock frequency (max 50MHz)
-  s->CR2 |= (I2C_CR2_ITBUFEN | I2C_CR2_ITEVTEN | I2C_CR2_ITERREN);   // Enable Buffer, Event and Error interrupts
-#endif
-
-  // DIAG(F("I2C_init() setting initial I2C clock to 100KHz"));
-  // Calculate baudrate and set default rate for now
-  // Configure the Clock Control Register for 100KHz SCL frequency
-  // Bit 15: I2C Master mode, 0=standard, 1=Fast Mode
-  // Bit 14: Duty, fast mode duty cycle
-  // Bit 11-0: so CCR divisor would be clk / 2 / 100000 (where clk is in Hz)
-  // s->CCR = I2C_PERIPH_CLK * 5;
-  s->CCR &= ~(0x3000); // Clear all bits except 12 and 13 which must remain per reset value
-  s->CCR |= (APB1clk1 / 2 / 100000UL); // Set a default of 100KHz I2C clockspeed to start!
-
-  // Configure the rise time register - max allowed is 1000ns, so value = 1000ns * I2C_PERIPH_CLK MHz / 1000 + 1.
-  s->TRISE = (1000 * i2c_MHz / 1000) + 1;
-
-  // DIAG(F("I2C_init() peripheral clock is now: %d, full reg is %x"), (s->CR2 & 0xFF), s->CR2);
-  // DIAG(F("I2C_init() peripheral CCR is now: %d"), s->CCR);
-  // DIAG(F("I2C_init() peripheral TRISE is now: %d"), s->TRISE);
-
-  // Enable the I2C master mode
-  s->CR1 |= I2C_CR1_PE;  // Enable I2C
-}
-
-/***************************************************************************
- *  Initiate a start bit for transmission.
- ***************************************************************************/
-void I2CManagerClass::I2C_sendStart() {
-
-  // Set counters here in case this is a retry.
-  rxCount = txCount = 0;
-
-  // On a single-master I2C bus, the start bit won't be sent until the bus
-  // state goes to IDLE so we can request it without waiting.  On a
-  // multi-master bus, the bus may be BUSY under control of another master,
-  // in which case we can avoid some arbitration failures by waiting until
-  // the bus state is IDLE.  We don't do that here.
-  //while (s->SR2 & I2C_SR2_BUSY) {}
-
-  // Check there's no STOP still in progress.  If we OR the START bit into CR1
-  // and the STOP bit is already set, we could output multiple STOP conditions.
-  while (s->CR1 & I2C_CR1_STOP) {}  // Wait for STOP bit to reset
-
-  s->CR2 |= (I2C_CR2_ITEVTEN | I2C_CR2_ITERREN);  // Enable interrupts
-  s->CR2 &= ~I2C_CR2_ITBUFEN;     // Don't enable buffer interupts yet.
-  s->CR1 &= ~I2C_CR1_POS;   // Clear the POS bit
-  s->CR1 |= (I2C_CR1_ACK | I2C_CR1_START);   // Enable the ACK and generate START
-  transactionState = TS_START;
-}
-
-/***************************************************************************
- *  Initiate a stop bit for transmission (does not interrupt)
- ***************************************************************************/
-void I2CManagerClass::I2C_sendStop() {
-  s->CR1 |= I2C_CR1_STOP; // Stop I2C
-}
-
-/***************************************************************************
- *  Close I2C down
- ***************************************************************************/
-void I2CManagerClass::I2C_close() {
-  I2C_sendStop();
-  // Disable the I2C master mode and wait for sync
-  s->CR1 &= ~I2C_CR1_PE;  // Disable I2C peripheral
-  // Should never happen, but wait for up to 500us only.
-  unsigned long startTime = micros();
-  while ((s->CR1 & I2C_CR1_PE) != 0) {
-    if ((int32_t)(micros() - startTime) >= 500) break;
-  }
-  NVIC_DisableIRQ(I2C1_EV_IRQn);
-  NVIC_DisableIRQ(I2C1_ER_IRQn);
-}
-
-/***************************************************************************
- *  Main state machine for I2C, called from interrupt handler or,
- *  if I2C_USE_INTERRUPTS isn't defined, from the I2CManagerClass::loop() function
- *  (and therefore, indirectly, from I2CRB::wait() and I2CRB::isBusy()).
- ***************************************************************************/
-void I2CManagerClass::I2C_handleInterrupt() {
-  volatile uint16_t temp_sr1, temp_sr2;
-
-  temp_sr1 = s->SR1;
-
-  // Check for errors first
-  if (temp_sr1 & (I2C_SR1_AF | I2C_SR1_ARLO | I2C_SR1_BERR)) {
-    // Check which error flag is set
-    if (temp_sr1 & I2C_SR1_AF)
-    {
-      s->SR1 &= ~(I2C_SR1_AF); // Clear AF
-      I2C_sendStop(); // Clear the bus
-      transactionState = TS_IDLE;
-      completionStatus = I2C_STATUS_NEGATIVE_ACKNOWLEDGE;
-      state = I2C_STATE_COMPLETED;
-    }
-    else if (temp_sr1 & I2C_SR1_ARLO)
-    {
-      // Arbitration lost, restart
-      s->SR1 &= ~(I2C_SR1_ARLO); // Clear ARLO
-      I2C_sendStart(); // Reinitiate request
-      transactionState = TS_START;
-    }
-    else if (temp_sr1 & I2C_SR1_BERR)
-    {
-      // Bus error
-      s->SR1 &= ~(I2C_SR1_BERR); // Clear BERR
-      I2C_sendStop(); // Clear the bus
-      transactionState = TS_IDLE;
-      completionStatus = I2C_STATUS_BUS_ERROR;
-      state = I2C_STATE_COMPLETED;
-    }
-  } 
-  else {
-    // No error flags, so process event according to current state.
-    switch (transactionState) {
-      case TS_START:
-        if (temp_sr1 & I2C_SR1_SB) {
-          // Event EV5
-          // Start bit has been sent successfully and we have the bus.
-          // If anything to send, initiate write.  Otherwise initiate read.
-          if (operation == OPERATION_READ || ((operation == OPERATION_REQUEST) && !bytesToSend)) {
-            // Send address with read flag (1) or'd in
-            s->DR = (deviceAddress << 1) | 1;  //  send the address
-            transactionState = TS_R_ADDR;
-          } else {
-            // Send address with write flag (0) or'd in
-            s->DR = (deviceAddress << 1) | 0;  //  send the address
-            transactionState = TS_W_ADDR;
-          }
-        }
-        // SB bit is cleared by writing to DR (already done).
-        break;
-
-      case TS_W_ADDR:
-        if (temp_sr1 & I2C_SR1_ADDR) {
-          temp_sr2 = s->SR2; // read SR2 to complete clearing the ADDR bit
-          // Event EV6
-          // Address sent successfully, device has ack'd in response.
-          if (!bytesToSend) {
-            I2C_sendStop();
-            transactionState = TS_IDLE;
-            completionStatus = I2C_STATUS_OK;
-            state = I2C_STATE_COMPLETED;
-          } else {
-            // Put one byte into DR to load shift register.
-            s->DR = sendBuffer[txCount++];
-            bytesToSend--;
-            if (bytesToSend) {
-              // Put another byte to load DR
-              s->DR = sendBuffer[txCount++];
-              bytesToSend--;
-            }
-            if (!bytesToSend) {
-              // No more bytes to send.
-              // The TXE interrupt occurs when the DR is empty, and the BTF interrupt 
-              // occurs when the shift register is also empty (one character later).
-              // To avoid repeated TXE interrupts during this time, we disable TXE interrupt.
-              s->CR2 &= ~I2C_CR2_ITBUFEN;  // Wait for BTF interrupt, disable TXE interrupt
-              transactionState = TS_W_STOP;
-            } else {
-              // More data remaining to send after this interrupt, enable TXE interrupt.
-              s->CR2 |= I2C_CR2_ITBUFEN;
-              transactionState = TS_W_DATA;
-            }
-          }
-        }
-        break;
-
-      case TS_W_DATA:
-        if (temp_sr1 & I2C_SR1_TXE) {
-          // Event EV8_1/EV8
-          // Transmitter empty, write a byte to it.
-          if (bytesToSend) {
-            s->DR = sendBuffer[txCount++];
-            bytesToSend--;
-            if (!bytesToSend) {
-              s->CR2 &= ~I2C_CR2_ITBUFEN;  // Disable TXE interrupt
-              transactionState = TS_W_STOP;
-            }
-          }
-        } 
-        break;
-
-      case TS_W_STOP:
-        if (temp_sr1 & I2C_SR1_BTF) {
-          // Event EV8_2
-          // Done, last character sent. Anything to receive?
-          if (bytesToReceive) {
-            I2C_sendStart();
-            // NOTE: Three redundant BTF interrupts take place between the
-            // first BTF interrupt and the START interrupt.  I've tried all sorts
-            // of ways to eliminate them, and the only thing that worked for
-            // me was to loop until the BTF bit becomes reset.  Either way,
-            // it's a waste of processor time.  Anyone got a solution?
-            //while (s->SR1 && I2C_SR1_BTF) {}
-            transactionState = TS_START;
-          } else {
-            I2C_sendStop();
-            transactionState = TS_IDLE;
-            completionStatus = I2C_STATUS_OK;
-            state = I2C_STATE_COMPLETED;
-          }
-          s->SR1 &= I2C_SR1_BTF;  // Clear BTF interrupt
-        }
-        break;
-
-      case TS_R_ADDR:
-        if (temp_sr1 & I2C_SR1_ADDR) {
-          // Event EV6
-          // Address sent for receive.
-          // The next bit is different depending on whether there are 
-          // 1 byte, 2 bytes or >2 bytes to be received, in accordance with the
-          // Programmers Reference RM0390.
-          if (bytesToReceive == 1) {
-            // Receive 1 byte
-            s->CR1 &= ~I2C_CR1_ACK;  // Disable ack
-            temp_sr2 = s->SR2; // read SR2 to complete clearing the ADDR bit
-            // Next step will occur after a RXNE interrupt, so enable it
-            s->CR2 |= I2C_CR2_ITBUFEN;
-            transactionState = TS_R_STOP;
-          } else if (bytesToReceive == 2) {
-            // Receive 2 bytes
-            s->CR1 &= ~I2C_CR1_ACK;  // Disable ACK for final byte
-            s->CR1 |= I2C_CR1_POS;  // set POS flag to delay effect of ACK flag
-            // Next step will occur after a BTF interrupt, so disable RXNE interrupt
-            s->CR2 &= ~I2C_CR2_ITBUFEN;
-            temp_sr2 = s->SR2; // read SR2 to complete clearing the ADDR bit
-            transactionState = TS_R_STOP;
-          } else {
-            // >2 bytes, just wait for bytes to come in and ack them for the time being
-            // (ack flag has already been set).
-            // Next step will occur after a BTF interrupt, so disable RXNE interrupt
-            s->CR2 &= ~I2C_CR2_ITBUFEN;
-            temp_sr2 = s->SR2; // read SR2 to complete clearing the ADDR bit
-            transactionState = TS_R_DATA;
-          }
-        }
-        break;
-      
-      case TS_R_DATA:
-        // Event EV7/EV7_1
-        if (temp_sr1 & I2C_SR1_BTF) {
-          // Byte received in receiver - read next byte
-          if (bytesToReceive == 3) {
-            // Getting close to the last byte, so a specific sequence is recommended.
-            s->CR1 &= ~I2C_CR1_ACK;  // Reset ack for next byte received.
-            transactionState = TS_R_STOP;
-          }
-          receiveBuffer[rxCount++] = s->DR;  // Store received byte
-          bytesToReceive--;
-        } 
-        break;
-        
-      case TS_R_STOP:
-        if (temp_sr1 & I2C_SR1_BTF) {
-          // Event EV7 (last one)
-          // When we've got here, the receiver has got the last two bytes
-          // (or one byte, if only one byte is being received),
-          // and NAK has already been sent, so we need to read from the receiver.
-          if (bytesToReceive) {
-            if (bytesToReceive > 1) 
-              I2C_sendStop();
-            while(bytesToReceive) {
-              receiveBuffer[rxCount++] = s->DR;  // Store received byte(s)
-              bytesToReceive--;
-            }
-            // Finish.
-            transactionState = TS_IDLE;
-            completionStatus = I2C_STATUS_OK;
-            state = I2C_STATE_COMPLETED;
-          }
-        } else if (temp_sr1 & I2C_SR1_RXNE) {
-          if (bytesToReceive == 1) {
-            // One byte on a single-byte transfer.  Ack has already been set.
-            I2C_sendStop();
-            receiveBuffer[rxCount++] = s->DR; // Store received byte
-            bytesToReceive--;
-            // Finish.
-            transactionState = TS_IDLE;
-            completionStatus = I2C_STATUS_OK;
-            state = I2C_STATE_COMPLETED;
-          } else
-            s->SR1 &= I2C_SR1_RXNE;  // Acknowledge interrupt
-        }
-        break;
-    }
-    // If we've received an interrupt at any other time, we're not interested so clear it
-    // to prevent it recurring ad infinitum.
-    s->SR1 = 0;
-  }
-  
-}
-
-#endif /* I2CMANAGER_STM32_H */

I2CManager_Wire.h

@@ -1,5 +1,5 @@
 /*
- *  © 2023, Neil McKechnie. All rights reserved.
+ *  © 2021, Neil McKechnie. All rights reserved.
  *
  *  This file is part of CommandStation-EX
  *
@@ -30,19 +30,11 @@
 #define I2C_USE_WIRE
 #endif
 
-// Older versions of Wire don't have setWireTimeout function.  AVR does.
-#ifdef ARDUINO_ARCH_AVR
-#define WIRE_HAS_TIMEOUT
-#endif
-
 /***************************************************************************
  *  Initialise I2C interface software
  ***************************************************************************/
 void I2CManagerClass::_initialise() {
   Wire.begin();
-#if defined(WIRE_HAS_TIMEOUT) 
-  Wire.setWireTimeout(_timeout, true);
-#endif
 }
 
 /***************************************************************************
@@ -53,85 +45,20 @@ void I2CManagerClass::_setClock(unsigned long i2cClockSpeed) {
   Wire.setClock(i2cClockSpeed);
 }
 
-/***************************************************************************
- *  Set I2C timeout value in microseconds.  The timeout applies to each
- *   Wire call separately, i.e. in a write+read, the timer is reset before the
- *   read is started.
- ***************************************************************************/
-void I2CManagerClass::setTimeout(unsigned long value) {
-  _timeout = value;
-#if defined(WIRE_HAS_TIMEOUT) 
-  Wire.setWireTimeout(value, true);
-#endif
-}
-
-/********************************************************
- * Helper function for I2C Multiplexer operations
- ********************************************************/
-#ifdef I2C_EXTENDED_ADDRESS
-static uint8_t muxSelect(I2CAddress address) {
-  // Select MUX sub bus.
-  I2CMux muxNo = address.muxNumber();
-  I2CSubBus subBus = address.subBus();
-  if (muxNo != I2CMux_None) {
-    Wire.beginTransmission(I2C_MUX_BASE_ADDRESS+muxNo); 
-    uint8_t data =  (subBus == SubBus_All) ? 0xff :
-                    (subBus == SubBus_None) ? 0x00 :
-#if defined(I2CMUX_PCA9547)
-                    0x08 | subBus;
-#elif defined(I2CMUX_PCA9542) || defined(I2CMUX_PCA9544)
-                    0x04 | subBus;   // NB Only 2 or 4 subbuses respectively
-#else
-                    // Default behaviour for most MUXs is to use a mask
-                    // with a bit set for the subBus to be enabled
-                    1 << subBus;
-#endif
-    Wire.write(&data, 1);
-    return Wire.endTransmission(true);  // have to release I2C bus for it to work
-  }
-  return I2C_STATUS_OK;
-}
-#endif
-
-
 /***************************************************************************
  *  Initiate a write to an I2C device (blocking operation on Wire)
  ***************************************************************************/
-uint8_t I2CManagerClass::write(I2CAddress address, const uint8_t buffer[], uint8_t size, I2CRB *rb) {
-  uint8_t status, muxStatus;
-  uint8_t retryCount = 0;
-  // If request fails, retry up to the defined limit, unless the NORETRY flag is set
-  // in the request block.
-  do {
-    status = muxStatus = I2C_STATUS_OK;
-#ifdef I2C_EXTENDED_ADDRESS
-    if (address.muxNumber() != I2CMux_None)
-      muxStatus = muxSelect(address);
-#endif
-    // Only send new transaction if address is non-zero.
-    if (muxStatus == I2C_STATUS_OK && address != 0) {
-      Wire.beginTransmission(address);
-      if (size > 0) Wire.write(buffer, size);
-      status = Wire.endTransmission();
-    }
-#ifdef I2C_EXTENDED_ADDRESS
-    // Deselect MUX if there's more than one MUX present, to avoid having multiple ones selected
-    if (_muxCount > 1 && muxStatus == I2C_STATUS_OK 
-          && address.deviceAddress() != 0 && address.muxNumber() != I2CMux_None) {
-      muxSelect({address.muxNumber(), SubBus_None});
-    }
-    if (muxStatus != I2C_STATUS_OK) status = muxStatus;
-#endif
-  } while (!(status == I2C_STATUS_OK
-    || ++retryCount > MAX_I2C_RETRIES || rb->operation & OPERATION_NORETRY));
-  rb->status = status;
+uint8_t I2CManagerClass::write(uint8_t address, const uint8_t buffer[], uint8_t size, I2CRB *rb) {
+  Wire.beginTransmission(address);
+  if (size > 0) Wire.write(buffer, size);
+  rb->status = Wire.endTransmission();
   return I2C_STATUS_OK;
 }
 
 /***************************************************************************
  *  Initiate a write from PROGMEM (flash) to an I2C device (blocking operation on Wire)
  ***************************************************************************/
-uint8_t I2CManagerClass::write_P(I2CAddress address, const uint8_t buffer[], uint8_t size, I2CRB *rb) {
+uint8_t I2CManagerClass::write_P(uint8_t address, const uint8_t buffer[], uint8_t size, I2CRB *rb) {
   uint8_t ramBuffer[size];
   const uint8_t *p1 = buffer;
   for (uint8_t i=0; i<size; i++)
@@ -143,64 +70,27 @@ uint8_t I2CManagerClass::write_P(I2CAddress address, const uint8_t buffer[], uin
  *  Initiate a write (optional) followed by a read from the I2C device (blocking operation on Wire)
  *  If fewer than the number of requested bytes are received, status is I2C_STATUS_TRUNCATED.
  ***************************************************************************/
-uint8_t I2CManagerClass::read(I2CAddress address, uint8_t readBuffer[], uint8_t readSize,
+uint8_t I2CManagerClass::read(uint8_t address, uint8_t readBuffer[], uint8_t readSize,
                               const uint8_t writeBuffer[], uint8_t writeSize, I2CRB *rb)
 {
-  uint8_t status, muxStatus;
+  uint8_t status = I2C_STATUS_OK;
   uint8_t nBytes = 0;
-  uint8_t retryCount = 0;
-  // If request fails, retry up to the defined limit, unless the NORETRY flag is set
-  // in the request block.
-  do {
-    status = muxStatus = I2C_STATUS_OK;
-#ifdef I2C_EXTENDED_ADDRESS
-    if (address.muxNumber() != I2CMux_None) {
-      muxStatus = muxSelect(address);
-    }
-#endif
-    // Only start new transaction if address is non-zero.
-    if (muxStatus == I2C_STATUS_OK && address != 0) {
-      if (writeSize > 0) {
-        Wire.beginTransmission(address);
-        Wire.write(writeBuffer, writeSize);
-        status = Wire.endTransmission(false); // Don't free bus yet
-      }
-      if (status == I2C_STATUS_OK) {
-#ifdef WIRE_HAS_TIMEOUT
-        Wire.clearWireTimeoutFlag();
-        Wire.requestFrom(address, (size_t)readSize);
-        if (!Wire.getWireTimeoutFlag()) {
-          while (Wire.available() && nBytes < readSize) 
-            readBuffer[nBytes++] = Wire.read();
-          if (nBytes < readSize) status = I2C_STATUS_TRUNCATED;
-        } else {
-          status = I2C_STATUS_TIMEOUT;
-        }
-#else
-        Wire.requestFrom(address, (size_t)readSize);
-          while (Wire.available() && nBytes < readSize) 
-            readBuffer[nBytes++] = Wire.read();
-          if (nBytes < readSize) status = I2C_STATUS_TRUNCATED;
-#endif
-      }
-    }
-#ifdef I2C_EXTENDED_ADDRESS
-    // Deselect MUX if there's more than one MUX present, to avoid having multiple ones selected
-    if (_muxCount > 1 && muxStatus == I2C_STATUS_OK && address != 0 && address.muxNumber() != I2CMux_None) {
-      muxSelect({address.muxNumber(), SubBus_None});
-    }
-    if (muxStatus != I2C_STATUS_OK) status = muxStatus;
-#endif
-
-  } while (!((status == I2C_STATUS_OK) 
-    || ++retryCount > MAX_I2C_RETRIES || rb->operation & OPERATION_NORETRY));
-
+  if (writeSize > 0) {
+    Wire.beginTransmission(address);
+    Wire.write(writeBuffer, writeSize);
+    status = Wire.endTransmission(false); // Don't free bus yet
+  }
+  if (status == I2C_STATUS_OK) {
+    Wire.requestFrom(address, (size_t)readSize);
+    while (Wire.available() && nBytes < readSize) 
+      readBuffer[nBytes++] = Wire.read();
+    if (nBytes < readSize) status = I2C_STATUS_TRUNCATED;
+  }
   rb->nBytes = nBytes;
   rb->status = status;
   return I2C_STATUS_OK;
 }
 
-
 /***************************************************************************
  *  Function to queue a request block and initiate operations.
  * 
@@ -210,7 +100,7 @@ uint8_t I2CManagerClass::read(I2CAddress address, uint8_t readBuffer[], uint8_t
  * the non-blocking version.
  ***************************************************************************/
 void I2CManagerClass::queueRequest(I2CRB *req) {
-  switch (req->operation & OPERATION_MASK) {
+  switch (req->operation) {
     case OPERATION_READ:
       read(req->i2cAddress, req->readBuffer, req->readLen, NULL, 0, req);
       break;
@@ -231,4 +121,8 @@ void I2CManagerClass::queueRequest(I2CRB *req) {
  ***************************************************************************/
 void I2CManagerClass::loop() {}
 
+// Loop function
+void I2CManagerClass::checkForTimeout() {}
+
+
 #endif

IODevice.cpp

@@ -33,7 +33,7 @@
 
 // Link to halSetup function.  If not defined, the function reference will be NULL.
 extern __attribute__((weak)) void halSetup();
-extern __attribute__((weak)) bool exrailHalSetup();
+extern __attribute__((weak)) void exrailHalSetup();
 
 //==================================================================================================================
 // Static methods
@@ -48,55 +48,36 @@ extern __attribute__((weak)) bool exrailHalSetup();
 // Create any standard device instances that may be required, such as the Arduino pins 
 // and PCA9685.
 void IODevice::begin() {
-  // Initialise the IO subsystem defaults
-  ArduinoPins::create(2, NUM_DIGITAL_PINS-2);  // Reserve pins for direct access
-
   // Call user's halSetup() function (if defined in the build in myHal.cpp).
   //  The contents will depend on the user's system hardware configuration.
   //  The myHal.cpp file is a standard C++ module so has access to all of the DCC++EX APIs.
-  // This is done early so that the subsequent defaults will detect an overlap and not
-  // create something that conflicts with the user's vpin definitions. 
+  
+  // This is done first so that the following defaults will detect an overlap and not
+  // create something that conflicts with the users vpin definitions. 
   if (halSetup)
     halSetup();
 
   // include any HAL devices defined in exrail. 
-  bool ignoreDefaults=false;
   if (exrailHalSetup)
-    ignoreDefaults=exrailHalSetup();
-  if (ignoreDefaults) return;
-  
-  // Predefine two PCA9685 modules 0x40-0x41 if no conflicts
+    exrailHalSetup();
+
+  // Initialise the IO subsystem defaults
+  ArduinoPins::create(2, NUM_DIGITAL_PINS-2);  // Reserve pins for direct access
+  // Predefine two PCA9685 modules 0x40-0x41
   // Allocates 32 pins 100-131
-  const bool silent=true; // no message if these conflict
-  if (checkNoOverlap(100, 16, 0x40, silent)) {
-    PCA9685::create(100, 16, 0x40);
-  } 
-
-  if (checkNoOverlap(116, 16, 0x41, silent)) {
-    PCA9685::create(116, 16, 0x41);
-  } 
+  PCA9685::create(100, 16, 0x40);
+  PCA9685::create(116, 16, 0x41);
   
-  // Predefine two MCP23017 module 0x20/0x21 if no conflicts
+  // Predefine two MCP23017 module 0x20/0x21
   // Allocates 32 pins 164-195
-  if (checkNoOverlap(164, 16, 0x20, silent)) {
-    MCP23017::create(164, 16, 0x20);
-  } 
+  MCP23017::create(164, 16, 0x20);
+  MCP23017::create(180, 16, 0x21);
 
-  if (checkNoOverlap(180, 16, 0x21, silent)) {
-    MCP23017::create(180, 16, 0x21);
-  } 
-}
-
-// reset() function to reinitialise all devices
-void IODevice::reset() {
-  unsigned long currentMicros = micros();
-  for (IODevice *dev = _firstDevice; dev != NULL; dev = dev->_nextDevice) {
-    dev->_deviceState = DEVSTATE_DORMANT;
-    // First ensure that _loop isn't delaying 
-    dev->delayUntil(currentMicros);
-    // Then invoke _begin to restart driver
+  // Call the begin() methods of each configured device in turn
+  for (IODevice *dev=_firstDevice; dev!=NULL; dev = dev->_nextDevice) {
     dev->_begin();
   }
+  _initPhase = false;
 }
 
 // Overarching static loop() method for the IODevice subsystem.  Works through the
@@ -128,19 +109,18 @@ void IODevice::loop() {
   
   // Report loop time if diags enabled
 #if defined(DIAG_LOOPTIMES)
-  unsigned long diagMicros = micros();
   static unsigned long lastMicros = 0;
-  // Measure time since HAL's loop() method started.
-  unsigned long halElapsed = diagMicros - currentMicros;
-  // Measure time between loop() method entries (excluding this diagnostic).
-  unsigned long elapsed = diagMicros - lastMicros;
+  // Measure time since loop() method started.
+  unsigned long halElapsed = micros() - currentMicros;
+  // Measure time between loop() method entries.
+  unsigned long elapsed = currentMicros - lastMicros;
   static unsigned long maxElapsed = 0, maxHalElapsed = 0;
   static unsigned long lastOutputTime = 0;
   static unsigned long halTotal = 0, total = 0;
   static unsigned long count = 0;
   const unsigned long interval = (unsigned long)5 * 1000 * 1000; // 5 seconds in microsec
 
-  // Ignore long loop counts while message is still outputting (~3 milliseconds)
+  // Ignore long loop counts while message is still outputting
   if (currentMicros - lastOutputTime > 3000UL) {
     if (elapsed > maxElapsed) maxElapsed = elapsed;
     if (halElapsed > maxHalElapsed) maxHalElapsed = halElapsed;
@@ -148,16 +128,14 @@ void IODevice::loop() {
     total += elapsed;
     count++;
   }
-  if (diagMicros - lastOutputTime > interval) {
+  if (currentMicros - lastOutputTime > interval) {
     if (lastOutputTime > 0) 
       DIAG(F("Loop Total:%lus (%lus max) HAL:%lus (%lus max)"), 
         total/count, maxElapsed, halTotal/count, maxHalElapsed);
     maxElapsed = maxHalElapsed = total = halTotal = count = 0;
-    lastOutputTime = diagMicros;
+    lastOutputTime = currentMicros;
   }
-  // Read microsecond count after calculations, so they aren't
-  // included in the overall timings.
-  lastMicros = micros();
+  lastMicros = currentMicros;
 #endif
 }
 
@@ -173,13 +151,6 @@ 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);
@@ -189,7 +160,7 @@ bool IODevice::hasCallback(VPIN vpin) {
 
 // Display (to diagnostics) details of the device.
 void IODevice::_display() {
-  DIAG(F("Unknown device Vpins:%u-%u %S"), 
+  DIAG(F("Unknown device Vpins:%d-%d %S"), 
     (int)_firstVpin, (int)_firstVpin+_nPins-1, _deviceState==DEVSTATE_FAILED ? F("OFFLINE") : F(""));
 }
 
@@ -199,7 +170,7 @@ bool IODevice::configure(VPIN vpin, ConfigTypeEnum configType, int paramCount, i
   IODevice *dev = findDevice(vpin);
   if (dev) return dev->_configure(vpin, configType, paramCount, params);
 #ifdef DIAG_IO
-  DIAG(F("IODevice::configure(): VPIN %u not found!"), (int)vpin);
+  DIAG(F("IODevice::configure(): Vpin ID %d not found!"), (int)vpin);
 #endif
   return false;
 }
@@ -211,7 +182,7 @@ int IODevice::read(VPIN vpin) {
       return dev->_read(vpin);
   }
 #ifdef DIAG_IO
-  DIAG(F("IODevice::read(): VPIN %u not found!"), (int)vpin);
+  DIAG(F("IODevice::read(): Vpin %d not found!"), (int)vpin);
 #endif
   return false;
 }
@@ -223,7 +194,7 @@ int IODevice::readAnalogue(VPIN vpin) {
       return dev->_readAnalogue(vpin);
   }
 #ifdef DIAG_IO
-  DIAG(F("IODevice::readAnalogue(): VPIN %u not found!"), (int)vpin);
+  DIAG(F("IODevice::readAnalogue(): Vpin %d not found!"), (int)vpin);
 #endif
   return -1023;
 }
@@ -233,7 +204,7 @@ int IODevice::configureAnalogIn(VPIN vpin) {
       return dev->_configureAnalogIn(vpin);
   }
 #ifdef DIAG_IO
-  DIAG(F("IODevice::configureAnalogIn(): VPIN %u not found!"), (int)vpin);
+  DIAG(F("IODevice::configureAnalogIn(): Vpin %d not found!"), (int)vpin);
 #endif
   return -1023;
 }
@@ -247,7 +218,7 @@ void IODevice::write(VPIN vpin, int value) {
     return;
   }
 #ifdef DIAG_IO
-  DIAG(F("IODevice::write(): VPIN %u not found!"), (int)vpin);
+  DIAG(F("IODevice::write(): Vpin ID %d not found!"), (int)vpin);
 #endif
 }
 
@@ -266,7 +237,7 @@ void IODevice::writeAnalogue(VPIN vpin, int value, uint8_t param1, uint16_t para
     return;
   }
 #ifdef DIAG_IO
-  DIAG(F("IODevice::writeAnalogue(): VPIN %u not found!"), (int)vpin);
+  DIAG(F("IODevice::writeAnalogue(): Vpin ID %d not found!"), (int)vpin);
 #endif
 }
 
@@ -287,27 +258,25 @@ void IODevice::setGPIOInterruptPin(int16_t pinNumber) {
   _gpioInterruptPin = pinNumber;
 }
 
-// Helper function to add a new device to the device chain.  If 
-// slaveDevice is NULL then the device is added to the end of the chain.
-// Otherwise, the chain is searched for slaveDevice and the new device linked
-// in front of it (to support filter devices that share the same VPIN range
-// as the devices they control).  If slaveDevice isn't found, then the
-// device is linked to the end of the chain.
-void IODevice::addDevice(IODevice *newDevice, IODevice *slaveDevice /* = NULL */) {
-  if (slaveDevice == _firstDevice) {
-    newDevice->_nextDevice = _firstDevice;
+// Private helper function to add a device to the chain of devices.
+void IODevice::addDevice(IODevice *newDevice) {
+  // Link new object to the end of the chain.  Thereby, the first devices to be declared/created
+  // will be located faster by findDevice than those which are created later.
+  // Ideally declare/create the digital IO pins first, then servos, then more esoteric devices.
+  IODevice *lastDevice;
+  if (_firstDevice == 0)
     _firstDevice = newDevice;
-  } else {
-    for (IODevice *dev = _firstDevice; dev != 0; dev = dev->_nextDevice) {
-      if (dev->_nextDevice == slaveDevice || dev->_nextDevice == NULL) {
-          // Link new device between dev and slaveDevice (or at end of chain)
-        newDevice->_nextDevice = dev->_nextDevice;
-        dev->_nextDevice = newDevice;
-        break;
-      }
-    }
+  else {
+    for (IODevice *dev = _firstDevice; dev != 0; dev = dev->_nextDevice)
+      lastDevice = dev;
+    lastDevice->_nextDevice = newDevice;
   }
-  newDevice->_begin();
+  newDevice->_nextDevice = 0;
+
+  // If the IODevice::begin() method has already been called, initialise device here.  If not,
+  // the device's _begin() method will be called by IODevice::begin().
+  if (!_initPhase)
+    newDevice->_begin();
 }
 
 // Private helper function to locate a device by VPIN.  Returns NULL if not found.
@@ -321,45 +290,28 @@ IODevice *IODevice::findDevice(VPIN vpin) {
   return NULL;
 }
 
-// Instance helper function for filter devices (layered over others).  Looks for 
-//  a device that is further down the chain than the current device.
-IODevice *IODevice::findDeviceFollowing(VPIN vpin) {
-  for (IODevice *dev = _nextDevice; dev != 0; dev = dev->_nextDevice) {
-    VPIN firstVpin = dev->_firstVpin;
-    if (vpin >= firstVpin && vpin < firstVpin+dev->_nPins)
-      return dev;
-  }
-  return NULL;
-}
-
 // Private helper function to check for vpin overlap. Run during setup only.
 // returns true if pins DONT overlap with existing device
-// TODO: Move the I2C address reservation and checks into the I2CManager code.
-// That will enable non-HAL devices to reserve I2C addresses too.
-// Silent is used by the default setup so that there is no message if the default 
-// device has already been handled by the user setup.
-bool IODevice::checkNoOverlap(VPIN firstPin, uint8_t nPins, 
-      I2CAddress i2cAddress, bool silent) {
+bool IODevice::checkNoOverlap(VPIN firstPin, uint8_t nPins, uint8_t i2cAddress) {
 #ifdef DIAG_IO
-  DIAG(F("Check no overlap %u %u %s"), firstPin,nPins,i2cAddress.toString());
+  DIAG(F("Check no overlap %d %d 0x%x"), firstPin,nPins,i2cAddress);
 #endif
   VPIN lastPin=firstPin+nPins-1;
   for (IODevice *dev = _firstDevice; dev != 0; dev = dev->_nextDevice) {
     
-    if (nPins > 0 && dev->_nPins > 0) {
-      // check for pin range overlaps (verbose but compiler will fix that)  
-      VPIN firstDevPin=dev->_firstVpin;
-      VPIN lastDevPin=firstDevPin+dev->_nPins-1;
-      bool noOverlap= firstPin>lastDevPin || lastPin<firstDevPin;
-      if (!noOverlap) {
-          if (!silent) DIAG(F("WARNING HAL Overlap, redefinition of Vpins %u to %u ignored."),
-              firstPin, lastPin);
-          return false;
-      } 
-    }
+    // check for pin range overlaps (verbose but compiler will fix that)  
+    VPIN firstDevPin=dev->_firstVpin;
+    VPIN lastDevPin=firstDevPin+dev->_nPins-1;
+    bool noOverlap= firstPin>lastDevPin || lastPin<firstDevPin;
+    if (!noOverlap) {
+        DIAG(F("WARNING HAL Overlap definition of pins  %d to %d ignored."),
+            firstPin, lastPin);
+        return false;
+    } 
+  
     // Check for overlapping I2C address
     if (i2cAddress && dev->_I2CAddress==i2cAddress) {
-      if (!silent) DIAG(F("WARNING HAL Overlap. i2c Addr %s ignored."),i2cAddress.toString());
+      DIAG(F("WARNING HAL Overlap. i2c Addr 0x%x ignored."),i2cAddress);
       return false;
     } 
   }
@@ -374,12 +326,15 @@ bool IODevice::checkNoOverlap(VPIN firstPin, uint8_t nPins,
 // Chain of callback blocks (identifying registered callback functions for state changes)
 IONotifyCallback *IONotifyCallback::first = 0;
 
-// Start and end of chain of devices.
+// Start of chain of devices.
 IODevice *IODevice::_firstDevice = 0;
 
 // Reference to next device to be called on _loop() method.
 IODevice *IODevice::_nextLoopDevice = 0;
 
+// Flag which is reset when IODevice::begin has been called.
+bool IODevice::_initPhase = true;  
+
 
 //==================================================================================================================
 // Instance members
@@ -399,7 +354,7 @@ void IODevice::begin() { DIAG(F("NO HAL CONFIGURED!")); }
 bool IODevice::configure(VPIN pin, ConfigTypeEnum configType, int nParams, int p[]) {
   if (configType!=CONFIGURE_INPUT || nParams!=1 || pin >= NUM_DIGITAL_PINS) return false;
   #ifdef DIAG_IO
-  DIAG(F("Arduino _configurePullup pin:%d Val:%d"), pin, p[0]);
+  DIAG(F("Arduino _configurePullup Pin:%d Val:%d"), pin, p[0]);
   #endif
   pinMode(pin, p[0] ? INPUT_PULLUP : INPUT);
   return true;
@@ -553,7 +508,7 @@ int ArduinoPins::_configureAnalogIn(VPIN vpin) {
 }
 
 void ArduinoPins::_display() {
-  DIAG(F("Arduino Vpins:%u-%u"), (int)_firstVpin, (int)_firstVpin+_nPins-1);
+  DIAG(F("Arduino Vpins:%d-%d"), (int)_firstVpin, (int)_firstVpin+_nPins-1);
 }
 
 /////////////////////////////////////////////////////////////////////////////////////////////////////

IODevice.h

@@ -1,5 +1,4 @@
 /*
- *  © 2023, Paul Antoine, Discord user @ADUBOURG
  *  © 2021, Neil McKechnie. All rights reserved.
  *  
  *  This file is part of DCC++EX API
@@ -27,6 +26,12 @@
 // Define symbol DIAG_LOOPTIMES to enable CS loop execution time to be reported
 //#define DIAG_LOOPTIMES
 
+// Define symbol IO_NO_HAL to reduce FLASH footprint when HAL features not required
+// The HAL is disabled by default on Nano and Uno platforms, because of limited flash space.
+#if defined(ARDUINO_AVR_NANO) || defined(ARDUINO_AVR_UNO) 
+#define IO_NO_HAL
+#endif
+
 // Define symbol IO_SWITCH_OFF_SERVO to set the PCA9685 output to 0 when an 
 // animation has completed.  This switches off the servo motor, preventing 
 // the continuous buzz sometimes found on servos, and reducing the 
@@ -88,8 +93,6 @@ public:
     CONFIGURE_INPUT = 1,
     CONFIGURE_SERVO = 2,
     CONFIGURE_OUTPUT = 3,
-    CONFIGURE_ANALOGOUTPUT = 4,
-    CONFIGURE_ANALOGINPUT = 5,
   } ConfigTypeEnum;
 
   typedef enum : uint8_t {
@@ -107,10 +110,6 @@ public:
   // Also, the _begin method of any existing instances is called from here.
   static void begin();
 
-  // reset function to invoke all driver's _begin() methods again, to
-  // reset the state of the devices and reinitialise.
-  static void reset();
-
   // configure is used invoke an IODevice instance's _configure method
   static bool configure(VPIN vpin, ConfigTypeEnum configType, int paramCount, int params[]);
 
@@ -154,9 +153,6 @@ 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 
@@ -165,13 +161,27 @@ public:
   // once the GPIO port concerned has been read.
   void setGPIOInterruptPin(int16_t pinNumber);
 
-  // Method to check if pins will overlap before creating new device. 
-  static bool checkNoOverlap(VPIN firstPin, uint8_t nPins=1, 
-                  I2CAddress i2cAddress=0, bool silent=false);
+ // Method to check if pins will overlap before creating new device. 
+  static bool checkNoOverlap(VPIN firstPin, uint8_t nPins=1, uint8_t i2cAddress=0);
+  
+protected:
+  
+  // Constructor
+  IODevice(VPIN firstVpin=0, int nPins=0) {
+    _firstVpin = firstVpin;
+    _nPins = nPins;
+    _nextEntryTime = 0;
+    _I2CAddress=0;
+  }
 
-  // Method used by IODevice filters to locate slave pins that may be overlayed by their own
-  // pin range.  
-  IODevice *findDeviceFollowing(VPIN vpin);
+ // Method to perform initialisation of the device (optionally implemented within device class)
+  virtual void _begin() {}
+
+  // Method to configure device (optionally implemented within device class)
+  virtual bool _configure(VPIN vpin, ConfigTypeEnum configType, int paramCount, int params[]) { 
+    (void)vpin; (void)configType; (void)paramCount; (void)params; // Suppress compiler warning.
+    return false;
+  };
 
   // Method to write new state (optionally implemented within device class)
   virtual void _write(VPIN vpin, int value) {
@@ -179,7 +189,7 @@ public:
   };
 
   // Method to write an 'analogue' value (optionally implemented within device class)
-  virtual void _writeAnalogue(VPIN vpin, int value, uint8_t param1=0, uint16_t param2=0) {
+  virtual void _writeAnalogue(VPIN vpin, int value, uint8_t param1, uint16_t param2) {
     (void)vpin; (void)value; (void) param1; (void)param2;
   };
 
@@ -194,29 +204,6 @@ public:
     (void)vpin; 
     return 0;
   };
-
-protected:
-  
-  // Constructor
-  IODevice(VPIN firstVpin=0, int nPins=0) {
-    _firstVpin = firstVpin;
-    _nPins = nPins;
-    _nextEntryTime = 0;
-    _I2CAddress=0;
-  }
-
-  // Method to perform initialisation of the device (optionally implemented within device class)
-  virtual void _begin() {}
-
-  // Method to check whether the vpin corresponds to this device
-  bool owns(VPIN vpin);
-
-  // Method to configure device (optionally implemented within device class)
-  virtual bool _configure(VPIN vpin, ConfigTypeEnum configType, int paramCount, int params[]) { 
-    (void)vpin; (void)configType; (void)paramCount; (void)params; // Suppress compiler warning.
-    return false;
-  };
-
   virtual int _configureAnalogIn(VPIN vpin) { 
     (void)vpin; 
     return 0;
@@ -241,7 +228,7 @@ protected:
   // Common object fields.
   VPIN _firstVpin;
   int _nPins;
-  I2CAddress _I2CAddress;
+  uint8_t _I2CAddress;
   // Flag whether the device supports callbacks.
   bool _hasCallback = false;
 
@@ -250,20 +237,22 @@ protected:
   int16_t _gpioInterruptPin = -1;
     
   // Static support function for subclass creation
-  static void addDevice(IODevice *newDevice, IODevice *slaveDevice = NULL);
-
-  // Method to find device handling Vpin
-  static IODevice *findDevice(VPIN vpin);
+  static void addDevice(IODevice *newDevice);
 
   // Current state of device
   DeviceStateEnum _deviceState = DEVSTATE_DORMANT;
 
 private:
+  // Method to check whether the vpin corresponds to this device
+  bool owns(VPIN vpin);
+  // Method to find device handling Vpin
+  static IODevice *findDevice(VPIN vpin);
   IODevice *_nextDevice = 0;
   unsigned long _nextEntryTime;
   static IODevice *_firstDevice;
 
   static IODevice *_nextLoopDevice;
+  static bool _initPhase;
 };
 
 
@@ -274,7 +263,7 @@ private:
  
 class PCA9685 : public IODevice {
 public:
-  static void create(VPIN vpin, int nPins, I2CAddress i2cAddress, uint16_t frequency = 50);
+  static void create(VPIN vpin, int nPins, uint8_t I2CAddress);
   enum ProfileType : uint8_t {
     Instant = 0,  // Moves immediately between positions (if duration not specified)
     UseDuration = 0, // Use specified duration
@@ -287,7 +276,7 @@ public:
 
 private:
   // Constructor
-  PCA9685(VPIN vpin, int nPins, I2CAddress i2cAddress, uint16_t frequency);
+  PCA9685(VPIN vpin, int nPins, uint8_t I2CAddress);
   // Device-specific initialisation
   void _begin() override;
   bool _configure(VPIN vpin, ConfigTypeEnum configType, int paramCount, int params[]) override;
@@ -317,14 +306,13 @@ private:
   struct ServoData *_servoData [16];
 
   static const uint8_t _catchupSteps = 5; // number of steps to wait before switching servo off
-  static const uint8_t FLASH _bounceProfile[30];
+  static const byte FLASH _bounceProfile[30];
 
   const unsigned int refreshInterval = 50; // refresh every 50ms
 
   // structures for setting up non-blocking writes to servo controller
   I2CRB requestBlock;
   uint8_t outputBuffer[5];
-  uint8_t prescaler; // clock prescaler for setting PWM frequency
 };
 
 /////////////////////////////////////////////////////////////////////////////////////////////////////
@@ -381,7 +369,6 @@ private:
   uint8_t *_pinInUse; 
 };
 
-#ifndef IO_NO_HAL
 /////////////////////////////////////////////////////////////////////////////////////////////////////
 /*
  * IODevice subclass for EX-Turntable.
@@ -389,9 +376,9 @@ private:
  
 class EXTurntable : public IODevice {
 public:
-  static void create(VPIN firstVpin, int nPins, I2CAddress I2CAddress);
+  static void create(VPIN firstVpin, int nPins, uint8_t I2CAddress);
   // Constructor
-  EXTurntable(VPIN firstVpin, int nPins, I2CAddress I2CAddress);
+  EXTurntable(VPIN firstVpin, int nPins, uint8_t I2CAddress);
   enum ActivityNumber : uint8_t {
     Turn = 0,             // Rotate turntable, maintain phase
     Turn_PInvert = 1,     // Rotate turntable, invert phase
@@ -410,143 +397,18 @@ private:
   void _begin() override;
   void _loop(unsigned long currentMicros) override;
   int _read(VPIN vpin) override;
-  void _broadcastStatus (VPIN vpin, uint8_t status, uint8_t activity);
   void _writeAnalogue(VPIN vpin, int value, uint8_t activity, uint16_t duration) override;
   void _display() override;
   uint8_t _stepperStatus;
-  uint8_t _previousStatus;
-  uint8_t _currentActivity;
-};
-#endif
-
-/////////////////////////////////////////////////////////////////////////////////////////////////////
-
-
-// IODevice framework for invoking user-written functions.
-// To use, define a function that you want to be regularly
-// invoked, and then create an instance of UserAddin.  
-// For example, you can show the status, on screen 3, of the first eight
-// locos in the speed table:
-// 
-// void updateLocoScreen() {
-//   for (int i=0; i<8; i++) {
-//     if (DCC::speedTable[i].loco > 0) {
-//       int speed = DCC::speedTable[i].speedCode;
-//       SCREEN(3, i, F("Loco:%4d %3d %c"), DCC::speedTable[i].loco,
-//         speed & 0x7f, speed & 0x80 ? 'R' : 'F');
-//     }
-//   }
-// }
-//
-// void halSetup() {
-//   ...
-//   UserAddin(updateLocoScreen, 1000);  // Update every 1000ms
-//   ...
-// }
-//
-class UserAddin : public IODevice {
-private:
-  void (*_invokeUserFunction)();
-  int _delay; // milliseconds
-public:
-  UserAddin(void (*func)(), int delay) {
-    _invokeUserFunction = func; 
-    _delay = delay; 
-    addDevice(this); 
-  }
-  // userFunction has no return value, no parameter.  delay is in milliseconds.
-  static void create(void (*userFunction)(), int delay) {
-    new UserAddin(userFunction, delay);
-  }
-protected:
-  void _begin() { _display(); }
-  void _loop(unsigned long currentMicros) override {
-    _invokeUserFunction();
-    // _loop won't be called again until _delay ms have elapsed.
-    delayUntil(currentMicros + _delay * 1000UL);
-  }
-  void _display() override {
-    DIAG(F("UserAddin run every %dms"), _delay);
-  }
 };
 
 /////////////////////////////////////////////////////////////////////////////////////////////////////
-// 
-// This HAL device driver is intended for communication in automation
-// sequences.  A VPIN can be SET or RESET within a sequence, and its
-// current state checked elsewhere using IF, IFNOT, AT etc. or monitored
-// from JMRI using a Sensor object (DCC-EX <S ...> command).
-// Alternatively, the flag can be set from JMRI and other interfaces
-// using the <Z ...> command, to enable or disable actions within a sequence.
-// 
-// Example of configuration in halSetup.h:
-// 
-//  FLAGS::create(32000, 128);
-// 
-// or in myAutomation.h:
-//  
-//  HAL(FLAGS, 32000, 128);
-// 
-// Both create 128 flags numbered with VPINs 32000-32127.
-// 
-//
-
-class FLAGS : IODevice {
-private:
-  uint8_t *_states = NULL;
-
-public:
-  static void create(VPIN firstVpin, unsigned int nPins) {
-    if (checkNoOverlap(firstVpin, nPins))
-        new FLAGS(firstVpin, nPins);
-  }
-
-protected:
-  // Constructor performs static initialisation of the device object
-  FLAGS (VPIN firstVpin, int nPins) {
-    _firstVpin = firstVpin;
-    _nPins = nPins;
-    _states = (uint8_t *)calloc(1, (_nPins+7)/8);
-    if (!_states) {
-      DIAG(F("FLAGS: ERROR Memory Allocation Failure"));
-      return;
-    }
-
-    addDevice(this);
-  }
-
-  int _read(VPIN vpin) override {
-    int pin = vpin - _firstVpin;
-    if (pin >= _nPins || pin < 0) return 0;
-    uint8_t mask = 1 << (pin & 7);
-    return (_states[pin>>3] & mask) ? 1 : 0;
-  }
-
-  void _write(VPIN vpin, int value) override {
-    int pin = vpin - _firstVpin;
-    if (pin >= _nPins || pin < 0) return;
-    uint8_t mask = 1 << (pin & 7);
-    if (value) 
-      _states[pin>>3] |= mask;
-    else
-      _states[pin>>3] &= ~mask;
-  }
-
-  void _display() override {
-    DIAG(F("FLAGS configured on VPINs %u-%u"),
-      _firstVpin, _firstVpin+_nPins-1);
-  }
-
-};
 
 #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"
 
 
 #endif // iodevice_h

IO_AnalogueInputs.h

@@ -59,33 +59,28 @@
  **********************************************************************************************/
 class ADS111x: public IODevice { 
 public:
-  static void create(VPIN firstVpin, int nPins, I2CAddress i2cAddress) {
+  static void create(VPIN firstVpin, int nPins, uint8_t i2cAddress) {
     if (checkNoOverlap(firstVpin,nPins,i2cAddress)) new ADS111x(firstVpin, nPins, i2cAddress);
   }
 private:
-  ADS111x(VPIN firstVpin, int nPins, I2CAddress i2cAddress) {
+  ADS111x(VPIN firstVpin, int nPins, uint8_t i2cAddress) {
     _firstVpin = firstVpin;
-    _nPins = (nPins > 4) ? 4 : nPins;
-    _I2CAddress = i2cAddress;
+    _nPins = min(nPins,4);
+    _i2cAddress = i2cAddress;
     _currentPin = 0;
     for (int8_t i=0; i<_nPins; i++)
       _value[i] = -1;
     addDevice(this);
   }
   void _begin() {
-    // Initialise I2C
-    I2CManager.begin();
-    // ADS111x support high-speed I2C (4.3MHz) but that requires special
-    // processing.  So stick to fast mode (400kHz maximum).
-    I2CManager.setClock(400000);
     // Initialise ADS device
-    if (I2CManager.exists(_I2CAddress)) {
+    if (I2CManager.exists(_i2cAddress)) {
       _nextState = STATE_STARTSCAN;
 #ifdef DIAG_IO
       _display();
 #endif
     } else {
-      DIAG(F("ADS111x device not found, I2C:%s"), _I2CAddress.toString());
+      DIAG(F("ADS111x device not found, I2C:%x"), _i2cAddress);
       _deviceState = DEVSTATE_FAILED;
     }
   }
@@ -103,7 +98,7 @@ private:
           _outBuffer[1] = 0xC0 + (_currentPin << 4); // Trigger single-shot, channel n
           _outBuffer[2] = 0xA3;           // 250 samples/sec, comparator off
           // Write command, without waiting for completion.
-          I2CManager.write(_I2CAddress, _outBuffer, 3, &_i2crb);
+          I2CManager.write(_i2cAddress, _outBuffer, 3, &_i2crb);
 
           delayUntil(currentMicros + scanInterval);
           _nextState = STATE_STARTREAD;
@@ -112,14 +107,14 @@ private:
         case STATE_STARTREAD:
           // Reading the pin value
           _outBuffer[0] = 0x00;  // Conversion register address
-          I2CManager.read(_I2CAddress, _inBuffer, 2, _outBuffer, 1, &_i2crb); // Read register
+          I2CManager.read(_i2cAddress, _inBuffer, 2, _outBuffer, 1, &_i2crb); // Read register
           _nextState = STATE_GETVALUE;
           break;
 
         case STATE_GETVALUE:
           _value[_currentPin] = ((uint16_t)_inBuffer[0] << 8) + (uint16_t)_inBuffer[1];
           #ifdef IO_ANALOGUE_SLOW
-          DIAG(F("ADS111x VPIN:%u value:%d"), _currentPin, _value[_currentPin]);
+          DIAG(F("ADS111x pin:%d value:%d"), _currentPin, _value[_currentPin]);
           #endif
 
           // Move to next pin
@@ -131,7 +126,7 @@ private:
           break;
       }
     } else { // error status
-      DIAG(F("ADS111x I2C:%s Error:%d %S"), _I2CAddress.toString(), status, I2CManager.getErrorMessage(status));
+      DIAG(F("ADS111x I2C:x%d Error:%d %S"), _i2cAddress, status, I2CManager.getErrorMessage(status));
       _deviceState = DEVSTATE_FAILED;
     }
   }
@@ -142,7 +137,7 @@ private:
   }
   
   void _display() override {
-    DIAG(F("ADS111x I2C:%s Configured on Vpins:%u-%u %S"), _I2CAddress.toString(), _firstVpin, _firstVpin+_nPins-1,
+    DIAG(F("ADS111x I2C:x%x Configured on Vpins:%d-%d %S"), _i2cAddress, _firstVpin, _firstVpin+_nPins-1,
       _deviceState == DEVSTATE_FAILED ? F("OFFLINE") : F(""));
   }
 
@@ -159,6 +154,7 @@ private:
     STATE_GETVALUE,
   };
   uint16_t _value[4];
+  uint8_t _i2cAddress;
   uint8_t _outBuffer[3];
   uint8_t _inBuffer[2];
   uint8_t _currentPin;  // ADC pin currently being scanned

IO_DCCAccessory.cpp

@@ -62,7 +62,7 @@ void DCCAccessoryDecoder::_write(VPIN id, int state) {
 
 void DCCAccessoryDecoder::_display() {
   int endAddress = _packedAddress + _nPins - 1;
-  DIAG(F("DCCAccessoryDecoder Configured on Vpins:%u-%u Addresses %d/%d-%d/%d)"), _firstVpin, _firstVpin+_nPins-1,
+  DIAG(F("DCCAccessoryDecoder Configured on Vpins:%d-%d Addresses %d/%d-%d/%d)"), _firstVpin, _firstVpin+_nPins-1,
       ADDRESS(_packedAddress), SUBADDRESS(_packedAddress), ADDRESS(endAddress), SUBADDRESS(endAddress));
 }
 

IO_DFPlayer.h

@@ -1,5 +1,5 @@
 /*
- *  © 2023, Neil McKechnie. All rights reserved.
+ *  © 2022, Neil McKechnie. All rights reserved.
  *  
  *  This file is part of DCC++EX API
  *
@@ -33,13 +33,10 @@
  *   and Serialn is the name of the Serial port connected to the DFPlayer (e.g. Serial1).
  * 
  * Example:
- *   In halSetup function within myHal.cpp:
+ *   In mySetup function within mySetup.cpp:
  *       DFPlayer::create(3500, 5, Serial1);
- *   or in myAutomation.h:
- *       HAL(DFPlayer, 3500, 5, Serial1)
  * 
- * Writing an analogue value 1-2999 to the first pin (3500) will play the numbered file from the
- * SD card; e.g. a value of 1 will play the first file, 2 for the second file etc.
+ * Writing an analogue value 1-2999 to the first pin (3500) will play the numbered file from the SD card;
  * Writing an analogue value 0 to the first pin (3500) will stop the file playing;
  * Writing an analogue value 0-30 to the second pin (3501) will set the volume;
  * Writing a digital value of 1 to a pin will play the file corresponding to that pin, e.g.
@@ -64,10 +61,6 @@
  * card (as listed by the DIR command in Windows).  This may not match the order of the files 
  * as displayed by Windows File Manager, which sorts the file names.  It is suggested that
  * files be copied into an empty SDcard in the desired order, one at a time.
- * 
- * The driver now polls the device for its current status every second.  Should the device
- * fail to respond it will be marked off-line and its busy indicator cleared, to avoid
- * lock-ups in automation scripts that are executing for a WAITFOR().
  */
 
 #ifndef IO_DFPlayer_h
@@ -77,17 +70,23 @@
 
 class DFPlayer : public IODevice {
 private: 
-  const uint8_t MAXVOLUME=30;
   HardwareSerial *_serial;
   bool _playing = false;
   uint8_t _inputIndex = 0;
-  unsigned long _commandSendTime; // Time (us) that last transmit took place.
-  unsigned long _timeoutTime;
-  uint8_t _recvCMD;  // Last received command code byte
-  bool _awaitingResponse = false;
-  uint8_t _requestedVolumeLevel = MAXVOLUME;
-  uint8_t _currentVolume = MAXVOLUME;
-  int _requestedSong = -1;  // -1=none, 0=stop, >0=file number
+  unsigned long _commandSendTime; // Allows timeout processing
+
+  // When two commands are sent in quick succession, the device sometimes 
+  // fails to execute one.  A delay is required between successive commands.
+  // This could be implemented by buffering commands and outputting them
+  // from the loop() function, but it would somewhat complicate the 
+  // driver.  A simpler solution is to output a number of NUL pad characters
+  // between successive command strings if there isn't sufficient elapsed time
+  // between them.  At 9600 baud, each pad character takes approximately
+  // 1ms to complete.  Experiments indicate that the minimum number of pads
+  // for reliable operation is 17.  This gives 17.7ms between the end of one
+  // command and the beginning of the next, or 28ms between successive commands
+  // being completed.  I've allowed 20 characters, which is almost 21ms.
+  const int numPadCharacters = 20;  // Number of pad characters between commands
   
 public:
  
@@ -112,151 +111,66 @@ protected:
 
     // Send a query to the device to see if it responds
     sendPacket(0x42); 
-    _timeoutTime = micros() + 5000000UL;  // 5 second timeout
-    _awaitingResponse = true;
+    _commandSendTime = micros();
   }
 
   void _loop(unsigned long currentMicros) override {
-
-    // Read responses from device
-    processIncoming();
-
-    // Check if a command sent to device has timed out.  Allow 0.5 second for response
-    if (_awaitingResponse && (int32_t)(currentMicros - _timeoutTime) > 0) {
-      DIAG(F("DFPlayer device not responding on serial port"));
-      _deviceState = DEVSTATE_FAILED;
-      _awaitingResponse = false;
-      _playing = false;
-    }
-
-    // Send any commands that need to go.
-    processOutgoing(currentMicros);
-
-    delayUntil(currentMicros + 10000); // Only enter every 10ms
-  }
-
-  // Check for incoming data on _serial, and update busy flag and other state accordingly
-  void processIncoming() {
+    // Check for incoming data on _serial, and update busy flag accordingly.
     // Expected message is in the form "7E FF 06 3D xx xx xx xx xx EF"
-    bool ok = false;
     while (_serial->available()) {
       int c = _serial->read();
-      switch (_inputIndex) {
-        case 0:
-          if (c == 0x7E) ok = true;
-          break;
-        case 1:
-          if (c == 0xFF) ok = true;
-          break;
-        case 2:
-          if (c== 0x06) ok = true;
-          break;
-        case 3:
-          _recvCMD = c; // CMD byte
-          ok = true;
-          break;
-        case 6:
-          switch (_recvCMD) {
-            case 0x42:
-              // Response to status query
-              _playing = (c != 0);
-              // Mark the device online and cancel timeout
-              if (_deviceState==DEVSTATE_INITIALISING) {
-                _deviceState = DEVSTATE_NORMAL;
-                #ifdef DIAG_IO
-                _display();
-                #endif
-              }
-              _awaitingResponse = false;
-              break;
-            case 0x3d:
-              // End of play
-              if (_playing) {
-                #ifdef DIAG_IO
-                DIAG(F("DFPlayer: Finished"));
-                #endif
-                _playing = false;
-              }
-              break;
-            case 0x40:
-              // Error code
-              DIAG(F("DFPlayer: Error %d returned from device"), c);
-              _playing = false;
-              break;
-          }
-          ok = true;
-          break;
-        case 4: case 5: case 7: case 8: 
-          ok = true;  // Skip over these bytes in message.
-          break;
-        case 9:
-          if (c==0xef) {
-            // Message finished
-          }
-          break;
-        default:
-          break;
-      }
-      if (ok)
-        _inputIndex++;  // character as expected, so increment index
-      else
-        _inputIndex = 0;  // otherwise reset.
-    }
-  }
-
-  // Send any commands that need to be sent
-  void processOutgoing(unsigned long currentMicros) {
-
-    // When two commands are sent in quick succession, the device will often fail to 
-    // execute one.  Testing has indicated that a delay of 100ms or more is required
-    // between successive commands to get reliable operation.
-    // If 100ms has elapsed since the last thing sent, then check if there's some output to do.
-    if (((int32_t)currentMicros - _commandSendTime) > 100000) {
-      if (_currentVolume > _requestedVolumeLevel) {
-        // Change volume before changing song if volume is reducing.
-        _currentVolume = _requestedVolumeLevel;
-        sendPacket(0x06, _currentVolume);
-      } else if (_requestedSong > 0) {
-        // Change song
-        sendPacket(0x03, _requestedSong);
-        _requestedSong = -1;
-      } else if (_requestedSong == 0) {
-        sendPacket(0x16);  // Stop playing
-        _requestedSong = -1;
-      } else if (_currentVolume < _requestedVolumeLevel) {
-        // Change volume after changing song if volume is increasing.
-        _currentVolume = _requestedVolumeLevel;
-        sendPacket(0x06, _currentVolume);
-      } else if ((int32_t)currentMicros - _commandSendTime > 1000000) {
-        // Poll device every second that other commands aren't being sent,
-        // to check if it's still connected and responding.
-        sendPacket(0x42); 
-        if (!_awaitingResponse) {
-          _timeoutTime = currentMicros + 5000000UL;  // Timeout if no response within 5 seconds
-          _awaitingResponse = true;
+      if (c == 0x7E && _inputIndex == 0) 
+        _inputIndex = 1;
+      else if ((c==0xFF && _inputIndex==1)
+            || (c==0x3D && _inputIndex==3) 
+            || (_inputIndex >=4 && _inputIndex <= 8))
+        _inputIndex++;
+      else if (c==0x06 && _inputIndex==2) { 
+        // Valid message prefix, so consider the device online
+        if (_deviceState==DEVSTATE_INITIALISING) {
+          _deviceState = DEVSTATE_NORMAL;
+          #ifdef DIAG_IO
+          _display();
+          #endif
         }
-      }
+        _inputIndex++;
+      } else if (c==0xEF && _inputIndex==9) {
+        // End of play
+        if (_playing) {
+          #ifdef DIAG_IO
+          DIAG(F("DFPlayer: Finished"));
+          #endif
+          _playing = false;
+        }
+        _inputIndex = 0;
+      } else 
+        _inputIndex = 0;  // Unrecognised character sequence, start again!
     }
+    // Check if the initial prompt to device has timed out.  Allow 5 seconds
+    if (_deviceState == DEVSTATE_INITIALISING && currentMicros - _commandSendTime > 5000000UL) {
+      DIAG(F("DFPlayer device not responding on serial port"));
+      _deviceState = DEVSTATE_FAILED;
+    }
+    delayUntil(currentMicros + 10000); // Only enter every 10ms
   }
 
   // Write with value 1 starts playing a song.  The relative pin number is the file number.
   // Write with value 0 stops playing.
   void _write(VPIN vpin, int value) override {
-    if (_deviceState == DEVSTATE_FAILED) return;
     int pin = vpin - _firstVpin;
     if (value) {
       // Value 1, start playing
       #ifdef DIAG_IO
       DIAG(F("DFPlayer: Play %d"), pin+1);
       #endif
-      _requestedSong = pin+1;
+      sendPacket(0x03, pin+1);
       _playing = true;
     } else {
       // Value 0, stop playing
       #ifdef DIAG_IO
       DIAG(F("DFPlayer: Stop"));
       #endif
-      _requestedSong = 0;  // No song
+      sendPacket(0x16);
       _playing = false;
     }
   }
@@ -265,43 +179,51 @@ protected:
   // Volume may be specified as second parameter to writeAnalogue.
   // If value is zero, the player stops playing.  
   // WriteAnalogue on second pin sets the output volume.
-  //
   void _writeAnalogue(VPIN vpin, int value, uint8_t volume=0, uint16_t=0) override { 
-    if (_deviceState == DEVSTATE_FAILED) return;
     uint8_t pin = vpin - _firstVpin;
  
-    #ifdef DIAG_IO
-    DIAG(F("DFPlayer: VPIN:%u FileNo:%d Volume:%d"), vpin, value, volume);
-    #endif
-
     // Validate parameter.
-    if (volume > MAXVOLUME) volume = MAXVOLUME;
+    volume = min((uint8_t)30,volume);
 
     if (pin == 0) {
       // Play track 
       if (value > 0) {
-        if (volume > 0)
-          _requestedVolumeLevel = volume;
-        _requestedSong = value;
+        #ifdef DIAG_IO
+        DIAG(F("DFPlayer: Play %d"), value);
+        #endif
+        sendPacket(0x03, value); // Play track
         _playing = true;
+        if (volume > 0) {
+          #ifdef DIAG_IO
+          DIAG(F("DFPlayer: Volume %d"), volume);
+          #endif
+          sendPacket(0x06, volume);  // Set volume
+        }
       } else {
-        _requestedSong = 0; // stop playing
+        #ifdef DIAG_IO
+        DIAG(F("DFPlayer: Stop"));
+        #endif
+        sendPacket(0x16); // Stop play
         _playing = false;
       }
     } else if (pin == 1) {
       // Set volume (0-30)
-      _requestedVolumeLevel = value;  
+      if (value > 30) value = 30;
+      else if (value < 0) value = 0;
+      #ifdef DIAG_IO
+      DIAG(F("DFPlayer: Volume %d"), value);
+      #endif
+      sendPacket(0x06, value);      
     }
   }
 
   // A read on any pin indicates whether the player is still playing.
   int _read(VPIN) override {
-    if (_deviceState == DEVSTATE_FAILED) return false;
     return _playing;
   }
 
   void _display() override {
-    DIAG(F("DFPlayer Configured on Vpins:%u-%u %S"), _firstVpin, _firstVpin+_nPins-1,
+    DIAG(F("DFPlayer Configured on Vpins:%d-%d %S"), _firstVpin, _firstVpin+_nPins-1,
       (_deviceState==DEVSTATE_FAILED) ? F("OFFLINE") : F(""));
   }
   
@@ -318,6 +240,7 @@ private:
 
   void sendPacket(uint8_t command, uint16_t arg = 0)
   {
+    unsigned long currentMillis = millis();
     uint8_t out[] = { 0x7E,
         0xFF,
         06,
@@ -331,10 +254,19 @@ private:
 
     setChecksum(out);
 
-    // Output the command
-    _serial->write(out, sizeof(out));
+    // Check how long since the last command was sent.
+    // Each character takes approx 1ms at 9600 baud
+    unsigned long minimumGap = numPadCharacters + sizeof(out);
+    if (currentMillis - _commandSendTime < minimumGap) {
+      // Output some pad characters to add an
+      // artificial delay between commands
+      for (int i=0; i<numPadCharacters; i++) 
+        _serial->write(0);
+    }
 
-    _commandSendTime = micros();
+    // Now output the command
+    _serial->write(out, sizeof(out));
+    _commandSendTime = currentMillis;
   }
 
   uint16_t calcChecksum(uint8_t* packet)

IO_EXFastclock.h

@@ -40,24 +40,24 @@ bool FAST_CLOCK_EXISTS = true;
 class EXFastClock : public IODevice {
 public:
   // Constructor
-    EXFastClock(I2CAddress i2cAddress){
-    _I2CAddress = i2cAddress;
+    EXFastClock(uint8_t I2CAddress){
+    _I2CAddress = I2CAddress;
     addDevice(this);
   }
 
-static void create(I2CAddress i2cAddress) {
+static void create(uint8_t _I2CAddress) {
 
   DIAG(F("Checking for Clock"));
   // Start by assuming we will find the clock
   // Check if specified I2C address is responding (blocking operation)
   // Returns I2C_STATUS_OK (0) if OK, or error code.
-  uint8_t _checkforclock = I2CManager.checkAddress(i2cAddress);
+  uint8_t _checkforclock = I2CManager.checkAddress(_I2CAddress);
   DIAG(F("Clock check result - %d"), _checkforclock);
   // XXXX change thistosave2 bytes
   if (_checkforclock == 0) {
       FAST_CLOCK_EXISTS = true;
-      //DIAG(F("I2C Fast Clock found at %s"), i2cAddress.toString());
-      new EXFastClock(i2cAddress); 
+      //DIAG(F("I2C Fast Clock found at x%x"), _I2CAddress);
+      new EXFastClock(_I2CAddress); 
     }
     else {
       FAST_CLOCK_EXISTS = false;
@@ -68,6 +68,7 @@ static void create(I2CAddress i2cAddress) {
   }
     
 private:
+uint8_t _I2CAddress;
   
 
 // Initialisation of Fastclock
@@ -83,7 +84,7 @@ void _begin() override {
     } else {
     _deviceState = DEVSTATE_FAILED;
     //LCD(6,F("CLOCK NOT FOUND")); 
-    DIAG(F("Fast Clock Not Found at address %s"), _I2CAddress.toString());
+    DIAG(F("Fast Clock Not Found at address %d"), _I2CAddress);
     }
   }
 }
@@ -109,15 +110,17 @@ void _loop(unsigned long currentMicros) override{
         // As the minimum clock increment is 2 seconds delay a bit - say 1 sec.
         // Clock interval is 60/ clockspeed i.e 60/b seconds
         delayUntil(currentMicros + ((60/b) * 1000000));  
+            
+        }
      
       #endif
     
   }
-}
+
 
   // Display EX-FastClock device driver info.
-  void _display() override {
-    DIAG(F("FastCLock on I2C:%s - %S"), _I2CAddress.toString(),  (_deviceState==DEVSTATE_FAILED) ? F("OFFLINE") : F(""));
+  void _display() {
+    DIAG(F("FastCLock on I2C:x%x - %S"), _I2CAddress,  (_deviceState==DEVSTATE_FAILED) ? F("OFFLINE") : F(""));
   }
   
 };

IO_EXIOExpander.h

@@ -1,6 +1,5 @@
 /*
  *  © 2022, Peter Cole. All rights reserved.
- *  © 2024, Harald Barth. All rights reserved.
  *
  *  This file is part of EX-CommandStation
  *
@@ -23,25 +22,23 @@
 * This device driver will configure the device on startup, along with
 * interacting with the device for all input/output duties.
 *
-* To create EX-IOExpander devices, these are defined in myAutomation.h:
+* To create EX-IOExpander devices, these are defined in myHal.cpp:
 * (Note the device driver is included by default)
 *
-* HAL(EXIOExpander,800,18,0x65)
+* void halSetup() {
+*   // EXIOExpander::create(vpin, num_vpins, i2c_address);
+*   EXIOExpander::create(800, 18, 0x65);
+* }
 * 
 * All pins on an EX-IOExpander device are allocated according to the pin map for the specific
 * device in use. There is no way for the device driver to sanity check pins are used for the
 * correct purpose, however the EX-IOExpander device's pin map will prevent pins being used
 * incorrectly (eg. A6/7 on Nano cannot be used for digital input/output).
-*
-* The total number of pins cannot exceed 256 because of the communications packet format.
-* The number of analogue inputs cannot exceed 16 because of a limit on the maximum
-* I2C packet size of 32 bytes (in the Wire library).
 */
 
 #ifndef IO_EX_IOEXPANDER_H
 #define IO_EX_IOEXPANDER_H
 
-#include "IODevice.h"
 #include "I2CManager.h"
 #include "DIAG.h"
 #include "FSH.h"
@@ -63,233 +60,120 @@ public:
     NoPowerOff = 0x80, // Flag to be ORed in to suppress power off after move.
   };
 
-  static void create(VPIN vpin, int nPins, I2CAddress i2cAddress) {
+  static void create(VPIN vpin, int nPins, uint8_t i2cAddress) {
     if (checkNoOverlap(vpin, nPins, i2cAddress)) new EXIOExpander(vpin, nPins, i2cAddress);
   }
 
-private:
+private:  
   // Constructor
-  EXIOExpander(VPIN firstVpin, int nPins, I2CAddress i2cAddress) {
+  EXIOExpander(VPIN firstVpin, int nPins, uint8_t i2cAddress) {
     _firstVpin = firstVpin;
-    // Number of pins cannot exceed 256 (1 byte) because of I2C message structure.
-    if (nPins > 256) nPins = 256;
     _nPins = nPins;
-    _I2CAddress = i2cAddress;
+    _i2cAddress = i2cAddress;
     addDevice(this);
   }
 
   void _begin() {
-    uint8_t status;
     // Initialise EX-IOExander device
     I2CManager.begin();
-    if (I2CManager.exists(_I2CAddress)) {
+    if (I2CManager.exists(_i2cAddress)) {
+      _command4Buffer[0] = EXIOINIT;
+      _command4Buffer[1] = _nPins;
+      _command4Buffer[2] = _firstVpin & 0xFF;
+      _command4Buffer[3] = _firstVpin >> 8;
       // Send config, if EXIOPINS returned, we're good, setup pin buffers, otherwise go offline
-      // NB The I2C calls here are done as blocking calls, as they're not time-critical
-      // during initialisation and the reads require waiting for a response anyway.
-      // Hence we can allocate I/O buffers from the stack.
-      uint8_t receiveBuffer[3];
-      uint8_t commandBuffer[4] = {EXIOINIT, (uint8_t)_nPins, (uint8_t)(_firstVpin & 0xFF), (uint8_t)(_firstVpin >> 8)};
-      status = I2CManager.read(_I2CAddress, receiveBuffer, sizeof(receiveBuffer), commandBuffer, sizeof(commandBuffer));
-      if (status == I2C_STATUS_OK) {
-        if (receiveBuffer[0] == EXIOPINS) {
-          _numDigitalPins = receiveBuffer[1];
-          _numAnaloguePins = receiveBuffer[2];
-
-          // See if we already have suitable buffers assigned
-          if (_numDigitalPins>0) {
-            size_t digitalBytesNeeded = (_numDigitalPins + 7) / 8;
-            if (_digitalPinBytes < digitalBytesNeeded) {
-              // Not enough space, free any existing buffer and allocate a new one
-              if (_digitalPinBytes > 0) free(_digitalInputStates);
-              if ((_digitalInputStates = (byte*) calloc(digitalBytesNeeded, 1)) != NULL) {
-                _digitalPinBytes = digitalBytesNeeded;
-              } else {
-                DIAG(F("EX-IOExpander I2C:%s ERROR alloc %d bytes"), _I2CAddress.toString(), digitalBytesNeeded);
-                _deviceState = DEVSTATE_FAILED;
-                _digitalPinBytes = 0;
-                return;
-              }
-            }
-          }
-          
-          if (_numAnaloguePins>0) {
-            size_t analogueBytesNeeded = _numAnaloguePins * 2;
-            if (_analoguePinBytes < analogueBytesNeeded) {
-              // Free any existing buffers and allocate new ones.
-              if (_analoguePinBytes > 0) {
-                free(_analogueInputBuffer);
-                free(_analogueInputStates);
-                free(_analoguePinMap);
-              }
-              _analogueInputStates = (uint8_t*) calloc(analogueBytesNeeded, 1);
-              _analogueInputBuffer = (uint8_t*) calloc(analogueBytesNeeded, 1);
-              _analoguePinMap = (uint8_t*) calloc(_numAnaloguePins, 1);
-	      if (_analogueInputStates  != NULL &&
-		  _analogueInputBuffer != NULL &&
-		  _analoguePinMap != NULL) {
-		_analoguePinBytes = analogueBytesNeeded;
-	      } else {
-		DIAG(F("EX-IOExpander I2C:%s ERROR alloc analog pin bytes"), _I2CAddress.toString());
-		_deviceState = DEVSTATE_FAILED;
-		_analoguePinBytes = 0;
-		return;
-	      }
-            }
-          }
-        } else {
-          DIAG(F("EX-IOExpander I2C:%s ERROR configuring device"), _I2CAddress.toString());
-          _deviceState = DEVSTATE_FAILED;
-          return;
-        }
-      } 
-      // We now need to retrieve the analogue pin map if there are analogue pins
-      if (status == I2C_STATUS_OK && _numAnaloguePins>0) {
-        commandBuffer[0] = EXIOINITA;
-        status = I2CManager.read(_I2CAddress, _analoguePinMap, _numAnaloguePins, commandBuffer, 1);
+      I2CManager.read(_i2cAddress, _receive3Buffer, 3, _command4Buffer, 4);
+      if (_receive3Buffer[0] == EXIOPINS) {
+        _numDigitalPins = _receive3Buffer[1];
+        _numAnaloguePins = _receive3Buffer[2];
+        _digitalPinBytes = (_numDigitalPins + 7)/8;
+        _digitalInputStates=(byte*) calloc(_digitalPinBytes,1);
+        _analoguePinBytes = _numAnaloguePins * 2;
+        _analogueInputStates = (byte*) calloc(_analoguePinBytes, 1);
+        _analoguePinMap = (uint8_t*) calloc(_numAnaloguePins, 1);
+      } else {
+        DIAG(F("ERROR configuring EX-IOExpander device, I2C:x%x"), _i2cAddress);
+        _deviceState = DEVSTATE_FAILED;
+        return;
       }
-      if (status == I2C_STATUS_OK) {
-        // Attempt to get version, if we don't get it, we don't care, don't go offline
-        uint8_t versionBuffer[3];
-        commandBuffer[0] = EXIOVER;
-        if (I2CManager.read(_I2CAddress, versionBuffer, sizeof(versionBuffer), commandBuffer, 1) == I2C_STATUS_OK) {
-          _majorVer = versionBuffer[0];
-          _minorVer = versionBuffer[1];
-          _patchVer = versionBuffer[2];
-        }
-        DIAG(F("EX-IOExpander device found, I2C:%s, Version v%d.%d.%d"),
-            _I2CAddress.toString(), _majorVer, _minorVer, _patchVer);
-
+      // We now need to retrieve the analogue pin map
+      _command1Buffer[0] = EXIOINITA;
+      I2CManager.read(_i2cAddress, _analoguePinMap, _numAnaloguePins, _command1Buffer, 1);
+      // Attempt to get version, if we don't get it, we don't care, don't go offline
+      _command1Buffer[0] = EXIOVER;
+      I2CManager.read(_i2cAddress, _versionBuffer, 3, _command1Buffer, 1);
+      _majorVer = _versionBuffer[0];
+      _minorVer = _versionBuffer[1];
+      _patchVer = _versionBuffer[2];
+      DIAG(F("EX-IOExpander device found, I2C:x%x, Version v%d.%d.%d"),
+          _i2cAddress, _versionBuffer[0], _versionBuffer[1], _versionBuffer[2]);
 #ifdef DIAG_IO
-        _display();
+      _display();
 #endif
-      }
-      if (status != I2C_STATUS_OK)
-        reportError(status);
-
     } else {
-      DIAG(F("EX-IOExpander I2C:%s device not found"), _I2CAddress.toString());
+      DIAG(F("EX-IOExpander device not found, I2C:x%x"), _i2cAddress);
       _deviceState = DEVSTATE_FAILED;
     }
   }
 
-  // Digital input pin configuration, used to enable on EX-IOExpander device and set pullups if requested.
-  // Configuration isn't done frequently so we can use blocking I2C calls here, and so buffers can
-  // be allocated from the stack to reduce RAM allocation.
+  // Digital input pin configuration, used to enable on EX-IOExpander device and set pullups if in use
   bool _configure(VPIN vpin, ConfigTypeEnum configType, int paramCount, int params[]) override {
     if (paramCount != 1) return false;
     int pin = vpin - _firstVpin;
     if (configType == CONFIGURE_INPUT) {
-      uint8_t pullup = params[0];
-      uint8_t outBuffer[] = {EXIODPUP, (uint8_t)pin, pullup};
-      uint8_t responseBuffer[1];
-      uint8_t status = I2CManager.read(_I2CAddress, responseBuffer, sizeof(responseBuffer),
-                                outBuffer, sizeof(outBuffer));
-      if (status == I2C_STATUS_OK) {
-        if (responseBuffer[0] == EXIORDY) {
-          return true;
-        } else {
-          DIAG(F("EXIOVpin %u cannot be used as a digital input pin"), (int)vpin);
-        }
-      } else
-        reportError(status);
-    } else if (configType == CONFIGURE_ANALOGINPUT) {
-      // TODO:  Consider moving code from _configureAnalogIn() to here and remove _configureAnalogIn
-      // from IODevice class definition.  Not urgent, but each virtual function defined
-      // means increasing the RAM requirement of every HAL device driver, whether it's relevant
-      // to the driver or not.
-      return false;
-    }
-    return false;
-  }
-
-  // Analogue input pin configuration, used to enable an EX-IOExpander device.
-  // Use I2C blocking calls and allocate buffers from stack to save RAM.
-  int _configureAnalogIn(VPIN vpin) override {
-    int pin = vpin - _firstVpin;
-    uint8_t commandBuffer[] = {EXIOENAN, (uint8_t)pin};
-    uint8_t responseBuffer[1];
-    uint8_t status = I2CManager.read(_I2CAddress, responseBuffer, sizeof(responseBuffer),
-                                  commandBuffer, sizeof(commandBuffer));
-    if (status == I2C_STATUS_OK) {
-      if (responseBuffer[0] == EXIORDY) {
+      bool pullup = params[0];
+      _digitalOutBuffer[0] = EXIODPUP;
+      _digitalOutBuffer[1] = pin;
+      _digitalOutBuffer[2] = pullup;
+      I2CManager.read(_i2cAddress, _command1Buffer, 1, _digitalOutBuffer, 3);
+      if (_command1Buffer[0] == EXIORDY) {
         return true;
       } else {
-        DIAG(F("EX-IOExpander: Vpin %u cannot be used as an analogue input pin"), (int)vpin);
+        DIAG(F("Vpin %d cannot be used as a digital input pin"), (int)vpin);
+        return false;
       }
-    } else
-      reportError(status);
+    } else {
+      return false;
+    }
+  }
 
-    return false;
+  // Analogue input pin configuration, used to enable on EX-IOExpander device
+  int _configureAnalogIn(VPIN vpin) override {
+    int pin = vpin - _firstVpin;
+    _command2Buffer[0] = EXIOENAN;
+    _command2Buffer[1] = pin;
+    I2CManager.read(_i2cAddress, _command1Buffer, 1, _command2Buffer, 2);
+    if (_command1Buffer[0] == EXIORDY) {
+      return true;
+    } else {
+      DIAG(F("Vpin %d cannot be used as an analogue input pin"), (int)vpin);
+      return false;
+    }
+    return true;
   }
 
   // Main loop, collect both digital and analogue pin states continuously (faster sensor/input reads)
   void _loop(unsigned long currentMicros) override {
-    if (_deviceState == DEVSTATE_FAILED) return;    // If device failed, return
-
-    // Request block is used for analogue and digital reads from the IOExpander, which are performed
-    // on a cyclic basis.  Writes are performed synchronously as and when requested.
-
-    if (_readState != RDS_IDLE) {
-      if (_i2crb.isBusy()) return;                // If I2C operation still in progress, return
-
-      uint8_t status = _i2crb.status;
-      if (status == I2C_STATUS_OK) {             // If device request ok, read input data
-
-        // First check if we need to process received data
-        if (_readState == RDS_ANALOGUE) {
-          // Read of analogue values was in progress, so process received values
-          // Here we need to copy the values from input buffer to the analogue value array.  We need to 
-          // do this to avoid tearing of the values (i.e. one byte of a two-byte value being changed
-          // while the value is being read).
-          memcpy(_analogueInputStates, _analogueInputBuffer, _analoguePinBytes); // Copy I2C input buffer to states
-
-        } else if (_readState == RDS_DIGITAL) {
-          // Read of digital states was in progress, so process received values 
-          // The received digital states are placed directly into the digital buffer on receipt, 
-          // so don't need any further processing at this point (unless we want to check for
-          // changes and notify them to subscribers, to avoid the need for polling - see IO_GPIOBase.h).
-        }
-      } else
-        reportError(status, false);   // report eror but don't go offline.
-
-      _readState = RDS_IDLE;
-    }
-
-    // If we're not doing anything now, check to see if a new input transfer is due.
-    if (_readState == RDS_IDLE) {
-      if (_numDigitalPins>0 && currentMicros - _lastDigitalRead > _digitalRefresh) { // Delay for digital read refresh
-        // Issue new read request for digital states.  As the request is non-blocking, the buffer has to
-        // be allocated from heap (object state).
-        _readCommandBuffer[0] = EXIORDD;
-        I2CManager.read(_I2CAddress, _digitalInputStates, (_numDigitalPins+7)/8, _readCommandBuffer, 1, &_i2crb);
-                                                                // non-blocking read
-        _lastDigitalRead = currentMicros;
-        _readState = RDS_DIGITAL;
-      } else if (_numAnaloguePins>0 && currentMicros - _lastAnalogueRead > _analogueRefresh) { // Delay for analogue read refresh
-        // Issue new read for analogue input states
-        _readCommandBuffer[0] = EXIORDAN;
-        I2CManager.read(_I2CAddress, _analogueInputBuffer,
-            _numAnaloguePins * 2, _readCommandBuffer, 1, &_i2crb);
-        _lastAnalogueRead = currentMicros;
-        _readState = RDS_ANALOGUE;
-      }
-    }
+    (void)currentMicros; // remove warning
+    if (_deviceState == DEVSTATE_FAILED) return;
+    _command1Buffer[0] = EXIORDD;
+    I2CManager.read(_i2cAddress, _digitalInputStates, _digitalPinBytes, _command1Buffer, 1);
+    _command1Buffer[0] = EXIORDAN;
+    I2CManager.read(_i2cAddress, _analogueInputStates, _analoguePinBytes, _command1Buffer, 1);
   }
 
-  // Obtain the correct analogue input value, with reference to the analogue
-  // pin map.  
   // Obtain the correct analogue input value
   int _readAnalogue(VPIN vpin) override {
     if (_deviceState == DEVSTATE_FAILED) return 0;
     int pin = vpin - _firstVpin;
+    uint8_t _pinLSBByte;
     for (uint8_t aPin = 0; aPin < _numAnaloguePins; aPin++) {
       if (_analoguePinMap[aPin] == pin) {
-        uint8_t _pinLSBByte = aPin * 2;
-        uint8_t _pinMSBByte = _pinLSBByte + 1;
-        return (_analogueInputStates[_pinMSBByte] << 8) + _analogueInputStates[_pinLSBByte];
+        _pinLSBByte = aPin * 2;
       }
     }
-    return -1;  // pin not found in table
+    uint8_t _pinMSBByte = _pinLSBByte + 1;
+    return (_analogueInputStates[_pinMSBByte] << 8) + _analogueInputStates[_pinLSBByte];
   }
 
   // Obtain the correct digital input value
@@ -301,102 +185,63 @@ private:
     return value;
   }
 
-  // Write digital value.  We could have an output buffer of states, that is periodically
-  // written to the device if there are any changes; this would reduce the I2C overhead
-  // if lots of output requests are being made.  We could also cache the last value 
-  // sent so that we don't write the same value over and over to the output.  
-  // However, for the time being, we just write the current value (blocking I2C) to the
-  // IOExpander node.  As it is a blocking request, we can use buffers allocated from
-  // the stack to save RAM allocation.
   void _write(VPIN vpin, int value) override {
-    uint8_t digitalOutBuffer[3];
-    uint8_t responseBuffer[1];
     if (_deviceState == DEVSTATE_FAILED) return;
     int pin = vpin - _firstVpin;
-    digitalOutBuffer[0] = EXIOWRD;
-    digitalOutBuffer[1] = pin;
-    digitalOutBuffer[2] = value;
-    uint8_t status = I2CManager.read(_I2CAddress, responseBuffer, 1, digitalOutBuffer, 3);
-    if (status != I2C_STATUS_OK) {
-      reportError(status);
-    } else {
-      if (responseBuffer[0] != EXIORDY) {
-        DIAG(F("Vpin %u cannot be used as a digital output pin"), (int)vpin);
-      }
+    _digitalOutBuffer[0] = EXIOWRD;
+    _digitalOutBuffer[1] = pin;
+    _digitalOutBuffer[2] = value;
+    I2CManager.read(_i2cAddress, _command1Buffer, 1, _digitalOutBuffer, 3);
+    if (_command1Buffer[0] != EXIORDY) {
+      DIAG(F("Vpin %d cannot be used as a digital output pin"), (int)vpin);
     }
   }
 
-  // Write analogue (integer) value.  Write the parameters (blocking I2C) to the
-  // IOExpander node.  As it is a blocking request, we can use buffers allocated from
-  // the stack to reduce RAM allocation.
   void _writeAnalogue(VPIN vpin, int value, uint8_t profile, uint16_t duration) override {
-    uint8_t servoBuffer[7];
-    uint8_t responseBuffer[1];
-
     if (_deviceState == DEVSTATE_FAILED) return;
     int pin = vpin - _firstVpin;
 #ifdef DIAG_IO
-    DIAG(F("Servo: WriteAnalogue Vpin:%u Value:%d Profile:%d Duration:%d %S"), 
+    DIAG(F("Servo: WriteAnalogue Vpin:%d Value:%d Profile:%d Duration:%d %S"), 
       vpin, value, profile, duration, _deviceState == DEVSTATE_FAILED?F("DEVSTATE_FAILED"):F(""));
 #endif
-    servoBuffer[0] = EXIOWRAN;
-    servoBuffer[1] = pin;
-    servoBuffer[2] = value & 0xFF;
-    servoBuffer[3] = value >> 8;
-    servoBuffer[4] = profile;
-    servoBuffer[5] = duration & 0xFF;
-    servoBuffer[6] = duration >> 8;
-    uint8_t status = I2CManager.read(_I2CAddress, responseBuffer, 1, servoBuffer, 7);
-    if (status != I2C_STATUS_OK) {
-      DIAG(F("EX-IOExpander I2C:%s Error:%d %S"), _I2CAddress.toString(), status, I2CManager.getErrorMessage(status));
-      _deviceState = DEVSTATE_FAILED;
-    } else {
-      if (responseBuffer[0] != EXIORDY) {
-        DIAG(F("Vpin %u cannot be used as a servo/PWM pin"), (int)vpin);
-      }
+    _servoBuffer[0] = EXIOWRAN;
+    _servoBuffer[1] = pin;
+    _servoBuffer[2] = value & 0xFF;
+    _servoBuffer[3] = value >> 8;
+    _servoBuffer[4] = profile;
+    _servoBuffer[5] = duration & 0xFF;
+    _servoBuffer[6] = duration >> 8;
+    I2CManager.read(_i2cAddress, _command1Buffer, 1, _servoBuffer, 7);
+    if (_command1Buffer[0] != EXIORDY) {
+      DIAG(F("Vpin %d cannot be used as a servo/PWM pin"), (int)vpin);
     }
   }
 
-  // Display device information and status.
   void _display() override {
-    DIAG(F("EX-IOExpander I2C:%s v%d.%d.%d Vpins %u-%u %S"),
-              _I2CAddress.toString(), _majorVer, _minorVer, _patchVer,
+    DIAG(F("EX-IOExpander I2C:x%x v%d.%d.%d Vpins %d-%d %S"),
+              _i2cAddress, _majorVer, _minorVer, _patchVer,
               (int)_firstVpin, (int)_firstVpin+_nPins-1,
               _deviceState == DEVSTATE_FAILED ? F("OFFLINE") : F(""));
   }
 
-  // Helper function for error handling
-  void reportError(uint8_t status, bool fail=true) {
-    DIAG(F("EX-IOExpander I2C:%s Error:%d (%S)"), _I2CAddress.toString(), 
-      status, I2CManager.getErrorMessage(status));
-    if (fail)
-    _deviceState = DEVSTATE_FAILED;
-  }
-
+  uint8_t _i2cAddress;
   uint8_t _numDigitalPins = 0;
   uint8_t _numAnaloguePins = 0;
-
+  byte _digitalOutBuffer[3];
+  uint8_t _versionBuffer[3];
   uint8_t _majorVer = 0;
   uint8_t _minorVer = 0;
   uint8_t _patchVer = 0;
-
-  uint8_t* _digitalInputStates  = NULL;
-  uint8_t* _analogueInputStates = NULL;
-  uint8_t* _analogueInputBuffer = NULL;  // buffer for I2C input transfers
-  uint8_t _readCommandBuffer[1];
-
-  uint8_t _digitalPinBytes = 0;   // Size of allocated memory buffer (may be longer than needed)
-  uint8_t _analoguePinBytes = 0;  // Size of allocated memory buffer (may be longer than needed)
-  uint8_t* _analoguePinMap = NULL;
-  I2CRB _i2crb;
-
-  enum {RDS_IDLE, RDS_DIGITAL, RDS_ANALOGUE};  // Read operation states
-  uint8_t _readState = RDS_IDLE;
-  
-  unsigned long _lastDigitalRead = 0;
-  unsigned long _lastAnalogueRead = 0;
-  const unsigned long _digitalRefresh = 10000UL;    // Delay refreshing digital inputs for 10ms
-  const unsigned long _analogueRefresh = 50000UL;   // Delay refreshing analogue inputs for 50ms
+  byte* _digitalInputStates;
+  byte* _analogueInputStates;
+  uint8_t _digitalPinBytes = 0;
+  uint8_t _analoguePinBytes = 0;
+  byte _command1Buffer[1];
+  byte _command2Buffer[2];
+  byte _command4Buffer[4];
+  byte _receive3Buffer[3];
+  byte _servoBuffer[7];
+  uint8_t* _analoguePinMap;
 
   // EX-IOExpander protocol flags
   enum {

IO_EXTurntable.h

@@ -20,46 +20,42 @@
 /*
 * The IO_EXTurntable device driver is used to control a turntable via an Arduino with a stepper motor over I2C.
 *
-* The EX-Turntable code lives in a separate repo (https://github.com/DCC-EX/EX-Turntable) and contains the stepper motor logic.
+* The EX-Turntable code lives in a separate repo (https://github.com/DCC-EX/Turntable-EX) and contains the stepper motor logic.
 *
-* This device driver sends a step position to EX-Turntable to indicate the step position to move to using either of these commands:
+* This device driver sends a step position to Turntable-EX to indicate the step position to move to using either of these commands:
 * <D TT vpin steps activity> in the serial console
 * MOVETT(vpin, steps, activity) in EX-RAIL
 * Refer to the documentation for further information including the valid activities.
 */
 
+#ifndef IO_EXTurntable_h
+#define IO_EXTurntable_h
+
 #include "IODevice.h"
 #include "I2CManager.h"
 #include "DIAG.h"
-#include "Turntables.h"
-#include "CommandDistributor.h"
 
-#ifndef IO_NO_HAL
-
-void EXTurntable::create(VPIN firstVpin, int nPins, I2CAddress I2CAddress) {
+void EXTurntable::create(VPIN firstVpin, int nPins, uint8_t I2CAddress) {
   new EXTurntable(firstVpin, nPins, I2CAddress);
 }
 
 // Constructor
-EXTurntable::EXTurntable(VPIN firstVpin, int nPins, I2CAddress I2CAddress) {
+EXTurntable::EXTurntable(VPIN firstVpin, int nPins, uint8_t I2CAddress) {
   _firstVpin = firstVpin;
   _nPins = nPins;
   _I2CAddress = I2CAddress;
-  _stepperStatus = 0;
-  _previousStatus = 0;
   addDevice(this);
 }
 
 // Initialisation of EXTurntable
 void EXTurntable::_begin() {
   I2CManager.begin();
+  I2CManager.setClock(1000000);
   if (I2CManager.exists(_I2CAddress)) {
-    DIAG(F("EX-Turntable device found, I2C:%s"), _I2CAddress.toString());
 #ifdef DIAG_IO
     _display();
 #endif
   } else {
-    DIAG(F("EX-Turntable I2C:%s device not found"), _I2CAddress.toString());
     _deviceState = DEVSTATE_FAILED;
   }
 }
@@ -71,19 +67,15 @@ void EXTurntable::_loop(unsigned long currentMicros) {
   uint8_t readBuffer[1];
   I2CManager.read(_I2CAddress, readBuffer, 1);
   _stepperStatus = readBuffer[0];
-  if (_stepperStatus != _previousStatus && _stepperStatus == 0) { // Broadcast when a rotation finishes
-    if ( _currentActivity < 4) {
-      _broadcastStatus(_firstVpin, _stepperStatus, _currentActivity);
-    }
-    _previousStatus = _stepperStatus;
-  }
-  delayUntil(currentMicros + 100000);  // Wait 100ms before checking again
+  // DIAG(F("Turntable-EX returned status: %d"), _stepperStatus);
+  delayUntil(currentMicros + 500000);  // Wait 500ms before checking again, turntables turn slowly
 }
 
 // Read returns status as obtained in our loop.
 // Return false if our status value is invalid.
 int EXTurntable::_read(VPIN vpin) {
   if (_deviceState == DEVSTATE_FAILED) return 0;
+  // DIAG(F("_read status: %d"), _stepperStatus);
   if (_stepperStatus > 1) {
     return false;
   } else {
@@ -91,17 +83,6 @@ int EXTurntable::_read(VPIN vpin) {
   }
 }
 
-// If a status change has occurred for a turntable object, broadcast it
-void EXTurntable::_broadcastStatus (VPIN vpin, uint8_t status, uint8_t activity) {
-  Turntable *tto = Turntable::getByVpin(vpin);
-  if (tto) {
-    if (activity < 4) {
-      tto->setMoving(status);
-      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.
@@ -119,25 +100,21 @@ void EXTurntable::_broadcastStatus (VPIN vpin, uint8_t status, uint8_t activity)
 // Acc_Off = 9           // Turn accessory pin off
 void EXTurntable::_writeAnalogue(VPIN vpin, int value, uint8_t activity, uint16_t duration) {
   if (_deviceState == DEVSTATE_FAILED) return;
-  if (value < 0) return;
   uint8_t stepsMSB = value >> 8;
   uint8_t stepsLSB = value & 0xFF;
 #ifdef DIAG_IO
-  DIAG(F("EX-Turntable WriteAnalogue VPIN:%u Value:%d Activity:%d Duration:%d"),
+  DIAG(F("EX-Turntable WriteAnalogue Vpin:%d Value:%d Activity:%d Duration:%d"),
     vpin, value, activity, duration);
   DIAG(F("I2CManager write I2C Address:%d stepsMSB:%d stepsLSB:%d activity:%d"),
-    _I2CAddress.toString(), stepsMSB, stepsLSB, activity);
+    _I2CAddress, stepsMSB, stepsLSB, activity);
 #endif
-  if (activity < 4) _stepperStatus = 1;     // Tell the device driver Turntable-EX is busy
-  _previousStatus = _stepperStatus;
-  _currentActivity = activity;
-  _broadcastStatus(vpin, _stepperStatus, activity); // Broadcast when the rotation starts
+  _stepperStatus = 1;     // Tell the device driver Turntable-EX is busy
   I2CManager.write(_I2CAddress, 3, stepsMSB, stepsLSB, activity);
 }
 
 // Display Turnetable-EX device driver info.
 void EXTurntable::_display() {
-  DIAG(F("EX-Turntable I2C:%s Configured on Vpins:%u-%u %S"), _I2CAddress.toString(), (int)_firstVpin, 
+  DIAG(F("EX-Turntable I2C:x%x Configured on Vpins:%d-%d %S"), _I2CAddress, (int)_firstVpin, 
     (int)_firstVpin+_nPins-1, (_deviceState==DEVSTATE_FAILED) ? F("OFFLINE") : F(""));
 }
 

IO_ExampleSerial.cpp

@@ -0,0 +1,129 @@
+/*
+ *  © 2021, 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/>.
+ */
+
+#include <Arduino.h>
+#include "IO_ExampleSerial.h"
+#include "FSH.h"
+
+// Constructor
+IO_ExampleSerial::IO_ExampleSerial(VPIN firstVpin, int nPins, HardwareSerial *serial, unsigned long baud) {
+  _firstVpin = firstVpin;
+  _nPins = nPins;
+  _pinValues = (uint16_t *)calloc(_nPins, sizeof(uint16_t));
+  _baud = baud;
+  
+  // Save reference to serial port driver
+  _serial = serial;
+
+  addDevice(this);
+}
+
+// Static create method for one module.
+void IO_ExampleSerial::create(VPIN firstVpin, int nPins, HardwareSerial *serial, unsigned long baud) {
+  if (checkNoOverlap(firstVpin,nPins)) new IO_ExampleSerial(firstVpin, nPins, serial, baud);
+}
+
+// Device-specific initialisation
+void IO_ExampleSerial::_begin() {
+  _serial->begin(_baud);
+#if defined(DIAG_IO)
+  _display();
+#endif
+
+  // Send a few # characters to the output
+  for (uint8_t i=0; i<3; i++)
+    _serial->write('#');
+}
+
+// Device-specific write function.  Write a string in the form "#Wm,n#"
+//  where m is the vpin number, and n is the value.
+void IO_ExampleSerial::_write(VPIN vpin, int value) {
+  int pin = vpin -_firstVpin;
+  #ifdef DIAG_IO
+  DIAG(F("IO_ExampleSerial::_write Pin:%d Value:%d"), (int)vpin, value);
+  #endif
+  // Send a command string over the serial line
+  _serial->print('#');
+  _serial->print('W');
+  _serial->print(pin);
+  _serial->print(',');
+  _serial->print(value);
+  _serial->println('#');
+  DIAG(F("ExampleSerial Sent command, p1=%d, p2=%d"), vpin, value);
+ }
+
+// Device-specific read function.
+int IO_ExampleSerial::_read(VPIN vpin) {
+
+  // Return a value for the specified vpin.
+  int result = _pinValues[vpin-_firstVpin];
+
+  return result;
+}
+
+// Loop function to do background scanning of the input port.  State 
+//  machine parses the incoming command as it is received.  Command
+//  is in the form "#Nm,n#" where m is the index and n is the value.
+void IO_ExampleSerial::_loop(unsigned long currentMicros) {
+  (void)currentMicros;  // Suppress compiler warnings
+  if (_serial->available()) {
+    // Input data available to read.  Read a character.
+    char c = _serial->read();
+    switch (_inputState) {
+      case 0: // Waiting for start of command
+        if (c == '#')  // Start of command received.
+          _inputState = 1;
+        break;
+      case 1: // Expecting command character
+        if (c == 'N') { // 'Notify' character received
+          _inputState = 2;
+          _inputValue = _inputIndex = 0;
+        } else
+          _inputState = 0; // Unexpected char, reset
+        break;
+      case 2: // reading first parameter (index)
+        if (isdigit(c))
+          _inputIndex = _inputIndex * 10 + (c-'0');
+        else if (c==',') 
+          _inputState = 3;
+        else
+          _inputState = 0; // Unexpected char, reset
+        break;
+      case 3: // reading reading second parameter (value)
+        if (isdigit(c)) 
+          _inputValue = _inputValue * 10 - (c-'0');
+        else if (c=='#') { // End of command
+          // Complete command received, do something with it.
+          DIAG(F("ExampleSerial Received command, p1=%d, p2=%d"), _inputIndex, _inputValue);
+          if (_inputIndex < _nPins) { // Store value
+            _pinValues[_inputIndex] = _inputValue;
+          }
+          _inputState = 0; // Done, start again.
+        } else
+          _inputState = 0; // Unexpected char, reset
+        break;
+    }
+  }
+}
+
+void IO_ExampleSerial::_display() {
+  DIAG(F("IO_ExampleSerial Configured on VPins:%d-%d"), (int)_firstVpin, 
+    (int)_firstVpin+_nPins-1);
+}
+

IO_ExampleSerial.h

@@ -35,131 +35,24 @@
 #include "IODevice.h"
 
 class IO_ExampleSerial : public IODevice {
+public:
+  static void create(VPIN firstVpin, int nPins, HardwareSerial *serial, unsigned long baud);  
+
+protected:
+  IO_ExampleSerial(VPIN firstVpin, int nPins, HardwareSerial *serial, unsigned long baud);
+  void _begin() override;
+  void _loop(unsigned long currentMicros) override;
+  void _write(VPIN vpin, int value) override;
+  int _read(VPIN vpin) override;
+  void _display() override;
+
 private:
-  // Here we define the device-specific variables.  
   HardwareSerial *_serial;
   uint8_t _inputState = 0;
   int _inputIndex = 0;
   int _inputValue = 0;
   uint16_t *_pinValues; // Pointer to block of memory containing pin values
   unsigned long _baud;
-
-public:
-  //  Static function to handle "IO_ExampleSerial::create(...)" calls.
-  static void create(VPIN firstVpin, int nPins, HardwareSerial *serial, unsigned long baud) {
-    if (checkNoOverlap(firstVpin,nPins)) new IO_ExampleSerial(firstVpin, nPins, serial, baud);
-  } 
-
-protected:
-  // Constructor.  This should initialise variables etc. but not call other objects yet
-  // (e.g. Serial, I2CManager, and other parts of the CS functionality).
-  // defer those until the _begin() function.  The 'addDevice' call is required unless
-  // the device is not to be added (e.g. because of incorrect parameters).
-  IO_ExampleSerial(VPIN firstVpin, int nPins, HardwareSerial *serial, unsigned long baud) {
-    _firstVpin = firstVpin;
-    _nPins = nPins;
-    _pinValues = (uint16_t *)calloc(_nPins, sizeof(uint16_t));
-    _baud = baud;
-    
-    // Save reference to serial port driver
-    _serial = serial;
-
-    addDevice(this);
-  }
-
-  // Device-specific initialisation
-  void _begin() override {
-    _serial->begin(_baud);
-#if defined(DIAG_IO)
-    _display();
-#endif
-
-    // Send a few # characters to the output
-    for (uint8_t i=0; i<3; i++)
-      _serial->write('#');
-  }
-  
-  // Device-specific write function.  Write a string in the form "#Wm,n#"
-  //  where m is the vpin number, and n is the value.
-  void _write(VPIN vpin, int value) {
-    int pin = vpin -_firstVpin;
-    #ifdef DIAG_IO
-    DIAG(F("IO_ExampleSerial::_write VPIN:%u Value:%d"), (int)vpin, value);
-    #endif
-    // Send a command string over the serial line
-    _serial->print('#');
-    _serial->print('W');
-    _serial->print(pin);
-    _serial->print(',');
-    _serial->print(value);
-    _serial->println('#');
-    DIAG(F("ExampleSerial Sent command, p1=%d, p2=%d"), vpin, value);
-  }
-
-  // Device-specific read function.
-  int _read(VPIN vpin) {
-
-    // Return a value for the specified vpin.
-    int result = _pinValues[vpin-_firstVpin];
-
-    return result;
-  }
-
-  // Loop function to do background scanning of the input port.  State 
-  //  machine parses the incoming command as it is received.  Command
-  //  is in the form "#Nm,n#" where m is the index and n is the value.
-  void _loop(unsigned long currentMicros) {
-    (void)currentMicros;  // Suppress compiler warnings
-    if (_serial->available()) {
-      // Input data available to read.  Read a character.
-      char c = _serial->read();
-      switch (_inputState) {
-        case 0: // Waiting for start of command
-          if (c == '#')  // Start of command received.
-            _inputState = 1;
-          break;
-        case 1: // Expecting command character
-          if (c == 'N') { // 'Notify' character received
-            _inputState = 2;
-            _inputValue = _inputIndex = 0;
-          } else
-            _inputState = 0; // Unexpected char, reset
-          break;
-        case 2: // reading first parameter (index)
-          if (isdigit(c))
-            _inputIndex = _inputIndex * 10 + (c-'0');
-          else if (c==',') 
-            _inputState = 3;
-          else
-            _inputState = 0; // Unexpected char, reset
-          break;
-        case 3: // reading reading second parameter (value)
-          if (isdigit(c)) 
-            _inputValue = _inputValue * 10 - (c-'0');
-          else if (c=='#') { // End of command
-            // Complete command received, do something with it.
-            DIAG(F("ExampleSerial Received command, p1=%d, p2=%d"), _inputIndex, _inputValue);
-            if (_inputIndex >= 0 && _inputIndex < _nPins) { // Store value
-              _pinValues[_inputIndex] = _inputValue;
-            }
-            _inputState = 0; // Done, start again.
-          } else
-            _inputState = 0; // Unexpected char, reset
-          break;
-      }
-    }
-  }
-
-  // Display information about the device, and perhaps its current condition (e.g. active, disabled etc).
-  // Here we display the current values held for the pins.
-  void _display() {
-    DIAG(F("IO_ExampleSerial Configured on Vpins:%u-%u"), (int)_firstVpin, 
-      (int)_firstVpin+_nPins-1);
-    for (int i=0; i<_nPins; i++)
-      DIAG(F("  VPin %2u: %d"), _firstVpin+i, _pinValues[i]);
-  }
-
-
 };
 
 #endif // IO_EXAMPLESERIAL_H

IO_GPIOBase.h

@@ -34,7 +34,7 @@ class GPIOBase : public IODevice {
 
 protected:
   // Constructor
-  GPIOBase(FSH *deviceName, VPIN firstVpin, uint8_t nPins, I2CAddress i2cAddress, int interruptPin);
+  GPIOBase(FSH *deviceName, VPIN firstVpin, uint8_t nPins, uint8_t I2CAddress, int interruptPin);
   // Device-specific initialisation
   void _begin() override;
   // Device-specific pin configuration function.  
@@ -49,13 +49,13 @@ protected:
   // Data fields
  
   // Allocate enough space for all input pins
-  T _portInputState; // 1=high (inactive), 0=low (activated)
-  T _portOutputState; // 1 =high, 0=low
-  T _portMode;  // 0=input, 1=output
-  T _portPullup; // 0=nopullup, 1=pullup
-  T _portInUse;  // 0=not in use, 1=in use
-  // Target interval between refreshes of each input port
-  static const int _portTickTime = 4000; // 4ms
+  T _portInputState; 
+  T _portOutputState;
+  T _portMode;
+  T _portPullup;
+  T _portInUse;
+  // Interval between refreshes of each input port
+  static const int _portTickTime = 4000;
 
   // Virtual functions for interfacing with I2C GPIO Device
   virtual void _writeGpioPort() = 0;
@@ -69,6 +69,10 @@ protected:
 
   I2CRB requestBlock;
   FSH *_deviceName;
+#if defined(ARDUINO_ARCH_ESP32)
+  // workaround: Has somehow no min function for all types
+  static inline T min(T a, int b) { return a < b ? a : b; };
+#endif
 };
 
 // Because class GPIOBase is a template, the implementation (below) must be contained within the same
@@ -76,21 +80,15 @@ protected:
 
 // Constructor
 template <class T>
-GPIOBase<T>::GPIOBase(FSH *deviceName, VPIN firstVpin, uint8_t nPins, I2CAddress i2cAddress, int interruptPin) :
+GPIOBase<T>::GPIOBase(FSH *deviceName, VPIN firstVpin, uint8_t nPins, uint8_t I2CAddress, int interruptPin) :
   IODevice(firstVpin, nPins)
 {
-  if (_nPins > (int)sizeof(T)*8) _nPins = sizeof(T)*8;  // Ensure nPins is consistent with the number of bits in T
   _deviceName = deviceName;
-  _I2CAddress = i2cAddress;
+  _I2CAddress = I2CAddress;
   _gpioInterruptPin = interruptPin;
   _hasCallback = true;
   // Add device to list of devices.
   addDevice(this);
-
-  _portMode = 0;  // default to input mode
-  _portPullup = -1; // default to pullup enabled
-  _portInputState = -1;  // default to all inputs high (inactive)
-  _portInUse = 0;  // No ports in use initially.
 }
 
 template <class T>
@@ -105,16 +103,21 @@ void GPIOBase<T>::_begin() {
 #if defined(DIAG_IO)
     _display();
 #endif
+    _portMode = 0;  // default to input mode
+    _portPullup = -1; // default to pullup enabled
+    _portInputState = -1;
+    _portInUse = 0;
     _setupDevice();
     _deviceState = DEVSTATE_NORMAL;
   } else {
-    DIAG(F("%S I2C:%s Device not detected"), _deviceName, _I2CAddress.toString());
+    DIAG(F("%S I2C:x%x Device not detected"), _deviceName, _I2CAddress);
     _deviceState = DEVSTATE_FAILED;
   }
 }
 
 // Configuration parameters for inputs: 
 //  params[0]: enable pullup
+//  params[1]: invert input (optional)
 template <class T>
 bool GPIOBase<T>::_configure(VPIN vpin, ConfigTypeEnum configType, int paramCount, int params[]) {
   if (configType != CONFIGURE_INPUT) return false;
@@ -122,7 +125,7 @@ bool GPIOBase<T>::_configure(VPIN vpin, ConfigTypeEnum configType, int paramCoun
   bool pullup = params[0];
   int pin = vpin - _firstVpin;
   #ifdef DIAG_IO
-  DIAG(F("%S I2C:%s Config Pin:%d Val:%d"), _deviceName, _I2CAddress.toString(), pin, pullup);
+  DIAG(F("%S I2C:x%x Config Pin:%d Val:%d"), _deviceName, _I2CAddress, pin, pullup);
   #endif
   uint16_t mask = 1 << pin;
   if (pullup) 
@@ -152,7 +155,7 @@ void GPIOBase<T>::_loop(unsigned long currentMicros) {
       _deviceState = DEVSTATE_NORMAL;
     } else {
       _deviceState = DEVSTATE_FAILED;
-      DIAG(F("%S I2C:%s Error:%d %S"), _deviceName, _I2CAddress.toString(), status, 
+      DIAG(F("%S I2C:x%x Error:%d %S"), _deviceName, _I2CAddress, status, 
         I2CManager.getErrorMessage(status));
     }
     _processCompletion(status);
@@ -175,7 +178,7 @@ void GPIOBase<T>::_loop(unsigned long currentMicros) {
 
     #ifdef DIAG_IO
     if (differences)
-      DIAG(F("%S I2C:%s PortStates:%x"), _deviceName, _I2CAddress.toString(), _portInputState);
+      DIAG(F("%S I2C:x%x PortStates:%x"), _deviceName, _I2CAddress, _portInputState);
     #endif
   }
 
@@ -196,7 +199,7 @@ void GPIOBase<T>::_loop(unsigned long currentMicros) {
 
 template <class T>
 void GPIOBase<T>::_display() {
-  DIAG(F("%S I2C:%s Configured on Vpins:%u-%u %S"), _deviceName, _I2CAddress.toString(), 
+  DIAG(F("%S I2C:x%x Configured on Vpins:%d-%d %S"), _deviceName, _I2CAddress, 
     _firstVpin, _firstVpin+_nPins-1, (_deviceState==DEVSTATE_FAILED) ? F("OFFLINE") : F(""));
 }
 
@@ -205,7 +208,7 @@ void GPIOBase<T>::_write(VPIN vpin, int value) {
   int pin = vpin - _firstVpin;
   T mask = 1 << pin;
   #ifdef DIAG_IO
-  DIAG(F("%S I2C:%s Write Pin:%d Val:%d"), _deviceName, _I2CAddress.toString(), pin, value);
+  DIAG(F("%S I2C:x%x Write Pin:%d Val:%d"), _deviceName, _I2CAddress, pin, value);
   #endif
 
   // Set port mode output if currently not output mode
@@ -241,7 +244,7 @@ int GPIOBase<T>::_read(VPIN vpin) {
   // Set unused pin and write mode pin value to 1
     _portInputState |= ~_portInUse | _portMode;
     #ifdef DIAG_IO
-    DIAG(F("%S I2C:%s PortStates:%x"), _deviceName, _I2CAddress.toString(), _portInputState);
+    DIAG(F("%S I2C:x%x PortStates:%x"), _deviceName, _I2CAddress, _portInputState);
     #endif
   }
   return (_portInputState & mask) ? 0 : 1;  // Invert state (5v=0, 0v=1)

IO_HALDisplay.h

@@ -1,262 +0,0 @@
-/*
- *  © 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/>.
- */
-
-/* 
- * This driver provides a more immediate interface into the OLED display
- * than the one installed through the config.h file.  When an LCD(...) call
- * is made, the text is output immediately to the specified display line,
- * without waiting for the next 2.5 second refresh.  However, if the line 
- * specified is off the screen then the text in the bottom line will be 
- * overwritten.  There is however a special case that if line 255 is specified, 
- * the existing text will scroll up and the new line added to the bottom
- * line of the screen.
- * 
- * To install, use the following command in myHal.cpp:
- *
- *    HALDisplay<OLED>::create(address, width, height);
- * 
- * where address is the I2C address of the OLED display (0x3c or 0x3d),
- * width is the width in pixels, and height is the height in pixels.
- * 
- * Valid width and height are 128x32 (SSD1306 controller), 
- * 128x64 (SSD1306) and 132x64 (SH1106).  The driver uses
- * a 5x7 character set in a 6x8 pixel cell.
- * 
- * OR
- * 
- *    HALDisplay<LiquidCrystal>::create(address, width, height);
- * 
- * where address is the I2C address of the LCD display (0x27 typically),
- * width is the width in characters (16 or 20 typically),
- * and height is the height in characters (2 or 4 typically).
- */
-
-
-#ifndef IO_HALDisplay_H
-#define IO_HALDisplay_H
-
-#include "IODevice.h"
-#include "DisplayInterface.h"
-#include "SSD1306Ascii.h"
-#include "LiquidCrystal_I2C.h"
-#include "version.h"
-
-typedef SSD1306AsciiWire OLED;
-typedef LiquidCrystal_I2C LiquidCrystal; 
-
-template <class T> 
-class HALDisplay : public IODevice, public DisplayInterface {
-private:
-  // Here we define the device-specific variables.  
-  uint8_t _height; // in pixels
-  uint8_t _width;  // in pixels
-  T *_displayDriver;
-  uint8_t _rowNo = 0;   // Row number being written by caller
-  uint8_t _colNo = 0;  // Position in line being written by caller
-  uint8_t _numRows;
-  uint8_t _numCols;
-  char *_buffer = NULL;
-  uint8_t *_rowGeneration = NULL;
-  uint8_t *_lastRowGeneration = NULL;
-  uint8_t _rowNoToScreen = 0; 
-  uint8_t _charPosToScreen = 0;
-  bool _startAgain = false;
-  DisplayInterface *_nextDisplay = NULL;
-
-public:
-  //  Static function to handle "HALDisplay::create(...)" calls.
-  static void create(I2CAddress i2cAddress, int width, int height) {
-    if (checkNoOverlap(0, 0, i2cAddress)) new HALDisplay(0, i2cAddress, width, height);
-  } 
-  static void create(uint8_t displayNo, I2CAddress i2cAddress, int width, int height) {
-    if (checkNoOverlap(0, 0, i2cAddress)) new HALDisplay(displayNo, i2cAddress, width, height);
-  } 
-
-protected:
-  // Constructor
-  HALDisplay(uint8_t displayNo, I2CAddress i2cAddress, int width, int height) {
-    _displayDriver = new T(i2cAddress, width, height);
-    if (!_displayDriver) return;  // Check for memory allocation failure
-    _I2CAddress = i2cAddress;
-    _width = width;
-    _height = height;
-    _numCols = _displayDriver->getNumCols();
-    _numRows = _displayDriver->getNumRows();
-
-    _charPosToScreen = _numCols;
-
-    // Allocate arrays
-    _buffer = (char *)calloc(_numRows*_numCols, sizeof(char));
-    if (!_buffer) return;  // Check for memory allocation failure
-    _rowGeneration = (uint8_t *)calloc(_numRows, sizeof(uint8_t));
-    if (!_rowGeneration) return;  // Check for memory allocation failure
-    _lastRowGeneration = (uint8_t *)calloc(_numRows, sizeof(uint8_t));
-    if (!_lastRowGeneration) return;  // Check for memory allocation failure
-
-    // Fill buffer with spaces
-    memset(_buffer, ' ', _numCols*_numRows);
-
-    _displayDriver->clearNative();
-
-    // Add device to list of HAL devices (not necessary but allows
-    // status to be displayed using <D HAL SHOW> and device to be
-    // reinitialised using <D HAL RESET>).
-    IODevice::addDevice(this);
-
-    // Also add this display to list of display handlers
-    DisplayInterface::addDisplay(displayNo);
-
-    // Is this the system display (0)?
-    if (displayNo == 0) {
-      // Set first two lines on screen
-      this->setRow(displayNo, 0);
-      print(F("DCC-EX v"));
-      print(F(VERSION));
-      setRow(displayNo, 1);
-      print(F("Lic GPLv3"));
-    }
-  }
-  
-  
-  void screenUpdate() {
-    // Loop through the buffer and if a row has changed
-    // (rowGeneration[row] is changed) then start writing the
-    // characters from the buffer, one character per entry, 
-    // to the screen until that row has been refreshed.
-
-    // First check if the OLED driver is still busy from a previous 
-    // call.  If so, don't do anything until the next entry.
-    if (!_displayDriver->isBusy()) {
-      // Check if we've just done the end of a row
-      if (_charPosToScreen >= _numCols) {
-        // Move to next line
-        if (++_rowNoToScreen >= _numRows || _startAgain) {
-          _rowNoToScreen = 0; // Wrap to first row
-          _startAgain = false;
-        }
-
-        if (_rowGeneration[_rowNoToScreen] != _lastRowGeneration[_rowNoToScreen]) {
-          // Row content has changed, so start outputting it
-          _lastRowGeneration[_rowNoToScreen] = _rowGeneration[_rowNoToScreen];
-          _displayDriver->setRowNative(_rowNoToScreen);
-          _charPosToScreen = 0;  // Prepare to output first character on next entry
-        } else {
-          // Row not changed, don't bother writing it.
-        }
-      } else {
-        // output character at current position
-        _displayDriver->writeNative(_buffer[_rowNoToScreen*_numCols+_charPosToScreen++]);
-      }  
-    }
-    return;
-  }
-
-  /////////////////////////////////////////////////
-  // IODevice Class Member Overrides
-  /////////////////////////////////////////////////
-
-  // Device-specific initialisation
-  void _begin() override {
-    // Initialise device
-    if (_displayDriver->begin()) {
-
-      _display();
-
-      // Force all rows to be redrawn
-      for (uint8_t row=0; row<_numRows; row++)
-        _rowGeneration[row]++;
-      
-      // Start with top line (looks better).  
-      // The numbers will wrap round on the first loop2 entry.
-      _rowNoToScreen = _numRows;
-      _charPosToScreen = _numCols;
-    }
-  }
-
-  void _loop(unsigned long) override {
-    screenUpdate();
-  }
-  
-  // Display information about the device.
-  void _display() {
-    DIAG(F("HALDisplay %d configured on addr %s"), _displayNo, _I2CAddress.toString());
-  }
-  
-  /////////////////////////////////////////////////
-  // DisplayInterface functions
-  // 
-  /////////////////////////////////////////////////
-  
-public:
-  void _displayLoop() override {
-    screenUpdate();
-  }
-
-  // Position on nominated line number (0 to number of lines -1)
-  // Clear the line in the buffer ready for updating
-  // The displayNo referenced here is remembered and any following
-  // calls to write() will be directed to that display.
-  void _setRow(byte line) override {
-    if (line == 255) {
-      // LCD(255,"xxx") or SCREEN(displayNo,255, "xxx") - 
-      // scroll the contents of the buffer and put the new line
-      // at the bottom of the screen
-      for (int row=1; row<_numRows; row++) {
-        strncpy(&_buffer[(row-1)*_numCols], &_buffer[row*_numCols], _numCols);
-        _rowGeneration[row-1]++;
-      }
-      line = _numRows-1;
-    } else if (line >= _numRows) 
-      line = _numRows - 1;  // Overwrite bottom line.
-
-    _rowNo = line;
-    // Fill line with blanks
-    for (_colNo = 0; _colNo < _numCols; _colNo++)
-      _buffer[_rowNo*_numCols+_colNo] = ' ';
-    _colNo = 0;
-    // Mark that the buffer has been touched.  It will start being 
-    // sent to the screen on the next loop entry, by which time
-    // the line should have been written to the buffer.
-    _rowGeneration[_rowNo]++;
-    // Indicate that the output loop is to start updating the screen again from
-    // row 0.  Otherwise, on a full screen rewrite the bottom part may be drawn
-    // before the top part!
-    _startAgain = true;
-  }
-
-  // Write one character to the screen referenced in the last setRow() call.
-  virtual size_t _write(uint8_t c) override {
-    // Write character to buffer (if there's space)
-    if (_colNo < _numCols) {
-      _buffer[_rowNo*_numCols+_colNo++] = c;
-    }
-    return 1;
-  }
-
-  // Write blanks to all of the screen buffer
-  void _clear() {
-    // Clear buffer
-    memset(_buffer, ' ', _numCols*_numRows);
-    _colNo = 0;
-    _rowNo = 0;
-  }
-
-};
-
-#endif // IO_HALDisplay_H

IO_HCSR04.h

@@ -30,7 +30,7 @@
  *
  * This driver polls the HC-SR04 by sending the trigger pulse and then measuring
  * the length of the received pulse.  If the calculated distance is less than
- * the threshold, the output _state returned by a read() call changes to 1.  If
+ * the threshold, the output state returned by a read() call changes to 1.  If
  * the distance is greater than the threshold plus a hysteresis margin, the
  * output changes to 0. The device also supports readAnalogue(), which returns
  * the measured distance in cm, or 32767 if the distance exceeds the
@@ -48,20 +48,6 @@
  * Note: The timing accuracy required for measuring the pulse length means that
  * the pins have to be direct Arduino pins; GPIO pins on an IO Extender cannot
  * provide the required accuracy.
- * 
- * Example configuration:
- *  HCSR04::create(23000, 32, 33, 80, 85);
- * 
- * Where 23000 is the VPIN allocated,
- *       32 is the pin connected to the HCSR04 trigger terminal,
- *       33 is the pin connected to the HCSR04 echo terminal,
- *       80 is the distance in cm below which pin 23000 will be active,
- *   and 85 is the distance in cm above which pin 23000 will be inactive.
- * 
- * Alternative configuration, which hogs the processor until the measurement is complete
- * (old behaviour, more accurate but higher impact on other CS tasks):
- *  HCSR04::create(23000, 32, 33, 80, 85, HCSR04::LOOP);
- * 
  */
 
 #ifndef IO_HCSR04_H
@@ -75,52 +61,38 @@ private:
   // pins must be arduino GPIO pins, not extender pins or HAL pins.
   int _trigPin = -1;
   int _echoPin = -1;
-  // Thresholds for setting active _state in cm.
+  // Thresholds for setting active state in cm.
   uint8_t _onThreshold;  // cm
   uint8_t _offThreshold; // cm
   // Last measured distance in cm.
   uint16_t _distance;
-  // Active=1/inactive=0 _state 
+  // Active=1/inactive=0 state 
   uint8_t _value = 0;
-  // Factor for calculating the distance (cm) from echo time (us).
+  // Factor for calculating the distance (cm) from echo time (ms).
   //  Based on a speed of sound of 345 metres/second.
-  const uint16_t factor = 58; // us/cm
-  // Limit the time spent looping by dropping out when the expected
-  // worst case threshold value is greater than an arbitrary value.
-  const uint16_t maxPermittedLoopTime = 10 * factor; // max in us
-  unsigned long _startTime = 0;
-  unsigned long _maxTime = 0;
-  enum {DORMANT, MEASURING}; // _state values
-  uint8_t _state = DORMANT;
-  uint8_t _counter = 0;
-  uint16_t _options = 0;
+  const uint16_t factor = 58; // ms/cm
 
 public:
-  enum Options {
-    LOOP = 1,  // Option HCSR04::LOOP reinstates old behaviour, i.e. complete measurement in one loop entry.
-  };
  
   // Static create function provides alternative way to create object
-  static void create(VPIN vpin, int trigPin, int echoPin, uint16_t onThreshold, uint16_t offThreshold, uint16_t options = 0) {
+  static void create(VPIN vpin, int trigPin, int echoPin, uint16_t onThreshold, uint16_t offThreshold) {
     if (checkNoOverlap(vpin))
-        new HCSR04(vpin, trigPin, echoPin, onThreshold, offThreshold, options);
+        new HCSR04(vpin, trigPin, echoPin, onThreshold, offThreshold);
   }
 
 protected:
-  // Constructor performs static initialisation of the device object
-  HCSR04 (VPIN vpin, int trigPin, int echoPin, uint16_t onThreshold, uint16_t offThreshold, uint16_t options) {
+  // Constructor perfroms static initialisation of the device object
+  HCSR04 (VPIN vpin, int trigPin, int echoPin, uint16_t onThreshold, uint16_t offThreshold) {
     _firstVpin = vpin;
     _nPins = 1;
     _trigPin = trigPin;
     _echoPin = echoPin;
     _onThreshold = onThreshold;
     _offThreshold = offThreshold;
-    _options = options;
     addDevice(this);
   }
  // _begin function called to perform dynamic initialisation of the device
   void _begin() override {
-    _state = 0;
     pinMode(_trigPin, OUTPUT);
     pinMode(_echoPin, INPUT);
     ArduinoPins::fastWriteDigital(_trigPin, 0);
@@ -140,104 +112,78 @@ protected:
     return _distance;
   }
 
-  // _loop function - read HC-SR04 once every 100 milliseconds.
+  // _loop function - read HC-SR04 once every 50 milliseconds.
   void _loop(unsigned long currentMicros) override {
-    unsigned long waitTime;
-    switch(_state) {
-      case DORMANT: // Issue pulse
-        // If receive pin is still set on from previous call, do nothing till next entry.
-        if (ArduinoPins::fastReadDigital(_echoPin)) return;
-
-        // Send 10us pulse to trigger transmitter
-        ArduinoPins::fastWriteDigital(_trigPin, 1);
-        delayMicroseconds(10);
-        ArduinoPins::fastWriteDigital(_trigPin, 0);
-
-        // Wait, with timeout, for echo pin to become set.
-        // Measured time delay is just under 500us, so 
-        // wait for max of 1000us.
-        _startTime = micros();
-        _maxTime = 1000;
-
-        while (!ArduinoPins::fastReadDigital(_echoPin)) {
-          // Not set yet, see if we've timed out.
-          waitTime = micros() - _startTime;
-          if (waitTime > _maxTime) {
-            // Timeout waiting for pulse start, abort the read and start again
-            _state = DORMANT;
-            return;
-          }
-        }
-
-        // Echo pulse started, so wait for echo pin to reset, and measure length of pulse
-        _startTime = micros();
-        _maxTime = factor * _offThreshold;
-        _state = MEASURING;
-        // If maximum measurement time is high, then skip until next loop entry before 
-        // starting to look for pulse end.
-        // This gives better accuracy at shorter distance thresholds but without extending 
-        // loop execution time for longer thresholds.  If LOOP option is set on, then
-        // the entire measurement will be done in one loop entry, i.e. the code will fall
-        // through into the measuring phase.
-        if (!(_options & LOOP) && _maxTime > maxPermittedLoopTime) break;
-        /* fallthrough */
-
-      case MEASURING: // Check if echo pulse has finished
-        do {
-          waitTime = micros() - _startTime;
-          if (!ArduinoPins::fastReadDigital(_echoPin)) {
-            // Echo pulse completed; check if pulse length is below threshold and if so set value.
-            if (waitTime <= factor * _onThreshold) {
-              // Measured time is within the onThreshold, so value is one.
-              _value = 1;
-              // If the new distance value is less than the current, use it immediately.
-              // But if the new distance value is longer, then it may be erroneously long
-              // (because of extended loop times delays), so apply a delay to distance increases.
-              uint16_t estimatedDistance = waitTime / factor;
-              if (estimatedDistance < _distance) 
-                _distance = estimatedDistance;
-              else
-                _distance += 1;  // Just increase distance slowly.
-              _counter = 0;
-              //DIAG(F("HCSR04: Pulse Len=%l Distance=%d"), waitTime, _distance);
-            }
-            _state = DORMANT;
-          } else {
-            // Echo pulse hasn't finished, so check if maximum time has elapsed
-            // If pulse is too long then set return value to zero,
-            //  and finish without waiting for end of pulse.
-            if (waitTime > _maxTime) {
-              // Pulse length longer than maxTime, value is provisionally zero.
-              // But don't change _value unless provisional value is zero for 10 consecutive measurements
-              if (_value == 1) {
-                if (++_counter >= 10) {
-                  _value = 0;
-                  _distance = 32767;
-                  _counter = 0;
-                }
-              }
-              _state = DORMANT; // start again
-            }
-          }
-          // If there's lots of time remaining before the expected completion time,
-          // then exit and wait for next loop entry.  Otherwise, loop until we finish.
-          // If option LOOP is set, then we loop until finished anyway.
-          uint32_t remainingTime = _maxTime - waitTime;
-          if (!(_options & LOOP) && remainingTime < maxPermittedLoopTime) return;
-        } while (_state == MEASURING) ;
-        break;
-    }
-    // Datasheet recommends a wait of at least 60ms between measurement cycles
-    if (_state == DORMANT)
-      delayUntil(currentMicros+60000UL); // wait 60ms till next measurement
-
+    read_HCSR04device();
+    // Delay next loop entry until 50ms have elapsed.
+    delayUntil(currentMicros + 50000UL);
   }
 
   void _display() override {
-    DIAG(F("HCSR04 Configured on VPIN:%u TrigPin:%d EchoPin:%d On:%dcm Off:%dcm"),
+    DIAG(F("HCSR04 Configured on Vpin:%d TrigPin:%d EchoPin:%d On:%dcm Off:%dcm"),
       _firstVpin, _trigPin, _echoPin, _onThreshold, _offThreshold);
   }
 
+private:
+  // This polls the HC-SR04 device by sending a pulse and measuring the duration of
+  //  the pulse observed on the receive pin.  In order to be kind to the rest of the CS
+  //  software, no interrupts are used and interrupts are not disabled.  The pulse duration
+  //  is measured in a loop, using the micros() function.  Therefore, interrupts from other
+  //  sources may affect the result.  However, interrupts response code in CS typically takes
+  //  much less than the 58us frequency for the DCC interrupt, and 58us corresponds to only 1cm
+  //  in the HC-SR04.
+  //  To reduce chatter on the output, hysteresis is applied on reset: the output is set to 1 when the 
+  //  measured distance is less than the onThreshold, and is set to 0 if the measured distance is
+  //  greater than the offThreshold.
+  //
+  void read_HCSR04device() {
+    // uint16 enough to time up to 65ms
+    uint16_t startTime, waitTime = 0, currentTime, maxTime;  
+
+    // If receive pin is still set on from previous call, abort the read.
+    if (ArduinoPins::fastReadDigital(_echoPin))
+      return;
+
+    // Send 10us pulse to trigger transmitter
+    ArduinoPins::fastWriteDigital(_trigPin, 1);
+    delayMicroseconds(10);
+    ArduinoPins::fastWriteDigital(_trigPin, 0);
+
+    // Wait for receive pin to be set
+    startTime = currentTime = micros();
+    maxTime = factor * _offThreshold * 2;
+    while (!ArduinoPins::fastReadDigital(_echoPin)) {
+      // lastTime = currentTime;
+      currentTime = micros();
+      waitTime = currentTime - startTime;
+      if (waitTime > maxTime) {
+        // Timeout waiting for pulse start, abort the read
+        return;
+      }
+    }
+
+    // Wait for receive pin to reset, and measure length of pulse
+    startTime = currentTime = micros();
+    maxTime = factor * _offThreshold;
+    while (ArduinoPins::fastReadDigital(_echoPin)) {
+      currentTime = micros();
+      waitTime = currentTime - startTime;
+      // If pulse is too long then set return value to zero,
+      //  and finish without waiting for end of pulse.
+      if (waitTime > maxTime) {
+        // Pulse length longer than maxTime, reset value.
+        _value = 0;
+        _distance = 32767;
+        return;
+      }
+    } 
+    // Check if pulse length is below threshold, if so set value.
+    //DIAG(F("HCSR04: Pulse Len=%l Distance=%d"), waitTime, distance);
+    _distance = waitTime / factor; // in centimetres
+    if (_distance < _onThreshold) 
+      _value = 1;
+  }
+
 };
 
 #endif //IO_HCSR04_H

IO_I2CDFPlayer.h

@@ -1,805 +0,0 @@
-   /*
- *  © 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/>.
- */
-
-/*
- * DFPlayer is an MP3 player module with an SD card holder.  It also has an integrated
- * amplifier, so it only needs a power supply and a speaker.
- * This driver is a modified version of the IO_DFPlayer.h file
- * *********************************************************************************************
- * 
- * Dec 2023, Added NXP SC16IS752 I2C Dual UART to enable the DFPlayer connection over the I2C bus
- * 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:
- * 
- * I2CDFPlayer::create(1st vPin, vPins, I2C address, xtal);
- * 
- * 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
- * xtal         : 0 for 1,8432Mhz, 1 for 14,7456Mhz
- * 
- * The vPin is also a pin that can be read, it indicate if the DFPlayer has finished playing a track
- *
- */
-
-#ifndef IO_I2CDFPlayer_h
-#define IO_I2CDFPlayer_h
-
-#include "IODevice.h"
-#include "I2CManager.h"
-#include "DIAG.h"
-
-// Debug and diagnostic defines, enable too many will result in slowing the driver
-//#define DIAG_I2CDFplayer
-//#define DIAG_I2CDFplayer_data
-//#define DIAG_I2CDFplayer_reg
-//#define DIAG_I2CDFplayer_playing
-
-class I2CDFPlayer : public IODevice {
-private: 
-  const uint8_t MAXVOLUME=30;
-  uint8_t RETRYCOUNT = 0x03;
-  bool _playing = false;
-  uint8_t _inputIndex = 0;
-  unsigned long _commandSendTime; // Time (us) that last transmit took place.
-  unsigned long _timeoutTime;
-  uint8_t _recvCMD;  // Last received command code byte
-  bool _awaitingResponse = false;  
-  uint8_t _retryCounter = RETRYCOUNT; // Max retries before timing out
-  uint8_t _requestedVolumeLevel = MAXVOLUME;
-  uint8_t _currentVolume = MAXVOLUME;
-  int _requestedSong = -1;  // -1=none, 0=stop, >0=file number
-  bool _repeat = false; // audio file is repeat playing
-  uint8_t _previousCmd = true;
-  // SC16IS752 defines
-  I2CAddress _I2CAddress;
-  I2CRB _rb;
-  uint8_t _UART_CH=0x00;  // Fix uart ch to 0 for now
-  // Communication parameters for the DFPlayer are fixed at 8 bit, No parity, 1 stopbit
-  uint8_t WORD_LEN = 0x03;    // Value LCR bit 0,1
-  uint8_t STOP_BIT = 0x00;    // Value LCR bit 2 
-  uint8_t PARITY_ENA = 0x00;  // Value LCR bit 3
-  uint8_t PARITY_TYPE = 0x00; // Value LCR bit 4
-  uint32_t BAUD_RATE = 9600;
-  uint8_t PRESCALER = 0x01;   // Value MCR bit 7
-  uint8_t TEMP_REG_VAL = 0x00;
-  uint8_t FIFO_RX_LEVEL = 0x00;
-  uint8_t RX_BUFFER = 0x00; // nr of bytes copied into _inbuffer
-  uint8_t FIFO_TX_LEVEL = 0x00;  
-  bool _playCmd = false;
-  bool _volCmd = false;
-  bool _folderCmd = false;
-  uint8_t _requestedFolder = 0x01; // default to folder 01
-  uint8_t _currentFolder = 0x01; // default to folder 01
-  bool _repeatCmd = false;
-  bool _stopplayCmd = false;
-  bool _resetCmd = false;
-  bool _eqCmd = false;
-  uint8_t _requestedEQValue = DF_NORMAL;
-  uint8_t _currentEQvalue = DF_NORMAL; // start equalizer value
-  bool _daconCmd = false;
-  uint8_t _audioMixer = 0x01; // Default to output amplifier 1
-  bool _setamCmd = false; // Set the Audio mixer channel
-  uint8_t _outbuffer [11]; // DFPlayer command is 10 bytes + 1 byte register address & UART channel
-  uint8_t _inbuffer[10]; // expected DFPlayer return 10 bytes
-   
-  unsigned long _sc16is752_xtal_freq;
-  unsigned long SC16IS752_XTAL_FREQ_LOW = 1843200; // To support cheap eBay/AliExpress SC16IS752 boards
-  unsigned long SC16IS752_XTAL_FREQ_HIGH = 14745600; // Support for higher baud rates, standard for modular EX-IO system
-   
-public:
-  // Constructor
-   I2CDFPlayer(VPIN firstVpin, int nPins, I2CAddress i2cAddress, uint8_t xtal){
-    _firstVpin = firstVpin;
-    _nPins = nPins;
-    _I2CAddress = i2cAddress;
-    if (xtal == 0){
-      _sc16is752_xtal_freq = SC16IS752_XTAL_FREQ_LOW;
-    } else { // should be 1
-        _sc16is752_xtal_freq = SC16IS752_XTAL_FREQ_HIGH;
-      }
-    addDevice(this);
-   } 
-  
-public:
-  static void create(VPIN firstVpin, int nPins, I2CAddress i2cAddress, uint8_t xtal) {
-    if (checkNoOverlap(firstVpin, nPins, i2cAddress)) new I2CDFPlayer(firstVpin, nPins, i2cAddress, xtal); 
-    }
-
-  void _begin() override {
-    // check if SC16IS752 exist first, initialize and then resume DFPlayer init via SC16IS752
-    I2CManager.begin();
-    I2CManager.setClock(1000000);
-    if (I2CManager.exists(_I2CAddress)){
-      DIAG(F("SC16IS752 I2C:%s UART detected"), _I2CAddress.toString());
-      Init_SC16IS752(); // Initialize UART
-      if (_deviceState == DEVSTATE_FAILED){
-        DIAG(F("SC16IS752 I2C:%s UART initialization failed"), _I2CAddress.toString());
-        }
-      } else {
-         DIAG(F("SC16IS752 I2C:%s UART not detected"), _I2CAddress.toString());
-        }
-      #if defined(DIAG_IO)
-      _display();
-      #endif
-      // Now init DFPlayer
-      // Send a query to the device to see if it responds
-      _deviceState = DEVSTATE_INITIALISING; 
-      sendPacket(0x42,0,0);
-      _timeoutTime = micros() + 5000000UL;  // 5 second timeout      
-      _awaitingResponse = true; 
-     }
-  
-  
-  void _loop(unsigned long currentMicros) override {
-    // Read responses from device
-    uint8_t status = _rb.status;
-    if (status == I2C_STATUS_PENDING) return;  // Busy, so don't do anything
-    if (status == I2C_STATUS_OK) { 
-      processIncoming(currentMicros);
-          // Check if a command sent to device has timed out.  Allow 0.5 second for response
-          // added retry counter, sometimes we do not sent keep alive due to other commands sent to DFPlayer
-      if (_awaitingResponse && (int32_t)(currentMicros - _timeoutTime) > 0) { // timeout triggered
-        if(_retryCounter == 0){ // retry counter out of luck, must take the device to failed state     
-          DIAG(F("I2CDFPlayer:%s, DFPlayer not responding on UART channel: 0x%x"), _I2CAddress.toString(), _UART_CH);
-          _deviceState = DEVSTATE_FAILED;
-          _awaitingResponse = false;
-          _playing = false;
-          _retryCounter = RETRYCOUNT;
-        } else { // timeout and retry protection and recovery of corrupt data frames from DFPlayer
-            #ifdef DIAG_I2CDFplayer_playing
-              DIAG(F("I2CDFPlayer: %s, DFPlayer timout, retry counter: %d on UART channel: 0x%x"), _I2CAddress.toString(), _retryCounter, _UART_CH);
-            #endif
-            _timeoutTime = currentMicros + 5000000UL;  // Timeout if no response within 5 seconds// reset timeout
-            _awaitingResponse = false; // trigger sending a keep alive 0x42 in processOutgoing()
-            _retryCounter --; // decrement retry counter                        
-            resetRX_fifo(); // reset the RX fifo as it has corrupt data            
-          }
-      }      
-    }
-
-    status = _rb.status;
-    if (status == I2C_STATUS_PENDING) return;  // Busy, try next time
-    if (status == I2C_STATUS_OK) {
-     // Send any commands that need to go.
-      processOutgoing(currentMicros);
-     }
-    delayUntil(currentMicros + 10000); // Only enter every 10ms    
-  }
-
- 
-  // Check for incoming data, and update busy flag and other state accordingly
- 
-  void processIncoming(unsigned long currentMicros) {
-    // Expected message is in the form "7E FF 06 3D xx xx xx xx xx EF"
-    RX_fifo_lvl();
-    if (FIFO_RX_LEVEL >= 10) {      
-      #ifdef DIAG_I2CDFplayer
-        DIAG(F("I2CDFPlayer: %s Retrieving data from RX Fifo on UART_CH: 0x%x FIFO_RX_LEVEL: %d"),_I2CAddress.toString(), _UART_CH, FIFO_RX_LEVEL); 
-      #endif
-      _outbuffer[0] = REG_RHR << 3 | _UART_CH << 1;
-      // Only copy 10 bytes from RX FIFO, there maybe additional partial return data after a track is finished playing in the RX FIFO
-      I2CManager.read(_I2CAddress, _inbuffer, 10, _outbuffer, 1); // inbuffer[] has the data now
-      //delayUntil(currentMicros + 10000); // Allow time to get the data
-      RX_BUFFER = 10; // We have copied 10 bytes from RX FIFO to _inbuffer
-        #ifdef DIAG_I2CDFplayer_data
-          DIAG(F("SC16IS752: At I2C: %s, UART channel: 0x%x, RX FIFO Data"), _I2CAddress.toString(), _UART_CH);
-          for (int i = 0; i < sizeof _inbuffer; i++){
-            DIAG(F("SC16IS752: Data _inbuffer[0x%x]: 0x%x"), i, _inbuffer[i]);  
-          }
-        #endif       
-    } else {
-        FIFO_RX_LEVEL = 0; //set to 0, we'll read a fresh FIFO_RX_LEVEL next time
-        return; // No data or not enough data in rx fifo, check again next time around
-      }
-
-    
-    bool ok = false;
-    //DIAG(F("I2CDFPlayer: RX_BUFFER: %d"), RX_BUFFER);
-    while (RX_BUFFER != 0) {
-      int c = _inbuffer[_inputIndex]; // Start at 0, increment to FIFO_RX_LEVEL
-      switch (_inputIndex) {
-        case 0:
-          if (c == 0x7E) ok = true;
-          break;
-        case 1:
-          if (c == 0xFF) ok = true;
-          break;
-        case 2:
-          if (c== 0x06) ok = true;
-          break;
-        case 3:
-          _recvCMD = c; // CMD byte
-          ok = true;
-          break;
-        case 6:
-          switch (_recvCMD) {
-            //DIAG(F("I2CDFPlayer: %s, _recvCMD: 0x%x _awaitingResponse: 0x0%x"),_I2CAddress.toString(), _recvCMD, _awaitingResponse);
-            case 0x42:
-              // Response to status query
-              _playing = (c != 0);              
-              // Mark the device online and cancel timeout
-              if (_deviceState==DEVSTATE_INITIALISING) {
-                _deviceState = DEVSTATE_NORMAL;
-                #ifdef DIAG_I2CDFplayer
-                 DIAG(F("I2CDFPlayer: %s, UART_CH: 0x0%x, _deviceState: 0x0%x"),_I2CAddress.toString(), _UART_CH, _deviceState);
-                #endif 
-                #ifdef DIAG_IO
-                _display();
-                #endif
-              }
-              _awaitingResponse = false;
-              break;
-            case 0x3d:            
-              // End of play
-              if (_playing) {
-                #ifdef DIAG_IO
-                  DIAG(F("I2CDFPlayer: Finished"));
-                #endif
-                _playing = false;
-              }
-              break;
-            case 0x40:
-              // Error codes; 1: Module Busy
-              DIAG(F("I2CDFPlayer: Error %d returned from device"), c);
-              _playing = false;
-              break;
-          }
-          ok = true;
-          break;
-        case 4: case 5: case 7: case 8: 
-          ok = true;  // Skip over these bytes in message.
-          break;
-        case 9:
-          if (c==0xef) {
-            // Message finished
-            _retryCounter = RETRYCOUNT; // reset the retry counter as we have received a valid packet
-          }
-          break;
-        default:
-          break;
-      }
-      if (ok){
-        _inputIndex++;  // character as expected, so increment index
-        RX_BUFFER --; // Decrease FIFO_RX_LEVEL with each character read from _inbuffer[_inputIndex]
-      } else {
-        _inputIndex = 0;  // otherwise reset.
-        RX_BUFFER = 0;
-      }
-    }
-    RX_BUFFER = 0; //Set to 0, we'll read a new RX FIFO level again
-  }
-
-
-  // Send any commands that need to be sent
-  void processOutgoing(unsigned long currentMicros) {
-    // When two commands are sent in quick succession, the device will often fail to 
-    // execute one.  Testing has indicated that a delay of 100ms or more is required
-    // between successive commands to get reliable operation.
-    // If 100ms has elapsed since the last thing sent, then check if there's some output to do.
-    if (((int32_t)currentMicros - _commandSendTime) > 100000) {
-      if ( _resetCmd == true){
-          sendPacket(0x0C,0,0);
-          _resetCmd = false;          
-      } else if(_volCmd == true) { // do the volme before palying a track
-         if(_requestedVolumeLevel >= 0 && _requestedVolumeLevel <= 30){         
-         _currentVolume = _requestedVolumeLevel; // If _requestedVolumeLevel is out of range, sent _currentV1olume      
-         }
-         sendPacket(0x06, 0x00, _currentVolume);
-        _volCmd = false;
-      } else if (_playCmd == true) {
-        // Change song
-        if (_requestedSong != -1) {
-          #ifdef DIAG_I2CDFplayer_playing
-           DIAG(F("I2CDFPlayer: _requestedVolumeLevel: %u, _requestedSong: %u, _currentFolder: %u _playCmd: 0x%x"), _requestedVolumeLevel, _requestedSong, _currentFolder, _playCmd);
-          #endif               
-          sendPacket(0x0F, _currentFolder, _requestedSong);  // audio file in folder          
-          _requestedSong = -1; 
-          _playCmd = false;
-        }           
-      } //else if (_requestedSong == 0) {
-        else if (_stopplayCmd == true) {
-          #ifdef DIAG_I2CDFplayer_playing
-           DIAG(F("I2CDFPlayer: Stop playing: _stopplayCmd: 0x%x"), _stopplayCmd);
-          #endif
-        sendPacket(0x16, 0x00, 0x00);  // Stop playing        
-        _requestedSong = -1;
-        _repeat = false; // reset repeat        
-        _stopplayCmd = false;
-        } else if (_folderCmd == true) {
-          #ifdef DIAG_I2CDFplayer_playing
-           DIAG(F("I2CDFPlayer: Folder: _folderCmd: 0x%x, _requestedFolder: %d"), _stopplayCmd, _requestedFolder);
-          #endif
-          if (_currentFolder != _requestedFolder){
-            _currentFolder = _requestedFolder;
-          }
-          _folderCmd = false;
-      } else if (_repeatCmd == true) {
-        if(_repeat == false) { // No repeat play currently
-          #ifdef DIAG_I2CDFplayer_playing
-           DIAG(F("I2CDFPlayer: Repeat: _repeatCmd: 0x%x, _requestedSong: %d, _repeat: 0x0%x"), _repeatCmd, _requestedSong, _repeat);
-          #endif 
-          sendPacket(0x08, 0x00, _requestedSong);  // repeat playing audio file in root folder          
-          _requestedSong = -1;
-          _repeat = true; 
-        }
-        _repeatCmd= false;      
-      } else if (_daconCmd == true) { // Always turn DAC on
-        #ifdef DIAG_I2CDFplayer_playing
-          DIAG(F("I2CDFPlayer: DACON: _daconCmd: 0x%x"), _daconCmd);
-        #endif 
-        sendPacket(0x1A,0,0x00);
-        _daconCmd = false;
-      } else if (_eqCmd == true){ // Set Equalizer, values 0x00 - 0x05        
-        if (_currentEQvalue != _requestedEQValue){
-          #ifdef DIAG_I2CDFplayer_playing
-           DIAG(F("I2CDFPlayer: EQ: _eqCmd: 0x%x, _currentEQvalue: 0x0%x, _requestedEQValue: 0x0%x"), _eqCmd, _currentEQvalue, _requestedEQValue);
-          #endif 
-          _currentEQvalue = _requestedEQValue;
-          sendPacket(0x07,0x00,_currentEQvalue);
-        }
-        _eqCmd = false;
-      } else if (_setamCmd == true){ // Set Audio mixer channel
-         setGPIO(); // Set the audio mixer channel
-         /*        
-          if (_audioMixer == 1){ // set to audio mixer 1       
-            if (_UART_CH == 0){ 
-              TEMP_REG_VAL |= (0x01 << _UART_CH); //Set GPIO pin 0 to high
-            } else { // must be UART 1
-              TEMP_REG_VAL |= (0x01 << _UART_CH); //Set GPIO pin 1 to high
-              }
-           //_setamCmd = false;
-           //UART_WriteRegister(REG_IOSTATE, TEMP_REG_VAL);
-          } else { // set to audio mixer 2
-              if (_UART_CH == 0){ 
-                TEMP_REG_VAL &= (0x00 << _UART_CH); //Set GPIO pin 0 to Low
-              } else { // must be UART 1
-                TEMP_REG_VAL &= (0x00 << _UART_CH); //Set GPIO pin 1 to Low
-                }
-              //_setamCmd = false;
-              //UART_WriteRegister(REG_IOSTATE, TEMP_REG_VAL);
-            }*/
-        _setamCmd = false;        
-      } else if ((int32_t)currentMicros - _commandSendTime > 1000000) {
-        // Poll device every second that other commands aren't being sent,
-        // to check if it's still connected and responding.
-          #ifdef DIAG_I2CDFplayer_playing
-           DIAG(F("I2CDFPlayer: Send keepalive") );
-          #endif
-        sendPacket(0x42,0,0); 
-        if (!_awaitingResponse) {
-          #ifdef DIAG_I2CDFplayer_playing
-           DIAG(F("I2CDFPlayer: Send keepalive, _awaitingResponse: 0x0%x"), _awaitingResponse );
-          #endif
-          _timeoutTime = currentMicros + 5000000UL;  // Timeout if no response within 5 seconds
-          _awaitingResponse = true;
-        }
-      }
-    }  
-  }
-
-
-  // Write to a vPin will do nothing
-  void _write(VPIN vpin, int value) override {
-    if (_deviceState == DEVSTATE_FAILED) return;
-      #ifdef DIAG_IO
-        DIAG(F("I2CDFPlayer: Writing to any vPin not supported"));
-      #endif
-  }
-
-
-  // WriteAnalogue on first pin uses the nominated value as a file number to start playing, if file number > 0.
-  // Volume may be specified as second parameter to writeAnalogue.
-  // If value is zero, the player stops playing.  
-  // WriteAnalogue on second pin sets the output volume.
-  //
-  // WriteAnalogue to be done on first vpin
-  //
-  //void _writeAnalogue(VPIN vpin, int value, uint8_t volume=0, uint16_t=0) override { 
-  void _writeAnalogue(VPIN vpin, int value, uint8_t volume=0, uint16_t cmd=0) override { 
-    if (_deviceState == DEVSTATE_FAILED) return;    
-    #ifdef DIAG_IO
-      DIAG(F("I2CDFPlayer: VPIN:%u FileNo:%d Volume:%d Command:0x%x"), vpin, value, volume, cmd);
-    #endif
-    uint8_t pin = vpin - _firstVpin;
-    if (pin == 0) { // Enhanced DFPlayer commands, do nothing if not vPin 0     
-     // Read command and value
-      switch (cmd){
-       //case NONE:
-       // DFPlayerCmd = cmd;
-       // break;
-       case DF_PLAY:
-        _playCmd = true;
-        _volCmd = true;        
-        _requestedSong = value;
-        _requestedVolumeLevel = volume; 
-        _playing = true;        
-        break;
-        case DF_VOL:
-          _volCmd = true;          
-          _requestedVolumeLevel = volume;
-        break;
-       case DF_FOLDER:
-        _folderCmd = true;
-        if (volume <= 0 || volume > 99){ // Range checking, valid values 1-99, else default to 1
-          _requestedFolder = 0x01; // if outside range, default to folder 01  
-        } else {
-          _requestedFolder = volume;
-        }        
-        break;
-       case DF_REPEATPLAY: // Need to check if _repeat == true, if so do nothing        
-        if (_repeat == false) {
-           #ifdef DIAG_I2CDFplayer_playing
-              DIAG(F("I2CDFPlayer: WriteAnalog Repeat: _repeat: 0x0%x, value: %d _repeatCmd: 0x%x"), _repeat, value, _repeatCmd);
-           #endif
-          _repeatCmd = true;          
-          _requestedSong = value;
-          _requestedVolumeLevel = volume;
-          _playing = true;         
-        }
-        break;
-       case DF_STOPPLAY:
-        _stopplayCmd = true;        
-        break;
-       case DF_EQ:
-        #ifdef DIAG_I2CDFplayer_playing
-          DIAG(F("I2CDFPlayer: WriteAnalog EQ: cmd: 0x%x, EQ value: 0x%x"), cmd, volume);
-        #endif
-        _eqCmd = true;        
-        if (volume <= 0 || volume > 5) { // If out of range, default to NORMAL
-          _requestedEQValue = DF_NORMAL;            
-        } else { // Valid EQ parameter range
-          _requestedEQValue = volume;     
-          }
-        break;        
-       case DF_RESET:
-        _resetCmd = true;      
-        break; 
-       case DF_DACON: // Works, but without the DACOFF command limited value, except when not relying on DFPlayer default to turn the DAC on
-        #ifdef DIAG_I2CDFplayer_playing
-          DIAG(F("I2CDFPlayer: WrtieAnalog DACON: cmd: 0x%x"), cmd);
-        #endif
-        _daconCmd = true;
-        break;
-        case DF_SETAM: // Set the audio mixer channel to 1 or 2
-          _setamCmd = true;
-          #ifdef DIAG_I2CDFplayer_playing
-            DIAG(F("I2CDFPlayer: WrtieAnalog SETAM: cmd: 0x%x"), cmd);
-          #endif
-          if (volume <= 0 || volume > 2) { // If out of range, default to 1
-            _audioMixer = 1;            
-          } else { // Valid SETAM parameter in range
-              _audioMixer = volume; // _audioMixer valid values 1 or 2
-            }          
-        break;
-       default:
-        break;
-      }
-    }    
-  }
-
-  // A read on any pin indicates if the player is still playing.
-  int _read(VPIN vpin) override {
-    if (_deviceState == DEVSTATE_FAILED) return false;
-    uint8_t pin = vpin - _firstVpin;
-      if (pin == 0) { // Do nothing if not vPin 0
-        return _playing;
-      }
-    }
-
-  void _display() override {
-    DIAG(F("I2CDFPlayer Configured on Vpins:%u-%u %S"), _firstVpin, _firstVpin+_nPins-1,
-      (_deviceState==DEVSTATE_FAILED) ? F("OFFLINE") : F(""));
-  }
-  
-private: 
-  // DFPlayer command frame
-  // 7E FF 06 0F 00 01 01 xx xx EF
-  // 0	  ->	7E is start code
-  // 1	  ->	FF is version
-  // 2	  ->	06 is length
-  // 3	  ->	0F is command
-  // 4	  ->	00 is no receive
-  // 5~6	->	01 01 is argument
-  // 7~8	->	checksum = 0 - ( FF+06+0F+00+01+01 )
-  // 9	  ->	EF is end code
-
-  void sendPacket(uint8_t command, uint8_t arg1 = 0, uint8_t arg2 = 0) {
-    FIFO_TX_LEVEL = 0; // Reset FIFO_TX_LEVEL    
-    uint8_t out[] = {
-        0x7E,
-        0xFF,
-        06,
-        command,
-        00,
-        //static_cast<uint8_t>(arg >> 8),
-        //static_cast<uint8_t>(arg & 0x00ff),
-        arg1,
-        arg2,
-        00,
-        00,
-        0xEF };
-
-    setChecksum(out);
-
-      // Prepend the DFPlayer command with REG address and UART Channel in _outbuffer
-      _outbuffer[0] = REG_THR << 3 | _UART_CH << 1; //TX FIFO and UART Channel      
-      for ( int i = 1; i < sizeof(out)+1 ; i++){
-        _outbuffer[i] = out[i-1];
-      }
-
-      #ifdef DIAG_I2CDFplayer_data
-       DIAG(F("SC16IS752: I2C: %s Sent packet function"), _I2CAddress.toString());
-       for (int i = 0; i < sizeof _outbuffer; i++){
-        DIAG(F("SC16IS752: Data _outbuffer[0x%x]: 0x%x"), i, _outbuffer[i]);  
-       }
-      #endif
-      
-    TX_fifo_lvl();
-    if(FIFO_TX_LEVEL > 0){ //FIFO is empty
-      I2CManager.write(_I2CAddress, _outbuffer, sizeof(_outbuffer), &_rb);
-      //I2CManager.write(_I2CAddress, _outbuffer, sizeof(_outbuffer));
-      #ifdef DIAG_I2CDFplayer
-       DIAG(F("SC16IS752: I2C: %s data transmit complete on UART: 0x%x"), _I2CAddress.toString(), _UART_CH);
-      #endif
-    } else {
-      DIAG(F("I2CDFPlayer at: %s, TX FIFO not empty on UART: 0x%x"), _I2CAddress.toString(), _UART_CH);
-      _deviceState = DEVSTATE_FAILED; // This should not happen      
-    }
-    _commandSendTime = micros();
-  }
-
-  uint16_t calcChecksum(uint8_t* packet)
-  {
-    uint16_t sum = 0;
-    for (int i = 1; i < 7; i++)
-    {
-      sum += packet[i];
-    }
-    return -sum;
-  }
-
-  void setChecksum(uint8_t* out)
-  {
-    uint16_t sum = calcChecksum(out);
-    out[7] = (sum >> 8);
-    out[8] = (sum & 0xff);
-  }
-
-  // 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
-  // 
-  void Init_SC16IS752(){ // Return value is in _deviceState
-    #ifdef DIAG_I2CDFplayer
-      DIAG(F("SC16IS752: Initialize I2C: %s , UART Ch: 0x%x"), _I2CAddress.toString(),  _UART_CH);      
-    #endif
-    //uint16_t _divisor = (SC16IS752_XTAL_FREQ / PRESCALER) / (BAUD_RATE * 16);
-    uint16_t _divisor = (_sc16is752_xtal_freq/PRESCALER)/(BAUD_RATE * 16);  // Calculate _divisor for baudrate
-    TEMP_REG_VAL = 0x08; // UART Software reset
-    UART_WriteRegister(REG_IOCONTROL, TEMP_REG_VAL);
-    TEMP_REG_VAL = 0x00; // Set pins to GPIO mode
-    UART_WriteRegister(REG_IOCONTROL, TEMP_REG_VAL);
-    TEMP_REG_VAL = 0xFF; //Set all pins as output
-    UART_WriteRegister(REG_IODIR, TEMP_REG_VAL);
-    UART_ReadRegister(REG_IOSTATE); // Read current state as not to overwrite the other GPIO pins
-    TEMP_REG_VAL = _inbuffer[0];
-    setGPIO(); // Set the audio mixer channel
-    /*
-    if (_UART_CH == 0){ // Set Audio mixer channel
-      TEMP_REG_VAL |= (0x01 << _UART_CH); //Set GPIO pin 0 to high
-    } else { // must be UART 1
-      TEMP_REG_VAL |= (0x01 << _UART_CH); //Set GPIO pin 1 to high
-    }
-    UART_WriteRegister(REG_IOSTATE, TEMP_REG_VAL);
-    */
-    TEMP_REG_VAL = 0x07; // Reset FIFO, clear RX & TX FIFO
-    UART_WriteRegister(REG_FCR, TEMP_REG_VAL);
-    TEMP_REG_VAL = 0x00; // Set MCR to all 0, includes Clock divisor
-    UART_WriteRegister(REG_MCR, TEMP_REG_VAL);
-    TEMP_REG_VAL = 0x80 | WORD_LEN | STOP_BIT | PARITY_ENA | PARITY_TYPE;
-    UART_WriteRegister(REG_LCR, TEMP_REG_VAL); // Divisor latch enabled
-    UART_WriteRegister(REG_DLL, (uint8_t)_divisor);  // Write DLL
-    UART_WriteRegister(REG_DLH, (uint8_t)(_divisor >> 8)); // Write DLH
-    UART_ReadRegister(REG_LCR);
-    TEMP_REG_VAL = _inbuffer[0] & 0x7F; // Disable Divisor latch enabled bit
-    UART_WriteRegister(REG_LCR, TEMP_REG_VAL); // Divisor latch disabled  
-
-    uint8_t status = _rb.status;
-    if (status != I2C_STATUS_OK) {
-      DIAG(F("SC16IS752: I2C: %s failed %S"), _I2CAddress.toString(), I2CManager.getErrorMessage(status));
-      _deviceState = DEVSTATE_FAILED;
-    } else {
-      #ifdef DIAG_IO
-       DIAG(F("SC16IS752: I2C: %s, _deviceState: %S"), _I2CAddress.toString(), I2CManager.getErrorMessage(status));
-      #endif
-     _deviceState = DEVSTATE_NORMAL; // If I2C state is OK, then proceed to initialize DFPlayer 
-    }
-  }
-
-  
-  // Read the Receive FIFO Level register (RXLVL), return a single unsigned integer
-  // of nr of characters in the RX FIFO, bit 6:0, 7 not used, set to zero
-  // value from 0 (0x00) to 64 (0x40) Only display if RX FIFO has data
-  // The RX fifo level is used to check if there are enough bytes to process a frame
-  void RX_fifo_lvl(){
-    UART_ReadRegister(REG_RXLV);
-    FIFO_RX_LEVEL = _inbuffer[0];
-    #ifdef DIAG_I2CDFplayer
-     if (FIFO_RX_LEVEL > 0){
-     //if (FIFO_RX_LEVEL > 0 && FIFO_RX_LEVEL < 10){
-      DIAG(F("SC16IS752: At I2C: %s, UART channel: 0x%x, FIFO_RX_LEVEL: 0d%d"), _I2CAddress.toString(), _UART_CH, _inbuffer[0]);
-    }
-    #endif   
-  }
-
-  // When a frame is transmitted from the DFPlayer to the serial port, and at the same time the CS is sending a 42 query
-  // the following two frames from the DFPlayer are corrupt. This result in the receive buffer being out of sync and the 
-  // CS will complain and generate a timeout.
-  // The RX fifo has corrupt data and need to be flushed, this function does that
-  // 
-  void resetRX_fifo(){
-    #ifdef DIAG_I2CDFplayer
-      DIAG(F("SC16IS752: At I2C: %s, UART channel: 0x%x, RX fifo reset"), _I2CAddress.toString(), _UART_CH);
-    #endif    
-    TEMP_REG_VAL = 0x03; // Reset RX fifo
-    UART_WriteRegister(REG_FCR, TEMP_REG_VAL);
-  }
-
-  // Set or reset GPIO pin 0 and 1 depending on the UART ch
-  // This function may be modified in a future release to enable all 8 pins to be set or reset with EX-Rail
-  // for various auxilary functions
-  void setGPIO(){
-    UART_ReadRegister(REG_IOSTATE); // Get the current GPIO pins state from the IOSTATE register
-    TEMP_REG_VAL = _inbuffer[0];
-    if (_audioMixer == 1){ // set to audio mixer 1
-      if (_UART_CH == 0){ 
-        TEMP_REG_VAL |= (0x01 << _UART_CH); //Set GPIO pin 0 to high
-      } else { // must be UART 1
-         TEMP_REG_VAL |= (0x01 << _UART_CH); //Set GPIO pin 1 to high
-        }
-    } else { // set to audio mixer 2
-        if (_UART_CH == 0){ 
-          TEMP_REG_VAL &= ~(0x01 << _UART_CH); //Set GPIO pin 0 to Low
-        } else { // must be UART 1
-           TEMP_REG_VAL &= ~(0x01 << _UART_CH); //Set GPIO pin 1 to Low
-          }
-      }    
-    UART_WriteRegister(REG_IOSTATE, TEMP_REG_VAL);
-    _setamCmd = false;  
-  }
-  
-
-  // Read the Tranmit FIFO Level register (TXLVL), return a single unsigned integer
-  // of nr characters free in the TX FIFO, bit 6:0, 7 not used, set to zero
-  // value from 0 (0x00) to 64 (0x40)
-  //
-  void TX_fifo_lvl(){
-    UART_ReadRegister(REG_TXLV);
-    FIFO_TX_LEVEL = _inbuffer[0];
-    #ifdef DIAG_I2CDFplayer
-    //  DIAG(F("SC16IS752: At I2C: %s, UART channel: 0x%x, FIFO_TX_LEVEL: 0d%d"), _I2CAddress.toString(), _UART_CH, FIFO_TX_LEVEL);
-    #endif 
-  }
-
-
-  //void UART_WriteRegister(I2CAddress _I2CAddress, uint8_t _UART_CH, uint8_t UART_REG, uint8_t Val, I2CRB &_rb){
-  void UART_WriteRegister(uint8_t UART_REG, uint8_t Val){
-    _outbuffer[0] = UART_REG << 3 | _UART_CH << 1;
-    _outbuffer[1] = Val;
-    #ifdef DIAG_I2CDFplayer_reg
-      DIAG(F("SC16IS752: Write register at I2C: %s, UART channel: 0x%x, Register: 0x%x, Data: 0b%b"), _I2CAddress.toString(), _UART_CH, UART_REG, _outbuffer[1]);
-    #endif
-    I2CManager.write(_I2CAddress, _outbuffer, 2);
-  }
-
- 
-  void UART_ReadRegister(uint8_t UART_REG){
-     _outbuffer[0] = UART_REG << 3 | _UART_CH << 1; // _outbuffer[0] has now UART_REG and UART_CH
-     I2CManager.read(_I2CAddress, _inbuffer, 1, _outbuffer, 1);    
-    // _inbuffer has the REG data
-    #ifdef DIAG_I2CDFplayer_reg
-      DIAG(F("SC16IS752: Read register at I2C: %s, UART channel: 0x%x, Register: 0x%x, Data: 0b%b"), _I2CAddress.toString(), _UART_CH, UART_REG, _inbuffer[0]);
-    #endif
-  }
-
-// 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
-  };
-
-
-// DFPlayer commands and values
-// Declared in this scope
-enum  : uint8_t{
-    DF_PLAY          = 0x0F,
-    DF_VOL           = 0x06,
-    DF_FOLDER        = 0x2B, // Not a DFPlayer command, used to set folder nr where audio file is
-    DF_REPEATPLAY    = 0x08,
-    DF_STOPPLAY      = 0x16,
-    DF_EQ            = 0x07, // Set equaliser, require parameter NORMAL, POP, ROCK, JAZZ, CLASSIC or BASS
-    DF_RESET         = 0x0C,
-    DF_DACON         = 0x1A,
-    DF_SETAM         = 0x2A, // Set audio mixer 1 or 2 for this DFPLayer   
-    DF_NORMAL        = 0x00, // Equalizer parameters
-    DF_POP           = 0x01,
-    DF_ROCK          = 0x02,
-    DF_JAZZ          = 0x03,
-    DF_CLASSIC       = 0x04,
-    DF_BASS          = 0x05,    
-  };
-
-};
-
-#endif // IO_I2CDFPlayer_h

IO_MCP23008.h

@@ -25,14 +25,14 @@
 
 class MCP23008 : public GPIOBase<uint8_t> {
 public:
-  static void create(VPIN firstVpin, uint8_t nPins, I2CAddress i2cAddress, int interruptPin=-1) {
-    if (checkNoOverlap(firstVpin, nPins,i2cAddress)) new MCP23008(firstVpin, nPins, i2cAddress, interruptPin);
+  static void create(VPIN firstVpin, uint8_t nPins, uint8_t I2CAddress, int interruptPin=-1) {
+    if (checkNoOverlap(firstVpin, nPins,I2CAddress)) new MCP23008(firstVpin, nPins, I2CAddress, interruptPin);
   }
 
 private:
   // Constructor
-  MCP23008(VPIN firstVpin, uint8_t nPins, I2CAddress i2cAddress, int interruptPin=-1)
-    : GPIOBase<uint8_t>((FSH *)F("MCP23008"), firstVpin, nPins, i2cAddress, interruptPin) {
+  MCP23008(VPIN firstVpin, uint8_t nPins, uint8_t I2CAddress, int interruptPin=-1)
+    : GPIOBase<uint8_t>((FSH *)F("MCP23008"), firstVpin, min(nPins, (uint8_t)8), I2CAddress, interruptPin) {
 
     requestBlock.setRequestParams(_I2CAddress, inputBuffer, sizeof(inputBuffer),
       outputBuffer, sizeof(outputBuffer));
@@ -60,7 +60,7 @@ private:
     if (immediate) {
       uint8_t buffer;
       I2CManager.read(_I2CAddress, &buffer, 1, 1, REG_GPIO);
-      _portInputState = buffer | _portMode;
+      _portInputState = buffer;
     } else {
       // Queue new request
       requestBlock.wait(); // Wait for preceding operation to complete
@@ -71,7 +71,7 @@ private:
   // This function is invoked when an I/O operation on the requestBlock completes.
   void _processCompletion(uint8_t status) override {
     if (status == I2C_STATUS_OK) 
-      _portInputState = inputBuffer[0] | _portMode;
+      _portInputState = inputBuffer[0];
     else  
       _portInputState = 0xff;
   }

IO_MCP23017.h

@@ -30,14 +30,14 @@
  
 class MCP23017 : public GPIOBase<uint16_t> {
 public:
-  static void create(VPIN vpin, uint8_t nPins, I2CAddress i2cAddress, int interruptPin=-1) {
-    if (checkNoOverlap(vpin, nPins, i2cAddress)) new MCP23017(vpin, nPins, i2cAddress, interruptPin);
+  static void create(VPIN vpin, int nPins, uint8_t I2CAddress, int interruptPin=-1) {
+    if (checkNoOverlap(vpin, nPins, I2CAddress)) new MCP23017(vpin, min(nPins,16), I2CAddress, interruptPin);
   }
 
 private:  
   // Constructor
-  MCP23017(VPIN vpin, uint8_t nPins, I2CAddress i2cAddress, int interruptPin=-1) 
-    : GPIOBase<uint16_t>((FSH *)F("MCP23017"), vpin, nPins, i2cAddress, interruptPin) 
+  MCP23017(VPIN vpin, int nPins, uint8_t I2CAddress, int interruptPin=-1) 
+    : GPIOBase<uint16_t>((FSH *)F("MCP23017"), vpin, nPins, I2CAddress, interruptPin) 
   {
     requestBlock.setRequestParams(_I2CAddress, inputBuffer, sizeof(inputBuffer),
       outputBuffer, sizeof(outputBuffer));
@@ -65,7 +65,7 @@ private:
     if (immediate) {
       uint8_t buffer[2];
       I2CManager.read(_I2CAddress, buffer, 2, 1, REG_GPIOA);
-      _portInputState = ((uint16_t)buffer[1]<<8) | buffer[0] | _portMode;
+      _portInputState = ((uint16_t)buffer[1]<<8) | buffer[0];
     } else {
       // Queue new request
       requestBlock.wait(); // Wait for preceding operation to complete
@@ -76,7 +76,7 @@ private:
   // This function is invoked when an I/O operation on the requestBlock completes.
   void _processCompletion(uint8_t status) override {
     if (status == I2C_STATUS_OK) 
-      _portInputState = (((uint16_t)inputBuffer[1]<<8) | inputBuffer[0]) | _portMode;
+      _portInputState = ((uint16_t)inputBuffer[1]<<8) | inputBuffer[0];
     else  
       _portInputState = 0xffff;
   }

IO_PCA9555.h

@@ -1,111 +0,0 @@
-/*
- *  © 2021, 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/>.
- */
-
-#ifndef io_pca9555_h
-#define io_pca9555_h
-
-#include "IO_GPIOBase.h"
-#include "FSH.h"
-
-/////////////////////////////////////////////////////////////////////////////////////////////////////
-/*
- * IODevice subclass for PCA9555 16-bit I/O expander (NXP & Texas Instruments).
- */
- 
-class PCA9555 : public GPIOBase<uint16_t> {
-public:
-  static void create(VPIN vpin, uint8_t nPins, I2CAddress i2cAddress, int interruptPin=-1) {
-    if (checkNoOverlap(vpin, nPins, i2cAddress)) new PCA9555(vpin,nPins, i2cAddress, interruptPin);
-  }
-
-private:  
-  // Constructor
-  PCA9555(VPIN vpin, uint8_t nPins, I2CAddress I2CAddress, int interruptPin=-1) 
-    : GPIOBase<uint16_t>((FSH *)F("PCA9555"), vpin, nPins, I2CAddress, interruptPin) 
-  {
-    requestBlock.setRequestParams(_I2CAddress, inputBuffer, sizeof(inputBuffer),
-      outputBuffer, sizeof(outputBuffer));
-    outputBuffer[0] = REG_INPUT_P0;
-  }
-  void _writeGpioPort() override {
-    I2CManager.write(_I2CAddress, 3, REG_OUTPUT_P0, _portOutputState, _portOutputState>>8);
-  }
-  void _writePullups() override {
-    // Do nothing, pull-ups are always in place for input ports
-    // This function is here for HAL GPIOBase API compatibilitiy
-      
-  }
-  void _writePortModes() override {
-    // Write 0 to REG_CONF_P0 & REG_CONF_P1 for in-use pins that are outputs, 1 for others.
-    // PCA9555 & TCA9555, Interrupt is always enabled for raising and falling edge
-    uint16_t temp = ~(_portMode & _portInUse);
-    I2CManager.write(_I2CAddress, 3, REG_CONF_P0, temp, temp>>8);    
-  }
-  void _readGpioPort(bool immediate) override {
-    if (immediate) {
-      uint8_t buffer[2];
-      I2CManager.read(_I2CAddress, buffer, 2, 1, REG_INPUT_P0);
-      _portInputState = ((uint16_t)buffer[1]<<8) | buffer[0];
-      /* PCA9555 Int bug fix, from PCA9555 datasheet: "must change command byte to something besides 00h 
-       * after a Read operation to the PCA9555 device or before reading from 
-       * another device"
-       * Recommended solution, read from REG_OUTPUT_P0, then do nothing with the received data
-       * Issue not seen during testing, uncomment if needed 
-       */
-      //I2CManager.read(_I2CAddress, buffer, 2, 1, REG_OUTPUT_P0);
-    } else {
-      // Queue new request
-      requestBlock.wait(); // Wait for preceding operation to complete
-      // Issue new request to read GPIO register
-      I2CManager.queueRequest(&requestBlock);
-    }
-  }
-  // This function is invoked when an I/O operation on the requestBlock completes.
-  void _processCompletion(uint8_t status) override {
-    if (status == I2C_STATUS_OK) 
-      _portInputState = ((uint16_t)inputBuffer[1]<<8) | inputBuffer[0];
-    else  
-      _portInputState = 0xffff;
-  }
-
-  void _setupDevice() override {
-    // HAL API calls
-    _writePortModes();
-    _writePullups();
-    _writeGpioPort();
-  }
- 
-  uint8_t inputBuffer[2];
-  uint8_t outputBuffer[1];
- 
-
-  enum {
-    REG_INPUT_P0 = 0x00,
-    REG_INPUT_P1 = 0x01,
-    REG_OUTPUT_P0 = 0x02,
-    REG_OUTPUT_P1 = 0x03,
-    REG_POL_INV_P0 = 0x04,
-    REG_POL_INV_P1 = 0x05,
-    REG_CONF_P0 = 0x06,
-    REG_CONF_P1 = 0x07,    
-  };
-
-};
-
-#endif

IO_PCA9685.cpp

@@ -31,14 +31,15 @@ static const byte MODE1_AI=0x20;      /**< Auto-Increment enabled */
 static const byte MODE1_RESTART=0x80; /**< Restart enabled */
 
 static const float FREQUENCY_OSCILLATOR=25000000.0; /** Accurate enough for our purposes  */
+static const uint8_t PRESCALE_50HZ = (uint8_t)(((FREQUENCY_OSCILLATOR / (50.0 * 4096.0)) + 0.5) - 1);
 static const uint32_t MAX_I2C_SPEED = 1000000L; // PCA9685 rated up to 1MHz I2C clock speed
 
 // Predeclare helper function
 static void writeRegister(byte address, byte reg, byte value);
 
 // Create device driver instance.
-void PCA9685::create(VPIN firstVpin, int nPins, I2CAddress i2cAddress, uint16_t frequency) {
-  if (checkNoOverlap(firstVpin, nPins,i2cAddress)) new PCA9685(firstVpin, nPins, i2cAddress, frequency);
+void PCA9685::create(VPIN firstVpin, int nPins, uint8_t I2CAddress) {
+  if (checkNoOverlap(firstVpin, nPins,I2CAddress)) new PCA9685(firstVpin, nPins, I2CAddress);
 }
 
 // Configure a port on the PCA9685.
@@ -46,7 +47,7 @@ bool PCA9685::_configure(VPIN vpin, ConfigTypeEnum configType, int paramCount, i
   if (configType != CONFIGURE_SERVO) return false;
   if (paramCount != 5) return false;
   #ifdef DIAG_IO
-  DIAG(F("PCA9685 Configure VPIN:%u Apos:%d Ipos:%d Profile:%d Duration:%d state:%d"), 
+  DIAG(F("PCA9685 Configure VPIN:%d Apos:%d Ipos:%d Profile:%d Duration:%d state:%d"), 
     vpin, params[0], params[1], params[2], params[3], params[4]);
   #endif
 
@@ -72,14 +73,10 @@ bool PCA9685::_configure(VPIN vpin, ConfigTypeEnum configType, int paramCount, i
 }
 
 // Constructor
-PCA9685::PCA9685(VPIN firstVpin, int nPins, I2CAddress i2cAddress, uint16_t frequency) {
+PCA9685::PCA9685(VPIN firstVpin, int nPins, uint8_t I2CAddress) {
   _firstVpin = firstVpin;
-    _nPins = (nPins > 16) ? 16 : nPins;
-  _I2CAddress = i2cAddress;
-  // Calculate prescaler value for PWM clock
-  if (frequency > 1526) frequency = 1526;
-  else if (frequency < 24) frequency = 24;
-  prescaler = FREQUENCY_OSCILLATOR / 4096 / frequency;
+  _nPins = min(nPins, 16);
+  _I2CAddress = I2CAddress;
   // To save RAM, space for servo configuration is not allocated unless a pin is used.
   // Initialise the pointers to NULL.
   for (int i=0; i<_nPins; i++)
@@ -101,7 +98,7 @@ void PCA9685::_begin() {
   // Initialise I/O module here.
   if (I2CManager.exists(_I2CAddress)) {
     writeRegister(_I2CAddress, PCA9685_MODE1, MODE1_SLEEP | MODE1_AI);    
-    writeRegister(_I2CAddress, PCA9685_PRESCALE, prescaler);
+    writeRegister(_I2CAddress, PCA9685_PRESCALE, PRESCALE_50HZ);   // 50Hz clock, 20ms pulse period.
     writeRegister(_I2CAddress, PCA9685_MODE1, MODE1_AI);
     writeRegister(_I2CAddress, PCA9685_MODE1, MODE1_RESTART | MODE1_AI);
     // In theory, we should wait 500us before sending any other commands to each device, to allow
@@ -118,7 +115,7 @@ void PCA9685::_begin() {
 // For this function, the configured profile is used.
 void PCA9685::_write(VPIN vpin, int value) {
   #ifdef DIAG_IO
-  DIAG(F("PCA9685 Write VPIN:%u Value:%d"), vpin, value);
+  DIAG(F("PCA9685 Write Vpin:%d Value:%d"), vpin, value);
   #endif
   int pin = vpin - _firstVpin;
   if (value) value = 1;
@@ -145,7 +142,7 @@ void PCA9685::_write(VPIN vpin, int value) {
 //            
 void PCA9685::_writeAnalogue(VPIN vpin, int value, uint8_t profile, uint16_t duration) {
   #ifdef DIAG_IO
-  DIAG(F("PCA9685 WriteAnalogue VPIN:%u Value:%d Profile:%d Duration:%d %S"), 
+  DIAG(F("PCA9685 WriteAnalogue Vpin:%d Value:%d Profile:%d Duration:%d %S"), 
     vpin, value, profile, duration, _deviceState == DEVSTATE_FAILED?F("DEVSTATE_FAILED"):F(""));
   #endif
   if (_deviceState == DEVSTATE_FAILED) return;
@@ -242,13 +239,13 @@ void PCA9685::updatePosition(uint8_t pin) {
 // between 0 and 4095 for the PWM mark-to-period ratio, with 4095 being 100%.
 void PCA9685::writeDevice(uint8_t pin, int value) {
   #ifdef DIAG_IO
-  DIAG(F("PCA9685 I2C:%s WriteDevice Pin:%d Value:%d"), _I2CAddress.toString(), pin, value);
+  DIAG(F("PCA9685 I2C:x%x WriteDevice Pin:%d Value:%d"), _I2CAddress, pin, value);
   #endif
   // Wait for previous request to complete
   uint8_t status = requestBlock.wait();
   if (status != I2C_STATUS_OK) {
     _deviceState = DEVSTATE_FAILED;
-    DIAG(F("PCA9685 I2C:%s failed %S"), _I2CAddress.toString(), I2CManager.getErrorMessage(status));
+    DIAG(F("PCA9685 I2C:x%x failed %S"), _I2CAddress, I2CManager.getErrorMessage(status));
   } else {
     // Set up new request.
     outputBuffer[0] = PCA9685_FIRST_SERVO + 4 * pin;
@@ -262,7 +259,7 @@ void PCA9685::writeDevice(uint8_t pin, int value) {
 
 // Display details of this device.
 void PCA9685::_display() {
-  DIAG(F("PCA9685 I2C:%s Configured on Vpins:%u-%u %S"), _I2CAddress.toString(), (int)_firstVpin, 
+  DIAG(F("PCA9685 I2C:x%x Configured on Vpins:%d-%d %S"), _I2CAddress, (int)_firstVpin, 
     (int)_firstVpin+_nPins-1, (_deviceState==DEVSTATE_FAILED) ? F("OFFLINE") : F(""));
 }
 
@@ -275,5 +272,5 @@ static void writeRegister(byte address, byte reg, byte value) {
 // The profile below is in the range 0-100% and should be combined with the desired limits
 // of the servo set by _activePosition and _inactivePosition.  The profile is symmetrical here,
 // i.e. the bounce is the same on the down action as on the up action.  First entry isn't used.
-const uint8_t FLASH PCA9685::_bounceProfile[30] = 
+const byte FLASH PCA9685::_bounceProfile[30] = 
     {0,2,3,7,13,33,50,83,100,83,75,70,65,60,60,65,74,84,100,83,75,70,70,72,75,80,87,92,97,100};

IO_PCA9685pwm.h

@@ -1,170 +0,0 @@
-/*
- *  © 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/>.
- */
-
-/* 
- * This driver performs the basic interface between the HAL and an 
- * I2C-connected PCA9685 16-channel PWM module.  When requested, it 
- * commands the device to set the PWM mark-to-period ratio accordingly.
- * The call to IODevice::writeAnalogue(vpin, value) specifies the
- * desired value in the range 0-4095 (0=0% and 4095=100%).
- * 
- * This driver can be used for simple servo control by writing values between
- * about 102 and 450 (extremes of movement for 9g micro servos) or 150 to 250
- * for a more restricted range (corresponding to 1.5ms to 2.5ms pulse length).
- * A value of zero will switch off the servo.  To create the device, use
- * the following syntax:
- * 
- * PCA9685_basic::create(vpin, npins, i2caddress);
- * 
- * For LED control, a value of 0 is fully off, and 4095 is fully on.  It is
- * recommended, to reduce flicker of LEDs, that the frequency be configured
- * to a value higher than the default of 50Hz.  To do this, create the device
- * as follows, for a frequency of 200Hz.:
- * 
- * PCA9685_basic::create(vpin, npins, i2caddress, 200);
- * 
- */
-
-#ifndef PCA9685_BASIC_H
-#define PCA9685_BASIC_H
-
-#include "IODevice.h"
-#include "I2CManager.h"
-#include "DIAG.h"
-
-/*
- * IODevice subclass for PCA9685 16-channel PWM module.
- */
- 
-class PCA9685pwm : public IODevice {
-public:
-  // Create device driver instance.
-  static void create(VPIN firstVpin, int nPins, I2CAddress i2cAddress, uint16_t frequency = 50) {
-    if (checkNoOverlap(firstVpin, nPins, i2cAddress)) new PCA9685pwm(firstVpin, nPins, i2cAddress, frequency);
-  }
-
-private:
-  
-  // structures for setting up non-blocking writes to PWM controller
-  I2CRB requestBlock;
-  uint8_t outputBuffer[5];
-  uint16_t prescaler;
-
-  // REGISTER ADDRESSES
-  const uint8_t PCA9685_MODE1=0x00;      // Mode Register 
-  const uint8_t PCA9685_FIRST_SERVO=0x06;  /** low uint8_t first PWM register ON*/
-  const uint8_t PCA9685_PRESCALE=0xFE;     /** Prescale register for PWM output frequency */
-  // MODE1 bits
-  const uint8_t MODE1_SLEEP=0x10;   /**< Low power mode. Oscillator off */
-  const uint8_t MODE1_AI=0x20;      /**< Auto-Increment enabled */
-  const uint8_t MODE1_RESTART=0x80; /**< Restart enabled */
-
-  const uint32_t FREQUENCY_OSCILLATOR=25000000; /** Accurate enough for our purposes  */
-  const uint8_t PRESCALE_50HZ = (uint8_t)(((FREQUENCY_OSCILLATOR / (50.0 * 4096.0)) + 0.5) - 1);
-  const uint32_t MAX_I2C_SPEED = 1000000L; // PCA9685 rated up to 1MHz I2C clock speed
-
-  // Constructor
-  PCA9685pwm(VPIN firstVpin, int nPins, I2CAddress i2cAddress, uint16_t frequency) {
-    _firstVpin = firstVpin;
-    _nPins = (nPins>16) ? 16 : nPins;
-    _I2CAddress = i2cAddress;
-    if (frequency > 1526) frequency = 1526;
-    else if (frequency < 24) frequency = 24;
-    prescaler = FREQUENCY_OSCILLATOR / 4096 / frequency;
-    addDevice(this);
-
-    // Initialise structure used for setting pulse rate
-    requestBlock.setWriteParams(_I2CAddress, outputBuffer, sizeof(outputBuffer));
-  }
-
-  // Device-specific initialisation
-  void _begin() override {
-    I2CManager.begin();
-    I2CManager.setClock(1000000); // Nominally able to run up to 1MHz on I2C
-            // In reality, other devices including the Arduino will limit 
-            // the clock speed to a lower rate.
-
-    // Initialise I/O module here.
-    if (I2CManager.exists(_I2CAddress)) {
-      writeRegister(_I2CAddress, PCA9685_MODE1, MODE1_SLEEP | MODE1_AI);
-      writeRegister(_I2CAddress, PCA9685_PRESCALE, prescaler);
-      writeRegister(_I2CAddress, PCA9685_MODE1, MODE1_AI);
-      writeRegister(_I2CAddress, PCA9685_MODE1, MODE1_RESTART | MODE1_AI);
-      // In theory, we should wait 500us before sending any other commands to each device, to allow
-      // the PWM oscillator to get running.  However, we don't do any specific wait, as there's 
-      // plenty of other stuff to do before we will send a command.
-    #if defined(DIAG_IO)
-      _display();
-    #endif
-    } else
-      _deviceState = DEVSTATE_FAILED;
-  }
-
-  // Device-specific writeAnalogue function, invoked from IODevice::writeAnalogue().
-  //            
-  void _writeAnalogue(VPIN vpin, int value, uint8_t param1, uint16_t param2) override {
-    (void)param1; (void)param2;  // suppress compiler warning
-    #ifdef DIAG_IO
-    DIAG(F("PCA9685pwm WriteAnalogue VPIN:%u Value:%d %S"), 
-      vpin, value, _deviceState == DEVSTATE_FAILED?F("DEVSTATE_FAILED"):F(""));
-    #endif
-    if (_deviceState == DEVSTATE_FAILED) return;
-    int pin = vpin - _firstVpin;
-    if (value > 4095) value = 4095;
-    else if (value < 0) value = 0;
-
-    writeDevice(pin, value);
-  }
-
-  // Display details of this device.
-  void _display() override {
-    DIAG(F("PCA9685pwm I2C:%s Configured on Vpins:%u-%u %S"), _I2CAddress.toString(), (int)_firstVpin, 
-      (int)_firstVpin+_nPins-1, (_deviceState==DEVSTATE_FAILED) ? F("OFFLINE") : F(""));
-  }
-
-  // writeDevice (helper function) takes a pin in range 0 to _nPins-1 within the device, and a value
-  // between 0 and 4095 for the PWM mark-to-period ratio, with 4095 being 100%.
-  void writeDevice(uint8_t pin, int value) {
-    #ifdef DIAG_IO
-    DIAG(F("PCA9685pwm I2C:%s WriteDevice Pin:%d Value:%d"), _I2CAddress.toString(), pin, value);
-    #endif
-    // Wait for previous request to complete
-    uint8_t status = requestBlock.wait();
-    if (status != I2C_STATUS_OK) {
-      _deviceState = DEVSTATE_FAILED;
-      DIAG(F("PCA9685pwm I2C:%s failed %S"), _I2CAddress.toString(), I2CManager.getErrorMessage(status));
-    } else {
-      // Set up new request.
-      outputBuffer[0] = PCA9685_FIRST_SERVO + 4 * pin;
-      outputBuffer[1] = 0;
-      outputBuffer[2] = (value == 4095 ? 0x10 : 0);  // 4095=full on
-      outputBuffer[3] = value & 0xff;
-      outputBuffer[4] = value >> 8;
-      I2CManager.queueRequest(&requestBlock);
-    }
-  }
-
-  // Internal helper function for this device
-  static void writeRegister(I2CAddress address, uint8_t reg, uint8_t value) {
-    I2CManager.write(address, 2, reg, value);
-  }
-
-};
-
-#endif

IO_PCF8574.h

@@ -43,22 +43,20 @@
 
 class PCF8574 : public GPIOBase<uint8_t> {
 public:
-  static void create(VPIN firstVpin, uint8_t nPins, I2CAddress i2cAddress, int interruptPin=-1) {
-    if (checkNoOverlap(firstVpin, nPins, i2cAddress)) new PCF8574(firstVpin, nPins, i2cAddress, interruptPin);
+  static void create(VPIN firstVpin, uint8_t nPins, uint8_t I2CAddress, int interruptPin=-1) {
+    if (checkNoOverlap(firstVpin, nPins,I2CAddress)) new PCF8574(firstVpin, nPins, I2CAddress, interruptPin);
   }
 
 private:
-  PCF8574(VPIN firstVpin, uint8_t nPins, I2CAddress i2cAddress, int interruptPin=-1)
-    : GPIOBase<uint8_t>((FSH *)F("PCF8574"), firstVpin, nPins, i2cAddress, interruptPin) 
+  PCF8574(VPIN firstVpin, uint8_t nPins, uint8_t I2CAddress, int interruptPin=-1)
+    : GPIOBase<uint8_t>((FSH *)F("PCF8574"), firstVpin, min(nPins, (uint8_t)8), I2CAddress, interruptPin) 
   {
     requestBlock.setReadParams(_I2CAddress, inputBuffer, 1);
   }
   
-  // The PCF8574 handles inputs by applying a weak pull-up when output is driven to '1'.
-  // The pin state is driven '1' if the pin is an input, or if it is an output set to 1.
-  // Unused pins are driven '0'.
+  // The pin state is '1' if the pin is an input or if it is an output set to 1.  Zero otherwise. 
   void _writeGpioPort() override {
-    I2CManager.write(_I2CAddress, 1, (_portOutputState | ~_portMode) & _portInUse);
+    I2CManager.write(_I2CAddress, 1, _portOutputState | ~_portMode);
   }
 
   // The PCF8574 handles inputs by applying a weak pull-up when output is driven to '1'.
@@ -66,8 +64,9 @@ private:
   // and enable pull-up.
   void _writePullups() override { }
 
+  // The pin state is '1' if the pin is an input or if it is an output set to 1.  Zero otherwise. 
   void _writePortModes() override {
-    _writeGpioPort();
+    I2CManager.write(_I2CAddress, 1, _portOutputState | ~_portMode);
   }
 
   // In immediate mode, _readGpioPort reads the device GPIO port and updates _portInputState accordingly.
@@ -77,7 +76,7 @@ private:
     if (immediate) {
       uint8_t buffer[1];
       I2CManager.read(_I2CAddress, buffer, 1);
-      _portInputState = buffer[0] | _portMode;
+      _portInputState = buffer[0];
     } else {
       requestBlock.wait(); // Wait for preceding operation to complete
       // Issue new request to read GPIO register
@@ -88,7 +87,7 @@ private:
   // This function is invoked when an I/O operation on the requestBlock completes.
   void _processCompletion(uint8_t status) override {
     if (status == I2C_STATUS_OK) 
-      _portInputState = inputBuffer[0] | _portMode;
+      _portInputState = inputBuffer[0];
     else  
       _portInputState = 0xff; 
   }

IO_PCF8575.h

@@ -1,109 +0,0 @@
-/*
- *  © 2023, Paul Antoine, and Discord user @ADUBOURG
- *  © 2021, 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/>.
- */
-
-/* 
- * The PCF8575 is a simple device; it only has one register.  The device 
- * input/output mode and pullup are configured through this, and the 
- * output state is written and the input state read through it too.
- * 
- * This is accomplished by having a weak resistor in series with the output,
- * and a read-back of the other end of the resistor.  As an output, the 
- * pin state is set to 1 or 0, and the output voltage goes to +5V or 0V
- * (through the weak resistor).
- * 
- * In order to use the pin as an input, the output is written as
- * a '1' in order to pull up the resistor.  Therefore the input will be
- * 1 unless the pin is pulled down externally, in which case it will be 0.
- * 
- * As a consequence of this approach, it is not possible to use the device for
- * inputs without pullups.
- */
-
-#ifndef IO_PCF8575_H
-#define IO_PCF8575_H
-
-#include "IO_GPIOBase.h"
-#include "FSH.h"
-
-class PCF8575 : public GPIOBase<uint16_t> {
-public:
-  static void create(VPIN firstVpin, uint8_t nPins, I2CAddress i2cAddress, int interruptPin=-1) {
-    if (checkNoOverlap(firstVpin, nPins, i2cAddress)) new PCF8575(firstVpin, nPins, i2cAddress, interruptPin);
-  }
-
-private:
-  PCF8575(VPIN firstVpin, uint8_t nPins, I2CAddress i2cAddress, int interruptPin=-1)
-    : GPIOBase<uint16_t>((FSH *)F("PCF8575"), firstVpin, nPins, i2cAddress, interruptPin)
-  {
-    requestBlock.setReadParams(_I2CAddress, inputBuffer, sizeof(inputBuffer));
-  }
-  
-  // The PCF8575 handles inputs by applying a weak pull-up when output is driven to '1'.
-  // The pin state is driven '1' if the pin is an input, or if it is an output set to 1.
-  // Unused pins are driven '0'.
-  void _writeGpioPort() override {
-    uint16_t bits = (_portOutputState | ~_portMode) & _portInUse;
-    I2CManager.write(_I2CAddress, 2, bits, bits>>8);
-  }
-
-  // The PCF8575 handles inputs by applying a weak pull-up when output is driven to '1'.
-  // Therefore, writing '1' in _writePortModes is enough to set the module to input mode 
-  // and enable pull-up.
-  void _writePullups() override { }
-
-  // The pin state is '1' if the pin is an input or if it is an output set to 1.  Zero otherwise. 
-  void _writePortModes() override {
-    _writeGpioPort();
-  }
-
-  // In immediate mode, _readGpioPort reads the device GPIO port and updates _portInputState accordingly.
-  //  When not in immediate mode, it initiates a request using the request block and returns.
-  //  When the request completes, _processCompletion finishes the operation.
-  void _readGpioPort(bool immediate) override {
-    if (immediate) {
-      uint8_t buffer[2];
-      I2CManager.read(_I2CAddress, buffer, 2);
-      _portInputState = (((uint16_t)buffer[1]<<8) | buffer[0]) | _portMode;
-    } else {
-      requestBlock.wait(); // Wait for preceding operation to complete
-      // Issue new request to read GPIO register
-      I2CManager.queueRequest(&requestBlock);
-    }
-  }
-
-  // This function is invoked when an I/O operation on the requestBlock completes.
-  void _processCompletion(uint8_t status) override {
-    if (status == I2C_STATUS_OK) 
-      _portInputState = (((uint16_t)inputBuffer[1]<<8) | inputBuffer[0]) | _portMode;
-    else  
-      _portInputState = 0xffff;
-  }
-
-  // Set up device ports
-  void _setupDevice() override { 
-    _writePortModes();
-    _writeGpioPort();
-    _writePullups();
-  }
- 
-  uint8_t inputBuffer[2];
-};
-
-#endif

IO_RotaryEncoder.h

@@ -1,5 +1,4 @@
 /*
- *  © 2023, Peter Cole. All rights reserved.
  *  © 2022, Peter Cole. All rights reserved.
  *
  *  This file is part of EX-CommandStation
@@ -29,23 +28,9 @@
 * ONCHANGE(vpin) - flag when the rotary encoder position has changed from the previous position
 * IFRE(vpin, position) - test to see if specified rotary encoder position has been received
 *
-* Feedback can also be sent to the rotary encoder by using 2 Vpins, and sending a SET()/RESET() to the second Vpin.
+* Further to this, feedback can be sent to the rotary encoder by using 2 Vpins, and sending a SET()/RESET() to the second Vpin.
 * A SET(vpin) will flag that a turntable (or anything else) is in motion, and a RESET(vpin) that the motion has finished.
 *
-* In addition, defining a third Vpin will allow a position number to be sent so that when an EXRAIL automation or some other
-* activity has moved a turntable, the position can be reflected in the rotary encoder software. This can be accomplished
-* using the EXRAIL SERVO(vpin, position, profile) command, where:
-* - vpin = the third defined Vpin (any other is ignored)
-* - position = the defined position in the DCC-EX Rotary Encoder software, 0 (Home) to 255
-* - profile = Must be defined as per the SERVO() command, but is ignored as it has no relevance
-*
-* Defining in myAutomation.h requires the device driver to be included in addition to the HAL() statement. Examples:
-*
-* #include "IO_RotaryEncoder.h"
-* HAL(RotaryEncoder, 700, 1, 0x70)    // Define single Vpin, no feedback or position sent to rotary encoder software
-* HAL(RotaryEncoder, 700, 2, 0x70)    // Define two Vpins, feedback only sent to rotary encoder software
-* HAL(RotaryEncoder, 700, 3, 0x70)    // Define three Vpins, can send feedback and position update to rotary encoder software
-*
 * Refer to the documentation for further information including the valid activities and examples.
 */
 
@@ -59,132 +44,82 @@
 
 class RotaryEncoder : public IODevice {
 public:
-  
-  static void create(VPIN firstVpin, int nPins, I2CAddress i2cAddress) {
-    if (checkNoOverlap(firstVpin, nPins, i2cAddress)) new RotaryEncoder(firstVpin, nPins, i2cAddress);
+  // Constructor
+  RotaryEncoder(VPIN firstVpin, int nPins, uint8_t I2CAddress){
+    _firstVpin = firstVpin;
+    _nPins = nPins;
+    _I2CAddress = I2CAddress;
+    addDevice(this);
+  }
+  static void create(VPIN firstVpin, int nPins, uint8_t I2CAddress) {
+    if (checkNoOverlap(firstVpin, nPins, I2CAddress)) new RotaryEncoder(firstVpin, nPins, I2CAddress);
   }
 
 private:
-  // Constructor
-  RotaryEncoder(VPIN firstVpin, int nPins, I2CAddress i2cAddress){
-    _firstVpin = firstVpin;
-    _nPins = nPins;
-    if (_nPins > 3) {
-      _nPins = 3;
-      DIAG(F("RotaryEncoder WARNING:%d vpins defined, only 3 supported"), _nPins);
-    }
-    _I2CAddress = i2cAddress;
-    addDevice(this);
-  }
-
   // Initiate the device
   void _begin() {
-    uint8_t _status;
-    // Attempt to initilalise device
     I2CManager.begin();
     if (I2CManager.exists(_I2CAddress)) {
-      // Send RE_RDY, must receive RE_RDY to be online
-      _sendBuffer[0] = RE_RDY;
-      _status = I2CManager.read(_I2CAddress, _rcvBuffer, 1, _sendBuffer, 1);
-      if (_status == I2C_STATUS_OK) {
-        if (_rcvBuffer[0] == RE_RDY) {
-          _sendBuffer[0] = RE_VER;
-          if (I2CManager.read(_I2CAddress, _versionBuffer, 3, _sendBuffer, 1) == I2C_STATUS_OK) {
-            _majorVer = _versionBuffer[0];
-            _minorVer = _versionBuffer[1];
-            _patchVer = _versionBuffer[2];
-          }
-        } else {
-          DIAG(F("RotaryEncoder I2C:%s garbage received: %d"), _I2CAddress.toString(), _rcvBuffer[0]);
-          _deviceState = DEVSTATE_FAILED;
-          return;
-        }
-      } else {
-        DIAG(F("RotaryEncoder I2C:%s ERROR connecting"), _I2CAddress.toString());
-        _deviceState = DEVSTATE_FAILED;
-        return;
-      }
+      byte _getVersion[1] = {RE_VER};
+      I2CManager.read(_I2CAddress, _versionBuffer, 3, _getVersion, 1);
+      _majorVer = _versionBuffer[0];
+      _minorVer = _versionBuffer[1];
+      _patchVer = _versionBuffer[2];
+      _buffer[0] = RE_OP;
+      I2CManager.write(_I2CAddress, _buffer, 1);
 #ifdef DIAG_IO
       _display();
 #endif
     } else {
-      DIAG(F("RotaryEncoder I2C:%s device not found"), _I2CAddress.toString());
-      _deviceState = DEVSTATE_FAILED;
+        _deviceState = DEVSTATE_FAILED;
     }
   }
 
   void _loop(unsigned long currentMicros) override {
-    if (_deviceState == DEVSTATE_FAILED) return;  // Return if device has failed
-    if (_i2crb.isBusy()) return;                  // Return if I2C operation still in progress
-
-    if (currentMicros - _lastPositionRead > _positionRefresh) {
-      _lastPositionRead = currentMicros;
-      _sendBuffer[0] = RE_READ;
-      I2CManager.read(_I2CAddress, _rcvBuffer, 1, _sendBuffer, 1, &_i2crb); // Read position from encoder
-      _position = _rcvBuffer[0];
-      // If EXRAIL is active, we need to trigger the ONCHANGE() event handler if it's in use
-#if defined(EXRAIL_ACTIVE)
+    I2CManager.read(_I2CAddress, _buffer, 1);
+    _position = _buffer[0];
+    // This here needs to have a change check, ie. position is a different value.
+  #if defined(EXRAIL_ACTIVE)
       if (_position != _previousPosition) {
         _previousPosition = _position;
-        RMFT2::changeEvent(_firstVpin, 1);
+        RMFT2::changeEvent(_firstVpin,1);
       } else {
-        RMFT2::changeEvent(_firstVpin, 0);
+        RMFT2::changeEvent(_firstVpin,0);
       }
-#endif
-    }
+  #endif
+    delayUntil(currentMicros + 100000);
   }
 
-  // Return the position sent by the rotary encoder software
+  // Device specific read function
   int _readAnalogue(VPIN vpin) override {
     if (_deviceState == DEVSTATE_FAILED) return 0;
     return _position;
   }
 
-  // Send the feedback value to the rotary encoder software
   void _write(VPIN vpin, int value) override {
     if (vpin == _firstVpin + 1) {
-      if (value != 0) value = 0x01;
-      byte _feedbackBuffer[2] = {RE_OP, (byte)value};
+      byte _feedbackBuffer[2] = {RE_OP, value};
       I2CManager.write(_I2CAddress, _feedbackBuffer, 2);
     }
   }
-
-  // Send a position update to the rotary encoder software
-  // To be valid, must be 0 to 255, and different to the current position
-  // If the current position is the same, it was initiated by the rotary encoder
-  void _writeAnalogue(VPIN vpin, int position, uint8_t profile, uint16_t duration) override {
-    if (vpin == _firstVpin + 2) {
-      if (position >= 0 && position <= 255 && position != _position) {
-        byte newPosition = position & 0xFF;
-        byte _positionBuffer[2] = {RE_MOVE, newPosition};
-        I2CManager.write(_I2CAddress, _positionBuffer, 2);
-      }
-    }
-  }
   
   void _display() override {
-    DIAG(F("Rotary Encoder I2C:%s v%d.%d.%d Configured on VPIN:%u-%d %S"), _I2CAddress.toString(), _majorVer, _minorVer, _patchVer,
+    DIAG(F("Rotary Encoder I2C:x%x v%d.%d.%d Configured on Vpin:%d-%d %S"), _I2CAddress, _majorVer, _minorVer, _patchVer,
       (int)_firstVpin, _firstVpin+_nPins-1, (_deviceState==DEVSTATE_FAILED) ? F("OFFLINE") : F(""));
   }
 
+  uint8_t _I2CAddress;
   int8_t _position;
   int8_t _previousPosition = 0;
   uint8_t _versionBuffer[3];
-  uint8_t _sendBuffer[1];
-  uint8_t _rcvBuffer[1];
+  uint8_t _buffer[1];
   uint8_t _majorVer = 0;
   uint8_t _minorVer = 0;
   uint8_t _patchVer = 0;
-  I2CRB _i2crb;
-  unsigned long _lastPositionRead = 0;
-  const unsigned long _positionRefresh = 100000UL;    // Delay refreshing position for 100ms
 
   enum {
-    RE_RDY = 0xA0,   // Flag to check if encoder is ready for operation
-    RE_VER = 0xA1,   // Flag to retrieve rotary encoder software version
-    RE_READ = 0xA2,  // Flag to read the current position of the encoder
-    RE_OP = 0xA3,    // Flag for operation start/end, sent to when sending feedback on move start/end
-    RE_MOVE = 0xA4,  // Flag for sending a position update from the device driver to the encoder
+    RE_VER = 0xA0,   // Flag to retrieve rotary encoder version from the device
+    RE_OP = 0xA1,    // Flag for normal operation
   };
 
 };

IO_Servo.cpp

@@ -1,33 +0,0 @@
-/*
- *  © 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/>.
- */
-
-#include "IO_Servo.h"
-#include "FSH.h"
-
-// Profile for a bouncing signal or turnout
-// The profile below is in the range 0-100% and should be combined with the desired limits
-// of the servo set by _activePosition and _inactivePosition.  The profile is symmetrical here,
-// i.e. the bounce is the same on the down action as on the up action.  First entry isn't used.
-//
-// Note: This has been put into its own .CPP file to ensure that duplicates aren't created
-// if the IO_Servo.h library is #include'd in multiple source files.
-//
-const uint8_t FLASH Servo::_bounceProfile[30] = 
-    {0,2,3,7,13,33,50,83,100,83,75,70,65,60,60,65,74,84,100,83,75,70,70,72,75,80,87,92,97,100};
-

IO_Servo.h

@@ -1,298 +0,0 @@
-/*
- *  © 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/>.
- */
-
-/*
- * This device is a layered device which is designed to sit on top of another
- * device.  The underlying device class is expected to accept writeAnalogue calls 
- * which will normally cause some physical movement of something.  The device may be a servo, 
- * a motor or some other kind of positioner, and the something might be a turnout,
- * a semaphore signal or something else.  One user has used this capability for
- * moving a figure along the platform on their layout!
- * 
- * Example of use:
- *    In myHal.cpp, 
- * 
- * #include "IO_Servo.h"
- * ...
- * PCA9685::create(100,16,0x40);   // First create the hardware interface device
- * Servo::create(300,16,100);    // Then create the higher level device which 
- *                               // references pins 100-115 or a subset of them.
- * 
- * Then any reference to pins 300-315 will cause the servo driver to send output
- * PWM commands to the corresponding PCA9685 driver pins 100-115.  The PCA9685 driver may
- * be substituted with any other driver which provides analogue output 
- * capability, e.g. EX-IOExpander devices, as long as they are capable of interpreting 
- * the writeAnalogue() function calls.
- */
-
-#include "IODevice.h"
-
-#ifndef IO_SERVO_H
-#define IO_SERVO_H
-
-#include "I2CManager.h"
-#include "DIAG.h"
-
-class Servo : IODevice {
-
-public: 
-  enum ProfileType : uint8_t {
-    Instant = 0,  // Moves immediately between positions (if duration not specified)
-    UseDuration = 0, // Use specified duration
-    Fast = 1,     // Takes around 500ms end-to-end
-    Medium = 2,   // 1 second end-to-end
-    Slow = 3,     // 2 seconds end-to-end
-    Bounce = 4,   // For semaphores/turnouts with a bit of bounce!!
-    NoPowerOff = 0x80, // Flag to be ORed in to suppress power off after move.
-  };
-
-  // Create device driver instance.
-  static void create(VPIN firstVpin, int nPins, VPIN firstSlavePin=VPIN_NONE) {
-    new Servo(firstVpin, nPins, firstSlavePin);
-  }
-
-private:
-  VPIN _firstSlavePin;
-  IODevice *_slaveDevice = NULL;
-
-  struct ServoData {
-    uint16_t activePosition : 12; // Config parameter
-    uint16_t inactivePosition : 12; // Config parameter
-    uint16_t currentPosition : 12;
-    uint16_t fromPosition : 12;
-    uint16_t toPosition : 12; 
-    uint8_t profile;  // Config parameter
-    uint16_t stepNumber; // Index of current step (starting from 0)
-    uint16_t numSteps;  // Number of steps in animation, or 0 if none in progress.
-    uint8_t currentProfile; // profile being used for current animation.
-    uint16_t duration; // time (tenths of a second) for animation to complete.
-  }; // 14 bytes per element, i.e. per pin in use
-  
-  struct ServoData *_servoData [16];
-
-  static const uint8_t _catchupSteps = 5; // number of steps to wait before switching servo off
-  static const uint8_t FLASH _bounceProfile[30];
-
-  const unsigned int refreshInterval = 50; // refresh every 50ms
-
-
-  // Configure a port on the Servo.
-  bool _configure(VPIN vpin, ConfigTypeEnum configType, int paramCount, int params[]) {
-    if (_deviceState == DEVSTATE_FAILED) return false;
-    if (configType != CONFIGURE_SERVO) return false;
-    if (paramCount != 5) return false;
-    #ifdef DIAG_IO
-    DIAG(F("Servo: Configure VPIN:%u Apos:%d Ipos:%d Profile:%d Duration:%d state:%d"), 
-      vpin, params[0], params[1], params[2], params[3], params[4]);
-    #endif
-
-    int8_t pin = vpin - _firstVpin;
-    struct ServoData *s = _servoData[pin];
-    if (s == NULL) { 
-      _servoData[pin] = (struct ServoData *)calloc(1, sizeof(struct ServoData));
-      s = _servoData[pin];
-      if (!s) return false; // Check for failed memory allocation
-    }
-
-    s->activePosition = params[0];
-    s->inactivePosition = params[1];
-    s->profile = params[2];
-    s->duration = params[3];
-    int state = params[4];
-
-    if (state != -1) {
-      // Position servo to initial state
-      writeAnalogue(vpin, state ? s->activePosition : s->inactivePosition);
-    } 
-    return true;
-  }
-
-  // Constructor
-  Servo(VPIN firstVpin, int nPins, VPIN firstSlavePin = VPIN_NONE) {
-    _firstVpin = firstVpin;
-    _nPins = (nPins > 16) ? 16 : nPins;
-    if (firstSlavePin == VPIN_NONE)
-      _firstSlavePin = firstVpin;
-    else
-      _firstSlavePin = firstSlavePin;
-
-    // To save RAM, space for servo configuration is not allocated unless a pin is used.
-    // Initialise the pointers to NULL.
-    for (int i=0; i<_nPins; i++)
-      _servoData[i] = NULL;
-
-    // Get reference to slave device.
-    _slaveDevice = findDevice(_firstSlavePin);
-    if (!_slaveDevice) {
-      DIAG(F("Servo: Slave device not found on Vpins %u-%u"), 
-        _firstSlavePin, _firstSlavePin+_nPins-1);
-      _deviceState = DEVSTATE_FAILED;
-    }      
-    if (_slaveDevice != findDevice(_firstSlavePin+_nPins-1)) {
-      DIAG(F("Servo: Slave device does not cover all Vpins %u-%u"), 
-        _firstSlavePin, _firstSlavePin+_nPins-1);
-      _deviceState = DEVSTATE_FAILED;
-    }
-
-    addDevice(this, _slaveDevice); // Link device ahead of slave device to intercept requests
-  }
-
-  // Device-specific initialisation
-  void _begin() override {
-    #if defined(DIAG_IO)
-    _display();
-    #endif
-  }
-
-  // Device-specific write function, invoked from IODevice::write().  
-  // For this function, the configured profile is used.
-  void _write(VPIN vpin, int value) override {
-    if (_deviceState == DEVSTATE_FAILED) return;
-    #ifdef DIAG_IO
-    DIAG(F("Servo Write VPIN:%u Value:%d"), vpin, value);
-    #endif
-    int pin = vpin - _firstVpin;
-    if (value) value = 1;
-
-    struct ServoData *s = _servoData[pin];
-    if (s != NULL) {
-      // Use configured parameters
-      writeAnalogue(vpin, value ? s->activePosition : s->inactivePosition, s->profile, s->duration);
-    }  else {
-      /* simulate digital pin on PWM */
-      writeAnalogue(vpin, value ? 4095 : 0, Instant | NoPowerOff, 0);     
-    }
-  }
-
-  // Device-specific writeAnalogue function, invoked from IODevice::writeAnalogue().
-  // Profile is as follows:
-  //  Bit 7:     0=Set output to 0% to power off servo motor when finished
-  //             1=Keep output at final position (better with LEDs, which will stay lit)
-  //  Bits 6-0:  0           Use specified duration (defaults to 0 deciseconds)
-  //             1 (Fast)    Move servo in 0.5 seconds
-  //             2 (Medium)  Move servo in 1.0 seconds
-  //             3 (Slow)    Move servo in 2.0 seconds
-  //             4 (Bounce)  Servo 'bounces' at extremes.
-  // Duration is in deciseconds (tenths of a second) and defaults to 0.  
-  //            
-  void _writeAnalogue(VPIN vpin, int value, uint8_t profile, uint16_t duration) override {
-    #ifdef DIAG_IO
-    DIAG(F("Servo: WriteAnalogue VPIN:%u Value:%d Profile:%d Duration:%d %S"), 
-      vpin, value, profile, duration, _deviceState == DEVSTATE_FAILED?F("DEVSTATE_FAILED"):F(""));
-    #endif
-    if (_deviceState == DEVSTATE_FAILED) return;
-    int pin = vpin - _firstVpin;
-    if (value > 4095) value = 4095;
-    else if (value < 0) value = 0;
-
-    struct ServoData *s = _servoData[pin];
-    if (s == NULL) {
-      // Servo pin not configured, so configure now using defaults
-      s = _servoData[pin] = (struct ServoData *) calloc(sizeof(struct ServoData), 1);
-      if (s == NULL) return;  // Check for memory allocation failure
-      s->activePosition = 4095;
-      s->inactivePosition = 0;
-      s->currentPosition = value;
-      s->profile = Instant | NoPowerOff;  // Use instant profile (but not this time)
-    }
-
-    // Animated profile.  Initiate the appropriate action.
-    s->currentProfile = profile;
-    uint8_t profileValue = profile & ~NoPowerOff;  // Mask off 'don't-power-off' bit.
-    s->numSteps = profileValue==Fast ? 10 :   // 0.5 seconds
-                  profileValue==Medium ? 20 : // 1.0 seconds
-                  profileValue==Slow ? 40 :   // 2.0 seconds
-                  profileValue==Bounce ? sizeof(_bounceProfile)-1 : // ~ 1.5 seconds
-                  duration * 2 + 1; // Convert from deciseconds (100ms) to refresh cycles (50ms)
-    s->stepNumber = 0;
-    s->toPosition = value;
-    s->fromPosition = s->currentPosition;
-  }
-
-  // _read returns true if the device is currently in executing an animation, 
-  //  changing the output over a period of time.
-  int _read(VPIN vpin) override {
-    if (_deviceState == DEVSTATE_FAILED) return 0;
-    int pin = vpin - _firstVpin;
-    struct ServoData *s = _servoData[pin];
-    if (s == NULL) 
-      return false; // No structure means no animation!
-    else
-      return (s->stepNumber < s->numSteps);
-  }
-
-  void _loop(unsigned long currentMicros) override {
-    if (_deviceState == DEVSTATE_FAILED) return;
-    for (int pin=0; pin<_nPins; pin++) {
-      updatePosition(pin);
-    }
-    delayUntil(currentMicros + refreshInterval * 1000UL);
-  }
-
-  // Private function to reposition servo
-  // TODO: Could calculate step number from elapsed time, to allow for erratic loop timing.
-  void updatePosition(uint8_t pin) {
-    struct ServoData *s = _servoData[pin];
-    if (s == NULL) return; // No pin configuration/state data
-
-    if (s->numSteps == 0) return; // No animation in progress
-
-    if (s->stepNumber == 0 && s->fromPosition == s->toPosition) {
-      // Go straight to end of sequence, output final position.
-      s->stepNumber = s->numSteps-1;
-    }
-
-    if (s->stepNumber < s->numSteps) {
-      // Animation in progress, reposition servo
-      s->stepNumber++;
-      if ((s->currentProfile & ~NoPowerOff) == Bounce) {
-        // Retrieve step positions from array in flash
-        uint8_t profileValue = GETFLASH(&_bounceProfile[s->stepNumber]);
-        s->currentPosition = map(profileValue, 0, 100, s->fromPosition, s->toPosition);
-      } else {
-        // All other profiles - calculate step by linear interpolation between from and to positions.
-        s->currentPosition = map(s->stepNumber, 0, s->numSteps, s->fromPosition, s->toPosition);
-      }
-      // Send servo command to output driver
-      _slaveDevice->_writeAnalogue(_firstSlavePin+pin, s->currentPosition);
-    } else if (s->stepNumber < s->numSteps + _catchupSteps) {
-      // We've finished animation, wait a little to allow servo to catch up
-      s->stepNumber++;
-    } else if (s->stepNumber == s->numSteps + _catchupSteps 
-              && s->currentPosition != 0) {
-  #ifdef IO_SWITCH_OFF_SERVO
-      if ((s->currentProfile & NoPowerOff) == 0) {
-        // Wait has finished, so switch off output driver to avoid servo buzz.
-        _slaveDevice->_writeAnalogue(_firstSlavePin+pin, 0);
-      }
-  #endif
-      s->numSteps = 0;  // Done now.
-    }
-  }
-
-  // Display details of this device.
-  void _display() override {
-    DIAG(F("Servo Configured on Vpins:%u-%u, slave pins:%d-%d %S"),
-      (int)_firstVpin, (int)_firstVpin+_nPins-1,
-      (int)_firstSlavePin, (int)_firstSlavePin+_nPins-1,
-      (_deviceState==DEVSTATE_FAILED) ? F("OFFLINE") : F(""));
-  }
-};
-
-#endif

IO_TouchKeypad.h

@@ -1,134 +0,0 @@
-/*
- *  © 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/>.
- */
-
-/* 
- * Driver for capacitative touch-pad based on the TTP229-B chip with serial 
- * (not I2C) output.  The touchpad has 16 separate pads in a 4x4 matrix, 
- * numbered 1-16.  The communications with the pad are via a clock signal sent
- * from the controller to the device, and a data signal sent back by the device.
- * The pins clockPin and dataPin must be local pins, not external (GPIO Expander)
- * pins.
- * 
- * To use, 
- *    TouchKeypad::create(firstVpin, 16, clockPin, dataPin);
- * 
- * NOTE: Most of these keypads ship with only 8 pads enabled.  To enable all
- * sixteen pads, locate the area of the board labelled P1 (four pairs of 
- * holes labelled 1 to 4 from the left); solder a jumper link between the pair 
- * labelled 3 (connected to pin TP2 on the chip).  When this link is connected,
- * the pins OUT1 to OUT8 are not used but all sixteen touch pads are operational.
- * 
- * TODO: Allow a list of datapins to be provided so that multiple keypads can
- * be read simultaneously by the one device driver and the one shared clock signal.
- * As it stands, we can configure multiple driver instances, one for each keypad, 
- * and it will work fine.  The clock will be driven to all devices but only one 
- * driver will be reading the responses from its corresponding device at a time.
- */
-
-#ifndef IO_TOUCHKEYPAD_H
-#define IO_TOUCHKEYPAD_H
-
-#include "IODevice.h"
-
-class TouchKeypad : public IODevice {
-private:
-  // Here we define the device-specific variables.  
-  uint16_t _inputStates = 0;
-  VPIN _clockPin;
-  VPIN _dataPin;
-
-public:
-  //  Static function to handle create calls.
-  static void create(VPIN firstVpin, int nPins, VPIN clockPin, VPIN dataPin) {
-    if (checkNoOverlap(firstVpin,nPins)) new TouchKeypad(firstVpin, nPins, clockPin, dataPin);
-  } 
-
-protected:
-  // Constructor. 
-  TouchKeypad(VPIN firstVpin, int nPins, VPIN clockPin, VPIN dataPin) {
-    _firstVpin = firstVpin;
-    _nPins = (nPins > 16) ? 16 : nPins;  // Maximum of 16 pads per device
-    _clockPin = clockPin;
-    _dataPin = dataPin;
-
-    addDevice(this);
-  }
-
-  // Device-specific initialisation
-  void _begin() override {
-#if defined(DIAG_IO)
-    _display();
-#endif
-    // Set clock pin as output, initially high, and data pin as input.  
-    // Enable pullup on the input so that the default (not connected) state is 
-    // 'keypad not pressed'.
-    ArduinoPins::fastWriteDigital(_clockPin, 1);
-    pinMode(_clockPin, OUTPUT);
-    pinMode(_dataPin, INPUT_PULLUP); // Force defined state when no connection
-  }
-  
-  // Device-specific read function.
-  int _read(VPIN vpin) {
-    if (vpin < _firstVpin || vpin >= _firstVpin + _nPins) return 0;
-
-    // Return a value for the specified vpin.
-    return _inputStates & (1<<(vpin-_firstVpin)) ? 1 : 0;
-  }
-
-  // Loop function to do background scanning of the keyboard.
-  // The TTP229 device requires clock pulses to be sent to it,
-  // and the data bits can be read on the rising edge of the clock.
-  // By default the clock and data are inverted (active-low).
-  // A gap of more  than 2ms is advised between successive read
-  // cycles, we wait for 100ms between reads of the keyboard as this
-  // provide a good enough response time.
-  // Maximum clock frequency is 512kHz, so put a 1us delay
-  // between clock transitions.
-  //
-  void _loop(unsigned long currentMicros) {
-
-    // Clock 16 bits from the device
-    uint16_t data = 0, maskBit = 0x01;
-    for (uint8_t pad=0; pad<16; pad++) {
-      ArduinoPins::fastWriteDigital(_clockPin, 0);
-      delayMicroseconds(1);
-      ArduinoPins::fastWriteDigital(_clockPin, 1);
-      data |= (ArduinoPins::fastReadDigital(_dataPin) ? 0 : maskBit);
-      maskBit <<= 1;
-      delayMicroseconds(1);
-    }
-    _inputStates = data;
-#ifdef DIAG_IO
-    static uint16_t lastData = 0;
-    if (data != lastData) DIAG(F("KeyPad: %x"), data);
-    lastData = data;
-#endif
-    delayUntil(currentMicros + 100000); // read every 100ms
-  }
-
-  // Display information about the device, and perhaps its current condition (e.g. active, disabled etc).
-  void _display() {
-    DIAG(F("TouchKeypad Configured on Vpins:%u-%u SCL=%d SDO=%d"), (int)_firstVpin, 
-      (int)_firstVpin+_nPins-1, _clockPin, _dataPin);
-  }
-
-
-};
-
-#endif // IO_TOUCHKEYPAD_H

IO_VL53L0X.h

@@ -42,17 +42,14 @@
  * If you have more than one module, then you will need to specify a digital VPIN (Arduino
  * digital output or I/O extender pin) which you connect to the module's XSHUT pin.  Now,
  * when the device driver starts, the XSHUT pin is set LOW to turn the module off.  Once 
- * all VL53L0X modules are turned off, the driver works through each module in turn,
- * setting XSHUT to HIGH to turn that module on, then writing that module's desired I2C address.
+ * all VL53L0X modules are turned off, the driver works through each module in turn by
+ * setting XSHUT to HIGH to turn the module on,, then writing the module's desired I2C address.
  * In this way, many VL53L0X modules can be connected to the one I2C bus, each one 
- * using a distinct I2C address.  The process is described in ST Microelectronics application
- * note AN4846.
+ * using a distinct I2C address.
  * 
- * WARNING:  If the device's XSHUT pin is not connected, then it may be prone to noise, 
- * and the device may reset spontaneously or when handled and the device will stop responding
- * on its allocated address.  If you're not using XSHUT, then tie it to +5V via a resistor 
- * (should be tied to +2.8V strictly). Some manufacturers (Adafruit and Polulu for example)
- * include a pull-up on the module, but others don't.
+ * WARNING:  If the device's XSHUT pin is not connected, then it is very prone to noise, 
+ * and the device may even reset when handled.  If you're not using XSHUT, then it's 
+ * best to tie it to +5V.
  * 
  * The driver is configured as follows:
  * 
@@ -73,8 +70,7 @@
  *       lowThreshold is the distance at which the digital vpin state is set to 1 (in mm),
  *       highThreshold is the distance at which the digital vpin state is set to 0 (in mm),
  *   and xshutPin is the VPIN number corresponding to a digital output that is connected to the
- *       XSHUT terminal on the module.  The digital output may be an Arduino pin or an
- *       I/O extender pin.
+ *       XSHUT terminal on the module.
  * 
  * Example:
  *   In mySetup function within mySetup.cpp:
@@ -97,6 +93,7 @@
 
 class VL53L0X : public IODevice {
 private: 
+  uint8_t _i2cAddress;
   uint16_t _ambient;
   uint16_t _distance;
   uint16_t _signal;
@@ -104,23 +101,20 @@ private:
   uint16_t _offThreshold;
   VPIN _xshutPin;
   bool _value;
-  uint8_t _nextState = STATE_INIT;
+  uint8_t _nextState = 0;
   I2CRB _rb;
   uint8_t _inBuffer[12];
   uint8_t _outBuffer[2];
-  static bool _addressConfigInProgress;
-
   // State machine states.
   enum : uint8_t {
-    STATE_INIT,
-    STATE_RESTARTMODULE,
-    STATE_CONFIGUREADDRESS,
-    STATE_CONFIGUREDEVICE,
-    STATE_INITIATESCAN,
-    STATE_CHECKSTATUS,
-    STATE_GETRESULTS,
-    STATE_DECODERESULTS,
-    STATE_FAILED,
+    STATE_INIT = 0,
+    STATE_CONFIGUREADDRESS = 1,
+    STATE_SKIP = 2,
+    STATE_CONFIGUREDEVICE = 3,
+    STATE_INITIATESCAN = 4,
+    STATE_CHECKSTATUS = 5,
+    STATE_GETRESULTS = 6,
+    STATE_DECODERESULTS = 7,
   };
 
   // Register addresses
@@ -135,15 +129,15 @@ private:
 
 
   public:
-  static void create(VPIN firstVpin, int nPins, I2CAddress i2cAddress, uint16_t onThreshold, uint16_t offThreshold, VPIN xshutPin = VPIN_NONE) {
+  static void create(VPIN firstVpin, int nPins, uint8_t i2cAddress, uint16_t onThreshold, uint16_t offThreshold, VPIN xshutPin = VPIN_NONE) {
      if (checkNoOverlap(firstVpin, nPins,i2cAddress)) new VL53L0X(firstVpin, nPins, i2cAddress, onThreshold, offThreshold, xshutPin);
   }
 
 protected:
-  VL53L0X(VPIN firstVpin, int nPins, I2CAddress i2cAddress, uint16_t onThreshold, uint16_t offThreshold, VPIN xshutPin = VPIN_NONE) {
+  VL53L0X(VPIN firstVpin, int nPins, uint8_t i2cAddress, uint16_t onThreshold, uint16_t offThreshold, VPIN xshutPin = VPIN_NONE) {
     _firstVpin = firstVpin;
-    _nPins = (nPins > 3) ? 3 : nPins;
-    _I2CAddress = i2cAddress;
+    _nPins = min(nPins, 3);
+    _i2cAddress = i2cAddress;
     _onThreshold = onThreshold;
     _offThreshold = offThreshold;
     _xshutPin = xshutPin;
@@ -151,108 +145,81 @@ protected:
     addDevice(this);
   }
   void _begin() override {
-    // If there's only one device, then the XSHUT pin need not be connected.  However, 
-    //  the device will not respond on its default address if it has 
-    //  already been changed.  Therefore, we skip the address configuration if the 
-    //  desired address is already responding on the I2C bus.
-    _nextState = STATE_INIT;
-    _addressConfigInProgress = false;
+    if (_xshutPin == VPIN_NONE) {
+      // Check if device is already responding on the nominated address.
+      if (I2CManager.exists(_i2cAddress)) {
+        // Yes, it's already on this address, so skip the address initialisation.
+        _nextState = STATE_CONFIGUREDEVICE;
+      } else {
+        _nextState = STATE_INIT;
+      }
+    }
   }
 
   void _loop(unsigned long currentMicros) override {
     uint8_t status;
     switch (_nextState) {
       case STATE_INIT:
-        if (I2CManager.exists(_I2CAddress)) {
-          // Device already present on the nominated address, so skip the address initialisation.
-          _nextState = STATE_CONFIGUREDEVICE;
-        } else {
-          // On first entry to loop, reset this module by pulling XSHUT low.  Each module
-          // will be addressed in turn, until all are in the reset state.
-          // If no XSHUT pin is configured, then only one device is supported.
-          if (_xshutPin != VPIN_NONE) IODevice::write(_xshutPin, 0);
-          _nextState = STATE_RESTARTMODULE;
-          delayUntil(currentMicros+10000);
-        }
-        break;
-      case STATE_RESTARTMODULE:
-        // On second entry, set XSHUT pin high to allow this module to restart.
-        // I've observed that the device tends to randomly reset if the XSHUT 
-        // pin is set high from a 5V arduino, even through a pullup resistor.  
-        // Assume that there will be a pull-up on the XSHUT pin to +2.8V as
-        // recommended in the device datasheet.  Then we only need to
-        // turn our output pin high-impedence (by making it an input) and the
-        // on-board pullup will do its job.
-        // Ensure XSHUT is set for only one module at a time by using a
-        // shared flag accessible to all device instances.
-        if (!_addressConfigInProgress) {
-          _addressConfigInProgress = true;
-          // Configure XSHUT pin (if connected) to bring the module out of sleep mode.
-          if (_xshutPin != VPIN_NONE) IODevice::configureInput(_xshutPin, false);
-          // Allow the module time to restart
-          delayUntil(currentMicros+10000);
-          _nextState = STATE_CONFIGUREADDRESS;
-        }
+        // On first entry to loop, reset this module by pulling XSHUT low.  All modules
+        // will be reset in turn.
+        if (_xshutPin != VPIN_NONE) IODevice::write(_xshutPin, 0);
+        _nextState = STATE_CONFIGUREADDRESS;
         break;
       case STATE_CONFIGUREADDRESS:
+        // On second entry, set XSHUT pin high to allow the module to restart.
+        // On the module, there is a diode in series with the XSHUT pin to 
+        // protect the low-voltage pin against +5V.
+        if (_xshutPin != VPIN_NONE) IODevice::write(_xshutPin, 1);
+        // Allow the module time to restart
+        delay(10);
         // Then write the desired I2C address to the device, while this is the only
         //  module responding to the default address.
-        {
-          #if defined(I2C_EXTENDED_ADDRESS)
-          // Add subbus reference for desired address to the device default address.
-          I2CAddress defaultAddress = {_I2CAddress, VL53L0X_I2C_DEFAULT_ADDRESS};
-          status = I2CManager.write(defaultAddress, 2, VL53L0X_REG_I2C_SLAVE_DEVICE_ADDRESS, _I2CAddress.deviceAddress());
-          #else
-          status = I2CManager.write(VL53L0X_I2C_DEFAULT_ADDRESS, 2, VL53L0X_REG_I2C_SLAVE_DEVICE_ADDRESS, _I2CAddress);
-          #endif
-          if (status != I2C_STATUS_OK) {
-            reportError(status);
-          }
-        }
-        delayUntil(currentMicros+10000);
+        I2CManager.write(VL53L0X_I2C_DEFAULT_ADDRESS, 2, VL53L0X_REG_I2C_SLAVE_DEVICE_ADDRESS, _i2cAddress);
+        _nextState = STATE_SKIP;
+        break;
+      case STATE_SKIP:
+        // Do nothing on the third entry.
         _nextState = STATE_CONFIGUREDEVICE;
         break;
       case STATE_CONFIGUREDEVICE:
-        // Allow next VL53L0X device to be configured
-        _addressConfigInProgress = false;
-        // Now check if device address has been set.
-        if (I2CManager.exists(_I2CAddress)) {
+        // On next entry, check if device address has been set.
+        if (I2CManager.exists(_i2cAddress)) {
           #ifdef DIAG_IO
           _display();
           #endif
           // Set 2.8V mode
-          status = write_reg(VL53L0X_CONFIG_PAD_SCL_SDA__EXTSUP_HV, 
+          write_reg(VL53L0X_CONFIG_PAD_SCL_SDA__EXTSUP_HV, 
             read_reg(VL53L0X_CONFIG_PAD_SCL_SDA__EXTSUP_HV) | 0x01);
-          if (status != I2C_STATUS_OK) {
-            reportError(status);
-          } else
-            _nextState = STATE_INITIATESCAN;
         } else {
-          DIAG(F("VL53L0X I2C:%s device not responding"), _I2CAddress.toString());
+          DIAG(F("VL53L0X I2C:x%x device not responding"), _i2cAddress);
           _deviceState = DEVSTATE_FAILED;
-          _nextState = STATE_FAILED;
         }
+        _nextState = STATE_INITIATESCAN;
         break;
       case STATE_INITIATESCAN:
         // Not scanning, so initiate a scan
         _outBuffer[0] = VL53L0X_REG_SYSRANGE_START;
         _outBuffer[1] = 0x01;
-        I2CManager.write(_I2CAddress, _outBuffer, 2, &_rb);
+        I2CManager.write(_i2cAddress, _outBuffer, 2, &_rb);
         _nextState = STATE_CHECKSTATUS;
         break;
       case STATE_CHECKSTATUS:
         status = _rb.status;
         if (status == I2C_STATUS_PENDING) return; // try next time
         if (status != I2C_STATUS_OK) {
-          reportError(status);
+          DIAG(F("VL53L0X I2C:x%x Error:%d %S"), _i2cAddress, status, I2CManager.getErrorMessage(status));
+          _deviceState = DEVSTATE_FAILED;
+          _value = false;
         } else
-          _nextState = STATE_GETRESULTS;
+          _nextState = 2;
         delayUntil(currentMicros + 95000); // wait for 95 ms before checking.
+        _nextState = STATE_GETRESULTS;
         break;
       case STATE_GETRESULTS:
         // Ranging completed.  Request results
         _outBuffer[0] = VL53L0X_REG_RESULT_RANGE_STATUS;
-        I2CManager.read(_I2CAddress, _inBuffer, 12, _outBuffer, 1, &_rb);
+        I2CManager.read(_i2cAddress, _inBuffer, 12, _outBuffer, 1, &_rb);
+        _nextState = 3;
         delayUntil(currentMicros + 5000); // Allow 5ms to get data
         _nextState = STATE_DECODERESULTS;
         break;
@@ -273,28 +240,15 @@ protected:
             else if (_distance > _offThreshold) 
               _value = false;
           }
-          // Completed. Restart scan on next loop entry.
-          _nextState = STATE_INITIATESCAN;
-        } else {
-          reportError(status);
         }
-        break;
-      case STATE_FAILED:
-        // Do nothing.
-        delayUntil(currentMicros+1000000UL);
+        // Completed. Restart scan on next loop entry.
+        _nextState = STATE_INITIATESCAN;
         break;
       default:
         break;
     }
   }
 
-  // Function to report a failed I2C operation.
-  void reportError(uint8_t status) {
-    DIAG(F("VL53L0X I2C:%s Error:%d %S"), _I2CAddress.toString(), status, I2CManager.getErrorMessage(status));
-    _deviceState = DEVSTATE_FAILED;
-    _value = false;
-  }
-
   // For analogue read, first pin returns distance, second pin is signal strength, and third is ambient level.
   int _readAnalogue(VPIN vpin) override {
     int pin = vpin - _firstVpin;
@@ -319,8 +273,8 @@ protected:
   }
 
   void _display() override {
-    DIAG(F("VL53L0X I2C:%s Configured on Vpins:%u-%u On:%dmm Off:%dmm %S"),
-      _I2CAddress.toString(), _firstVpin, _firstVpin+_nPins-1, _onThreshold, _offThreshold,
+    DIAG(F("VL53L0X I2C:x%x Configured on Vpins:%d-%d On:%dmm Off:%dmm %S"),
+      _i2cAddress, _firstVpin, _firstVpin+_nPins-1, _onThreshold, _offThreshold,
       (_deviceState==DEVSTATE_FAILED) ? F("OFFLINE") : F(""));
   }
   
@@ -334,15 +288,13 @@ private:
     uint8_t outBuffer[2];
     outBuffer[0] = reg;
     outBuffer[1] = data;
-    return I2CManager.write(_I2CAddress, outBuffer, 2);
+    return I2CManager.write(_i2cAddress, outBuffer, 2);
   }
   uint8_t read_reg(uint8_t reg) {
     // read byte from register and return value
-    I2CManager.read(_I2CAddress, _inBuffer, 1, &reg, 1);
+    I2CManager.read(_i2cAddress, _inBuffer, 1, &reg, 1);
     return _inBuffer[0];
   }
 };
 
-bool VL53L0X::_addressConfigInProgress = false;
-
 #endif // IO_VL53L0X_h

IO_duinoNodes.h

@@ -55,7 +55,6 @@ public:
     pinMode(_clockPin,OUTPUT);
     pinMode(_dataPin,_pinMap?INPUT_PULLUP:OUTPUT);
     _display();
-    if (!_pinMap) _loopOutput();
   }
 
 // loop called by HAL supervisor 
@@ -122,7 +121,7 @@ void _loopOutput()  {
   }
 
   void _display() override {
-      DIAG(F("IO_duinoNodes %SPUT Configured on Vpins:%u-%u shift=%d"), 
+      DIAG(F("IO_duinoNodes %SPUT Configured on VPins:%d-%d shift=%d"), 
       _pinMap?F("IN"):F("OUT"),
       (int)_firstVpin, 
       (int)_firstVpin+_nPins-1, _nShiftBytes*8);

IO_trainbrains.h

@@ -1,98 +0,0 @@
-/*
- *  © 2023, Chris Harlow. All rights reserved.
- *  © 2021, 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/>.
- */
-
-#ifndef io_trainbrains_h
-#define io_trainbrains_h
-
-#include "IO_GPIOBase.h"
-#include "FSH.h"
-
-/////////////////////////////////////////////////////////////////////////////////////////////////////
-/*
- * IODevice subclass for trainbrains 3-block occupancy detector.
- * For details see http://trainbrains.eu
- */
- 
- enum TrackUnoccupancy
-{
-    TRACK_UNOCCUPANCY_UNKNOWN = 0,
-    TRACK_OCCUPIED = 1,
-    TRACK_UNOCCUPIED = 2
-};
-
-class Trainbrains02 : public GPIOBase<uint16_t> {
-public:
-  static void create(VPIN vpin, uint8_t nPins, I2CAddress i2cAddress) {
-    if (checkNoOverlap(vpin, nPins, i2cAddress)) new Trainbrains02(vpin, nPins, i2cAddress);
-  }
-
-private:  
-  // Constructor
-  Trainbrains02(VPIN vpin, uint8_t nPins, I2CAddress i2cAddress, int interruptPin=-1) 
-    : GPIOBase<uint16_t>((FSH *)F("Trainbrains02"), vpin, nPins, i2cAddress, interruptPin) 
-  {
-    requestBlock.setRequestParams(_I2CAddress, inputBuffer, sizeof(inputBuffer),
-      outputBuffer, sizeof(outputBuffer));
-    
-     outputBuffer[0] = (uint8_t)_I2CAddress; // strips away the mux part.
-     outputBuffer[1] =14;
-     outputBuffer[2] =1;
-     outputBuffer[3] =0;  // This is the channel updated at each poling call
-     outputBuffer[4] =0;
-     outputBuffer[5] =0;
-     outputBuffer[6] =0;
-     outputBuffer[7] =0;
-     outputBuffer[8] =0;
-     outputBuffer[9] =0;
-  }
-  
-  void _writeGpioPort() override {}
-
-  void _readGpioPort(bool immediate) override {
-    // cycle channel on device each time 
-    outputBuffer[3]=channelInProgress+1; // 1-origin 
-    channelInProgress++;
-    if(channelInProgress>=_nPins) channelInProgress=0; 
-    
-    if (immediate) {
-      _processCompletion(I2CManager.read(_I2CAddress, inputBuffer, sizeof(inputBuffer), 
-                                   outputBuffer, sizeof(outputBuffer)));
-    } else {
-      // Queue new request
-      requestBlock.wait(); // Wait for preceding operation to complete
-      // Issue new request to read GPIO register
-      I2CManager.queueRequest(&requestBlock);
-    }
-  }
-
-  // This function is invoked when an I/O operation on the requestBlock completes.
-  void _processCompletion(uint8_t status) override {
-    if (status != I2C_STATUS_OK) inputBuffer[6]=TRACK_UNOCCUPANCY_UNKNOWN;  
-    if (inputBuffer[6] == TRACK_UNOCCUPIED ) _portInputState |=  0x01 <<channelInProgress;
-    else _portInputState &=  ~(0x01 <<channelInProgress);
-  }
-
-  uint8_t channelInProgress=0; 
-  uint8_t outputBuffer[10];
-  uint8_t inputBuffer[10];
-  
-};
-
-#endif

KeywordHasher.h

@@ -1,57 +0,0 @@
-/*
- *  © 2024 Vincent Hamp and 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/>.
- */
-
-
-/* Reader be aware: 
- This function implements the _hk data type so that a string keyword
- is hashed to the same value as the DCCEXParser uses to hash incoming 
- keywords. 
- Thus  "MAIN"_hk  generates exactly the same run time vakue 
- as   const int16_t HASH_KEYWORD_MAIN=11339  
-*/
-#ifndef KeywordHAsher_h
-#define KeywordHasher_h
-
-#include <Arduino.h>
-constexpr uint16_t CompiletimeKeywordHasher(const char *  sv, uint16_t running=0) {
-    return (*sv==0) ? running : CompiletimeKeywordHasher(sv+1,
-          (*sv >= '0' && *sv <= '9') 
-            ? (10*running+*sv-'0')  // Numeric hash  
-            : ((running << 5) + running) ^ *sv
-            );  // 
-}
-
-constexpr int16_t operator""_hk(const char * keyword, size_t len) 
-{
-    return (int16_t) CompiletimeKeywordHasher(keyword,len*0);
-}
-
-/* Some historical values for testing:
-const int16_t HASH_KEYWORD_MAIN = 11339;
-const int16_t HASH_KEYWORD_SLOW = -17209;
-const int16_t HASH_KEYWORD_SPEED28 = -17064;
-const int16_t HASH_KEYWORD_SPEED128 = 25816;
-*/
-
-static_assert("MAIN"_hk == 11339,"Keyword hasher error");
-static_assert("SLOW"_hk == -17209,"Keyword hasher error");
-static_assert("SPEED28"_hk == -17064,"Keyword hasher error");
-static_assert("SPEED128"_hk == 25816,"Keyword hasher error");
-#endif

LCDDisplay.cpp

@@ -0,0 +1,167 @@
+/*
+ *  © 2021, Chris Harlow, Neil McKechnie. 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/>.
+ */
+
+// CAUTION: the device dependent parts of this class are created in the .ini
+// using LCD_Implementation.h
+
+/* The strategy for drawing the screen is as follows.
+ *  1) There are up to eight rows of text to be displayed.
+ *  2) Blank rows of text are ignored.
+ *  3) If there are more non-blank rows than screen lines,
+ *     then all of the rows are displayed, with the rest of the
+ *     screen being blank.
+ *  4) If there are fewer non-blank rows than screen lines,
+ *     then a scrolling strategy is adopted so that, on each screen
+ *     refresh, a different subset of the rows is presented.
+ *  5) On each entry into loop2(), a single operation is sent to the 
+ *     screen; this may be a position command or a character for
+ *     display.  This spreads the onerous work of updating the screen
+ *     and ensures that other loop() functions in the application are
+ *     not held up significantly.  The exception to this is when 
+ *     the loop2() function is called with force=true, where 
+ *     a screen update is executed to completion.  This is normally
+ *     only done during start-up.
+ *  The scroll mode is selected by defining SCROLLMODE as 0, 1 or 2
+ *  in the config.h.
+ *  #define SCROLLMODE 0 is scroll continuous (fill screen if poss),
+ *  #define SCROLLMODE 1 is by page (alternate between pages),
+ *  #define SCROLLMODE 2 is by row (move up 1 row at a time).
+
+ */
+
+#include "LCDDisplay.h"
+
+void LCDDisplay::clear() {
+  clearNative();
+  for (byte row = 0; row < MAX_LCD_ROWS; row++) rowBuffer[row][0] = '\0';
+  topRow = -1;  // loop2 will fill from row 0
+}
+
+void LCDDisplay::setRow(byte line) {
+  hotRow = line;
+  hotCol = 0;
+}
+
+size_t LCDDisplay::write(uint8_t b) {
+  if (hotRow >= MAX_LCD_ROWS || hotCol >= MAX_LCD_COLS) return -1;
+  rowBuffer[hotRow][hotCol] = b;
+  hotCol++;
+  rowBuffer[hotRow][hotCol] = 0;
+  return 1;
+}
+
+void LCDDisplay::loop() {
+  if (!lcdDisplay) return;
+  lcdDisplay->loop2(false);
+}
+
+LCDDisplay *LCDDisplay::loop2(bool force) {
+  if (!lcdDisplay) return NULL;
+
+  // If output device is busy, don't do anything on this loop
+  //  This avoids blocking while waiting for the device to complete.
+  if (isBusy()) return NULL;  
+
+  unsigned long currentMillis = millis();
+
+  if (!force) {
+    // See if we're in the time between updates
+    if ((currentMillis - lastScrollTime) < LCD_SCROLL_TIME)
+      return NULL;
+  } else {
+    // force full screen update from the beginning.
+    rowFirst = -1;
+    rowNext = 0;
+    bufferPointer = 0;
+    done = false;
+    slot = 0;
+  }
+
+  do {
+    if (bufferPointer == 0) {
+      // Find a line of data to write to the screen.
+      if (rowFirst < 0) rowFirst = rowNext;
+      skipBlankRows();
+      if (!done) {
+        // Non-blank line found, so copy it.
+        for (uint8_t i = 0; i < sizeof(buffer); i++)
+          buffer[i] = rowBuffer[rowNext][i];
+      } else
+        buffer[0] = '\0';  // Empty line
+      setRowNative(slot);  // Set position for display
+      charIndex = 0;
+      bufferPointer = &buffer[0];
+
+    } else {
+
+      // Write next character, or a space to erase current position.
+      char ch = *bufferPointer;
+      if (ch) {
+        writeNative(ch);
+        bufferPointer++;
+      } else
+        writeNative(' ');
+
+      if (++charIndex >= MAX_LCD_COLS) {
+        // Screen slot completed, move to next slot on screen
+        slot++;
+        bufferPointer = 0;
+        if (!done) {
+          moveToNextRow();
+          skipBlankRows();
+        }
+      }
+
+      if (slot >= lcdRows) {
+        // Last slot finished, reset ready for next screen update.
+#if SCROLLMODE==2
+        if (!done) {
+          // On next refresh, restart one row on from previous start.
+          rowNext = rowFirst;
+          moveToNextRow();
+          skipBlankRows();
+        }
+#endif
+        done = false;
+        slot = 0;
+        rowFirst = -1;
+        lastScrollTime = currentMillis;
+        return NULL;
+      }
+    }
+  } while (force);
+
+  return NULL;
+}
+
+void LCDDisplay::moveToNextRow() {
+  rowNext = (rowNext + 1) % MAX_LCD_ROWS;
+#if SCROLLMODE == 1
+  // Finished if we've looped back to row 0
+  if (rowNext == 0) done = true;
+#else
+  // Finished if we're back to the first one shown
+  if (rowNext == rowFirst) done = true;
+#endif
+}
+
+void LCDDisplay::skipBlankRows() {
+  while (!done && rowBuffer[rowNext][0] == 0)
+    moveToNextRow();
+}

LCDDisplay.h

@@ -0,0 +1,81 @@
+/*
+ *  © 2021, Chris Harlow, Neil McKechnie. 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/>.
+ */
+#ifndef LCDDisplay_h
+#define LCDDisplay_h
+#include <Arduino.h>
+#include "defines.h"
+#include "DisplayInterface.h"
+
+// Allow maximum message length to be overridden from config.h
+#if !defined(MAX_MSG_SIZE) 
+#define MAX_MSG_SIZE 20
+#endif
+
+// Set default scroll mode (overridable in config.h)
+#if !defined(SCROLLMODE) 
+#define SCROLLMODE 1
+#endif
+
+// This class is created in LCDisplay_Implementation.h
+
+class LCDDisplay : public DisplayInterface {
+ public:
+  LCDDisplay() {};
+  static const int MAX_LCD_ROWS = 8;
+  static const int MAX_LCD_COLS = MAX_MSG_SIZE;
+  static const long LCD_SCROLL_TIME = 3000;  // 3 seconds
+
+  // Internally handled functions
+  static void loop();
+  LCDDisplay* loop2(bool force) override;
+  void setRow(byte line) override;
+  void clear() override;
+
+  size_t write(uint8_t b) override;
+
+protected:
+  uint8_t lcdRows;
+  uint8_t lcdCols;
+
+ private:
+  void moveToNextRow();
+  void skipBlankRows();
+
+  // Relay functions to the live driver in the subclass
+  virtual void clearNative() = 0;
+  virtual void setRowNative(byte line) = 0;
+  virtual size_t writeNative(uint8_t b) = 0;
+  virtual bool isBusy() = 0;
+
+  unsigned long lastScrollTime = 0;
+  int8_t hotRow = 0;
+  int8_t hotCol = 0;
+  int8_t topRow = 0;
+  int8_t slot = 0;
+  int8_t rowFirst = -1;
+  int8_t rowNext = 0;
+  int8_t charIndex = 0;
+  char buffer[MAX_LCD_COLS + 1];
+  char* bufferPointer = 0;
+  bool done = false;
+
+  char rowBuffer[MAX_LCD_ROWS][MAX_LCD_COLS + 1];
+};
+
+#endif

LCD_Implementation.h

@@ -27,36 +27,27 @@
 
 #ifndef LCD_Implementation_h
 #define LCD_Implementation_h
-#include "DisplayInterface.h"
+#include "LCDDisplay.h"
 #include "SSD1306Ascii.h"
 #include "LiquidCrystal_I2C.h"
   
 
-// Implement the Display shim class as a singleton.
-// The DisplayInterface class implements a display handler with no code (null device);
-// The Display class sub-classes DisplayInterface to provide the common display code;
-// Then Display class talks to the specific device type classes:
+// Implement the LCDDisplay shim class as a singleton.
+// The DisplayInterface class implements a displayy handler with no code (null device);
+// The LCDDisplay class sub-classes DisplayInterface to provide the common display code;
+// Then LCDDisplay class is subclassed to the specific device type classes:
 //    SSD1306AsciiWire for I2C OLED driver with SSD1306 or SH1106 controllers;
 //    LiquidCrystal_I2C for I2C LCD driver for HD44780 with PCF8574 'backpack'.
 
 #if defined(OLED_DRIVER)
-  #define DISPLAY_START(xxx) { \
-    DisplayInterface *t = new Display(new SSD1306AsciiWire(OLED_DRIVER)); \
-    t->begin(); \
-    xxx; \
-    t->refresh(); \
-  } 
+  #define CONDITIONAL_LCD_START for (DisplayInterface * dummy=new SSD1306AsciiWire(OLED_DRIVER);dummy!=NULL; dummy=dummy->loop2(true))
   
 #elif defined(LCD_DRIVER)
-  #define DISPLAY_START(xxx) { \
-    DisplayInterface *t = new Display(new LiquidCrystal_I2C(LCD_DRIVER)); \
-    t->begin(); \
-    xxx;  \
-    t->refresh();}
-#else
-  #define DISPLAY_START(xxx) { \
-  xxx; \
-  }
+  #define CONDITIONAL_LCD_START for (DisplayInterface * dummy=new LiquidCrystal_I2C(LCD_DRIVER);dummy!=NULL; dummy=dummy->loop2(true))
 
+#else
+  // Create null display handler just in case someone calls lcdDisplay->something without checking if lcdDisplay is NULL!
+  #define CONDITIONAL_LCD_START { new DisplayInterface(); }
 #endif
+
 #endif // LCD_Implementation_h

LiquidCrystal_I2C.cpp

@@ -41,28 +41,27 @@
 // can't assume that its in that state when a sketch starts (and the
 // LiquidCrystal constructor is called).
 
-LiquidCrystal_I2C::LiquidCrystal_I2C(I2CAddress lcd_Addr, uint8_t lcd_cols,
+LiquidCrystal_I2C::LiquidCrystal_I2C(uint8_t lcd_Addr, uint8_t lcd_cols,
                                      uint8_t lcd_rows) {
   _Addr = lcd_Addr;
-  lcdRows = lcd_rows;  // Number of character rows (typically 2 or 4).
-  lcdCols = lcd_cols;  // Number of character columns (typically 16 or 20)
-  _backlightval = 0;
- }
+  lcdRows = lcd_rows;
+  lcdCols = lcd_cols;
 
-bool LiquidCrystal_I2C::begin() {
+  _backlightval = 0;
 
   I2CManager.begin();
   I2CManager.setClock(100000L);    // PCF8574 is spec'd to 100kHz.
 
-  if (I2CManager.exists(_Addr)) {
-    DIAG(F("%dx%d LCD configured on I2C:%s"), (int)lcdCols, (int)lcdRows, _Addr.toString());
+  if (I2CManager.exists(lcd_Addr)) {
+    DIAG(F("%dx%d LCD configured on I2C:x%x"), (int)lcd_cols, (int)lcd_rows, (int)lcd_Addr);
     _displayfunction = LCD_4BITMODE | LCD_1LINE | LCD_5x8DOTS;
+    begin();
     backlight();
-  } else {
-    DIAG(F("LCD not found on I2C:%s"), _Addr.toString());
-    return false;
+    lcdDisplay = this;
   }
+}
 
+void LiquidCrystal_I2C::begin() {
   if (lcdRows > 1) {
     _displayfunction |= LCD_2LINE;
   }
@@ -80,15 +79,15 @@ bool LiquidCrystal_I2C::begin() {
 
   // we start in 8bit mode, try to set 4 bit mode
   write4bits(0x03);
-  delayMicroseconds(5000);  // wait min 4.1ms
+  delayMicroseconds(4500);  // wait min 4.1ms
 
   // second try
   write4bits(0x03);
-  delayMicroseconds(5000);  // wait min 4.1ms
+  delayMicroseconds(4500);  // wait min 4.1ms
 
   // third go!
   write4bits(0x03);
-  delayMicroseconds(5000);
+  delayMicroseconds(150);
 
   // finally, set to 4-bit interface
   write4bits(0x02);
@@ -100,23 +99,26 @@ bool LiquidCrystal_I2C::begin() {
   _displaycontrol = LCD_DISPLAYON | LCD_CURSOROFF | LCD_BLINKOFF;
   display();
 
+  // clear it off
+  clear();
+
   // Initialize to default text direction (for roman languages)
   _displaymode = LCD_ENTRYLEFT | LCD_ENTRYSHIFTDECREMENT;
 
   // set the entry mode
   command(LCD_ENTRYMODESET | _displaymode);
 
-  return true;
+  setRowNative(0);
 }
 
 /********** high level commands, for the user! */
 void LiquidCrystal_I2C::clearNative() {
   command(LCD_CLEARDISPLAY);  // clear display, set cursor position to zero
-  delayMicroseconds(2000);    // this command takes 1.52ms but allow plenty
+  delayMicroseconds(2000);    // this command takes 1.52ms
 }
 
 void LiquidCrystal_I2C::setRowNative(byte row) {
-  uint8_t row_offsets[] = {0x00, 0x40, 0x14, 0x54};
+  int row_offsets[] = {0x00, 0x40, 0x14, 0x54};
   if (row >= lcdRows) {
     row = lcdRows - 1;  // we count rows starting w/0
   }
@@ -144,10 +146,6 @@ size_t LiquidCrystal_I2C::writeNative(uint8_t value) {
   return 1;
 }
 
-bool LiquidCrystal_I2C::isBusy() { 
-  return rb.isBusy();
-}
-
 /*********** mid level commands, for sending data/cmds */
 
 inline void LiquidCrystal_I2C::command(uint8_t value) { 
@@ -194,12 +192,11 @@ void LiquidCrystal_I2C::send(uint8_t value, uint8_t mode) {
   uint8_t lownib = ((value & 0x0f) << BACKPACK_DATA_BITS) | mode;
   // Send both nibbles
   uint8_t len = 0;
-  rb.wait();
   outputBuffer[len++] = highnib|En;
   outputBuffer[len++] = highnib;
   outputBuffer[len++] = lownib|En;
   outputBuffer[len++] = lownib;
-  I2CManager.write(_Addr, outputBuffer, len, &rb);  // Write command asynchronously
+  I2CManager.write(_Addr, outputBuffer, len);  // Write command synchronously
 }
 
 // write 4 data bits to the HD44780 LCD controller.
@@ -209,16 +206,14 @@ void LiquidCrystal_I2C::write4bits(uint8_t value) {
   // I2C clock cycle time of 2.5us at 400kHz. Data is clocked in to the
   // HD44780 on the trailing edge of the Enable pin.
   uint8_t len = 0;
-  rb.wait();
   outputBuffer[len++] = _data|En;
   outputBuffer[len++] = _data;
-  I2CManager.write(_Addr, outputBuffer, len, &rb);  // Write command asynchronously
+  I2CManager.write(_Addr, outputBuffer, len);  // Write command synchronously
 }
 
 // write a byte to the PCF8574 I2C interface.  We don't need to set
 // the enable pin for this.
 void LiquidCrystal_I2C::expanderWrite(uint8_t value) {
-  rb.wait();
   outputBuffer[0] = value | _backlightval;
-  I2CManager.write(_Addr, outputBuffer, 1, &rb);  // Write command asynchronously
+  I2CManager.write(_Addr, outputBuffer, 1);  // Write command synchronously
 }

LiquidCrystal_I2C.h

@@ -22,7 +22,7 @@
 #define LiquidCrystal_I2C_h
 
 #include <Arduino.h>
-#include "Display.h"
+#include "LCDDisplay.h"
 #include "I2CManager.h"
 
 // commands
@@ -62,38 +62,33 @@
 #define Rw (1 << BACKPACK_Rw_BIT)  // Read/Write bit
 #define Rs (1 << BACKPACK_Rs_BIT)  // Register select bit
 
-class LiquidCrystal_I2C : public DisplayDevice {
+class LiquidCrystal_I2C : public LCDDisplay {
 public:
-  LiquidCrystal_I2C(I2CAddress lcd_Addr,uint8_t lcd_cols,uint8_t lcd_rows);
-  bool begin() override;
+  LiquidCrystal_I2C(uint8_t lcd_Addr,uint8_t lcd_cols,uint8_t lcd_rows);
+  void begin();
   void clearNative() override;
   void setRowNative(byte line) override;
   size_t writeNative(uint8_t c) override;
-  // I/O is synchronous, so if this is called we're not busy!
-  bool isBusy() override; 
   
   void display();
   void noBacklight();
   void backlight();
   
   void command(uint8_t);
-  uint16_t getNumCols() { return lcdCols; }
-  uint16_t getNumRows() { return lcdRows; }
-
 
 private:
   void send(uint8_t, uint8_t);
   void write4bits(uint8_t);
   void expanderWrite(uint8_t);
-  uint8_t lcdCols=0, lcdRows=0;
-  I2CAddress _Addr;
+  uint8_t _Addr;
   uint8_t _displayfunction;
   uint8_t _displaycontrol;
   uint8_t _displaymode;
-  uint8_t _backlightval = 0;
+  uint8_t _backlightval;
 
   uint8_t outputBuffer[4];
-  I2CRB rb;
+  // I/O is synchronous, so if this is called we're not busy!
+  bool isBusy() override { return false; } 
 };
 
 #endif

MotorDriver.cpp

@@ -1,10 +1,9 @@
 /*
- *  © 2022-2023 Paul M Antoine
+ *  © 2022 Paul M Antoine
  *  © 2021 Mike S
  *  © 2021 Fred Decker
- *  © 2020-2023 Harald Barth
+ *  © 2020-2022 Harald Barth
  *  © 2020-2021 Chris Harlow
- *  © 2023 Colin Murdoch
  *  All rights reserved.
  *  
  *  This file is part of CommandStation-EX
@@ -27,23 +26,20 @@
 #include "DCCWaveform.h"
 #include "DCCTimer.h"
 #include "DIAG.h"
-#include "EXRAIL2.h"
 
-unsigned long MotorDriver::globalOverloadStart = 0;
+#if defined(ARDUINO_ARCH_ESP32)
+#include "ESP32-fixes.h"
+#endif
+
+bool MotorDriver::commonFaultPin=false;
 
 volatile portreg_t shadowPORTA;
 volatile portreg_t shadowPORTB;
 volatile portreg_t shadowPORTC;
-#if defined(ARDUINO_ARCH_STM32)
-volatile portreg_t shadowPORTD;
-volatile portreg_t shadowPORTE;
-volatile portreg_t shadowPORTF;
-#endif
-
-MotorDriver::MotorDriver(int16_t power_pin, byte signal_pin, byte signal_pin2, int16_t brake_pin,
-                         byte current_pin, float sense_factor, unsigned int trip_milliamps, int16_t fault_pin) {
-  const FSH * warnString = F("** WARNING **");
 
+MotorDriver::MotorDriver(int16_t power_pin, byte signal_pin, byte signal_pin2, int8_t brake_pin,
+                         byte current_pin, float sense_factor, unsigned int trip_milliamps, byte fault_pin) {
+  powerPin=power_pin;
   invertPower=power_pin < 0;
   if (invertPower) {
     powerPin = 0-power_pin;
@@ -73,110 +69,41 @@ MotorDriver::MotorDriver(int16_t power_pin, byte signal_pin, byte signal_pin2, i
     fastSignalPin.shadowinout = fastSignalPin.inout;
     fastSignalPin.inout = &shadowPORTC;
   }
-  if (HAVE_PORTD(fastSignalPin.inout == &PORTD)) {
-    DIAG(F("Found PORTD pin %d"),signalPin);
-    fastSignalPin.shadowinout = fastSignalPin.inout;
-    fastSignalPin.inout = &shadowPORTD;
-  }
-  if (HAVE_PORTE(fastSignalPin.inout == &PORTE)) {
-    DIAG(F("Found PORTE pin %d"),signalPin);
-    fastSignalPin.shadowinout = fastSignalPin.inout;
-    fastSignalPin.inout = &shadowPORTE;
-  }
-  if (HAVE_PORTF(fastSignalPin.inout == &PORTF)) {
-    DIAG(F("Found PORTF pin %d"),signalPin);
-    fastSignalPin.shadowinout = fastSignalPin.inout;
-    fastSignalPin.inout = &shadowPORTF;
-  }
 
   signalPin2=signal_pin2;
   if (signalPin2!=UNUSED_PIN) {
     dualSignal=true;
     getFastPin(F("SIG2"),signalPin2,fastSignalPin2);
     pinMode(signalPin2, OUTPUT);
-
-    fastSignalPin2.shadowinout = NULL;
-    if (HAVE_PORTA(fastSignalPin2.inout == &PORTA)) {
-      DIAG(F("Found PORTA pin %d"),signalPin2);
-      fastSignalPin2.shadowinout = fastSignalPin2.inout;
-      fastSignalPin2.inout = &shadowPORTA;
-    }
-    if (HAVE_PORTB(fastSignalPin2.inout == &PORTB)) {
-      DIAG(F("Found PORTB pin %d"),signalPin2);
-      fastSignalPin2.shadowinout = fastSignalPin2.inout;
-      fastSignalPin2.inout = &shadowPORTB;
-    }
-    if (HAVE_PORTC(fastSignalPin2.inout == &PORTC)) {
-      DIAG(F("Found PORTC pin %d"),signalPin2);
-      fastSignalPin2.shadowinout = fastSignalPin2.inout;
-      fastSignalPin2.inout = &shadowPORTC;
-    }
-    if (HAVE_PORTD(fastSignalPin2.inout == &PORTD)) {
-      DIAG(F("Found PORTD pin %d"),signalPin2);
-      fastSignalPin2.shadowinout = fastSignalPin2.inout;
-      fastSignalPin2.inout = &shadowPORTD;
-    }
-    if (HAVE_PORTE(fastSignalPin2.inout == &PORTE)) {
-      DIAG(F("Found PORTE pin %d"),signalPin2);
-      fastSignalPin2.shadowinout = fastSignalPin2.inout;
-      fastSignalPin2.inout = &shadowPORTE;
-    }
-    if (HAVE_PORTF(fastSignalPin2.inout == &PORTF)) {
-      DIAG(F("Found PORTF pin %d"),signalPin2);
-      fastSignalPin2.shadowinout = fastSignalPin2.inout;
-      fastSignalPin2.inout = &shadowPORTF;
-    }
   }
   else dualSignal=false; 
   
+  brakePin=brake_pin;
   if (brake_pin!=UNUSED_PIN){
     invertBrake=brake_pin < 0;
-    if (invertBrake)
-      brake_pin = 0-brake_pin;
-    if (brake_pin > MAX_PIN)
-      DIAG(F("%S Brake pin %d > %d"), warnString, brake_pin, MAX_PIN);
-    brakePin=(byte)brake_pin;
+    brakePin=invertBrake ? 0-brake_pin : brake_pin;
     getFastPin(F("BRAKE"),brakePin,fastBrakePin);
     // if brake is used for railcom  cutout we need to do PORTX register trick here as well
     pinMode(brakePin, OUTPUT);
-    setBrake(true);  // start with brake on in case we hace DC stuff going on
-  } else {
-    brakePin=UNUSED_PIN;
   }
+  else brakePin=UNUSED_PIN;
   
   currentPin=current_pin;
   if (currentPin!=UNUSED_PIN) {
-    int ret = ADCee::init(currentPin);
-    if (ret < -1010) { // XXX give value a name later
-      DIAG(F("ADCee::init error %d, disable current pin %d"), ret, currentPin);
-      currentPin = UNUSED_PIN;
-    }
+    senseOffset = ADCee::init(currentPin);
   }
-  senseOffset=0; // value can not be obtained until waveform is activated
 
-  if (fault_pin != UNUSED_PIN) {
-    invertFault=fault_pin < 0;
-    if (invertFault)
-      fault_pin =  0-fault_pin;
-    if (fault_pin > MAX_PIN)
-      DIAG(F("%S Fault pin %d > %d"), warnString, fault_pin, MAX_PIN);
-    faultPin=(byte)fault_pin;
-    DIAG(F("Fault pin = %d invert %d"), faultPin, invertFault);
+  faultPin=fault_pin;
+  if (faultPin != UNUSED_PIN) {
     getFastPin(F("FAULT"),faultPin, 1 /*input*/, fastFaultPin);
     pinMode(faultPin, INPUT);
-  } else {
-      faultPin=UNUSED_PIN;
   }
 
   // This conversion performed at compile time so the remainder of the code never needs
   // float calculations or libraray code. 
   senseFactorInternal=sense_factor * senseScale; 
   tripMilliamps=trip_milliamps;
-#ifdef MAX_CURRENT
-  if (MAX_CURRENT > 0 && MAX_CURRENT < tripMilliamps)
-    tripMilliamps = MAX_CURRENT;
-#endif
-  rawCurrentTripValue=mA2raw(tripMilliamps);
+  rawCurrentTripValue=mA2raw(trip_milliamps);
 
   if (rawCurrentTripValue + senseOffset > ADCee::ADCmax()) {
     // This would mean that the values obtained from the ADC never
@@ -191,16 +118,21 @@ MotorDriver::MotorDriver(int16_t power_pin, byte signal_pin, byte signal_pin2, i
   }
 
   if (currentPin==UNUSED_PIN) 
-    DIAG(F("%S No current or short detection"), warnString);
+    DIAG(F("** WARNING ** No current or short detection"));
   else  {
-    DIAG(F("Pin %d Max %dmA (%d)"), currentPin, raw2mA(rawCurrentTripValue), rawCurrentTripValue);
+    DIAG(F("CurrentPin=A%d, Offset=%d, TripValue=%d"),
+    currentPin-A0, senseOffset,rawCurrentTripValue);
 
     // self testing diagnostic for the non-float converters... may be removed when happy
     //  DIAG(F("senseFactorInternal=%d raw2mA(1000)=%d mA2Raw(1000)=%d"),
     //   senseFactorInternal, raw2mA(1000),mA2raw(1000));
   }
 
+  // prepare values for current detection
+  sampleDelay = 0;
+  lastSampleTaken = millis();
   progTripValue = mA2raw(TRIP_CURRENT_PROG); 
+
 }
 
 bool MotorDriver::isPWMCapable() {
@@ -209,25 +141,27 @@ bool MotorDriver::isPWMCapable() {
 
 
 void MotorDriver::setPower(POWERMODE mode) {
-  if (powerMode == mode) return;
-  //DIAG(F("Track %c POWERMODE=%d"), trackLetter, (int)mode);
-  lastPowerChange[(int)mode] = micros();
-  if (mode == POWERMODE::OVERLOAD)
-    globalOverloadStart = lastPowerChange[(int)mode];
-  bool on=(mode==POWERMODE::ON || mode ==POWERMODE::ALERT);
+  bool on=mode==POWERMODE::ON;
   if (on) {
-    // when switching a track On, we need to check the crrentOffset with the pin OFF
-    if (powerMode==POWERMODE::OFF && currentPin!=UNUSED_PIN) {
-        senseOffset = ADCee::read(currentPin);
-        DIAG(F("Track %c sensOffset=%d"),trackLetter,senseOffset);
-    }
-
+    noInterrupts();
     IODevice::write(powerPin,invertPower ? LOW : HIGH);
+    interrupts();
+    if (DCinuse)
+      setDCSignal(curSpeedCode);
     if (isProgTrack)
       DCCWaveform::progTrack.clearResets();
   }
   else {
+      noInterrupts();
       IODevice::write(powerPin,invertPower ? HIGH : LOW);
+      interrupts();
+      if (DCinuse) {
+	// remember current (DC) speed
+	// but set PWM to zero/stop
+	byte s = curSpeedCode;
+	setDCSignal(128);
+	curSpeedCode = s;
+      }
   }
   powerMode=mode; 
 }
@@ -254,8 +188,8 @@ bool MotorDriver::canMeasureCurrent() {
   return currentPin!=UNUSED_PIN;
 }
 /*
- * Return the current reading as pin reading 0 to max resolution (1024 or 4096).
- * If the fault pin is activated return a negative current to show active fault pin.
+ * Return the current reading as pin reading 0 to 1023. If the fault
+ * pin is activated return a negative current to show active fault pin.
  * As there is no -0, cheat a little and return -1 in that case.
  * 
  * senseOffset handles the case where a shield returns values above or below 
@@ -267,17 +201,12 @@ int MotorDriver::getCurrentRaw(bool fromISR) {
   (void)fromISR;
   if (currentPin==UNUSED_PIN) return 0; 
   int current;
-  current = ADCee::read(currentPin, fromISR);
-  // here one can diag raw value
-  // if (fromISR == false) DIAG(F("%c: %d"), trackLetter, current);
-  current = current-senseOffset;     // adjust with offset
+  current = ADCee::read(currentPin, fromISR)-senseOffset;
   if (current<0) current=0-current;
-  // current >= 0 here, we use negative current as fault pin flag
-  if ((faultPin != UNUSED_PIN) && powerPin) {
-    if (invertFault ? isHIGH(fastFaultPin) : isLOW(fastFaultPin))
+  if ((faultPin != UNUSED_PIN)  && isLOW(fastFaultPin) && powerMode==POWERMODE::ON)
       return (current == 0 ? -1 : -current);
-  }
   return current;
+   
 }
 
 #ifdef ANALOG_READ_INTERRUPT
@@ -314,8 +243,7 @@ void MotorDriver::startCurrentFromHW() {
 #pragma GCC pop_options
 #endif //ANALOG_READ_INTERRUPT
 
-#if defined(ARDUINO_ARCH_ESP32) || defined(ARDUINO_ARCH_STM32)
-#ifdef VARIABLE_TONES
+#if defined(ARDUINO_ARCH_ESP32)
 uint16_t taurustones[28] = { 165, 175, 196, 220,
 			     247, 262, 294, 330,
 			     349, 392, 440, 494,
@@ -324,69 +252,65 @@ uint16_t taurustones[28] = { 165, 175, 196, 220,
 			     330, 284, 262, 247,
 			     220, 196, 175, 165 };
 #endif
-#endif
 void MotorDriver::setDCSignal(byte speedcode) {
-  if (brakePin == UNUSED_PIN)
-    return;
-  switch(brakePin) {
+  curSpeedCode = speedcode;
+  DCinuse = true;
+
 #if defined(ARDUINO_AVR_UNO)
-    // Not worth doin something here as:
-    // If we are on pin 9 or 10 we are on Timer1 and we can not touch Timer1 as that is our DCC source.
-    // If we are on pin 5 or 6 we are on Timer 0 ad we can not touch Timer0 as that is millis() etc.
-    // We are most likely not on pin 3 or 11 as no known motor shield has that as brake.
+  if (powerPin == 3 || powerPin == 11)
+    TCCR2B = (TCCR2B & B11111000) | B00000110; // D3, D11: set divisor on timer 2 to result in (approx) 122.55Hz
 #endif
 #if defined(ARDUINO_AVR_MEGA) || defined(ARDUINO_AVR_MEGA2560)
+// As timer 0 is the system timer, we leave it alone
+//TCCR0B = (TCCR0B & B11111000) | B00000100; // D4, D13    : 122 or 244Hz?
+// As we use timer 1 for DCC we leave it alone
+//TCCR1B = (TCCR1B & B11111000) | B00000100; // D11, D12   : 122Hz
+  switch(powerPin) {
   case 9:
   case 10:
-    // Timer2 (is differnet)
-    TCCR2A = (TCCR2A & B11111100) | B00000001; // set WGM1=0 and WGM0=1 phase correct PWM
-    TCCR2B = (TCCR2B & B11110000) | B00000110; // set WGM2=0 ; set divisor on timer 2 to 1/256 for 122.55Hz
-    //DIAG(F("2 A=%x B=%x"), TCCR2A, TCCR2B);
+    TCCR2B = (TCCR2B & B11111000) | B00000110; // D9, D10    : 122Hz
+    break;
+  case 2:
+  case 3:
+  case 5:
+    TCCR3B = (TCCR3B & B11111000) | B00000100; // D2, D3, D5 : 122Hz but maxcount and thus divisor differs
     break;
   case 6:
   case 7:
   case 8:
-    // Timer4
-    TCCR4A = (TCCR4A & B11111100) | B00000001; // set WGM0=1 and WGM1=0 for normal PWM 8-bit
-    TCCR4B = (TCCR4B & B11100000) | B00000100; // set WGM2=0 and WGM3=0 for normal PWM 8 bit and div 1/256 for 122.55Hz
+    TCCR4B = (TCCR4B & B11111000) | B00000100; // D6, D7, D8 : 122Hz but maxcount and thus divisor differs
     break;
-  case 46:
-  case 45:
   case 44:
-    // Timer5
-    TCCR5A = (TCCR5A & B11111100) | B00000001; // set WGM0=1 and WGM1=0 for normal PWM 8-bit
-    TCCR5B = (TCCR5B & B11100000) | B00000100; // set WGM2=0 and WGM3=0 for normal PWM 8 bit and div 1/256 for 122.55Hz
-    break;
-#endif
-  default:
+  case 45:
+  case 46:
+    TCCR5B = (TCCR5B & B11111000) | B00000100; // D44,D45,D46: 122Hz but maxcount and thus divisor differs
     break;
   }
+#endif
   // spedcoode is a dcc speed & direction
   byte tSpeed=speedcode & 0x7F; // DCC Speed with 0,1 stop and speed steps 2 to 127
   byte tDir=speedcode & 0x80;
-  byte brake;
-#if defined(ARDUINO_ARCH_ESP32) || defined(ARDUINO_ARCH_STM32)
+  byte pwmratio;
+#if defined(ARDUINO_ARCH_ESP32)
   {
     int f = 131;
-#ifdef VARIABLE_TONES
     if (tSpeed > 2) {
       if (tSpeed <= 58) {
 	f = taurustones[ (tSpeed-2)/2 ] ;
       }
     }
-#endif
-    DCCTimer::DCCEXanalogWriteFrequency(brakePin, f); // set DC PWM frequency to 100Hz XXX May move to setup
+    DCCEXanalogWriteFrequency(powerPin, f); // set DC PWM frequency to 100Hz XXX May move to setup
   }
 #endif
-  if (tSpeed <= 1) brake = 255;
-  else if (tSpeed >= 127) brake = 0;
-  else  brake = 2 * (128-tSpeed);
-  if (invertBrake)
-    brake=255-brake;
-#if defined(ARDUINO_ARCH_ESP32) || defined(ARDUINO_ARCH_STM32)
-  DCCTimer::DCCEXanalogWrite(brakePin,brake);
+  if (tSpeed <= 1) pwmratio = 0;
+  else if (tSpeed >= 127) pwmratio = 255;
+  else  pwmratio = 2 * tSpeed;
+  if (invertPower)
+    pwmratio =255-pwmratio;
+#if defined(ARDUINO_ARCH_ESP32)
+  DCCEXanalogWrite(powerPin,pwmratio);
 #else
-  analogWrite(brakePin,brake);
+  analogWrite(powerPin,pwmratio);
 #endif
   //DIAG(F("DCSignal %d"), speedcode);
   if (HAVE_PORTA(fastSignalPin.shadowinout == &PORTA)) {
@@ -407,91 +331,13 @@ void MotorDriver::setDCSignal(byte speedcode) {
     setSignal(tDir);
     HAVE_PORTC(PORTC=shadowPORTC);
     interrupts();
-  } else if (HAVE_PORTD(fastSignalPin.shadowinout == &PORTD)) {
-    noInterrupts();
-    HAVE_PORTD(shadowPORTD=PORTD);
-    setSignal(tDir);
-    HAVE_PORTD(PORTD=shadowPORTD);
-    interrupts();
-  } else if (HAVE_PORTE(fastSignalPin.shadowinout == &PORTE)) {
-    noInterrupts();
-    HAVE_PORTE(shadowPORTE=PORTE);
-    setSignal(tDir);
-    HAVE_PORTE(PORTE=shadowPORTE);
-    interrupts();
-  } else if (HAVE_PORTF(fastSignalPin.shadowinout == &PORTF)) {
-    noInterrupts();
-    HAVE_PORTF(shadowPORTF=PORTF);
-    setSignal(tDir);
-    HAVE_PORTF(PORTF=shadowPORTF);
-    interrupts();
   } else {
     noInterrupts();
     setSignal(tDir);
     interrupts();
   }
 }
-void MotorDriver::throttleInrush(bool on) {
-  if (brakePin == UNUSED_PIN)
-    return;
-  if ( !(trackMode & (TRACK_MODE_MAIN | TRACK_MODE_PROG | TRACK_MODE_EXT)))
-    return;
-  byte duty = on ? 208 : 0;
-  if (invertBrake)
-    duty = 255-duty;
-#if defined(ARDUINO_ARCH_ESP32)
-  if(on) {
-    DCCTimer::DCCEXanalogWrite(brakePin,duty);
-    DCCTimer::DCCEXanalogWriteFrequency(brakePin, 62500);
-  } else {
-    ledcDetachPin(brakePin);
-  }
-#elif defined(ARDUINO_ARCH_STM32)
-  if(on) {
-    DCCTimer::DCCEXanalogWriteFrequency(brakePin, 62500);
-    DCCTimer::DCCEXanalogWrite(brakePin,duty);
-  } else {
-    pinMode(brakePin, OUTPUT);
-  }
-#else
-  if(on){
-    switch(brakePin) {
-#if defined(ARDUINO_AVR_UNO)
-      // Not worth doin something here as:
-      // If we are on pin 9 or 10 we are on Timer1 and we can not touch Timer1 as that is our DCC source.
-      // If we are on pin 5 or 6 we are on Timer 0 ad we can not touch Timer0 as that is millis() etc.
-      // We are most likely not on pin 3 or 11 as no known motor shield has that as brake.
-#endif
-#if defined(ARDUINO_AVR_MEGA) || defined(ARDUINO_AVR_MEGA2560)
-    case 9:
-    case 10:
-      // Timer2 (is different)
-      TCCR2A = (TCCR2A & B11111100) | B00000011; // set WGM0=1 and WGM1=1 for fast PWM
-      TCCR2B = (TCCR2B & B11110000) | B00000001; // set WGM2=0 and prescaler div=1 (max)
-      DIAG(F("2 A=%x B=%x"), TCCR2A, TCCR2B);
-      break;
-    case 6:
-    case 7:
-    case 8:
-      // Timer4
-      TCCR4A = (TCCR4A & B11111100) | B00000001; // set WGM0=1 and WGM1=0 for fast PWM 8-bit
-      TCCR4B = (TCCR4B & B11100000) | B00001001; // set WGM2=1 and WGM3=0 for fast PWM 8 bit and div=1 (max)
-      break;
-    case 46:
-    case 45:
-    case 44:
-      // Timer5
-      TCCR5A = (TCCR5A & B11111100) | B00000001; // set WGM0=1 and WGM1=0 for fast PWM 8-bit
-      TCCR5B = (TCCR5B & B11100000) | B00001001; // set WGM2=1 and WGM3=0 for fast PWM 8 bit and div=1 (max)
-      break;
-#endif
-    default:
-      break;
-    }
-  }
-  analogWrite(brakePin,duty);
-#endif
-}
+
 unsigned int MotorDriver::raw2mA( int raw) {
   //DIAG(F("%d = %d * %d / %d"), (int32_t)raw * senseFactorInternal / senseScale, raw, senseFactorInternal, senseScale);
   return (int32_t)raw * senseFactorInternal / senseScale;
@@ -520,178 +366,64 @@ void  MotorDriver::getFastPin(const FSH* type,int pin, bool input, FASTPIN & res
     // DIAG(F(" port=0x%x, inoutpin=0x%x, isinput=%d, mask=0x%x"),port, result.inout,input,result.maskHIGH);
 }
 
-///////////////////////////////////////////////////////////////////////////////////////////
-// checkPowerOverload(useProgLimit, trackno)
-// bool useProgLimit: Trackmanager knows if this track is in prog mode or in main mode
-// byte trackno: trackmanager knows it's number (could be skipped?)
-//
-// Short ciruit handling strategy:
-//
-// There are the following power states: ON ALERT OVERLOAD OFF
-// OFF state is only changed to/from manually. Power is on
-// during ON and ALERT. Power is off during OVERLOAD and OFF.
-// The overload mechanism changes between the other states like
-//
-// ON -1-> ALERT -2-> OVERLOAD -3-> ALERT -4-> ON
-// or
-// ON -1-> ALERT -4-> ON
-//
-// Times are in class MotorDriver (MotorDriver.h).
-//
-// 1. ON to ALERT:
-// Transition on fault pin condition or current overload
-//
-// 2. ALERT to OVERLOAD:
-// Transition happens if different timeouts have elapsed.
-// If only the fault pin is active, timeout is
-// POWER_SAMPLE_IGNORE_FAULT_LOW (100ms)
-// If only overcurrent is detected, timeout is
-// POWER_SAMPLE_IGNORE_CURRENT (100ms)
-// If fault pin and overcurrent are active, timeout is
-// POWER_SAMPLE_IGNORE_FAULT_HIGH (5ms)
-// Transition to OVERLOAD turns off power to the affected
-// output (unless fault pins are shared)
-// If the transition conditions are not fullfilled,
-// transition according to 4 is tested.
-//
-// 3. OVERLOAD to ALERT
-// Transiton happens when timeout has elapsed, timeout
-// is named power_sample_overload_wait. It is started
-// at POWER_SAMPLE_OVERLOAD_WAIT (40ms) at first entry
-// to OVERLOAD and then increased by a factor of 2
-// at further entries to the OVERLOAD condition. This
-// happens until POWER_SAMPLE_RETRY_MAX (10sec) is reached.
-// power_sample_overload_wait is reset by a poweroff or
-// a POWER_SAMPLE_ALL_GOOD (5sec) period during ON.
-// After timeout power is turned on again and state
-// goes back to ALERT.
-//
-// 4. ALERT to ON
-// Transition happens by watching the current and fault pin
-// samples during POWER_SAMPLE_ALERT_GOOD (20ms) time. If
-// values have been good during that time, transition is
-// made back to ON. Note that even if state is back to ON,
-// the power_sample_overload_wait time is first reset
-// later (see above).
-//
-// The time keeping is handled by timestamps lastPowerChange[]
-// which are set by each power change and by lastBadSample which
-// keeps track if conditions during ALERT have been good enough
-// to go back to ON. The time differences are calculated by
-// microsSinceLastPowerChange().
-//
-
 void MotorDriver::checkPowerOverload(bool useProgLimit, byte trackno) {
-
+  if (millis() - lastSampleTaken  < sampleDelay) return;
+  lastSampleTaken = millis();
+  int tripValue= useProgLimit?progTripValue:getRawCurrentTripValue();
+  
+  // Trackname for diag messages later
   switch (powerMode) {
-
-  case POWERMODE::OFF: {
-    lastPowerMode = POWERMODE::OFF;
-    power_sample_overload_wait = POWER_SAMPLE_OVERLOAD_WAIT;
-    break;
-  }
-
-  case POWERMODE::ON: {
-    lastPowerMode = POWERMODE::ON;
-    bool cF = checkFault();
-    bool cC = checkCurrent(useProgLimit);
-    if(cF || cC ) {
-      if (cC) {
-	unsigned int mA=raw2mA(lastCurrent);
-	DIAG(F("TRACK %c ALERT %s %dmA"), trackno + 'A',
-	     cF ? "FAULT" : "",
-	     mA);
+    case POWERMODE::OFF:
+      sampleDelay = POWER_SAMPLE_OFF_WAIT;
+      break;
+    case POWERMODE::ON:
+      // Check current
+      lastCurrent=getCurrentRaw();
+      if (lastCurrent < 0) {
+	  // We have a fault pin condition to take care of
+	  lastCurrent = -lastCurrent;
+	  setPower(POWERMODE::OVERLOAD); // Turn off, decide later how fast to turn on again
+	  if (commonFaultPin) {
+	      if (lastCurrent < tripValue) {
+		      setPower(POWERMODE::ON); // maybe other track
+	      }
+	      // Write this after the fact as we want to turn on as fast as possible
+	      // because we don't know which output actually triggered the fault pin
+	      DIAG(F("COMMON FAULT PIN ACTIVE: POWERTOGGLE TRACK %c"), trackno + 'A');
+	  } else {
+	    DIAG(F("TRACK %c FAULT PIN ACTIVE - OVERLOAD"), trackno + 'A');
+	      if (lastCurrent < tripValue) {
+		  lastCurrent = tripValue; // exaggerate
+	      }
+	  }
+      }
+      if (lastCurrent < tripValue) {
+        sampleDelay = POWER_SAMPLE_ON_WAIT;
+	if(power_good_counter<100)
+	  power_good_counter++;
+	else
+	  if (power_sample_overload_wait>POWER_SAMPLE_OVERLOAD_WAIT) power_sample_overload_wait=POWER_SAMPLE_OVERLOAD_WAIT;
       } else {
-	DIAG(F("TRACK %c ALERT FAULT"), trackno + 'A');
-      }
-      setPower(POWERMODE::ALERT);
-      if ((trackMode & TRACK_MODE_AUTOINV) && (trackMode & (TRACK_MODE_MAIN|TRACK_MODE_EXT|TRACK_MODE_BOOST))){
-	DIAG(F("TRACK %c INVERT"), trackno + 'A');
-	invertOutput();
+        setPower(POWERMODE::OVERLOAD);
+        unsigned int mA=raw2mA(lastCurrent);
+        unsigned int maxmA=raw2mA(tripValue);
+	      power_good_counter=0;
+        sampleDelay = power_sample_overload_wait;
+        DIAG(F("TRACK %c POWER OVERLOAD %dmA (limit %dmA) shutdown for %dms"), trackno + 'A', mA, maxmA, sampleDelay);
+	if (power_sample_overload_wait >= 10000)
+	    power_sample_overload_wait = 10000;
+	else
+	    power_sample_overload_wait *= 2;
       }
       break;
-    }
-    // all well
-    if (microsSinceLastPowerChange(POWERMODE::ON) > POWER_SAMPLE_ALL_GOOD) {
-      power_sample_overload_wait = POWER_SAMPLE_OVERLOAD_WAIT;
-    }
-    break;
-  }
-
-  case POWERMODE::ALERT: {
-    // set local flags that handle how much is output to diag (do not output duplicates)
-    bool notFromOverload = (lastPowerMode != POWERMODE::OVERLOAD);
-    bool powerModeChange = (powerMode != lastPowerMode);
-    unsigned long now = micros();
-    if (powerModeChange)
-      lastBadSample = now;
-    lastPowerMode = POWERMODE::ALERT;
-    // check how long we have been in this state
-    unsigned long mslpc = microsSinceLastPowerChange(POWERMODE::ALERT);
-    if(checkFault()) {
-      throttleInrush(true);
-      lastBadSample = now;
-      unsigned long timeout = checkCurrent(useProgLimit) ? POWER_SAMPLE_IGNORE_FAULT_HIGH : POWER_SAMPLE_IGNORE_FAULT_LOW;
-      if ( mslpc < timeout) {
-	if (powerModeChange)
-	  DIAG(F("TRACK %c FAULT PIN (%M ignore)"), trackno + 'A', timeout);
-	break;
-      }
-      DIAG(F("TRACK %c FAULT PIN detected after %4M. Pause %4M)"), trackno + 'A', mslpc, power_sample_overload_wait);
-      throttleInrush(false);
-      setPower(POWERMODE::OVERLOAD);
-      break;
-    }
-    if (checkCurrent(useProgLimit)) {
-      lastBadSample = now;
-      if (mslpc < POWER_SAMPLE_IGNORE_CURRENT) {
-	if (powerModeChange) {
-	  unsigned int mA=raw2mA(lastCurrent);
-	  DIAG(F("TRACK %c CURRENT (%M ignore) %dmA"), trackno + 'A', POWER_SAMPLE_IGNORE_CURRENT, mA);
-	}
-	break;
-      }
-      unsigned int mA=raw2mA(lastCurrent);
-      unsigned int maxmA=raw2mA(tripValue);
-      DIAG(F("TRACK %c POWER OVERLOAD %4dmA (max %4dmA) detected after %4M. Pause %4M"),
-	   trackno + 'A', mA, maxmA, mslpc, power_sample_overload_wait);
-      throttleInrush(false);
-      setPower(POWERMODE::OVERLOAD);
-      break;
-    }
-    // all well
-    unsigned long goodtime = micros() - lastBadSample;
-    if (goodtime > POWER_SAMPLE_ALERT_GOOD) {
-      if (true || notFromOverload) { // we did a RESTORE message XXX
-	unsigned int mA=raw2mA(lastCurrent);
-	DIAG(F("TRACK %c NORMAL (after %M/%M) %dmA"), trackno + 'A', goodtime, mslpc, mA);
-      }
-      throttleInrush(false);
+    case POWERMODE::OVERLOAD:
+      // Try setting it back on after the OVERLOAD_WAIT
       setPower(POWERMODE::ON);
-    }
-    break;
-  }
-
-  case POWERMODE::OVERLOAD: {
-    lastPowerMode = POWERMODE::OVERLOAD;
-    unsigned long mslpc = (commonFaultPin ? (micros() - globalOverloadStart) : microsSinceLastPowerChange(POWERMODE::OVERLOAD));
-    if (mslpc > power_sample_overload_wait) {
-      // adjust next wait time
-      power_sample_overload_wait *= 2;
-      if (power_sample_overload_wait > POWER_SAMPLE_RETRY_MAX)
-	      power_sample_overload_wait = POWER_SAMPLE_RETRY_MAX;
-  #ifdef EXRAIL_ACTIVE
-      DIAG(F("Calling EXRAIL"));
-      RMFT2::powerEvent(trackno, true); // Tell EXRAIL we have an overload
-  #endif
-      // power on test
-      DIAG(F("TRACK %c POWER RESTORE (after %4M)"), trackno + 'A', mslpc);
-      setPower(POWERMODE::ALERT);
-    }
-    break;
-  }
-
-  default:
-    break;
+      sampleDelay = POWER_SAMPLE_ON_WAIT;
+      // Debug code....
+      DIAG(F("TRACK %c POWER RESTORE (check %dms)"), trackno + 'A', sampleDelay);
+      break;
+    default:
+      sampleDelay = 999; // cant get here..meaningless statement to avoid compiler warning.
   }
 }

MotorDriver.h

@@ -1,9 +1,9 @@
 /*
- *  © 2022-2023 Paul M. Antoine
+ *  © 2022 Paul M Antoine
  *  © 2021 Mike S
  *  © 2021 Fred Decker
  *  © 2020 Chris Harlow
- *  © 2022,2023 Harald Barth
+ *  © 2022 Harald Barth
  *  All rights reserved.
  *  
  *  This file is part of CommandStation-EX
@@ -27,17 +27,6 @@
 #include "IODevice.h"
 #include "DCCTimer.h"
 
-// use powers of two so we can do logical and/or on the track modes in if clauses.
-// RACK_MODE_DCX is (TRACK_MODE_DC|TRACK_MODE_INV)
-template<class T> inline T operator~ (T a) { return (T)~(int)a; }
-template<class T> inline T operator| (T a, T b) { return (T)((int)a | (int)b); }
-template<class T> inline T operator& (T a, T b) { return (T)((int)a & (int)b); }
-template<class T> inline T operator^ (T a, T b) { return (T)((int)a ^ (int)b); }
-enum TRACK_MODE : byte {TRACK_MODE_NONE = 1, TRACK_MODE_MAIN = 2, TRACK_MODE_PROG = 4,
-                        TRACK_MODE_DC = 8, TRACK_MODE_EXT = 16, TRACK_MODE_BOOST = 32,
-                        TRACK_MODE_ALL = 62, // only to operate all tracks
-                        TRACK_MODE_INV = 64, TRACK_MODE_DCX = 72 /*DC + INV*/, TRACK_MODE_AUTOINV = 128};
-
 #define setHIGH(fastpin)  *fastpin.inout |= fastpin.maskHIGH
 #define setLOW(fastpin)   *fastpin.inout &= fastpin.maskLOW
 #define isHIGH(fastpin)   (*fastpin.inout & fastpin.maskHIGH)
@@ -67,16 +56,6 @@ enum TRACK_MODE : byte {TRACK_MODE_NONE = 1, TRACK_MODE_MAIN = 2, TRACK_MODE_PRO
 #define HAVE_PORTB(X) X
 #define PORTC GPIOC->ODR
 #define HAVE_PORTC(X) X
-#define PORTD GPIOD->ODR
-#define HAVE_PORTD(X) X
-#if defined(GPIOE)
-#define PORTE GPIOE->ODR
-#define HAVE_PORTE(X) X
-#endif
-#if defined(GPIOF)
-#define PORTF GPIOF->ODR
-#define HAVE_PORTF(X) X
-#endif
 #endif
 
 // if macros not defined as pass-through we define
@@ -91,22 +70,12 @@ enum TRACK_MODE : byte {TRACK_MODE_NONE = 1, TRACK_MODE_MAIN = 2, TRACK_MODE_PRO
 #ifndef HAVE_PORTC
 #define HAVE_PORTC(X) byte TOKENPASTE2(Unique_, __LINE__) __attribute__((unused)) =0
 #endif
-#ifndef HAVE_PORTD
-#define HAVE_PORTD(X) byte TOKENPASTE2(Unique_, __LINE__) __attribute__((unused)) =0
-#endif
-#ifndef HAVE_PORTE
-#define HAVE_PORTE(X) byte TOKENPASTE2(Unique_, __LINE__) __attribute__((unused)) =0
-#endif
-#ifndef HAVE_PORTF
-#define HAVE_PORTF(X) byte TOKENPASTE2(Unique_, __LINE__) __attribute__((unused)) =0
-#endif
 
 // Virtualised Motor shield 1-track hardware Interface
 
 #ifndef UNUSED_PIN     // sync define with the one in MotorDrivers.h
-#define UNUSED_PIN 255 // inside uint8_t
+#define UNUSED_PIN 127 // inside int8_t
 #endif
-#define MAX_PIN 254
 
 class pinpair {
 public:
@@ -136,17 +105,14 @@ struct FASTPIN {
 extern volatile portreg_t shadowPORTA;
 extern volatile portreg_t shadowPORTB;
 extern volatile portreg_t shadowPORTC;
-extern volatile portreg_t shadowPORTD;
-extern volatile portreg_t shadowPORTE;
-extern volatile portreg_t shadowPORTF;
 
-enum class POWERMODE : byte { OFF, ON, OVERLOAD, ALERT };
+enum class POWERMODE : byte { OFF, ON, OVERLOAD };
 
 class MotorDriver {
   public:
     
-    MotorDriver(int16_t power_pin, byte signal_pin, byte signal_pin2, int16_t brake_pin, 
-                byte current_pin, float senseFactor, unsigned int tripMilliamps, int16_t fault_pin);
+    MotorDriver(int16_t power_pin, byte signal_pin, byte signal_pin2, int8_t brake_pin, 
+                byte current_pin, float senseFactor, unsigned int tripMilliamps, byte faultPin);
     void setPower( POWERMODE mode);
     POWERMODE getPower() { return powerMode;}
     // as the port registers can be shadowed to get syncronized DCC signals
@@ -155,11 +121,7 @@ class MotorDriver {
     // otherwise the call from interrupt context can undo whatever we do
     // from outside interrupt
     void setBrake( bool on, bool interruptContext=false);
-    __attribute__((always_inline)) inline void setSignal( bool high) {
-#ifndef ARDUINO_ARCH_ESP32
-      if (invertPhase)
-	high = !high;
-#endif
+  __attribute__((always_inline)) inline void setSignal( bool high) {
       if (trackPWM) {
 	DCCTimer::setPWM(signalPin,high);
       }
@@ -179,39 +141,34 @@ class MotorDriver {
 	pinMode(signalPin, OUTPUT);
       else
 	pinMode(signalPin, INPUT);
-      if (signalPin2 != UNUSED_PIN) {
-	if (on)
-	  pinMode(signalPin2, OUTPUT);
-	else
-	  pinMode(signalPin2, INPUT);
-      }
     };
     inline pinpair getSignalPin() { return pinpair(signalPin,signalPin2); };
     void setDCSignal(byte speedByte);
-    void throttleInrush(bool on);
     inline void detachDCSignal() {
 #if defined(__arm__)
-      pinMode(brakePin, OUTPUT);
+      pinMode(powerPin, OUTPUT);
 #elif defined(ARDUINO_ARCH_ESP32)
-      ledcDetachPin(brakePin);
+      ledcDetachPin(powerPin);
 #else
       setDCSignal(128);
 #endif
+      DCinuse = false;
     };
     int  getCurrentRaw(bool fromISR=false);
     unsigned int raw2mA( int raw);
     unsigned int mA2raw( unsigned int mA);
-    inline bool brakeCanPWM() {
-#if defined(ARDUINO_ARCH_ESP32)
-      return (brakePin != UNUSED_PIN); // This was just (true) but we probably do need to check for UNUSED_PIN!
-#elif defined(__arm__)
-      // On ARM we can use digitalPinHasPWM
-      return ((brakePin!=UNUSED_PIN) && (digitalPinHasPWM(brakePin)));
-#elif defined(digitalPinToTimer)
-      return ((brakePin!=UNUSED_PIN) && (digitalPinToTimer(brakePin)));
+    inline bool powerPinCanPWM() {
+#if defined(ARDUINO_ARCH_ESP32) || defined(__arm__)
+      // TODO: on ARM we can use digitalPinHasPWM, and may wish/need to
+      return true;
 #else
-      return (brakePin<14 && brakePin >1);
-#endif
+#ifdef digitalPinHasPWM
+      return digitalPinHasPWM(powerPin);
+#else
+#warning No good digitalPinHasPWM doing approximation
+      return (powerPin<14 && powerPin >1);
+#endif //digitalPinToTimer
+#endif //ESP32/ARM
     }
     inline int getRawCurrentTripValue() {
 	    return rawCurrentTripValue;
@@ -219,10 +176,7 @@ class MotorDriver {
     bool isPWMCapable();
     bool canMeasureCurrent();
     bool trackPWM = false; // this track uses PWM timer to generate the DCC waveform
-    bool commonFaultPin = false; // This is a stupid motor shield which has only a common fault pin for both outputs
-    inline byte setCommonFaultPin() {
-      return commonFaultPin = true;
-    }
+    static bool commonFaultPin; // This is a stupid motor shield which has only a common fault pin for both outputs
     inline byte getFaultPin() {
 	return faultPin;
     }
@@ -230,83 +184,23 @@ class MotorDriver {
       isProgTrack = on;
     }
     void checkPowerOverload(bool useProgLimit, byte trackno);
-    inline void setTrackLetter(char c) {
-      trackLetter = c;
-    };
-    // this returns how much time has passed since the last power change. If it
-    // was really long ago (approx > 52min) advance counter approx 35 min so that
-    // we are at 18 minutes again. Times for 32 bit unsigned long.
-    inline unsigned long microsSinceLastPowerChange(POWERMODE mode) {
-      unsigned long now = micros();
-      unsigned long diff = now - lastPowerChange[(int)mode];
-      if (diff > (1UL << (7 *sizeof(unsigned long)))) // 2^(4*7)us = 268.4 seconds
-        lastPowerChange[(int)mode] = now - 30000000UL;           // 30 seconds ago
-      return diff;
-    };
 #ifdef ANALOG_READ_INTERRUPT
     bool sampleCurrentFromHW();
     void startCurrentFromHW();
 #endif
-  inline void setMode(TRACK_MODE m) {
-    trackMode = m;
-    invertOutput(trackMode & TRACK_MODE_INV);
-  };
-  inline void invertOutput() {               // toggles output inversion
-    invertPhase = !invertPhase;
-    invertOutput(invertPhase);
-  };
-  inline void invertOutput(bool b) {         // sets output inverted or not
-    if (b)
-      invertPhase = 1;
-    else
-      invertPhase = 0;
-#if defined(ARDUINO_ARCH_ESP32)
-    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);
-    else
-      *outreg &= ~((uint32_t)0x1 << GPIO_FUNC0_OUT_INV_SEL_S);
-    if (p.invpin != UNUSED_PIN) {
-      outreg = (uint32_t *)(GPIO_FUNC0_OUT_SEL_CFG_REG + 4*p.invpin);
-      if (invertPhase) // clear or set the invert bit in the gpio out register
-	*outreg &= ~((uint32_t)0x1 << GPIO_FUNC0_OUT_INV_SEL_S);
-      else
-	*outreg |=  ((uint32_t)0x1 << GPIO_FUNC0_OUT_INV_SEL_S);
-    }
-#endif
-  };
-  inline TRACK_MODE getMode() {
-    return trackMode;
-  };
   private:
-    char trackLetter = '?';
     bool isProgTrack = false; // tells us if this is a prog track
     void  getFastPin(const FSH* type,int pin, bool input, FASTPIN & result);
-    inline void  getFastPin(const FSH* type,int pin, FASTPIN & result) {
+    void  getFastPin(const FSH* type,int pin, FASTPIN & result) {
 	getFastPin(type, pin, 0, result);
-    };
-    // side effect sets lastCurrent and tripValue
-    inline bool checkCurrent(bool useProgLimit) {
-      tripValue= useProgLimit?progTripValue:getRawCurrentTripValue();
-      lastCurrent = getCurrentRaw();
-      if (lastCurrent < 0)
-	lastCurrent = -lastCurrent;
-      return lastCurrent >= tripValue;
-    };
-    // side effect sets lastCurrent
-    inline bool checkFault() {
-      lastCurrent = getCurrentRaw();
-      return lastCurrent < 0;
-    };
+    }
     VPIN powerPin;
     byte signalPin, signalPin2, currentPin, faultPin, brakePin;
     FASTPIN fastSignalPin, fastSignalPin2, fastBrakePin,fastFaultPin;
     bool dualSignal;       // true to use signalPin2
     bool invertBrake;       // brake pin passed as negative means pin is inverted
     bool invertPower;       // power pin passed as negative means pin is inverted
-    bool invertFault;       // fault pin passed as negative means pin is inverted
-    bool invertPhase = 0;   // phase of out pin is inverted
+    
     // Raw to milliamp conversion factors avoiding float data types.
     // Milliamps=rawADCreading * sensefactorInternal / senseScale
     //
@@ -319,14 +213,10 @@ class MotorDriver {
     int rawCurrentTripValue;
     // current sampling
     POWERMODE powerMode;
-    POWERMODE lastPowerMode;
-    unsigned long lastPowerChange[4];         // timestamp in microseconds
-    unsigned long lastBadSample;              // timestamp in microseconds
-    // used to sync restore time when common Fault pin detected
-    static unsigned long globalOverloadStart; // timestamp in microseconds
+    unsigned long lastSampleTaken;
+    unsigned int sampleDelay;
     int progTripValue;
-    int  lastCurrent; //temp value
-    int  tripValue;   //temp value
+    int  lastCurrent;
 #ifdef ANALOG_READ_INTERRUPT
     volatile unsigned long sampleCurrentTimestamp;
     volatile uint16_t sampleCurrent;
@@ -334,28 +224,17 @@ class MotorDriver {
     int maxmA;
     int tripmA;
 
-    // Times for overload management. Unit: microseconds.
-    // Base for wait time until power is turned on again
-    static const unsigned long POWER_SAMPLE_OVERLOAD_WAIT =     40000UL;
-    // Time after we consider all faults old and forgotten
-    static const unsigned long POWER_SAMPLE_ALL_GOOD =        5000000UL;
-    // Time after which we consider a ALERT over 
-    static const unsigned long POWER_SAMPLE_ALERT_GOOD =        20000UL;
-    // How long to ignore fault pin if current is under limit
-    static const unsigned long POWER_SAMPLE_IGNORE_FAULT_LOW = 100000UL;
-    // How long to ignore fault pin if current is higher than limit
-    static const unsigned long POWER_SAMPLE_IGNORE_FAULT_HIGH =  5000UL;
-    // How long to wait between overcurrent and turning off
-    static const unsigned long POWER_SAMPLE_IGNORE_CURRENT  =  100000UL;
-    // Upper limit for retry period
-    static const unsigned long POWER_SAMPLE_RETRY_MAX =      10000000UL;
+    // Wait times for power management. Unit: milliseconds
+    static const int  POWER_SAMPLE_ON_WAIT = 100;
+    static const int  POWER_SAMPLE_OFF_WAIT = 1000;
+    static const int  POWER_SAMPLE_OVERLOAD_WAIT = 20;
     
     // Trip current for programming track, 250mA. Change only if you really
     // need to be non-NMRA-compliant because of decoders that are not either.
     static const int TRIP_CURRENT_PROG=250;
     unsigned long power_sample_overload_wait = POWER_SAMPLE_OVERLOAD_WAIT;
     unsigned int power_good_counter = 0;
-    TRACK_MODE trackMode = TRACK_MODE_NONE; // we assume track not assigned at startup
-
+    bool DCinuse = false;
+    byte curSpeedCode = 0;
 };
 #endif

MotorDrivers.h

@@ -1,7 +1,7 @@
 /*
- *  © 2022-2023 Paul M. Antoine
+ *  © 2022 Paul M. Antoine
  *  © 2021 Fred Decker
- *  © 2020-2023 Harald Barth
+ *  © 2020-2022 Harald Barth
  *  (c) 2020 Chris Harlow. All rights reserved.
  *  (c) 2021 Fred Decker.  All rights reserved.
  *  (c) 2020 Harald Barth. All rights reserved.
@@ -36,7 +36,7 @@
 // custom defines in config.h.
 
 #ifndef UNUSED_PIN     // sync define with the one in MotorDriver.h
-#define UNUSED_PIN 255 // inside uint8_t
+#define UNUSED_PIN 127 // inside int8_t
 #endif
 
 // The MotorDriver definition is:
@@ -60,8 +60,7 @@
 // Arduino STANDARD Motor Shield, used on different architectures:
 
 #if defined(ARDUINO_ARCH_SAMD) || defined(ARDUINO_ARCH_STM32)
-// Standard Motor Shield definition for 3v3 processors (other than the ESP32)
-// Setup for SAMD21 Sparkfun DEV board MUST use Arduino Motor Shield R3 (MUST be R3
+// Setup for SAMD21 Sparkfun DEV board using Arduino standard Motor Shield R3 (MUST be R3
 // for 3v3 compatibility!!) senseFactor for 3.3v systems is 1.95 as calculated when using
 // 10-bit A/D samples, and for 12-bit samples it's more like 0.488, but we probably need
 // to tweak both these
@@ -71,27 +70,15 @@
 #define SAMD_STANDARD_MOTOR_SHIELD STANDARD_MOTOR_SHIELD
 #define STM32_STANDARD_MOTOR_SHIELD STANDARD_MOTOR_SHIELD
 
-// EX 8874 based shield connected to a 3V3 system with 12-bit (4096) ADC
-#define EX8874_SHIELD F("EX8874"), \
- new MotorDriver( 3, 12, UNUSED_PIN, 9, A0, 1.27, 5000, A4), \
- new MotorDriver(11, 13, UNUSED_PIN, 8, A1, 1.27, 5000, A5)
-
-
 #elif defined(ARDUINO_ARCH_ESP32)
 // STANDARD shield on an ESPDUINO-32 (ESP32 in Uno form factor). The shield must be eiter the
 // 3.3V compatible R3 version or it has to be modified to not supply more than 3.3V to the
-// analog inputs. Here we use analog inputs A2 and A3 as A0 and A1 are wired in a way so that
+// analog inputs. Here we use analog inputs A4 and A5 as A0 and A1 are wired in a way so that
 // they are not useable at the same time as WiFi (what a bummer). The numbers below are the
 // actual GPIO numbers. In comments the numbers the pins have on an Uno.
-#define STANDARD_MOTOR_SHIELD F("STANDARD_MOTOR_SHIELD"), \
- new MotorDriver(25/* 3*/, 19/*12*/, UNUSED_PIN, 13/*9*/, 35/*A2*/, 0.70, 1500, UNUSED_PIN), \
- new MotorDriver(23/*11*/, 18/*13*/, UNUSED_PIN, 12/*8*/, 34/*A3*/, 0.70, 1500, UNUSED_PIN)
-
-// EX 8874 based shield connected to a 3.3V system (like ESP32) and 12bit (4096) ADC
-// numbers are GPIO numbers. comments are UNO form factor shield pin numbers
-#define EX8874_SHIELD F("EX8874"),\
- new MotorDriver(25/* 3*/, 19/*12*/, UNUSED_PIN, 13/*9*/, 35/*A2*/, 1.27, 5000, 36 /*A4*/), \
- new MotorDriver(23/*11*/, 18/*13*/, UNUSED_PIN, 12/*8*/, 34/*A3*/, 1.27, 5000, 39 /*A5*/)
+#define STANDARD_MOTOR_SHIELD F("STANDARD_MOTOR_SHIELD"),                                                 \
+    new MotorDriver(25/* 3*/, 19/*12*/, UNUSED_PIN, 13/*9*/, 36/*A4*/, 0.70, 1500, UNUSED_PIN), \
+    new MotorDriver(23/*11*/, 18/*13*/, UNUSED_PIN, 12/*8*/, 39/*A5*/, 0.70, 1500, UNUSED_PIN)
 
 #else
 // STANDARD shield on any Arduino Uno or Mega compatible with the original specification.
@@ -101,12 +88,6 @@
 #define BRAKE_PWM_SWAPPED_MOTOR_SHIELD F("BPS_MOTOR_SHIELD"),                                       \
                               new MotorDriver(-9 , 12, UNUSED_PIN, -3, A0, 2.99, 1500, UNUSED_PIN), \
                               new MotorDriver(-8 , 13, UNUSED_PIN,-11, A1, 2.99, 1500, UNUSED_PIN)
-
-// EX 8874 based shield connected to a 5V system (like Arduino) and 10bit (1024) ADC
-#define EX8874_SHIELD F("EX8874"), \
- new MotorDriver( 3, 12, UNUSED_PIN, 9, A0, 5.08, 5000, A4), \
- new MotorDriver(11, 13, UNUSED_PIN, 8, A1, 5.08, 5000, A5)
-
 #endif
 
 // Pololu Motor Shield

Release - Architecture Doc/CommandStation-EX-Arch-v1-0.svg

@@ -485,10 +485,10 @@
 				<text x="32.86" y="598.05" class="st4" v:langID="1033"><v:paragraph v:horizAlign="1"/><v:tabList/>Accessories <v:newlineChar/><tspan
 							x="30.42" dy="1.2em" class="st5">(</tspan>Output.cpp)</text>			</g>
 		</a>
-		<a xlink:href="https://github.com/DCC-EX/CommandStation-EX/blob/master/Display.cpp">
+		<a xlink:href="https://github.com/DCC-EX/CommandStation-EX/blob/master/LCDDisplay.cpp">
 			<g id="shape14-81" v:mID="14" v:groupContext="shape" v:layerMember="0" transform="translate(288,-116.156)">
 				<title>Process.14</title>
-				<desc>Other Utilities (Display.cpp)</desc>
+				<desc>Other Utilities (LCDDisplay.cpp)</desc>
 				<v:custProps>
 					<v:cp v:nameU="Cost" v:lbl="Cost" v:prompt="" v:type="7" v:format="@" v:sortKey="" v:invis="false"
 							v:ask="false" v:langID="1033" v:cal="0"/>
@@ -522,7 +522,7 @@
 				</g>
 				<rect x="0" y="580.5" width="90" height="31.5" rx="13.5" ry="13.5" class="st3"/>
 				<text x="19.29" y="593.55" class="st4" v:langID="1033"><v:paragraph v:horizAlign="1"/><v:tabList/>Other Utilities<v:newlineChar/><tspan
-							x="14.29" dy="1.2em" class="st5">(</tspan>Display.cpp)</text>			</g>
+							x="14.29" dy="1.2em" class="st5">(</tspan>LCDDisplay.cpp)</text>			</g>
 		</a>
 		<g id="shape3-88" v:mID="3" v:groupContext="shape" v:layerMember="1" transform="translate(108,-443.812)">
 			<title>Dynamic connector</title>

Release_Notes/CommandRef.md

@@ -1,197 +0,0 @@
-This file is being used to consolidate the command reference information. 
-
-General points:
-  - Commands below have a single character opcode and parameters.
-  Even <JA> is actually read as <J A> 
-  - Keyword parameters are shown in upper case but may be entered in mixed case.
-  - value parameters are decimal numeric (unless otherwise noted)
-  - [something]  indicates its optional.
-  - Not all commands have a response, and broadcasts mean that not all responses come from the last commands that you have issued.
-   
-Startup status
-<s> Return status like
-    <iDCC-EX V-4.2.22 / MEGA / STANDARD_MOTOR_SHIELD G-devel-202302281422Z>
-    also returns defined turnout list:
-    <H id 1|0>   1=thrown
-
-Track power management. After power commands a power state is broadcast to all throttles.
-
-<1>                Power on all
-<1 MAIN|PROG|JOIN> Power on MAIN or PROG track
-<1 JOIN>           Power on MAIN and PROG track but send main track data on both.
-<0>                Power off all tracks 
-<0 MAIN|PROG>      Power off main or prog track
-
-Basic manual loco control
-<t locoid speed direction>  Throttle loco. 
-    speed in JMRI-form  (-1=ESTOP, 0=STOP, 1..126 = DCC speeds 2..127)
-    direction 1=forward, 0=reverse
-    For response see broadcast <l>
-
-<F locoid function 1|0>     Set loco function 1=ON, 0-OFF
-    For response see broadcast <l>
-
-<!>  emergency stop all locos
-<T id 0|1|T|C>  Control turnout id, 0=C=Closed, 1=T=Thrown
-       response broadcast <H id 0|1>
-
-
-DCC accessory control
-<a address subaddress activate [onoff]>
-<a linearaddress activate> 
-
-
-Turnout definition
-Note: Turnouts are best defined in myAutomation.h where a turnout description can also be provided ( refer to EXRAIL documentation) or by using these commands in a mySetup.h file. 
-
-<T id SERVO vpin thrown closed profile>
-<T id VPIN vpin>
-<T id DCC addr subaddr>
-<T id DCC linearaddr>
-   Valid commands respond with <O>
-
-Direct pin manipulation (replaces <Z commands, no predefinition required)
-<z vpin>     Set pin HIGH
-<z -vpin>    Set pin LOW
-<z vpin value> Set pin analog value
-<z vpin value profile> Set pin analog with profile
-<z vpin value profile duration> set pin analog with profile and value
-
-
-Sensors (Used by JMRI, not required by EXRAIL)
-<S id vpin pullup> define a sensor to be monitored.
-   Responses <Q id> and <q id> as sensor changes  
-
-Decoder programming - main track
-<w cab cv value> POM write value to cv on loco
-<b cab cv bit value> POM write bit to cv on loco
-
-Decoder Programming - prog track
-<W cabid>  Clear consist and write new cab id (includes long/short settings)
-           Responds <W cabid> or <W -1> for error
-<W cv value> Write value to cv
-
-<V cv predictedValue> Read cv value, much faster if prediction is correct. 
-<V cv bit predictedValue>      Read CV bit
-
-<R>         Read drive-away loco id. (May be a consist id)
-<D ACK ON|OFF>
-<D ACK LIMIT|MIN|MAX|RETRY value>
-<D PROGBOOST>
-
-Advanced DCC control
-<M  packet.... >
-<P  packet ...>
-<f map1 map2 [map3]>
-<#>
-<->
-<- cabid>
-<D CABS>
-<D SPEED28>
-<D SPEED128>
-
-
-EEPROM commands
-These commands exist for
-backwards JMRI compatibility. 
-You are strongly discouraged from maintaining your configuration settings in EEPROM.    
-<E>
-<e>
-<D EEPROM>
-<T>
-<T id>
-<S>
-<S id>
-<Z>
-<Z id>
-
-Diagnostic commands
-<D CMD ON|OFF>
-<D WIFI ON|OFF>
-<D ETHERNET ON|OFF>
-<D WIT ON|OFF>
-<D LCN ON|OFF>
-<D EXRAIL ON|OFF>
-<D RESET>
-<D SERVO|ANOUT vpin position [profile]>
-<D ANIN vpin>
-<D HAL SHOW>
-<D HAL RESET>
-<+ cmd>
-<+>
-<Q>
-
-User defined filter commands
-<U ....>
-<u ....>
-
-Track Management
-<=>
-<= track DCC|PROG|OFF>
-<= track DC|DCX cabid>
-<JG>
-<JI>
-
-
-Turntable interface
-<D TT vpin steps [activity]>
-
-Fast clock interface
-<JC>
-<JC mins rate>
-
-
-Advanced Throttle access to features
-<t cab>
-<JA>
-<JA id>
-<JR>
-<JR id>
-<JT>
-<JT id>
-
-*******************
-EXRAIL Commands
-*******************
-
-</>
-</PAUSE>
-</RESUME>
-</START cab sequence>
-</START sequence>
-</KILL taskid>
-</KILL ALL>
-</RESERVE|FREE blockid>
-</LATCH|UNLATCH latchid>
-</RED|AMBER|GREEN signalid>
-
-Obsolete commands/formats
-<c>
-<t ignored cab speed direction> 
-<T id vpin thrown closed>
-<T id addr subaddr>
-<B cv bit value obsolete obsolete>
-<R cv obsolete obsolete>
-<W cv value obsolete obsolete>
-<R cv>            V command is much faster if prediction is correct.
-<B cv bit value>  V command is much faster if prediction is correct.
-<Z id vpin active> (use <z)  Define an output pin that JMRI can set by id 
-<Z id activate>    (use <z)  Activate an output pin by id
-
-
-Broadcast responses
-Note: broadcasts are sent to all throttles when appropriate (usually because something has changed)
-
-<p0>
-<p1>
-<p1 MAIN|PROG|JOIN>
-
-<l cab slot dccspeed functionmap>
-<H id 1|0>
-<jC mmmm speed>
-
-Diagnostic responses
-These are not meant to be software readable. They contain diagnostic information for programmers to identify issues.
-<X> 
-<*  ... *>
-

RingStream.cpp

@@ -83,7 +83,7 @@ size_t RingStream::printFlash(const FSH * flashBuffer) {
 
 // Establish the actual length of the progmem string.
 char * flash=(char *)flashBuffer;
-int16_t plength=STRLEN_P(flash);
+int16_t plength=strlen_P(flash);
 if (plength==0) return 0; // just ignore empty string
 
 // Retain the buffer count as it will be modified by the marker+address insert

SSD1306Ascii.cpp

@@ -143,69 +143,56 @@ const uint8_t FLASH SSD1306AsciiWire::SH1106_132x64init[] = {
 // SSD1306AsciiWire Method Definitions
 //------------------------------------------------------------------------------
  
-// Auto-detect address
-SSD1306AsciiWire::SSD1306AsciiWire(int width, int height) 
-  : SSD1306AsciiWire(0, width, height) { }
-
-// Constructor with explicit address
-SSD1306AsciiWire::SSD1306AsciiWire(I2CAddress address, int width, int height) {
-  m_i2cAddr = address;
+// Constructor
+SSD1306AsciiWire::SSD1306AsciiWire(int width, int height) {
   m_displayWidth = width;
   m_displayHeight = height;
-  // Set size in characters
-  m_charsPerColumn = m_displayHeight / fontHeight;
-  m_charsPerRow = (m_displayWidth+fontWidth-1) / fontWidth; // Round up
-}
-
-bool SSD1306AsciiWire::begin() {
-  I2CManager.begin();
-  I2CManager.setClock(400000L);  // Set max supported I2C speede
-
-  if (m_i2cAddr == 0) {
-    // Probe for I2C device on 0x3c and 0x3d.
-    for (uint8_t address = 0x3c; address <= 0x3d; address++) {
-      if (I2CManager.exists(address)) {
-        m_i2cAddr = address;
-        break;
-      }
-    }
-    if (m_i2cAddr == 0)
-      DIAG(F("OLED display not found"));
-  }
-
+  // Set size in characters in base class
+  lcdRows = height / 8;
+  lcdCols = width / 6;
   m_col = 0;
   m_row = 0;
   m_colOffset = 0;
 
-  if (m_displayWidth==132 && m_displayHeight==64) {
-    // SH1106 display.  This uses 128x64 centered within a 132x64 OLED.
-    m_colOffset = 2;
-    I2CManager.write_P(m_i2cAddr, SH1106_132x64init, sizeof(SH1106_132x64init));
-  } else if (m_displayWidth==128 && (m_displayHeight==64 || m_displayHeight==32)) {
-    // SSD1306 or SSD1309 128x64 or 128x32
-    I2CManager.write_P(m_i2cAddr, Adafruit128xXXinit, sizeof(Adafruit128xXXinit));
-    if (m_displayHeight == 32) 
-      I2CManager.write(m_i2cAddr, 5, 0, // Set command mode
-        SSD1306_SETMULTIPLEX, 0x1F,     // ratio 32
-        SSD1306_SETCOMPINS, 0x02);      // sequential COM pins, disable remap
-  } else {
-    DIAG(F("OLED configuration option not recognised"));
-    return false;
+  I2CManager.begin();
+  I2CManager.setClock(400000L);  // Set max supported I2C speed
+  for (byte address = 0x3c; address <= 0x3d; address++) {
+    if (I2CManager.exists(address)) {
+      m_i2cAddr = address;
+      if (m_displayWidth==132 && m_displayHeight==64) {
+        // SH1106 display.  This uses 128x64 centered within a 132x64 OLED.
+        m_colOffset = 2;
+        I2CManager.write_P(address, SH1106_132x64init, sizeof(SH1106_132x64init));
+      } else if (m_displayWidth==128 && (m_displayHeight==64 || m_displayHeight==32)) {
+        // SSD1306 128x64 or 128x32
+        I2CManager.write_P(address, Adafruit128xXXinit, sizeof(Adafruit128xXXinit));
+        if (m_displayHeight == 32) 
+          I2CManager.write(address, 5, 0, // Set command mode
+            SSD1306_SETMULTIPLEX, 0x1F,     // ratio 32
+            SSD1306_SETCOMPINS, 0x02);      // sequential COM pins, disable remap
+      } else {
+        DIAG(F("OLED configuration option not recognised"));
+        return;
+      }
+      // Device found
+      DIAG(F("%dx%d OLED display configured on I2C:x%x"), width, height, address);
+      // Set singleton address
+      lcdDisplay = this;
+      clear();
+      return;
+    }
   }
-  // Device found
-  DIAG(F("%dx%d OLED display configured on I2C:%s"), m_displayWidth, m_displayHeight, m_i2cAddr.toString());
-  return true;
+  DIAG(F("OLED display not found"));
 }
 
 /* Clear screen by writing blank pixels. */
 void SSD1306AsciiWire::clearNative() {
-  const int maxBytes = sizeof(blankPixels) - 1;  // max number of pixel columns (bytes) per transmission
+  const int maxBytes = sizeof(blankPixels);  // max number of bytes sendable over Wire
   for (uint8_t r = 0; r <= m_displayHeight/8 - 1; r++) {
     setRowNative(r);   // Position at start of row to be erased
-    for (uint8_t c = 0; c < m_displayWidth; c += maxBytes) {
-      uint8_t len = m_displayWidth-c;  // Number of pixel columns remaining
-      if (len > maxBytes) len = maxBytes;
-      I2CManager.write_P(m_i2cAddr, blankPixels, len+1);  // Write command + 'len' blank columns
+    for (uint8_t c = 0; c <= m_displayWidth - 1; c += maxBytes-1) {
+      uint8_t len = min(m_displayWidth-c, maxBytes-1) + 1;
+      I2CManager.write_P(m_i2cAddr, blankPixels, len);  // Write a number of blank columns
     }
   }
 }
@@ -236,6 +223,11 @@ void SSD1306AsciiWire::setRowNative(uint8_t line) {
 size_t SSD1306AsciiWire::writeNative(uint8_t ch) {
   const uint8_t* base = m_font;
 
+  if (ch < m_fontFirstChar || ch >= (m_fontFirstChar + m_fontCharCount))
+    return 0;
+  // Check if character would be partly or wholly off the display
+  if (m_col + fontWidth > m_displayWidth)
+    return 0;
 #if defined(NOLOWERCASE)
   // Adjust if lowercase is missing
   if (ch >= 'a') {
@@ -245,12 +237,6 @@ size_t SSD1306AsciiWire::writeNative(uint8_t ch) {
       ch -= 26; // Allow for missing lowercase letters
   }
 #endif
-  if (ch < m_fontFirstChar || ch >= (m_fontFirstChar + m_fontCharCount))
-    return 0;
-  // Check if character would be partly or wholly off the display
-  if (m_col + fontWidth > m_displayWidth)
-    return 0;
-
   ch -= m_fontFirstChar;
   base += fontWidth * ch;
   // Before using buffer, wait for last request to complete
@@ -259,261 +245,127 @@ size_t SSD1306AsciiWire::writeNative(uint8_t ch) {
   outputBuffer[0] = 0x40;     // set SSD1306 controller to data mode
   uint8_t bufferPos = 1;
   // Copy character pixel columns
-  for (uint8_t i = 0; i < fontWidth; i++) {
-    if (m_col++ < m_displayWidth) 
-      outputBuffer[bufferPos++] = GETFLASH(base++);
-  }
+  for (uint8_t i = 0; i < fontWidth; i++) 
+    outputBuffer[bufferPos++] = GETFLASH(base++);
+  // Add blank pixels between letters
+  for (uint8_t i = 0; i < letterSpacing; i++) 
+    outputBuffer[bufferPos++] = 0;
 
   // Write the data to I2C display
   I2CManager.write(m_i2cAddr, outputBuffer, bufferPos, &requestBlock);
+  m_col += fontWidth + letterSpacing;
   return 1;
 }
 
 
 //------------------------------------------------------------------------------
 
-// Font characters, 6x8 pixels, starting at 0x20.
+// Font characters, 5x7 pixels, 0x61 characters starting at 0x20.
 // Lower case characters optionally omitted.
-const uint8_t FLASH SSD1306AsciiWire::System6x8[] = {
+const uint8_t FLASH SSD1306AsciiWire::System5x7[] = {
 
     // Fixed width; char width table not used !!!!
+    // or with lowercase character omitted.
 
     // font data
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // (space) (20)
-    0x00, 0x00, 0x5F, 0x00, 0x00, 0x00,  // ! (21)
-    0x00, 0x07, 0x00, 0x07, 0x00, 0x00,  // "
-    0x14, 0x7F, 0x14, 0x7F, 0x14, 0x00,  // #
-    0x24, 0x2A, 0x7F, 0x2A, 0x12, 0x00,  // $
-    0x23, 0x13, 0x08, 0x64, 0x62, 0x00,  // %
-    0x36, 0x49, 0x55, 0x22, 0x50, 0x00,  // &
-    0x00, 0x05, 0x03, 0x00, 0x00, 0x00,  // '
-    0x00, 0x1C, 0x22, 0x41, 0x00, 0x00,  // (
-    0x00, 0x41, 0x22, 0x1C, 0x00, 0x00,  // )
-    0x08, 0x2A, 0x1C, 0x2A, 0x08, 0x00,  // *
-    0x08, 0x08, 0x3E, 0x08, 0x08, 0x00,  // +
-    0x00, 0x50, 0x30, 0x00, 0x00, 0x00,  // ,
-    0x08, 0x08, 0x08, 0x08, 0x08, 0x00,  // -
-    0x00, 0x60, 0x60, 0x00, 0x00, 0x00,  // .
-    0x20, 0x10, 0x08, 0x04, 0x02, 0x00,  // / (47)
-    0x3E, 0x51, 0x49, 0x45, 0x3E, 0x00,  // 0 (48)
-    0x00, 0x42, 0x7F, 0x40, 0x00, 0x00,  // 1
-    0x42, 0x61, 0x51, 0x49, 0x46, 0x00,  // 2
-    0x21, 0x41, 0x45, 0x4B, 0x31, 0x00,  // 3
-    0x18, 0x14, 0x12, 0x7F, 0x10, 0x00,  // 4
-    0x27, 0x45, 0x45, 0x45, 0x39, 0x00,  // 5
-    0x3C, 0x4A, 0x49, 0x49, 0x30, 0x00,  // 6
-    0x01, 0x71, 0x09, 0x05, 0x03, 0x00,  // 7
-    0x36, 0x49, 0x49, 0x49, 0x36, 0x00,  // 8
-    0x06, 0x49, 0x49, 0x29, 0x1E, 0x00,  // 9 (57)
-    0x00, 0x36, 0x36, 0x00, 0x00, 0x00,  // :
-    0x00, 0x56, 0x36, 0x00, 0x00, 0x00,  // ;
-    0x00, 0x08, 0x14, 0x22, 0x41, 0x00,  // <
-    0x14, 0x14, 0x14, 0x14, 0x14, 0x00,  // =
-    0x41, 0x22, 0x14, 0x08, 0x00, 0x00,  // >
-    0x02, 0x01, 0x51, 0x09, 0x06, 0x00,  // ?
-    0x32, 0x49, 0x79, 0x41, 0x3E, 0x00,  // @ (64)
-    0x7E, 0x11, 0x11, 0x11, 0x7E, 0x00,  // A (65)
-    0x7F, 0x49, 0x49, 0x49, 0x36, 0x00,  // B
-    0x3E, 0x41, 0x41, 0x41, 0x22, 0x00,  // C
-    0x7F, 0x41, 0x41, 0x22, 0x1C, 0x00,  // D
-    0x7F, 0x49, 0x49, 0x49, 0x41, 0x00,  // E
-    0x7F, 0x09, 0x09, 0x01, 0x01, 0x00,  // F
-    0x3E, 0x41, 0x41, 0x51, 0x32, 0x00,  // G
-    0x7F, 0x08, 0x08, 0x08, 0x7F, 0x00,  // H
-    0x00, 0x41, 0x7F, 0x41, 0x00, 0x00,  // I
-    0x20, 0x40, 0x41, 0x3F, 0x01, 0x00,  // J
-    0x7F, 0x08, 0x14, 0x22, 0x41, 0x00,  // K
-    0x7F, 0x40, 0x40, 0x40, 0x40, 0x00,  // L
-    0x7F, 0x02, 0x04, 0x02, 0x7F, 0x00,  // M
-    0x7F, 0x04, 0x08, 0x10, 0x7F, 0x00,  // N
-    0x3E, 0x41, 0x41, 0x41, 0x3E, 0x00,  // O
-    0x7F, 0x09, 0x09, 0x09, 0x06, 0x00,  // P
-    0x3E, 0x41, 0x51, 0x21, 0x5E, 0x00,  // Q
-    0x7F, 0x09, 0x19, 0x29, 0x46, 0x00,  // R
-    0x46, 0x49, 0x49, 0x49, 0x31, 0x00,  // S
-    0x01, 0x01, 0x7F, 0x01, 0x01, 0x00,  // T
-    0x3F, 0x40, 0x40, 0x40, 0x3F, 0x00,  // U
-    0x1F, 0x20, 0x40, 0x20, 0x1F, 0x00,  // V
-    0x7F, 0x20, 0x18, 0x20, 0x7F, 0x00,  // W
-    0x63, 0x14, 0x08, 0x14, 0x63, 0x00,  // X
-    0x03, 0x04, 0x78, 0x04, 0x03, 0x00,  // Y
-    0x61, 0x51, 0x49, 0x45, 0x43, 0x00,  // Z (90)
-    0x00, 0x00, 0x7F, 0x41, 0x41, 0x00,  // [
-    0x02, 0x04, 0x08, 0x10, 0x20, 0x00,  // "\"
-    0x41, 0x41, 0x7F, 0x00, 0x00, 0x00,  // ]
-    0x04, 0x02, 0x01, 0x02, 0x04, 0x00,  // ^
-    0x40, 0x40, 0x40, 0x40, 0x40, 0x00,  // _
-    0x00, 0x01, 0x02, 0x04, 0x00, 0x00,  // ' (96)
+    0x00, 0x00, 0x00, 0x00, 0x00,  // (space)
+    0x00, 0x00, 0x5F, 0x00, 0x00,  // !
+    0x00, 0x07, 0x00, 0x07, 0x00,  // "
+    0x14, 0x7F, 0x14, 0x7F, 0x14,  // #
+    0x24, 0x2A, 0x7F, 0x2A, 0x12,  // $
+    0x23, 0x13, 0x08, 0x64, 0x62,  // %
+    0x36, 0x49, 0x55, 0x22, 0x50,  // &
+    0x00, 0x05, 0x03, 0x00, 0x00,  // '
+    0x00, 0x1C, 0x22, 0x41, 0x00,  // (
+    0x00, 0x41, 0x22, 0x1C, 0x00,  // )
+    0x08, 0x2A, 0x1C, 0x2A, 0x08,  // *
+    0x08, 0x08, 0x3E, 0x08, 0x08,  // +
+    0x00, 0x50, 0x30, 0x00, 0x00,  // ,
+    0x08, 0x08, 0x08, 0x08, 0x08,  // -
+    0x00, 0x60, 0x60, 0x00, 0x00,  // .
+    0x20, 0x10, 0x08, 0x04, 0x02,  // /
+    0x3E, 0x51, 0x49, 0x45, 0x3E,  // 0
+    0x00, 0x42, 0x7F, 0x40, 0x00,  // 1
+    0x42, 0x61, 0x51, 0x49, 0x46,  // 2
+    0x21, 0x41, 0x45, 0x4B, 0x31,  // 3
+    0x18, 0x14, 0x12, 0x7F, 0x10,  // 4
+    0x27, 0x45, 0x45, 0x45, 0x39,  // 5
+    0x3C, 0x4A, 0x49, 0x49, 0x30,  // 6
+    0x01, 0x71, 0x09, 0x05, 0x03,  // 7
+    0x36, 0x49, 0x49, 0x49, 0x36,  // 8
+    0x06, 0x49, 0x49, 0x29, 0x1E,  // 9
+    0x00, 0x36, 0x36, 0x00, 0x00,  // :
+    0x00, 0x56, 0x36, 0x00, 0x00,  // ;
+    0x00, 0x08, 0x14, 0x22, 0x41,  // <
+    0x14, 0x14, 0x14, 0x14, 0x14,  // =
+    0x41, 0x22, 0x14, 0x08, 0x00,  // >
+    0x02, 0x01, 0x51, 0x09, 0x06,  // ?
+    0x32, 0x49, 0x79, 0x41, 0x3E,  // @
+    0x7E, 0x11, 0x11, 0x11, 0x7E,  // A
+    0x7F, 0x49, 0x49, 0x49, 0x36,  // B
+    0x3E, 0x41, 0x41, 0x41, 0x22,  // C
+    0x7F, 0x41, 0x41, 0x22, 0x1C,  // D
+    0x7F, 0x49, 0x49, 0x49, 0x41,  // E
+    0x7F, 0x09, 0x09, 0x01, 0x01,  // F
+    0x3E, 0x41, 0x41, 0x51, 0x32,  // G
+    0x7F, 0x08, 0x08, 0x08, 0x7F,  // H
+    0x00, 0x41, 0x7F, 0x41, 0x00,  // I
+    0x20, 0x40, 0x41, 0x3F, 0x01,  // J
+    0x7F, 0x08, 0x14, 0x22, 0x41,  // K
+    0x7F, 0x40, 0x40, 0x40, 0x40,  // L
+    0x7F, 0x02, 0x04, 0x02, 0x7F,  // M
+    0x7F, 0x04, 0x08, 0x10, 0x7F,  // N
+    0x3E, 0x41, 0x41, 0x41, 0x3E,  // O
+    0x7F, 0x09, 0x09, 0x09, 0x06,  // P
+    0x3E, 0x41, 0x51, 0x21, 0x5E,  // Q
+    0x7F, 0x09, 0x19, 0x29, 0x46,  // R
+    0x46, 0x49, 0x49, 0x49, 0x31,  // S
+    0x01, 0x01, 0x7F, 0x01, 0x01,  // T
+    0x3F, 0x40, 0x40, 0x40, 0x3F,  // U
+    0x1F, 0x20, 0x40, 0x20, 0x1F,  // V
+    0x7F, 0x20, 0x18, 0x20, 0x7F,  // W
+    0x63, 0x14, 0x08, 0x14, 0x63,  // X
+    0x03, 0x04, 0x78, 0x04, 0x03,  // Y
+    0x61, 0x51, 0x49, 0x45, 0x43,  // Z
+    0x00, 0x00, 0x7F, 0x41, 0x41,  // [
+    0x02, 0x04, 0x08, 0x10, 0x20,  // "\"
+    0x41, 0x41, 0x7F, 0x00, 0x00,  // ]
+    0x04, 0x02, 0x01, 0x02, 0x04,  // ^
+    0x40, 0x40, 0x40, 0x40, 0x40,  // _
+    0x00, 0x01, 0x02, 0x04, 0x00,  // `
 #ifndef NOLOWERCASE
-    0x20, 0x54, 0x54, 0x54, 0x78, 0x00,  // a (97)
-    0x7F, 0x48, 0x44, 0x44, 0x38, 0x00,  // b
-    0x38, 0x44, 0x44, 0x44, 0x20, 0x00,  // c
-    0x38, 0x44, 0x44, 0x48, 0x7F, 0x00,  // d
-    0x38, 0x54, 0x54, 0x54, 0x18, 0x00,  // e
-    0x08, 0x7E, 0x09, 0x01, 0x02, 0x00,  // f
-    0x08, 0x14, 0x54, 0x54, 0x3C, 0x00,  // g
-    0x7F, 0x08, 0x04, 0x04, 0x78, 0x00,  // h
-    0x00, 0x44, 0x7D, 0x40, 0x00, 0x00,  // i
-    0x20, 0x40, 0x44, 0x3D, 0x00, 0x00,  // j
-    0x00, 0x7F, 0x10, 0x28, 0x44, 0x00,  // k
-    0x00, 0x41, 0x7F, 0x40, 0x00, 0x00,  // l
-    0x7C, 0x04, 0x18, 0x04, 0x78, 0x00,  // m
-    0x7C, 0x08, 0x04, 0x04, 0x78, 0x00,  // n
-    0x38, 0x44, 0x44, 0x44, 0x38, 0x00,  // o
-    0x7C, 0x14, 0x14, 0x14, 0x08, 0x00,  // p
-    0x08, 0x14, 0x14, 0x18, 0x7C, 0x00,  // q
-    0x7C, 0x08, 0x04, 0x04, 0x08, 0x00,  // r
-    0x48, 0x54, 0x54, 0x54, 0x20, 0x00,  // s
-    0x04, 0x3F, 0x44, 0x40, 0x20, 0x00,  // t
-    0x3C, 0x40, 0x40, 0x20, 0x7C, 0x00,  // u
-    0x1C, 0x20, 0x40, 0x20, 0x1C, 0x00,  // v
-    0x3C, 0x40, 0x30, 0x40, 0x3C, 0x00,  // w
-    0x44, 0x28, 0x10, 0x28, 0x44, 0x00,  // x
-    0x0C, 0x50, 0x50, 0x50, 0x3C, 0x00,  // y
-    0x44, 0x64, 0x54, 0x4C, 0x44, 0x00,  // z (122)
+    0x20, 0x54, 0x54, 0x54, 0x78,  // a
+    0x7F, 0x48, 0x44, 0x44, 0x38,  // b
+    0x38, 0x44, 0x44, 0x44, 0x20,  // c
+    0x38, 0x44, 0x44, 0x48, 0x7F,  // d
+    0x38, 0x54, 0x54, 0x54, 0x18,  // e
+    0x08, 0x7E, 0x09, 0x01, 0x02,  // f
+    0x08, 0x14, 0x54, 0x54, 0x3C,  // g
+    0x7F, 0x08, 0x04, 0x04, 0x78,  // h
+    0x00, 0x44, 0x7D, 0x40, 0x00,  // i
+    0x20, 0x40, 0x44, 0x3D, 0x00,  // j
+    0x00, 0x7F, 0x10, 0x28, 0x44,  // k
+    0x00, 0x41, 0x7F, 0x40, 0x00,  // l
+    0x7C, 0x04, 0x18, 0x04, 0x78,  // m
+    0x7C, 0x08, 0x04, 0x04, 0x78,  // n
+    0x38, 0x44, 0x44, 0x44, 0x38,  // o
+    0x7C, 0x14, 0x14, 0x14, 0x08,  // p
+    0x08, 0x14, 0x14, 0x18, 0x7C,  // q
+    0x7C, 0x08, 0x04, 0x04, 0x08,  // r
+    0x48, 0x54, 0x54, 0x54, 0x20,  // s
+    0x04, 0x3F, 0x44, 0x40, 0x20,  // t
+    0x3C, 0x40, 0x40, 0x20, 0x7C,  // u
+    0x1C, 0x20, 0x40, 0x20, 0x1C,  // v
+    0x3C, 0x40, 0x30, 0x40, 0x3C,  // w
+    0x44, 0x28, 0x10, 0x28, 0x44,  // x
+    0x0C, 0x50, 0x50, 0x50, 0x3C,  // y
+    0x44, 0x64, 0x54, 0x4C, 0x44,  // z
 #endif
-    0x00, 0x08, 0x36, 0x41, 0x00, 0x00,  // { (123)
-    0x00, 0x00, 0x7F, 0x00, 0x00, 0x00,  // |
-    0x00, 0x41, 0x36, 0x08, 0x00, 0x00,  // }
-    0x08, 0x08, 0x2A, 0x1C, 0x08, 0x00,  // ->
-    0x08, 0x1C, 0x2A, 0x08, 0x08, 0x00,  // <- (127)
-#ifndef NO_EXTENDED_CHARACTERS
-// Extended characters - based on "DOS Western Europe" characters
-//   International characters not yet implemented.
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented 0x80
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented 0x90
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x38, 0x44, 0xc6, 0x44, 0x20, 0x00,  // cent 0x9b
-    0x44, 0x6e, 0x59, 0x49, 0x62, 0x00,  // £ 0x9c
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented 0xa0
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x10, 0x28, 0x54, 0x28, 0x44, 0x00,  // <<
-    0x44, 0x28, 0x54, 0x28, 0x10, 0x00,  // >>
-    // Extended characters 176-180
-    0x92, 0x00, 0x49, 0x00, 0x24, 0x00,  // Light grey 0xb0
-    0xaa, 0x44, 0xaa, 0x11, 0xaa, 0x55,  // Mid grey 0xb1
-    0x6d, 0xff, 0xb6, 0xff, 0xdb, 0xff,  // Dark grey 0xb2
-    0x00, 0x00, 0x00, 0xff, 0x00, 0x00,  // Vertical line 0xb3
-    0x08, 0x08, 0x08, 0xff, 0x00, 0x00,  // Vertical line with left spur 0xb4
+    0x00, 0x08, 0x36, 0x41, 0x00,  // {
+    0x00, 0x00, 0x7F, 0x00, 0x00,  // |
+    0x00, 0x41, 0x36, 0x08, 0x00,  // }
+    0x08, 0x08, 0x2A, 0x1C, 0x08,  // ->
+    0x08, 0x1C, 0x2A, 0x08, 0x08,  // <-
+    0x00, 0x06, 0x09, 0x09, 0x06   // degree symbol
 
-    0x14, 0x14, 0x14, 0xff, 0x00, 0x00,  // Vertical line with double left spur 0xb5
-    0x08, 0x08, 0xff, 0x00, 0xff, 0x00,  // Double vertical line with single left spur
-    0x08, 0x08, 0xf8, 0x08, 0xf8, 0x00,  // Top right corner, single horiz, double vert
-    0x14, 0x14, 0x14, 0xfc, 0x00, 0x00,  // Top right corner, double horiz, single vert
-
-    // Extended characters 185-190
-    0x14, 0x14, 0xf7, 0x00, 0xff, 0x00,  // Double vertical line with double left spur 0xb9
-    0x00, 0x00, 0xff, 0x00, 0xff, 0x00,  // Double vertical line 0xba
-    0x14, 0x14, 0xf4, 0x04, 0xfc, 0x00,  // Double top right corner 0xbb
-    0x14, 0x14, 0x17, 0x10, 0x1f, 0x00,  // Double bottom right corner 0xbc
-    0x08, 0x08, 0x0f, 0x08, 0x0f, 0x00,  // Bottom right corner, single horiz, double vert 0xbd
-    0x14, 0x14, 0x14, 0x1f, 0x00, 0x00,  // Bottom right corner, double horiz, single vert 0xbe
-
-    // Extended characters 191-199
-    0x08, 0x08, 0x08, 0xf8, 0x00, 0x00,  // Top right corner 0xbf
-    0x00, 0x00, 0x00, 0x0f, 0x08, 0x08,  // Bottom left corner 0xc0
-    0x08, 0x08, 0x08, 0x0f, 0x08, 0x08,  // Horizontal line with upward spur 0xc1
-    0x08, 0x08, 0x08, 0xf8, 0x08, 0x08,  // Horizontal line with downward spur 0xc2
-    0x00, 0x00, 0x00, 0xff, 0x08, 0x08,  // Vertical line with right spur 0xc3
-    0x08, 0x08, 0x08, 0x08, 0x08, 0x08,  // Horizontal line 0xc4
-    0x08, 0x08, 0x08, 0xff, 0x08, 0x08,  // Cross 0xc5
-    0x00, 0x00, 0x00, 0xff, 0x14, 0x14,  // Vertical line double right spur 0xc6
-    0x00, 0x00, 0xff, 0x00, 0xff, 0x08,  // Double vertical line single right spur 0xc7
-
-    // Extended characters 200-206
-    0x00, 0x00, 0x1f, 0x10, 0x17, 0x14,  // Double bottom left corner 0xc8
-    0x00, 0x00, 0xfc, 0x04, 0xf4, 0x14,  // Double top left corner 0xc9
-    0x14, 0x14, 0x17, 0x10, 0x17, 0x14,  // Double horizontal with double upward spur 0xca
-    0x14, 0x14, 0xf4, 0x04, 0xf4, 0x14,  // Double horizontal with double downward spur 0xcb
-    0x00, 0x00, 0xff, 0x00, 0xf7, 0x14,  // Double vertical line with double right spur 0xcc
-    0x14, 0x14, 0x14, 0x14, 0x14, 0x14,  // Double horizontal line 0xcd
-    0x14, 0x14, 0xf7, 0x00, 0xf7, 0x14,  // Double cross 0xce
-
-    0x14, 0x14, 0x14, 0x17, 0x14, 0x14,  // Double horizontal line single upward spur 0xcf
-    0x08, 0x08, 0x0f, 0x08, 0x0f, 0x08,  // Horiz single line with double upward spur 0xd0
-    0x14, 0x14, 0x14, 0xf4, 0x14, 0x14,  // Horiz double line with single downward spur 0xd1
-    0x08, 0x08, 0xf8, 0x08, 0xf8, 0x08,  // Horiz single line with double downward spur 0xd2
-    0x00, 0x00, 0x0f, 0x08, 0x0f, 0x08,  // Bottom left corner, double vert single horiz 0xd3
-    0x00, 0x00, 0x00, 0x1f, 0x14, 0x14,  // Bottom left corner, single vert double horiz 0xd4
-    0x00, 0x00, 0x00, 0xfc, 0x14, 0x14,  // Top left corner, single vert double horiz 0xd5
-    0x00, 0x00, 0xf8, 0x08, 0xf8, 0x08,  // Top left corner, double vert single horiz 0xd6
-    0x08, 0x08, 0xff, 0x00, 0xff, 0x08,  // Cross, double vert single horiz 0xd7
-    0x14, 0x14, 0x14, 0xf7, 0x14, 0x14,  // Cross, single vert double horiz 0xd8
-
-    // Extended characters 217-223
-    0x08, 0x08, 0x08, 0x0f, 0x00, 0x00,  // Bottom right corner 0xd9
-    0x00, 0x00, 0x00, 0xf8, 0x08, 0x08,  // Top left corner 0xda
-    0xff, 0xff, 0xff, 0xff, 0xff, 0xff,  // Solid block 0xdb
-    0xf0, 0xf0, 0xf0, 0xf0, 0xf0, 0xf0,  // Bottom half block 0xdc
-    0xff, 0xff, 0xff, 0x00, 0x00, 0x00,  // Left half block 0xdd
-    0x00, 0x00, 0x00, 0xff, 0xff, 0xff,  // Right half block 0xde
-    0x0f, 0x0f, 0x0f, 0x0f, 0x0f, 0x0f,  // Top half block 0xdf
-
-    0xf0, 0xf0, 0xf0, 0x00, 0x00, 0x00,  // Bottom Left block 0xe0
-    0x00, 0x00, 0x00, 0xf0, 0xf0, 0xf0,  // Bottom Right block
-    0x0f, 0x0f, 0x0f, 0x00, 0x00, 0x00,  // Top left block 
-    0x00, 0x00, 0x00, 0x0f, 0x0f, 0x0f,  // Top right block 0xe3
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented 0xf0
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,  // Not implemented
-    // Extended character 248
-    0x00, 0x06, 0x09, 0x09, 0x06, 0x00   // degree symbol 0xf8
-#endif
 };
-
-const uint8_t SSD1306AsciiWire::m_fontCharCount = sizeof(System6x8) / 6;

SSD1306Ascii.h

@@ -23,28 +23,24 @@
 
 #include "Arduino.h"
 #include "FSH.h"
-#include "Display.h"
+#include "LCDDisplay.h"
 
 #include "I2CManager.h"
 #include "DIAG.h"
-#include "DisplayInterface.h"
 
 // Uncomment to remove lower-case letters to save 108 bytes of flash
 //#define NOLOWERCASE
 
-
-
 //------------------------------------------------------------------------------
 // Constructor
-class SSD1306AsciiWire : public DisplayDevice {
+class SSD1306AsciiWire : public LCDDisplay {
  public:
 
-  // Constructors
-  SSD1306AsciiWire(int width, int height); // Auto-detects I2C address
-  SSD1306AsciiWire(I2CAddress address, int width, int height);  
+  // Constructor
+  SSD1306AsciiWire(int width, int height);
 
   // Initialize the display controller.
-  bool begin();
+  void begin(uint8_t i2cAddr);
 
   // Clear the display and set the cursor to (0, 0).
   void clearNative() override;
@@ -56,8 +52,6 @@ class SSD1306AsciiWire : public DisplayDevice {
   size_t writeNative(uint8_t c) override;
 
   bool isBusy() override { return requestBlock.isBusy(); }
-  uint16_t getNumCols() { return m_charsPerRow; }
-  uint16_t getNumRows() { return m_charsPerColumn; }
 
  private:
   // Cursor column.
@@ -68,31 +62,26 @@ class SSD1306AsciiWire : public DisplayDevice {
   uint8_t m_displayWidth;
   // Display height.
   uint8_t m_displayHeight;
-  // Display width in characters
-  uint8_t m_charsPerRow;
-  // Display height in characters
-  uint8_t m_charsPerColumn;
   // Column offset RAM to SEG.
   uint8_t m_colOffset = 0;
   // Current font.
-  const uint8_t* const m_font = System6x8;
-  // Flag to prevent calling begin() twice
-  uint8_t m_initialised = false;
+  const uint8_t* const m_font = System5x7;
 
-  // Only fixed size 6x8 fonts in a 6x8 cell are supported.
-  static const uint8_t fontWidth = 6;
-  static const uint8_t fontHeight = 8;
+  // Only fixed size 5x7 fonts in a 6x8 cell are supported.
+  static const uint8_t fontWidth = 5;
+  static const uint8_t fontHeight = 7;
+  static const uint8_t letterSpacing = 1;
   static const uint8_t m_fontFirstChar = 0x20;
-  static const uint8_t m_fontCharCount;
+  static const uint8_t m_fontCharCount = 0x61;
 
-  I2CAddress m_i2cAddr = 0;
+  uint8_t m_i2cAddr;
 
   I2CRB requestBlock;
-  uint8_t outputBuffer[fontWidth+1];
+  uint8_t outputBuffer[fontWidth+letterSpacing+1];
 
   static const uint8_t blankPixels[];
 
-  static const uint8_t System6x8[];
+  static const uint8_t System5x7[];
   static const uint8_t FLASH Adafruit128xXXinit[];
   static const uint8_t FLASH SH1106_132x64init[];
 };

SerialManager.cpp

@@ -87,9 +87,6 @@ void SerialManager::init() {
     delay(1000);
   }
 #endif
-#ifdef SABERTOOTH
-  Serial2.begin(9600, SERIAL_8N1, 16, 17); // GPIO 16 RXD2; GPIO 17 TXD2 on ESP32
-#endif
 }
 
 void SerialManager::broadcast(char * stringBuffer) {
@@ -111,15 +108,14 @@ void SerialManager::loop2() {
             bufferLength = 0;
             buffer[0] = '\0';
         }
-        else if  (inCommandPayload) {
-	  if (bufferLength <  (COMMAND_BUFFER_SIZE-1))
-	    buffer[bufferLength++] = ch;
-	  if (ch == '>') {
-	    buffer[bufferLength] = '\0';
-	    DCCEXParser::parse(serial, buffer, NULL); 
-	    inCommandPayload = false;
-	    break;
-	  }
+        else if (ch == '>') {
+            buffer[bufferLength] = '\0';
+            DCCEXParser::parse(serial, buffer, NULL); 
+            inCommandPayload = false;
+            break;
+        }
+        else if (inCommandPayload) {
+            if (bufferLength <  (COMMAND_BUFFER_SIZE-1)) buffer[bufferLength++] = ch;
         }
     }
     

StringFormatter.cpp

@@ -18,8 +18,7 @@
  */
 #include "StringFormatter.h"
 #include <stdarg.h>
-#include "DisplayInterface.h"
-#include "CommandDistributor.h"
+#include "LCDDisplay.h"
 
 bool Diag::ACK=false;
 bool Diag::CMD=false;
@@ -39,49 +38,17 @@ void StringFormatter::diag( const FSH* input...) {
 
 void StringFormatter::lcd(byte row, const FSH* input...) {
   va_list args;
-#ifndef DISABLE_VDPY
-  Print * virtualLCD=CommandDistributor::getVirtualLCDSerial(0,row);
-#else
-  Print * virtualLCD=NULL;
-#endif
+
   // Issue the LCD as a diag first
-  // Unless the same serial is asking for the virtual @ respomnse
-  if (virtualLCD!=&USB_SERIAL) {
-    send(&USB_SERIAL,F("<* LCD%d:"),row);
-    va_start(args, input);
-    send2(&USB_SERIAL,input,args);
-    send(&USB_SERIAL,F(" *>\n"));
-  }
-  
-#ifndef DISABLE_VDPY
-  // send to virtual LCD collector (if any) 
-  if (virtualLCD) {
-    va_start(args, input);
-    send2(virtualLCD,input,args);
-    CommandDistributor::commitVirtualLCDSerial();
-  }
-#endif
-  DisplayInterface::setRow(row);    
+  send(&USB_SERIAL,F("<* LCD%d:"),row);
   va_start(args, input);
-  send2(DisplayInterface::getDisplayHandler(),input,args);
-}
-
-void StringFormatter::lcd2(uint8_t display, byte row, const FSH* input...) {
-  va_list args;
+  send2(&USB_SERIAL,input,args);
+  send(&USB_SERIAL,F(" *>\n"));
   
-   // send to virtual LCD collector (if any) 
-#ifndef DISABLE_VDPY
-  Print * virtualLCD=CommandDistributor::getVirtualLCDSerial(display,row);
-  if (virtualLCD) {
-    va_start(args, input);
-    send2(virtualLCD,input,args);
-    CommandDistributor::commitVirtualLCDSerial();
-  }
-#endif
-
-  DisplayInterface::setRow(display, row);    
+  if (!LCDDisplay::lcdDisplay) return;
+  LCDDisplay::lcdDisplay->setRow(row);    
   va_start(args, input);
-  send2(DisplayInterface::getDisplayHandler(),input,args);
+  send2(LCDDisplay::lcdDisplay,input,args);
 }
 
 void StringFormatter::send(Print * stream, const FSH* input...) {
@@ -141,27 +108,7 @@ void StringFormatter::send2(Print * stream,const FSH* format, va_list args) {
       case 'l': printPadded(stream,va_arg(args, long), formatWidth, formatLeft); break;
       case 'b': stream->print(va_arg(args, int), BIN); break;
       case 'o': stream->print(va_arg(args, int), OCT); break;
-      case 'x': stream->print((unsigned int)va_arg(args, unsigned int), HEX); break;
-      case 'X': stream->print((unsigned long)va_arg(args, unsigned long), HEX); break;
-      case 'h': printHex(stream,(unsigned int)va_arg(args, unsigned int)); break;
-      case 'M':
-      { // this prints a unsigned long microseconds time in readable format
-	unsigned long time = va_arg(args, long);
-	if (time >= 2000) {
-	  time = time / 1000;
-	  if (time >= 2000) {
-	    printPadded(stream, time/1000, formatWidth, formatLeft);
-	    stream->print(F("sec"));
-	  } else {
-	    printPadded(stream,time, formatWidth, formatLeft);
-	    stream->print(F("msec"));
-	  }
-	} else {
-	  printPadded(stream,time, formatWidth, formatLeft);
-	  stream->print(F("usec"));
-	}
-      }
-      break;
+      case 'x': stream->print(va_arg(args, int), HEX); break;
       //case 'f': stream->print(va_arg(args, double), 2); break;
       //format width prefix
       case '-': 
@@ -245,14 +192,4 @@ void StringFormatter::printPadded(Print* stream, long value, byte width, bool fo
     if (!formatLeft) stream->print(value, DEC);    
   }
 
-// printHex prints the full 2 byte hex with leading zeros, unlike print(value,HEX)
-const char FLASH hexchars[]="0123456789ABCDEF";
-void StringFormatter::printHex(Print * stream,uint16_t value) {
-    char result[5];
-    for (int i=3;i>=0;i--) {
-      result[i]=GETFLASH(hexchars+(value & 0x0F));
-      value>>=4;
-    }
-    result[4]='\0';
-     stream->print(result);
-}
+ 

StringFormatter.h

@@ -21,7 +21,7 @@
 #include <Arduino.h>
 #include "FSH.h"
 #include "RingStream.h"
-#include "Display.h"
+#include "LCDDisplay.h"
 class Diag {
   public:
   static bool ACK;
@@ -46,13 +46,12 @@ class StringFormatter
     // DIAG support
     static void diag( const FSH* input...);
     static void lcd(byte row, const FSH* input...);
-    static void lcd2(uint8_t display, byte row, const FSH* input...);
     static void printEscapes(char * input);
     static void printEscape( char c);
-    static void printHex(Print * stream,uint16_t value);
 
     private: 
     static void send2(Print * serial, const FSH* input,va_list args);
     static void printPadded(Print* stream, long value, byte width, bool formatLeft);
+
 };
 #endif

TrackManager.cpp

@@ -1,7 +1,6 @@
 /*
  *  © 2022 Chris Harlow
- *  © 2022,2023 Harald Barth
- *  © 2023 Colin Murdoch
+ *  © 2022 Harald Barth
  *  All rights reserved.
  *  
  *  This file is part of DCC++EX
@@ -26,26 +25,33 @@
 #include "MotorDriver.h"
 #include "DCCTimer.h"
 #include "DIAG.h"
-#include "CommandDistributor.h"
-#include "DCCEXParser.h"
-#include "KeywordHasher.h"
 // Virtualised Motor shield multi-track hardware Interface
 #define FOR_EACH_TRACK(t) for (byte t=0;t<=lastTrack;t++)
     
 #define APPLY_BY_MODE(findmode,function) \
         FOR_EACH_TRACK(t) \
-	    if (track[t]->getMode()==findmode)	\
+            if (trackMode[t]==findmode) \
                 track[t]->function;
 
+const int16_t HASH_KEYWORD_PROG = -29718;
+const int16_t HASH_KEYWORD_MAIN = 11339;
+const int16_t HASH_KEYWORD_OFF = 22479;  
+const int16_t HASH_KEYWORD_DC = 2183;  
+const int16_t HASH_KEYWORD_DCX = 6463; // DC reversed polarity 
+const int16_t HASH_KEYWORD_EXT = 8201; // External DCC signal
+const int16_t HASH_KEYWORD_A = 65; // parser makes single chars the ascii.   
+
 MotorDriver * TrackManager::track[MAX_TRACKS];
+TRACK_MODE TrackManager::trackMode[MAX_TRACKS];
 int16_t TrackManager::trackDCAddr[MAX_TRACKS];
 
+POWERMODE TrackManager::mainPowerGuess=POWERMODE::OFF;
 byte TrackManager::lastTrack=0;
 bool TrackManager::progTrackSyncMain=false; 
 bool TrackManager::progTrackBoosted=false; 
 int16_t TrackManager::joinRelay=UNUSED_PIN;
 #ifdef ARDUINO_ARCH_ESP32
-byte TrackManager::tempProgTrack=MAX_TRACKS+1; // MAX_TRACKS+1 is the unused flag
+byte TrackManager::tempProgTrack=MAX_TRACKS+1;
 #endif
 
 #ifdef ANALOG_READ_INTERRUPT
@@ -66,7 +72,7 @@ void TrackManager::sampleCurrent() {
     waiting = false;
     tr++;
     if (tr > lastTrack) tr = 0;
-    if (lastTrack < 2 || track[tr]->getMode() & TRACK_MODE_PROG) {
+    if (lastTrack < 2 || trackMode[tr] & TRACK_MODE_PROG) {
       return; // We could continue but for prog track we
               // rather do it in next interrupt beacuse
               // that gives us well defined sampling point.
@@ -77,7 +83,7 @@ void TrackManager::sampleCurrent() {
   if (!waiting) {
     // look for a valid track to sample or until we are around
     while (true) {
-      if (track[tr]->getMode() & ( TRACK_MODE_MAIN|TRACK_MODE_PROG|TRACK_MODE_DC|TRACK_MODE_BOOST|TRACK_MODE_EXT )) {
+      if (trackMode[tr] & ( TRACK_MODE_MAIN|TRACK_MODE_PROG|TRACK_MODE_DC|TRACK_MODE_DCX|TRACK_MODE_EXT )) {
 	track[tr]->startCurrentFromHW();
 	// for scope debug track[1]->setBrake(1);
 	waiting = true;
@@ -109,32 +115,19 @@ void TrackManager::Setup(const FSH * shieldname,
     
     // Default the first 2 tracks (which may be null) and perform HA waveform check.
     setTrackMode(0,TRACK_MODE_MAIN);
-#ifndef DISABLE_PROG
     setTrackMode(1,TRACK_MODE_PROG);
-#else
-    setTrackMode(1,TRACK_MODE_MAIN);
-#endif
   
-  // Fault pin config for odd motor boards (example pololu)
-  FOR_EACH_TRACK(t) {
-    for (byte s=t+1;s<=lastTrack;s++) {
-      if (track[t]->getFaultPin() != UNUSED_PIN &&
-	  track[t]->getFaultPin() == track[s]->getFaultPin()) {
-	track[t]->setCommonFaultPin();
-	track[s]->setCommonFaultPin();
-	DIAG(F("Common Fault pin tracks %c and %c"), t+'A', s+'A');
-      }
-    }
-  }
-  DCC::setShieldName(shieldname);
+  // TODO Fault pin config for odd motor boards (example pololu)
+  // MotorDriver::commonFaultPin = ((mainDriver->getFaultPin() == progDriver->getFaultPin())
+  //				 && (mainDriver->getFaultPin() != UNUSED_PIN));
+  DCC::begin(shieldname);   
 }
 
 void TrackManager::addTrack(byte t, MotorDriver* driver) {
+     trackMode[t]=TRACK_MODE_OFF;
      track[t]=driver;
      if (driver) {
          track[t]->setPower(POWERMODE::OFF);
-         track[t]->setMode(TRACK_MODE_NONE);
-	 track[t]->setTrackLetter('A'+t);
          lastTrack=t;
      } 
 }
@@ -145,16 +138,10 @@ void TrackManager::setDCCSignal( bool on) {
   HAVE_PORTA(shadowPORTA=PORTA);
   HAVE_PORTB(shadowPORTB=PORTB);
   HAVE_PORTC(shadowPORTC=PORTC);
-  HAVE_PORTD(shadowPORTD=PORTD);
-  HAVE_PORTE(shadowPORTE=PORTE);
-  HAVE_PORTF(shadowPORTF=PORTF);
   APPLY_BY_MODE(TRACK_MODE_MAIN,setSignal(on));
   HAVE_PORTA(PORTA=shadowPORTA);
   HAVE_PORTB(PORTB=shadowPORTB);
   HAVE_PORTC(PORTC=shadowPORTC);
-  HAVE_PORTD(PORTD=shadowPORTD);
-  HAVE_PORTE(PORTE=shadowPORTE);
-  HAVE_PORTF(PORTF=shadowPORTF);
 }
 
 void TrackManager::setCutout( bool on) {
@@ -169,16 +156,10 @@ void TrackManager::setPROGSignal( bool on) {
   HAVE_PORTA(shadowPORTA=PORTA);
   HAVE_PORTB(shadowPORTB=PORTB);
   HAVE_PORTC(shadowPORTC=PORTC);
-  HAVE_PORTD(shadowPORTD=PORTD);
-  HAVE_PORTE(shadowPORTE=PORTE);
-  HAVE_PORTF(shadowPORTF=PORTF);
   APPLY_BY_MODE(TRACK_MODE_PROG,setSignal(on));
   HAVE_PORTA(PORTA=shadowPORTA);
   HAVE_PORTB(PORTB=shadowPORTB);
   HAVE_PORTC(PORTC=shadowPORTC);
-  HAVE_PORTD(PORTD=shadowPORTD);
-  HAVE_PORTE(PORTE=shadowPORTE);
-  HAVE_PORTF(PORTF=shadowPORTF);
 }
 
 // setDCSignal(), called from normal context
@@ -186,104 +167,63 @@ void TrackManager::setPROGSignal( bool on) {
 // with interrupts turned off around the critical section
 void TrackManager::setDCSignal(int16_t cab, byte speedbyte) {
   FOR_EACH_TRACK(t) {
-    if (trackDCAddr[t]!=cab && cab != 0) continue;
-    if (track[t]->getMode() & TRACK_MODE_DC)
-      track[t]->setDCSignal(speedbyte);
+    if (trackDCAddr[t]!=cab) continue;
+    if (trackMode[t]==TRACK_MODE_DC) track[t]->setDCSignal(speedbyte);
+    else if (trackMode[t]==TRACK_MODE_DCX) track[t]->setDCSignal(speedbyte ^ 128);
   }
 }    
 
 bool TrackManager::setTrackMode(byte trackToSet, TRACK_MODE mode, int16_t dcAddr) {
     if (trackToSet>lastTrack || track[trackToSet]==NULL) return false;
 
-    // Remember track mode we came from for later
-    TRACK_MODE oldmode = track[trackToSet]->getMode();
-
-    //DIAG(F("Track=%c Mode=%d"),trackToSet+'A', mode);
-    // DC tracks require a motorDriver that can set brake!
-    if (mode & TRACK_MODE_DC) {
-#if defined(ARDUINO_AVR_UNO)
-      DIAG(F("Uno has no PWM timers available for DC"));
-      return false;
-#endif
-      if (!track[trackToSet]->brakeCanPWM()) {
-	DIAG(F("Brake pin can't PWM: No DC"));
-	return false;
-      }
-    }
+    //DIAG(F("Track=%c"),trackToSet+'A');
+    // DC tracks require a motorDriver that can set power pin PWM
+    if ((mode==TRACK_MODE_DC || mode==TRACK_MODE_DCX)
+         && !track[trackToSet]->powerPinCanPWM()) {
+             DIAG(F("Power pin can't PWM: No DC"));
+             return false; 
+         }
 
 #ifdef ARDUINO_ARCH_ESP32
     // remove pin from MUX matrix and turn it off
     pinpair p = track[trackToSet]->getSignalPin();
     //DIAG(F("Track=%c remove  pin %d"),trackToSet+'A', p.pin);
     gpio_reset_pin((gpio_num_t)p.pin);
+    pinMode(p.pin, OUTPUT); // gpio_reset_pin may reset to input
     if (p.invpin != UNUSED_PIN) {
       //DIAG(F("Track=%c remove ^pin %d"),trackToSet+'A', p.invpin);
       gpio_reset_pin((gpio_num_t)p.invpin);
+      pinMode(p.invpin, OUTPUT); // gpio_reset_pin may reset to input
     }
-#ifdef BOOSTER_INPUT
-
-#ifdef ARDUINO_ESP32S3_DEV
-#define LOOP_IDX SIG_IN_FUNC212_IDX //pads 208 to 212 available as loopback
-#else
-#define LOOP_IDX SIG_IN_FUNC228_IDX //pads 224 to 228 available as loopback
-#endif
-
-    if (mode & TRACK_MODE_BOOST) {
-      //DIAG(F("Track=%c mode boost pin %d"),trackToSet+'A', p.pin);
-      pinMode(BOOSTER_INPUT, INPUT);
-      gpio_matrix_in(26, LOOP_IDX, false);
-      gpio_matrix_out(p.pin, LOOP_IDX, false, false);
-      if (p.invpin != UNUSED_PIN) {
-	gpio_matrix_out(p.invpin, LOOP_IDX, true /*inverted*/, false);
-      }
-    } else // elseif clause continues
-#endif
-    if (mode & (TRACK_MODE_MAIN | TRACK_MODE_PROG | TRACK_MODE_DC)) {
-      // gpio_reset_pin may reset to input
-      pinMode(p.pin, OUTPUT);
-      if (p.invpin != UNUSED_PIN)
-	pinMode(p.invpin, OUTPUT);
-    }
-
-#endif
-#ifndef DISABLE_PROG
-    if (mode & TRACK_MODE_PROG) {
-#else
-    if (false) {
 #endif
+    if (mode==TRACK_MODE_PROG) {
       // only allow 1 track to be prog
       FOR_EACH_TRACK(t)
-	if ( (track[t]->getMode() & TRACK_MODE_PROG) && t != trackToSet) {
+	if (trackMode[t]==TRACK_MODE_PROG && t != trackToSet) {
 	  track[t]->setPower(POWERMODE::OFF);
-	  track[t]->setMode(TRACK_MODE_NONE);
+	  trackMode[t]=TRACK_MODE_OFF;
 	  track[t]->makeProgTrack(false);     // revoke prog track special handling
-	  streamTrackState(NULL,t);
 	}
       track[trackToSet]->makeProgTrack(true); // set for prog track special handling
     } else {
       track[trackToSet]->makeProgTrack(false); // only the prog track knows it's type
     }
-    track[trackToSet]->setMode(mode);
+    trackMode[trackToSet]=mode;
     trackDCAddr[trackToSet]=dcAddr;
-
+    
     // When a track is switched, we must clear any side effects of its previous 
     // state, otherwise trains run away or just dont move.
 
     // This can be done BEFORE the PWM-Timer evaluation (methinks)
-    if (!(mode & TRACK_MODE_DC)) {
+    if (!(mode==TRACK_MODE_DC || mode==TRACK_MODE_DCX)) {
       // DCC tracks need to have set the PWM to zero or they will not work.
       track[trackToSet]->detachDCSignal();
-      track[trackToSet]->setBrake(false);
     }
 
-    // BOOST:
-    //  Leave it as is
-    // otherwise:
-    //  EXT is a special case where the signal pin is
-    //  turned off. So unless that is set, the signal
-    //  pin should be turned on
-    if (!(mode & TRACK_MODE_BOOST))
-      track[trackToSet]->enableSignal(!(mode & TRACK_MODE_EXT));
+    // EXT is a special case where the signal pin is
+    // turned off. So unless that is set, the signal
+    // pin should be turned on
+    track[trackToSet]->enableSignal(mode != TRACK_MODE_EXT);
 
 #ifndef ARDUINO_ARCH_ESP32
     // re-evaluate HighAccuracy mode
@@ -293,7 +233,7 @@ bool TrackManager::setTrackMode(byte trackToSet, TRACK_MODE mode, int16_t dcAddr
       // DC tracks must not have the DCC PWM switched on
       // so we globally turn it off if one of the PWM
       // capable tracks is now DC or DCX.
-      if (track[t]->getMode() & TRACK_MODE_DC) {
+      if (trackMode[t]==TRACK_MODE_DC || trackMode[t]==TRACK_MODE_DCX) {
 	if (track[t]->isPWMCapable()) {
 	  canDo=false;    // this track is capable but can not run PWM
 	  break;          // in this mode, so abort and prevent globally below
@@ -301,7 +241,7 @@ bool TrackManager::setTrackMode(byte trackToSet, TRACK_MODE mode, int16_t dcAddr
 	  track[t]->trackPWM=false; // this track sure can not run with PWM
 	  //DIAG(F("Track %c trackPWM 0 (not capable)"), t+'A');
 	}
-      } else if (track[t]->getMode() & (TRACK_MODE_MAIN |TRACK_MODE_PROG)) {
+      } else if (trackMode[t]==TRACK_MODE_MAIN || trackMode[t]==TRACK_MODE_PROG) {
 	track[t]->trackPWM = track[t]->isPWMCapable(); // trackPWM is still a guess here
 	//DIAG(F("Track %c trackPWM %d"), t+'A', track[t]->trackPWM);
 	canDo &= track[t]->trackPWM;
@@ -319,155 +259,112 @@ bool TrackManager::setTrackMode(byte trackToSet, TRACK_MODE mode, int16_t dcAddr
 #else
     // For ESP32 we just reinitialize the DCC Waveform
     DCCWaveform::begin();
-    // setMode() again AFTER Waveform::begin() of ESP32 fixes INVERTED signal
-    track[trackToSet]->setMode(mode);
 #endif
 
     // This block must be AFTER the PWM-Timer modifications
-    if (mode & TRACK_MODE_DC) {
+    if (mode==TRACK_MODE_DC || mode==TRACK_MODE_DCX) {
         // DC tracks need to be given speed of the throttle for that cab address
         // otherwise will not match other tracks on same cab.
         // This also needs to allow for inverted DCX
         applyDCSpeed(trackToSet);
     }
 
-    // Turn off power if we changed the mode of this track
-    if (mode != oldmode)
-      track[trackToSet]->setPower(POWERMODE::OFF);
-    streamTrackState(NULL,trackToSet);
-
+    // Normal running tracks are set to the global power state 
+    track[trackToSet]->setPower(
+        (mode==TRACK_MODE_MAIN || mode==TRACK_MODE_DC || mode==TRACK_MODE_DCX || mode==TRACK_MODE_EXT) ?
+        mainPowerGuess : POWERMODE::OFF);
     //DIAG(F("TrackMode=%d"),mode);
     return true; 
 }
 
 void TrackManager::applyDCSpeed(byte t) {
   uint8_t speedByte=DCC::getThrottleSpeedByte(trackDCAddr[t]);
+  if (trackMode[t]==TRACK_MODE_DCX)
+    speedByte = speedByte ^ 128; // reverse direction bit
   track[t]->setDCSignal(speedByte);
 }
 
-bool TrackManager::parseEqualSign(Print *stream, int16_t params, int16_t p[])
+bool TrackManager::parseJ(Print *stream, int16_t params, int16_t p[])
 {
     
     if (params==0) { // <=>  List track assignments
         FOR_EACH_TRACK(t)
-             streamTrackState(stream,t);
+            if (track[t]!=NULL) {
+                StringFormatter::send(stream,F("<= %c "),'A'+t);
+                switch(trackMode[t]) {
+                    case TRACK_MODE_MAIN:
+                        StringFormatter::send(stream,F("MAIN"));
+			if (track[t]->trackPWM)
+			  StringFormatter::send(stream,F("+"));
+                        break;
+                    case TRACK_MODE_PROG:
+                        StringFormatter::send(stream,F("PROG"));
+			if (track[t]->trackPWM)
+			  StringFormatter::send(stream,F("+"));
+                        break;
+                    case TRACK_MODE_OFF:
+                        StringFormatter::send(stream,F("OFF"));
+                        break;
+                    case TRACK_MODE_EXT:
+                        StringFormatter::send(stream,F("EXT"));
+                        break;
+                    case TRACK_MODE_DC:
+                        StringFormatter::send(stream,F("DC %d"),trackDCAddr[t]);
+                        break;
+                    case TRACK_MODE_DCX:
+                        StringFormatter::send(stream,F("DCX %d"),trackDCAddr[t]);
+                        break;
+                    default:
+                        break; // unknown, dont care    
+                    }
+                StringFormatter::send(stream,F(">\n"));
+                }
         return true;
-        
     }
     
-    p[0]-="A"_hk;  // convert A... to 0.... 
+    p[0]-=HASH_KEYWORD_A;  // convert A... to 0.... 
 
     if (params>1 && (p[0]<0 || p[0]>=MAX_TRACKS)) 
         return false;
     
-    if (params==2  && p[1]=="MAIN"_hk) // <= id MAIN>
+    if (params==2  && p[1]==HASH_KEYWORD_MAIN) // <= id MAIN>
         return setTrackMode(p[0],TRACK_MODE_MAIN);
     
-#ifndef DISABLE_PROG
-    if (params==2  && p[1]=="PROG"_hk) // <= id PROG>
+    if (params==2  && p[1]==HASH_KEYWORD_PROG) // <= id PROG>
         return setTrackMode(p[0],TRACK_MODE_PROG);
-#endif
     
-    if (params==2  && (p[1]=="OFF"_hk || p[1]=="NONE"_hk)) // <= id OFF> <= id NONE>
-        return setTrackMode(p[0],TRACK_MODE_NONE);
+    if (params==2  && p[1]==HASH_KEYWORD_OFF) // <= id OFF>
+        return setTrackMode(p[0],TRACK_MODE_OFF);
 
-    if (params==2  && p[1]=="EXT"_hk) // <= id EXT>
+    if (params==2  && p[1]==HASH_KEYWORD_EXT) // <= id EXT>
         return setTrackMode(p[0],TRACK_MODE_EXT);
-#ifdef BOOSTER_INPUT
-    if (params==2  && p[1]=="BOOST"_hk) // <= id BOOST>
-        return setTrackMode(p[0],TRACK_MODE_BOOST);
-#endif
-    if (params==2  && p[1]=="AUTO"_hk) // <= id AUTO>
-      return setTrackMode(p[0], track[p[0]]->getMode() | TRACK_MODE_AUTOINV);
 
-    if (params==2  && p[1]=="INV"_hk) // <= id AUTO>
-      return setTrackMode(p[0], track[p[0]]->getMode() | TRACK_MODE_INV);
-
-    if (params==3  && p[1]=="DC"_hk && p[2]>0) // <= id DC cab>
+    if (params==3  && p[1]==HASH_KEYWORD_DC && p[2]>0) // <= id DC cab>
         return setTrackMode(p[0],TRACK_MODE_DC,p[2]);
     
-    if (params==3  && p[1]=="DCX"_hk && p[2]>0) // <= id DCX cab>
-        return setTrackMode(p[0],TRACK_MODE_DC|TRACK_MODE_INV,p[2]);
+    if (params==3  && p[1]==HASH_KEYWORD_DCX && p[2]>0) // <= id DCX cab>
+        return setTrackMode(p[0],TRACK_MODE_DCX,p[2]);
 
     return false;
 }
 
-const FSH* TrackManager::getModeName(TRACK_MODE tm) {
-  const FSH *modename=F("---");
-  
-  if (tm & TRACK_MODE_MAIN) {
-    if(tm & TRACK_MODE_AUTOINV)
-      modename=F("MAIN A");
-    else if (tm & TRACK_MODE_INV)
-      modename=F("MAIN I>\n");
-    else
-      modename=F("MAIN");
-  }
-#ifndef DISABLE_PROG
-  else if (tm & TRACK_MODE_PROG)
-    modename=F("PROG");
-#endif
-  else if (tm & TRACK_MODE_NONE)
-    modename=F("NONE");
-  else if(tm & TRACK_MODE_EXT)
-    modename=F("EXT");
-  else if(tm & TRACK_MODE_BOOST) {
-        if(tm & TRACK_MODE_AUTOINV)
-      modename=F("B A");
-    else if (tm & TRACK_MODE_INV)
-      modename=F("B I");
-    else
-      modename=F("B");
-  }
-  else if (tm & TRACK_MODE_DC) {
-    if (tm & TRACK_MODE_INV)
-      modename=F("DCX");
-    else
-      modename=F("DC");
-  }
-  return modename;
-}
-
-// null stream means send to commandDistributor for broadcast
-void TrackManager::streamTrackState(Print* stream, byte t) {
-  const FSH *format;
-  
-  if (track[t]==NULL) return;
-  TRACK_MODE tm = track[t]->getMode();
-  if (tm & TRACK_MODE_DC)
-    format=F("<= %c %S %d>\n");
-  else
-    format=F("<= %c %S>\n");
-
-  const FSH *modename=getModeName(tm);
-  if (stream) {  // null stream means send to commandDistributor for broadcast
-    StringFormatter::send(stream,format,'A'+t, modename, trackDCAddr[t]);
-  } else {
-    CommandDistributor::broadcastTrackState(format,'A'+t, modename, trackDCAddr[t]);
-    CommandDistributor::broadcastPower();
-  }
-  
-}
-
 byte TrackManager::nextCycleTrack=MAX_TRACKS;
 
 void TrackManager::loop() {
-    DCCWaveform::loop();
-#ifndef DISABLE_PROG
-    DCCACK::loop();
-#endif
+    DCCWaveform::loop(); 
+    DCCACK::loop(); 
     bool dontLimitProg=DCCACK::isActive() || progTrackSyncMain || progTrackBoosted;
     nextCycleTrack++;
     if (nextCycleTrack>lastTrack) nextCycleTrack=0;
     if (track[nextCycleTrack]==NULL) return;
     MotorDriver * motorDriver=track[nextCycleTrack];
-    bool useProgLimit=dontLimitProg ? false : (bool)(track[nextCycleTrack]->getMode() & TRACK_MODE_PROG);
+    bool useProgLimit=dontLimitProg? false: trackMode[nextCycleTrack]==TRACK_MODE_PROG;
     motorDriver->checkPowerOverload(useProgLimit, nextCycleTrack);   
 }
 
 MotorDriver * TrackManager::getProgDriver() {
     FOR_EACH_TRACK(t)
-      if (track[t]->getMode() & TRACK_MODE_PROG) return track[t];
+        if (trackMode[t]==TRACK_MODE_PROG) return track[t];
     return NULL;
 } 
 
@@ -475,127 +372,56 @@ MotorDriver * TrackManager::getProgDriver() {
 std::vector<MotorDriver *>TrackManager::getMainDrivers() {
   std::vector<MotorDriver *>  v;
   FOR_EACH_TRACK(t)
-    if (track[t]->getMode() & TRACK_MODE_MAIN) v.push_back(track[t]);
+    if (trackMode[t]==TRACK_MODE_MAIN) v.push_back(track[t]);
   return v;
 }
 #endif
 
-// Set track power for all tracks with this mode
-void TrackManager::setTrackPower(TRACK_MODE trackmodeToMatch, POWERMODE powermode) {
-  bool didChange=false;
-  FOR_EACH_TRACK(t) {
-    MotorDriver *driver=track[t];
-    TRACK_MODE trackmodeOfTrack = driver->getMode();
-    if (trackmodeToMatch & trackmodeOfTrack) {
-      if (powermode != driver->getPower())
-	didChange=true;
-      if (powermode == POWERMODE::ON) {
-	if (trackmodeOfTrack & TRACK_MODE_DC) {
-	  driver->setBrake(true);   // DC starts with brake on
-	  applyDCSpeed(t);          // speed match DCC throttles
-	} else {
-	  // toggle brake before turning power on - resets overcurrent error
-	  // on the Pololu board if brake is wired to ^D2.
-	  driver->setBrake(true);
-	  driver->setBrake(false); // DCC runs with brake off
-	}
-      }
-      driver->setPower(powermode);
+void TrackManager::setPower2(bool setProg,POWERMODE mode) {
+    if (!setProg) mainPowerGuess=mode; 
+    FOR_EACH_TRACK(t) {
+        MotorDriver * driver=track[t]; 
+        if (!driver) continue; 
+        switch (trackMode[t]) {
+            case TRACK_MODE_MAIN:
+                if (setProg) break; 
+                // toggle brake before turning power on - resets overcurrent error
+                // on the Pololu board if brake is wired to ^D2.
+		// XXX see if we can make this conditional
+                driver->setBrake(true);
+                driver->setBrake(false); // DCC runs with brake off
+                driver->setPower(mode);  
+                break; 
+            case TRACK_MODE_DC:
+            case TRACK_MODE_DCX:
+                if (setProg) break; 
+                applyDCSpeed(t);        // speed match DCC throttles
+                driver->setPower(mode);
+                break;  
+            case TRACK_MODE_PROG:
+                if (!setProg) break; 
+                driver->setBrake(true);
+                driver->setBrake(false);
+                driver->setPower(mode);
+                break;  
+            case TRACK_MODE_EXT:
+	        driver->setBrake(true);
+	        driver->setBrake(false);
+		driver->setPower(mode);
+	        break;
+            case TRACK_MODE_OFF:
+                break;
+        }
     }
-  }
-  if (didChange)
-    CommandDistributor::broadcastPower();
 }
-
-// Set track power for this track, inependent of mode
-void TrackManager::setTrackPower(POWERMODE powermode, byte t) {
-  MotorDriver *driver=track[t]; 
-  TRACK_MODE trackmode = driver->getMode();
-  POWERMODE oldpower = driver->getPower();
-  if (trackmode & TRACK_MODE_NONE) {
-    driver->setBrake(true);     // Track is unused. Brake is good to have.
-    powermode = POWERMODE::OFF; // Track is unused. Force it to OFF
-  } else if (trackmode & TRACK_MODE_DC) { // includes inverted DC (called DCX)
-    if (powermode == POWERMODE::ON) {
-      driver->setBrake(true);   // DC starts with brake on
-      applyDCSpeed(t);          // speed match DCC throttles
-    }
-  } else /* MAIN PROG EXT BOOST */ {
-    if (powermode == POWERMODE::ON) {
-      // toggle brake before turning power on - resets overcurrent error
-      // on the Pololu board if brake is wired to ^D2.
-      driver->setBrake(true);
-      driver->setBrake(false); // DCC runs with brake off
-    }
-  }
-  driver->setPower(powermode);
-  if (oldpower != driver->getPower())
-    CommandDistributor::broadcastPower();
-}
-
-// returns state of the one and only prog track
+  
 POWERMODE TrackManager::getProgPower() {
-  FOR_EACH_TRACK(t)
-    if (track[t]->getMode() & TRACK_MODE_PROG)
-      return track[t]->getPower(); // optimize: there is max one prog track
-  return POWERMODE::OFF;
-}
-
-// returns on if all are on. returns off otherwise
-POWERMODE TrackManager::getMainPower() {
-  POWERMODE result = POWERMODE::OFF;
-  FOR_EACH_TRACK(t) {
-    if (track[t]->getMode() & TRACK_MODE_MAIN) {
-      POWERMODE p = track[t]->getPower();
-      if (p == POWERMODE::OFF)
-	return POWERMODE::OFF; // done and out
-      if (p == POWERMODE::ON)
-	result = POWERMODE::ON;
-    }
+    FOR_EACH_TRACK(t)
+        if (trackMode[t]==TRACK_MODE_PROG) 
+                return track[t]->getPower();
+    return POWERMODE::OFF;   
   }
-  return result;
-}
-
-bool TrackManager::getPower(byte t, char s[]) {
-  if (t > lastTrack)
-    return false;
-  if (track[t]) {
-    s[0] = track[t]->getPower() == POWERMODE::ON ? '1' : '0';
-    s[2] = t + 'A';
-    return true;
-  }
-  return false;
-}
-
-
-void TrackManager::reportObsoleteCurrent(Print* stream) {
-  // This function is for backward JMRI compatibility only
-  // It reports the first track only, as main, regardless of track settings.
-  //  <c MeterName value C/V unit min max res warn>
-  int maxCurrent=track[0]->raw2mA(track[0]->getRawCurrentTripValue());
-  StringFormatter::send(stream, F("<c CurrentMAIN %d C Milli 0 %d 1 %d>\n"), 
-            track[0]->raw2mA(track[0]->getCurrentRaw(false)), maxCurrent, maxCurrent);                  
-}
-
-void TrackManager::reportCurrent(Print* stream) {
-    StringFormatter::send(stream,F("<jI"));
-    FOR_EACH_TRACK(t) {
-         StringFormatter::send(stream, F(" %d"),
-         (track[t]->getPower()==POWERMODE::OVERLOAD) ? -1 :
-            track[t]->raw2mA(track[t]->getCurrentRaw(false)));
-         }
-    StringFormatter::send(stream,F(">\n"));    
-}
-
-void TrackManager::reportGauges(Print* stream) {
-    StringFormatter::send(stream,F("<jG"));
-    FOR_EACH_TRACK(t) {
-         StringFormatter::send(stream, F(" %d"),
-            track[t]->raw2mA(track[t]->getRawCurrentTripValue()));
-         }
-    StringFormatter::send(stream,F(">\n"));    
-}
-
+   
 void TrackManager::setJoinRelayPin(byte joinRelayPin) {
   joinRelay=joinRelayPin;
   if (joinRelay!=UNUSED_PIN) {
@@ -608,7 +434,7 @@ void TrackManager::setJoin(bool joined) {
 #ifdef ARDUINO_ARCH_ESP32
   if (joined) {
     FOR_EACH_TRACK(t) {
-      if (track[t]->getMode() & TRACK_MODE_PROG) {
+      if (trackMode[t]==TRACK_MODE_PROG) {
 	tempProgTrack = t;
 	setTrackMode(t, TRACK_MODE_MAIN);
 	break;
@@ -616,12 +442,7 @@ void TrackManager::setJoin(bool joined) {
     }
   } else {
     if (tempProgTrack != MAX_TRACKS+1) {
-      // as setTrackMode with TRACK_MODE_PROG defaults to
-      // power off, we will take the current power state
-      // of our track and then preserve that state.
-      POWERMODE tPTmode = track[tempProgTrack]->getPower(); //get current power status of this track
       setTrackMode(tempProgTrack, TRACK_MODE_PROG);
-      track[tempProgTrack]->setPower(tPTmode);              //set track status as it was before
       tempProgTrack = MAX_TRACKS+1;
     }
   }
@@ -629,24 +450,3 @@ void TrackManager::setJoin(bool joined) {
   progTrackSyncMain=joined;
   if (joinRelay!=UNUSED_PIN) digitalWrite(joinRelay,joined?HIGH:LOW);
 }
-
-bool TrackManager::isPowerOn(byte t) {
-      if (track[t]->getPower()!=POWERMODE::ON) 
-	        return false;
-    return true;   
-  }
-
-bool TrackManager::isProg(byte t) {
-    if (track[t]->getMode() & TRACK_MODE_PROG)
-        return true;
-    return false;
-}
-
-TRACK_MODE TrackManager::getMode(byte t) {
-    return (track[t]->getMode());
-}
-
-int16_t TrackManager::returnDCAddr(byte t) {
-    return (trackDCAddr[t]);
-}
-

TrackManager.h

@@ -1,8 +1,6 @@
 /*
  *  © 2022 Chris Harlow
  *  © 2022 Harald Barth
- *  © 2023 Colin Murdoch
- * 
  *  All rights reserved.
  *  
  *  This file is part of CommandStation-EX
@@ -29,6 +27,10 @@
 #include "MotorDriver.h"
 // Virtualised Motor shield multi-track hardware Interface
 
+// use powers of two so we can do logical and/or on the track modes in if clauses.
+enum TRACK_MODE : byte {TRACK_MODE_OFF = 1, TRACK_MODE_MAIN = 2, TRACK_MODE_PROG = 4,
+                        TRACK_MODE_DC = 8, TRACK_MODE_DCX = 16, TRACK_MODE_EXT = 32};
+
 // These constants help EXRAIL macros say SET_TRACK(2,mode) OR SET_TRACK(C,mode) etc.
 const byte TRACK_NUMBER_0=0, TRACK_NUMBER_A=0;    
 const byte TRACK_NUMBER_1=1, TRACK_NUMBER_B=1;    
@@ -39,10 +41,6 @@ const byte TRACK_NUMBER_5=5, TRACK_NUMBER_F=5;
 const byte TRACK_NUMBER_6=6, TRACK_NUMBER_G=6;    
 const byte TRACK_NUMBER_7=7, TRACK_NUMBER_H=7;    
 
-// These constants help EXRAIL macros convert Track Power e.g. SET_POWER(A ON|OFF).
-const byte TRACK_POWER_0=0, TRACK_POWER_OFF=0;    
-const byte TRACK_POWER_1=1, TRACK_POWER_ON=1;   
-
 class TrackManager {
   public:
     static void Setup(const FSH * shieldName,
@@ -62,58 +60,37 @@ class TrackManager {
     static void setDCSignal(int16_t cab, byte speedbyte);
     static MotorDriver * getProgDriver();
 #ifdef ARDUINO_ARCH_ESP32
-    static std::vector<MotorDriver *>getMainDrivers();
+  static std::vector<MotorDriver *>getMainDrivers();
 #endif
-  
+    static void setPower2(bool progTrack,POWERMODE mode);
     static void setPower(POWERMODE mode) {setMainPower(mode); setProgPower(mode);}
-    static void setTrackPower(POWERMODE mode, byte t);
-    static void setTrackPower(TRACK_MODE trackmode, POWERMODE powermode);
-    static void setMainPower(POWERMODE mode) {setTrackPower(TRACK_MODE_MAIN, mode);}
-    static void setProgPower(POWERMODE mode) {setTrackPower(TRACK_MODE_PROG, mode);}
+    static void setMainPower(POWERMODE mode) {setPower2(false,mode);}
+    static void setProgPower(POWERMODE mode) {setPower2(true,mode);}
 
     static const int16_t MAX_TRACKS=8;
     static bool setTrackMode(byte track, TRACK_MODE mode, int16_t DCaddr=0);
-    static bool parseEqualSign(Print * stream,  int16_t params, int16_t p[]);
+    static bool parseJ(Print * stream,  int16_t params, int16_t p[]);
     static void loop();
-    static POWERMODE getMainPower();
+    static POWERMODE getMainPower() {return mainPowerGuess;}
     static POWERMODE getProgPower();
-    static inline POWERMODE getPower(byte t) { return track[t]->getPower(); }
-    static bool getPower(byte t, char s[]);
     static void setJoin(bool join);
     static bool isJoined() { return progTrackSyncMain;}
-    static inline bool isActive (byte tr) {
-      if (tr > lastTrack) return false;
-      return track[tr]->getMode() & (TRACK_MODE_MAIN|TRACK_MODE_PROG|TRACK_MODE_DC|TRACK_MODE_BOOST|TRACK_MODE_EXT);}
     static void setJoinRelayPin(byte joinRelayPin);
     static void sampleCurrent();
-    static void reportGauges(Print* stream);
-    static void reportCurrent(Print* stream);
-    static void reportObsoleteCurrent(Print* stream); 
-    static void streamTrackState(Print* stream, byte t);
-    static bool isPowerOn(byte t);
-    static bool isProg(byte t);
-    static TRACK_MODE getMode(byte t);
-    static int16_t returnDCAddr(byte t);
-    static const FSH* getModeName(TRACK_MODE Mode);
-
     static int16_t joinRelay;
     static bool progTrackSyncMain;  // true when prog track is a siding switched to main
-    static bool progTrackBoosted;   // true when prog track is not current limited
-
-#ifdef DEBUG_ADC
-  public:
-#else
-  private:
-#endif
-    static MotorDriver* track[MAX_TRACKS];
-
+     static bool progTrackBoosted;   // true when prog track is not current limited
+    
   private:
     static void addTrack(byte t, MotorDriver* driver);
     static byte lastTrack;
     static byte nextCycleTrack;
+    static POWERMODE mainPowerGuess;
     static void applyDCSpeed(byte t);
 
-    static int16_t trackDCAddr[MAX_TRACKS];  // dc address if TRACK_MODE_DC
+    static MotorDriver* track[MAX_TRACKS];
+    static TRACK_MODE trackMode[MAX_TRACKS]; 
+    static int16_t trackDCAddr[MAX_TRACKS];  // dc address if TRACK_MODE_DC or TRACK_MODE_DCX
 #ifdef ARDUINO_ARCH_ESP32
     static byte tempProgTrack; // holds the prog track number during join
 #endif

Turnouts.cpp

@@ -110,40 +110,49 @@
   /* static */ bool Turnout::setClosedStateOnly(uint16_t id, bool closeFlag) {
     Turnout *tt = get(id);
     if (!tt) return false;
+    tt->_turnoutData.closed = closeFlag;
+
     // I know it says setClosedStateOnly, but we need to tell others
-    // that the state has changed too. But we only broadcast if there
-    // really has been a change.
-    if (tt->_turnoutData.closed != closeFlag) {
-      tt->_turnoutData.closed = closeFlag;
-      CommandDistributor::broadcastTurnout(id, closeFlag);
-    }
-#if defined(EXRAIL_ACTIVE)
-    RMFT2::turnoutEvent(id, closeFlag);
-#endif
+    //  that the state has changed too.
+    #if defined(EXRAIL_ACTIVE)
+      RMFT2::turnoutEvent(id, closeFlag);
+    #endif
+
+    CommandDistributor::broadcastTurnout(id, closeFlag);
     return true;
   }
 
-#define DIAG_IO
+
   // Static setClosed function is invoked from close(), throw() etc. to perform the 
   //  common parts of the turnout operation.  Code which is specific to a turnout
   //  type should be placed in the virtual function setClosedInternal(bool) which is
   //  called from here.
   /* static */ bool Turnout::setClosed(uint16_t id, bool closeFlag) { 
-#if defined(DIAG_IO)
-    DIAG(F("Turnout(%d,%c)"), id, closeFlag ? 'c':'t');
-#endif
+  #if defined(DIAG_IO)
+    if (closeFlag) 
+      DIAG(F("Turnout::close(%d)"), id);
+    else
+      DIAG(F("Turnout::throw(%d)"), id);
+  #endif
     Turnout *tt = Turnout::get(id);
     if (!tt) return false;
     bool ok = tt->setClosedInternal(closeFlag);
 
     if (ok) {
-      tt->setClosedStateOnly(id, closeFlag);
+      
 #ifndef DISABLE_EEPROM
       // Write byte containing new closed/thrown state to EEPROM if required.  Note that eepromAddress
       // is always zero for LCN turnouts.
       if (EEStore::eeStore->data.nTurnouts > 0 && tt->_eepromAddress > 0) 
         EEPROM.put(tt->_eepromAddress, tt->_turnoutData.flags);
 #endif
+
+    #if defined(EXRAIL_ACTIVE)
+      RMFT2::turnoutEvent(id, closeFlag);
+    #endif
+
+      // Send message to JMRI etc.
+      CommandDistributor::broadcastTurnout(id, closeFlag);
     }
     return ok;
   }
@@ -198,7 +207,7 @@
     }
 
 #ifdef EESTOREDEBUG
-    printAll(&USB_SERIAL);
+    printAll(&Serial);
 #endif
     return tt;
   }
@@ -250,7 +259,6 @@
       }
     }
     tt = (Turnout *)new ServoTurnout(id, vpin, thrownPosition, closedPosition, profile, closed);
-    DIAG(F("Turnout 0x%x size %d size %d"), tt, sizeof(Turnout),sizeof(struct TurnoutData));
     IODevice::writeAnalogue(vpin, closed ? closedPosition : thrownPosition, PCA9685::Instant);
     return tt;
 #else
@@ -290,6 +298,7 @@
 #ifndef IO_NO_HAL
     IODevice::writeAnalogue(_servoTurnoutData.vpin, 
       close ? _servoTurnoutData.closedPosition : _servoTurnoutData.thrownPosition, _servoTurnoutData.profile);
+    _turnoutData.closed = close;
 #else
     (void)close;  // avoid compiler warnings
 #endif
@@ -387,6 +396,7 @@
     // and Close writes a 0.  
     // RCN-213 specifies that Throw is 0 and Close is 1.
     DCC::setAccessory(_dccTurnoutData.address, _dccTurnoutData.subAddress, close ^ !rcn213Compliant);
+    _turnoutData.closed = close;
     return true;
   }
 
@@ -462,6 +472,7 @@
 
   bool VpinTurnout::setClosedInternal(bool close) {
     IODevice::write(_vpinTurnoutData.vpin, close);
+    _turnoutData.closed = close;
     return true;
   }
 
@@ -512,10 +523,7 @@
   bool LCNTurnout::setClosedInternal(bool close) {
     // Assume that the LCN command still uses 1 for throw and 0 for close...
     LCN::send('T', _turnoutData.id, !close);
-    // The _turnoutData.closed flag should be updated by a message from the LCN master.
-    // but in this implementation it is updated in setClosedStateOnly() instead.
-    // If the LCN master updates this, setClosedStateOnly() and all setClosedInternal()
-    // have to be updated accordingly so that the closed flag is only set once.
+    // The _turnoutData.closed flag should be updated by a message from the LCN master, later.
     return true;
   }
 

Turnouts.h

@@ -69,12 +69,10 @@ protected:
     uint16_t id;
   } _turnoutData;  // 3 bytes
 
-#ifndef DISABLE_EEPROM
   // Address in eeprom of first byte of the _turnoutData struct (containing the closed flag).
   // Set to zero if the object has not been saved in EEPROM, e.g. for newly created Turnouts, and 
   // for all LCN turnouts.
   uint16_t _eepromAddress = 0;
-#endif
 
   // Pointer to next turnout on linked list.
   Turnout *_nextTurnout = 0;

Turntables.cpp

@@ -1,268 +0,0 @@
-/*
- *  © 2023 Peter Cole
- *  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/>.
- */
-
-#include "defines.h"
-#include <Arduino.h>
-#include "Turntables.h"
-#include "StringFormatter.h"
-#include "CommandDistributor.h"
-#include "EXRAIL2.h"
-#include "DCC.h"
-
-// No turntable support without HAL
-#ifndef IO_NO_HAL
-
-/*
- * Protected static data
- */
-Turntable *Turntable::_firstTurntable = 0;
-
-
-/*
- * Public static data
- */
-int Turntable::turntablelistHash = 0;
-
-
-/*
- * Protected static functions
- */
-// Add new turntable to end of list
-
-void Turntable::add(Turntable *tto) {
-  if (!_firstTurntable) {
-    _firstTurntable = tto;
-  } else {
-    Turntable *ptr = _firstTurntable;
-    for ( ; ptr->_nextTurntable!=0; ptr=ptr->_nextTurntable) {}
-    ptr->_nextTurntable = tto;
-  }
-  turntablelistHash++;
-}
-
-// Add a position
-void Turntable::addPosition(uint8_t idx, uint16_t value, uint16_t angle) {
-  _turntablePositions.insert(idx, value, angle);
-}
-
-// Get value for position
-uint16_t Turntable::getPositionValue(uint8_t position) {
-  TurntablePosition* currentPosition = _turntablePositions.getHead();
-  while (currentPosition) {
-    if (currentPosition->index == position) {
-      return currentPosition->data;
-    }
-    currentPosition = currentPosition->next;
-  }
-  return false;
-}
-
-// Get value for position
-uint16_t Turntable::getPositionAngle(uint8_t position) {
-  TurntablePosition* currentPosition = _turntablePositions.getHead();
-  while (currentPosition) {
-    if (currentPosition->index == position) {
-      return currentPosition->angle;
-    }
-    currentPosition = currentPosition->next;
-  }
-  return false;
-}
-
-// Get the count of positions associated with the turntable
-uint8_t Turntable::getPositionCount()  {
-  TurntablePosition* currentPosition = _turntablePositions.getHead();
-  uint8_t count = 0;
-  while (currentPosition) {
-    count++;
-    currentPosition = currentPosition->next;
-  }
-  return count;
-}
-
-/*
- * 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<EXTTTurntable*>(tto);
-      if (exttTto->getVpin() == vpin) {
-        return tto;
-      }
-    }
-  }
-  return nullptr;
-}
-
-// Get the current position for turntable with the specified ID
-uint8_t Turntable::getPosition(uint16_t id) {
-  Turntable *tto = get(id);
-  if (!tto) return false;
-  return tto->getPosition();
-}
-
-// Got the moving state of the specified turntable
-bool Turntable::ttMoving(uint16_t id) {
-  Turntable *tto = get(id);
-  if (!tto) return false;
-  return tto->isMoving();
-}
-
-// Initiate a turntable move
-bool Turntable::setPosition(uint16_t id, uint8_t position, uint8_t activity) {
-#if defined(DIAG_IO)
-  DIAG(F("Rotate turntable %d to position %d, activity %d)"), id, position, activity);
-#endif
-  Turntable *tto = Turntable::get(id);
-  if (!tto) return false;
-  if (tto->isMoving()) return false;
-  bool ok = tto->setPositionInternal(position, activity);
-
-  if (ok) {
-    // We only deal with broadcasts for DCC turntables here, EXTT in the device driver
-    if (!tto->isEXTT()) {
-      CommandDistributor::broadcastTurntable(id, position, false);
-    }
-    // Trigger EXRAIL rotateEvent for both types here if changed
-#if defined(EXRAIL_ACTIVE)
-    bool rotated = false;
-    if (position != tto->_previousPosition) rotated = true;
-    RMFT2::rotateEvent(id, rotated);
-#endif
-  }
-  return ok;
-}
-
-/*************************************************************************************
- * EXTTTurntable - EX-Turntable device.
- * 
- *************************************************************************************/
-// Private constructor
-EXTTTurntable::EXTTTurntable(uint16_t id, VPIN vpin) :
-  Turntable(id, TURNTABLE_EXTT)
-{
-  _exttTurntableData.vpin = vpin;
-}
-
-using DevState = IODevice::DeviceStateEnum;
-
-// Create function
-  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;
-        return tto;
-      }
-    }
-    if (!IODevice::exists(vpin)) return nullptr;
-    if (IODevice::getStatus(vpin) == DevState::DEVSTATE_FAILED) return nullptr;
-    if (Turntable::getByVpin(vpin)) 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)vpin;
-  return NULL;
-#endif
-  }
-
-  void EXTTTurntable::print(Print *stream) {
-    StringFormatter::send(stream, F("<i %d EXTURNTABLE %d>\n"), _turntableData.id, _exttTurntableData.vpin);
-  }
-
-  // EX-Turntable specific code for moving to the specified position
-  bool EXTTTurntable::setPositionInternal(uint8_t position, uint8_t activity) {
-#ifndef IO_NO_HAL
-    int16_t value;
-    if (position == 0) {
-      value = 0;  // Position 0 is just to send activities
-    } else {
-      if (activity > 1) return false; // If sending a position update, only phase changes valid (0|1)
-      value = getPositionValue(position); // Get position value from position list
-    }
-    if (position > 0 && !value) return false; // Return false if it's not a valid position
-    // Set position via device driver
-    _previousPosition = _turntableData.position;
-    _turntableData.position = position;
-    EXTurntable::writeAnalogue(_exttTurntableData.vpin, value, activity);
-#else
-    (void)position;
-#endif
-    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("<i %d DCCTURNTABLE>\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
-    int16_t addr=value>>3;
-    int16_t subaddr=(value>>1) & 0x03;
-    bool active=value & 0x01;
-    _previousPosition = _turntableData.position;
-    _turntableData.position = position;
-    DCC::setAccessory(addr, subaddr, active);
-#else
-    (void)position;
-#endif
-    return true;
-  }
-
-#endif

Turntables.h

@@ -1,243 +0,0 @@
-/*
- *  © 2023 Peter Cole
- *  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/>.
- */
-
-#ifndef TURNTABLES_H
-#define TURNTABLES_H
-
-#include <Arduino.h>
-#include "IODevice.h"
-#include "StringFormatter.h"
-
-// No turntable support without HAL
-#ifndef IO_NO_HAL
-
-// Turntable type definitions
-// EXTT = EX-Turntable
-// DCC = DCC accessory turntables - to be added later
-enum {
-  TURNTABLE_EXTT = 0,
-  TURNTABLE_DCC = 1,
-};
-
-/*************************************************************************************
- * Turntable positions.
- * 
- *************************************************************************************/
-struct TurntablePosition {
-  uint8_t index;
-  uint16_t data;
-  uint16_t angle;
-  TurntablePosition* next;
-  
-  TurntablePosition(uint8_t idx, uint16_t value, uint16_t angle) : index(idx), data(value), angle(angle), next(nullptr) {}
-};
-
-class TurntablePositionList {
-public:
-  TurntablePositionList() : head(nullptr) {}
-
-  void insert(uint8_t idx, uint16_t value, uint16_t angle) {
-    TurntablePosition* newPosition = new TurntablePosition(idx, value, angle);
-    if(!head) {
-      head = newPosition;
-    } else {
-      newPosition->next = head;
-      head = newPosition;
-    }
-  }
-
-  TurntablePosition* getHead() {
-    return head;
-  }
-
-private:
-  TurntablePosition* head;
-
-};
-
-
-/*************************************************************************************
- * Turntable - Base class for turntables.
- * 
- *************************************************************************************/
-
-class Turntable {
-protected:
-  /*
-   * Object data
-   */
-
-  //  Data common to all turntable types
-  struct TurntableData {
-    union {
-      struct {
-        bool hidden : 1;
-        bool turntableType : 1;
-        uint8_t position : 6;       // Allows up to 63 positions including 0/home
-      };
-      uint8_t flags;
-    };
-    uint16_t id;
-  } _turntableData;
-
-  // Pointer to next turntable object
-  Turntable *_nextTurntable = 0;
-
-  // Linked list for positions
-  TurntablePositionList _turntablePositions;
-  
-  // Store the previous position to allow checking for changes
-  uint8_t _previousPosition = 0;
-
-  // Store the current state of the turntable
-  bool _isMoving = false;
-
-  /*
-   * Constructor
-   */
-  Turntable(uint16_t id, uint8_t turntableType) {
-    _turntableData.id = id;
-    _turntableData.turntableType = turntableType;
-    _turntableData.hidden = false;
-    _turntableData.position = 0;
-    add(this);
-  }
-
-  /*
-   * Static data
-   */
-  static Turntable *_firstTurntable;
-  static int _turntablelistHash;
-
-  /*
-   * Virtual functions
-   */
-  virtual bool setPositionInternal(uint8_t position, uint8_t activity) = 0;
-
-  /*
-   * Static functions
-   */
-  static void add(Turntable *tto);
-
-public:
-  static Turntable *get(uint16_t id);
-  static Turntable *getByVpin(VPIN vpin);
-
-  /*
-   * Static data
-   */
-  static int turntablelistHash;
-
-  /*
-   * Public base class functions
-   */
-  inline uint8_t getPosition() { return _turntableData.position; }
-  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 bool isEXTT() const { return _turntableData.turntableType == TURNTABLE_EXTT; }
-  inline uint16_t getId() { return _turntableData.id; }
-  inline Turntable *next() { return _nextTurntable; }
-  void printState(Print *stream);
-  void addPosition(uint8_t idx, uint16_t value, uint16_t angle);
-  uint16_t getPositionValue(uint8_t position);
-  uint16_t getPositionAngle(uint8_t position);
-  uint8_t getPositionCount();
-  bool isMoving() { return _isMoving; }
-  void setMoving(bool moving) { _isMoving=moving; }
-
-  /*
-   * Virtual functions
-   */
-  virtual void print(Print *stream) {
-    (void)stream; // suppress compiler warnings
-  }
-  virtual ~Turntable() {} // Destructor
-  
-
-  /*
-   * Public static functions
-   */
-  inline static bool exists(uint16_t id) { return get(id) != 0; }
-  static bool setPosition(uint16_t id, uint8_t position, uint8_t activity=0);
-  static uint8_t getPosition(uint16_t id);
-  static bool ttMoving(uint16_t id);
-  inline static Turntable *first() { return _firstTurntable; }
-  static bool printAll(Print *stream) {
-    bool gotOne = false;
-    for (Turntable *tto = _firstTurntable; tto != 0; tto = tto->_nextTurntable)
-      if (!tto->isHidden()) {
-        gotOne = true;
-        StringFormatter::send(stream, F("<I %d %d>\n"), tto->getId(), tto->getPosition());
-      }
-    return gotOne;
-  }
-
-};
-
-/*************************************************************************************
- * EXTTTurntable - EX-Turntable device.
- * 
- *************************************************************************************/
-class EXTTTurntable : public Turntable {
-private:
-  // EXTTTurntableData contains device specific data
-  struct EXTTTurntableData {
-    VPIN vpin;
-  } _exttTurntableData;
-
-  // Constructor
-  EXTTTurntable(uint16_t id, VPIN vpin);
-
-public:
-  // Create function
-  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
-  bool setPositionInternal(uint8_t position, uint8_t activity) override;
-
-};
-
-/*************************************************************************************
- * 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

WiThrottle.cpp

@@ -150,6 +150,7 @@ void WiThrottle::parse(RingStream * stream, byte * cmdx) {
 	  DCCWaveform::progTrack.setPowerMode(cmd[3]=='1'?POWERMODE::ON:POWERMODE::OFF);
 */
 
+	CommandDistributor::broadcastPower();
       }
 #if defined(EXRAIL_ACTIVE)
       else if (cmd[1]=='R' && cmd[2]=='A' && cmd[3]=='2' ) { // Route activate
@@ -187,7 +188,6 @@ void WiThrottle::parse(RingStream * stream, byte * cmdx) {
       }
       break;
     case 'N':  // Heartbeat (2), only send if connection completed by 'HU' message
-      sendIntro(stream);
       StringFormatter::send(stream, F("*%d\n"), heartrateSent ? HEARTBEAT_SECONDS : HEARTBEAT_PRELOAD); // return timeout value
       break;
     case 'M': // multithrottle
@@ -195,7 +195,7 @@ void WiThrottle::parse(RingStream * stream, byte * cmdx) {
       break;
     case 'H': // send initial connection info after receiving "HU" message
       if (cmd[1] == 'U') {    
-	sendIntro(stream);
+      sendIntro(stream);	
       }
       break;           
     case 'Q': // 
@@ -235,10 +235,6 @@ int WiThrottle::getLocoId(byte * cmd) {
 void WiThrottle::multithrottle(RingStream * stream, byte * cmd){ 
   char throttleChar=cmd[1];
   int locoid=getLocoId(cmd+3); // -1 for *
-  if (locoid > 10239 || locoid < -1) {
-    StringFormatter::send(stream, F("No valid DCC loco %d\n"), locoid);
-    return;
-  }
   byte * aval=cmd;
   while(*aval !=';' && *aval !='\0') aval++;
   if (*aval) aval+=2;  // skip ;>
@@ -496,17 +492,16 @@ void WiThrottle::getLocoCallback(int16_t locoid) {
   TrackManager::setJoin(true);          // <1 JOIN> so we can drive loco away
   DIAG(F("LocoCallback commit success"));
   stashStream->commit();
+  CommandDistributor::broadcastPower();
 }
 
 void WiThrottle::sendIntro(Print* stream) {
-  if (introSent) // sendIntro only once
-    return;
   introSent=true; 
   StringFormatter::send(stream,F("VN2.0\nHTDCC-EX\nRL0\n"));
-  StringFormatter::send(stream,F("HtDCC-EX v%S, %S, %S, %S\n"), F(VERSION), F(ARDUINO_TYPE), DCC::getMotorShieldName(), F(GITHUB_SHA));
-  StringFormatter::send(stream,F("PTT]\\[Turnouts}|{Turnout]\\[THROW}|{2]\\[CLOSE}|{4\n"));
-  StringFormatter::send(stream,F("PPA%x\n"),TrackManager::getMainPower()==POWERMODE::ON);
-  // set heartbeat to 2 seconds because we need to sync the metadata (1 second is too short!)
+	StringFormatter::send(stream,F("HtDCC-EX v%S, %S, %S, %S\n"), F(VERSION), F(ARDUINO_TYPE), DCC::getMotorShieldName(), F(GITHUB_SHA));
+	StringFormatter::send(stream,F("PTT]\\[Turnouts}|{Turnout]\\[THROW}|{2]\\[CLOSE}|{4\n"));
+	StringFormatter::send(stream,F("PPA%x\n"),TrackManager::getMainPower()==POWERMODE::ON);     
+	// set heartbeat to 2 seconds because we need to sync the metadata (1 second is too short!)
   StringFormatter::send(stream,F("*%d\nHMConnecting..\n"), HEARTBEAT_PRELOAD);
 }
 
@@ -532,13 +527,10 @@ void WiThrottle::sendRoster(Print* stream) {
   rosterSent=true;
 #ifdef EXRAIL_ACTIVE
   StringFormatter::send(stream,F("RL%d"), RMFT2::rosterNameCount);
-  for (int16_t r=0;;r++) {
+  for (int16_t r=0;r<RMFT2::rosterNameCount;r++) {
       int16_t cabid=GETHIGHFLASHW(RMFT2::rosterIdList,r*2);
-      if (cabid == INT16_MAX)
-	break;
-      if (cabid > 0)
-	StringFormatter::send(stream,F("]\\[%S}|{%d}|{%c"),
-			      RMFT2::getRosterName(cabid),cabid,cabid<128?'S':'L');
+      StringFormatter::send(stream,F("]\\[%S}|{%d}|{%c"),
+      RMFT2::getRosterName(cabid),cabid,cabid<128?'S':'L');
   }
   StringFormatter::send(stream,F("\n"));       
 #else
@@ -552,14 +544,14 @@ void WiThrottle::sendRoutes(Print* stream) {
     // first pass automations
     for (int ix=0;;ix+=2) {
         int16_t id =GETHIGHFLASHW(RMFT2::automationIdList,ix);
-        if (id==INT16_MAX) break;
+        if (id==0) break;
         const FSH * desc=RMFT2::getRouteDescription(id);
         StringFormatter::send(stream,F("]\\[A%d}|{%S}|{4"),id,desc);
     }
     // second pass routes.
     for (int ix=0;;ix+=2) {
         int16_t id=GETHIGHFLASHW(RMFT2::routeIdList,ix);
-        if (id==INT16_MAX) break;
+        if (id==0) break;
         const FSH * desc=RMFT2::getRouteDescription(id);
         StringFormatter::send(stream,F("]\\[R%d}|{%S}|{2"),id,desc);
     }
@@ -575,13 +567,9 @@ void WiThrottle::sendFunctions(Print* stream, byte loco) {
 	myLocos[loco].functionToggles=1<<2; // F2 (HORN)  is a non-toggle
         
 #ifdef EXRAIL_ACTIVE
-	const FSH * functionNames= RMFT2::getRosterFunctions(locoid);
-	if (functionNames == NULL) {
-	  // no roster entry for locoid, try to find default entry
-	  functionNames= RMFT2::getRosterFunctions(0);
-	}
-	if (functionNames == NULL) {
-	  // no default roster entry either, use non-exrail presets as above 
+	const char * functionNames=(char *) RMFT2::getRosterFunctions(locoid);
+	if (!functionNames) {
+	  // no roster, use non-exrail presets as above 
 	}
 	else if (GETFLASH(functionNames)=='\0') {
 	  // "" = Roster but no functions given
@@ -596,7 +584,7 @@ void WiThrottle::sendFunctions(Print* stream, byte loco) {
 	  fkeys=0;
 	  bool firstchar=true;
 	  for (int fx=0;;fx++) {
-	    char c=GETFLASH((char *)functionNames+fx);
+	    char c=GETFLASH(functionNames+fx);
 	    if (c=='\0') {
 	      fkeys++;
 	      break;

WifiESP32.cpp

@@ -1,7 +1,5 @@
 /*
-    © 2023 Paul M. Antoine
-    © 2021 Harald Barth
-    © 2023 Nathan Kellenicki
+    © 2021, Harald Barth.
 
     This file is part of CommandStation-EX
 
@@ -22,7 +20,6 @@
 #if defined(ARDUINO_ARCH_ESP32)
 #include <vector>
 #include "defines.h"
-#include "ESPmDNS.h"
 #include <WiFi.h>
 #include "esp_wifi.h"
 #include "WifiESP32.h"
@@ -39,15 +36,9 @@
 #include "soc/timer_group_reg.h"
 void feedTheDog0(){
   // feed dog 0
-#ifdef ARDUINO_ESP32S3_DEV
-  TIMERG0.wdtwprotect.wdt_wkey=0x50D83AA1; //MWDT_LL_WKEY_VALUE? write enable
-  TIMERG0.wdtfeed.wdt_feed=1;              // feed dog
-  TIMERG0.wdtwprotect.wdt_wkey=0;          // write protect
-#else
   TIMERG0.wdt_wprotect=TIMG_WDT_WKEY_VALUE; // write enable
   TIMERG0.wdt_feed=1;                       // feed dog
   TIMERG0.wdt_wprotect=0;                   // write protect
-#endif
   // feed dog 1
   //TIMERG1.wdt_wprotect=TIMG_WDT_WKEY_VALUE; // write enable
   //TIMERG1.wdt_feed=1;                       // feed dog
@@ -80,39 +71,25 @@ class NetworkClient {
 public:
   NetworkClient(WiFiClient c) {
     wifi = c;
-    inUse = true;
   };
-  bool active(byte clientId) {
-    if (!inUse)
-      return false;
-    if(!wifi.connected()) {
-      DIAG(F("Remove client %d"), clientId);
-      CommandDistributor::forget(clientId);
-      wifi.stop();
-      inUse = false;
-      return false;
-    }
-    return true;
-  }
+  bool ok() {
+    return (inUse && wifi.connected());
+  };
   bool recycle(WiFiClient c) {
-    if (wifi == c) {
-      if (inUse == true)
-	DIAG(F("WARNING: Duplicate"));
-      else
-	DIAG(F("Returning"));
-      inUse = true;
-      return true;
-    }
-    if (inUse == false) {
-      wifi = c;
-      inUse = true;
-      return true;
-    }
+
+    if (inUse == true) return false;
+
+    // return false here until we have
+    // implemented a LRU timer
+    // if (LRU too recent) return false;
     return false;
+
+    wifi = c;
+    inUse = true;
+    return true;
   };
   WiFiClient wifi;
-private:
-  bool inUse;
+  bool inUse = true;
 };
 
 static std::vector<NetworkClient> clients; // a list to hold all clients
@@ -128,18 +105,11 @@ void wifiLoop(void *){
 }
 #endif
 
-char asciitolower(char in) {
-  if (in <= 'Z' && in >= 'A')
-    return in - ('Z' - 'z');
-  return in;
-}
-
 bool WifiESP::setup(const char *SSid,
                     const char *password,
                     const char *hostname,
                     int port,
-                    const byte channel,
-                    const bool forceAP) {
+                    const byte channel) {
   bool havePassword = true;
   bool haveSSID = true;
   bool wifiUp = false;
@@ -167,11 +137,8 @@ bool WifiESP::setup(const char *SSid,
   if (strncmp(yourNetwork, password, 13) == 0 || strncmp("", password, 13) == 0)
     havePassword = false;
 
-  if (haveSSID && havePassword && !forceAP) {
-    WiFi.setHostname(hostname); // Strangely does not work unless we do it HERE!
+  if (haveSSID && havePassword) {
     WiFi.mode(WIFI_STA);
-    WiFi.setScanMethod(WIFI_ALL_CHANNEL_SCAN); // Scan all channels so we find strongest
-                                               // (default in Wifi library is first match)
 #ifdef SERIAL_BT_COMMANDS
     WiFi.setSleep(true);
 #else
@@ -185,9 +152,7 @@ bool WifiESP::setup(const char *SSid,
       delay(500);
     }
     if (WiFi.status() == WL_CONNECTED) {
-      // DIAG(F("Wifi STA IP %s"),WiFi.localIP().toString().c_str());
-      DIAG(F("Wifi in STA mode"));
-      LCD(7, F("IP: %s"), WiFi.localIP().toString().c_str());
+      DIAG(F("Wifi STA IP %s"),WiFi.localIP().toString().c_str());
       wifiUp = true;
     } else {
       DIAG(F("Could not connect to Wifi SSID %s"),SSid);
@@ -209,20 +174,16 @@ bool WifiESP::setup(const char *SSid,
       }
     }
   }
-  if (!haveSSID || forceAP) {
+  if (!haveSSID) {
     // prepare all strings
-    String strSSID(forceAP ? SSid : "DCCEX_");
-    String strPass( (forceAP && havePassword) ? password : "PASS_");
-    if (!forceAP) {
-      String strMac = WiFi.macAddress();
-      strMac.remove(0,9);
-      strMac.replace(":","");
-      strMac.replace(":","");
-      // convert mac addr hex chars to lower case to be compatible with AT software
-      std::transform(strMac.begin(), strMac.end(), strMac.begin(), asciitolower);
-      strSSID.concat(strMac);
-      strPass.concat(strMac);
-    }
+    String strSSID("DCC_");
+    String strPass("PASS_");
+    String strMac = WiFi.macAddress();
+    strMac.remove(0,9);
+    strMac.replace(":","");
+    strMac.replace(":","");
+    strSSID.concat(strMac);
+    strPass.concat(strMac);
 
     WiFi.mode(WIFI_AP);
 #ifdef SERIAL_BT_COMMANDS
@@ -233,13 +194,8 @@ bool WifiESP::setup(const char *SSid,
     if (WiFi.softAP(strSSID.c_str(),
 		    havePassword ? password : strPass.c_str(),
 		    channel, false, 8)) {
-      // DIAG(F("Wifi AP SSID %s PASS %s"),strSSID.c_str(),havePassword ? password : strPass.c_str());
-      DIAG(F("Wifi in AP mode"));
-      LCD(5, F("Wifi: %s"), strSSID.c_str());
-      if (!havePassword)
-	LCD(6, F("PASS: %s"),strPass.c_str());
-      // DIAG(F("Wifi AP IP %s"),WiFi.softAPIP().toString().c_str());
-      LCD(7, F("IP: %s"),WiFi.softAPIP().toString().c_str());
+      DIAG(F("Wifi AP SSID %s PASS %s"),strSSID.c_str(),havePassword ? password : strPass.c_str());
+      DIAG(F("Wifi AP IP %s"),WiFi.softAPIP().toString().c_str());
       wifiUp = true;
       APmode = true;
     } else {
@@ -253,15 +209,6 @@ bool WifiESP::setup(const char *SSid,
     // no idea to go on
     return false;
   }
-
-  // Now Wifi is up, register the mDNS service
-  if(!MDNS.begin(hostname)) {
-    DIAG(F("Wifi setup failed to start mDNS"));
-  }
-  if(!MDNS.addService("withrottle", "tcp", 2560)) {
-    DIAG(F("Wifi setup failed to add withrottle service to mDNS"));
-  }
-
   server = new WiFiServer(port); // start listening on tcp port
   server->begin();
   // server started here
@@ -305,26 +252,37 @@ void WifiESP::loop() {
   // really no good way to check for LISTEN especially in AP mode?
   wl_status_t wlStatus;
   if (APmode || (wlStatus = WiFi.status()) == WL_CONNECTED) {
+    // loop over all clients and remove inactive
+    for (clientId=0; clientId<clients.size(); clientId++){
+      // check if client is there and alive
+      if(clients[clientId].inUse && !clients[clientId].wifi.connected()) {
+	DIAG(F("Remove client %d"), clientId);
+	CommandDistributor::forget(clientId);
+	clients[clientId].wifi.stop();
+	clients[clientId].inUse = false;
+	//Do NOT clients.erase(clients.begin()+clientId) as
+	//that would mix up clientIds for later.
+      }
+    }
     if (server->hasClient()) {
       WiFiClient client;
       while (client = server->available()) {
 	for (clientId=0; clientId<clients.size(); clientId++){
 	  if (clients[clientId].recycle(client)) {
-	    DIAG(F("Recycle client %d %s:%d"), clientId, client.remoteIP().toString().c_str(),client.remotePort());
+	    DIAG(F("Recycle client %d %s"), clientId, client.remoteIP().toString().c_str());
 	    break;
 	  }
 	}
 	if (clientId>=clients.size()) {
 	  NetworkClient nc(client);
 	  clients.push_back(nc);
-	  DIAG(F("New client %d, %s:%d"), clientId, client.remoteIP().toString().c_str(),client.remotePort());
+	  DIAG(F("New client %d, %s"), clientId, client.remoteIP().toString().c_str());
 	}
       }
     }
     // loop over all connected clients
-    // this removes as a side effect inactive clients when checking ::active()
     for (clientId=0; clientId<clients.size(); clientId++){
-      if(clients[clientId].active(clientId)) {
+      if(clients[clientId].ok()) {
 	int len;
 	if ((len = clients[clientId].wifi.available()) > 0) {
 	  // read data from client
@@ -362,7 +320,7 @@ void WifiESP::loop() {
 	}
 	// buffer filled, end with '\0' so we can use it as C string
 	buffer[count]='\0';
-	if((unsigned int)clientId <= clients.size() && clients[clientId].active(clientId)) {
+	if((unsigned int)clientId <= clients.size() && clients[clientId].ok()) {
 	  if (Diag::CMD || Diag::WITHROTTLE)
 	    DIAG(F("SEND %d:%s"), clientId, buffer);
 	  clients[clientId].wifi.write(buffer,count);
@@ -395,9 +353,8 @@ void WifiESP::loop() {
   // prio task. On core1 this is not a problem
   // as there the wdt is disabled by the
   // arduio IDE startup routines.
-  if (xPortGetCoreID() == 0) {
+  if (xPortGetCoreID() == 0)
     feedTheDog0();
-    yield();
-  }
+  yield();
 }
 #endif //ESP32

WifiESP32.h

@@ -1,6 +1,5 @@
 /*
- *  © 2021 Harald Barth
- *  © 2023 Nathan Kellenicki
+ *  © 2021, Harald Barth.
  *
  *  This file is part of CommandStation-EX
  *
@@ -32,8 +31,7 @@ public:
 		    const char *wifiPassword,
 		    const char *hostname,
 		    const int port,
-		    const byte channel,
-			const bool forceAP);
+		    const byte channel);
   static void loop();
 private:
 };

WifiInterface.cpp

@@ -2,7 +2,6 @@
  *  © 2021 Fred Decker
  *  © 2020-2022 Harald Barth
  *  © 2020-2022 Chris Harlow
- *  © 2023 Nathan Kellenicki
  *  All rights reserved.
  *
  *  This file is part of CommandStation-EX
@@ -53,34 +52,10 @@ Stream * WifiInterface::wifiStream;
  
 #if (defined(ARDUINO_AVR_MEGA) || defined(ARDUINO_AVR_MEGA2560))
 #define NUM_SERIAL 3
-#define SERIAL1 Serial1
-#define SERIAL3 Serial3
-#endif
-
-#if defined(ARDUINO_ARCH_STM32)
-// Handle serial ports availability on STM32 for variants!
-// #undef NUM_SERIAL
-#if defined(ARDUINO_NUCLEO_F401RE) || defined(ARDUINO_NUCLEO_F411RE)
-#define NUM_SERIAL 3
-#define SERIAL1 Serial1
-#define SERIAL3 Serial6
-#elif defined(ARDUINO_NUCLEO_F446RE)
-#define NUM_SERIAL 3
-#define SERIAL1 Serial3
-#define SERIAL3 Serial5
-#elif defined(ARDUINO_NUCLEO_F413ZH) || defined(ARDUINO_NUCLEO_F429ZI) \
-    || defined(ARDUINO_NUCLEO_F446ZE) || defined(ARDUINO_NUCLEO_F412ZG) \
-    || defined(ARDUINO_NUCLEO_F439ZI)
-#define NUM_SERIAL 2
-#define SERIAL1 Serial6
-#else
-#warning This variant of Nucleo not yet explicitly supported
-#endif
 #endif
 
 #ifndef NUM_SERIAL
 #define NUM_SERIAL 1
-#define SERIAL1 Serial1
 #endif
 
 bool WifiInterface::setup(long serial_link_speed, 
@@ -88,8 +63,7 @@ bool WifiInterface::setup(long serial_link_speed,
                           const FSH *wifiPassword,
                           const FSH *hostname,
                           const int port,
-                          const byte channel,
-                          const bool forceAP) {
+                          const byte channel) {
 
   wifiSerialState wifiUp = WIFI_NOAT;
 
@@ -101,34 +75,27 @@ bool WifiInterface::setup(long serial_link_speed,
   (void) hostname;
   (void) port;
   (void) channel;
-  (void) forceAP;
 #endif  
-
-// See if the WiFi is attached to the first serial port
+  
 #if NUM_SERIAL > 0 && !defined(SERIAL1_COMMANDS)
-  SERIAL1.begin(serial_link_speed);
-  wifiUp = setup(SERIAL1, wifiESSID, wifiPassword, hostname, port, channel, forceAP);
+  Serial1.begin(serial_link_speed);
+  wifiUp = setup(Serial1, wifiESSID, wifiPassword, hostname, port, channel);
 #endif
 
 // Other serials are tried, depending on hardware.
-// Currently only the Arduino Mega 2560 has usable Serial2 (Nucleo-64 boards use Serial 2 for console!)
-#if defined(ARDUINO_AVR_MEGA2560)
 #if NUM_SERIAL > 1 && !defined(SERIAL2_COMMANDS)
   if (wifiUp == WIFI_NOAT)
   {
     Serial2.begin(serial_link_speed);
-    wifiUp = setup(Serial2, wifiESSID, wifiPassword, hostname, port, channel, forceAP);
+    wifiUp = setup(Serial2, wifiESSID, wifiPassword, hostname, port, channel);
   }
 #endif
-#endif
-
-// We guess here that in all architctures that have a Serial3
-// we can use it for our purpose.
+  
 #if NUM_SERIAL > 2 && !defined(SERIAL3_COMMANDS)
   if (wifiUp == WIFI_NOAT)
   {
-    SERIAL3.begin(serial_link_speed);
-    wifiUp = setup(SERIAL3, wifiESSID, wifiPassword, hostname, port, channel, forceAP);
+    Serial3.begin(serial_link_speed);
+    wifiUp = setup(Serial3, wifiESSID, wifiPassword, hostname, port, channel);
   }
 #endif
 
@@ -146,7 +113,7 @@ bool WifiInterface::setup(long serial_link_speed,
 }
 
 wifiSerialState WifiInterface::setup(Stream & setupStream,  const FSH* SSid, const FSH* password,
-				     const FSH* hostname,  int port, byte channel, bool forceAP) {
+				     const FSH* hostname,  int port, byte channel) {
   wifiSerialState wifiState;
   static uint8_t ntry = 0;
   ntry++;
@@ -155,21 +122,20 @@ wifiSerialState WifiInterface::setup(Stream & setupStream,  const FSH* SSid, con
 
   DIAG(F("++ Wifi Setup Try %d ++"), ntry);
 
-  wifiState = setup2( SSid, password, hostname,  port, channel, forceAP);
+  wifiState = setup2( SSid, password, hostname,  port, channel);
 
   if (wifiState == WIFI_NOAT) {
-    LCD(4, F("WiFi no AT chip"));
-    return wifiState;
+      DIAG(F("++ Wifi Setup NO AT ++"));
+      return wifiState;
   }
  
   if (wifiState == WIFI_CONNECTED) {
     StringFormatter::send(wifiStream, F("ATE0\r\n")); // turn off the echo 
-    checkForOK(200, true);
-    DIAG(F("WiFi CONNECTED"));
-    // LCD already shows IP
-  } else {
-    LCD(4,F("WiFi DISCON."));
+    checkForOK(200, true);      
   }
+
+    
+  DIAG(F("++ Wifi Setup %S ++"), wifiState == WIFI_CONNECTED ? F("CONNECTED") : F("DISCONNECTED"));
   return wifiState;
 }
 
@@ -179,7 +145,7 @@ wifiSerialState WifiInterface::setup(Stream & setupStream,  const FSH* SSid, con
 #pragma GCC diagnostic ignored "-Wunused-parameter"
 #endif
 wifiSerialState WifiInterface::setup2(const FSH* SSid, const FSH* password,
-				      const FSH* hostname, int port, byte channel, bool forceAP) {
+				      const FSH* hostname, int port, byte channel) {
   bool ipOK = false;
   bool oldCmd = false;
 
@@ -202,23 +168,7 @@ wifiSerialState WifiInterface::setup2(const FSH* SSid, const FSH* password,
 
   // Display the AT version information
   StringFormatter::send(wifiStream, F("AT+GMR\r\n")); 
-  if (checkForOK(2000, F("AT version:"), true, false)) {
-    char version[] = "0.0.0.0-xxx";
-    for (int i=0; i<11;i++) {
-      while(!wifiStream->available());
-      version[i]=wifiStream->read();
-      StringFormatter::printEscape(version[i]);
-    }
-    if ((version[0] == '0') ||
-	(version[0] == '2' && version[2] == '0') ||
-	(version[0] == '2' && version[2] == '2' && version[4] == '0' && version[6] == '0'
-	 && version[7] == '-' && version[8] == 'd' && version[9] == 'e' && version[10] == 'v')) {
-      DIAG(F("You need to up/downgrade the ESP firmware"));
-      SSid = F("UPDATE_ESP_FIRMWARE");
-      forceAP = true;
-    }
-  }
-  checkForOK(2000, true, false);
+  checkForOK(2000, true, false);      // Makes this visible on the console
 
 #ifdef DONT_TOUCH_WIFI_CONF
   DIAG(F("DONT_TOUCH_WIFI_CONF was set: Using existing config"));
@@ -234,8 +184,8 @@ wifiSerialState WifiInterface::setup2(const FSH* SSid, const FSH* password,
   checkForOK(1000, true);                       // Not always OK, sometimes "no change"
 
   const char *yourNetwork = "Your network ";
-  if (STRNCMP_P(yourNetwork, (const char*)SSid, 13) == 0 || STRNCMP_P("", (const char*)SSid, 13) == 0) {
-    if (STRNCMP_P(yourNetwork, (const char*)password, 13) == 0) {
+  if (strncmp_P(yourNetwork, (const char*)SSid, 13) == 0 || strncmp_P("", (const char*)SSid, 13) == 0) {
+    if (strncmp_P(yourNetwork, (const char*)password, 13) == 0) {
       // If the source code looks unconfigured, check if the
       // ESP8266 is preconfigured in station mode.
       // We check the first 13 chars of the SSid and the password
@@ -248,7 +198,7 @@ wifiSerialState WifiInterface::setup2(const FSH* SSid, const FSH* password,
 	  if (!checkForOK(1000, F("0.0.0.0"), true,false))
 	      ipOK = true;
     }
-  } else if (!forceAP) {
+  } else {
       // SSID was configured, so we assume station (client) mode.
       if (oldCmd) {
 	      // AT command early version supports CWJAP/CWSAP
@@ -308,19 +258,14 @@ wifiSerialState WifiInterface::setup2(const FSH* SSid, const FSH* password,
   
     i=0;
     do {
-      if (!forceAP) {
-        if (STRNCMP_P(yourNetwork, (const char*)password, 13) == 0) {
-    // unconfigured
-          StringFormatter::send(wifiStream, F("AT+CWSAP%s=\"DCCEX_%s\",\"PASS_%s\",%d,4\r\n"),
-                                            oldCmd ? "" : "_CUR", macTail, macTail, channel);
-        } else {
-          // password configured by user
-          StringFormatter::send(wifiStream, F("AT+CWSAP%s=\"DCCEX_%s\",\"%S\",%d,4\r\n"), oldCmd ? "" : "_CUR",
-                                          macTail, password, channel);
-        }
+      if (strncmp_P(yourNetwork, (const char*)password, 13) == 0) {
+	// unconfigured
+        StringFormatter::send(wifiStream, F("AT+CWSAP%s=\"DCCEX_%s\",\"PASS_%s\",%d,4\r\n"),
+                                          oldCmd ? "" : "_CUR", macTail, macTail, channel);
       } else {
-        StringFormatter::send(wifiStream, F("AT+CWSAP%s=\"%S\",\"%S\",%d,4\r\n"),
-                                        oldCmd ? "" : "_CUR", SSid, password, channel);
+        // password configured by user
+       StringFormatter::send(wifiStream, F("AT+CWSAP%s=\"DCCEX_%s\",\"%S\",%d,4\r\n"), oldCmd ? "" : "_CUR",
+	                                       macTail, password, channel);
       }
     } while (!checkForOK(WIFI_CONNECT_TIMEOUT, true) && i++<2); // do twice if necessary but ignore failure as AP mode may still be ok
     if (i >= 2)

WifiInterface.h

@@ -1,7 +1,6 @@
 /*
  *  © 2020-2021 Chris Harlow
  *  © 2020, Harald Barth.
- *  © 2023 Nathan Kellenicki
  *  All rights reserved.
  *
  *  This file is part of CommandStation-EX
@@ -37,18 +36,17 @@ public:
                           const FSH *wifiPassword,
                           const FSH *hostname,
                           const int port,
-                          const byte channel,
-                          const bool forceAP);
+                          const byte channel);
   static void loop();
   static void ATCommand(HardwareSerial * stream,const byte *command);
   
 private:
   static wifiSerialState setup(Stream &setupStream, const FSH *SSSid, const FSH *password,
-                    const FSH *hostname, int port, byte channel, bool forceAP);
+                    const FSH *hostname, int port, byte channel);
   static Stream *wifiStream;
   static DCCEXParser parser;
   static wifiSerialState setup2(const FSH *SSSid, const FSH *password,
-                     const FSH *hostname, int port, byte channel, bool forceAP);
+                     const FSH *hostname, int port, byte channel);
   static bool checkForOK(const unsigned int timeout, bool echo, bool escapeEcho = true);
   static bool checkForOK(const unsigned int timeout, const FSH *waitfor, bool echo, bool escapeEcho = true);
   static bool connected;