Merge branch 'devel_fozzie2' of https://github.com/DCC-EX/CommandStation-EX into devel_fozzie2

commit 4e57a80265.

CommandDistributor.cpp

@@ -248,6 +248,10 @@ void  CommandDistributor::broadcastLoco(byte slot) {
 #endif
 }
 
+void  CommandDistributor::broadcastForgetLoco(int16_t loco) {
+  broadcastReply(COMMAND_TYPE, F("<l %d 0 1 0>\n<- %d>\n"), loco,loco);
+}
+
 void  CommandDistributor::broadcastPower() {
   char pstr[] = "? x";
   for(byte t=0; t<TrackManager::MAX_TRACKS; t++)

CommandDistributor.h

@@ -47,6 +47,7 @@ private:
 public :
   static void parse(byte clientId,byte* buffer, RingStream * ring);
   static void broadcastLoco(byte slot);
+  static void broadcastForgetLoco(int16_t loco);
   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);

CommandStation-EX.ino

@@ -141,44 +141,73 @@ void setup()
   CommandDistributor::broadcastPower();
 }
 
+void looptimer(unsigned long timeout, const FSH* message)
+{
+  static unsigned long lasttimestamp = 0;
+  unsigned long now = micros();
+  if (timeout != 0) {
+    unsigned long diff = now - lasttimestamp;
+    if (diff > timeout) {
+      DIAG(message);
+      DIAG(F("DeltaT=%L"), diff);
+      lasttimestamp = micros();
+      return;
+    }
+  }
+  lasttimestamp = now;
+}
+
 void loop()
 {
   // The main sketch has responsibilities during loop()
 
   // Responsibility 1: Handle DCC background processes
   //                   (loco reminders and power checks)
+  looptimer(0, F(""));
   DCC::loop();
+  looptimer(5000, F("DCC")); // got warnings up to 3884 during prog track read
 
   // Responsibility 2: handle any incoming commands on USB connection
   SerialManager::loop();
+  looptimer(2000, F("Serial")); // got warnings up to 1900 during start
 
   // Responsibility 3: Optionally handle any incoming WiFi traffic
 #ifndef ARDUINO_ARCH_ESP32
 #if WIFI_ON
   WifiInterface::loop();
+  looptimer(9000, F("Wifi")); // got warnings up to 8000
+
 #endif //WIFI_ON
 #else  //ARDUINO_ARCH_ESP32
 #ifndef WIFI_TASK_ON_CORE0
   WifiESP::loop();
+  looptimer(1000, F("WifiESP"));
+
 #endif
 #endif //ARDUINO_ARCH_ESP32
 #if ETHERNET_ON
   EthernetInterface::loop();
+  looptimer(10000, F("Ethernet"));
 #endif
 
   RMFT::loop();  // ignored if no automation
+  looptimer(1000, F("RMFT"));
 
   #if defined(LCN_SERIAL)
   LCN::loop();
+  looptimer(1000, F("LCN"));
   #endif
 
   // Display refresh
   DisplayInterface::loop();
+  looptimer(2000, F("Display")); // got warnings around 1150
 
   // Handle/update IO devices.
   IODevice::loop();
+  looptimer(1000, F("IODevice"));
 
   Sensor::checkAll(); // Update and print changes
+  looptimer(1000, F("Sensor"));
 
   // Report any decrease in memory (will automatically trigger on first call)
   static int ramLowWatermark = __INT_MAX__; // replaced on first loop

DCC.cpp

@@ -271,6 +271,20 @@ uint32_t DCC::getFunctionMap(int cab) {
   return (reg<0)?0:speedTable[reg].functions;
 }
 
+// saves DC frequency (0..3) in spare functions 29,30,31
+void DCC::setDCFreq(int cab,byte freq) {
+  if (cab==0 || freq>3) return;
+  auto reg=lookupSpeedTable(cab,true);
+  // drop and replace F29,30,31 (top 3 bits) 
+  auto newFunctions=speedTable[reg].functions & 0x1FFFFFFFUL;
+  if (freq==1)      newFunctions |= (1UL<<29); // F29
+  else if (freq==2) newFunctions |= (1UL<<30); // F30
+  else if (freq==3) newFunctions |= (1UL<<31); // F31
+  if (newFunctions==speedTable[reg].functions) return; // no change 
+  speedTable[reg].functions=newFunctions;
+  CommandDistributor::broadcastLoco(reg);
+}
+
 void DCC::setAccessory(int address, byte port, bool gate, byte onoff /*= 2*/) {
   // onoff is tristate:
   // 0  => send off packet
@@ -728,11 +742,15 @@ void DCC::forgetLoco(int cab) {  // removes any speed reminders for this loco
   if (reg>=0) {
     speedTable[reg].loco=0;
     setThrottle2(cab,1); // ESTOP if this loco still on track
+    CommandDistributor::broadcastForgetLoco(cab);
   }
 }
 void DCC::forgetAllLocos() {  // removes all speed reminders
   setThrottle2(0,1); // ESTOP all locos still on track
-  for (int i=0;i<MAX_LOCOS;i++) speedTable[i].loco=0;
+  for (int i=0;i<MAX_LOCOS;i++) {
+    if (speedTable[i].loco) CommandDistributor::broadcastForgetLoco(speedTable[i].loco);
+    speedTable[i].loco=0;
+  }
 }
 
 byte DCC::loopStatus=0;

DCC.h

@@ -70,6 +70,7 @@ public:
   static void changeFn(int cab, int16_t functionNumber);
   static int8_t getFn(int cab, int16_t functionNumber);
   static uint32_t getFunctionMap(int cab);
+  static void setDCFreq(int cab,byte freq);
   static void updateGroupflags(byte &flags, int16_t functionNumber);
   static void setAccessory(int address, byte port, bool gate, byte onoff = 2);
   static bool setExtendedAccessory(int16_t address, int16_t value, byte repeats=3);

DCCEXParser.cpp

@@ -2,7 +2,7 @@
  *  © 2022 Paul M Antoine
  *  © 2021 Neil McKechnie
  *  © 2021 Mike S
- *  © 2021 Herb Morton
+ *  © 2021-2024 Herb Morton
  *  © 2020-2023 Harald Barth
  *  © 2020-2021 M Steve Todd
  *  © 2020-2021 Fred Decker
@@ -563,6 +563,7 @@ void DCCEXParser::parseOne(Print *stream, byte *com, RingStream * ringStream)
 	    }
 #ifndef DISABLE_PROG
             else if (p[0]=="PROG"_hk) { // <0 PROG>
+          TrackManager::setJoin(false);
 	      TrackManager::progTrackBoosted=false;  // Prog track boost mode will not outlive prog track off
 	      TrackManager::setTrackPower(TRACK_MODE_PROG, POWERMODE::OFF);
             }
@@ -641,6 +642,13 @@ void DCCEXParser::parseOne(Print *stream, byte *com, RingStream * ringStream)
 
     case 'F': // New command to call the new Loco Function API <F cab func 1|0>
         if(params!=3) break; 
+        
+        if (p[1]=="DCFREQ"_hk) { // <F cab DCFREQ 0..3>
+          if (p[2]<0 || p[2]>3) break;
+          DCC::setDCFreq(p[0],p[2]);
+          return;    
+        }
+
         if (Diag::CMD)
             DIAG(F("Setting loco %d F%d %S"), p[0], p[1], p[2] ? F("ON") : F("OFF"));
         if (DCC::setFn(p[0], p[1], p[2] == 1)) return;

EXRAIL2.cpp

@@ -628,14 +628,16 @@ void RMFT2::loop2() {
     skipIf=blinkState!=at_timeout;
     break;
     
-  case OPCODE_AFTER: // waits for sensor to hit and then remain off for 0.5 seconds. (must come after an AT operation)
+  case OPCODE_AFTER: // waits for sensor to hit and then remain off for x mS. 
+    // Note, this must come after an AT operation, which is 
+    // automatically inserted by the AFTER macro. 
     if (readSensor(operand)) {
-      // reset timer to half a second and keep waiting
+      // reset timer and keep waiting
       waitAfter=millis();
       delayMe(50);
       return;
     }
-    if (millis()-waitAfter < 500 ) return;
+    if (millis()-waitAfter < getOperand(1) ) return;
     break;
 
   case OPCODE_AFTEROVERLOAD: // waits for the power to be turned back on - either by power routine or button
@@ -716,41 +718,7 @@ void RMFT2::loop2() {
 
   case OPCODE_SETFREQ:
       // Frequency is default 0, or 1, 2,3
-      //if (loco) DCC::setFn(loco,operand,true);
-      switch (operand) {
-        case 0:  // default - all F-s off
-            if (loco) {
-                DCC::setFn(loco,29,false);
-                DCC::setFn(loco,30,false);
-                DCC::setFn(loco,31,false);
-            }
-        break;
-        case 1:
-            if (loco) {
-	      DCC::setFn(loco,29,true);
-              DCC::setFn(loco,30,false);
-              DCC::setFn(loco,31,false);
-            }
-        break;
-        case 2:
-            if (loco) {
-	      DCC::setFn(loco,29,false);
-              DCC::setFn(loco,30,true);
-              DCC::setFn(loco,31,false);
-            }
-        break;
-        case 3:
-            if (loco) {
-	      DCC::setFn(loco,29,false);
-              DCC::setFn(loco,30,false);
-              DCC::setFn(loco,31,true);
-            }
-        break;
-      default:
-	; // do nothing
-	break;
-      }
-
+      DCC::setDCFreq(loco,operand);
       break;
 
   case OPCODE_RESUME:

EXRAIL2MacroReset.h

@@ -195,7 +195,7 @@
 #ifndef RMFT2_UNDEF_ONLY
 #define ACTIVATE(addr,subaddr)
 #define ACTIVATEL(addr)
-#define AFTER(sensor_id)
+#define AFTER(sensor_id,timer...)
 #define AFTEROVERLOAD(track_id)
 #define ALIAS(name,value...)
 #define AMBER(signal_id)
@@ -334,7 +334,7 @@
 #define SET_TRACK(track,mode)
 #define SET_POWER(track,onoff)
 #define SETLOCO(loco) 
-#define SETFREQ(loco,freq)
+#define SETFREQ(freq)
 #define SIGNAL(redpin,amberpin,greenpin) 
 #define SIGNALH(redpin,amberpin,greenpin) 
 #define SPEED(speed) 

EXRAILMacros.h

@@ -463,7 +463,7 @@ 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 AFTER(sensor_id,timer...) OPCODE_AT,V(sensor_id),OPCODE_AFTER,V(sensor_id),OPCODE_PAD,V(#timer[0]?timer+0:500),
 #define AFTEROVERLOAD(track_id) OPCODE_AFTEROVERLOAD,V(TRACK_NUMBER_##track_id),
 #define ALIAS(name,value...) 
 #define AMBER(signal_id) OPCODE_AMBER,V(signal_id),
@@ -620,7 +620,7 @@ int RMFT2::onLCCLookup[RMFT2::countLCCLookup];
 #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 SETFREQ(loco,freq) OPCODE_SETLOCO,V(loco), OPCODE_SETFREQ,V(freq),
+#define SETFREQ(freq) OPCODE_SETFREQ,V(freq),
 #define SIGNAL(redpin,amberpin,greenpin) 
 #define SIGNALH(redpin,amberpin,greenpin) 
 #define SPEED(speed) OPCODE_SPEED,V(speed),

EthernetInterface.cpp

@@ -29,77 +29,98 @@
 #include "CommandDistributor.h"
 #include "WiThrottle.h"
 #include "DCCTimer.h"
+#if __has_include ( "MDNS_Generic.h")
+  #include "MDNS_Generic.h"
+  #define DO_MDNS 
+  EthernetUDP udp;
+  MDNS mdns(udp);
+#endif
+
+
+extern void looptimer(unsigned long timeout, const FSH* message);
+
+bool EthernetInterface::connected=false;
+EthernetServer * EthernetInterface::server= nullptr;
+EthernetClient EthernetInterface::clients[MAX_SOCK_NUM];                // accept up to MAX_SOCK_NUM client connections at the same time; This depends on the chipset used on the Shield
+uint8_t EthernetInterface::buffer[MAX_ETH_BUFFER+1];                    // buffer used by TCP for the recv
+RingStream * EthernetInterface::outboundRing = nullptr;
 
-EthernetInterface * EthernetInterface::singleton=NULL;
 /**
  * @brief Setup Ethernet Connection
  * 
  */
-void EthernetInterface::setup()
+
+void EthernetInterface::setup()  // STM32 VERSION
 {
-  if (singleton!=NULL) {
-    DIAG(F("Prog Error!"));
-    return;
-  }
-  if ((singleton=new EthernetInterface()))
-    return;
-  DIAG(F("Ethernet not initialized"));
-};
-
-
-#ifdef IP_ADDRESS
-static IPAddress myIP(IP_ADDRESS);
+  DIAG(F("Ethernet begin"
+  #ifdef DO_MDNS
+    " with mDNS"
+  #endif 
+  ));
+  
+  #ifdef STM32_ETHERNET
+    // Set a HOSTNAME for the DHCP request - a nice to have, but hard it seems on LWIP for STM32
+    // The default is "lwip", which is **always** set in STM32Ethernet/src/utility/ethernetif.cpp
+    // for some reason. One can edit it to instead read:
+    //      #if LWIP_NETIF_HOSTNAME
+    //      /* Initialize interface hostname */
+    //      if (netif->hostname == NULL)
+    //         netif->hostname = "lwip";
+    //      #endif /* LWIP_NETIF_HOSTNAME */
+    // Which seems more useful! We should propose the patch... so the following line actually works!
+    netif_set_hostname(&gnetif, WIFI_HOSTNAME);   // Should probably be passed in the contructor...
 #endif
 
-/**
- * @brief Aquire IP Address from DHCP and start server
- * 
- * @return true 
- * @return false 
- */
-EthernetInterface::EthernetInterface()
-{
     byte mac[6];
     DCCTimer::getSimulatedMacAddress(mac);
-    connected=false;
-   
-#ifdef IP_ADDRESS
-    Ethernet.begin(mac, myIP);
-#else
-    if (Ethernet.begin(mac) == 0)
-    {
-        DIAG(F("Ethernet.begin FAILED"));
-        return;
-    } 
-#endif
-    if (Ethernet.hardwareStatus() == EthernetNoHardware) {
-      DIAG(F("Ethernet shield not found or W5100"));
-    }
+    #define _MAC_ mac
   
-    unsigned long startmilli = millis();
-    while ((millis() - startmilli) < 5500) { // Loop to give time to check for cable connection
-        if (Ethernet.linkStatus() == LinkON)
-            break;
-        DIAG(F("Ethernet waiting for link (1sec) "));
-        delay(1000);
-    }
-    // now we either do have link of we have a W5100
-    // where we do not know if we have link. That's
-    // the reason to now run checkLink.
-    // CheckLinks sets up outboundRing if it does
-    // not exist yet as well.
-    checkLink();
+  #ifdef IP_ADDRESS
+    static IPAddress myIP(IP_ADDRESS);
+    Ethernet.begin(_MAC_,myIP);
+    setup(false);
+  #else
+    if (Ethernet.begin(_MAC_)==0)
+  {
+    LCD(4,F("IP: No DHCP"));
+    return;
+  }
+  #endif
+
+  auto ip = Ethernet.localIP();    // look what IP was obtained (dynamic or static)
+  if (!ip) {
+    LCD(4,F("IP: None"));
+    return;
+  }
+  server = new EthernetServer(IP_PORT); // Ethernet Server listening on default port IP_PORT
+  server->begin();
+
+  // Arrange display of IP address and port
+  #ifdef LCD_DRIVER
+    const byte lcdData[]={LCD_DRIVER};
+    const bool wideDisplay=lcdData[1]>=24; // data[1] is cols. 
+  #else 
+    const bool wideDisplay=true;
+  #endif    
+  if (wideDisplay) {
+    // OLEDS or just usb diag is ok on one line. 
+    LCD(4,F("IP %d.%d.%d.%d:%d"), ip[0], ip[1], ip[2], ip[3], IP_PORT);    
+  } 
+  else { // LCDs generally too narrow, so take 2 lines
+    LCD(4,F("IP %d.%d.%d.%d"), ip[0], ip[1], ip[2], ip[3]);
+    LCD(5,F("Port %d"), IP_PORT);
+  }
+ 
+  outboundRing=new RingStream(OUTBOUND_RING_SIZE);
+  #ifdef DO_MDNS
+    mdns.begin(Ethernet.localIP(), WIFI_HOSTNAME); // hostname
+    mdns.addServiceRecord(WIFI_HOSTNAME "._withrottle", IP_PORT, MDNSServiceTCP);
+  // Not sure if we need to run it once, but just in case!
+    mdns.run();
+  #endif  
+  connected=true;    
 }
 
-/**
- * @brief Cleanup any resources
- * 
- * @return none
- */
-EthernetInterface::~EthernetInterface() {
-  delete server;
-  delete outboundRing;
-}
 
 /**
  * @brief Main loop for the EthernetInterface
@@ -107,134 +128,138 @@ EthernetInterface::~EthernetInterface() {
  */
 void EthernetInterface::loop()
 {
-    if (!singleton || (!singleton->checkLink()))
-      return;
+    if (!connected) return;
+    looptimer(5000, F("E.loop"));
+	      
+    static bool warnedAboutLink=false;
+    if (Ethernet.linkStatus() == LinkOFF){
+        if (warnedAboutLink) return;
+        DIAG(F("Ethernet link OFF"));
+        warnedAboutLink=true;
+        return;
+    }
+    looptimer(5000, F("E.loop warn"));
+	  
+    // link status must be ok here 
+    if (warnedAboutLink) {
+      DIAG(F("Ethernet link RESTORED"));
+      warnedAboutLink=false;
+    } 
     
+  #ifdef DO_MDNS
+    // Always do this because we don't want traffic to intefere with being found!
+    mdns.run();
+    looptimer(5000, F("E.mdns"));
+	  
+  #endif
+
+    //
     switch (Ethernet.maintain()) {
     case 1:
         //renewed fail
         DIAG(F("Ethernet Error: renewed fail"));
-        singleton=NULL;
+        connected=false;
         return;
     case 3:
         //rebind fail
         DIAG(F("Ethernet Error: rebind fail"));
-        singleton=NULL;
+        connected=false;
         return;
     default:
         //nothing happened
+        //DIAG(F("maintained"));
         break;
     }
-   singleton->loop2();
-}
-
-/**
- * @brief Checks ethernet link cable status and detects when it connects / disconnects
- * 
- * @return true when cable is connected, false otherwise
- */
-bool EthernetInterface::checkLink() {
-  if (Ethernet.linkStatus() != LinkOFF) { // check for not linkOFF instead of linkON as the W5100 does return LinkUnknown
-    //if we are not connected yet, setup a new server
-    if(!connected) {
-      DIAG(F("Ethernet cable connected"));
-      connected=true;
-      #ifdef IP_ADDRESS
-      Ethernet.setLocalIP(myIP);      // 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
-      server->begin();
-      LCD(4,F("IP: %d.%d.%d.%d"), ip[0], ip[1], ip[2], ip[3]);
-      LCD(5,F("Port:%d"), IP_PORT);
-      // only create a outboundRing it none exists, this may happen if the cable
-      // gets disconnected and connected again
-      if(!outboundRing)
-	outboundRing=new RingStream(OUTBOUND_RING_SIZE);
-    }
-    return true;
-  } else { // connected
-    DIAG(F("Ethernet cable disconnected"));
-    connected=false;
-    //clean up any client
-    for (byte socket = 0; socket < MAX_SOCK_NUM; socket++) {
-      if(clients[socket].connected())
-	clients[socket].stop();
-    }
-    // tear down server
-    delete server;
-    server = nullptr;
-    LCD(4,F("IP: None"));
-  }
-  return false;
-}
-
-void EthernetInterface::loop2() {
-    if (!outboundRing) { // no idea to call loop2() if we can't handle outgoing data in it
-      if (Diag::ETHERNET) DIAG(F("No outboundRing"));
-      return;
-    }
-    // get client from the server
-    EthernetClient client = server->accept();
-
-    // check for new client
-    if (client)
-    {
-        if (Diag::ETHERNET) DIAG(F("Ethernet: New client "));
-        byte socket;
+    looptimer(5000, F("E.maintain"));
+	  
+      // get client from the server
+  #if defined (STM32_ETHERNET)
+    // STM32Ethernet doesn't use accept(), just available()
+    auto client = server->available();
+    if (client) {
+      // check for new client
+      byte socket;
+      bool sockFound = false;
+      for (socket = 0; socket < MAX_SOCK_NUM; socket++)
+      {
+        if (client == clients[socket])
+        {
+          sockFound = true;
+          break;
+        }
+      }
+      if (!sockFound)
+      { // new client
         for (socket = 0; socket < MAX_SOCK_NUM; socket++)
         {
-            if (!clients[socket])
-            {
-                // On accept() the EthernetServer doesn't track the client anymore
-                // so we store it in our client array
-                if (Diag::ETHERNET) DIAG(F("Socket %d"),socket);
-                clients[socket] = client;
-                break;
-            }
+          if (!clients[socket])
+          {
+            clients[socket] = client;
+            sockFound=true;
+            if (Diag::ETHERNET)
+              DIAG(F("Ethernet: New client socket %d"), socket);
+            break;
+          }
         }
-        if (socket==MAX_SOCK_NUM) DIAG(F("new Ethernet OVERFLOW")); 
+      }
+      if (!sockFound) DIAG(F("new Ethernet OVERFLOW"));
     }
+  
+  #else
+    auto client = server->accept();
+    if (client) clients[client.getSocketNumber()]=client;
+  #endif
+    
 
     // check for incoming data from all possible clients
     for (byte socket = 0; socket < MAX_SOCK_NUM; socket++)
     {
-        if (clients[socket]) {
-        
-        int available=clients[socket].available();
-        if (available > 0) {
-            if (Diag::ETHERNET)  DIAG(F("Ethernet: available socket=%d,avail=%d"), socket, available);
-            // read bytes from a client
-            int count = clients[socket].read(buffer, MAX_ETH_BUFFER);
-            buffer[count] = '\0'; // terminate the string properly
-            if (Diag::ETHERNET) DIAG(F(",count=%d:%e"), socket,buffer);
-            // execute with data going directly back
-            CommandDistributor::parse(socket,buffer,outboundRing);
-            return; // limit the amount of processing that takes place within 1 loop() cycle. 
-          }
-        }
-    }
-
-    // stop any clients which disconnect
-   for (int socket = 0; socket<MAX_SOCK_NUM; socket++) {
-     if (clients[socket] && !clients[socket].connected()) {
-      clients[socket].stop();
-      CommandDistributor::forget(socket);          
-      if (Diag::ETHERNET)  DIAG(F("Ethernet: disconnect %d "), socket);             
-     }
-    }
-
+      if (!clients[socket]) continue; // socket is not in use
+	
+	    // read any bytes from this client
+	    auto count = clients[socket].read(buffer, MAX_ETH_BUFFER);
+      
+      if (count<0) continue;  // -1 indicates nothing to read
+	    
+      if (count > 0) {  // we have incoming data 
+	      buffer[count] = '\0'; // terminate the string properly
+	      if (Diag::ETHERNET) DIAG(F("Ethernet s=%d, c=%d b=:%e"), socket, count, buffer);
+	      // execute with data going directly back
+	      CommandDistributor::parse(socket,buffer,outboundRing);
+	      //looptimer(5000, F("Ethloop2 parse"));
+	      return; // limit the amount of processing that takes place within 1 loop() cycle. 
+	    }
+	    
+      // count=0 The client has disconnected
+	    clients[socket].stop();
+	    CommandDistributor::forget(socket);
+	    if (Diag::ETHERNET)  DIAG(F("Ethernet: disconnect %d "), socket);
+	  }
+	
     WiThrottle::loop(outboundRing);
-    
+
     // handle at most 1 outbound transmission 
-    int socketOut=outboundRing->read();
+    auto socketOut=outboundRing->read();
+    if (socketOut<0) return;  // no outbound pending
+
     if (socketOut >= MAX_SOCK_NUM) {
-      DIAG(F("Ethernet outboundRing socket=%d error"), socketOut);
-    } else if (socketOut >= 0) {
-      int count=outboundRing->count();
-      if (Diag::ETHERNET) DIAG(F("Ethernet reply socket=%d, count=:%d"), socketOut,count);
-      for(;count>0;count--)  clients[socketOut].write(outboundRing->read());
-      clients[socketOut].flush(); //maybe 
+      // This is a catastrophic code failure and unrecoverable.  
+      DIAG(F("Ethernet outboundRing s=%d error"), socketOut);
+      connected=false;
+      return;
+    } 
+
+    auto count=outboundRing->count();
+    {
+	    char tmpbuf[count+1]; // one extra for '\0'
+	    for(int i=0;i<count;i++) {
+	      tmpbuf[i] = outboundRing->read();
+	    }
+	    tmpbuf[count]=0;
+	    if (Diag::ETHERNET) DIAG(F("Ethernet reply s=%d, c=%d, b:%e"),
+                              socketOut,count,tmpbuf);
+	    clients[socketOut].write(tmpbuf,count);
     }
+    
 }
 #endif

EthernetInterface.h

@@ -35,6 +35,14 @@
 #if defined (ARDUINO_TEENSY41)
  #include <NativeEthernet.h>         //TEENSY Ethernet Treiber
  #include <NativeEthernetUdp.h>   
+#elif defined (ARDUINO_NUCLEO_F429ZI) || defined (ARDUINO_NUCLEO_F439ZI) || defined (ARDUINO_NUCLEO_F4X9ZI)
+ #include <LwIP.h>
+//  #include "STM32lwipopts.h"
+ #include <STM32Ethernet.h>
+ #include <lwip/netif.h>
+ extern "C" struct netif gnetif;
+ #define STM32_ETHERNET
+ #define MAX_SOCK_NUM 8
 #else
  #include "Ethernet.h"
 #endif
@@ -45,7 +53,7 @@
  * 
  */
 
-#define MAX_ETH_BUFFER 512
+#define MAX_ETH_BUFFER 128
 #define OUTBOUND_RING_SIZE 2048
 
 class EthernetInterface {
@@ -56,16 +64,11 @@ class EthernetInterface {
      static void loop();
    
  private:
-    static EthernetInterface * singleton;
-    bool connected;
-    EthernetInterface();
-    ~EthernetInterface();
-    void loop2();
-    bool checkLink();
-    EthernetServer * server = NULL;
-    EthernetClient clients[MAX_SOCK_NUM];                // accept up to MAX_SOCK_NUM client connections at the same time; This depends on the chipset used on the Shield
-    uint8_t buffer[MAX_ETH_BUFFER+1];                    // buffer used by TCP for the recv
-    RingStream * outboundRing = NULL;
+    static bool connected;
+    static EthernetServer * server;
+    static EthernetClient clients[MAX_SOCK_NUM];                // accept up to MAX_SOCK_NUM client connections at the same time; This depends on the chipset used on the Shield
+    static uint8_t buffer[MAX_ETH_BUFFER+1];                    // buffer used by TCP for the recv
+    static RingStream * outboundRing;
 };
 
 #endif

GITHUB_SHA.h

@@ -1 +1 @@
-#define GITHUB_SHA "devel-202406182019Z"
+#define GITHUB_SHA "devel-fozzie-202408172108Z"

IODevice.h

@@ -547,6 +547,6 @@ protected:
 #include "IO_duinoNodes.h"
 #include "IO_EXIOExpander.h"
 #include "IO_trainbrains.h"
-
+#include "IO_EncoderThrottle.h"
 
 #endif // iodevice_h

IO_EncoderThrottle.cpp

@@ -0,0 +1,144 @@
+/*
+ *  © 2024, Chris Harlow. All rights reserved.
+ *
+ *  This file is part of EX-CommandStation
+ *
+ *  This is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  It is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with CommandStation.  If not, see <https://www.gnu.org/licenses/>.
+*/
+
+/*
+* The IO_EncoderThrottle device driver uses a rotary encoder connected to vpins
+* to drive a loco.
+*  Loco id is selected by writeAnalog.
+*/
+
+#include "IODevice.h"
+#include "DIAG.h"
+#include "DCC.h"
+
+const byte _DIR_CW = 0x10;  // Clockwise step
+const byte _DIR_CCW = 0x20;  // Counter-clockwise step
+
+const byte transition_table[5][4]= {
+    {0,1,3,0},            // 0: 00
+    {1,1,1,2 | _DIR_CW},  // 1: 00->01
+    {2,2,0,2},            // 2: 00->01->11
+    {3,3,3,4 | _DIR_CCW}, // 3: 00->10
+    {4,0,4,4}             // 4: 00->10->11
+};
+
+const byte _STATE_MASK = 0x07;
+const byte _DIR_MASK = 0x30;
+
+
+
+  void EncoderThrottle::create(VPIN firstVpin, int dtPin, int clkPin, int clickPin, byte notch) {
+    if (checkNoOverlap(firstVpin)) new EncoderThrottle(firstVpin, dtPin,clkPin,clickPin,notch);
+  }
+
+
+  // Constructor
+  EncoderThrottle::EncoderThrottle(VPIN firstVpin, int dtPin, int clkPin, int clickPin, byte notch){
+    _firstVpin = firstVpin;
+    _nPins = 1;
+    _I2CAddress = 0;
+    _dtPin=dtPin;
+    _clkPin=clkPin;
+    _clickPin=clickPin;
+    _notch=notch;
+    _locoid=0;
+    _stopState=xrSTOP;
+    _rocoState=0; 
+    _prevpinstate=4; // not 01..11 
+    IODevice::configureInput(dtPin,true);
+    IODevice::configureInput(clkPin,true);
+    IODevice::configureInput(clickPin,true);
+    addDevice(this);
+    _display();
+  }
+
+  
+
+  void EncoderThrottle::_loop(unsigned long currentMicros)  {
+    if (_locoid==0) return;  // not in use
+    
+    // Clicking down on the roco, stops the loco and sets the direction as unknown.
+  if (IODevice::read(_clickPin)) {
+    if (_stopState==xrSTOP) return; // debounced multiple stops
+    DCC::setThrottle(_locoid,1,DCC::getThrottleDirection(_locoid));
+    _stopState=xrSTOP;
+    DIAG(F("DRIVE %d STOP"),_locoid);
+    return; 
+  }
+
+  // read roco pins and detect state change 
+  byte pinstate = (IODevice::read(_dtPin) << 1) | IODevice::read(_clkPin);
+  if (pinstate==_prevpinstate) return;
+  _prevpinstate=pinstate;
+
+  _rocoState = transition_table[_rocoState & _STATE_MASK][pinstate];
+  if ((_rocoState & _DIR_MASK) == 0) return; // no value change 
+
+  int change=(_rocoState & _DIR_CW)?+1:-1;
+  // handle roco change -1 or +1 (clockwise)
+  
+  if (_stopState==xrSTOP) {
+      // first move after button press sets the direction. (clockwise=fwd)
+      _stopState=change>0?xrFWD:xrREV;
+    }
+
+    // when going fwd, clockwise increases speed. 
+    // but when reversing, anticlockwise increases speed.
+    // This is similar to a center-zero pot control but with
+    // the added safety that you cant panic-spin into the other
+    // direction.
+    if (_stopState==xrREV) change=-change; 
+    //  manage limits
+    int oldspeed=DCC::getThrottleSpeed(_locoid);
+    if (oldspeed==1)oldspeed=0; // break out of estop
+    int  newspeed=change>0 ?  (min((oldspeed+_notch),126)) : (max(0,(oldspeed-_notch)));
+    if (newspeed==1) newspeed=0; // normal decelereated stop. 
+    if (oldspeed!=newspeed) {
+        DIAG(F("DRIVE %d notch %S %d %S"),_locoid,
+             change>0?F("UP"):F("DOWN"),_notch,
+             _stopState==xrFWD?F("FWD"):F("REV"));
+        DCC::setThrottle(_locoid,newspeed,_stopState==xrFWD);
+        }
+}
+
+  // Selocoid as analog value to start drive
+  // use <z vpin locoid [notch]>
+  void EncoderThrottle::_writeAnalogue(VPIN vpin, int value, uint8_t param1, uint16_t param2)  {  
+    (void) param2;
+    _locoid=value;
+    if (param1>0) _notch=param1;
+    _rocoState=0;
+    
+    // If loco is moving, we inherit direction from it.
+    _stopState=xrSTOP;
+    if (_locoid>0) {
+        auto speedbyte=DCC::getThrottleSpeedByte(_locoid);
+        if ((speedbyte & 0x7f) >1) {
+            // loco is moving
+            _stopState= (speedbyte & 0x80)?xrFWD:xrREV;
+        } 
+    }
+    _display();
+  }
+
+  
+  void EncoderThrottle::_display() {
+    DIAG(F("DRIVE vpin %d loco %d notch %d"),_firstVpin,_locoid,_notch);
+  }
+

IO_EncoderThrottle.h

@@ -0,0 +1,53 @@
+/*
+ *  © 2024, Chris Harlow. All rights reserved.
+ *
+ *  This file is part of EX-CommandStation
+ *
+ *  This is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  It is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with CommandStation.  If not, see <https://www.gnu.org/licenses/>.
+*/
+
+/*
+* The IO_EncoderThrottle device driver uses a rotary encoder connected to vpins
+* to drive a loco.
+*  Loco id is selected by writeAnalog.
+*/
+
+#ifndef IO_EncoderThrottle_H
+#define IO_EncoderThrottle_H
+#include "IODevice.h"
+
+class EncoderThrottle : public IODevice {
+public:
+  
+  static void create(VPIN firstVpin, int dtPin, int clkPin, int clickPin, byte notch=10);
+ 
+private:
+  int _dtPin,_clkPin,_clickPin, _locoid, _notch,_prevpinstate; 
+  enum {xrSTOP,xrFWD,xrREV} _stopState;
+  byte _rocoState;  
+
+  // Constructor
+  EncoderThrottle(VPIN firstVpin, int dtPin, int clkPin, int clickPin, byte notch);
+  
+  void _loop(unsigned long currentMicros) override ;
+
+  // Selocoid as analog value to start drive
+  // use <z vpin locoid [notch]>
+  void _writeAnalogue(VPIN vpin, int value, uint8_t param1, uint16_t param2) override;
+  
+  void _display() override ;
+
+ };
+
+#endif

MotorDriver.cpp

@@ -1,5 +1,6 @@
 /*
  *  © 2022-2024 Paul M Antoine
+ *  © 2024 Herb Morton
  *  © 2021 Mike S
  *  © 2021 Fred Decker
  *  © 2020-2023 Harald Barth
@@ -98,7 +99,7 @@ MotorDriver::MotorDriver(int16_t power_pin, byte signal_pin, byte signal_pin2, i
   if (HAVE_PORTH(fastSignalPin.inout == &PORTH)) {
     DIAG(F("Found PORTH pin %d"),signalPin);
     fastSignalPin.shadowinout = fastSignalPin.inout;
-    fastSignalPin.inout = &shadowPORTF;
+    fastSignalPin.inout = &shadowPORTH;
   }
 
   signalPin2=signal_pin2;

StringFormatter.cpp

@@ -139,6 +139,7 @@ void StringFormatter::send2(Print * stream,const FSH* format, va_list args) {
       case 'd': printPadded(stream,va_arg(args, int), formatWidth, formatLeft); break;
       case 'u': printPadded(stream,va_arg(args, unsigned int), formatWidth, formatLeft); break;
       case 'l': printPadded(stream,va_arg(args, long), formatWidth, formatLeft); break;
+      case 'L': stream->print(va_arg(args, unsigned long), DEC); 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;

TrackManager.cpp

@@ -1,6 +1,8 @@
 /*
  *  © 2022 Chris Harlow
  *  © 2022-2024 Harald Barth
+ *  © 2023-2024 Paul M. Antoine
+ *  © 2024 Herb Morton
  *  © 2023 Colin Murdoch
  *  All rights reserved.
  *  
@@ -149,6 +151,8 @@ void TrackManager::setDCCSignal( bool on) {
   HAVE_PORTD(shadowPORTD=PORTD);
   HAVE_PORTE(shadowPORTE=PORTE);
   HAVE_PORTF(shadowPORTF=PORTF);
+  HAVE_PORTG(shadowPORTF=PORTG);
+  HAVE_PORTH(shadowPORTF=PORTH);
   APPLY_BY_MODE(TRACK_MODE_MAIN,setSignal(on));
   HAVE_PORTA(PORTA=shadowPORTA);
   HAVE_PORTB(PORTB=shadowPORTB);
@@ -156,6 +160,8 @@ void TrackManager::setDCCSignal( bool on) {
   HAVE_PORTD(PORTD=shadowPORTD);
   HAVE_PORTE(PORTE=shadowPORTE);
   HAVE_PORTF(PORTF=shadowPORTF);
+  HAVE_PORTG(shadowPORTF=PORTG);
+  HAVE_PORTH(shadowPORTF=PORTH);
 }
 
 // setPROGSignal(), called from interrupt context
@@ -167,6 +173,8 @@ void TrackManager::setPROGSignal( bool on) {
   HAVE_PORTD(shadowPORTD=PORTD);
   HAVE_PORTE(shadowPORTE=PORTE);
   HAVE_PORTF(shadowPORTF=PORTF);
+  HAVE_PORTG(shadowPORTF=PORTG);
+  HAVE_PORTH(shadowPORTF=PORTH);
   APPLY_BY_MODE(TRACK_MODE_PROG,setSignal(on));
   HAVE_PORTA(PORTA=shadowPORTA);
   HAVE_PORTB(PORTB=shadowPORTB);
@@ -174,6 +182,8 @@ void TrackManager::setPROGSignal( bool on) {
   HAVE_PORTD(PORTD=shadowPORTD);
   HAVE_PORTE(PORTE=shadowPORTE);
   HAVE_PORTF(PORTF=shadowPORTF);
+  HAVE_PORTG(shadowPORTF=PORTG);
+  HAVE_PORTH(shadowPORTF=PORTH);
 }
 
 // setDCSignal(), called from normal context
@@ -631,23 +641,25 @@ void TrackManager::setJoinRelayPin(byte joinRelayPin) {
 
 void TrackManager::setJoin(bool joined) {
 #ifdef ARDUINO_ARCH_ESP32
-  if (joined) {
+  if (joined) {                                          // if we go into joined mode (PROG acts as MAIN)
     FOR_EACH_TRACK(t) {
-      if (track[t]->getMode() & TRACK_MODE_PROG) {
-	tempProgTrack = t;
+      if (track[t]->getMode() & TRACK_MODE_PROG) {       // find PROG track
+	tempProgTrack = t;                               // remember PROG track
 	setTrackMode(t, TRACK_MODE_MAIN);
-	break;
+	track[t]->setPower(POWERMODE::ON);               // if joined, always on
+	break;                                           // there is only one prog track, done
       }
     }
   } 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
+      // setTrackMode defaults to power off, so we
+      // need to preserve that state.
+      POWERMODE tPTmode = track[tempProgTrack]->getPower(); // get current power status of this track
+      setTrackMode(tempProgTrack, TRACK_MODE_PROG);         // set track mode back to prog
+      track[tempProgTrack]->setPower(tPTmode);              // set power status as it was before
       tempProgTrack = MAX_TRACKS+1;
+    } else {
+      DIAG(F("Unjoin but no remembered prog track"));
     }
   }
 #endif

WifiESP32.cpp

@@ -147,6 +147,12 @@ bool WifiESP::setup(const char *SSid,
   //  enableCoreWDT(1);
   //  disableCoreWDT(0);
 
+#ifdef WIFI_LED
+  // Turn off Wifi LED
+  pinMode(WIFI_LED, OUTPUT);
+  digitalWrite(WIFI_LED, 0);
+#endif
+
   // clean start
   WiFi.mode(WIFI_STA);
   WiFi.disconnect(true);
@@ -247,6 +253,13 @@ bool WifiESP::setup(const char *SSid,
     // no idea to go on
     return false;
   }
+#ifdef WIFI_LED
+  else{
+    // Turn on Wifi connected LED
+    digitalWrite(WIFI_LED, 1);
+  }
+#endif
+
 
   // Now Wifi is up, register the mDNS service
   if(!MDNS.begin(hostname)) {

config.example.h

@@ -307,11 +307,21 @@ The configuration file for DCC-EX Command Station
 //
 //#define SERIAL_BT_COMMANDS
 
-// BOOSTER PIN INPUT ON ESP32
+// BOOSTER PIN INPUT ON ESP32 CS
 // On ESP32 you have the possibility to define a pin as booster input
-// Arduio pin D2 is GPIO 26 on ESPDuino32
 //
+// Arduino pin D2 is GPIO 26 is Booster Input on ESPDuino32
 //#define BOOSTER_INPUT 26
+//
+// GPIO 32 is Booster Input on EX-CSB1
+//#define BOOSTER_INPUT 32
+
+// ESP32 LED Wifi Indicator
+// GPIO 2 on ESPduino32
+//#define WIFI_LED 2
+//
+// GPIO 33 on EX-CSB1
+//#define WIFI_LED 33
 
 // SABERTOOTH
 //

platformio.ini

@@ -104,10 +104,35 @@ lib_deps =
 	${env.lib_deps}
 	arduino-libraries/Ethernet
 	SPI
+	MDNS_Generic
+
+lib_ignore = WiFi101
+			WiFi101_Generic
+			WiFiEspAT
+			WiFiMulti_Generic
+			WiFiNINA_Generic
+
 monitor_speed = 115200
 monitor_echo = yes
 build_flags = 
 
+[env:mega2560-eth]
+platform = atmelavr
+board = megaatmega2560
+framework = arduino
+lib_deps = 
+    ${env.lib_deps}
+    arduino-libraries/Ethernet
+    MDNS_Generic
+    SPI
+lib_ignore = WiFi101
+            WiFi101_Generic
+            WiFiEspAT
+            WiFiMulti_Generic
+            WiFiNINA_Generic
+monitor_speed = 115200
+monitor_echo = yes
+
 [env:mega328]
 platform = atmelavr
 board = uno
@@ -246,6 +271,24 @@ monitor_echo = yes
 
 ; Experimental - Ethernet work still in progress
 ;
+[env:Nucleo-F429ZI]
+platform = ststm32
+board = nucleo_f429zi
+framework = arduino
+lib_deps = ${env.lib_deps}
+			stm32duino/STM32Ethernet @ ^1.3.0
+			stm32duino/STM32duino LwIP @ ^2.1.2
+			MDNS_Generic
+lib_ignore = WiFi101
+			WiFi101_Generic
+			WiFiEspAT
+			WiFiMulti_Generic
+			WiFiNINA_Generic
+build_flags = -std=c++17 -Os -g2 -Wunused-variable
+monitor_speed = 115200
+monitor_echo = yes
+upload_protocol = stlink
+
 ; [env:Nucleo-F429ZI]
 ; platform = ststm32
 ; board = nucleo_f429zi

version.h

@@ -3,11 +3,30 @@
 
 #include "StringFormatter.h"
 
-#define VERSION "5.2.62"
+#define VERSION "5.2.74"
+// 5.2.74 - Bugfix: ESP32 turn on the joined prog (as main) again after a prog operation
+// 5.2.73 - Bugfix: STM32 further fixes to shadowPORT entries in TrackManager.cpp for PORTG and PORTH
+// 5.2.72 - Bugfix: added shadowPORT entries in TrackManager.cpp for PORTG and PORTH on STM32, fixed typo in MotorDriver.cpp
+// 5.2.71 -  Broadcasts of loco forgets. 
+// 5.2.70 -  IO_RocoDriver renamed to IO_EncoderThrottle.
+//        -  and included in IODEvice.h (circular dependency removed) 
+// 5.2.69 -  IO_RocoDriver. Direct drive train with rotary encoder hw.
+// 5.2.68 -  Revert function map to signed (from 5.2.66) to avoid
+//           incompatibilities with ED etc for F31 frequency flag.
+// 5.2.67 -  EXRAIL AFTER optional debounce time variable (default 500mS)
+//        -  AFTER(42) == AFTER(42,500) sets time sensor must 
+//        -  be continuously off.
+// 5.2.66 - <F cab DCFREQ 0..3>
+//        - EXRAIL SETFREQ drop loco param (breaking since 5.2.28)
+// 5.2.65 - Speedup Exrail SETFREQ 
+// 5.2.64 - Bugfix: <0 PROG> updated to undo JOIN 
+// 5.2.63 - Implement WIFI_LED for ESP32, ESPduino32 and EX-CSB1, that is turned on when STA mode connects or AP mode is up
+//        - Add BOOSTER_INPUT definitions for ESPduino32 and EX-CSB1 to config.example.h
+//        - Add WIFI_LED definitions for ESPduino32 and EX-CSB1 to config.example.h
 // 5.2.62 - Allow acks way longer than standard
 // 5.2.61 - Merg CBUS  ACON/ACOF/ONACON/ONACOF Adapter interface.
 //        - LCC Adapter interface throttled startup,
-//          (Breaking change woith Adapter base code)
+//          (Breaking change with Adapter base code)
 // 5.2.60 - Bugfix: Opcode AFTEROVERLOAD does not have an argument that is a pin and needs to be initialized
 //        - Remove inrush throttle after half good time so that we go to mode overload if problem persists
 // 5.2.59 - STM32 bugfix correct Serial1 definition for Nucleo-F401RE