Add driver and example

Add patreon as our first funding site

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+github: DCC-EX
+patreon: dccex

.github/workflows/label-sponsors.yml

@@ -0,0 +1,14 @@
+name: Label sponsors
+on:
+  pull_request:
+    types: [opened]
+  issues:
+    types: [opened]
+jobs:
+  build:
+    name: is-sponsor-label
+    runs-on: ubuntu-latest
+    steps:
+      - uses: JasonEtco/is-sponsor-label-action@v1.2.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/sha.yml

@@ -24,10 +24,11 @@ jobs:
           sha=$(git rev-parse --short "$GITHUB_SHA")
           echo "#define GITHUB_SHA \"$sha\"" > GITHUB_SHA.h
 
-      - uses: EndBug/add-and-commit@v4 # You can change this to use a specific version
+      - uses: EndBug/add-and-commit@v8 # You can change this to use a specific version
         with:
           add: 'GITHUB_SHA.h'
           message: 'Committing a SHA'
+          commit: --amend
 
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Leave this line unchanged

.gitignore

@@ -7,9 +7,10 @@ Release/*
 .pio/
 .vscode/
 config.h
-.vscode/extensions.json
+.vscode/*
 mySetup.h
 mySetup.cpp
+myHal.cpp
 myAutomation.h
 myFilter.cpp
 myAutomation.h

.vscode/extensions.json

@@ -3,5 +3,8 @@
     // for the documentation about the extensions.json format
     "recommendations": [
         "platformio.platformio-ide"
+    ],
+    "unwantedRecommendations": [
+        "ms-vscode.cpptools-extension-pack"
     ]
 }

CommandDistributor.cpp

@@ -1,6 +1,9 @@
 /*
- *  © 2020,Gregor Baues,  Chris Harlow. All rights reserved.
- *  
+ *  © 2022 Harald Barth
+ *  © 2020-2021 Chris Harlow
+ *  © 2020 Gregor Baues
+ *  All rights reserved.
+ *
  *  This file is part of CommandStation-EX
  *
  *  This is free software: you can redistribute it and/or modify
@@ -16,16 +19,124 @@
  *  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 "CommandDistributor.h"
+#include "SerialManager.h"
 #include "WiThrottle.h"
+#include "DIAG.h"
+#include "defines.h"
+#include "DCCWaveform.h"
+#include "DCC.h"
 
-DCCEXParser * CommandDistributor::parser=0; 
+#if defined(BIG_MEMORY) | defined(WIFI_ON) | defined(ETHERNET_ON)
+// This section of CommandDistributor is simply not relevant on a uno or similar
+const byte NO_CLIENT=255;
 
-void  CommandDistributor::parse(byte clientId,byte * buffer, RingStream * streamer) {
- if (buffer[0] == '<')  {
-    if (!parser) parser = new DCCEXParser();
-    parser->parse(streamer, buffer, streamer); 
+RingStream *  CommandDistributor::ring=0;
+byte CommandDistributor::ringClient=NO_CLIENT;
+CommandDistributor::clientType  CommandDistributor::clients[8]={
+  NONE_TYPE,NONE_TYPE,NONE_TYPE,NONE_TYPE,NONE_TYPE,NONE_TYPE,NONE_TYPE,NONE_TYPE};
+RingStream * CommandDistributor::broadcastBufferWriter=new RingStream(100);
+
+void  CommandDistributor::parse(byte clientId,byte * buffer, RingStream * stream) {
+  ring=stream;
+  ringClient=stream->peekTargetMark();
+  if (buffer[0] == '<')  {
+    clients[clientId]=COMMAND_TYPE;
+    DCCEXParser::parse(stream, buffer, ring);
+  } else {
+    clients[clientId]=WITHROTTLE_TYPE;
+    WiThrottle::getThrottle(clientId)->parse(ring, buffer);
   }
-  else WiThrottle::getThrottle(clientId)->parse(streamer, buffer);
+  ringClient=NO_CLIENT;
+}
+
+void CommandDistributor::forget(byte clientId) {
+  clients[clientId]=NONE_TYPE;
+}
+
+
+void CommandDistributor::broadcast(bool includeWithrottleClients) {
+  broadcastBufferWriter->write((byte)'\0');
+
+  /* Boadcast to Serials */
+  SerialManager::broadcast(broadcastBufferWriter);
+
+#if defined(WIFI_ON) | defined(ETHERNET_ON)
+  // 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 (ringClient!=NO_CLIENT) ring->commit();
+
+  /* loop through ring clients */
+  for (byte clientId=0; clientId<sizeof(clients); clientId++) {
+    if (clients[clientId]==NONE_TYPE) continue;
+    if ( clients[clientId]==WITHROTTLE_TYPE && !includeWithrottleClients) continue;
+    ring->mark(clientId);
+    broadcastBufferWriter->printBuffer(ring);
+    ring->commit();
+  }
+  if (ringClient!=NO_CLIENT) ring->mark(ringClient);
+
+#endif
+ broadcastBufferWriter->flush();
+}
+#else
+// For a UNO/NANO we can broadcast direct to just one Serial instead of the ring
+// Redirect ring output ditrect to Serial
+#define broadcastBufferWriter &Serial
+// and ignore the internal broadcast call.
+void CommandDistributor::broadcast(bool includeWithrottleClients) {
+  (void)includeWithrottleClients;
+}
+#endif
+
+void  CommandDistributor::broadcastSensor(int16_t id, bool on ) {
+  StringFormatter::send(broadcastBufferWriter,F("<%c %d>\n"), on?'Q':'q', id);
+  broadcast(false);
+}
+
+void  CommandDistributor::broadcastTurnout(int16_t id, bool isClosed ) {
+  // For DCC++ classic compatibility, state reported to JMRI is 1 for thrown and 0 for closed;
+  // The string below contains serial and Withrottle protocols which should
+  // be safe for both types.
+  StringFormatter::send(broadcastBufferWriter,F("<H %d %d>\n"),id, !isClosed);
+#if defined(WIFI_ON) | defined(ETHERNET_ON)
+  StringFormatter::send(broadcastBufferWriter,F("PTA%c%d\n"), isClosed?'2':'4', id);
+#endif
+  broadcast(true);
+}
+
+void  CommandDistributor::broadcastLoco(byte slot) {
+  DCC::LOCO * sp=&DCC::speedTable[slot];
+  StringFormatter::send(broadcastBufferWriter,F("<l %d %d %d %l>\n"),
+			sp->loco,slot,sp->speedCode,sp->functions);
+  broadcast(false);
+#if defined(WIFI_ON) | defined(ETHERNET_ON)
+  WiThrottle::markForBroadcast(sp->loco);
+#endif
+}
+
+void  CommandDistributor::broadcastPower() {
+  bool main=DCCWaveform::mainTrack.getPowerMode()==POWERMODE::ON;
+  bool prog=DCCWaveform::progTrack.getPowerMode()==POWERMODE::ON;
+  bool join=DCCWaveform::progTrackSyncMain;
+  const FSH * reason=F("");
+  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';
+
+  StringFormatter::send(broadcastBufferWriter,
+                        F("<p%c%S>\nPPA%c\n"),state,reason, main?'1':'0');
+  LCD(2,F("Power %S%S"),state=='1'?F("On"):F("Off"),reason);
+  broadcast(true);
+}
+
+void CommandDistributor::broadcastText(const FSH * msg) {
+  StringFormatter::send(broadcastBufferWriter,F("%S"),msg);
+  broadcast(false); 
 }

CommandDistributor.h

@@ -1,6 +1,9 @@
 /*
- *  © 2020,Gregor Baues,  Chris Harlow. All rights reserved.
- *  
+ *  © 2022 Harald Barth
+ *  © 2020-2021 Chris Harlow
+ *  © 2020 Gregor Baues
+ *  All rights reserved.
+ *
  *  This file is part of CommandStation-EX
  *
  *  This is free software: you can redistribute it and/or modify
@@ -24,9 +27,22 @@
 class CommandDistributor {
 
 public :
-  static void parse(byte clientId,byte* buffer, RingStream * streamer);
+  static void parse(byte clientId,byte* buffer, RingStream * ring);
+  static void broadcastLoco(byte slot);
+  static void broadcastSensor(int16_t id, bool value);
+  static void broadcastTurnout(int16_t id, bool isClosed);
+  static void broadcastPower();
+  static void broadcastText(const FSH * msg);
+  static void forget(byte clientId);
 private:
-   static DCCEXParser * parser;
+  static void broadcast(bool includeWithrottleClients);
+  static RingStream * ring;
+  static RingStream * broadcastBufferWriter;
+  static byte ringClient;
+
+   // each bit in broadcastlist = 1<<clientid
+   enum clientType: byte {NONE_TYPE,COMMAND_TYPE,WITHROTTLE_TYPE};
+   static clientType clients[8];
 };
 
 #endif

CommandStation-EX.ino

@@ -1,33 +1,35 @@
 ////////////////////////////////////////////////////////////////////////////////////
-//  DCC-EX CommandStation-EX   Please see https://DCC-EX.com 
+//  DCC-EX CommandStation-EX   Please see https://DCC-EX.com
 //
 // This file is the main sketch for the Command Station.
-// 
-// CONFIGURATION: 
+//
+// CONFIGURATION:
 // Configuration is normally performed by editing a file called config.h.
 // This file is NOT shipped with the code so that if you pull a later version
 // of the code, your configuration will not be overwritten.
 //
 // If you used the automatic installer program, config.h will have been created automatically.
-// 
-// To obtain a starting copy of config.h please copy the file config.example.h which is 
-// shipped with the code and may be updated as new features are added. 
-// 
+//
+// To obtain a starting copy of config.h please copy the file config.example.h which is
+// shipped with the code and may be updated as new features are added.
+//
 // If config.h is not found, config.example.h will be used with all defaults.
 ////////////////////////////////////////////////////////////////////////////////////
 
 #if __has_include ( "config.h")
   #include "config.h"
 #else
-  #warning config.h not found. Using defaults from config.example.h 
+  #warning config.h not found. Using defaults from config.example.h
   #include "config.example.h"
 #endif
 
 
 /*
- *  © 2020,2021 Chris Harlow, Harald Barth, David Cutting, 
- *  Fred Decker, Gregor Baues, Anthony W - Dayton  All rights reserved.
- *  
+ *  © 2021 Neil McKechnie
+ *  © 2020-2021 Chris Harlow, Harald Barth, David Cutting,
+ *  Fred Decker, Gregor Baues, Anthony W - Dayton
+ *  All rights reserved.
+ *
  *  This file is part of CommandStation-EX
  *
  *  This is free software: you can redistribute it and/or modify
@@ -45,11 +47,15 @@
  */
 
 #include "DCCEX.h"
-
-// Create a serial command parser for the USB connection, 
-// This supports JMRI or manual diagnostics and commands
-// to be issued from the USB serial console.
-DCCEXParser serialParser;
+#ifdef WIFI_WARNING
+#warning You have defined that you want WiFi but your hardware has not enough memory to do that, so WiFi DISABLED
+#endif
+#ifdef ETHERNET_WARNING
+#warning You have defined that you want Ethernet but your hardware has not enough memory to do that, so Ethernet DISABLED
+#endif
+#ifdef EXRAIL_WARNING
+#warning You have myAutomation.h but your hardware has not enough memory to do that, so EX-RAIL DISABLED
+#endif
 
 void setup()
 {
@@ -57,15 +63,15 @@ void setup()
 
   // Responsibility 1: Start the usb connection for diagnostics
   // This is normally Serial but uses SerialUSB on a SAMD processor
-  Serial.begin(115200);
+  SerialManager::init();
 
   DIAG(F("License GPLv3 fsf.org (c) dcc-ex.com"));
 
   CONDITIONAL_LCD_START {
-    // This block is still executed for DIAGS if LCD not in use 
+    // 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")); 
-    }   
+    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
@@ -84,32 +90,26 @@ void setup()
   //  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
   DCC::begin(MOTOR_SHIELD_TYPE);
-         
-  // Start RMFT (ignored if no automnation)
+
+  // Start RMFT aka EX-RAIL (ignored if no automnation)
   RMFT::begin();
-  
-  // Link to and call mySetup() function (if defined in the build in mySetup.cpp).
-  //  The contents will depend on the user's system hardware configuration.
-  //  The mySetup.cpp file is a standard C++ module so has access to all of the DCC++EX APIs.
-  extern __attribute__((weak)) void mySetup();
-  if (mySetup) {
-    mySetup();
-  }
 
-  // Invoke any DCC++EX commands in the form "SETUP("xxxx");"" found in optional file mySetup.h.  
-  //  This can be used to create turnouts, outputs, sensors etc. throught the normal text commands.
+
+  // Invoke any DCC++EX commands in the form "SETUP("xxxx");"" found in optional file mySetup.h.
+  //  This can be used to create turnouts, outputs, sensors etc. through the normal text commands.
   #if __has_include ( "mySetup.h")
-        #define SETUP(cmd) serialParser.parse(F(cmd))  
-        #include "mySetup.h"
-        #undef SETUP
-       #endif
-
-  #if defined(LCN_SERIAL)
-      LCN_SERIAL.begin(115200); 
-      LCN::init(LCN_SERIAL);
+  #define SETUP(cmd) DCCEXParser::parse(F(cmd))
+  #include "mySetup.h"
+  #undef SETUP
   #endif
 
-  LCD(3,F("Ready")); 
+  #if defined(LCN_SERIAL)
+  LCN_SERIAL.begin(115200);
+  LCN::init(LCN_SERIAL);
+  #endif
+
+  LCD(3,F("Ready"));
+  CommandDistributor::broadcastPower();
 }
 
 void loop()
@@ -121,9 +121,9 @@ void loop()
   DCC::loop();
 
   // Responsibility 2: handle any incoming commands on USB connection
-  serialParser.loop(Serial);
+  SerialManager::loop();
 
-// Responsibility 3: Optionally handle any incoming WiFi traffic
+  // Responsibility 3: Optionally handle any incoming WiFi traffic
 #if WIFI_ON
   WifiInterface::loop();
 #endif
@@ -133,21 +133,22 @@ void loop()
 
   RMFT::loop();  // ignored if no automation
 
-  #if defined(LCN_SERIAL) 
-      LCN::loop();
+  #if defined(LCN_SERIAL)
+  LCN::loop();
   #endif
 
-  LCDDisplay::loop();  // ignored if LCD not in use 
+  LCDDisplay::loop();  // ignored if LCD not in use
 
   // Handle/update IO devices.
   IODevice::loop();
-  
+
+  Sensor::checkAll(); // Update and print changes
+
   // Report any decrease in memory (will automatically trigger on first call)
-  static int ramLowWatermark = __INT_MAX__; // replaced on first loop 
+  static int ramLowWatermark = __INT_MAX__; // replaced on first loop
 
   int freeNow = minimumFreeMemory();
-  if (freeNow < ramLowWatermark)
-  {
+  if (freeNow < ramLowWatermark) {
     ramLowWatermark = freeNow;
     LCD(3,F("Free RAM=%5db"), ramLowWatermark);
   }

DCC.cpp

@@ -1,7 +1,13 @@
 /*
- *  © 2020, Chris Harlow. All rights reserved.
- *  © 2020, Harald Barth
- *  
+ *  © 2021 Neil McKechnie
+ *  © 2021 Mike S
+ *  © 2021 Fred Decker
+ *  © 2021 Herb Morton
+ *  © 2020-2022 Harald Barth
+ *  © 2020-2021 M Steve Todd
+ *  © 2020-2021 Chris Harlow
+ *  All rights reserved.
+ *
  *  This file is part of Asbelos DCC API
  *
  *  This is free software: you can redistribute it and/or modify
@@ -20,11 +26,15 @@
 #include "DIAG.h"
 #include "DCC.h"
 #include "DCCWaveform.h"
+#ifndef DISABLE_EEPROM
 #include "EEStore.h"
+#endif
 #include "GITHUB_SHA.h"
 #include "version.h"
 #include "FSH.h"
 #include "IODevice.h"
+#include "EXRAIL2.h"
+#include "CommandDistributor.h"
 
 // This module is responsible for converting API calls into
 // messages to be sent to the waveform generator.
@@ -39,11 +49,11 @@
 //   Obtaining ACKs from the prog track using a function
 //   There are no volatiles here.
 
-const byte FN_GROUP_1=0x01;         
-const byte FN_GROUP_2=0x02;         
-const byte FN_GROUP_3=0x04;         
-const byte FN_GROUP_4=0x08;         
-const byte FN_GROUP_5=0x10;         
+const byte FN_GROUP_1=0x01;
+const byte FN_GROUP_2=0x02;
+const byte FN_GROUP_3=0x04;
+const byte FN_GROUP_4=0x08;
+const byte FN_GROUP_5=0x10;
 
 FSH* DCC::shieldName=NULL;
 byte DCC::joinRelay=UNUSED_PIN;
@@ -56,11 +66,13 @@ void DCC::begin(const FSH * motorShieldName, MotorDriver * mainDriver, MotorDriv
   // Initialise HAL layer before reading EEprom.
   IODevice::begin();
 
+#ifndef DISABLE_EEPROM
   // Load stuff from EEprom
   (void)EEPROM; // tell compiler not to warn this is unused
   EEStore::init();
+#endif
 
-  DCCWaveform::begin(mainDriver,progDriver); 
+  DCCWaveform::begin(mainDriver,progDriver);
 }
 
 void DCC::setJoinRelayPin(byte joinRelayPin) {
@@ -72,7 +84,7 @@ void DCC::setJoinRelayPin(byte joinRelayPin) {
 }
 
 void DCC::setThrottle( uint16_t cab, uint8_t tSpeed, bool tDirection)  {
-  byte speedCode = (tSpeed & 0x7F)  + tDirection * 128; 
+  byte speedCode = (tSpeed & 0x7F)  + tDirection * 128;
   setThrottle2(cab, speedCode);
   // retain speed for loco reminders
   updateLocoReminder(cab, speedCode );
@@ -83,8 +95,8 @@ void DCC::setThrottle2( uint16_t cab, byte speedCode)  {
   uint8_t b[4];
   uint8_t nB = 0;
   // DIAG(F("setSpeedInternal %d %x"),cab,speedCode);
-  
-  if (cab > 127)
+
+  if (cab > HIGHEST_SHORT_ADDR)
     b[nB++] = highByte(cab) | 0xC0;    // convert train number into a two-byte address
   b[nB++] = lowByte(cab);
 
@@ -124,7 +136,7 @@ void DCC::setFunctionInternal(int cab, byte byte1, byte byte2) {
   byte b[4];
   byte nB = 0;
 
-  if (cab > 127)
+  if (cab > HIGHEST_SHORT_ADDR)
     b[nB++] = highByte(cab) | 0xC0;    // convert train number into a two-byte address
   b[nB++] = lowByte(cab);
   if (byte1!=0) b[nB++] = byte1;
@@ -148,86 +160,67 @@ bool DCC::getThrottleDirection(int cab) {
 // Set function to value on or off
 void DCC::setFn( int cab, int16_t functionNumber, bool on) {
   if (cab<=0 ) return;
-  
-  if (functionNumber>28) { 
-    //non reminding advanced binary bit set 
+
+  if (functionNumber>28) {
+    //non reminding advanced binary bit set
     byte b[5];
     byte nB = 0;
-    if (cab > 127)
+    if (cab > HIGHEST_SHORT_ADDR)
       b[nB++] = highByte(cab) | 0xC0;    // convert train number into a two-byte address
     b[nB++] = lowByte(cab);
     if (functionNumber <= 127) {
-       b[nB++] = 0b11011101;   // Binary State Control Instruction short form  
+       b[nB++] = 0b11011101;   // Binary State Control Instruction short form
        b[nB++] = functionNumber | (on ? 0x80 : 0);
     }
     else  {
-       b[nB++] = 0b11000000;   // Binary State Control Instruction long form  
+       b[nB++] = 0b11000000;   // Binary State Control Instruction long form
        b[nB++] = (functionNumber & 0x7F) | (on ? 0x80 : 0);  // low order bits and state flag
        b[nB++] = functionNumber >>7 ;  // high order bits
     }
     DCCWaveform::mainTrack.schedulePacket(b, nB, 4);
     return;
   }
-  
+
   int reg = lookupSpeedTable(cab);
-  if (reg<0) return;  
+  if (reg<0) return;
 
   // Take care of functions:
   // Set state of function
+  unsigned long previous=speedTable[reg].functions;
   unsigned long funcmask = (1UL<<functionNumber);
   if (on) {
       speedTable[reg].functions |= funcmask;
   } else {
       speedTable[reg].functions &= ~funcmask;
   }
-  updateGroupflags(speedTable[reg].groupFlags, functionNumber);
-  return;
+  if (speedTable[reg].functions != previous) {
+    updateGroupflags(speedTable[reg].groupFlags, functionNumber);
+    CommandDistributor::broadcastLoco(reg);
+  }
 }
 
-// Change function according to how button was pressed,
-// typically in WiThrottle.
-// Returns new state or -1 if nothing was changed.
-int DCC::changeFn( int cab, int16_t functionNumber, bool pressed) {
-  int funcstate = -1;
-  if (cab<=0 || functionNumber>28) return funcstate;
+// Flip function state
+void DCC::changeFn( int cab, int16_t functionNumber) {
+  if (cab<=0 || functionNumber>28) return;
   int reg = lookupSpeedTable(cab);
-  if (reg<0) return funcstate;  
-
-  // Take care of functions:
-  // Imitate how many command stations do it: Button press is
-  // toggle but for F2 where it is momentary
+  if (reg<0) return;
   unsigned long funcmask = (1UL<<functionNumber);
-  if (functionNumber == 2) {
-      // turn on F2 on press and off again at release of button
-      if (pressed) {
-	  speedTable[reg].functions |= funcmask;
-	  funcstate = 1;
-      } else {
-	  speedTable[reg].functions &= ~funcmask;
-	  funcstate = 0;
-      }
-  } else {
-      // toggle function on press, ignore release
-      if (pressed) {
-        speedTable[reg].functions ^= funcmask;
-      }
-      funcstate = (speedTable[reg].functions & funcmask)? 1 : 0;
-  }
+  speedTable[reg].functions ^= funcmask;
   updateGroupflags(speedTable[reg].groupFlags, functionNumber);
-  return funcstate;
+  CommandDistributor::broadcastLoco(reg);
 }
 
 int DCC::getFn( int cab, int16_t functionNumber) {
   if (cab<=0 || functionNumber>28) return -1;  // unknown
   int reg = lookupSpeedTable(cab);
-  if (reg<0) return -1;  
+  if (reg<0) return -1;
 
   unsigned long funcmask = (1UL<<functionNumber);
   return  (speedTable[reg].functions & funcmask)? 1 : 0;
 }
 
 // Set the group flag to say we have touched the particular group.
-// A group will be reminded only if it has been touched.  
+// A group will be reminded only if it has been touched.
 void DCC::updateGroupflags(byte & flags, int16_t functionNumber) {
   byte groupMask;
   if (functionNumber<=4)       groupMask=FN_GROUP_1;
@@ -235,7 +228,13 @@ void DCC::updateGroupflags(byte & flags, int16_t functionNumber) {
   else if (functionNumber<=12) groupMask=FN_GROUP_3;
   else if (functionNumber<=20) groupMask=FN_GROUP_4;
   else                         groupMask=FN_GROUP_5;
-  flags |= groupMask; 
+  flags |= groupMask;
+}
+
+uint32_t DCC::getFunctionMap(int cab) {
+  if (cab<=0) return 0;  // unknown pretend all functions off
+  int reg = lookupSpeedTable(cab);
+  return (reg<0)?0:speedTable[reg].functions;
 }
 
 void DCC::setAccessory(int address, byte number, bool activate) {
@@ -253,6 +252,9 @@ void DCC::setAccessory(int address, byte number, bool activate) {
   b[1] = ((((address / 64) % 8) << 4) + (number % 4 << 1) + activate % 2) ^ 0xF8; // second byte is of the form 1AAACDDD, where C should be 1, and the least significant D represent activate/deactivate
 
   DCCWaveform::mainTrack.schedulePacket(b, 2, 4);      // Repeat the packet four times
+#if defined(EXRAIL_ACTIVE)
+  RMFT2::activateEvent(address<<2|number,activate);
+#endif
 }
 
 //
@@ -262,7 +264,7 @@ void DCC::setAccessory(int address, byte number, bool activate) {
 void DCC::writeCVByteMain(int cab, int cv, byte bValue)  {
   byte b[5];
   byte nB = 0;
-  if (cab > 127)
+  if (cab > HIGHEST_SHORT_ADDR)
     b[nB++] = highByte(cab) | 0xC0;    // convert train number into a two-byte address
 
   b[nB++] = lowByte(cab);
@@ -283,7 +285,7 @@ void DCC::writeCVBitMain(int cab, int cv, byte bNum, bool bValue)  {
   bValue = bValue % 2;
   bNum = bNum % 8;
 
-  if (cab > 127)
+  if (cab > HIGHEST_SHORT_ADDR)
     b[nB++] = highByte(cab) | 0xC0;    // convert train number into a two-byte address
 
   b[nB++] = lowByte(cab);
@@ -305,64 +307,64 @@ void DCC::setProgTrackBoost(bool on) {
 FSH* DCC::getMotorShieldName() {
   return shieldName;
 }
-  
+
 const ackOp FLASH WRITE_BIT0_PROG[] = {
      BASELINE,
      W0,WACK,
-     V0, WACK,  // validate bit is 0 
+     V0, WACK,  // validate bit is 0
      ITC1,      // if acked, callback(1)
      FAIL  // callback (-1)
 };
 const ackOp FLASH WRITE_BIT1_PROG[] = {
      BASELINE,
      W1,WACK,
-     V1, WACK,  // validate bit is 1 
+     V1, WACK,  // validate bit is 1
      ITC1,      // if acked, callback(1)
      FAIL  // callback (-1)
 };
 
 const ackOp FLASH VERIFY_BIT0_PROG[] = {
      BASELINE,
-     V0, WACK,  // validate bit is 0 
+     V0, WACK,  // validate bit is 0
      ITC0,      // if acked, callback(0)
      V1, WACK,  // validate bit is 1
-     ITC1,       
+     ITC1,
      FAIL  // callback (-1)
 };
 const ackOp FLASH VERIFY_BIT1_PROG[] = {
      BASELINE,
-     V1, WACK,  // validate bit is 1 
+     V1, WACK,  // validate bit is 1
      ITC1,      // if acked, callback(1)
-     V0, WACK, 
+     V0, WACK,
      ITC0,
      FAIL  // callback (-1)
 };
 
 const ackOp FLASH READ_BIT_PROG[] = {
      BASELINE,
-     V1, WACK,  // validate bit is 1 
+     V1, WACK,  // validate bit is 1
      ITC1,      // if acked, callback(1)
      V0, WACK,  // validate bit is zero
      ITC0,      // if acked callback 0
-     FAIL       // bit not readable 
+     FAIL       // bit not readable
      };
-     
+
 const ackOp FLASH WRITE_BYTE_PROG[] = {
       BASELINE,
-      WB,WACK,ITC1,    // Write and callback(1) if ACK 
-      // handle decoders that dont ack a write 
-      VB,WACK,ITC1,    // validate byte and callback(1) if correct 
+      WB,WACK,ITC1,    // Write and callback(1) if ACK
+      // handle decoders that dont ack a write
+      VB,WACK,ITC1,    // validate byte and callback(1) if correct
       FAIL        // callback (-1)
       };
-      
+
 const ackOp FLASH VERIFY_BYTE_PROG[] = {
       BASELINE,
       BIV,         // ackManagerByte initial value
-      VB,WACK,     // validate byte 
+      VB,WACK,     // validate byte
       ITCB,       // if ok callback value	
       STARTMERGE,    //clear bit and byte values ready for merge pass
       // each bit is validated against 0 and the result inverted in MERGE
-      // this is because there tend to be more zeros in cv values than ones.  
+      // this is because there tend to be more zeros in cv values than ones.
       // There is no need for one validation as entire byte is validated at the end
       V0, WACK, MERGE,        // read and merge first tested bit (7)
       ITSKIP,                 // do small excursion if there was no ack
@@ -379,13 +381,13 @@ const ackOp FLASH VERIFY_BYTE_PROG[] = {
       V0, WACK, MERGE,
       VB, WACK, ITCBV,  // verify merged byte and return it if acked ok - with retry report
       FAIL };
-      
-      
+
+
 const ackOp FLASH READ_CV_PROG[] = {
       BASELINE,
       STARTMERGE,    //clear bit and byte values ready for merge pass
       // each bit is validated against 0 and the result inverted in MERGE
-      // this is because there tend to be more zeros in cv values than ones.  
+      // this is because there tend to be more zeros in cv values than ones.
       // There is no need for one validation as entire byte is validated at the end
       V0, WACK, MERGE,        // read and merge first tested bit (7)
       ITSKIP,                 // do small excursion if there was no ack
@@ -400,20 +402,20 @@ const ackOp FLASH READ_CV_PROG[] = {
       V0, WACK, MERGE,
       V0, WACK, MERGE,
       V0, WACK, MERGE,
-      VB, WACK, ITCB,  // verify merged byte and return it if acked ok 
+      VB, WACK, ITCB,  // verify merged byte and return it if acked ok
       FAIL };          // verification failed
 
 
 const ackOp FLASH LOCO_ID_PROG[] = {
       BASELINE,
       SETCV, (ackOp)19,     // CV 19 is consist setting
-      SETBYTE, (ackOp)0,    
+      SETBYTE, (ackOp)0,
       VB, WACK, ITSKIP,     // ignore consist if cv19 is zero (no consist)
       SETBYTE, (ackOp)128,
       VB, WACK, ITSKIP,     // ignore consist if cv19 is 128 (no consist, direction bit set)
       STARTMERGE,           // Setup to read cv 19
-      V0, WACK, MERGE,  
-      V0, WACK, MERGE,  
+      V0, WACK, MERGE,
+      V0, WACK, MERGE,
       V0, WACK, MERGE,
       V0, WACK, MERGE,
       V0, WACK, MERGE,
@@ -421,13 +423,13 @@ const ackOp FLASH LOCO_ID_PROG[] = {
       V0, WACK, MERGE,
       V0, WACK, MERGE,
       VB, WACK, ITCB7,  // return 7 bits only, No_ACK means CV19 not supported so ignore it
-      
-      SKIPTARGET,     // continue here if CV 19 is zero or fails all validation      
+
+      SKIPTARGET,     // continue here if CV 19 is zero or fails all validation
       SETCV,(ackOp)29,
       SETBIT,(ackOp)5,
       V0, WACK, ITSKIP,  // Skip to SKIPTARGET if bit 5 of CV29 is zero
-      
-      // Long locoid  
+
+      // Long locoid
       SETCV, (ackOp)17,       // CV 17 is part of locoid
       STARTMERGE,
       V0, WACK, MERGE,  // read and merge bit 1 etc
@@ -439,8 +441,8 @@ const ackOp FLASH LOCO_ID_PROG[] = {
       V0, WACK, MERGE,
       V0, WACK, MERGE,
       VB, WACK, NAKFAIL,  // verify merged byte and return -1 it if not acked ok
-      STASHLOCOID,         // keep stashed cv 17 for later 
-      // Read 2nd part from CV 18 
+      STASHLOCOID,         // keep stashed cv 17 for later
+      // Read 2nd part from CV 18
       SETCV, (ackOp)18,
       STARTMERGE,
       V0, WACK, MERGE,  // read and merge bit 1 etc
@@ -453,8 +455,8 @@ const ackOp FLASH LOCO_ID_PROG[] = {
       V0, WACK, MERGE,
       VB, WACK, NAKFAIL,  // verify merged byte and return -1 it if not acked ok
       COMBINELOCOID,        // Combile byte with stash to make long locoid and callback
-      
-      // ITSKIP Skips to here if CV 29 bit 5 was zero. so read CV 1 and return that  
+
+      // ITSKIP Skips to here if CV 29 bit 5 was zero. so read CV 1 and return that
       SKIPTARGET,
       SETCV, (ackOp)1,
       STARTMERGE,
@@ -468,7 +470,7 @@ const ackOp FLASH LOCO_ID_PROG[] = {
       V0, WACK, MERGE,
       VB, WACK, ITCB,  // verify merged byte and callback
       FAIL
-      };    
+      };
 
 const ackOp FLASH SHORT_LOCO_ID_PROG[] = {
       BASELINE,
@@ -480,12 +482,12 @@ const ackOp FLASH SHORT_LOCO_ID_PROG[] = {
       SETBIT,(ackOp)5,
       W0,WACK,
       V0,WACK,NAKFAIL,
-      SETCV, (ackOp)1,   
-      SETBYTEL,   // low byte of word 
+      SETCV, (ackOp)1,
+      SETBYTEL,   // low byte of word
       WB,WACK,    // some decoders don't ACK writes
       VB,WACK,ITCB,
       FAIL
-};    
+};
 
 const ackOp FLASH LONG_LOCO_ID_PROG[] = {
       BASELINE,
@@ -500,16 +502,16 @@ const ackOp FLASH LONG_LOCO_ID_PROG[] = {
       V1,WACK,NAKFAIL,
       // Store high byte of address in cv 17
       SETCV, (ackOp)17,
-      SETBYTEH,   // high byte of word 
+      SETBYTEH,   // high byte of word
       WB,WACK,
       VB,WACK,NAKFAIL,
-      // store 
+      // store
       SETCV, (ackOp)18,
-      SETBYTEL,   // low byte of word 
+      SETBYTEL,   // low byte of word
       WB,WACK,
       VB,WACK,ITC1,   // callback(1) means Ok
       FAIL
-};    
+};
 
 void  DCC::writeCVByte(int16_t cv, byte byteValue, ACK_CALLBACK callback)  {
   ackManagerSetup(cv, byteValue,  WRITE_BYTE_PROG, callback);
@@ -548,24 +550,24 @@ void DCC::setLocoId(int id,ACK_CALLBACK callback) {
     callback(-1);
     return;
   }
-  if (id<=127)
+  if (id<=HIGHEST_SHORT_ADDR)
       ackManagerSetup(id, SHORT_LOCO_ID_PROG, callback);
   else
       ackManagerSetup(id | 0xc000,LONG_LOCO_ID_PROG, callback);
 }
 
 void DCC::forgetLoco(int cab) {  // removes any speed reminders for this loco
-  setThrottle2(cab,1); // ESTOP this loco if still on track  
+  setThrottle2(cab,1); // ESTOP this loco if 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      
+  setThrottle2(0,1); // ESTOP all locos still on track
   for (int i=0;i<MAX_LOCOS;i++) speedTable[i].loco=0;
 }
 
-byte DCC::loopStatus=0;  
+byte DCC::loopStatus=0;
 
 void DCC::loop()  {
   DCCWaveform::loop(ackManagerProg!=NULL); // power overload checks
@@ -580,58 +582,58 @@ void DCC::issueReminders() {
   // This loop searches for a loco in the speed table starting at nextLoco and cycling back around
   for (int reg=0;reg<MAX_LOCOS;reg++) {
        int slot=reg+nextLoco;
-       if (slot>=MAX_LOCOS) slot-=MAX_LOCOS; 
+       if (slot>=MAX_LOCOS) slot-=MAX_LOCOS;
        if (speedTable[slot].loco > 0) {
-          // have found the next loco to remind 
+          // have found the next loco to remind
           // issueReminder will return true if this loco is completed (ie speed and functions)
-          if (issueReminder(slot)) nextLoco=slot+1; 
+          if (issueReminder(slot)) nextLoco=slot+1;
           return;
         }
   }
 }
- 
+
 bool DCC::issueReminder(int reg) {
   unsigned long functions=speedTable[reg].functions;
   int loco=speedTable[reg].loco;
   byte flags=speedTable[reg].groupFlags;
-  
+
   switch (loopStatus) {
         case 0:
       //   DIAG(F("Reminder %d speed %d"),loco,speedTable[reg].speedCode);
          setThrottle2(loco, speedTable[reg].speedCode);
          break;
        case 1: // remind function group 1 (F0-F4)
-          if (flags & FN_GROUP_1) 
+          if (flags & FN_GROUP_1)
               setFunctionInternal(loco,0, 128 | ((functions>>1)& 0x0F) | ((functions & 0x01)<<4)); // 100D DDDD
-          break;     
+          break;
        case 2: // remind function group 2 F5-F8
-          if (flags & FN_GROUP_2) 
+          if (flags & FN_GROUP_2)
               setFunctionInternal(loco,0, 176 | ((functions>>5)& 0x0F));                           // 1011 DDDD
-          break;     
+          break;
        case 3: // remind function group 3 F9-F12
-          if (flags & FN_GROUP_3) 
+          if (flags & FN_GROUP_3)
               setFunctionInternal(loco,0, 160 | ((functions>>9)& 0x0F));                           // 1010 DDDD
-          break;   
+          break;
        case 4: // remind function group 4 F13-F20
-          if (flags & FN_GROUP_4) 
-              setFunctionInternal(loco,222, ((functions>>13)& 0xFF)); 
+          if (flags & FN_GROUP_4)
+              setFunctionInternal(loco,222, ((functions>>13)& 0xFF));
           flags&= ~FN_GROUP_4;  // dont send them again
-          break;  
+          break;
        case 5: // remind function group 5 F21-F28
           if (flags & FN_GROUP_5)
-              setFunctionInternal(loco,223, ((functions>>21)& 0xFF)); 
+              setFunctionInternal(loco,223, ((functions>>21)& 0xFF));
           flags&= ~FN_GROUP_5;  // dont send them again
-          break; 
+          break;
       }
       loopStatus++;
       // if we reach status 6 then this loco is done so
-      // reset status to 0 for next loco and return true so caller 
-      // moves on to next loco. 
+      // reset status to 0 for next loco and return true so caller
+      // moves on to next loco.
       if (loopStatus>5) loopStatus=0;
       return loopStatus==0;
     }
- 
- 
+
+
 
 
 ///// Private helper functions below here /////////////////////
@@ -666,20 +668,28 @@ int DCC::lookupSpeedTable(int locoId) {
   }
   return reg;
 }
-  
+
 void  DCC::updateLocoReminder(int loco, byte speedCode) {
- 
+
   if (loco==0) {
      // broadcast stop/estop but dont change direction
      for (int reg = 0; reg < MAX_LOCOS; reg++) {
-       speedTable[reg].speedCode = (speedTable[reg].speedCode & 0x80) |  (speedCode & 0x7f);
+       if (speedTable[reg].loco==0) continue;
+       byte newspeed=(speedTable[reg].speedCode & 0x80) |  (speedCode & 0x7f);
+       if (speedTable[reg].speedCode != newspeed) {
+         speedTable[reg].speedCode = newspeed;
+         CommandDistributor::broadcastLoco(reg);
+       }
      }
-     return; 
+     return;
   }
-  
+
   // determine speed reg for this loco
-  int reg=lookupSpeedTable(loco);       
-  if (reg>=0) speedTable[reg].speedCode = speedCode;
+  int reg=lookupSpeedTable(loco);
+  if (reg>=0 && speedTable[reg].speedCode!=speedCode) {
+    speedTable[reg].speedCode = speedCode;
+    CommandDistributor::broadcastLoco(reg);
+  }
 }
 
 DCC::LOCO DCC::speedTable[MAX_LOCOS];
@@ -711,19 +721,21 @@ void  DCC::ackManagerSetup(int cv, byte byteValueOrBitnum, ackOp const program[]
     return;
   }
 
-  ackManagerRejoin=DCCWaveform::progTrackSyncMain;     
+  ackManagerRejoin=DCCWaveform::progTrackSyncMain;
   if (ackManagerRejoin ) {
         // Change from JOIN must zero resets packet.
         setProgTrackSyncMain(false);
-        DCCWaveform::progTrack.sentResetsSincePacket = 0;      
+        DCCWaveform::progTrack.sentResetsSincePacket = 0;
       }
-      
-   DCCWaveform::progTrack.autoPowerOff=false;           
+
+   DCCWaveform::progTrack.autoPowerOff=false;
    if (DCCWaveform::progTrack.getPowerMode() == POWERMODE::OFF) {
-        DCCWaveform::progTrack.autoPowerOff=true;  // power off afterwards           
+        DCCWaveform::progTrack.autoPowerOff=true;  // power off afterwards
         if (Diag::ACK) DIAG(F("Auto Prog power on"));
         DCCWaveform::progTrack.setPowerMode(POWERMODE::ON);
-        DCCWaveform::progTrack.sentResetsSincePacket = 0;      
+	if (MotorDriver::commonFaultPin)
+	  DCCWaveform::mainTrack.setPowerMode(POWERMODE::ON);
+        DCCWaveform::progTrack.sentResetsSincePacket = 0;
     }
 
   ackManagerCv = cv;
@@ -751,7 +763,7 @@ bool DCC::checkResets(uint8_t numResets) {
 void DCC::ackManagerLoop() {
   while (ackManagerProg) {
     byte opcode=GETFLASH(ackManagerProg);
-    
+
     // breaks from this switch will step to next prog entry
     // returns from this switch will stay on same entry
     // (typically waiting for a reset counter or ACK waiting, or when all finished.)
@@ -761,57 +773,57 @@ void DCC::ackManagerLoop() {
       	  if (checkResets(DCCWaveform::progTrack.autoPowerOff || ackManagerRejoin  ? 20 : 3)) return;
           DCCWaveform::progTrack.setAckBaseline();
           callbackState=READY;
-          break;   
-      case W0:    // write 0 bit 
-      case W1:    // write 1 bit 
+          break;
+      case W0:    // write 0 bit
+      case W1:    // write 1 bit
             {
 	      if (checkResets(RESET_MIN)) return;
-              if (Diag::ACK) DIAG(F("W%d cv=%d bit=%d"),opcode==W1, ackManagerCv,ackManagerBitNum); 
+              if (Diag::ACK) DIAG(F("W%d cv=%d bit=%d"),opcode==W1, ackManagerCv,ackManagerBitNum);
               byte instruction = WRITE_BIT | (opcode==W1 ? BIT_ON : BIT_OFF) | ackManagerBitNum;
               byte message[] = {cv1(BIT_MANIPULATE, ackManagerCv), cv2(ackManagerCv), instruction };
               DCCWaveform::progTrack.schedulePacket(message, sizeof(message), PROG_REPEATS);
-              DCCWaveform::progTrack.setAckPending(); 
+              DCCWaveform::progTrack.setAckPending();
              callbackState=AFTER_WRITE;
          }
-            break; 
-      
-      case WB:   // write byte 
+            break;
+
+      case WB:   // write byte
             {
 	      if (checkResets( RESET_MIN)) return;
               if (Diag::ACK) DIAG(F("WB cv=%d value=%d"),ackManagerCv,ackManagerByte);
               byte message[] = {cv1(WRITE_BYTE, ackManagerCv), cv2(ackManagerCv), ackManagerByte};
               DCCWaveform::progTrack.schedulePacket(message, sizeof(message), PROG_REPEATS);
-              DCCWaveform::progTrack.setAckPending(); 
+              DCCWaveform::progTrack.setAckPending();
               callbackState=AFTER_WRITE;
             }
             break;
-      
+
       case   VB:     // Issue validate Byte packet
         {
-	  if (checkResets( RESET_MIN)) return; 
+	  if (checkResets( RESET_MIN)) return;
           if (Diag::ACK) DIAG(F("VB cv=%d value=%d"),ackManagerCv,ackManagerByte);
           byte message[] = { cv1(VERIFY_BYTE, ackManagerCv), cv2(ackManagerCv), ackManagerByte};
           DCCWaveform::progTrack.schedulePacket(message, sizeof(message), PROG_REPEATS);
-          DCCWaveform::progTrack.setAckPending(); 
+          DCCWaveform::progTrack.setAckPending();
         }
         break;
-      
+
       case V0:
       case V1:      // Issue validate bit=0 or bit=1  packet
         {
-	  if (checkResets(RESET_MIN)) return; 
-          if (Diag::ACK) DIAG(F("V%d cv=%d bit=%d"),opcode==V1, ackManagerCv,ackManagerBitNum); 
+	  if (checkResets(RESET_MIN)) return;
+          if (Diag::ACK) DIAG(F("V%d cv=%d bit=%d"),opcode==V1, ackManagerCv,ackManagerBitNum);
           byte instruction = VERIFY_BIT | (opcode==V0?BIT_OFF:BIT_ON) | ackManagerBitNum;
           byte message[] = {cv1(BIT_MANIPULATE, ackManagerCv), cv2(ackManagerCv), instruction };
           DCCWaveform::progTrack.schedulePacket(message, sizeof(message), PROG_REPEATS);
-          DCCWaveform::progTrack.setAckPending(); 
+          DCCWaveform::progTrack.setAckPending();
         }
         break;
-      
+
       case WACK:   // wait for ack (or absence of ack)
          {
           byte ackState=2; // keep polling
-      
+
           ackState=DCCWaveform::progTrack.getAck();
           if (ackState==2) return; // keep polling
           ackReceived=ackState==1;
@@ -824,14 +836,14 @@ void DCC::ackManagerLoop() {
             return;
           }
         break;
-        
+
       case ITCB:   // If True callback(byte)
           if (ackReceived) {
             callback(ackManagerByte);
             return;
           }
         break;
-		    
+		
       case ITCBV:   // If True callback(byte) - Verify
           if (ackReceived) {
             if (ackManagerByte == ackManagerByteVerify) {
@@ -842,21 +854,21 @@ void DCC::ackManagerLoop() {
             return;
           }
         break;
-		    
+		
       case ITCB7:   // If True callback(byte & 0x7F)
           if (ackReceived) {
             callback(ackManagerByte & 0x7F);
             return;
           }
         break;
-        
+
       case NAKFAIL:   // If nack callback(-1)
           if (!ackReceived) {
             callback(-1);
             return;
           }
         break;
-        
+
       case FAIL:  // callback(-1)
            callback(-1);
            return;
@@ -867,63 +879,63 @@ void DCC::ackManagerLoop() {
 
       case STARTMERGE:
            ackManagerBitNum=7;
-           ackManagerByte=0;     
+           ackManagerByte=0;
           break;
-          
+
       case MERGE:  // Merge previous Validate zero wack response with byte value and update bit number (use for reading CV bytes)
           ackManagerByte <<= 1;
-          // ackReceived means bit is zero. 
+          // ackReceived means bit is zero.
           if (!ackReceived) ackManagerByte |= 1;
           ackManagerBitNum--;
           break;
 
       case SETBIT:
-          ackManagerProg++; 
+          ackManagerProg++;
           ackManagerBitNum=GETFLASH(ackManagerProg);
           break;
 
      case SETCV:
-          ackManagerProg++; 
+          ackManagerProg++;
           ackManagerCv=GETFLASH(ackManagerProg);
           break;
 
      case SETBYTE:
-          ackManagerProg++; 
+          ackManagerProg++;
           ackManagerByte=GETFLASH(ackManagerProg);
           break;
 
     case SETBYTEH:
           ackManagerByte=highByte(ackManagerWord);
           break;
-          
+
     case SETBYTEL:
           ackManagerByte=lowByte(ackManagerWord);
           break;
 
      case STASHLOCOID:
-          ackManagerStash=ackManagerByte;  // stash value from CV17 
+          ackManagerStash=ackManagerByte;  // stash value from CV17
           break;
-          
-     case COMBINELOCOID: 
+
+     case COMBINELOCOID:
           // ackManagerStash is  cv17, ackManagerByte is CV 18
-          callback( ackManagerByte + ((ackManagerStash - 192) << 8));
-          return;            
+          callback( LONG_ADDR_MARKER | ( ackManagerByte + ((ackManagerStash - 192) << 8)));
+          return;
 
      case ITSKIP:
-          if (!ackReceived) break; 
+          if (!ackReceived) break;
           // SKIP opcodes until SKIPTARGET found
           while (opcode!=SKIPTARGET) {
-            ackManagerProg++; 
+            ackManagerProg++;
             opcode=GETFLASH(ackManagerProg);
           }
           break;
-     case SKIPTARGET: 
-          break;     
-     default: 
+     case SKIPTARGET:
+          break;
+     default:
           DIAG(F("!! ackOp %d FAULT!!"),opcode);
           callback( -1);
-          return;        
-    
+          return;
+
       }  // end of switch
     ackManagerProg++;
   }
@@ -944,7 +956,7 @@ void DCC::callback(int value) {
     // Rule 1: If we have written to a decoder we must maintain power for 100mS
     // Rule 2: If we are re-joining the main track we must power off for 30mS
 
-    switch (callbackState) {    
+    switch (callbackState) {
        case AFTER_WRITE:  // first attempt to callback after a write operation
 	    if (!ackManagerRejoin && !DCCWaveform::progTrack.autoPowerOff) {
                callbackState=READY;
@@ -954,7 +966,7 @@ void DCC::callback(int value) {
             callbackState=WAITING_100;
             if (Diag::ACK) DIAG(F("Stable 100mS"));
             break;
-            
+
        case WAITING_100:  // waiting for 100mS
             if (millis()-callbackStart < 100) break;
             // stable after power maintained for 100mS
@@ -963,32 +975,34 @@ void DCC::callback(int value) {
             // but if we will keep the power on, we must off it for 30mS
             if (DCCWaveform::progTrack.autoPowerOff) callbackState=READY;
             else { // Need to cycle power off and on
-                DCCWaveform::progTrack.setPowerMode(POWERMODE::OFF); 
+                DCCWaveform::progTrack.setPowerMode(POWERMODE::OFF);
                 callbackStart=millis();
                 callbackState=WAITING_30;
                 if (Diag::ACK) DIAG(F("OFF 30mS"));
             }
             break;
- 
+
         case WAITING_30:  // waiting for 30mS with power off
             if (millis()-callbackStart < 30) break;
             //power has been off for 30mS
-            DCCWaveform::progTrack.setPowerMode(POWERMODE::ON); 
+            DCCWaveform::progTrack.setPowerMode(POWERMODE::ON);
             callbackState=READY;
             break;
-     
+
        case READY:  // ready after read, or write after power delay and off period.
             // power off if we powered it on
            if (DCCWaveform::progTrack.autoPowerOff) {
               if (Diag::ACK) DIAG(F("Auto Prog power off"));
               DCCWaveform::progTrack.doAutoPowerOff();
+	      if (MotorDriver::commonFaultPin)
+		DCCWaveform::mainTrack.setPowerMode(POWERMODE::OFF);
            }
           // Restore <1 JOIN> to state before BASELINE
           if (ackManagerRejoin) {
               setProgTrackSyncMain(true);
               if (Diag::ACK) DIAG(F("Auto JOIN"));
-          }  
-    
+          }
+
           ackManagerProg=NULL;  // no more steps to execute
           if (Diag::ACK) DIAG(F("Callback(%d)"),value);
           (ackManagerCallback)( value);
@@ -1001,10 +1015,10 @@ void DCC::displayCabList(Print * stream) {
     for (int reg = 0; reg < MAX_LOCOS; reg++) {
        if (speedTable[reg].loco>0) {
         used ++;
-        StringFormatter::send(stream,F("cab=%d, speed=%d, dir=%c \n"),       
+        StringFormatter::send(stream,F("cab=%d, speed=%d, dir=%c \n"),
            speedTable[reg].loco,  speedTable[reg].speedCode & 0x7f,(speedTable[reg].speedCode & 0x80) ? 'F':'R');
        }
      }
      StringFormatter::send(stream,F("Used=%d, max=%d\n"),used,MAX_LOCOS);
-     
+
 }

DCC.h

@@ -1,5 +1,10 @@
 /*
- *  © 2020, Chris Harlow. All rights reserved.
+ *  © 2021 Mike S
+ *  © 2021 Fred Decker
+ *  © 2021 Herb Morton
+ *  © 2020-2021 Harald Barth
+ *  © 2020-2021 Chris Harlow
+ *  All rights reserved.
  *  
  *  This file is part of Asbelos DCC API
  *
@@ -23,6 +28,16 @@
 #include "MotorDrivers.h"
 #include "FSH.h"
 
+#include "defines.h"
+#ifndef HIGHEST_SHORT_ADDR
+#define HIGHEST_SHORT_ADDR 127
+#else
+#if HIGHEST_SHORT_ADDR > 127
+#error short addr greater than 127 does not make sense
+#endif
+#endif
+const uint16_t LONG_ADDR_MARKER = 0x4000;
+
 typedef void (*ACK_CALLBACK)(int16_t result);
 
 enum ackOp : byte
@@ -89,8 +104,9 @@ public:
   static void writeCVBitMain(int cab, int cv, byte bNum, bool bValue);
   static void setFunction(int cab, byte fByte, byte eByte);
   static void setFn(int cab, int16_t functionNumber, bool on);
-  static int changeFn(int cab, int16_t functionNumber, bool pressed);
+  static void changeFn(int cab, int16_t functionNumber);
   static int  getFn(int cab, int16_t functionNumber);
+  static uint32_t getFunctionMap(int cab);
   static void updateGroupflags(byte &flags, int16_t functionNumber);
   static void setAccessory(int aAdd, byte aNum, bool activate);
   static bool writeTextPacket(byte *b, int nBytes);
@@ -124,7 +140,6 @@ public:
     return ackRetryPSum;
   };
 
-private:
   struct LOCO
   {
     int loco;
@@ -132,6 +147,9 @@ private:
     byte groupFlags;
     unsigned long functions;
   };
+ static LOCO speedTable[MAX_LOCOS];
+ 
+private:
   static byte joinRelay;
   static byte loopStatus;
   static void setThrottle2(uint16_t cab, uint8_t speedCode);
@@ -142,7 +160,6 @@ private:
   static FSH *shieldName;
   static byte globalSpeedsteps;
 
-  static LOCO speedTable[MAX_LOCOS];
   static byte cv1(byte opcode, int cv);
   static byte cv2(int cv);
   static int lookupSpeedTable(int locoId);

DCCEX.h

@@ -1,7 +1,8 @@
 /*
- *  (c) 2020 Chris Harlow. All rights reserved.
- *  (c) 2021 Fred Decker.  All rights reserved.
- *  (c) 2020 Harald Barth. All rights reserved.
+ *  © 2021 Fred Decker
+ *  © 2020-2021 Harald Barth
+ *  © 2020-2021 Chris Harlow
+ *  All rights reserved.
  *  
  *  This file is part of CommandStation-EX
  *
@@ -29,6 +30,7 @@
 #include "DCC.h"
 #include "DIAG.h"
 #include "DCCEXParser.h"
+#include "SerialManager.h"
 #include "version.h"
 #include "WifiInterface.h"
 #if ETHERNET_ON == true
@@ -41,7 +43,7 @@
 #include "Turnouts.h"
 #include "Sensors.h"
 #include "Outputs.h"
-#include "RMFT.h"
-
+#include "CommandDistributor.h"
+#include "EXRAIL.h"
     
 #endif

DCCEXParser.cpp

@@ -1,6 +1,12 @@
 /*
- *  © 2020, Chris Harlow. All rights reserved.
- *  © 2020, Harald Barth.
+ *  © 2021 Neil McKechnie
+ *  © 2021 Mike S
+ *  © 2021 Herb Morton
+ *  © 2020-2022 Harald Barth
+ *  © 2020-2021 M Steve Todd
+ *  © 2020-2021 Fred Decker
+ *  © 2020-2021 Chris Harlow
+ *  All rights reserved.
  *  
  *  This file is part of CommandStation-EX
  *
@@ -28,7 +34,7 @@
 #include "GITHUB_SHA.h"
 #include "version.h"
 #include "defines.h"
-
+#include "CommandDistributor.h"
 #include "EEStore.h"
 #include "DIAG.h"
 #include <avr/wdt.h>
@@ -56,7 +62,9 @@ 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;
@@ -73,15 +81,12 @@ 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;
-#ifdef HAS_ENOUGH_MEMORY
 const int16_t HASH_KEYWORD_WIFI = -5583;
 const int16_t HASH_KEYWORD_ETHERNET = -30767;
 const int16_t HASH_KEYWORD_WIT = 31594;
-#endif
 
 int16_t DCCEXParser::stashP[MAX_COMMAND_PARAMS];
 bool DCCEXParser::stashBusy;
-
 Print *DCCEXParser::stashStream = NULL;
 RingStream *DCCEXParser::stashRingStream = NULL;
 byte DCCEXParser::stashTarget=0;
@@ -92,46 +97,8 @@ byte DCCEXParser::stashTarget=0;
 // calls the corresponding DCC api.
 // Non-DCC things like turnouts, pins and sensors are handled in additional JMRI interface classes.
 
-DCCEXParser::DCCEXParser() {}
-void DCCEXParser::flush()
-{
-    if (Diag::CMD)
-        DIAG(F("Buffer flush"));
-    bufferLength = 0;
-    inCommandPayload = false;
-}
 
-void DCCEXParser::loop(Stream &stream)
-{
-    while (stream.available())
-    {
-        if (bufferLength == MAX_BUFFER)
-        {
-            flush();
-        }
-        char ch = stream.read();
-        if (ch == '<')
-        {
-            inCommandPayload = true;
-            bufferLength = 0;
-            buffer[0] = '\0';
-        }
-        else if (ch == '>')
-        {
-            buffer[bufferLength] = '\0';
-            parse(&stream, buffer, NULL); // Parse this (No ringStream for serial)
-            inCommandPayload = false;
-            break;
-        }
-        else if (inCommandPayload)
-        {
-            buffer[bufferLength++] = ch;
-        }
-    }
-    Sensor::checkAll(&stream); // Update and print changes
-}
-
-int16_t DCCEXParser::splitValues(int16_t result[MAX_COMMAND_PARAMS], const byte *cmd)
+int16_t DCCEXParser::splitValues(int16_t result[MAX_COMMAND_PARAMS], const byte *cmd, bool usehex)
 {
     byte state = 1;
     byte parameterCount = 0;
@@ -169,10 +136,15 @@ int16_t DCCEXParser::splitValues(int16_t result[MAX_COMMAND_PARAMS], const byte
         case 3: // building a parameter
             if (hot >= '0' && hot <= '9')
             {
-                runningValue = 10 * runningValue + (hot - '0');
+                runningValue = (usehex?16:10) * runningValue + (hot - '0');
                 break;
             }
             if (hot >= 'a' && hot <= 'z') hot=hot-'a'+'A'; // uppercase a..z
+            if (usehex && hot>='A' && hot<='F') {
+                // treat A..F as hex not keyword
+                runningValue = 16 * runningValue + (hot - 'A' + 10);
+                break;
+            }
             if (hot >= 'A' && hot <= 'Z')
             {
                 // Since JMRI got modified to send keywords in some rare cases, we need this
@@ -190,66 +162,6 @@ int16_t DCCEXParser::splitValues(int16_t result[MAX_COMMAND_PARAMS], const byte
     return parameterCount;
 }
 
-int16_t DCCEXParser::splitHexValues(int16_t result[MAX_COMMAND_PARAMS], const byte *cmd)
-{
-    byte state = 1;
-    byte parameterCount = 0;
-    int16_t runningValue = 0;
-    const byte *remainingCmd = cmd + 1; // skips the opcode
-    
-    // clear all parameters in case not enough found
-    for (int16_t i = 0; i < MAX_COMMAND_PARAMS; i++)
-        result[i] = 0;
-
-    while (parameterCount < MAX_COMMAND_PARAMS)
-    {
-        byte hot = *remainingCmd;
-
-        switch (state)
-        {
-
-        case 1: // skipping spaces before a param
-            if (hot == ' ')
-                break;
-            if (hot == '\0' || hot == '>')
-                return parameterCount;
-            state = 2;
-            continue;
-
-        case 2: // checking first hex digit
-            runningValue = 0;
-            state = 3;
-            continue;
-
-        case 3: // building a parameter
-            if (hot >= '0' && hot <= '9')
-            {
-                runningValue = 16 * runningValue + (hot - '0');
-                break;
-            }
-            if (hot >= 'A' && hot <= 'F')
-            {
-                runningValue = 16 * runningValue + 10 + (hot - 'A');
-                break;
-            }
-            if (hot >= 'a' && hot <= 'f')
-            {
-                runningValue = 16 * runningValue + 10 + (hot - 'a');
-                break;
-            }
-            if (hot==' ' || hot=='>' || hot=='\0') { 
-               result[parameterCount] = runningValue;
-               parameterCount++;
-               state = 1;
-               continue;
-            }
-            return -1; // invalid hex digit
-        }
-        remainingCmd++;
-    }
-    return parameterCount;
-}
-
 FILTER_CALLBACK DCCEXParser::filterCallback = 0;
 FILTER_CALLBACK DCCEXParser::filterRMFTCallback = 0;
 AT_COMMAND_CALLBACK DCCEXParser::atCommandCallback = 0;
@@ -268,6 +180,7 @@ 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; 
       char buffer[size];
       strcpy_P(buffer,(char *)cmd);
@@ -278,15 +191,17 @@ void DCCEXParser::parse(const FSH * cmd) {
 
 void DCCEXParser::parse(Print *stream, byte *com, RingStream * ringStream)
 {
+#ifndef DISABLE_EEPROM
     (void)EEPROM; // tell compiler not to warn this is unused
+#endif
     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 params = splitValues(p, com);
     byte opcode = com[0];
-
+    byte params = splitValues(p, com, opcode=='M' || opcode=='P');
+    
     if (filterCallback)
         filterCallback(stream, opcode, params, p);
     if (filterRMFTCallback && opcode!='\0')
@@ -334,10 +249,9 @@ void DCCEXParser::parse(Print *stream, byte *com, RingStream * ringStream)
             break; // invalid direction code
 
         DCC::setThrottle(cab, tspeed, direction);
-        if (params == 4)
+        if (params == 4) // send obsolete format T response
             StringFormatter::send(stream, F("<T %d %d %d>\n"), p[0], p[2], p[3]);
-        else
-            StringFormatter::send(stream, F("<O>\n"));
+        // speed change will be broadcast anyway in new <l > format
         return;
     }
     case 'f': // FUNCTION <f CAB BYTE1 [BYTE2]>
@@ -368,7 +282,7 @@ void DCCEXParser::parse(Print *stream, byte *com, RingStream * ringStream)
           || ((p[activep]  & 0x01) != p[activep]) // invalid activate 0|1
           ) break; 
           // Honour the configuration option (config.h) which allows the <a> command to be reversed
-#ifdef DCC_ACCESSORY_RCN_213
+#ifdef DCC_ACCESSORY_COMMAND_REVERSE
           DCC::setAccessory(address, subaddress,p[activep]==0);
 #else
           DCC::setAccessory(address, subaddress,p[activep]==1);
@@ -401,8 +315,8 @@ void DCCEXParser::parse(Print *stream, byte *com, RingStream * ringStream)
 
     case 'M': // WRITE TRANSPARENT DCC PACKET MAIN <M REG X1 ... X9>
     case 'P': // WRITE TRANSPARENT DCC PACKET PROG <P REG X1 ... X9>
-        // Re-parse the command using a hex-only splitter
-        params=splitHexValues(p,com)-1; // drop REG
+        // NOTE: this command was parsed in HEX instead of decimal
+        params--; // drop REG
         if (params<1) break;  
         {
           byte packet[params];
@@ -463,61 +377,70 @@ void DCCEXParser::parse(Print *stream, byte *com, RingStream * ringStream)
         }
         break;
 
-    case '1': // POWERON <1   [MAIN|PROG]>
-    case '0': // POWEROFF <0 [MAIN | PROG] >
-        if (params > 1)
-            break;
+    case '1': // POWERON <1   [MAIN|PROG|JOIN]>
         {
-            POWERMODE mode = opcode == '1' ? POWERMODE::ON : POWERMODE::OFF;
-            DCC::setProgTrackSyncMain(false); // Only <1 JOIN> will set this on, all others set it off
-            if (params == 0 ||
-		(MotorDriver::commonFaultPin && p[0] != HASH_KEYWORD_JOIN)) // commonFaultPin prevents individual track handling
-            {
-                DCCWaveform::mainTrack.setPowerMode(mode);
-                DCCWaveform::progTrack.setPowerMode(mode);
-		if (mode == POWERMODE::OFF)
-		  DCC::setProgTrackBoost(false);  // Prog track boost mode will not outlive prog track off
-                StringFormatter::send(stream, F("<p%c>\n"), opcode);
-		        LCD(2, F("p%c"), opcode);
-                return;
-            }
-            switch (p[0])
-            {
-            case HASH_KEYWORD_MAIN:
-                DCCWaveform::mainTrack.setPowerMode(mode);
-                StringFormatter::send(stream, F("<p%c MAIN>\n"), opcode);
-	            LCD(2, F("p%c MAIN"), opcode);
-                return;
-
-            case HASH_KEYWORD_PROG:
-                DCCWaveform::progTrack.setPowerMode(mode);
-		if (mode == POWERMODE::OFF)
-		  DCC::setProgTrackBoost(false);  // Prog track boost mode will not outlive prog track off
-                StringFormatter::send(stream, F("<p%c PROG>\n"), opcode);
-		        LCD(2, F("p%c PROG"), opcode);
-                return;
-            case HASH_KEYWORD_JOIN:
-                DCCWaveform::mainTrack.setPowerMode(mode);
-                DCCWaveform::progTrack.setPowerMode(mode);
-                if (mode == POWERMODE::ON)
-                {
-                    DCC::setProgTrackSyncMain(true);
-                    StringFormatter::send(stream, F("<p1 JOIN>\n"), opcode);
-		            LCD(2, F("p1 JOIN"));
-                }
-                else
-		        {
-                    StringFormatter::send(stream, F("<p0>\n"));
-		            LCD(2, F("p0"));
-	    	    }
-                return;
-            }
-            break;
+        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;
+	  }
+	  else if (p[0]==HASH_KEYWORD_MAIN) { // <1 MAIN>
+            main=true;
+	  }
+	  else if (p[0]==HASH_KEYWORD_PROG) { // <1 PROG>
+            prog=true;
+	  }
+	  else break; // will reply <X>
+	}
+        if (main) DCCWaveform::mainTrack.setPowerMode(POWERMODE::ON);
+        if (prog) DCCWaveform::progTrack.setPowerMode(POWERMODE::ON);
+        DCC::setProgTrackSyncMain(join);
+
+        CommandDistributor::broadcastPower();
         return;
+        }
+
+    case '0': // POWEROFF <0 [MAIN | PROG] >
+        {
+        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;
+	  }
+	  else if (p[0]==HASH_KEYWORD_PROG) { // <0 PROG>
+	    prog=true;
+	  }
+	  else break; // will reply <X>
+	}
+
+        if (main) DCCWaveform::mainTrack.setPowerMode(POWERMODE::OFF);
+        if (prog) {
+            DCC::setProgTrackBoost(false);  // Prog track boost mode will not outlive prog track off
+            DCCWaveform::progTrack.setPowerMode(POWERMODE::OFF);
+        }
+        DCC::setProgTrackSyncMain(false);
+
+        CommandDistributor::broadcastPower();
+        return;
+        }
 
     case '!': // ESTOP ALL  <!>
-        DCC::setThrottle(0,1,1); // this broadcasts speed 1(estop) and sets all reminders to speed 1. 
+        DCC::setThrottle(0,1,1); // this broadcasts speed 1(estop) and sets all reminders to speed 1.
         return;
 
     case 'c': // SEND METER RESPONSES <c>
@@ -540,6 +463,7 @@ void DCCEXParser::parse(Print *stream, byte *com, RingStream * ringStream)
         // TODO Send stats of  speed reminders table
         return;       
 
+#ifndef DISABLE_EEPROM
     case 'E': // STORE EPROM <E>
         EEStore::store();
         StringFormatter::send(stream, F("<e %d %d %d>\n"), EEStore::eeStore->data.nTurnouts, EEStore::eeStore->data.nSensors, EEStore::eeStore->data.nOutputs);
@@ -549,7 +473,7 @@ void DCCEXParser::parse(Print *stream, byte *com, RingStream * ringStream)
         EEStore::clear();
         StringFormatter::send(stream, F("<O>\n"));
         return;
-
+#endif
     case ' ': // < >
         StringFormatter::send(stream, F("\n"));
         return;
@@ -570,16 +494,17 @@ void DCCEXParser::parse(Print *stream, byte *com, RingStream * ringStream)
         return;
 
     case 'F': // New command to call the new Loco Function API <F cab func 1|0>
+        if(params!=3) break; 
         if (Diag::CMD)
             DIAG(F("Setting loco %d F%d %S"), p[0], p[1], p[2] ? F("ON") : F("OFF"));
         DCC::setFn(p[0], p[1], p[2] == 1);
         return;
 
     case '+': // Complex Wifi interface command (not usual parse)
-        if (atCommandCallback) {
+        if (atCommandCallback && !ringStream) {
           DCCWaveform::mainTrack.setPowerMode(POWERMODE::OFF);
           DCCWaveform::progTrack.setPowerMode(POWERMODE::OFF);
-          atCommandCallback(com);
+          atCommandCallback((HardwareSerial *)stream,com);
           return;
         }
         break;
@@ -723,9 +648,7 @@ bool DCCEXParser::parseT(Print *stream, int16_t params, int16_t p[])
           }
           if (!Turnout::setClosed(p[0], state)) return false;
 
-          // Send acknowledgement to caller if the command was not received over Serial
-          // (acknowledgement messages on Serial are sent by the Turnout class).
-          if (stream != &Serial) Turnout::printState(p[0], stream);
+
           return true;
         }
 
@@ -818,10 +741,10 @@ bool DCCEXParser::parseD(Print *stream, int16_t params, int16_t p[])
 	      LCD(1, F("Ack Limit=%dmA"), p[2]);  // <D ACK LIMIT 42>
 	    } else if (p[1] == HASH_KEYWORD_MIN) {
 	      DCCWaveform::progTrack.setMinAckPulseDuration(p[2]);
-	      LCD(0, F("Ack Min=%dus"), p[2]);  //   <D ACK MIN 1500>
+	      LCD(0, F("Ack Min=%uus"), p[2]);  //   <D ACK MIN 1500>
 	    } else if (p[1] == HASH_KEYWORD_MAX) {
 	      DCCWaveform::progTrack.setMaxAckPulseDuration(p[2]);
-	      LCD(0, F("Ack Max=%dus"), p[2]);  //   <D ACK MAX 9000>
+	      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], DCC::setAckRetry(p[2]));  //   <D ACK RETRY 2>
@@ -864,11 +787,13 @@ bool DCCEXParser::parseD(Print *stream, int16_t params, int16_t p[])
           delay(50);            // wait for the prescaller time to expire          
           break; // and <X> if we didnt restart 
         }
-        
+
+#ifndef DISABLE_EEPROM
     case HASH_KEYWORD_EEPROM: // <D EEPROM NumEntries>
 	if (params >= 2)
 	    EEStore::dump(p[1]);
 	return true;
+#endif
 
     case HASH_KEYWORD_SPEED28:
         DCC::setGlobalSpeedsteps(28);
@@ -958,10 +883,21 @@ void DCCEXParser::callback_R(int16_t result)
     commitAsyncReplyStream();
 }
 
-void DCCEXParser::callback_Rloco(int16_t result)
-{
-    StringFormatter::send(getAsyncReplyStream(), F("<r %d>\n"), result);
-    commitAsyncReplyStream();
+void DCCEXParser::callback_Rloco(int16_t result) {
+  const FSH * detail;
+  if (result<=0) {
+    detail=F("<r %d>\n");
+  } else {
+    bool longAddr=result & LONG_ADDR_MARKER;        //long addr
+    if (longAddr)
+      result = result^LONG_ADDR_MARKER;
+    if (longAddr && result <= HIGHEST_SHORT_ADDR)
+      detail=F("<r LONG %d UNSUPPORTED>\n");
+    else
+      detail=F("<r %d>\n");
+  }
+  StringFormatter::send(getAsyncReplyStream(), detail, result);
+  commitAsyncReplyStream();
 }
 
 void DCCEXParser::callback_Wloco(int16_t result)

DCCEXParser.h

@@ -1,5 +1,8 @@
 /*
- *  © 2020, Chris Harlow. All rights reserved.
+ *  © 2021 Mike S
+ *  © 2021 Fred Decker
+ *  © 2020-2021 Chris Harlow
+ *  All rights reserved.
  *  
  *  This file is part of Asbelos DCC API
  *
@@ -23,15 +26,13 @@
 #include "RingStream.h"
 
 typedef void (*FILTER_CALLBACK)(Print * stream, byte & opcode, byte & paramCount, int16_t p[]);
-typedef void (*AT_COMMAND_CALLBACK)(const byte * command);
+typedef void (*AT_COMMAND_CALLBACK)(HardwareSerial * stream,const byte * command);
 
 struct DCCEXParser
 {
-   DCCEXParser();
-   void loop(Stream & stream);
-   void parse(Print * stream,  byte * command,  RingStream * ringStream);
-   void parse(const FSH * cmd);
-   void flush();
+   
+   static void parse(Print * stream,  byte * command,  RingStream * ringStream);
+   static void parse(const FSH * cmd);
    static void setFilter(FILTER_CALLBACK filter);
    static void setRMFTFilter(FILTER_CALLBACK filter);
    static void setAtCommandCallback(AT_COMMAND_CALLBACK filter);
@@ -40,17 +41,13 @@ struct DCCEXParser
    private:
   
     static const int16_t MAX_BUFFER=50;  // longest command sent in
-     byte  bufferLength=0;
-     bool  inCommandPayload=false;
-     byte  buffer[MAX_BUFFER+2]; 
-    int16_t splitValues( int16_t result[MAX_COMMAND_PARAMS], const byte * command);
-    int16_t splitHexValues( int16_t result[MAX_COMMAND_PARAMS], const byte * command);
+    static int16_t splitValues( int16_t result[MAX_COMMAND_PARAMS], const byte * command, bool usehex);
      
-     bool parseT(Print * stream, int16_t params, int16_t p[]);
-     bool parseZ(Print * stream, int16_t params, int16_t p[]);
-     bool parseS(Print * stream,  int16_t params, int16_t p[]);
-     bool parsef(Print * stream,  int16_t params, int16_t p[]);
-     bool parseD(Print * stream,  int16_t params, int16_t p[]);
+    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 parseD(Print * stream,  int16_t params, int16_t p[]);
 
      static Print * getAsyncReplyStream();
      static void commitAsyncReplyStream();
@@ -61,7 +58,7 @@ struct DCCEXParser
     static RingStream * stashRingStream;
     
     static int16_t stashP[MAX_COMMAND_PARAMS];
-    bool stashCallback(Print * stream, int16_t p[MAX_COMMAND_PARAMS], RingStream * ringStream);
+    static bool stashCallback(Print * stream, int16_t p[MAX_COMMAND_PARAMS], RingStream * ringStream);
     static void callback_W(int16_t result);
     static void callback_B(int16_t result);        
     static void callback_R(int16_t result);

DCCTimer.cpp

@@ -1,5 +1,10 @@
 /*
- *  © 2021, Chris Harlow & David Cutting. All rights reserved.
+ *  © 2021 Mike S
+ *  © 2021 Harald Barth
+ *  © 2021 Fred Decker
+ *  © 2021 Chris Harlow
+ *  © 2021 David Cutting
+ *  All rights reserved.
  *  
  *  This file is part of Asbelos DCC API
  *

DCCTimer.h

@@ -1,6 +1,8 @@
 /*
- *  (c) 2021 Mike S. All rights reserved.
- *  (c) 2021 Fred Decker.  All rights reserved.
+ *  © 2021 Mike S
+ *  © 2021 Harald Barth
+ *  © 2021 Fred Decker
+ *  All rights reserved.
  *  
  *  This file is part of CommandStation-EX
  *

DCCWaveform.cpp

@@ -1,8 +1,12 @@
 /*
- *  © 2020, Chris Harlow. All rights reserved.
- *  © 2020, Harald Barth.
+ *  © 2021 Neil McKechnie
+ *  © 2021 Mike S
+ *  © 2021 Fred Decker
+ *  © 2020-2021 Harald Barth
+ *  © 2020-2021 Chris Harlow
+ *  All rights reserved.
  *  
- *  This file is part of Asbelos DCC API
+ *  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
@@ -285,7 +289,7 @@ void DCCWaveform::setAckBaseline() {
       if (isMainTrack) return;
       int baseline=motorDriver->getCurrentRaw();
       ackThreshold= baseline + motorDriver->mA2raw(ackLimitmA);
-      if (Diag::ACK) DIAG(F("ACK baseline=%d/%dmA Threshold=%d/%dmA Duration between %dus and %dus"),
+      if (Diag::ACK) DIAG(F("ACK baseline=%d/%dmA Threshold=%d/%dmA Duration between %uus and %uus"),
 			  baseline,motorDriver->raw2mA(baseline),
 			  ackThreshold,motorDriver->raw2mA(ackThreshold),
                           minAckPulseDuration, maxAckPulseDuration);
@@ -305,7 +309,7 @@ void DCCWaveform::setAckPending() {
 
 byte DCCWaveform::getAck() {
       if (ackPending) return (2);  // still waiting
-      if (Diag::ACK) DIAG(F("%S after %dmS max=%d/%dmA pulse=%duS samples=%d gaps=%d"),ackDetected?F("ACK"):F("NO-ACK"), ackCheckDuration,
+      if (Diag::ACK) DIAG(F("%S after %dmS max=%d/%dmA pulse=%uuS samples=%d gaps=%d"),ackDetected?F("ACK"):F("NO-ACK"), ackCheckDuration,
 			  ackMaxCurrent,motorDriver->raw2mA(ackMaxCurrent), ackPulseDuration, numAckSamples, numAckGaps);
       if (ackDetected) return (1); // Yes we had an ack
       return(0);  // pending set off but not detected means no ACK.   

DCCWaveform.h

@@ -1,8 +1,12 @@
 /*
- *  © 2020, Chris Harlow. All rights reserved.
- *  © 2020, Harald Barth.
+ *  © 2021 M Steve Todd
+ *  © 2021 Mike S
+ *  © 2021 Fred Decker
+ *  © 2020-2021 Harald Barth
+ *  © 2020-2021 Chris Harlow
+ *  All rights reserved.
  *  
- *  This file is part of Asbelos DCC API
+ *  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

DIAG.h

@@ -1,7 +1,9 @@
 /*
- *  © 2020, Chris Harlow. All rights reserved.
+ *  © 2021 Fred Decker
+ *  © 2020 Chris Harlow
+ *  All rights reserved.
  *  
- *  This file is part of Asbelos DCC API
+ *  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

DisplayInterface.cpp

@@ -1,5 +1,7 @@
 /*
- *  © 2021, Chris Harlow, Neil McKechnie. All rights reserved.
+ *  © 2021 Neil McKechnie
+ *  © 2021 Chris Harlow
+ *  All rights reserved.
  *
  *  This file is part of CommandStation-EX
  *
@@ -19,4 +21,4 @@
 
 #include "DisplayInterface.h"
 
-DisplayInterface *DisplayInterface::lcdDisplay = 0;
+DisplayInterface *DisplayInterface::lcdDisplay = 0;

DisplayInterface.h

@@ -1,5 +1,7 @@
 /*
- *  © 2021, Chris Harlow, Neil McKechnie. All rights reserved.
+ *  © 2021 Neil McKechnie
+ *  © 2021 Chris Harlow
+ *  All rights reserved.
  *
  *  This file is part of CommandStation-EX
  *
@@ -32,4 +34,4 @@ public:
   static DisplayInterface *lcdDisplay;
 };
 
-#endif
+#endif

EEStore.cpp

@@ -1,9 +1,12 @@
 /*
+ *  © 2021 Neil McKechnie
+ *  © 2021 Fred Decker
+ *  © 2020-2021 Harald Barth
+ *  © 2020-2021 Chris Harlow
  *  © 2013-2016 Gregg E. Berman
- *  © 2020, Chris Harlow. All rights reserved.
- *  © 2020, Harald Barth.
+ *  All rights reserved.
  *
- *  This file is part of Asbelos DCC API
+ *  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
@@ -18,6 +21,9 @@
  *  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"
+#ifndef DISABLE_EEPROM
 #include "EEStore.h"
 
 #include "DIAG.h"
@@ -103,3 +109,4 @@ void EEStore::dump(int num) {
 
 EEStore *EEStore::eeStore = NULL;
 int EEStore::eeAddress = 0;
+#endif

EEStore.h

@@ -1,6 +1,9 @@
 /*
- *  (c) 2020 Chris Harlow. All rights reserved.
- *  (c) 2020 Harald Barth. All rights reserved.
+ *  © 2021 Neil McKechnie
+ *  © 2021 Fred Decker
+ *  © 2020-2021 Harald Barth
+ *  © 2020 Chris Harlow
+ *  All rights reserved.
  *  
  *  This file is part of CommandStation-EX
  *
@@ -17,6 +20,7 @@
  *  You should have received a copy of the GNU General Public License
  *  along with CommandStation.  If not, see <https://www.gnu.org/licenses/>.
  */
+#ifndef DISABLE_EEPROM
 #ifndef EEStore_h
 #define EEStore_h
 
@@ -52,3 +56,4 @@ struct EEStore{
 };
 
 #endif
+#endif // DISABLE_EEPROM

EXRAIL.h

@@ -1,8 +1,8 @@
-#ifndef RMFT_H
-#define RMFT_H
+#ifndef EXRAIL_H
+#define EXRAIL_H
 
-#if defined(RMFT_ACTIVE)
- #include "RMFT2.h"
+#if defined(EXRAIL_ACTIVE)
+ #include "EXRAIL2.h"
 
   class RMFT {
     public:
@@ -10,7 +10,7 @@
       static void inline loop() {RMFT2::loop();}
   };
 
-  #include "RMFTMacros.h"
+  #include "EXRAILMacros.h"
   
 #else 
   // Dummy RMFT 

EXRAIL2.cpp

@@ -0,0 +1,990 @@
+/*
+ *  © 2021 Neil McKechnie
+ *  © 2021-2022 Harald Barth
+ *  © 2020-2022 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/>.
+ */
+
+/* EXRAILPlus planned FEATURE additions
+   F1. [DONE] DCC accessory packet opcodes (short and long form)
+   F2. [DONE] ONAccessory catchers 
+   F3. [DONE] Turnout descriptions for Withrottle
+   F4. Oled announcements (depends on HAL)
+   F5. Withrottle roster info
+   F6. Multi-occupancy semaphore
+   F7. [DONE see AUTOSTART] Self starting sequences
+   F8. Park/unpark
+   F9.  [DONE] Analog drive
+   F10. [DONE] Alias anywhere
+   F11. [DONE]EXRAIL/ENDEXRAIL unnecessary
+   F12. [DONE] Allow guarded code (as effect of ALIAS anywhere)
+   F13. [DONE] IFGTE/IFLT function  
+  */
+/* EXRAILPlus planned TRANSPARENT additions
+   T1. [DONE] RAM based fast lookup for sequences ON* event catchers and signals.
+   T2. Extend to >64k
+  */
+
+
+#include <Arduino.h>
+#include "EXRAIL2.h"
+#include "DCC.h"
+#include "DCCWaveform.h"
+#include "DIAG.h"
+#include "WiThrottle.h"
+#include "DCCEXParser.h"
+#include "Turnouts.h"
+#include "CommandDistributor.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_ROUTES=-3702;
+
+// 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.
+// The threads exist in a ring, each time through loop() the next thread in the ring is serviced.
+
+// Statics 
+const int16_t LOCO_ID_WAITING=-99; // waiting for loco id from prog track
+int16_t RMFT2::progtrackLocoId;  // used for callback when detecting a loco on prog track
+bool RMFT2::diag=false;      // <D EXRAIL ON>  
+RMFT2 * RMFT2::loopTask=NULL; // loopTask contains the address of ONE of the tasks in a ring.
+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];
+
+LookList *  RMFT2::sequenceLookup=NULL;
+LookList *  RMFT2::onThrowLookup=NULL;
+LookList *  RMFT2::onCloseLookup=NULL;
+LookList *  RMFT2::onActivateLookup=NULL;
+LookList *  RMFT2::onDeactivateLookup=NULL;
+
+#define GET_OPCODE GETFLASH(RMFT2::RouteCode+progCounter)
+#define GET_OPERAND(n) GETFLASHW(RMFT2::RouteCode+progCounter+1+(n*3))
+#define SKIPOP progCounter+=3
+
+
+LookList::LookList(int16_t size) {
+  m_size=size;
+  m_loaded=0;
+  if (size) {
+    m_lookupArray=new int16_t[size];
+    m_resultArray=new int16_t[size];
+  }
+}
+
+void LookList::add(int16_t lookup, int16_t result) {
+  if (m_loaded==m_size) return; // and forget
+  m_lookupArray[m_loaded]=lookup;
+  m_resultArray[m_loaded]=result;
+  m_loaded++;
+}
+
+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 -1;
+}
+
+/* static */ void RMFT2::begin() {
+  DCCEXParser::setRMFTFilter(RMFT2::ComandFilter);
+  for (int f=0;f<MAX_FLAGS;f++) flags[f]=0;
+  int progCounter;
+
+  // counters to create lookup arrays
+  int sequenceCount=0; // to allow for seq 0 at start
+  int onThrowCount=0;
+  int onCloseCount=0;
+  int onActivateCount=0;
+  int onDeactivateCount=0;
+
+  // first pass count sizes for fast lookup arrays
+  for (progCounter=0;; SKIPOP) {
+    byte opcode=GET_OPCODE;
+    if (opcode==OPCODE_ENDEXRAIL) break;
+    switch (opcode) {
+    case OPCODE_ROUTE:
+    case OPCODE_AUTOMATION:
+    case OPCODE_SEQUENCE:
+      sequenceCount++;
+      break;
+
+    case OPCODE_ONTHROW:
+      onThrowCount++;
+      break;
+      
+    case OPCODE_ONCLOSE:
+      onCloseCount++;
+      break;
+      
+    case OPCODE_ONACTIVATE:
+      onActivateCount++;
+      break;
+
+    case OPCODE_ONDEACTIVATE:
+      onDeactivateCount++;
+      break;
+
+    default: // Ignore
+      break;
+    }
+  }
+
+  // create lookups
+  sequenceLookup=new LookList(sequenceCount);
+  onThrowLookup=new LookList(onThrowCount);
+  onCloseLookup=new LookList(onCloseCount);
+  onActivateLookup=new LookList(onActivateCount);
+  onDeactivateLookup=new LookList(onDeactivateCount);
+
+  // Second pass startup, define any turnouts or servos, set signals red
+  // add sequences onRoutines to the lookups
+  for (int sigpos=0;;sigpos+=3) {
+    VPIN redpin=GETFLASHW(RMFT2::SignalDefinitions+sigpos);
+    if (redpin==0) break;  // end of signal list
+    VPIN amberpin=GETFLASHW(RMFT2::SignalDefinitions+sigpos+1);
+    VPIN greenpin=GETFLASHW(RMFT2::SignalDefinitions+sigpos+2);
+    IODevice::write(redpin,true);
+    if (amberpin) IODevice::write(amberpin,false);
+    IODevice::write(greenpin,false);
+  }
+
+  for (progCounter=0;; SKIPOP){
+    byte opcode=GET_OPCODE;
+    if (opcode==OPCODE_ENDEXRAIL) break;
+    VPIN operand=GET_OPERAND(0);
+    
+    switch (opcode) {
+    case OPCODE_AT:
+    case OPCODE_AFTER:
+    case OPCODE_IF:
+    case OPCODE_IFNOT: {
+      int16_t pin = (int16_t)operand;
+      if (pin<0) pin = -pin;
+      IODevice::configureInput((VPIN)pin,true);
+      break;
+    }
+
+    case OPCODE_TURNOUT: {
+      VPIN id=operand;
+      int addr=GET_OPERAND(1);
+      byte subAddr=GET_OPERAND(2);
+      DCCTurnout::create(id,addr,subAddr);
+      break;
+    }
+
+    case OPCODE_SERVOTURNOUT: {
+      VPIN id=operand;
+      VPIN pin=GET_OPERAND(1);
+      int activeAngle=GET_OPERAND(2);
+      int inactiveAngle=GET_OPERAND(3);
+      int profile=GET_OPERAND(4);
+      ServoTurnout::create(id,pin,activeAngle,inactiveAngle,profile);
+      break;
+    }
+
+    case OPCODE_PINTURNOUT: {
+      VPIN id=operand;
+      VPIN pin=GET_OPERAND(1);
+      VpinTurnout::create(id,pin);
+      break;
+    }
+      
+    case OPCODE_ROUTE:
+    case OPCODE_AUTOMATION:
+    case OPCODE_SEQUENCE:
+      sequenceLookup->add(operand,progCounter);
+      break;
+      
+    case OPCODE_ONTHROW:
+      onThrowLookup->add(operand,progCounter);
+      break;
+      
+    case OPCODE_ONCLOSE:
+      onCloseLookup->add(operand,progCounter);
+      break;
+      
+    case OPCODE_ONACTIVATE:
+      onActivateLookup->add(operand,progCounter);
+      break;
+      
+    case OPCODE_ONDEACTIVATE:
+      onDeactivateLookup->add(operand,progCounter);
+      break;
+      
+    case OPCODE_AUTOSTART:
+      // automatically create a task from here at startup.
+      new RMFT2(progCounter);
+      break;
+      
+    default: // Ignore
+      break;
+    }
+  }
+  SKIPOP; // include ENDROUTES opcode
+
+  DIAG(F("EXRAIL %db, fl=%d seq=%d, onT=%d, onC=%d"),
+        progCounter,MAX_FLAGS,
+        sequenceCount, onThrowCount, onCloseCount);
+
+  new RMFT2(0); // add the startup route
+}
+
+// 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) { // 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"));
+      }
+    }
+    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;
+    
+  case HASH_KEYWORD_ROUTES: // </ ROUTES > JMRI withrottle support
+    if (paramCount>1) return false;
+    StringFormatter::send(stream,F("</ROUTES "));
+    emitWithrottleRouteList(stream);
+    StringFormatter::send(stream,F(">"));
+    return true;
+    
+  default:
+    break;
+  }
+  
+  // all other / commands take 1 parameter 0 to MAX_FLAGS-1
+  
+  if (paramCount!=2 || p[1]<0  || p[1]>=MAX_FLAGS) return false;
+  
+  switch (p[0]) {
+  case HASH_KEYWORD_KILL: // Kill taskid
+    {
+      RMFT2 * task=loopTask;
+      while(task) {
+	if (task->taskId==p[1]) {
+	  delete task;
+	  return  true;
+	}
+	task=task->next;
+	if (task==loopTask) break;
+      }
+    }
+    return false;
+    
+  case HASH_KEYWORD_RESERVE:  // force reserve a section
+    setFlag(p[1],SECTION_FLAG);
+    return true;
+    
+  case HASH_KEYWORD_FREE:  // force free a section
+    setFlag(p[1],0,SECTION_FLAG);
+    return true;
+    
+  case HASH_KEYWORD_LATCH:
+    setFlag(p[1], LATCH_FLAG);
+    return true;
+    
+  case HASH_KEYWORD_UNLATCH:
+    setFlag(p[1], 0, LATCH_FLAG);
+    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.
+void RMFT2::emitWithrottleRouteList(Print* stream) {
+   StringFormatter::send(stream,F("PRT]\\[Routes}|{Route]\\[Set}|{2]\\[Handoff}|{4\nPRL"));
+   emitWithrottleDescriptions(stream);
+   StringFormatter::send(stream,F("\n"));
+}
+
+
+RMFT2::RMFT2(int progCtr) {
+  progCounter=progCtr;
+
+  // get an unused  task id from the flags table
+  taskId=255; // in case of overflow
+  for (int f=0;f<MAX_FLAGS;f++) {
+    if (!getFlag(f,TASK_FLAG)) {
+      taskId=f;
+      setFlag(f, TASK_FLAG);
+      break;
+    }
+  }
+  delayTime=0;
+  loco=0;
+  speedo=0;
+  forward=true;
+  invert=false;
+  timeoutFlag=false;
+  stackDepth=0;
+  onTurnoutId=0; // Not handling an ONTHROW/ONCLOSE
+
+  // chain into ring of RMFTs
+  if (loopTask==NULL) {
+    loopTask=this;
+    next=this;
+  } else {
+    next=loopTask->next;
+    loopTask->next=this;
+  }
+}
+
+
+RMFT2::~RMFT2() {
+  driveLoco(1); // ESTOP my loco if any
+  setFlag(taskId,0,TASK_FLAG); // we are no longer using this id
+  if (next==this)
+    loopTask=NULL;
+  else
+    for (RMFT2* ring=next;;ring=ring->next)
+      if (ring->next == this) {
+	ring->next=next;
+	loopTask=next;
+	break;
+      }
+}
+
+void RMFT2::createNewTask(int route, uint16_t cab) {
+      int pc=sequenceLookup->find(route);
+      if (pc<0) return;
+      RMFT2* task=new RMFT2(pc);
+      task->loco=cab;
+}
+
+void RMFT2::driveLoco(byte speed) {
+  if (loco<=0) return;  // Prevent broadcast!
+  if (diag) DIAG(F("EXRAIL drive %d %d %d"),loco,speed,forward^invert);
+  if (DCCWaveform::mainTrack.getPowerMode()==POWERMODE::OFF) {
+    DCCWaveform::mainTrack.setPowerMode(POWERMODE::ON);
+    CommandDistributor::broadcastPower();
+  }
+  DCC::setThrottle(loco,speed, forward^invert);
+  speedo=speed;
+}
+
+bool RMFT2::readSensor(uint16_t sensorId) {
+  // Exrail operands are unsigned but we need the signed version as inserted by the macros.
+  int16_t sId=(int16_t) sensorId;
+
+  VPIN vpin=abs(sId);
+  if (getFlag(vpin,LATCH_FLAG)) return true; // latched on
+  
+  // negative sensorIds invert the logic (e.g. for a break-beam sensor which goes OFF when detecting)
+  bool s= IODevice::read(vpin) ^ (sId<0);
+  if (s && diag) DIAG(F("EXRAIL Sensor %d hit"),sId);
+  return s;
+}
+
+// This skips to the end of an if block, or to the ELSE within it.
+bool RMFT2::skipIfBlock() {
+  // returns false if killed
+  short nest = 1;
+  while (nest > 0) {
+    SKIPOP;
+    byte opcode =  GET_OPCODE;
+    switch(opcode) {
+    case OPCODE_ENDEXRAIL:
+      kill(F("missing ENDIF"), nest);
+      return false;
+    case OPCODE_IF:
+    case OPCODE_IFCLOSED:
+    case OPCODE_IFGTE:
+    case OPCODE_IFLT:
+    case OPCODE_IFNOT:
+    case OPCODE_IFRANDOM:
+    case OPCODE_IFRESERVE:
+    case OPCODE_IFTHROWN:
+    case OPCODE_IFTIMEOUT:
+      nest++;
+      break;
+    case OPCODE_ENDIF:
+      nest--;
+      break;
+    case OPCODE_ELSE:
+      // if nest==1 then this is the ELSE for the IF we are skipping
+      if (nest==1) nest=0; // cause loop exit and return after ELSE
+      break;
+    default:
+      break;
+    }
+  }
+  return true;
+}
+
+
+
+/* static */ void RMFT2::readLocoCallback(int16_t cv) {
+  progtrackLocoId=cv;
+}
+
+void RMFT2::loop() {
+
+  // Round Robin call to a RMFT task each time
+  if (loopTask==NULL) return;
+  loopTask=loopTask->next;
+  if (pausingTask==NULL || pausingTask==loopTask) loopTask->loop2();
+}
+
+
+void RMFT2::loop2() {
+  if (delayTime!=0 && millis()-delayStart < delayTime) return;
+
+  byte opcode = GET_OPCODE;
+  int16_t operand =  GET_OPERAND(0);
+  // if (diag) DIAG(F("RMFT2 %d %d"),opcode,operand);
+  // Attention: Returning from this switch leaves the program counter unchanged.
+  //            This is used for unfinished waits for timers or sensors.
+  //            Breaking from this switch will step to the next step in the route.
+  switch ((OPCODE)opcode) {
+
+  case OPCODE_THROW:
+    Turnout::setClosed(operand, false);
+    break;
+    
+  case OPCODE_CLOSE:
+    Turnout::setClosed(operand, true);
+    break;
+
+  case OPCODE_REV:
+    forward = false;
+    driveLoco(operand);
+    break;
+    
+  case OPCODE_FWD:
+      forward = true;
+      driveLoco(operand);
+      break;
+      
+  case OPCODE_SPEED:
+    driveLoco(operand);
+    break;
+    
+  case OPCODE_INVERT_DIRECTION:
+    invert= !invert;
+    driveLoco(speedo);
+    break;
+    
+  case OPCODE_RESERVE:
+    if (getFlag(operand,SECTION_FLAG)) {
+      driveLoco(0);
+      delayMe(500);
+      return;
+    }
+    setFlag(operand,SECTION_FLAG);
+    break;
+    
+  case OPCODE_FREE:
+    setFlag(operand,0,SECTION_FLAG);
+    break;
+    
+  case OPCODE_AT:
+    timeoutFlag=false;
+    if (readSensor(operand)) break;
+    delayMe(50);
+    return;
+    
+  case OPCODE_ATTIMEOUT1:   // ATTIMEOUT(vpin,timeout) part 1
+    timeoutStart=millis();
+    timeoutFlag=false;
+    break;
+    
+  case OPCODE_ATTIMEOUT2:
+    if (readSensor(operand)) break; // success without timeout
+    if (millis()-timeoutStart > 100*GET_OPERAND(1)) {
+      timeoutFlag=true;
+      break; // and drop through
+    }
+    delayMe(50);
+    return;
+    
+  case OPCODE_IFTIMEOUT: // do next operand if timeout flag set
+    if (!timeoutFlag) if (!skipIfBlock()) return;
+    break;
+    
+  case OPCODE_AFTER: // waits for sensor to hit and then remain off for 0.5 seconds. (must come after an AT operation)
+    if (readSensor(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;
+    
+  case OPCODE_UNLATCH:
+    setFlag(operand,0,LATCH_FLAG);
+    break;
+
+  case OPCODE_SET:
+    IODevice::write(operand,true);
+    break;
+    
+  case OPCODE_RESET:
+    IODevice::write(operand,false);
+    break;
+    
+  case OPCODE_PAUSE:
+    DCC::setThrottle(0,1,true);  // pause all locos on the track
+    pausingTask=this;
+    break;
+    
+  case OPCODE_POM:
+    if (loco) DCC::writeCVByteMain(loco, operand, GET_OPERAND(1));
+    break;
+    
+  case OPCODE_POWEROFF:
+    DCCWaveform::mainTrack.setPowerMode(POWERMODE::OFF);
+    DCCWaveform::progTrack.setPowerMode(POWERMODE::OFF);
+    DCC::setProgTrackSyncMain(false);
+    CommandDistributor::broadcastPower();
+    break;
+    
+  case OPCODE_RESUME:
+    pausingTask=NULL;
+    driveLoco(speedo);
+    for (RMFT2 * t=next; t!=this;t=t->next) if (t->loco >0) t->driveLoco(t->speedo);
+    break;
+    
+  case OPCODE_IF: // do next operand if sensor set
+    if (!readSensor(operand)) if (!skipIfBlock()) return;
+    break;
+    
+  case OPCODE_ELSE: // skip to matching ENDIF
+    if (!skipIfBlock()) return;
+    break;
+    
+  case OPCODE_IFGTE: // do next operand if sensor>= value
+    if (IODevice::readAnalogue(operand)<(int)(GET_OPERAND(1))) if (!skipIfBlock()) return;
+    break;
+    
+  case OPCODE_IFLT: // do next operand if sensor< value
+    if (IODevice::readAnalogue(operand)>=(int)(GET_OPERAND(1))) if (!skipIfBlock()) return;
+    break;
+    
+  case OPCODE_IFNOT: // do next operand if sensor not set
+    if (readSensor(operand)) if (!skipIfBlock()) return;
+    break;
+    
+  case OPCODE_IFRANDOM: // do block on random percentage
+    if ((int16_t)random(100)>=operand) if (!skipIfBlock()) return;
+    break;
+    
+  case OPCODE_IFRESERVE: // do block if we successfully RERSERVE
+    if (!getFlag(operand,SECTION_FLAG)) setFlag(operand,SECTION_FLAG);
+    else if (!skipIfBlock()) return;
+    break;
+    
+  case OPCODE_IFTHROWN:
+    if (Turnout::isClosed(operand)) if (!skipIfBlock()) return;
+    break;
+    
+  case OPCODE_IFCLOSED:
+    if (!Turnout::isClosed(operand)) if (!skipIfBlock()) return;
+    break;
+    
+  case OPCODE_ENDIF:
+    break;
+    
+  case OPCODE_DELAYMS:
+    delayMe(operand);
+    break;
+    
+  case OPCODE_DELAY:
+    delayMe(operand*100L);
+    break;
+    
+  case OPCODE_DELAYMINS:
+    delayMe(operand*60L*1000L);
+    break;
+    
+  case OPCODE_RANDWAIT:
+    delayMe(random(operand)*100L);
+    break;
+    
+  case OPCODE_RED:
+    doSignal(operand,true,false,false);
+    break;
+    
+  case OPCODE_AMBER:
+    doSignal(operand,false,true,false);
+    break;
+    
+  case OPCODE_GREEN:
+    doSignal(operand,false,false,true);
+    break;
+    
+  case OPCODE_FON:
+    if (loco) DCC::setFn(loco,operand,true);
+    break;
+
+  case OPCODE_FOFF:
+    if (loco) DCC::setFn(loco,operand,false);
+    break;
+    
+  case OPCODE_DRIVE:
+    {
+      byte analogSpeed=IODevice::readAnalogue(operand) *127 / 1024;
+      if (speedo!=analogSpeed) driveLoco(analogSpeed);
+      break;
+    }
+    
+  case OPCODE_XFON:
+    DCC::setFn(operand,GET_OPERAND(1),true);
+    break;
+    
+  case OPCODE_XFOFF:
+    DCC::setFn(operand,GET_OPERAND(1),false);
+    break;
+    
+  case OPCODE_DCCACTIVATE: {
+    // operand is address<<3 | subaddr<<1 | active
+    int16_t addr=operand>>3;
+    int16_t subaddr=(operand>>1) & 0x03;
+    bool active=operand & 0x01;
+    DCC::setAccessory(addr,subaddr,active);
+    break;
+  }
+    
+  case OPCODE_FOLLOW:
+    progCounter=sequenceLookup->find(operand);
+    if (progCounter<0) kill(F("FOLLOW unknown"), operand);
+    return;
+    
+  case OPCODE_CALL:
+    if (stackDepth==MAX_STACK_DEPTH) {
+      kill(F("CALL stack"), stackDepth);
+      return;
+    }
+    callStack[stackDepth++]=progCounter+3;
+    progCounter=sequenceLookup->find(operand);
+    if (progCounter<0) kill(F("CALL unknown"),operand);
+    return;
+    
+  case OPCODE_RETURN:
+    if (stackDepth==0) {
+      kill(F("RETURN stack"));
+      return;
+    }
+    progCounter=callStack[--stackDepth];
+    return;
+    
+  case OPCODE_ENDTASK:
+  case OPCODE_ENDEXRAIL:
+    kill();
+    return;
+    
+  case OPCODE_JOIN:
+    DCCWaveform::mainTrack.setPowerMode(POWERMODE::ON);
+    DCCWaveform::progTrack.setPowerMode(POWERMODE::ON);
+    DCC::setProgTrackSyncMain(true);
+    CommandDistributor::broadcastPower();
+    break;
+  
+  case OPCODE_POWERON:
+    DCCWaveform::mainTrack.setPowerMode(POWERMODE::ON);
+    DCC::setProgTrackSyncMain(false);
+    CommandDistributor::broadcastPower();
+    break;
+    
+  case OPCODE_UNJOIN:
+    DCC::setProgTrackSyncMain(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);
+    break;
+    
+  case OPCODE_READ_LOCO2:
+    if (progtrackLocoId==LOCO_ID_WAITING) {
+      delayMe(100);
+      return; // still waiting for callback
+    }
+    if (progtrackLocoId<0) {
+      kill(F("No Loco Found"),progtrackLocoId);
+      return; // still waiting for callback
+    }
+    
+    loco=progtrackLocoId;
+    speedo=0;
+    forward=true;
+    invert=false;
+    break;
+    
+  case OPCODE_START:
+    {
+      int newPc=sequenceLookup->find(operand);
+      if (newPc<0) break;
+      new RMFT2(newPc);
+    }
+    break;
+    
+  case OPCODE_SENDLOCO:  // cab, route
+    {
+      int newPc=sequenceLookup->find(GET_OPERAND(1));
+      if (newPc<0) break;
+      RMFT2* newtask=new RMFT2(newPc); // create new task
+      newtask->loco=operand;
+    }
+    break;
+    
+  case OPCODE_SETLOCO:
+    {
+      loco=operand;
+      speedo=0;
+      forward=true;
+      invert=false;
+    }
+    break;
+    
+    
+  case OPCODE_SERVO: // OPCODE_SERVO,V(vpin),OPCODE_PAD,V(position),OPCODE_PAD,V(profile),OPCODE_PAD,V(duration)
+    IODevice::writeAnalogue(operand,GET_OPERAND(1),GET_OPERAND(2),GET_OPERAND(3));
+    break;
+    
+  case OPCODE_WAITFOR: // OPCODE_SERVO,V(pin)
+    if (IODevice::isBusy(operand)) {
+      delayMe(100);
+      return;
+    }
+    break;
+    
+  case OPCODE_PRINT:
+    printMessage(operand);
+    break;
+    
+  case OPCODE_ROUTE:
+  case OPCODE_AUTOMATION:
+  case OPCODE_SEQUENCE:
+    if (diag) DIAG(F("EXRAIL begin(%d)"),operand);
+    break;
+    
+  case OPCODE_AUTOSTART: // Handled only during begin process
+  case OPCODE_PAD: // Just a padding for previous opcode needing >1 operand byte.
+  case OPCODE_TURNOUT: // Turnout definition ignored at runtime
+  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_ONTHROW:
+  case OPCODE_ONACTIVATE: // Activate event catchers ignored here
+  case OPCODE_ONDEACTIVATE:
+    break;
+    
+  default:
+    kill(F("INVOP"),operand);
+  }
+  // Falling out of the switch means move on to the next opcode
+  SKIPOP;
+}
+
+void RMFT2::delayMe(long delay) {
+  delayTime=delay;
+  delayStart=millis();
+}
+
+void RMFT2::setFlag(VPIN id,byte onMask, byte offMask) {
+   if (FLAGOVERFLOW(id)) return; // Outside range limit
+   byte f=flags[id];
+   f &= ~offMask;
+   f |= onMask;
+   flags[id]=f;
+}
+
+bool RMFT2::getFlag(VPIN id,byte mask) {
+  if (FLAGOVERFLOW(id)) return 0; // Outside range limit
+  return flags[id]&mask;
+}
+
+void RMFT2::kill(const FSH * reason, int operand) {
+  if (reason) DIAG(F("EXRAIL ERROR pc=%d, cab=%d, %S %d"), progCounter,loco, reason, operand);
+  else if (diag) DIAG(F("ENDTASK at pc=%d"), progCounter);
+  delete this;
+}
+
+/* static */ void RMFT2::doSignal(VPIN id,bool red, bool amber, bool green) {
+  //if (diag) DIAG(F(" dosignal %d"),id);
+  for (int sigpos=0;;sigpos+=3) {
+    VPIN redpin=GETFLASHW(RMFT2::SignalDefinitions+sigpos);
+    //if (diag) DIAG(F("red=%d"),redpin);
+    if (redpin==0) {
+      DIAG(F("EXRAIL Signal %d not defined"), id);
+      return;  // signal not found
+    }
+    if (redpin==id) {
+      VPIN amberpin=GETFLASHW(RMFT2::SignalDefinitions+sigpos+1);
+      VPIN greenpin=GETFLASHW(RMFT2::SignalDefinitions+sigpos+2);
+      //if (diag) DIAG(F("signal %d %d %d"),redpin,amberpin,greenpin);
+      // If amberpin is zero, synthesise amber from red+green
+      IODevice::write(redpin,red || (amber && (amberpin==0)));
+      if (amberpin) IODevice::write(amberpin,amber);
+      if (greenpin) IODevice::write(greenpin,green || (amber && (amberpin==0)));
+      return;
+    }
+  }
+}
+
+void RMFT2::turnoutEvent(int16_t turnoutId, bool closed) {
+  // Hunt for an ONTHROW/ONCLOSE for this turnout
+  int pc= (closed?onCloseLookup:onThrowLookup)->find(turnoutId);
+  if (pc<0) return;
+  
+  // Check we dont already have a task running this turnout
+  RMFT2 * task=loopTask;
+  while(task) {
+    if (task->onTurnoutId==turnoutId) {
+      DIAG(F("Recursive ONTHROW/ONCLOSE for Turnout %d"),turnoutId);
+      return;
+    }
+    task=task->next;
+    if (task==loopTask) break;
+  }
+  
+  task=new RMFT2(pc);  // new task starts at this instruction
+  task->onTurnoutId=turnoutId; // flag for recursion detector
+}
+
+void RMFT2::activateEvent(int16_t addr, bool activate) {
+  // Hunt for an ONACTIVATE/ONDEACTIVATE for this accessory
+  int pc= (activate?onActivateLookup:onDeactivateLookup)->find(addr);
+  if (pc<0) return;
+  
+  // Check we dont already have a task running this address
+  RMFT2 * task=loopTask;
+  while(task) {
+    if (task->onActivateAddr==addr) {
+      DIAG(F("Recursive ON(DE)ACTIVATE for  %d"),addr);
+      return;
+    }
+    task=task->next;
+    if (task==loopTask) break;
+  }
+  
+  task->onActivateAddr=addr; // flag for recursion detector
+  task=new RMFT2(pc);  // new task starts at this instruction
+}
+
+void RMFT2::printMessage2(const FSH * msg) {
+  DIAG(F("EXRAIL(%d) %S"),loco,msg);
+}
+
+// This is called by emitRouteDescriptions to emit a withrottle description for a route or autoomation.
+void RMFT2::emitRouteDescription(Print * stream, char type, int id, const FSH * description) {
+  StringFormatter::send(stream,F("]\\[%c%d}|{%S}|{%c"),
+			type,id,description, type=='R'?'2':'4');
+}

EXRAIL2.h

@@ -1,5 +1,7 @@
 /*
- *  © 2020, Chris Harlow. All rights reserved.
+ *  © 2021 Neil McKechnie
+ *  © 2020-2022 Chris Harlow
+ *  All rights reserved.
  *  
  *  This file is part of CommandStation-EX
  *
@@ -16,13 +18,13 @@
  *  You should have received a copy of the GNU General Public License
  *  along with CommandStation.  If not, see <https://www.gnu.org/licenses/>.
  */
-#ifndef RMFT2_H
-#define RMFT2_H
+#ifndef EXRAIL2_H
+#define EXRAIL2_H
 #include "FSH.h"
 #include "IODevice.h"
    
 // The following are the operation codes (or instructions) for a kind of virtual machine.
-// Each instruction is normally 2 bytes long with an operation code followed by a parameter.
+// Each instruction is normally 3 bytes long with an operation code followed by a parameter.
 // In cases where more than one parameter is required, the first parameter is followed by one  
 // or more OPCODE_PAD instructions with the subsequent parameters. This wastes a byte but makes 
 // searching easier as a parameter can never be confused with an opcode. 
@@ -30,34 +32,52 @@
 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_AT,OPCODE_AFTER,OPCODE_AUTOSTART,
+             OPCODE_ATTIMEOUT1,OPCODE_ATTIMEOUT2,OPCODE_IFTIMEOUT,
              OPCODE_LATCH,OPCODE_UNLATCH,OPCODE_SET,OPCODE_RESET,
              OPCODE_IF,OPCODE_IFNOT,OPCODE_ENDIF,OPCODE_IFRANDOM,OPCODE_IFRESERVE,
-             OPCODE_DELAY,OPCODE_DELAYMINS,OPCODE_RANDWAIT,
+             OPCODE_IFCLOSED, OPCODE_IFTHROWN,OPCODE_ELSE,
+             OPCODE_DELAY,OPCODE_DELAYMINS,OPCODE_DELAYMS,OPCODE_RANDWAIT,
              OPCODE_FON,OPCODE_FOFF,OPCODE_XFON,OPCODE_XFOFF,
-             OPCODE_RED,OPCODE_GREEN,OPCODE_AMBER,
+             OPCODE_RED,OPCODE_GREEN,OPCODE_AMBER,OPCODE_DRIVE,
              OPCODE_SERVO,OPCODE_SIGNAL,OPCODE_TURNOUT,OPCODE_WAITFOR,
              OPCODE_PAD,OPCODE_FOLLOW,OPCODE_CALL,OPCODE_RETURN,
              OPCODE_JOIN,OPCODE_UNJOIN,OPCODE_READ_LOCO1,OPCODE_READ_LOCO2,OPCODE_POM,
              OPCODE_START,OPCODE_SETLOCO,OPCODE_SENDLOCO,
-             OPCODE_PAUSE, OPCODE_RESUME,OPCODE_POWEROFF,
+             OPCODE_PAUSE, OPCODE_RESUME,OPCODE_POWEROFF,OPCODE_POWERON,
              OPCODE_ONCLOSE, OPCODE_ONTHROW, OPCODE_SERVOTURNOUT, OPCODE_PINTURNOUT,
-             OPCODE_PRINT,
+             OPCODE_PRINT,OPCODE_DCCACTIVATE,
+             OPCODE_ONACTIVATE,OPCODE_ONDEACTIVATE,OPCODE_IFGTE,OPCODE_IFLT,
+             OPCODE_ROSTER,
              OPCODE_ROUTE,OPCODE_AUTOMATION,OPCODE_SEQUENCE,OPCODE_ENDTASK,OPCODE_ENDEXRAIL
              };
 
 
  
   // Flag bits for status of hardware and TPL
-  static const byte SECTION_FLAG = 0x01;
-  static const byte LATCH_FLAG = 0x02;
-  static const byte TASK_FLAG = 0x04;
+  static const byte SECTION_FLAG = 0x80;
+  static const byte LATCH_FLAG = 0x40;
+  static const byte TASK_FLAG = 0x20;
+  static const byte SPARE_FLAG = 0x10;
+  static const byte COUNTER_MASK= 0x0F;
 
   static const byte  MAX_STACK_DEPTH=4;
  
    static const short MAX_FLAGS=256;
   #define FLAGOVERFLOW(x) x>=MAX_FLAGS
 
+class LookList {
+  public: 
+    LookList(int16_t size);
+    void add(int16_t lookup, int16_t result);
+    int16_t find(int16_t value);
+  private:
+     int16_t m_size;
+     int16_t m_loaded;
+     int16_t * m_lookupArray;
+     int16_t * m_resultArray;     
+};
+
  class RMFT2 {
    public:
     static void begin();
@@ -69,13 +89,17 @@ enum OPCODE : byte {OPCODE_THROW,OPCODE_CLOSE,
     static void emitWithrottleRouteList(Print* stream); 
     static void createNewTask(int route, uint16_t cab);
     static void turnoutEvent(int16_t id, bool closed);  
+    static void activateEvent(int16_t addr, bool active);
+    static void emitTurnoutDescription(Print* stream,int16_t id);
+    static const byte rosterNameCount;
+    static void emitWithrottleRoster(Print * stream);
+    static const FSH * getRosterFunctions(int16_t cabid);  
 private: 
     static void ComandFilter(Print * stream, byte & opcode, byte & paramCount, int16_t p[]);
     static bool parseSlash(Print * stream, byte & paramCount, int16_t p[]) ;
     static void streamFlags(Print* stream);
     static void setFlag(VPIN id,byte onMask, byte OffMask=0);
-    static bool getFlag(VPIN id,byte mask);   
-    static int locateRouteStart(int16_t _route);
+    static bool getFlag(VPIN id,byte mask); 
     static int16_t progtrackLocoId;
     static void doSignal(VPIN id,bool red, bool amber, bool green); 
     static void emitRouteDescription(Print * stream, char type, int id, const FSH * description);
@@ -92,18 +116,28 @@ private:
     void kill(const FSH * reason=NULL,int operand=0);          
     void printMessage(uint16_t id);  // Built by RMFTMacros.h
     void printMessage2(const FSH * msg);
-
+    
     
    static bool diag;
    static const  FLASH  byte RouteCode[];
+   static const  FLASH  int16_t SignalDefinitions[];
    static byte flags[MAX_FLAGS];
- 
+   static LookList * sequenceLookup;
+   static LookList * onThrowLookup;
+   static LookList * onCloseLookup;
+   static LookList * onActivateLookup;
+   static LookList * onDeactivateLookup;
+
   // Local variables - exist for each instance/task 
     RMFT2 *next;   // loop chain 
     int progCounter;    // Byte offset of next route opcode in ROUTES table
     unsigned long delayStart; // Used by opcodes that must be recalled before completing
-    unsigned long waitAfter; // Used by OPCODE_AFTER
     unsigned long  delayTime;
+    union {
+      unsigned long waitAfter; // Used by OPCODE_AFTER
+      unsigned long timeoutStart; // Used by OPCODE_ATTIMEOUT
+    };
+    bool timeoutFlag;
     byte  taskId;
     
     uint16_t loco;
@@ -111,6 +145,7 @@ private:
     bool invert;
     byte speedo;
     int16_t onTurnoutId;
+    int16_t onActivateAddr;
     byte stackDepth;
     int callStack[MAX_STACK_DEPTH];
 };

EXRAIL2MacroReset.h

@@ -0,0 +1,206 @@
+/*
+ *  © 2021-2022 Chris Harlow
+ *  © 2020,2021 Chris Harlow. All rights reserved.
+ *  
+ *  This file is part of CommandStation-EX
+ *
+ *  This is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  It is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with CommandStation.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+// This file cleans and resets the RMFT2 Macros.
+// It is used between passes to reduce complexity in RMFT2Macros.h
+// DO NOT add an include guard to this file.
+
+// Undefine all RMFT macros
+#undef ACTIVATE
+#undef ACTIVATEL
+#undef AFTER
+#undef ALIAS
+#undef AMBER
+#undef AT
+#undef ATTIMEOUT
+#undef AUTOMATION 
+#undef AUTOSTART
+#undef BROADCAST
+#undef CALL 
+#undef CLOSE 
+#undef DEACTIVATE
+#undef DEACTIVATEL
+#undef DELAY
+#undef DELAYMINS
+#undef DELAYRANDOM 
+#undef DONE
+#undef DRIVE
+#undef ELSE
+#undef ENDEXRAIL 
+#undef ENDIF  
+#undef ENDTASK
+#undef ESTOP 
+#undef EXRAIL  
+#undef FADE
+#undef FOFF
+#undef FOLLOW 
+#undef FON 
+#undef FREE 
+#undef FWD 
+#undef GREEN
+#undef IF 
+#undef IFCLOSED
+#undef IFGTE
+#undef IFLT
+#undef IFNOT
+#undef IFRANDOM 
+#undef IFRESERVE
+#undef IFTHROWN
+#undef IFTIMEOUT
+#undef INVERT_DIRECTION 
+#undef JOIN 
+#undef LATCH 
+#undef LCD 
+#undef LCN 
+#undef ONACTIVATE
+#undef ONACTIVATEL
+#undef ONDEACTIVATE
+#undef ONDEACTIVATEL 
+#undef ONCLOSE
+#undef ONTHROW 
+#undef PAUSE
+#undef PIN_TURNOUT 
+#undef PRINT
+#undef POM
+#undef POWEROFF
+#undef POWERON
+#undef READ_LOCO 
+#undef RED 
+#undef RESERVE 
+#undef RESET 
+#undef RESUME 
+#undef RETURN 
+#undef REV
+#undef ROSTER 
+#undef ROUTE
+#undef SENDLOCO 
+#undef SEQUENCE 
+#undef SERIAL 
+#undef SERIAL1 
+#undef SERIAL2 
+#undef SERIAL3 
+#undef SERVO 
+#undef SERVO2 
+#undef SERVO_TURNOUT 
+#undef SET
+#undef SETLOCO 
+#undef SIGNAL 
+#undef SPEED 
+#undef START 
+#undef STOP 
+#undef THROW  
+#undef TURNOUT 
+#undef UNJOIN
+#undef UNLATCH 
+#undef WAITFOR
+#undef XFOFF
+#undef XFON
+
+#ifndef RMFT2_UNDEF_ONLY
+#define ACTIVATE(addr,subaddr)
+#define ACTIVATEL(addr)
+#define AFTER(sensor_id)
+#define ALIAS(name,value)
+#define AMBER(signal_id)
+#define AT(sensor_id)
+#define ATTIMEOUT(sensor_id,timeout_ms)
+#define AUTOMATION(id, description) 
+#define AUTOSTART
+#define BROADCAST(msg)
+#define CALL(route) 
+#define CLOSE(id) 
+#define DEACTIVATE(addr,subaddr)
+#define DEACTIVATEL(addr)
+#define DELAY(mindelay)
+#define DELAYMINS(mindelay)
+#define DELAYRANDOM(mindelay,maxdelay) 
+#define DONE
+#define DRIVE(analogpin)
+#define ELSE
+#define ENDEXRAIL 
+#define ENDIF  
+#define ENDTASK
+#define ESTOP 
+#define EXRAIL  
+#define FADE(pin,value,ms)
+#define FOFF(func)
+#define FOLLOW(route) 
+#define FON(func) 
+#define FREE(blockid) 
+#define FWD(speed) 
+#define GREEN(signal_id)
+#define IF(sensor_id) 
+#define IFCLOSED(turnout_id) 
+#define IFGTE(sensor_id,value) 
+#define IFLT(sensor_id,value) 
+#define IFNOT(sensor_id)
+#define IFRANDOM(percent)
+#define IFTHROWN(turnout_id) 
+#define IFRESERVE(block)
+#define IFTIMEOUT
+#define INVERT_DIRECTION 
+#define JOIN 
+#define LATCH(sensor_id) 
+#define LCD(row,msg) 
+#define LCN(msg) 
+#define ONACTIVATE(addr,subaddr)
+#define ONACTIVATEL(linear)
+#define ONDEACTIVATE(addr,subaddr)
+#define ONDEACTIVATEL(linear) 
+#define ONCLOSE(turnout_id)
+#define ONTHROW(turnout_id) 
+#define PAUSE
+#define PIN_TURNOUT(id,pin,description...) 
+#define PRINT(msg) 
+#define POM(cv,value)
+#define POWEROFF
+#define POWERON
+#define READ_LOCO 
+#define RED(signal_id) 
+#define RESERVE(blockid) 
+#define RESET(pin) 
+#define RESUME 
+#define RETURN 
+#define REV(speed) 
+#define ROUTE(id, description)
+#define ROSTER(cab,name,funcmap...)
+#define SENDLOCO(cab,route) 
+#define SEQUENCE(id) 
+#define SERIAL(msg) 
+#define SERIAL1(msg) 
+#define SERIAL2(msg) 
+#define SERIAL3(msg) 
+#define SERVO(id,position,profile) 
+#define SERVO2(id,position,duration) 
+#define SERVO_TURNOUT(id,pin,activeAngle,inactiveAngle,profile,description...) 
+#define SET(pin) 
+#define SETLOCO(loco) 
+#define SIGNAL(redpin,amberpin,greenpin) 
+#define SPEED(speed) 
+#define START(route) 
+#define STOP 
+#define THROW(id)  
+#define TURNOUT(id,addr,subaddr,description...) 
+#define UNJOIN 
+#define UNLATCH(sensor_id) 
+#define WAITFOR(pin)
+#define XFOFF(cab,func)
+#define XFON(cab,func)
+#endif

EXRAILMacros.h

@@ -1,5 +1,7 @@
 /*
- *  © 2020,2021 Chris Harlow. All rights reserved.
+ *  © 2021 Neil McKechnie
+ *  © 2020-2022 Chris Harlow
+ *  All rights reserved.
  *  
  *  This file is part of CommandStation-EX
  *
@@ -16,8 +18,9 @@
  *  You should have received a copy of the GNU General Public License
  *  along with CommandStation.  If not, see <https://www.gnu.org/licenses/>.
  */
-#ifndef RMFTMacros_H
-#define RMFTMacros_H
+
+#ifndef EXRAILMacros_H
+#define EXRAILMacros_H
 
 // remove normal code LCD & SERIAL macros (will be restored later)
 #undef LCD
@@ -25,7 +28,7 @@
 
 
 // This file will include and build the EXRAIL script and associated helper tricks.
-// It does this by incliding myAutomation.h several times, each with a set of macros to 
+// It does this by including myAutomation.h several times, each with a set of macros to 
 // extract the relevant parts.
 
 // The entire automation script is contained within a byte array RMFT2::RouteCode[]
@@ -46,207 +49,145 @@
 
 // CAUTION: The macros below are multiple passed over myAutomation.h
 
-// Pass 1 Implements aliases and 
-// converts descriptions to  withrottle format emitter function
-// Most macros are simply ignored in this pass.
-
-
-#define ALIAS(name,value) const int name=value; 
-#define EXRAIL  void  RMFT2::emitWithrottleDescriptions(Print * stream) {(void)stream;
-#define ROUTE(id, description) emitRouteDescription(stream,'R',id,F(description));
-#define AUTOMATION(id, description) emitRouteDescription(stream,'A',id,F(description));
-#define ENDEXRAIL  }
- 
-#define AFTER(sensor_id)
-#define AMBER(signal_id)
-#define AT(sensor_id)
-#define CALL(route) 
-#define CLOSE(id) 
-#define DELAY(mindelay)
-#define DELAYMINS(mindelay)
-#define DELAYRANDOM(mindelay,maxdelay) 
-#define DONE
-#define ENDIF  
-#define ENDTASK
-#define ESTOP 
-#define FADE(pin,value,ms)
-#define FOFF(func)
-#define FOLLOW(route) 
-#define FON(func) 
-#define FREE(blockid) 
-#define FWD(speed) 
-#define GREEN(signal_id)
-#define IF(sensor_id) 
-#define IFNOT(sensor_id)
-#define IFRANDOM(percent) 
-#define IFRESERVE(block)
-#define INVERT_DIRECTION 
-#define JOIN 
-#define LATCH(sensor_id) 
-#define LCD(row,msg) 
-#define LCN(msg) 
-#define ONCLOSE(turnout_id)
-#define ONTHROW(turnout_id) 
-#define PAUSE
-#define PRINT(msg) 
-#define POM(cv,value)
-#define POWEROFF
-#define READ_LOCO 
-#define RED(signal_id) 
-#define RESERVE(blockid) 
-#define RESET(pin) 
-#define RESUME 
-#define RETURN 
-#define REV(speed) 
-#define START(route) 
-#define SENDLOCO(cab,route) 
-#define SERIAL(msg) 
-#define SERIAL1(msg) 
-#define SERIAL2(msg) 
-#define SERIAL3(msg) 
-#define SERVO(id,position,profile) 
-#define SERVO2(id,position,duration) 
-#define SETLOCO(loco) 
-#define SET(pin) 
-#define SEQUENCE(id) 
-#define SPEED(speed) 
-#define STOP 
-#undef SIGNAL
-#define SIGNAL(redpin,amberpin,greenpin) 
-#define SERVO_TURNOUT(id,pin,activeAngle,inactiveAngle,profile) 
-#define PIN_TURNOUT(id,pin) 
-#define THROW(id)  
-#define TURNOUT(id,addr,subaddr) 
-#define UNJOIN 
-#define UNLATCH(sensor_id) 
-#define WAITFOR(pin)
-#define XFOFF(cab,func)
-#define XFON(cab,func)
-
-#include "myAutomation.h"
-
-// setup for pass 2... Create getMessageText function
+// Pass 1 Implements aliases 
+#include "EXRAIL2MacroReset.h"
 #undef ALIAS
-#undef ROUTE
-#undef AUTOMATION  
-#define ROUTE(id, description)
-#define AUTOMATION(id, description)  
-
-#undef EXRAIL 
-#undef PRINT
-#undef LCN
-#undef SERIAL
-#undef SERIAL1
-#undef SERIAL2
-#undef SERIAL3
-#undef ENDEXRAIL  
-#undef LCD
-const int StringMacroTracker1=__COUNTER__;
-#define ALIAS(name,value) 
-#define EXRAIL void  RMFT2::printMessage(uint16_t id) { switch(id) {
-#define ENDEXRAIL  default: DIAG(F("printMessage error %d %d"),id,StringMacroTracker1); return ; }}
-#define PRINT(msg)    case (__COUNTER__ - StringMacroTracker1) : printMessage2(F(msg));break;
-#define LCN(msg)      case (__COUNTER__ - StringMacroTracker1) : StringFormatter::send(&LCN_SERIAL,F(msg));break;
-#define SERIAL(msg)   case (__COUNTER__ - StringMacroTracker1) : StringFormatter::send(&Serial,F(msg));break;
-#define SERIAL1(msg)  case (__COUNTER__ - StringMacroTracker1) : StringFormatter::send(&Serial1,F(msg));break;
-#define SERIAL2(msg)  case (__COUNTER__ - StringMacroTracker1) : StringFormatter::send(&Serial2,F(msg));break;
-#define SERIAL3(msg)  case (__COUNTER__ - StringMacroTracker1) : StringFormatter::send(&Serial3,F(msg));break;
-#define LCD(id,msg)   case (__COUNTER__ - StringMacroTracker1) : StringFormatter::lcd(id,F(msg));break;
+#define ALIAS(name,value) const int name=value; 
 #include "myAutomation.h"
 
-// Setup for Pass 3: create main routes table 
-#undef AFTER
-#undef AMBER
-#undef AT
-#undef AUTOMATION 
-#undef CALL
-#undef CLOSE
-#undef DELAY
-#undef DELAYMINS
-#undef DELAYRANDOM
-#undef DONE
-#undef ENDIF
-#undef ENDEXRAIL
-#undef ENDTASK
-#undef ESTOP
-#undef EXRAIL
-#undef FOFF
-#undef FOLLOW
-#undef FON
-#undef FREE
-#undef FWD
-#undef GREEN
-#undef IF
-#undef IFNOT
-#undef IFRANDOM
-#undef IFRESERVE
-#undef INVERT_DIRECTION
-#undef JOIN
-#undef LATCH
-#undef LCD
-#undef LCN
-#undef ONCLOSE
-#undef ONTHROW
-#undef PAUSE
-#undef POM
-#undef POWEROFF
+// Pass 2 convert descriptions to  withrottle format emitter function
+#include "EXRAIL2MacroReset.h"
+#undef ROUTE
+#define ROUTE(id, description) emitRouteDescription(stream,'R',id,F(description));
+#undef AUTOMATION
+#define AUTOMATION(id, description) emitRouteDescription(stream,'A',id,F(description));
+void  RMFT2::emitWithrottleDescriptions(Print * stream) {
+   (void)stream;
+    #include "myAutomation.h"
+}
+
+// Pass 3... Create Text sending functions
+#include "EXRAIL2MacroReset.h"
+const int StringMacroTracker1=__COUNTER__;
+#undef BROADCAST
+#define BROADCAST(msg) case (__COUNTER__ - StringMacroTracker1) : CommandDistributor::broadcastText(F(msg));break;
 #undef PRINT
-#undef READ_LOCO
-#undef RED
-#undef RESERVE
-#undef RESET
-#undef RESUME
-#undef RETURN
-#undef REV
-#undef ROUTE 
-#undef START
-#undef SEQUENCE 
-#undef SERVO
-#undef SERVO2
-#undef FADE
-#undef SENDLOCO
+#define PRINT(msg)    case (__COUNTER__ - StringMacroTracker1) : printMessage2(F(msg));break;
+#undef LCN
+#define LCN(msg)      case (__COUNTER__ - StringMacroTracker1) : StringFormatter::send(&LCN_SERIAL,F(msg));break;
 #undef SERIAL
+#define SERIAL(msg)   case (__COUNTER__ - StringMacroTracker1) : StringFormatter::send(&Serial,F(msg));break;
 #undef SERIAL1
+#define SERIAL1(msg)  case (__COUNTER__ - StringMacroTracker1) : StringFormatter::send(&Serial1,F(msg));break;
 #undef SERIAL2
+#define SERIAL2(msg)  case (__COUNTER__ - StringMacroTracker1) : StringFormatter::send(&Serial2,F(msg));break;
 #undef SERIAL3
-#undef SETLOCO
-#undef SET
-#undef SPEED
-#undef STOP
-#undef SIGNAL
-#undef SERVO_TURNOUT
-#undef PIN_TURNOUT
-#undef THROW
+#define SERIAL3(msg)  case (__COUNTER__ - StringMacroTracker1) : StringFormatter::send(&Serial3,F(msg));break;
+#undef LCD
+#define LCD(id,msg)   case (__COUNTER__ - StringMacroTracker1) : StringFormatter::lcd(id,F(msg));break;
+
+void  RMFT2::printMessage(uint16_t id) { 
+  switch(id) {
+    #include "myAutomation.h"
+    default: break ; 
+  }
+}
+
+
+// Pass 4: Turnout descriptions (optional)
+#include "EXRAIL2MacroReset.h"
 #undef TURNOUT
-#undef UNJOIN
-#undef UNLATCH
-#undef WAITFOR
-#undef XFOFF
-#undef XFON
+#define TURNOUT(id,addr,subaddr,description...) case id: desc=F("" description); break;
+#undef PIN_TURNOUT
+#define PIN_TURNOUT(id,pin,description...) case id: desc=F("" description); break;
+#undef SERVO_TURNOUT
+#define SERVO_TURNOUT(id,pin,activeAngle,inactiveAngle,profile,description...) case id: desc=F("" description); break;
 
+void RMFT2::emitTurnoutDescription(Print* stream,int16_t turnoutid) {
+     const FSH * desc=F("");
+     switch (turnoutid) {
+        #include "myAutomation.h"
+     default: break;
+     }
+     if (GETFLASH(desc)=='\0') desc=F("%d");
+     StringFormatter::send(stream,desc,turnoutid);    
+}
+
+// Pass 5: Roster names (count)
+#include "EXRAIL2MacroReset.h"
+#undef ROSTER
+#define ROSTER(cabid,name,funcmap...) +1
+
+const byte RMFT2::rosterNameCount=0
+        #include "myAutomation.h"
+     ;
+
+// Pass 6: Roster names emitter
+#include "EXRAIL2MacroReset.h"
+#undef ROSTER
+#define ROSTER(cabid,name,funcmap...) StringFormatter::send(stream,(FSH *)format,F(name),cabid,cabid<128?'S':'L');
+void RMFT2::emitWithrottleRoster(Print * stream) {
+        static const char format[] FLASH ="]\\[%S}|{%d}|{%c";
+        (void)format;
+        StringFormatter::send(stream,F("RL%d"), rosterNameCount);
+        #include "myAutomation.h"
+        stream->write('\n');        
+}
+
+// Pass 7: functions getter
+#include "EXRAIL2MacroReset.h"
+#undef ROSTER
+#define ROSTER(cabid,name,funcmap...) case cabid: return F("" funcmap);
+const FSH *  RMFT2::getRosterFunctions(int16_t cabid) {
+   switch(cabid) {
+      #include "myAutomation.h"
+      default: return NULL;
+   }        
+}
+
+// Pass 8 Signal definitions
+#include "EXRAIL2MacroReset.h"
+#undef SIGNAL
+#define SIGNAL(redpin,amberpin,greenpin) redpin,amberpin,greenpin, 
+const  FLASH  int16_t RMFT2::SignalDefinitions[] = {
+    #include "myAutomation.h"
+    0,0,0 };
+
+// Last Pass : create main routes table
+// Only undef the macros, not dummy them.  
+#define  RMFT2_UNDEF_ONLY
+#include "EXRAIL2MacroReset.h"
+// Define internal helper macros.
+// Everything we generate here has to be compile-time evaluated to 
+// a constant.  
+#define V(val) (byte)(((int16_t)(val))&0x00FF),(byte)(((int16_t)(val)>>8)&0x00FF)
 // Define macros for route code creation 
-#define V(val) ((int16_t)(val))&0x00FF,((int16_t)(val)>>8)&0x00FF
-#define NOP 0,0
 
-#define ALIAS(name,value) 
-#define EXRAIL const  FLASH  byte RMFT2::RouteCode[] = {
-#define AUTOMATION(id, description)  OPCODE_AUTOMATION, V(id), 
-#define ROUTE(id, description)  OPCODE_ROUTE, V(id), 
-#define SEQUENCE(id)  OPCODE_SEQUENCE, V(id), 
-#define ENDTASK OPCODE_ENDTASK,NOP,
-#define DONE OPCODE_ENDTASK,NOP,
-#define ENDEXRAIL OPCODE_ENDTASK,NOP,OPCODE_ENDEXRAIL,NOP };
- 
+#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 ALIAS(name,value) 
 #define AMBER(signal_id) OPCODE_AMBER,V(signal_id),
 #define AT(sensor_id) OPCODE_AT,V(sensor_id),
+#define ATTIMEOUT(sensor_id,timeout) OPCODE_ATTIMEOUT1,0,0,OPCODE_ATTIMEOUT2,V(sensor_id),OPCODE_PAD,V(timeout/100L),
+#define AUTOMATION(id, description)  OPCODE_AUTOMATION, V(id), 
+#define AUTOSTART OPCODE_AUTOSTART,0,0,
+#define BROADCAST(msg) PRINT(msg)
 #define CALL(route) OPCODE_CALL,V(route),
 #define CLOSE(id)  OPCODE_CLOSE,V(id),
-#define DELAY(ms) OPCODE_DELAY,V(ms/100L),
+#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)),
 #define DELAYMINS(mindelay) OPCODE_DELAYMINS,V(mindelay),
-#define DELAYRANDOM(mindelay,maxdelay) OPCODE_DELAY,V(mindelay/100L),OPCODE_RANDWAIT,V((maxdelay-mindelay)/100L),
-#define ENDIF  OPCODE_ENDIF,NOP,
+#define DELAYRANDOM(mindelay,maxdelay) DELAY(mindelay) OPCODE_RANDWAIT,V((maxdelay-mindelay)/100L),
+#define DONE OPCODE_ENDTASK,0,0,
+#define DRIVE(analogpin) OPCODE_DRIVE,V(analogpin),
+#define ELSE OPCODE_ELSE,0,0,
+#define ENDEXRAIL 
+#define ENDIF  OPCODE_ENDIF,0,0,
+#define ENDTASK OPCODE_ENDTASK,0,0,
 #define ESTOP OPCODE_SPEED,V(1), 
+#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),
@@ -255,53 +196,68 @@ const int StringMacroTracker1=__COUNTER__;
 #define FWD(speed) OPCODE_FWD,V(speed),
 #define GREEN(signal_id) OPCODE_GREEN,V(signal_id),
 #define IF(sensor_id) OPCODE_IF,V(sensor_id),
+#define IFCLOSED(turnout_id) OPCODE_IFCLOSED,V(turnout_id),
+#define IFGTE(sensor_id,value) OPCODE_IFGTE,V(sensor_id),OPCODE_PAD,V(value),
+#define IFLT(sensor_id,value) OPCODE_IFLT,V(sensor_id),OPCODE_PAD,V(value),
 #define IFNOT(sensor_id) OPCODE_IFNOT,V(sensor_id),
 #define IFRANDOM(percent) OPCODE_IFRANDOM,V(percent),
 #define IFRESERVE(block) OPCODE_IFRESERVE,V(block),
-#define INVERT_DIRECTION OPCODE_INVERT_DIRECTION,NOP,
-#define JOIN OPCODE_JOIN,NOP,
+#define IFTHROWN(turnout_id) OPCODE_IFTHROWN,V(turnout_id),
+#define IFTIMEOUT OPCODE_IFTIMEOUT,0,0,
+#define INVERT_DIRECTION OPCODE_INVERT_DIRECTION,0,0,
+#define JOIN OPCODE_JOIN,0,0,
 #define LATCH(sensor_id) OPCODE_LATCH,V(sensor_id),
 #define LCD(id,msg) PRINT(msg)
 #define LCN(msg) PRINT(msg)
+#define ONACTIVATE(addr,subaddr) OPCODE_ONACTIVATE,V(addr<<2|subaddr),
+#define ONACTIVATEL(linear) OPCODE_ONACTIVATE,V(linear+3),
 #define ONCLOSE(turnout_id) OPCODE_ONCLOSE,V(turnout_id),
+#define ONDEACTIVATE(addr,subaddr) OPCODE_ONDEACTIVATE,V(addr<<2|subaddr),
+#define ONDEACTIVATEL(linear) OPCODE_ONDEACTIVATE,V(linear+3),
 #define ONTHROW(turnout_id) OPCODE_ONTHROW,V(turnout_id),
-#define PAUSE OPCODE_PAUSE,NOP,
+#define PAUSE OPCODE_PAUSE,0,0,
+#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),
-#define POWEROFF OPCODE_POWEROFF,NOP,
+#define POWEROFF OPCODE_POWEROFF,0,0,
+#define POWERON  OPCODE_POWERON,0,0,
 #define PRINT(msg) OPCODE_PRINT,V(__COUNTER__ - StringMacroTracker2),
-#define READ_LOCO OPCODE_READ_LOCO1,NOP,OPCODE_READ_LOCO2,NOP,
+#define READ_LOCO OPCODE_READ_LOCO1,0,0,OPCODE_READ_LOCO2,0,0,
 #define RED(signal_id) OPCODE_RED,V(signal_id),
 #define RESERVE(blockid) OPCODE_RESERVE,V(blockid),
 #define RESET(pin) OPCODE_RESET,V(pin),
-#define RESUME OPCODE_RESUME,NOP,
-#define RETURN OPCODE_RETURN,NOP,
+#define RESUME OPCODE_RESUME,0,0,
+#define RETURN OPCODE_RETURN,0,0,
 #define REV(speed) OPCODE_REV,V(speed),
+#define ROSTER(cabid,name,funcmap...)
+#define ROUTE(id, description)  OPCODE_ROUTE, V(id), 
 #define SENDLOCO(cab,route) OPCODE_SENDLOCO,V(cab),OPCODE_PAD,V(route),
+#define SEQUENCE(id)  OPCODE_SEQUENCE, V(id), 
 #define SERIAL(msg) PRINT(msg)
 #define SERIAL1(msg) PRINT(msg)
 #define SERIAL2(msg) PRINT(msg)
 #define SERIAL3(msg) PRINT(msg)
-#define START(route) OPCODE_START,V(route),
 #define SERVO(id,position,profile) OPCODE_SERVO,V(id),OPCODE_PAD,V(position),OPCODE_PAD,V(PCA9685::profile),OPCODE_PAD,V(0),
 #define SERVO2(id,position,ms) OPCODE_SERVO,V(id),OPCODE_PAD,V(position),OPCODE_PAD,V(PCA9685::Instant),OPCODE_PAD,V(ms/100L),
-#define SETLOCO(loco) OPCODE_SETLOCO,V(loco),
+#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 SETLOCO(loco) OPCODE_SETLOCO,V(loco),
+#define SIGNAL(redpin,amberpin,greenpin) 
 #define SPEED(speed) OPCODE_SPEED,V(speed),
+#define START(route) OPCODE_START,V(route),
 #define STOP OPCODE_SPEED,V(0), 
-#define SIGNAL(redpin,amberpin,greenpin) OPCODE_SIGNAL,V(redpin),OPCODE_PAD,V(amberpin),OPCODE_PAD,V(greenpin), 
-#define SERVO_TURNOUT(id,pin,activeAngle,inactiveAngle,profile) OPCODE_SERVOTURNOUT,V(id),OPCODE_PAD,V(pin),OPCODE_PAD,V(activeAngle),OPCODE_PAD,V(inactiveAngle),OPCODE_PAD,V(PCA9685::ProfileType::profile),
-#define PIN_TURNOUT(id,pin) OPCODE_PINTURNOUT,V(id),OPCODE_PAD,V(pin), 
 #define THROW(id)  OPCODE_THROW,V(id),
-#define TURNOUT(id,addr,subaddr) OPCODE_TURNOUT,V(id),OPCODE_PAD,V(addr),OPCODE_PAD,V(subaddr),
-#define UNJOIN OPCODE_UNJOIN,NOP,
+#define TURNOUT(id,addr,subaddr,description...) OPCODE_TURNOUT,V(id),OPCODE_PAD,V(addr),OPCODE_PAD,V(subaddr),
+#define UNJOIN OPCODE_UNJOIN,0,0,
 #define UNLATCH(sensor_id) OPCODE_UNLATCH,V(sensor_id),
 #define WAITFOR(pin) OPCODE_WAITFOR,V(pin),
 #define XFOFF(cab,func) OPCODE_XFOFF,V(cab),OPCODE_PAD,V(func),
 #define XFON(cab,func) OPCODE_XFON,V(cab),OPCODE_PAD,V(func),
 
-// PASS2 Build RouteCode
+// Build RouteCode
 const int StringMacroTracker2=__COUNTER__;
-#include "myAutomation.h"
+const  FLASH  byte RMFT2::RouteCode[] = {
+    #include "myAutomation.h"
+    OPCODE_ENDTASK,0,0,OPCODE_ENDEXRAIL,0,0 };
 
 // Restore normal code LCD & SERIAL  macro
 #undef LCD

EthernetInterface.cpp

@@ -1,5 +1,9 @@
 /*
- *  © 2020,Gregor Baues,  Chris Harlow. All rights reserved.
+ *  © 2021 Fred Decker
+ *  © 2020-2021 Harald Barth
+ *  © 2020-2021 Chris Harlow
+ *  © 2020 Gregor Baues
+ *  All rights reserved.
  *  
  *  This file is part of DCC-EX/CommandStation-EX
  *
@@ -170,6 +174,7 @@ void EthernetInterface::loop()
    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);             
      }
     }

EthernetInterface.h

@@ -1,5 +1,10 @@
 /*
- *  © 2020,Gregor Baues,  Chris Harlow. All rights reserved.
+ *  © 2021 Neil McKechnie
+ *  © 2021 Mike S
+ *  © 2021 Fred Decker
+ *  © 2020-2021 Chris Harlow
+ *  © 2020 Gregor Baues
+ *  All rights reserved.
  *  
  *  This file is part of DCC-EX/CommandStation-EX
  *
@@ -23,7 +28,7 @@
 #ifndef EthernetInterface_h
 #define EthernetInterface_h
 
-#include "defines.h")
+#include "defines.h"
 #include "DCCEXParser.h"
 #include <Arduino.h>
 #include <avr/pgmspace.h>

FSH.h

@@ -1,5 +1,8 @@
 /*
- *  (c) 2021 Fred Decker.  All rights reserved.
+ *  © 2021 Neil McKechnie
+ *  © 2021 Harald Barth
+ *  © 2021 Fred Decker
+ *  All rights reserved.
  *  
  *  This file is part of CommandStation-EX
  *

GITHUB_SHA.h

@@ -1 +1 @@
-#define GITHUB_SHA "8853b23"
+#define GITHUB_SHA "a26d988"

I2CManager.h

@@ -107,11 +107,16 @@
  *  the loop() function is called, and may be adequate under some circumstances.  
  *  The advantage of NOT using interrupts is that the impact of I2C upon the DCC waveform (when accurate timing mode isn't in use)
  *  becomes almost zero.
- *  This mechanism is under evaluation and should not be relied upon as yet.
  * 
  */
 
+// Uncomment following line to enable Wire library instead of native I2C drivers
 //#define I2C_USE_WIRE
+
+// Uncomment following line to disable the use of interrupts by the native I2C drivers.
+//#define I2C_NO_INTERRUPTS
+
+// Default to use interrupts within the native I2C drivers.
 #ifndef I2C_NO_INTERRUPTS
 #define I2C_USE_INTERRUPTS
 #endif

I2CManager_Mega4809.h

@@ -72,7 +72,7 @@ void I2CManagerClass::I2C_sendStart() {
   bytesToReceive = currentRequest->readLen;
 
   // If anything to send, initiate write.  Otherwise initiate read.
-  if (operation == OPERATION_READ || (operation == OPERATION_REQUEST & !bytesToSend))
+  if (operation == OPERATION_READ || ((operation == OPERATION_REQUEST) & !bytesToSend))
     TWI0.MADDR = (currentRequest->i2cAddress << 1) | 1;
   else
     TWI0.MADDR = (currentRequest->i2cAddress << 1) | 0;
@@ -157,4 +157,4 @@ ISR(TWI0_TWIM_vect) {
   I2CManagerClass::handleInterrupt();
 }
 
-#endif
+#endif

I2CManager_NonBlocking.h

@@ -129,6 +129,10 @@ uint8_t I2CManagerClass::read(uint8_t i2cAddress, uint8_t *readBuffer, uint8_t r
 /***************************************************************************
  * checkForTimeout() function, called from isBusy() and wait() to cancel
  * 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() {
   unsigned long currentMicros = micros();
@@ -163,7 +167,10 @@ void I2CManagerClass::loop() {
 #if !defined(I2C_USE_INTERRUPTS)
   handleInterrupt();
 #endif
-  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();
 }
 
 /***************************************************************************
@@ -175,6 +182,9 @@ 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_ACTIVE && currentRequest != NULL) {

I2CManager_Wire.h

@@ -98,22 +98,20 @@ uint8_t I2CManagerClass::read(uint8_t address, uint8_t readBuffer[], uint8_t rea
  * returned in the I2CRB as for the asynchronous version.
  ***************************************************************************/
 void I2CManagerClass::queueRequest(I2CRB *req) {
-  uint8_t status;
   switch (req->operation) {
     case OPERATION_READ:
-      status = read(req->i2cAddress, req->readBuffer, req->readLen, NULL, 0, req);
+      req->status = read(req->i2cAddress, req->readBuffer, req->readLen, NULL, 0, req);
       break;
     case OPERATION_SEND:
-      status = write(req->i2cAddress, req->writeBuffer, req->writeLen, req);
+      req->status = write(req->i2cAddress, req->writeBuffer, req->writeLen, req);
       break;
     case OPERATION_SEND_P:
-      status = write_P(req->i2cAddress, req->writeBuffer, req->writeLen, req);
+      req->status = write_P(req->i2cAddress, req->writeBuffer, req->writeLen, req);
       break;
     case OPERATION_REQUEST:
-      status = read(req->i2cAddress, req->readBuffer, req->readLen, req->writeBuffer, req->writeLen, req);
+      req->status = read(req->i2cAddress, req->readBuffer, req->readLen, req->writeBuffer, req->writeLen, req);
       break;
   }
-  req->status = status;
 }
 
 /***************************************************************************

IODevice.cpp

@@ -1,5 +1,7 @@
 /*
- *  © 2021, Neil McKechnie. All rights reserved.
+ *  © 2021 Neil McKechnie
+ *  © 2021 Harald Barth
+ *  All rights reserved.
  *  
  *  This file is part of DCC++EX API
  *
@@ -28,6 +30,10 @@
 #define USE_FAST_IO
 #endif
 
+// Link to halSetup function.  If not defined, the function reference will be NULL.
+extern __attribute__((weak)) void halSetup();
+extern __attribute__((weak)) void mySetup();  // Deprecated function name, output warning if it's declared
+
 //==================================================================================================================
 // Static methods
 //------------------------------------------------------------------------------------------------------------------
@@ -57,6 +63,16 @@ void IODevice::begin() {
     dev->_begin();
   }
   _initPhase = false;
+
+  // Check for presence of deprecated mySetup() function, and output warning.
+  if (mySetup)
+    DIAG(F("WARNING: mySetup() function should be renamed to halSetup()"));
+
+  // 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.
+  if (halSetup)
+    halSetup();
 }
 
 // Overarching static loop() method for the IODevice subsystem.  Works through the
@@ -148,6 +164,33 @@ void IODevice::_display() {
 bool IODevice::configure(VPIN vpin, ConfigTypeEnum configType, int paramCount, int params[]) {
   IODevice *dev = findDevice(vpin);
   if (dev) return dev->_configure(vpin, configType, paramCount, params);
+#ifdef DIAG_IO
+  DIAG(F("IODevice::configure(): Vpin ID %d not found!"), (int)vpin);
+#endif
+  return false;
+}
+
+// Read value from virtual pin.
+int IODevice::read(VPIN vpin) {
+  for (IODevice *dev = _firstDevice; dev != 0; dev = dev->_nextDevice) {
+    if (dev->owns(vpin)) 
+      return dev->_read(vpin);
+  }
+#ifdef DIAG_IO
+  DIAG(F("IODevice::read(): Vpin %d not found!"), (int)vpin);
+#endif
+  return false;
+}
+
+// Read analogue value from virtual pin.
+int IODevice::readAnalogue(VPIN vpin) {
+  for (IODevice *dev = _firstDevice; dev != 0; dev = dev->_nextDevice) {
+    if (dev->owns(vpin)) 
+      return dev->_readAnalogue(vpin);
+  }
+#ifdef DIAG_IO
+  DIAG(F("IODevice::readAnalogue(): Vpin %d not found!"), (int)vpin);
+#endif
   return false;
 }
 
@@ -258,48 +301,22 @@ bool IODevice::owns(VPIN id) {
   return (id >= _firstVpin && id < _firstVpin + _nPins);
 }
 
-// Read value from virtual pin.
-int IODevice::read(VPIN vpin) {
-  for (IODevice *dev = _firstDevice; dev != 0; dev = dev->_nextDevice) {
-    if (dev->owns(vpin)) 
-      return dev->_read(vpin);
-  }
-#ifdef DIAG_IO
-  DIAG(F("IODevice::read(): Vpin %d not found!"), (int)vpin);
-#endif
-  return false;
-}
-
-// Read analogue value from virtual pin.
-int IODevice::readAnalogue(VPIN vpin) {
-  for (IODevice *dev = _firstDevice; dev != 0; dev = dev->_nextDevice) {
-    if (dev->owns(vpin)) 
-      return dev->_readAnalogue(vpin);
-  }
-#ifdef DIAG_IO
-  DIAG(F("IODevice::readAnalogue(): Vpin %d not found!"), (int)vpin);
-#endif
-  return false;
-}
-
 
 #else // !defined(IO_NO_HAL)
 
 // Minimal implementations of public HAL interface, to support Arduino pin I/O and nothing more.
 
 void IODevice::begin() { DIAG(F("NO HAL CONFIGURED!")); }
-bool IODevice::configure(VPIN pin, ConfigTypeEnum, int, int p[]) {
+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]);
   #endif
-  if (p[0]) {
-    pinMode(pin, INPUT_PULLUP);
-  } else {
-    pinMode(pin, INPUT);
-  }
+  pinMode(pin, p[0] ? INPUT_PULLUP : INPUT);
   return true;
 }
 void IODevice::write(VPIN vpin, int value) {
+  if (vpin >= NUM_DIGITAL_PINS) return;
   digitalWrite(vpin, value);
   pinMode(vpin, OUTPUT);
 }
@@ -307,6 +324,7 @@ void IODevice::writeAnalogue(VPIN, int, uint8_t, uint16_t) {}
 bool IODevice::isBusy(VPIN) { return false; }
 bool IODevice::hasCallback(VPIN) { return false; }
 int IODevice::read(VPIN vpin) { 
+  if (vpin >= NUM_DIGITAL_PINS) return 0;
   return !digitalRead(vpin);  // Return inverted state (5v=0, 0v=1)
 }
 int IODevice::readAnalogue(VPIN vpin) {

IO_DCCAccessory.cpp

@@ -47,11 +47,15 @@ void DCCAccessoryDecoder::_begin() {
 // Device-specific write function.  State 1=closed, 0=thrown.  Adjust for RCN-213 compliance
 void DCCAccessoryDecoder::_write(VPIN id, int state) {
   int packedAddress = _packedAddress + id - _firstVpin;
-  #ifdef DIAG_IO
-  DIAG(F("DCC Write Linear Address:%d State:%d"), packedAddress, state);
-  #endif
-#if !defined(DCC_ACCESSORY_RCN_213)
+#if defined(HAL_ACCESSORY_COMMAND_REVERSE)
   state = !state;
+#ifdef DIAG_IO
+  DIAG(F("DCC Write Linear Address:%d State:%d (inverted)"), packedAddress, state);
+#endif
+#else
+#ifdef DIAG_IO
+  DIAG(F("DCC Write Linear Address:%d State:%d"), packedAddress, state);
+#endif
 #endif
   DCC::setAccessory(ADDRESS(packedAddress), SUBADDRESS(packedAddress), state);
 }

IO_PCA9555.h

@@ -0,0 +1,112 @@
+/*
+ *  © 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, int nPins, uint8_t I2CAddress, int interruptPin=-1) {
+    new PCA9555(vpin, min(nPins,16), I2CAddress, interruptPin);
+  }
+  
+  // Constructor
+  PCA9555(VPIN vpin, int nPins, uint8_t 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;
+  }
+
+private:
+  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_PCF8574.h

@@ -75,7 +75,7 @@ private:
     if (immediate) {
       uint8_t buffer[1];
       I2CManager.read(_I2CAddress, buffer, 1);
-      _portInputState = ((uint16_t)buffer) & 0xff;
+      _portInputState = buffer[0];
     } else {
       requestBlock.wait(); // Wait for preceding operation to complete
       // Issue new request to read GPIO register
@@ -86,7 +86,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[0]) & 0xff;
+      _portInputState = inputBuffer[0];
     else  
       _portInputState = 0xff; 
   }

LCN.h

@@ -1,5 +1,7 @@
 /*
- *  (c) 2021 Fred Decker.  All rights reserved.
+ *  © 2021 Harald Barth
+ *  © 2021 Fred Decker
+ *  All rights reserved.
  *  
  *  This file is part of CommandStation-EX
  *

MotorDriver.cpp

@@ -1,7 +1,11 @@
 /*
- *  © 2020, Chris Harlow. All rights reserved.
+ *  © 2021 Mike S
+ *  © 2021 Fred Decker
+ *  © 2020-2022 Harald Barth
+ *  © 2020-2021 Chris Harlow
+ *  All rights reserved.
  *  
- *  This file is part of Asbelos DCC API
+ *  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
@@ -76,7 +80,7 @@ MotorDriver::MotorDriver(byte power_pin, byte signal_pin, byte signal_pin2, int8
   if (currentPin==UNUSED_PIN) 
     DIAG(F("MotorDriver ** WARNING ** No current or short detection"));  
   else  
-    DIAG(F("MotorDriver currentPin=A%d, senseOffset=%d, rawCurentTripValue(relative to offset)=%d"),
+    DIAG(F("MotorDriver currentPin=A%d, senseOffset=%d, rawCurrentTripValue(relative to offset)=%d"),
     currentPin-A0, senseOffset,rawCurrentTripValue);
 }
 
@@ -148,16 +152,16 @@ int MotorDriver::getCurrentRaw() {
   bool irq = disableInterrupts();
   current = analogRead(currentPin)-senseOffset;
   enableInterrupts(irq);
-#elif defined(ARDUINO_TEENSY32) || defined(ARDUINO_TEENSY35)|| defined(ARDUINO_TEENSY36)
+#else // Uno, Mega and all the TEENSY3* but not TEENSY4* 
   unsigned char sreg_backup;
   sreg_backup = SREG;   /* save interrupt enable/disable state */
   cli();
   current = analogRead(currentPin)-senseOffset;
+#if defined(ARDUINO_TEENSY32) || defined(ARDUINO_TEENSY35)|| defined(ARDUINO_TEENSY36)
   overflow_count = 0;
-  SREG = sreg_backup;    /* restore interrupt state */
-#else
-  current = analogRead(currentPin)-senseOffset;
 #endif
+  if (sreg_backup & 128) sei();  /* restore interrupt state */
+#endif // outer #
   if (current<0) current=0-current;
   if ((faultPin != UNUSED_PIN)  && isLOW(fastFaultPin) && isHIGH(fastPowerPin))
       return (current == 0 ? -1 : -current);

MotorDriver.h

@@ -1,5 +1,8 @@
 /*
- *  © 2020, Chris Harlow. All rights reserved.
+ *  © 2021 Mike S
+ *  © 2021 Fred Decker
+ *  © 2020 Chris Harlow
+ *  All rights reserved.
  *  
  *  This file is part of Asbelos DCC API
  *

MotorDrivers.h

@@ -1,4 +1,6 @@
 /*
+ *  © 2021 Fred Decker
+ *  © 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.
@@ -87,4 +89,22 @@
     new MotorDriver(5, 4, UNUSED_PIN, UNUSED_PIN, A0, 2.99, 2000, UNUSED_PIN), \
     new MotorDriver(6, 7, UNUSED_PIN, UNUSED_PIN, A1, 2.99, 2000, UNUSED_PIN)
 
+// Makeblock ORION UNO like sized board with integrated motor driver
+// This is like an Uno with H-bridge and RJ12 contacts instead of pin rows.
+// No current sense. Barrel connector max 12V, Vmotor max 15V. 1.1A polyfuse as output protection.
+// Main is marked M1 and near RJ12 #5
+// Prog is marked M2 and near RJ12 #4
+// For details see
+// http://docs.makeblock.com/diy-platform/en/electronic-modules/main-control-boards/makeblock-orion.html
+#define ORION_UNO_INTEGRATED_SHIELD F("ORION_UNO_INTEGRATED_SHIELD"),		      \
+    new MotorDriver(6, 7, UNUSED_PIN, UNUSED_PIN, UNUSED_PIN, 1.0, 1100, UNUSED_PIN), \
+    new MotorDriver(5, 4, UNUSED_PIN, UNUSED_PIN, UNUSED_PIN, 1.0, 1100, UNUSED_PIN)
+
+// This is an example how to setup a motor shield definition for a motor shield connected
+// to an NANO EVERY board. You have to make the connectons from the shield to the board
+// as in this example or adjust the values yourself.
+#define NANOEVERY_EXAMPLE F("NANOEVERY_EXAMPLE"), \
+ new MotorDriver(5,  6, UNUSED_PIN, UNUSED_PIN, A0, 2.99, 2000, UNUSED_PIN),\
+ new MotorDriver(9, 10, UNUSED_PIN, UNUSED_PIN, A1, 2.99, 2000, UNUSED_PIN)
+
 #endif

Outputs.cpp

@@ -1,5 +1,9 @@
 /*
- *  © 2020, Chris Harlow. All rights reserved.
+ *  © 2021 Neil McKechnie
+ *  © 2021 Harald Barth
+ *  © 2020-2021 Fred Decker
+ *  © 2020-2021 Chris Harlow
+ *  All rights reserved.
  *  
  *  This file is part of Asbelos DCC API
  *
@@ -82,7 +86,9 @@ the state of any outputs being monitored or controlled by a separate interface o
 **********************************************************************/
 
 #include "Outputs.h"
+#ifndef DISABLE_EEPROM
 #include "EEStore.h"
+#endif
 #include "StringFormatter.h"
 #include "IODevice.h"
 
@@ -102,10 +108,11 @@ void  Output::activate(uint16_t s){
   data.active = s;                     // if s>0, set status to active, else inactive
   // set state of output pin to HIGH or LOW depending on whether bit zero of iFlag is set to 0 (ACTIVE=HIGH) or 1 (ACTIVE=LOW)
   IODevice::write(data.pin, s ^ data.invert);  
-
+#ifndef DISABLE_EEPROM
   // Update EEPROM if output has been stored.    
   if(EEStore::eeStore->data.nOutputs > 0 && num > 0)
     EEPROM.put(num, data.oStatus);
+#endif
 }
 
 ///////////////////////////////////////////////////////////////////////////////
@@ -141,7 +148,7 @@ bool Output::remove(uint16_t n){
 
 ///////////////////////////////////////////////////////////////////////////////
 // Static function to load configuration and state of all Outputs from EEPROM
-
+#ifndef DISABLE_EEPROM
 void Output::load(){
   struct OutputData data;
   Output *tt;
@@ -176,6 +183,7 @@ void Output::store(){
   }
 
 }
+#endif
 
 ///////////////////////////////////////////////////////////////////////////////
 // Static function to create an Output object

Outputs.h

@@ -1,5 +1,8 @@
 /*
- *  © 2020, Chris Harlow. All rights reserved.
+ *  © 2021 Harald Barth
+ *  © 2021 Fred Decker
+ *  © 2020 Chris Harlow
+ *  All rights reserved.
  *  
  *  This file is part of Asbelos DCC API
  *
@@ -48,8 +51,10 @@ public:
   bool isActive();
   static Output* get(uint16_t);
   static bool remove(uint16_t);
+#ifndef DISABLE_EEPROM
   static void load();
   static void store();
+#endif
   static Output *create(uint16_t, VPIN, int, int=0);
   static Output *firstOutput;
   struct OutputData data;

README.md

@@ -17,12 +17,12 @@ Both CommandStation-EX and BaseStation-Classic support much of the NMRA Digital
 * Control of all cab functions F0-F28 and F29-F68
 * Main Track: Write configuration variable bytes and set/clear specific configuration variable (CV) bits (aka Programming on Main or POM)
 * Programming Track: Same as the main track with the addition of reading configuration variable bytes
-* And manu more custom features. see [What's new in CommandStation-EX?](#whats-new-in-commandstation-ex)
+* And many more custom features. see [What's new in CommandStation-EX?](#whats-new-in-commandstation-ex)
 
 
 # What’s in this Repository?
 
-This repository, CommandStation-EX, contains a complete DCC++ EX Commmand Station sketch designed for compiling and uploading into an Arduino Uno, Mega, or Nano.  All sketch files are in the folder named CommandStation-EX and its subforlders. 
+This repository, CommandStation-EX, contains a complete DCC++ EX Commmand Station sketch designed for compiling and uploading into an Arduino Uno, Mega, or Nano.
 
 To utilize this sketch, you can use the following: 
 
@@ -69,7 +69,7 @@ in config.h.
 * Automatic slot (register) management 
 * Automation (coming soon)
 
-NOTE: DCC-EX is a major rewrite to the code. We started over and rebuilt it from the ground up! For what that means to you, click [HERE](notes/rewrite.md).
+NOTE: DCC-EX is a major rewrite to the code. We started over and rebuilt it from the ground up! For what that means, you can read [HERE](https://dcc-ex.com/about/rewrite.html).
 
 # More information
 You can learn more at the [DCC++ EX website](https://dcc-ex.com/)

RMFT2.cpp

@@ -1,767 +0,0 @@
-/*
- *  © 2020,2021 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/>.
- */
-#include <Arduino.h>
-#include "RMFT2.h"
-#include "DCC.h"
-#include "DCCWaveform.h"
-#include "DIAG.h"
-#include "WiThrottle.h"
-#include "DCCEXParser.h"
-#include "Turnouts.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_ROUTES=-3702;
-
-// 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.
-// The thrrads exist in a ring, each time through loop() the next thread in the ring is serviced.
-
-// Statics 
-const int16_t LOCO_ID_WAITING=-99; // waiting for loco id from prog track
-int16_t RMFT2::progtrackLocoId;  // used for callback when detecting a loco on prograck
-bool RMFT2::diag=false;      // <D EXRAIL ON>  
-RMFT2 * RMFT2::loopTask=NULL; // loopTask contains the address of ONE of the tasks in a ring.
-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];
-
-#define GET_OPCODE GETFLASH(RMFT2::RouteCode+progCounter)
-#define GET_OPERAND(n) GETFLASHW(RMFT2::RouteCode+progCounter+1+(n*3))
-#define SKIPOP progCounter+=3
-
-/* static */ void RMFT2::begin() { 
-  DCCEXParser::setRMFTFilter(RMFT2::ComandFilter);
-  for (int f=0;f<MAX_FLAGS;f++) flags[f]=0;
-  int progCounter;
-  // first pass startup, define any turnouts or servos, set signals red and count size.
-  for (progCounter=0;; SKIPOP){
-     byte opcode=GET_OPCODE;
-     if (opcode==OPCODE_ENDEXRAIL) break;
-
-     switch (opcode) {
-     case OPCODE_AT:
-     case OPCODE_AFTER:
-     case OPCODE_IF:
-     case OPCODE_IFNOT:
-       IODevice::configureInput((VPIN)GET_OPERAND(0),true);
-     }
-
-     if (opcode==OPCODE_SIGNAL) {
-      VPIN red=GET_OPERAND(0);
-      VPIN amber=GET_OPERAND(1);
-      VPIN green=GET_OPERAND(2);
-      IODevice::write(red,true);
-      if (amber) IODevice::write(amber,false);
-      IODevice::write(green,false);
-      continue;
-     }
-     
-     if (opcode==OPCODE_TURNOUT) {
-      VPIN id=GET_OPERAND(0);
-      int addr=GET_OPERAND(1);
-      byte subAddr=GET_OPERAND(2);
-      DCCTurnout::create(id,addr,subAddr);
-      continue;
-     }
-
-     if (opcode==OPCODE_SERVOTURNOUT) {
-      int16_t id=GET_OPERAND(0);
-      VPIN pin=GET_OPERAND(1);
-      int activeAngle=GET_OPERAND(2);
-      int inactiveAngle=GET_OPERAND(3);
-      int profile=GET_OPERAND(4);
-      ServoTurnout::create(id,pin,activeAngle,inactiveAngle,profile);
-      continue;
-     }
-
-     if (opcode==OPCODE_PINTURNOUT) {
-      int16_t id=GET_OPERAND(0);
-      VPIN pin=GET_OPERAND(1);
-      VpinTurnout::create(id,pin);
-      continue;
-     }
-     // other opcodes are not needed on this pass
-  } 
-  SKIPOP; // include ENDROUTES opcode
-  DIAG(F("EXRAIL %db, MAX_FLAGS=%d"), progCounter,MAX_FLAGS);
-  new RMFT2(0); // add the startup route
-}
-
-// 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) { // 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"));
-                     }                 
-                 }
-                 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=locateRouteStart(route);                 
-                  if (pc<0) return false;
-                    RMFT2* task=new RMFT2(pc);
-                    task->loco=cab;                    
-                 }
-              return true;
-
-            case HASH_KEYWORD_ROUTES: // </ ROUTES > JMRI withrottle support 
-                 if (paramCount>1) return false;
-                 StringFormatter::send(stream,F("</ROUTES "));
-                 emitWithrottleRouteList(stream);                                  
-                 StringFormatter::send(stream,F(">"));
-              return true;
-              
-            default:
-              break;
-          }
-          
-          // all other / commands take 1 parameter 0 to MAX_FLAGS-1     
-
-          if (paramCount!=2 || p[1]<0  || p[1]>=MAX_FLAGS) return false;
-
-          switch (p[0]) {  
-               case HASH_KEYWORD_KILL: // Kill taskid
-                    {
-                    RMFT2 * task=loopTask;
-                    while(task) {
-                      if (task->taskId==p[1]) {
-                         delete task;
-                         return  true;
-                      }
-                      task=task->next;      
-                      if (task==loopTask) break;      
-                    }
-                 }
-                 return false;
-                    
-            case HASH_KEYWORD_RESERVE:  // force reserve a section
-                 setFlag(p[1],SECTION_FLAG);
-                 return true;
-    
-            case HASH_KEYWORD_FREE:  // force free a section
-                 setFlag(p[1],0,SECTION_FLAG);
-                 return true;
-                
-            case HASH_KEYWORD_LATCH:
-                 setFlag(p[1], LATCH_FLAG);
-                 return true;
-   
-            case HASH_KEYWORD_UNLATCH:
-                 setFlag(p[1], 0, LATCH_FLAG);
-                 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. 
-void RMFT2::emitWithrottleRouteList(Print* stream) {
-   StringFormatter::send(stream,F("PRT]\\[Routes}|{Route]\\[Set}|{2]\\[Handoff}|{4\nPRL"));
-   emitWithrottleDescriptions(stream);
-   StringFormatter::send(stream,F("\n"));
-}
-
-
-RMFT2::RMFT2(int progCtr) {
-  progCounter=progCtr;
-
-  // get an unused  task id from the flags table 
-  taskId=255; // in case of overflow
-  for (int f=0;f<MAX_FLAGS;f++) {
-    if (!getFlag(f,TASK_FLAG)) {
-      taskId=f;
-      setFlag(f, TASK_FLAG);
-      break;
-    }
-  }
-  delayTime=0;
-  loco=0;
-  speedo=0;
-  forward=true;
-  invert=false;
-  stackDepth=0;
-  onTurnoutId=0; // Not handling an ONTHROW/ONCLOSE
-   
-  // chain into ring of RMFTs
-  if (loopTask==NULL) {
-    loopTask=this;
-    next=this;
-  }
-  else {
-        next=loopTask->next;
-        loopTask->next=this;
-  }
-}
-
-
-RMFT2::~RMFT2() {
-  driveLoco(1); // ESTOP my loco if any 
-  setFlag(taskId,0,TASK_FLAG); // we are no longer using this id
-  if (next==this) loopTask=NULL;
-  else for (RMFT2* ring=next;;ring=ring->next) if (ring->next == this) {
-           ring->next=next;
-           loopTask=next;
-           break;
-       }
-}
-
-void RMFT2::createNewTask(int route, uint16_t cab) {
-      int pc=locateRouteStart(route);
-      if (pc<0) return;
-      RMFT2* task=new RMFT2(pc);
-      task->loco=cab;
-}
-
-   
-int RMFT2::locateRouteStart(int16_t _route) {
-  if (_route==0) return 0; // Route 0 is always start of ROUTES for default startup 
-  for (int progCounter=0;;SKIPOP) {
-    byte opcode=GET_OPCODE;
-    if (opcode==OPCODE_ENDEXRAIL) {
-      DIAG(F("RMFT2 sequence %d not found"), _route);
-      return -1;
-    }
-    if ((opcode==OPCODE_ROUTE || opcode==OPCODE_AUTOMATION || opcode==OPCODE_SEQUENCE) 
-       &&  _route==(int)GET_OPERAND(0)) return progCounter;
-  }
-  return -1;
-}
-
-
-void RMFT2::driveLoco(byte speed) {
-     if (loco<=0) return;  // Prevent broadcast! 
-     if (diag) DIAG(F("EXRAIL drive %d %d %d"),loco,speed,forward^invert);
-     if (DCCWaveform::mainTrack.getPowerMode()==POWERMODE::OFF) {
-        DCCWaveform::mainTrack.setPowerMode(POWERMODE::ON); 
-        Serial.println(F("<p1>")); // tell JMRI
-     }
-     DCC::setThrottle(loco,speed, forward^invert);
-     speedo=speed;
-}
-
-bool RMFT2::readSensor(uint16_t sensorId) {
-  // Exrail operands are unsigned but we need the signed version as inserted by the macros.  
-  int16_t sId=(int16_t) sensorId;
-
-  VPIN vpin=abs(sId);
-  if (getFlag(vpin,LATCH_FLAG)) return true; // latched on
-
-  // negative sensorIds invert the logic (e.g. for a break-beam sensor which goes OFF when detecting)
-  bool s= IODevice::read(vpin) ^ (sId<0);
-  if (s && diag) DIAG(F("EXRAIL Sensor %d hit"),sId);
-  return s;
-}
-
-bool RMFT2::skipIfBlock() {
-  // returns false if killed
-  short nest = 1;
-  while (nest > 0) {
-    SKIPOP;
-    byte opcode =  GET_OPCODE;
-    switch(opcode) {
-      case OPCODE_ENDEXRAIL: 
-           kill(F("missing ENDIF"), nest);
-           return false;  
-      case OPCODE_IF:
-      case OPCODE_IFNOT:
-      case OPCODE_IFRANDOM:
-      case OPCODE_IFRESERVE:
-           nest++;
-           break;
-      case OPCODE_ENDIF:
-           nest--;
-           break;
-      default:
-      break;
-    }
-  }
-  return true; 
-}
-
-
-
-/* static */ void RMFT2::readLocoCallback(int16_t cv) {
-     progtrackLocoId=cv;
-}
-
-void RMFT2::loop() {
-  
-  // Round Robin call to a RMFT task each time 
-     if (loopTask==NULL) return; 
-     
-     loopTask=loopTask->next;
- 
-     if (pausingTask==NULL || pausingTask==loopTask) loopTask->loop2();
-}    
-
-  
-void RMFT2::loop2() {
-   if (delayTime!=0 && millis()-delayStart < delayTime) return;
-     
-  byte opcode = GET_OPCODE;
-  int16_t operand =  GET_OPERAND(0);
-  // if (diag) DIAG(F("RMFT2 %d %d"),opcode,operand); 
-  // Attention: Returning from this switch leaves the program counter unchanged.
-  //            This is used for unfinished waits for timers or sensors.
-  //            Breaking from this switch will step to the next step in the route. 
-  switch ((OPCODE)opcode) {
-    
-    case OPCODE_THROW:
-         Turnout::setClosed(operand, false);
-         break;
-          
-    case OPCODE_CLOSE:
-         Turnout::setClosed(operand, true);
-         break; 
-    
-    case OPCODE_REV:
-      forward = false;
-      driveLoco(operand);
-      break;
-    
-    case OPCODE_FWD:
-      forward = true;
-      driveLoco(operand);
-      break;
-      
-    case OPCODE_SPEED:
-      driveLoco(operand);
-      break;
-    
-    case OPCODE_INVERT_DIRECTION:
-      invert= !invert;
-      driveLoco(speedo);
-      break;
-      
-    case OPCODE_RESERVE:
-      if (getFlag(operand,SECTION_FLAG)) {
-        driveLoco(0);
-        delayMe(500);
-        return;
-      }
-      setFlag(operand,SECTION_FLAG);
-      break;
-    
-    case OPCODE_FREE:
-      setFlag(operand,0,SECTION_FLAG);
-      break;
-    
-    case OPCODE_AT:
-      if (readSensor(operand)) break;
-      delayMe(50);
-      return;
-    
-    case OPCODE_AFTER: // waits for sensor to hit and then remain off for 0.5 seconds. (must come after an AT operation)
-      if (readSensor(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;
-    
-    case OPCODE_UNLATCH:
-      setFlag(operand,0,LATCH_FLAG);
-      break;
-
-    case OPCODE_SET:
-      IODevice::write(operand,true);
-      break;
-  
-    case OPCODE_RESET:
-      IODevice::write(operand,false);
-      break;
-    
-    case OPCODE_PAUSE:
-         DCC::setThrottle(0,1,true);  // pause all locos on the track
-         pausingTask=this;
-         break;
-
-    case OPCODE_POM:
-        if (loco) DCC::writeCVByteMain(loco, operand, GET_OPERAND(1));
-        break;
-
-    case OPCODE_POWEROFF:
-        DCCWaveform::mainTrack.setPowerMode(POWERMODE::OFF);
-        DCCWaveform::progTrack.setPowerMode(POWERMODE::OFF);
-        DCC::setProgTrackSyncMain(false);       
-        Serial.println(F("<p0>")); // Tell JMRI
-        break;
-
-    case OPCODE_RESUME:
-         pausingTask=NULL;
-         driveLoco(speedo);
-         for (RMFT2 * t=next; t!=this;t=t->next) if (t->loco >0) t->driveLoco(t->speedo);
-          break;        
-    
-    case OPCODE_IF: // do next operand if sensor set
-      if (!readSensor(operand)) if (!skipIfBlock()) return;
-      break;
-    
-    case OPCODE_IFNOT: // do next operand if sensor not set
-      if (readSensor(operand)) if (!skipIfBlock()) return;
-      break;
-   
-    case OPCODE_IFRANDOM: // do block on random percentage
-      if (random(100)>=operand) if (!skipIfBlock()) return;
-      break;
-   
-    case OPCODE_IFRESERVE: // do block if we successfully RERSERVE
-      if (!getFlag(operand,SECTION_FLAG)) setFlag(operand,SECTION_FLAG);
-      else if (!skipIfBlock()) return;
-      break;
-      
-    case OPCODE_ENDIF:
-      break;
-    
-    case OPCODE_DELAY:
-      delayMe(operand*100L);
-      break;
-   
-    case OPCODE_DELAYMINS:
-      delayMe(operand*60L*1000L);
-      break;
-    
-    case OPCODE_RANDWAIT:
-      delayMe(random(operand)*100L);
-      break;
-    
-    case OPCODE_RED:
-      doSignal(operand,true,false,false);
-      break;
-    
-    case OPCODE_AMBER:
-      doSignal(operand,false,true,false);
-      break;
-    
-    case OPCODE_GREEN:
-      doSignal(operand,false,false,true);
-      break;
-       
-    case OPCODE_FON:      
-      if (loco) DCC::setFn(loco,operand,true);
-      break;
-     
-    case OPCODE_FOFF:
-      if (loco) DCC::setFn(loco,operand,false);
-      break;
-    
-    case OPCODE_XFON:      
-      DCC::setFn(operand,GET_OPERAND(1),true);
-      break;
-   
-    case OPCODE_XFOFF:      
-      DCC::setFn(operand,GET_OPERAND(1),false);
-      break;
-   
-    case OPCODE_FOLLOW:
-      progCounter=locateRouteStart(operand);
-      if (progCounter<0) kill(F("FOLLOW unknown"), operand); 
-      return;
-  
-    case OPCODE_CALL:
-      if (stackDepth==MAX_STACK_DEPTH) {
-        kill(F("CALL stack"), stackDepth);
-        return;
-      }
-      callStack[stackDepth++]=progCounter+3;
-      progCounter=locateRouteStart(operand);
-      if (progCounter<0) kill(F("CALL unknown"),operand); 
-      return;
-
-    case OPCODE_RETURN:
-      if (stackDepth==0) {
-        kill(F("RETURN stack"));
-        return;
-      }
-      progCounter=callStack[--stackDepth];
-      return;
-      
-    case OPCODE_ENDTASK:
-    case OPCODE_ENDEXRAIL:
-      kill();
-      return;
-      
-    case OPCODE_JOIN:
-       DCCWaveform::mainTrack.setPowerMode(POWERMODE::ON); 
-       DCCWaveform::progTrack.setPowerMode(POWERMODE::ON); 
-       DCC::setProgTrackSyncMain(true);
-       Serial.println(F("<p1 JOIN>")); // Tell JMRI
-       break;
-
-    case OPCODE_UNJOIN:
-       DCC::setProgTrackSyncMain(false);
-       break;
-       
-    case OPCODE_READ_LOCO1: // READ_LOCO is implemented as 2 separate opcodes
-       progtrackLocoId=LOCO_ID_WAITING;  // Nothing found yet
-       DCC::getLocoId(readLocoCallback);
-       break;
-      
-      case OPCODE_READ_LOCO2:
-       if (progtrackLocoId==LOCO_ID_WAITING) {
-        delayMe(100);
-        return; // still waiting for callback
-       }
-       if (progtrackLocoId<0) {
-        kill(F("No Loco Found"),progtrackLocoId);
-        return; // still waiting for callback
-       }
-       
-       loco=progtrackLocoId;
-       speedo=0;
-       forward=true;
-       invert=false;
-       break;
-       
-       case OPCODE_START:
-           {
-            int newPc=locateRouteStart(operand);
-            if (newPc<0) break; 
-            new RMFT2(newPc); 
-           }
-           break;
-           
-      case OPCODE_SENDLOCO:  // cab, route
-           {
-            int newPc=locateRouteStart(GET_OPERAND(1));
-            if (newPc<0) break; 
-            RMFT2* newtask=new RMFT2(newPc); // create new task 
-            newtask->loco=operand; 
-           }
-           break;
-           
-       case OPCODE_SETLOCO:
-           {
-             loco=operand; 
-             speedo=0;
-             forward=true;
-             invert=false;
-            }
-       break;
-
-          
-       case OPCODE_SERVO: // OPCODE_SERVO,V(vpin),OPCODE_PAD,V(position),OPCODE_PAD,V(profile),OPCODE_PAD,V(duration)
-        IODevice::writeAnalogue(operand,GET_OPERAND(1),GET_OPERAND(2),GET_OPERAND(3));          
-        break;
-       
-       case OPCODE_WAITFOR: // OPCODE_SERVO,V(pin)
-            if (IODevice::isBusy(operand)) {
-              delayMe(100);
-              return;
-            }
-            break;
-
-       case OPCODE_PRINT:
-            printMessage(operand);
-            break;
-               
-       case OPCODE_ROUTE:
-       case OPCODE_AUTOMATION:
-       case OPCODE_SEQUENCE:
-          if (diag) DIAG(F("EXRAIL begin(%d)"),operand);
-          break;
-
-       case OPCODE_PAD: // Just a padding for previous opcode needing >1 operad byte.
-       case OPCODE_SIGNAL: // Signal definition ignore at run time
-       case OPCODE_TURNOUT: // Turnout definition ignored at runtime
-       case OPCODE_SERVOTURNOUT: // Turnout definition ignored at runtime
-       case OPCODE_PINTURNOUT: // Turnout definition ignored at runtime
-       case OPCODE_ONCLOSE: // Turnout event catcers ignored here
-       case OPCODE_ONTHROW: // Turnout definition ignored at runtime
-       break;
-    
-    default:
-      kill(F("INVOP"),operand);
-    }
-    // Falling out of the switch means move on to the next opcode
-    SKIPOP;
-}
-
-void RMFT2::delayMe(long delay) {
-     delayTime=delay;
-     delayStart=millis();
-}
-
-void RMFT2::setFlag(VPIN id,byte onMask, byte offMask) {  
-   if (FLAGOVERFLOW(id)) return; // Outside range limit
-   byte f=flags[id];
-   f &= ~offMask;
-   f |= onMask;
-   flags[id]=f;
-}
-
-bool RMFT2::getFlag(VPIN id,byte mask) {
-   if (FLAGOVERFLOW(id)) return 0; // Outside range limit
-   return flags[id]&mask;   
-}
-
-void RMFT2::kill(const FSH * reason, int operand) {
-     if (reason) DIAG(F("EXRAIL ERROR pc=%d, cab=%d, %S %d"), progCounter,loco, reason, operand);
-     else if (diag) DIAG(F("ENDTASK at pc=%d"), progCounter); 
-     delete this;
-}
-
-/* static */ void RMFT2::doSignal(VPIN id,bool red, bool amber, bool green) { 
-  // CAUTION: hides class member progCounter
-  for (int progCounter=0;; SKIPOP){
-     byte opcode=GET_OPCODE;
-     if (opcode==OPCODE_ENDEXRAIL) return;
-     if (opcode!=OPCODE_SIGNAL) continue;
-     byte redpin=GET_OPERAND(0);
-     if (redpin!=id)continue;
-     byte amberpin=GET_OPERAND(1);
-     byte greenpin=GET_OPERAND(2);
-     // If amberpin is zero, synthesise amber from red+green
-     IODevice::write(redpin,red || (amber && (amberpin==0)));
-     if (amberpin) IODevice::write(amberpin,amber);
-     if (greenpin) IODevice::write(greenpin,green || (amber && (amberpin==0)));
-     return;
-   }
-  } 
- void RMFT2::turnoutEvent(int16_t turnoutId, bool closed) {
-    
-    // Check we dont already have a task running this turnout
-    RMFT2 * task=loopTask;                 
-    while(task) {
-      if (task->onTurnoutId==turnoutId) {
-        DIAG(F("Recursive ONTHROW/ONCLOSE for Turnout %d"),turnoutId);
-        return;
-        }
-      task=task->next;      
-      if (task==loopTask) break;      
-      }
-    // Hunt for an ONTHROW/ONCLOSE for this turnout   
-    byte huntFor=closed ?  OPCODE_ONCLOSE : OPCODE_ONTHROW ;
-    // caution hides class progCounter;
-    for (int progCounter=0;; SKIPOP){
-     byte opcode=GET_OPCODE;
-     if (opcode==OPCODE_ENDEXRAIL) return;
-     if (opcode!=huntFor) continue;
-     if (turnoutId!=(int16_t)GET_OPERAND(0)) continue;
-     task=new RMFT2(progCounter);  // new task starts at this instruction
-     task->onTurnoutId=turnoutId; // flag for recursion detector
-     return;
-   }
- }
- 
- void RMFT2::printMessage2(const FSH * msg) {
-        DIAG(F("EXRAIL(%d) %S"),loco,msg);
-   }
-
-// This is called by emitRouteDescriptions to emit a withrottle description for a route or autoomation. 
-void RMFT2::emitRouteDescription(Print * stream, char type, int id, const FSH * description) {
- StringFormatter::send(stream,F("]\\[%c%d}|{%S}|{%c"),
-              type,id,description, type=='R'?'2':'4');
-}
- 

Release_Notes/release_notes_v4.0.0.md

@@ -0,0 +1,284 @@
+Version 4.0 Release Notes
+*************************
+
+The DCC-EX Team is pleased to release CommandStation-EX-v4.0.0 as a Production Release.  Release v4.0.0 is a Major release that adds significant new product design, plus Automation features and bug fixes. The team continues improving the architecture of DCC++EX to make it more flexible and optimizing the code so as to get more performance from the Arduino (and other) microprocessors.  This release includes all of the Point Releases from v3.2.0 to v3.2.0 rc13.
+
+**Downloads (zip and tar.gz) below. These are named without version number in the folder name to make the Arduino IDE happy.**
+
+[CommandStation-EX.zip](https://github.com/DCC-EX/CommandStation-EX/releases/download/v4.0.0-Prod/CommandStation-EX.zip)
+
+
+[CommandStation-EX.tar.gz](https://github.com/DCC-EX/CommandStation-EX/releases/download/v0.0.0-Prod/CommandStation-EX.tar.gz)
+
+**Known Issues**
+
+- **Wi-Fi** - Requires sending `<AT>` commands from a serial monitor if you want to switch between AP mode and STA station mode after initial setup
+- **Pololu Motor Shield** - is supported with this release, but the user may have to adjust timings to enable programming mode due to limitations in its current sensing circuitry
+
+**All New Major DCC++EX 4.0.0 features**
+
+- **New HAL Hardware Abstraction Layer API** that automatically detects and greatly simplifies interfacing to many predefined accessory boards for servos, signals & sensors and added I/O (digital and analog inputs and outputs, servos etc). 
+- HAL Support for;
+  - MCP23008, MCP23017 and PCF9584 I2C GPIO Extender modules. 
+  - PCA9685 PWM (servo & signal) control modules. 
+  - Analogue inputs on Arduino pins and on ADS111x I2C modules. 
+  - MP3 sound playback via DFPlayer module. 
+  - HC-SR04 Ultrasonic range sensor module. 
+  - VL53L0X Laser range sensor module (Time-Of-Flight). 
+  - A new `<D HAL SHOW>` command to list the HAL devices attached to the command station
+ 
+**New Command Station Broadcast throttle logic**
+
+- Synchronizes multiple WiThrottles and PC based JMRI Throttles for direction, speed and F-key updates
+
+**New ‘Discovered Servers’ on WiFi Throttles**
+
+- Our New multicast Dynamic Network Server (mDNS) enhancement allows us to display the available WiFi server connections to a DCC++EX Command Station. Selecting it allows your WiThrottle App to connect to and load Server Rosters and function keys to your throttle from the new DCC++EX Command Station Server Roster.
+
+**New DCC++EX 4.0.0 with EX-RAIL Extended Railroad Automation Instruction Language**
+
+- Use to control your entire layout or as a separate accessory/animation controller
+- Awesome, cleverly powerful yet simple user friendly scripting language for user built Automation & Routing scripts. 
+- You can control Engines, Sensors, Turnouts, Signals, Outputs and Accessories that are entered into your new myAutomation.h file, then uploaded into the DCC++EX Command Station.
+- EX-RAIL scripts are automatically displayed as Automation {Handoff} and Route {Set} buttons on supported WiFi Throttle Apps.
+
+**New EX-RAIL ‘Roster’ Feature**
+
+- List and store user defined engine roster & function keys inside the command station, and automatically load them in WiFi Throttle Apps.
+- When choosing “DCC++EX” from discovered servers an Engine Driver or WiThrottle is directly connected to the Command Station. 
+- The EX-RAIL ’ROSTER’ command allows all the engine numbers, names and function keys you’ve listed in your myAutomation.h file to automatically upload the Command Station's ‘Server Roster’ into your Engine Driver and WiThrottle Apps.  
+
+**New JMRI 4.99.2 and above specific DCC++EX 4.0 features**
+
+- Enhanced JMRI DCC++ Configure Base Station pane for building and maintaining Sensor, Turnout and Output devices, or these can automatically be populated from the DCC++EX Command Station's mySetup.h file into JMRI.
+
+- JMRI now supports multiple serial connected DCC++EX Command Stations, to display and track separate "Send DCC++ Command" and "DCC++ Traffic" Monitors for each Command Station at the same time.
+  For example: Use an Uno DCC++EX DecoderPro Programming Station {DCC++Prg} on a desktop programming track and a second Mega DCC++EX EX-RAIL Command Station for Operations {DCC++Ops} on the layout with an additional `<JOINED>` programming spur or siding track for acquiring an engine and ‘Drive Away’ onto the mainline (see the DriveAway feature for more information).
+
+**DCC++EX 4.0.0 additional product enhancements**
+
+- Additional Motor Shields and Motor Board {boosters) supported
+- Additional Accessory boards supported for GPIO expansion, Sensors, Servos & Signals
+- Additional diagnostic commands like ‘D ACK RETRY’ and ‘D EXRAIL ON’ events, ‘D HAL SHOW’ devices and ‘D SERVO’ positions, and ‘D RESET’ the command station while maintaining the serial connection with JMRI
+- Automatic retry on failed ACK detection to give decoders another chance
+- New EX-RAIL ’/’ slash command allows JMRI to directly communicate with many EX-RAIL scripts
+- Turnout class revised to expand turnout capabilities and allow turnout names/descriptors to display in WiThrottle Apps.
+- Build turnouts through either or both mySetup.h and myAutomation.h files, and have them automatically passed to, and populate, JMRI Turnout Tables
+- Turnout user names display in Engine Driver & WiThrottles
+- Output class now allows ID > 255. 
+- Configuration options to globally flip polarity of DCC Accessory states when driven from `<a>` command and `<T>` command.
+- Increased use of display for showing loco decoder programming information. 
+- Can disable EEPROM memory code to allow room for DCC++EX 4.0 to fit on a Uno Command Station
+- Can define border between long and short addresses 
+- Native non-blocking I2C drivers for AVR and Nano architectures (fallback to blocking Wire library for other platforms). 
+- EEPROM layout change - deletes EEPROM contents on first start following upgrade. 
+
+**4.0.0 Bug Fixes**
+
+- Compiles on Nano Every
+- Diagnostic display of ack pulses >32ms
+- Current read from wrong ADC during interrupt
+- AT(+) Command Pass Through 
+- CiDAP WiFi Drop out and the WiThrottle F-key looping error corrected
+- One-off error in CIPSEND drop
+- Common Fault Pin Error
+- Uno Memory Utilization optimized
+
+#### Summary of Release 3.1.0 key features and/or bug fixes by Point Release
+
+**Summary of the key new features added to CommandStation-EX V3.0.16**
+
+- Ignore CV1 bit 7 read if rejected by a non NMRA compliant decoder when identifying loco id
+
+**Summary of the key new features added to CommandStation-EX V3.0.15**
+
+- Send function commands just once instead of repeating them 4 times
+
+**Summary of the key new features added to CommandStation-EX V3.0.14**
+
+- Add feature to tolerate decoders that incorrectly have gaps in their ACK pulse
+- Provide proper track power management when joining and unjoining tracks with <1 JOIN>
+
+**Summary of the key new features added to CommandStation-EX V3.0.13**
+
+- Fix for CAB Functions greater than 127
+
+**Summary of the key new features added to CommandStation-EX V3.0.12**
+
+- Fixed clear screen issue for nanoEvery and nanoWifi
+
+**Summary of the key new features added to CommandStation-EX V3.0.11**
+
+- Reorganized files for support of 128 speed steps
+
+**Summary of the key new features added to CommandStation-EX V3.0.10**
+
+- Added Support for the Teensy 3.2, 3.5, 3.6, 4.0 and 4.1 MCUs
+- No functional change just changes to avoid complier warnings for Teensy/nanoEvery
+
+**Summary of the key new features added to CommandStation-EX V3.0.9**
+
+- Rearranges serial newlines for the benefit of JMRI
+- Major update for efficiencies in displays (LCD, OLED)
+- Add I2C Support functions
+
+**Summary of the key new features added to CommandStation-EX V3.0.8**
+
+- Wraps <* *> around DIAGS for the benefit of JMRI
+
+**Summary of the key new features added to CommandStation-EX V3.0.7**
+
+- Implemented support for older 28 apeed step decoders - Option to turn on 28 step speed decoders in addition to 128. If set, all locos will use 28 steps.
+- Improved overload messages with raw values (relative to offset)
+
+**Summary of the key new features added to CommandStation-EX V3.0.6**
+
+- Prevent compiler warning about deprecated B constants
+- Fix Bug that did not let us transmit 5 byte sized packets - 5 Byte commands like PoM (programming on main) were not being sent correctly
+- Support for Huge function numbers (DCC BinaryStateControl) - Support Functions beyond F28
+- <!> ESTOP all - New command to emergency stop all locos on the main track
+- <- [cab]> estop and forget cab/all cabs - Stop and remove loco from the CS. Stops the repeating throttle messages
+- `<D RESET>` command to reboot Arduino
+- Automatic sensor offset detect
+- Improved startup msgs from Motor Drivers (accuracy and auto sense factors)
+- Drop post-write verify - No need to double check CV writes. Writes are now even faster.
+- Allow current sense pin set to UNUSED_PIN - No need to ground an unused analog current pin. Produce startup warning and callback -2 for prog track cmds.
+
+**Summary of the key new features added to CommandStation-EX V3.0.5**
+
+- Fix Fn Key startup with loco ID and fix state change for F16-28
+- Removed ethernet mac config and made it automatic
+- Show wifi ip and port on lcd
+- Auto load config.example.h with warning
+- Dropped example .ino files
+- Corrected .ino comments
+- Add Pololu fault pin handling
+- Waveform speed/simplicity improvements
+- Improved pin speed in waveform
+- Portability to nanoEvery and UnoWifiRev2 CPUs
+- Analog read speed improvements
+- Drop need for DIO2 library
+- Improved current check code
+- Linear command
+- Removed need for ArduinoTimers files
+- Removed option to choose different timer
+- Added EX-RAIL hooks for automation in future version
+- Fixed Turnout list
+- Allow command keywords in mixed case
+- Dropped unused memstream
+- PWM pin accuracy if requirements met
+
+**Summary of the key new features added to CommandStation-EX V3.0.4**
+
+- "Drive-Away" Feature - added so that throttles like Engine Driver can allow a loco to be programmed on a usable, electrically isolated programming track and then drive off onto the main track
+- WiFi Startup Fixes
+
+**Summary of the key new features added to CommandStation-EX V3.0.3**
+
+- Command to write loco address and clear consist
+- Command will allow for consist address
+- Startup commands implemented
+
+**Summary of the key new features added to CommandStation-EX V3.0.2:**
+
+- Create new output for current in mA for `<c>` command - New current response outputs current in mA, overlimit current, and maximum board capable current
+- Simultaneously update JMRI to handle new current meter
+
+**Summary of the key new features added to CommandStation-EX V3.0.1:**
+
+- Add back fix for jitter
+- Add Turnouts, Outputs and Sensors to `<s>` command output
+
+**CommandStation-EX V3.0.0:**
+
+**Release v3.0.0 was a major rewrite if earlier versions of DCC++.  The code base was re-architeced and core changes were made to the Waveform generator to reduce overhead and make better use of Arduino.** **Summary of the key new features added in Release v3.0.0 include:**
+
+- **New USB Browser Based Throttle** - WebThrottle-EX is a full front-end to controller to control the CS to run trains.
+- **WiFi Support** - AP and station modes supported. Auto-detection of an ESP8266 WiFi module with AT firmware on a Mega's serial port. Connection to JMRI and WiThrottle clients.
+- **Withrottle Integrations** - Act as a host for up to four WiThrottle clients concurrently.
+- **Add LCD/OLED support** - OLED supported on Mega only
+- **Improved CV programming routines** - checks for length of CV pulse, and breaks out of the wait state once it has received an ACK, now reading one CV per second.
+- **Improved current sensing** - rewrote current sensing routines for safer operation. Current thresholds based on milliamps, not magic numbers
+- **Individual track power control** - Ability to toggle power on either or both tracks, and to "JOIN" the tracks and make them output the same waveform for multiple power districts.
+- **Single or Dual-Pin PWM output** - Allows control of H-bridges with PH/EN or dual PWM inputs
+- **New, simpler function command** - `<F>` command allows setting functions based on their number, not based on a code as in `<f>`
+- **Function reminders** - Function reminders are sent in addition to speed reminders
+- **Functions to F28** - All NMRA functions are now supported
+- **Filters and user functions** - Ability to filter commands in the parser and execute custom code based on them. (ex: Redirect Turnout commands via NRF24)
+- **Diagnostic `<D>` commands** - See documentation for a full list of new diagnostic commands
+- **Rewrote DCC++ Parser** - more efficient operation, accepts multi-char input and uses less RAM
+- **Rewritten waveform generator** - capable of using any pin for DCC waveform out, eliminating the need for jumpers
+- **Rewritten packet generator** - Simplify and make smaller, remove idea of "registers" from original code
+- **Add free RAM messages** - Free RAM messages are now printed whenever there is a decerase in available RAM
+- **Fix EEPROM bugs**
+- **Number of locos discovery command** - `<#>` command
+- **Support for more locomotives** - 20 locomotives on an UNO and 50 an a Mega.
+- **Automatic slot management** - slot variable in throttle/function commands are ignored and slot management is taken care of automatically. `<->` and `<- CAB>` commands added to release locos from memory and stop packets to the track.
+
+**Key Contributors**
+
+**Project Lead**
+
+- Fred Decker - Holly Springs, North Carolina, USA (FlightRisk)
+
+**CommandStation-EX Developers**
+
+- Chris Harlow - Bournemouth, UK (UKBloke)
+- Harald Barth - Stockholm, Sweden (Haba)
+- Neil McKechnie - Worcestershire, UK (NeilMck)
+- Fred Decker - Holly Springs, North Carolina, USA (FlightRisk)
+- Dave Cutting - Logan, Utah, USA (Dave Cutting/ David Cutting)
+- M Steve Todd - Oregon, USA (MSteveTodd) 
+- Scott Catalano - Pennsylvania
+- Gregor Baues - Île-de-France, France (grbba)
+
+**Engine Driver and JMRI Interface**
+
+- M Steve Todd
+
+**exInstaller Software**
+
+- Anthony W - Dayton, Ohio, USA (Dex, Dex++)
+
+**Website and Documentation**
+
+- Mani Kumar - Bangalor, India (Mani / Mani Kumar)
+- Fred Decker - Holly Springs, North Carolina, USA (FlightRisk)
+- Dave Cutting - Logan, Utah, USA (Dave Cutting/ David Cutting)
+- Roger Beschizza - Dorset, UK (Roger Beschizza)
+- Keith Ledbetter - Chicago, Illinois, USA (Keith Ledbetter)
+- Kevin Smith - Rochester Hills, Michigan USA (KC Smith)
+- Colin Grabham - Central NSW, Australia (Kebbin)
+
+**WebThrotle-EX**
+
+- Fred Decker - Holly Springs, NC (FlightRisk/FrightRisk)
+- Mani Kumar - Bangalor, India (Mani /Mani Kumar)
+- Matt H - Somewhere in Europe
+
+**Beta Testing / Release Management / Support**
+
+- Larry Dribin - Release Management
+- Kevin Smith - Rochester Hills, Michigan USA (KC Smith)
+- Herb Morton - Kingwood Texas, USA (Ash++)
+- Keith Ledbetter
+- Brad Van der Elst
+- Andrew Pye
+- Mike Bowers
+- Randy McKenzie
+- Roberto Bravin
+- Sam Brigden
+- Alan Lautenslager
+- Martin Bafver
+- Mário André Silva
+- Anthony Kochevar
+- Gajanatha Kobbekaduwe
+- Sumner Patterson
+- Paul - Virginia, USA
+
+**Downloads (zip and tar.gz) below. These are named without version number in the folder name to make the Arduino IDE happy.**
+
+[CommandStation-EX.zip](https://github.com/DCC-EX/CommandStation-EX/releases/download/v4.0.0-Prod/CommandStation-EX.zip)
+
+
+[CommandStation-EX.tar.gz](https://github.com/DCC-EX/CommandStation-EX/releases/download/v4.0.0-Prod/CommandStation-EX.tar.gz)

RingStream.cpp

@@ -1,5 +1,6 @@
 /*
- *  © 2020, Chris Harlow. All rights reserved.
+ *  © 2020-2021 Chris Harlow
+ *  All rights reserved.
  *  
  *  This file is part of DCC-EX CommandStation-EX
  *
@@ -103,3 +104,12 @@ bool RingStream::commit() {
   _buffer[_mark]=lowByte(_count);
   return true; // commit worked
 }
+void RingStream::flush() {
+  _pos_write=0;
+  _pos_read=0;
+  _buffer[0]=0;
+}
+void RingStream::printBuffer(Print * stream) {
+  _buffer[_pos_write]='\0';
+  stream->print((char *)_buffer);
+}

RingStream.h

@@ -1,7 +1,8 @@
 #ifndef RingStream_h
 #define RingStream_h
 /*
- *  © 2020, Chris Harlow. All rights reserved.
+ *  © 2020-2021 Chris Harlow
+ *  All rights reserved.
  *  
  *  This file is part of DCC-EX CommandStation-EX
  *
@@ -34,7 +35,8 @@ class RingStream : public Print {
     void mark(uint8_t b);
     bool commit();
     uint8_t peekTargetMark();
-    
+    void printBuffer(Print * streamer);
+    void flush();
  private:
    int _len;
    int _pos_write;

SSD1306Ascii.cpp

@@ -89,28 +89,93 @@ const uint8_t FLASH SSD1306AsciiWire::blankPixels[30] =
   {0x40,        // First byte specifies data mode
   0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0};  
 
+
+//==============================================================================
+// this section is based on https://github.com/adafruit/Adafruit_SSD1306
+
+/** Initialization commands for a 128x32 or 128x64 SSD1306 oled display. */
+const uint8_t FLASH SSD1306AsciiWire::Adafruit128xXXinit[] = {
+    // Init sequence for Adafruit 128x32/64 OLED module
+    0x00,                              // Set to command mode
+    SSD1306_DISPLAYOFF,
+    SSD1306_SETDISPLAYCLOCKDIV, 0x80,  // the suggested ratio 0x80 
+    SSD1306_SETMULTIPLEX, 0x3F,        // ratio 64 (initially)
+    SSD1306_SETDISPLAYOFFSET, 0x0,     // no offset
+    SSD1306_SETSTARTLINE | 0x0,        // line #0
+    SSD1306_CHARGEPUMP, 0x14,          // internal vcc
+    SSD1306_MEMORYMODE, 0x02,          // page mode
+    SSD1306_SEGREMAP | 0x1,            // column 127 mapped to SEG0
+    SSD1306_COMSCANDEC,                // column scan direction reversed
+    SSD1306_SETCOMPINS, 0X12,          // set COM pins
+    SSD1306_SETCONTRAST, 0x7F,         // contrast level 127
+    SSD1306_SETPRECHARGE, 0xF1,        // pre-charge period (1, 15)
+    SSD1306_SETVCOMDETECT, 0x40,       // vcomh regulator level
+    SSD1306_DISPLAYALLON_RESUME,
+    SSD1306_NORMALDISPLAY,
+    SSD1306_DISPLAYON
+};
+
+//------------------------------------------------------------------------------
+// This section is based on https://github.com/stanleyhuangyc/MultiLCD
+
+/** Initialization commands for a 128x64 SH1106 oled display. */
+const uint8_t FLASH SSD1306AsciiWire::SH1106_132x64init[] = {
+  0x00,                                  // Set to command mode
+  SSD1306_DISPLAYOFF,
+  SSD1306_SETDISPLAYCLOCKDIV, 0X80,      // set osc division
+  SSD1306_SETMULTIPLEX, 0x3F,            // ratio 64
+  SSD1306_SETDISPLAYOFFSET, 0X00,        // set display offset
+  SSD1306_SETSTARTPAGE | 0X0,            // set page address
+  SSD1306_SETSTARTLINE | 0x0,            // set start line
+  SH1106_SET_PUMP_MODE, SH1106_PUMP_ON,  // set charge pump enable
+  SSD1306_SEGREMAP | 0X1,                // set segment remap
+  SSD1306_COMSCANDEC,                    // Com scan direction
+  SSD1306_SETCOMPINS, 0X12,              // set COM pins
+  SSD1306_SETCONTRAST, 0x80,             // 128
+  SSD1306_SETPRECHARGE, 0X1F,            // set pre-charge period
+  SSD1306_SETVCOMDETECT,  0x40,          // set vcomh
+  SH1106_SET_PUMP_VOLTAGE | 0X2,         // 8.0 volts
+  SSD1306_NORMALDISPLAY,                 // normal / reverse
+  SSD1306_DISPLAYON
+};
+
 //==============================================================================
 // SSD1306AsciiWire Method Definitions
 //------------------------------------------------------------------------------
  
 // Constructor
 SSD1306AsciiWire::SSD1306AsciiWire(int width, int height) {
+  m_displayWidth = width;
+  m_displayHeight = height;
   // Set size in characters in base class
   lcdRows = height / 8;
   lcdCols = width / 6;
+  m_col = 0;
+  m_row = 0;
+  m_colOffset = 0;
 
   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);
-      if (width == 132)
-        begin(&SH1106_132x64, address);
-      else if (height == 32)
-        begin(&Adafruit128x32, address);
-      else
-        begin(&Adafruit128x64, address);
       // Set singleton address
       lcdDisplay = this;
       clear();
@@ -132,23 +197,6 @@ void SSD1306AsciiWire::clearNative() {
   }
 }
 
-// Initialise device
-void SSD1306AsciiWire::begin(const DevType* dev, uint8_t i2cAddr) {
-  m_i2cAddr = i2cAddr;
-  m_col = 0;
-  m_row = 0;
-  const uint8_t* table = (const uint8_t*)GETFLASHW(&dev->initcmds);
-  uint8_t size = GETFLASH(&dev->initSize);
-  m_displayWidth = GETFLASH(&dev->lcdWidth);
-  m_displayHeight = GETFLASH(&dev->lcdHeight);
-  m_colOffset = GETFLASH(&dev->colOffset);
-  I2CManager.write_P(m_i2cAddr, table, size);
-  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
-}
-
 //------------------------------------------------------------------------------
 
 // Set cursor position (by text line)
@@ -209,82 +257,6 @@ size_t SSD1306AsciiWire::writeNative(uint8_t ch) {
   return 1;
 }
 
-//==============================================================================
-// this section is based on https://github.com/adafruit/Adafruit_SSD1306
-
-/** Initialization commands for a 128x32 or 128x64 SSD1306 oled display. */
-const uint8_t FLASH SSD1306AsciiWire::Adafruit128xXXinit[] = {
-    // Init sequence for Adafruit 128x32/64 OLED module
-    0x00,                              // Set to command mode
-    SSD1306_DISPLAYOFF,
-    SSD1306_SETDISPLAYCLOCKDIV, 0x80,  // the suggested ratio 0x80 
-    SSD1306_SETMULTIPLEX, 0x3F,        // ratio 64 (initially)
-    SSD1306_SETDISPLAYOFFSET, 0x0,     // no offset
-    SSD1306_SETSTARTLINE | 0x0,        // line #0
-    SSD1306_CHARGEPUMP, 0x14,          // internal vcc
-    SSD1306_MEMORYMODE, 0x02,          // page mode
-    SSD1306_SEGREMAP | 0x1,            // column 127 mapped to SEG0
-    SSD1306_COMSCANDEC,                // column scan direction reversed
-    SSD1306_SETCOMPINS, 0X12,          // set COM pins
-    SSD1306_SETCONTRAST, 0x7F,         // contrast level 127
-    SSD1306_SETPRECHARGE, 0xF1,        // pre-charge period (1, 15)
-    SSD1306_SETVCOMDETECT, 0x40,       // vcomh regulator level
-    SSD1306_DISPLAYALLON_RESUME,
-    SSD1306_NORMALDISPLAY,
-    SSD1306_DISPLAYON
-};
-
-/** Initialize a 128x32 SSD1306 oled display. */
-const DevType FLASH SSD1306AsciiWire::Adafruit128x32 = {
-  Adafruit128xXXinit,
-  sizeof(Adafruit128xXXinit),
-  128,
-  32,
-  0
-};
-
-/** Initialize a 128x64 oled display. */
-const DevType FLASH SSD1306AsciiWire::Adafruit128x64 = {
-  Adafruit128xXXinit,
-  sizeof(Adafruit128xXXinit),
-  128,
-  64,
-  0
-};
-//------------------------------------------------------------------------------
-// This section is based on https://github.com/stanleyhuangyc/MultiLCD
-
-/** Initialization commands for a 128x64 SH1106 oled display. */
-const uint8_t FLASH SSD1306AsciiWire::SH1106_132x64init[] = {
-  0x00,                                  // Set to command mode
-  SSD1306_DISPLAYOFF,
-  SSD1306_SETDISPLAYCLOCKDIV, 0X80,      // set osc division
-  SSD1306_SETMULTIPLEX, 0x3F,            // ratio 64
-  SSD1306_SETDISPLAYOFFSET, 0X00,        // set display offset
-  SSD1306_SETSTARTPAGE | 0X0,            // set page address
-  SSD1306_SETSTARTLINE | 0x0,            // set start line
-  SH1106_SET_PUMP_MODE, SH1106_PUMP_ON,  // set charge pump enable
-  SSD1306_SEGREMAP | 0X1,                // set segment remap
-  SSD1306_COMSCANDEC,                    // Com scan direction
-  SSD1306_SETCOMPINS, 0X12,              // set COM pins
-  SSD1306_SETCONTRAST, 0x80,             // 128
-  SSD1306_SETPRECHARGE, 0X1F,            // set pre-charge period
-  SSD1306_SETVCOMDETECT,  0x40,          // set vcomh
-  SH1106_SET_PUMP_VOLTAGE | 0X2,         // 8.0 volts
-  SSD1306_NORMALDISPLAY,                 // normal / reverse
-  SSD1306_DISPLAYON
-};
-
-/** Initialize a 132x64 oled SH1106 display. */
-const DevType FLASH SSD1306AsciiWire::SH1106_132x64 =  {
-  SH1106_132x64init,
-  sizeof(SH1106_132x64init),
-  128,
-  64,
-  2    // SH1106 is a 132x64 controller but most OLEDs are only attached
-       // to columns 2-129.
-};
-
 
 //------------------------------------------------------------------------------
 

SSD1306Ascii.h

@@ -32,21 +32,6 @@
 //#define NOLOWERCASE
 
 //------------------------------------------------------------------------------
-// Device initialization structure.
-
-struct DevType {
-  /* Pointer to initialization command bytes. */
-  const uint8_t* initcmds;
-  /* Number of initialization bytes */
-  const uint8_t initSize;
-  /* Width of the display in pixels */
-  const uint8_t lcdWidth;
-  /** Height of the display in pixels. */
-  const uint8_t lcdHeight;
-  /* Column offset RAM to display.  Used to pick start column of SH1106. */
-  const uint8_t colOffset;
-};
-
 // Constructor
 class SSD1306AsciiWire : public LCDDisplay {
  public:
@@ -55,25 +40,17 @@ class SSD1306AsciiWire : public LCDDisplay {
   SSD1306AsciiWire(int width, int height);
 
   // Initialize the display controller.
-  void begin(const DevType* dev, uint8_t i2cAddr);
+  void begin(uint8_t i2cAddr);
 
   // Clear the display and set the cursor to (0, 0).
   void clearNative() override;
 
   // Set cursor to start of specified text line
   void setRowNative(byte line) override;
-
-  // Initialize the display controller.
-  void init(const DevType* dev);
   
   // Write one character to OLED
   size_t writeNative(uint8_t c) override;
 
-  // Display characteristics / initialisation
-  static const DevType FLASH Adafruit128x32;
-  static const DevType FLASH Adafruit128x64;
-  static const DevType FLASH SH1106_132x64;
-
   bool isBusy() override { return requestBlock.isBusy(); }
 
  private:

Sensors.cpp

@@ -1,8 +1,10 @@
 /*
- *  © 2020, Chris Harlow. All rights reserved.
- *  © 2021, modified by Neil McKechnie. All rights reserved.
+ *  © 2021 Neil McKechnie
+ *  © 2020-2021 Harald Barth
+ *  © 2020-2021 Chris Harlow
+ *  All rights reserved.
  *  
- *  This file is part of Asbelos DCC API
+ *  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
@@ -67,8 +69,11 @@ decide to ignore the <q ID> return and only react to <Q ID> triggers.
 **********************************************************************/
 
 #include "StringFormatter.h"
+#include "CommandDistributor.h"
 #include "Sensors.h"
+#ifndef DISABLE_EEPROM
 #include "EEStore.h"
+#endif
 #include "IODevice.h"
 
 
@@ -85,7 +90,7 @@ decide to ignore the <q ID> return and only react to <Q ID> triggers.
 // second part of the list is determined from by the 'firstPollSensor' pointer.
 ///////////////////////////////////////////////////////////////////////////////
 
-void Sensor::checkAll(Print *stream){
+void Sensor::checkAll(){
   uint16_t sensorCount = 0;
 
 #ifdef USE_NOTIFY
@@ -133,10 +138,8 @@ void Sensor::checkAll(Print *stream){
       readingSensor->active = readingSensor->inputState;
       readingSensor->latchDelay = minReadCount;  // Reset counter
       
-      if (stream != NULL) {
-        StringFormatter::send(stream, F("<%c %d>\n"), readingSensor->active ? 'Q' : 'q', readingSensor->data.snum);
-        pause = true;  // Don't check any more sensors on this entry
-      }
+      CommandDistributor::broadcastSensor(readingSensor->data.snum,readingSensor->active);
+      pause = true;  // Don't check any more sensors on this entry
     }
 
     // Move to next sensor in list.
@@ -275,7 +278,7 @@ bool Sensor::remove(int n){
 }
 
 ///////////////////////////////////////////////////////////////////////////////
-
+#ifndef DISABLE_EEPROM
 void Sensor::load(){
   struct SensorData data;
   Sensor *tt;
@@ -303,7 +306,7 @@ void Sensor::store(){
     EEStore::eeStore->data.nSensors++;
   }
 }
-
+#endif
 ///////////////////////////////////////////////////////////////////////////////
 
 Sensor *Sensor::firstSensor=NULL;
@@ -314,4 +317,4 @@ unsigned long Sensor::lastReadCycle=0;
 Sensor *Sensor::firstPollSensor = NULL;
 Sensor *Sensor::lastSensor = NULL;
 bool Sensor::inputChangeCallbackRegistered = false;
-#endif
+#endif

Sensors.h

@@ -1,5 +1,8 @@
 /*
- *  © 2020, Chris Harlow. All rights reserved.
+ *  © 2021 Neil McKechnie
+ *  © 2020-2021 Harald Barth
+ *  © 2020-2021 Chris Harlow
+ *  All rights reserved.
  *  
  *  This file is part of Asbelos DCC API
  *
@@ -68,12 +71,14 @@ public:
   Sensor *nextSensor;
 
   void setState(int state);
+#ifndef DISABLE_EEPROM
   static void load();
   static void store();
+#endif
   static Sensor *create(int id, VPIN vpin, int pullUp);
   static Sensor* get(int id);  
   static bool remove(int id);  
-  static void checkAll(Print *stream);
+  static void checkAll();
   static void printAll(Print *stream);
   static unsigned long lastReadCycle; // value of micros at start of last read cycle
   static const unsigned int cycleInterval = 10000; // min time between consecutive reads of each sensor in microsecs.

SerialManager.cpp

@@ -0,0 +1,82 @@
+ /*
+ *  © 2021 Chris Harlow
+ *  © 2022 Harald Barth
+ *  All rights reserved.
+ *  
+ *  This file is part of DCC++EX
+ *
+ *  This is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  It is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with CommandStation.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+#include "SerialManager.h"
+#include "DCCEXParser.h"
+SerialManager * SerialManager::first=NULL;
+
+SerialManager::SerialManager(Stream * myserial) {
+  serial=myserial;
+  next=first;
+  first=this;
+  bufferLength=0;
+  inCommandPayload=false; 
+} 
+
+void SerialManager::init() {
+  while (!Serial && millis() < 5000); // wait max 5s for Serial to start
+  Serial.begin(115200);
+  new SerialManager(&Serial);
+#ifdef SERIAL3_COMMANDS
+  Serial3.begin(115200);
+  new SerialManager(&Serial3);
+#endif
+#ifdef SERIAL2_COMMANDS
+  Serial2.begin(115200);
+  new SerialManager(&Serial2);
+#endif
+#ifdef SERIAL1_COMMANDS
+  Serial1.begin(115200);
+  new SerialManager(&Serial1);
+#endif
+}
+
+void SerialManager::broadcast(RingStream * ring) {
+    for (SerialManager * s=first;s;s=s->next) s->broadcast2(ring);
+}
+void SerialManager::broadcast2(RingStream * ring) {
+    ring->printBuffer(serial);
+}
+
+void SerialManager::loop() {
+    for (SerialManager * s=first;s;s=s->next) s->loop2();
+}
+
+void SerialManager::loop2() {
+    while (serial->available()) {
+        char ch = serial->read();
+        if (ch == '<') {
+            inCommandPayload = true;
+            bufferLength = 0;
+            buffer[0] = '\0';
+        }
+        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;
+        }
+    }
+    
+}

SerialManager.h

@@ -0,0 +1,49 @@
+ /*
+ *  © 2021 Chris Harlow
+ *  All rights reserved.
+ *  
+ *  This file is part of DCC++EX
+ *
+ *  This is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  It is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with CommandStation.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+#ifndef SerialManager_h
+#define SerialManager_h
+
+#include "Arduino.h"
+#include "defines.h"
+#include "RingStream.h"
+
+#ifndef COMMAND_BUFFER_SIZE
+ #define COMMAND_BUFFER_SIZE 100
+#endif
+
+class SerialManager {
+public:
+  static void init();
+  static void loop();
+  static void broadcast(RingStream * ring);
+  
+private:  
+  static SerialManager * first;
+  SerialManager(Stream * myserial);
+  void loop2();
+  void broadcast2(RingStream * ring);
+  Stream * serial;
+  SerialManager * next;
+  byte bufferLength;
+  byte buffer[COMMAND_BUFFER_SIZE]; 
+  bool inCommandPayload;
+};
+#endif

StringFormatter.cpp

@@ -99,6 +99,7 @@ void StringFormatter::send2(Print * stream,const FSH* format, va_list args) {
       case 'E': printEscapes(stream,(const FSH*)va_arg(args, char*)); break;
       case 'S': stream->print((const FSH*)va_arg(args, char*)); break;
       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 'b': stream->print(va_arg(args, int), BIN); break;
       case 'o': stream->print(va_arg(args, int), OCT); break;

Turnouts.cpp

@@ -1,10 +1,13 @@
 /*
- *  © 2021 Restructured Neil McKechnie
+ *  © 2021 Neil McKechnie
+ *  © 2021 M Steve Todd
+ *  © 2021 Fred Decker
+ *  © 2020-2021 Harald Barth
+ *  © 2020-2021 Chris Harlow
  *  © 2013-2016 Gregg E. Berman
- *  © 2020, Chris Harlow. All rights reserved.
- *  © 2020, Harald Barth.
+ *  All rights reserved.
  *  
- *  This file is part of Asbelos DCC API
+ *  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
@@ -22,9 +25,12 @@
 
 
 #include "defines.h"  // includes config.h
+#ifndef DISABLE_EEPROM
 #include "EEStore.h"
+#endif
 #include "StringFormatter.h"
-#include "RMFT2.h"
+#include "CommandDistributor.h"
+#include "EXRAIL2.h"
 #include "Turnouts.h"
 #include "DCC.h"
 #include "LCN.h"
@@ -68,11 +74,7 @@
     turnoutlistHash++;
   }
   
-  // For DCC++ classic compatibility, state reported to JMRI is 1 for thrown and 0 for closed; 
-  void Turnout::printState(Print *stream) { 
-    StringFormatter::send(stream, F("<H %d %d>\n"), 
-      _turnoutData.id, !_turnoutData.closed);
-  }
+  
 
   // Remove nominated turnout from turnout linked list and delete the object.
   /* static */ bool Turnout::remove(uint16_t id) {
@@ -112,14 +114,11 @@
 
     // I know it says setClosedStateOnly, but we need to tell others
     //  that the state has changed too.
-    #if defined(RMFT_ACTIVE)
+    #if defined(EXRAIL_ACTIVE)
       RMFT2::turnoutEvent(id, closeFlag);
     #endif
 
-      // Send message to JMRI etc. over Serial USB.  This is done here
-      // to ensure that the message is sent when the turnout operation
-      // is not initiated by a Serial command.
-      tt->printState(&Serial);
+    CommandDistributor::broadcastTurnout(id, closeFlag);
     return true;
   }
 
@@ -140,25 +139,25 @@
     bool ok = tt->setClosedInternal(closeFlag);
 
     if (ok) {
-      turnoutlistHash++;  // let withrottle know something changed
-    
+      
+#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);  
+        EEPROM.put(tt->_eepromAddress, tt->_turnoutData.flags);
+#endif
 
-    #if defined(RMFT_ACTIVE)
+    #if defined(EXRAIL_ACTIVE)
       RMFT2::turnoutEvent(id, closeFlag);
     #endif
 
-      // Send message to JMRI etc. over Serial USB.  This is done here
-      // to ensure that the message is sent when the turnout operation
-      // is not initiated by a Serial command.
-      tt->printState(&Serial);
+      // Send message to JMRI etc.
+      CommandDistributor::broadcastTurnout(id, closeFlag);
     }
     return ok;
   }
 
+#ifndef DISABLE_EEPROM
   // Load all turnout objects
   /* static */ void Turnout::load() {
     for (uint16_t i=0; i<EEStore::eeStore->data.nTurnouts; i++) {
@@ -212,13 +211,7 @@
 #endif
     return tt;
   }
-
-  // Display, on the specified stream, the current state of the turnout (1=thrown or 0=closed).
-  /* static */ void Turnout::printState(uint16_t id, Print *stream) {
-    Turnout *tt = get(id);
-    if (tt) tt->printState(stream);
-  }
-
+#endif
 
 /*************************************************************************************
  * ServoTurnout - Turnout controlled by servo device.
@@ -277,6 +270,7 @@
 
   // Load a Servo turnout definition from EEPROM.  The common Turnout data has already been read at this point.
   Turnout *ServoTurnout::load(struct TurnoutData *turnoutData) {
+#ifndef DISABLE_EEPROM
     ServoTurnoutData servoTurnoutData;
     // Read class-specific data from EEPROM
     EEPROM.get(EEStore::pointer(), servoTurnoutData);
@@ -286,6 +280,10 @@
     Turnout *tt = ServoTurnout::create(turnoutData->id, servoTurnoutData.vpin, servoTurnoutData.thrownPosition,
       servoTurnoutData.closedPosition, servoTurnoutData.profile, turnoutData->closed);
     return tt;
+#else
+    (void)turnoutData;
+    return NULL;
+#endif
   }
 
   // For DCC++ classic compatibility, state reported to JMRI is 1 for thrown and 0 for closed
@@ -308,6 +306,7 @@
   }
 
   void ServoTurnout::save() {
+#ifndef DISABLE_EEPROM
     // Write turnout definition and current position to EEPROM
     // First write common servo data, then
     // write the servo-specific data
@@ -315,6 +314,7 @@
     EEStore::advance(sizeof(_turnoutData));
     EEPROM.put(EEStore::pointer(), _servoTurnoutData);
     EEStore::advance(sizeof(_servoTurnoutData));
+#endif
   }
 
 /*************************************************************************************
@@ -367,6 +367,7 @@
 
   // Load a DCC turnout definition from EEPROM.  The common Turnout data has already been read at this point.
   /* static */ Turnout *DCCTurnout::load(struct TurnoutData *turnoutData) {
+#ifndef DISABLE_EEPROM
     DCCTurnoutData dccTurnoutData;
     // Read class-specific data from EEPROM
     EEPROM.get(EEStore::pointer(), dccTurnoutData);
@@ -376,6 +377,10 @@
     DCCTurnout *tt = new DCCTurnout(turnoutData->id, dccTurnoutData.address, dccTurnoutData.subAddress);
 
     return tt;
+#else
+    (void)turnoutData;
+    return NULL;
+#endif
   }
 
   void DCCTurnout::print(Print *stream) {
@@ -396,6 +401,7 @@
   }
 
   void DCCTurnout::save() {
+#ifndef DISABLE_EEPROM
     // Write turnout definition and current position to EEPROM
     // First write common servo data, then
     // write the servo-specific data
@@ -403,6 +409,7 @@
     EEStore::advance(sizeof(_turnoutData));
     EEPROM.put(EEStore::pointer(), _dccTurnoutData);
     EEStore::advance(sizeof(_dccTurnoutData));
+#endif
   }
 
 
@@ -441,6 +448,7 @@
 
   // Load a VPIN turnout definition from EEPROM.  The common Turnout data has already been read at this point.
   /* static */ Turnout *VpinTurnout::load(struct TurnoutData *turnoutData) {
+#ifndef DISABLE_EEPROM
     VpinTurnoutData vpinTurnoutData;
     // Read class-specific data from EEPROM
     EEPROM.get(EEStore::pointer(), vpinTurnoutData);
@@ -450,6 +458,10 @@
     VpinTurnout *tt = new VpinTurnout(turnoutData->id, vpinTurnoutData.vpin, turnoutData->closed);
 
     return tt;
+#else
+    (void)turnoutData;
+    return NULL;
+#endif
   }
 
   // Report 1 for thrown, 0 for closed.
@@ -465,6 +477,7 @@
   }
 
   void VpinTurnout::save() {
+#ifndef DISABLE_EEPROM
     // Write turnout definition and current position to EEPROM
     // First write common servo data, then
     // write the servo-specific data
@@ -472,6 +485,7 @@
     EEStore::advance(sizeof(_turnoutData));
     EEPROM.put(EEStore::pointer(), _vpinTurnoutData);
     EEStore::advance(sizeof(_vpinTurnoutData));
+#endif
   }
 
 

Turnouts.h

@@ -1,9 +1,13 @@
 /*
- *  © 2021 Restructured Neil McKechnie
+ *  © 2021 Neil McKechnie
+ *  © 2021 M Steve Todd
+ *  © 2021 Fred Decker
+ *  © 2020-2021 Harald Barth
+ *  © 2020-2021 Chris Harlow
  *  © 2013-2016 Gregg E. Berman
- *  © 2020, Chris Harlow. All rights reserved.
+ *  All rights reserved.
  *  
- *  This file is part of Asbelos DCC API
+ *  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
@@ -25,7 +29,7 @@
 //#define EESTOREDEBUG 
 #include "Arduino.h"
 #include "IODevice.h"
-
+#include "StringFormatter.h"
 
 // Turnout type definitions
 enum {
@@ -155,19 +159,20 @@ public:
 
   inline static Turnout *first() { return _firstTurnout; }
 
+#ifndef DISABLE_EEPROM
   // Load all turnout definitions.
   static void load();
   // Load one turnout definition
   static Turnout *loadTurnout();
   // Save all turnout definitions
   static void store();
-
+#endif
   static void printAll(Print *stream) {
     for (Turnout *tt = _firstTurnout; tt != 0; tt = tt->_nextTurnout)
-      tt->printState(stream);
+      StringFormatter::send(stream, F("<H %d %d>\n"),tt->getId(), tt->isThrown());
   }
 
-  static void printState(uint16_t id, Print *stream);
+
 };
 
 

WiThrottle.cpp

@@ -1,8 +1,12 @@
 /*
- *  © 2020, Chris Harlow. All rights reserved.
- *  © 2020, Harald Barth
+ *  © 2021 Neil McKechnie
+ *  © 2021 Mike S
+ *  © 2020-2022 Harald Barth
+ *  © 2020-2021 M Steve Todd
+ *  © 2020-2021 Chris Harlow
+ *  All rights reserved.
  *  
- *  This file is part of Asbelos DCC API
+ *  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
@@ -49,8 +53,8 @@
 #include "DIAG.h"
 #include "GITHUB_SHA.h"
 #include "version.h"
-#include "RMFT2.h"
-
+#include "EXRAIL2.h"
+#include "CommandDistributor.h"
 
 #define LOOPLOCOS(THROTTLECHAR, CAB)  for (int loco=0;loco<MAX_MY_LOCO;loco++) \
       if ((myLocos[loco].throttle==THROTTLECHAR || '*'==THROTTLECHAR) && (CAB<0 || myLocos[loco].cab==CAB))
@@ -111,122 +115,127 @@ void WiThrottle::parse(RingStream * stream, byte * cmdx) {
   if (Diag::WITHROTTLE) DIAG(F("%l WiThrottle(%d)<-[%e]"),millis(),clientid,cmd);
 
   if (initSent) {
-    // Send power state if different than last sent
-    bool currentPowerState = (DCCWaveform::mainTrack.getPowerMode()==POWERMODE::ON);
-    if (lastPowerState != currentPowerState) {
-      StringFormatter::send(stream,F("PPA%x\n"),currentPowerState);
-      lastPowerState = currentPowerState;  
-    }
     // Send turnout list if changed since last sent (will replace list on client)
     if (turnoutListHash != Turnout::turnoutlistHash) {
       StringFormatter::send(stream,F("PTL"));
       for(Turnout *tt=Turnout::first();tt!=NULL;tt=tt->next()){
           int id=tt->getId();
-          StringFormatter::send(stream,F("]\\[%d}|{%d}|{%c"), id, id, Turnout::isClosed(id)?'2':'4');
+          StringFormatter::send(stream,F("]\\[%d}|{"), id);
+#ifdef EXRAIL_ACTIVE
+	  RMFT2::emitTurnoutDescription(stream,id);
+#else   
+	  StringFormatter::send(stream,F("%d"), id);
+#endif  
+          StringFormatter::send(stream,F("}|{%c"), Turnout::isClosed(id)?'2':'4');
       }
       StringFormatter::send(stream,F("\n"));
       turnoutListHash = Turnout::turnoutlistHash; // keep a copy of hash for later comparison
     }
 
     else if (!exRailSent) {
-      // Send ExRail routes list if not already sent (but not at same time as turnouts above)
+      // Send EX-RAIL routes list if not already sent (but not at same time as turnouts above)
       exRailSent=true;
-#ifdef RMFT_ACTIVE
+#ifdef EXRAIL_ACTIVE
       RMFT2::emitWithrottleRouteList(stream);
-#endif    
+#endif
+      // allow heartbeat to slow down once all metadata sent     
+      StringFormatter::send(stream,F("*%d\n"),HEARTBEAT_SECONDS);
     }
   }
-
-   while (cmd[0]) {
-   switch (cmd[0]) {
-       case '*':  // heartbeat control
-            if (cmd[1]=='+') heartBeatEnable=true;
-            else if (cmd[1]=='-') heartBeatEnable=false;
-            break;
-       case 'P':  
-            if (cmd[1]=='P' && cmd[2]=='A' )  {  //PPA power mode 
-              DCCWaveform::mainTrack.setPowerMode(cmd[3]=='1'?POWERMODE::ON:POWERMODE::OFF);
-	      if (MotorDriver::commonFaultPin) // commonFaultPin prevents individual track handling
-		DCCWaveform::progTrack.setPowerMode(cmd[3]=='1'?POWERMODE::ON:POWERMODE::OFF);
-              StringFormatter::send(stream,F("PPA%x\n"),DCCWaveform::mainTrack.getPowerMode()==POWERMODE::ON);
-              lastPowerState = (DCCWaveform::mainTrack.getPowerMode()==POWERMODE::ON); //remember power state sent for comparison later
-            }
-#if defined(RMFT_ACTIVE)
-            else if (cmd[1]=='R' && cmd[2]=='A' && cmd[3]=='2' ) { // Route activate
-              // exrail routes are RA2Rn , Animations are RA2An 
-              int route=getInt(cmd+5);
-              uint16_t cab=cmd[4]=='A' ? mostRecentCab : 0; 
-              RMFT2::createNewTask(route, cab);
-            }
+  
+  while (cmd[0]) {
+    switch (cmd[0]) {
+    case '*':  // heartbeat control
+      if (cmd[1]=='+') heartBeatEnable=true;
+      else if (cmd[1]=='-') heartBeatEnable=false;
+      break;
+    case 'P':  
+      if (cmd[1]=='P' && cmd[2]=='A' )  {  //PPA power mode 
+	DCCWaveform::mainTrack.setPowerMode(cmd[3]=='1'?POWERMODE::ON:POWERMODE::OFF);
+	if (MotorDriver::commonFaultPin) // commonFaultPin prevents individual track handling
+	  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
+	// exrail routes are RA2Rn , Animations are RA2An 
+	int route=getInt(cmd+5);
+	uint16_t cab=cmd[4]=='A' ? mostRecentCab : 0; 
+	RMFT2::createNewTask(route, cab);
+      }
 #endif    
-            else if (cmd[1]=='T' && cmd[2]=='A') { // PTA accessory toggle 
-                int id=getInt(cmd+4); 
-                if (!Turnout::exists(id)) {
-                  // If turnout does not exist, create it
-                  int addr = ((id - 1) / 4) + 1;
-                  int subaddr = (id - 1) % 4;
-                  DCCTurnout::create(id,addr,subaddr);
-                  StringFormatter::send(stream, F("HmTurnout %d created\n"),id);
-                }
-                switch (cmd[3]) {
-            		  // T and C according to RCN-213 where 0 is Stop, Red, Thrown, Diverging.
-            		  case 'T': 
-            		     Turnout::setClosed(id,false);
-                     break;
-            		  case 'C': 
-                     Turnout::setClosed(id,true);
-                     break;
-            		  case '2': 
-            		     Turnout::setClosed(id,!Turnout::isClosed(id));
-                     break;
-            		  default :
-            		     Turnout::setClosed(id,true);
-                     break;
-                }
-		            StringFormatter::send(stream, F("PTA%c%d\n"),Turnout::isClosed(id)?'2':'4',id );
-		        }
-            break;
-       case 'N':  // Heartbeat (2), only send if connection completed by 'HU' message
-            if (initSent) { 
-              StringFormatter::send(stream, F("*%d\n"),HEARTBEAT_SECONDS); // return timeout value
-            }
-            break;
-       case 'M': // multithrottle
-            multithrottle(stream, cmd); 
-            break;
-       case 'H': // send initial connection info after receiving "HU" message
-            if (cmd[1] == 'U') {
-              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"),DCCWaveform::mainTrack.getPowerMode()==POWERMODE::ON);
-              lastPowerState = (DCCWaveform::mainTrack.getPowerMode()==POWERMODE::ON); //remember power state sent for comparison later
-              StringFormatter::send(stream,F("*%d\n"),HEARTBEAT_SECONDS);
-              initSent = true;
-            }
-            break;           
-      case 'Q': // 
-            LOOPLOCOS('*', -1) { // tell client to drop any locos still assigned to this WiThrottle
-              if (myLocos[loco].throttle!='\0') {
-                StringFormatter::send(stream, F("M%c-%c%d<;>\n"), myLocos[loco].throttle, LorS(myLocos[loco].cab), myLocos[loco].cab);
-              }
-            }
-            if (Diag::WITHROTTLE) DIAG(F("%l WiThrottle(%d) Quit"),millis(),clientid);
-            delete this; 
-            break;           
-   }
-   // skip over cmd until 0 or past \r or \n
-   while(*cmd !='\0' && *cmd != '\r' && *cmd !='\n') cmd++;
-   if (*cmd!='\0') cmd++; // skip \r or \n  
-   }           
-}
-int WiThrottle::getInt(byte * cmd) {
-    int i=0;
-    while (cmd[0]>='0' && cmd[0]<='9') {
-      i=i*10 + (cmd[0]-'0');
-      cmd++;
+      else if (cmd[1]=='T' && cmd[2]=='A') { // PTA accessory toggle 
+	int id=getInt(cmd+4); 
+	if (!Turnout::exists(id)) {
+	  // If turnout does not exist, create it
+	  int addr = ((id - 1) / 4) + 1;
+	  int subaddr = (id - 1) % 4;
+	  DCCTurnout::create(id,addr,subaddr);
+	  StringFormatter::send(stream, F("HmTurnout %d created\n"),id);
+	}
+	switch (cmd[3]) {
+	  // T and C according to RCN-213 where 0 is Stop, Red, Thrown, Diverging.
+	case 'T': 
+	  Turnout::setClosed(id,false);
+	  break;
+	case 'C': 
+	  Turnout::setClosed(id,true);
+	  break;
+	case '2': 
+	  Turnout::setClosed(id,!Turnout::isClosed(id));
+	  break;
+	default :
+	  Turnout::setClosed(id,true);
+	  break;
+	}
+	StringFormatter::send(stream, F("PTA%c%d\n"),Turnout::isClosed(id)?'2':'4',id );
+      }
+      break;
+    case 'N':  // Heartbeat (2), only send if connection completed by 'HU' message
+      if (initSent) { 
+	StringFormatter::send(stream, F("*%d\n"),HEARTBEAT_SECONDS); // return timeout value
+      }
+      break;
+    case 'M': // multithrottle
+      multithrottle(stream, cmd); 
+      break;
+    case 'H': // send initial connection info after receiving "HU" message
+      if (cmd[1] == 'U') {
+	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"),DCCWaveform::mainTrack.getPowerMode()==POWERMODE::ON);
+#ifdef EXRAIL_ACTIVE
+	RMFT2::emitWithrottleRoster(stream);
+#endif        
+	// set heartbeat to 1 second because we need to sync the metadata
+	StringFormatter::send(stream,F("*1\n"));
+	initSent = true;
+      }
+      break;           
+    case 'Q': // 
+      LOOPLOCOS('*', -1) { // tell client to drop any locos still assigned to this WiThrottle
+	if (myLocos[loco].throttle!='\0') {
+	  StringFormatter::send(stream, F("M%c-%c%d<;>\n"), myLocos[loco].throttle, LorS(myLocos[loco].cab), myLocos[loco].cab);
+	}
+      }
+      if (Diag::WITHROTTLE) DIAG(F("%l WiThrottle(%d) Quit"),millis(),clientid);
+      delete this; 
+      break;           
     }
-    return i;    
+    // skip over cmd until 0 or past \r or \n
+    while(*cmd !='\0' && *cmd != '\r' && *cmd !='\n') cmd++;
+    if (*cmd!='\0') cmd++; // skip \r or \n  
+  }           
+}
+
+int WiThrottle::getInt(byte * cmd) {
+  int i=0;
+  while (cmd[0]>='0' && cmd[0]<='9') {
+    i=i*10 + (cmd[0]-'0');
+    cmd++;
+  }
+  return i;    
 }
 
 int WiThrottle::getLocoId(byte * cmd) {
@@ -236,143 +245,183 @@ int WiThrottle::getLocoId(byte * cmd) {
 }
 
 void WiThrottle::multithrottle(RingStream * stream, byte * cmd){ 
-          char throttleChar=cmd[1];
-          int locoid=getLocoId(cmd+3); // -1 for *
-          byte * aval=cmd;
-          while(*aval !=';' && *aval !='\0') aval++;
-          if (*aval) aval+=2;  // skip ;>
-
-//       DIAG(F("Multithrottle aval=%c cab=%d"), aval[0],locoid);    
-       switch(cmd[2]) {
-          case '+':  // add loco request
-                if (cmd[3]=='*') { 
-                  // M+* means get loco from prog track, then join tracks ready to drive away
-                  // Stash the things the callback will need later
-                  stashStream= stream;
-                  stashClient=stream->peekTargetMark();
-                  stashThrottleChar=throttleChar;
-                  stashInstance=this;
-                  // ask DCC to call us back when the loco id has been read
-                  DCC::getLocoId(getLocoCallback); // will remove any previous join                    
-                  return; // return nothing in stream as response is sent later in the callback 
-                }
-                //return error if address zero requested
-                if (locoid==0) { 
-                  StringFormatter::send(stream, F("HMAddress '0' not supported!\n"), cmd[3] ,locoid);                    
-                  return;
-                }
-                //return error if L or S from request doesn't match DCC++ assumptions
-                if (cmd[3] != LorS(locoid)) { 
-                  StringFormatter::send(stream, F("HMLength '%c' not valid for %d!\n"), cmd[3] ,locoid);                    
-                  return;
-                }
-                //use first empty "slot" on this client's list, will be added to DCC registration list
-                for (int loco=0;loco<MAX_MY_LOCO;loco++) {
-                  if (myLocos[loco].throttle=='\0') { 
-                    myLocos[loco].throttle=throttleChar;
-                    myLocos[loco].cab=locoid;
-                    mostRecentCab=locoid;
-                    StringFormatter::send(stream, F("M%c+%c%d<;>\n"), throttleChar, cmd[3] ,locoid); //tell client to add loco
-                    //Get known Fn states from DCC 
-                    for(int fKey=0; fKey<=28; fKey++) { 
+  char throttleChar=cmd[1];
+  int locoid=getLocoId(cmd+3); // -1 for *
+  byte * aval=cmd;
+  while(*aval !=';' && *aval !='\0') aval++;
+  if (*aval) aval+=2;  // skip ;>
+  
+  //       DIAG(F("Multithrottle aval=%c cab=%d"), aval[0],locoid);    
+  switch(cmd[2]) {
+  case '+':  // add loco request
+    if (cmd[3]=='*') { 
+      // M+* means get loco from prog track, then join tracks ready to drive away
+      // Stash the things the callback will need later
+      stashStream= stream;
+      stashClient=stream->peekTargetMark();
+      stashThrottleChar=throttleChar;
+      stashInstance=this;
+      // ask DCC to call us back when the loco id has been read
+      DCC::getLocoId(getLocoCallback); // will remove any previous join                    
+      return; // return nothing in stream as response is sent later in the callback 
+    }
+    //return error if address zero requested
+    if (locoid==0) { 
+      StringFormatter::send(stream, F("HMAddress '0' not supported!\n"), cmd[3] ,locoid);                    
+      return;
+    }
+    //return error if L or S from request doesn't match DCC++ assumptions
+    if (cmd[3] != LorS(locoid)) { 
+      StringFormatter::send(stream, F("HMLength '%c' not valid for %d!\n"), cmd[3] ,locoid);                    
+      return;
+    }
+    //use first empty "slot" on this client's list, will be added to DCC registration list
+    for (int loco=0;loco<MAX_MY_LOCO;loco++) {
+      if (myLocos[loco].throttle=='\0') { 
+	myLocos[loco].throttle=throttleChar;
+	myLocos[loco].cab=locoid; 
+	myLocos[loco].functionMap=DCC::getFunctionMap(locoid); 
+	myLocos[loco].broadcastPending=true; // means speed/dir will be sent later
+	mostRecentCab=locoid;
+	StringFormatter::send(stream, F("M%c+%c%d<;>\n"), throttleChar, cmd[3] ,locoid); //tell client to add loco
+	int fkeys=29;
+	myLocos[loco].functionToggles=1<<2; // F2 (HORN)  is a non-toggle
+        
+#ifdef EXRAIL_ACTIVE
+	const char * functionNames=(char *) RMFT2::getRosterFunctions(locoid);
+	if (!functionNames) {
+	  // no roster, use presets as above 
+	}
+	else if (GETFLASH(functionNames)=='\0') {
+	  // "" = Roster but no functions given
+	  fkeys=0;
+	}  
+	else {
+	  // we have function names... 
+	  // scan names list emitting names, counting functions and 
+	  // flagging non-toggling things like horn.
+	  myLocos[loco].functionToggles =0;
+	  StringFormatter::send(stream, F("M%cL%c%d<;>]\\["), throttleChar,cmd[3],locoid);   
+	  fkeys=0;
+	  bool firstchar=true;
+	  for (int fx=0;;fx++) {
+	    char c=GETFLASH(functionNames+fx);
+	    if (c=='\0') {
+	      fkeys++;
+	      break;
+	    }
+	    if (c=='/') {
+	      fkeys++;
+	      StringFormatter::send(stream,F("]\\["));
+	      firstchar=true;
+	    }
+	    else if (firstchar && c=='*') {
+	      myLocos[loco].functionToggles |= 1UL<<fkeys;
+	      firstchar=false;
+	    } 
+	    else {
+	      firstchar=false;
+	      stream->write(c);
+	    }
+	  }
+	  StringFormatter::send(stream,F("\n"));
+	}
+        
+#endif
+	
+	for(int fKey=0; fKey<fkeys; fKey++) { 
                       int fstate=DCC::getFn(locoid,fKey);
-                        if (fstate>=0) StringFormatter::send(stream,F("M%cA%c%d<;>F%d%d\n"),throttleChar,cmd[3],locoid,fstate,fKey);                     
-                    }
-                    StringFormatter::send(stream, F("M%cA%c%d<;>V%d\n"), throttleChar, cmd[3], locoid, DCCToWiTSpeed(DCC::getThrottleSpeed(locoid)));
-                    StringFormatter::send(stream, F("M%cA%c%d<;>R%d\n"), throttleChar, cmd[3], locoid, DCC::getThrottleDirection(locoid));
-                    StringFormatter::send(stream, F("M%cA%c%d<;>s1\n"), throttleChar, cmd[3], locoid); //default speed step 128
-                    return;
-                  }
-               }
-               StringFormatter::send(stream, F("HMMax locos (%d) exceeded, %d not added!\n"), MAX_MY_LOCO ,locoid);                    
-               break;
-          case '-': // remove loco(s) from this client (leave in DCC registration)
-                 LOOPLOCOS(throttleChar, locoid) {
-                     myLocos[loco].throttle='\0';
-                     StringFormatter::send(stream, F("M%c-%c%d<;>\n"), throttleChar, LorS(myLocos[loco].cab), myLocos[loco].cab);
-                  }
-            
-            break;
-          case 'A':
-              locoAction(stream,aval, throttleChar, locoid);
-            }
+                      if (fstate>=0) StringFormatter::send(stream,F("M%cA%c%d<;>F%d%d\n"),throttleChar,cmd[3],locoid,fstate,fKey);                     
+	}
+	//speed and direction will be published at next broadcast cycle
+	StringFormatter::send(stream, F("M%cA%c%d<;>s1\n"), throttleChar, cmd[3], locoid); //default speed step 128
+	return;
+      }
+    }
+    StringFormatter::send(stream, F("HMMax locos (%d) exceeded, %d not added!\n"), MAX_MY_LOCO ,locoid);                    
+    break;
+  case '-': // remove loco(s) from this client (leave in DCC registration)
+    LOOPLOCOS(throttleChar, locoid) {
+      myLocos[loco].throttle='\0';
+      StringFormatter::send(stream, F("M%c-%c%d<;>\n"), throttleChar, LorS(myLocos[loco].cab), myLocos[loco].cab);
+    }
+    
+    break;
+  case 'A':
+    locoAction(stream,aval, throttleChar, locoid);
+  }
 }
 
 void WiThrottle::locoAction(RingStream * stream, byte* aval, char throttleChar, int cab){
-    // Note cab=-1 for all cabs in the consist called throttleChar.  
-//    DIAG(F("Loco Action aval=%c%c throttleChar=%c, cab=%d"), aval[0],aval[1],throttleChar, cab);
-     switch (aval[0]) {
-           case 'V':  // Vspeed
-             { 
-              int witSpeed=getInt(aval+1);
-              LOOPLOCOS(throttleChar, cab) {
-                mostRecentCab=myLocos[loco].cab;
-                DCC::setThrottle(myLocos[loco].cab, WiTToDCCSpeed(witSpeed), DCC::getThrottleDirection(myLocos[loco].cab));
-                StringFormatter::send(stream,F("M%cA%c%d<;>V%d\n"), throttleChar, LorS(myLocos[loco].cab), myLocos[loco].cab, witSpeed);
-                }
-             } 
-            break;
-           case 'F': //F onOff function
-              {
-		            bool funcstate;
-                bool pressed=aval[1]=='1';
-                int fKey = getInt(aval+2);
-                LOOPLOCOS(throttleChar, cab) {
-		              funcstate = DCC::changeFn(myLocos[loco].cab, fKey, pressed);
-		              if(funcstate==0 || funcstate==1)
-			              StringFormatter::send(stream,F("M%cA%c%d<;>F%d%d\n"), throttleChar, LorS(myLocos[loco].cab), 
-						          myLocos[loco].cab, funcstate, fKey);
-		              }
-                }
-                break;  
-            case 'q':
-                if (aval[1]=='V') {   //qV
-                  LOOPLOCOS(throttleChar, cab) {              
-                    StringFormatter::send(stream,F("M%cA%c%d<;>V%d\n"), throttleChar, LorS(myLocos[loco].cab), myLocos[loco].cab, DCCToWiTSpeed(DCC::getThrottleSpeed(myLocos[loco].cab)));
-                  }              
-                }
-                else if (aval[1]=='R') { // qR
-                  LOOPLOCOS(throttleChar, cab) {              
-                    StringFormatter::send(stream,F("M%cA%c%d<;>R%d\n"), throttleChar, LorS(myLocos[loco].cab), myLocos[loco].cab, DCC::getThrottleDirection(myLocos[loco].cab));
-                  }             
-                }     
-            break;    
-            case 'R':
-            { 
-              bool forward=aval[1]!='0';
-              LOOPLOCOS(throttleChar, cab) {
-                mostRecentCab=myLocos[loco].cab;
-                DCC::setThrottle(myLocos[loco].cab, DCC::getThrottleSpeed(myLocos[loco].cab), forward);
-                StringFormatter::send(stream,F("M%cA%c%d<;>R%d\n"), throttleChar, LorS(myLocos[loco].cab), myLocos[loco].cab, forward);
-              }
-            }        
-            break;      
-            case 'X':
-              //Emergency Stop  (speed code 1)
-              LOOPLOCOS(throttleChar, cab) {
-                DCC::setThrottle(myLocos[loco].cab, 1, DCC::getThrottleDirection(myLocos[loco].cab));
-                StringFormatter::send(stream,F("M%cA%c%d<;>V%d\n"), throttleChar, LorS(myLocos[loco].cab), myLocos[loco].cab, -1);
-              }
-              break;
-            case 'I': // Idle, set speed to 0
-            case 'Q': // Quit, set speed to 0
-              LOOPLOCOS(throttleChar, cab) {
-                mostRecentCab=myLocos[loco].cab;
-                DCC::setThrottle(myLocos[loco].cab, 0, DCC::getThrottleDirection(myLocos[loco].cab));
-                StringFormatter::send(stream,F("M%cA%c%d<;>V%d\n"), throttleChar, LorS(myLocos[loco].cab), myLocos[loco].cab, 0);
-              }
-              break;
-            }               
+  // Note cab=-1 for all cabs in the consist called throttleChar.  
+  //    DIAG(F("Loco Action aval=%c%c throttleChar=%c, cab=%d"), aval[0],aval[1],throttleChar, cab);
+  (void) stream;
+  switch (aval[0]) {
+  case 'V':  // Vspeed
+    { 
+      int witSpeed=getInt(aval+1);
+      LOOPLOCOS(throttleChar, cab) {
+	mostRecentCab=myLocos[loco].cab;
+	DCC::setThrottle(myLocos[loco].cab, WiTToDCCSpeed(witSpeed), DCC::getThrottleDirection(myLocos[loco].cab));
+	// SetThrottle will cause speed change broadcast
+      }
+    } 
+    break;
+  case 'F': // Function key pressed/released
+    {  
+      bool pressed=aval[1]=='1';
+      int fKey = getInt(aval+2);
+      LOOPLOCOS(throttleChar, cab) {
+	bool unsetOnRelease = myLocos[loco].functionToggles & (1L<<fKey);
+	if (unsetOnRelease) DCC::setFn(myLocos[loco].cab,fKey, pressed);
+	else if (pressed)  DCC::changeFn(myLocos[loco].cab, fKey);
+      }
+      break;  
+    }
+  case 'q':
+    if (aval[1]=='V' || aval[1]=='R' ) {   //qV or qR
+      // just flag the loco for broadcast and it will happen.
+      LOOPLOCOS(throttleChar, cab) {              
+	myLocos[loco].broadcastPending=true;
+      }                           
+    }     
+    break;    
+  case 'R':
+    { 
+      bool forward=aval[1]!='0';
+      LOOPLOCOS(throttleChar, cab) {
+	mostRecentCab=myLocos[loco].cab;
+	DCC::setThrottle(myLocos[loco].cab, DCC::getThrottleSpeed(myLocos[loco].cab), forward);
+	// setThrottle will cause a broadcast so notification will be sent
+      }
+    }        
+    break;      
+  case 'X':
+    //Emergency Stop  (speed code 1)
+    LOOPLOCOS(throttleChar, cab) {
+      DCC::setThrottle(myLocos[loco].cab, 1, DCC::getThrottleDirection(myLocos[loco].cab));
+      // setThrottle will cause a broadcast so notification will be sent
+    }
+    break;
+  case 'I': // Idle, set speed to 0
+  case 'Q': // Quit, set speed to 0
+    LOOPLOCOS(throttleChar, cab) {
+      mostRecentCab=myLocos[loco].cab;
+      DCC::setThrottle(myLocos[loco].cab, 0, DCC::getThrottleDirection(myLocos[loco].cab));
+      // setThrottle will cause a broadcast so notification will be sent
+    }
+    break;
+  }               
 }
 
-  // convert between DCC++ speed values and WiThrottle speed values
+// convert between DCC++ speed values and WiThrottle speed values
 int WiThrottle::DCCToWiTSpeed(int DCCSpeed) {
   if (DCCSpeed == 0) return 0; //stop is stop
   if (DCCSpeed == 1) return -1; //eStop value
   return DCCSpeed - 1; //offset others by 1
 }
 
-  // convert between WiThrottle speed values and DCC++ speed values
+// convert between WiThrottle speed values and DCC++ speed values
 int WiThrottle::WiTToDCCSpeed(int WiTSpeed) {
   if (WiTSpeed == 0) return 0;  //stop is stop
   if (WiTSpeed == -1) return 1; //eStop value
@@ -380,24 +429,17 @@ int WiThrottle::WiTToDCCSpeed(int WiTSpeed) {
 }
 
 void WiThrottle::loop(RingStream * stream) {
-  // for each WiThrottle, check the heartbeat
+  // for each WiThrottle, check the heartbeat and broadcast needed
   for (WiThrottle* wt=firstThrottle; wt!=NULL ; wt=wt->nextThrottle) 
-     wt->checkHeartbeat();
-
-   // TODO... any broadcasts to be done 
-   (void)stream; 
-   /* MUST follow this model in  this loop. 
-    *   stream->mark();
-    *   send 1 digit client id, and any data 
-    *   stream->commit() 
-     */
+    wt->checkHeartbeat(stream);
+  
 
 }
 
-void WiThrottle::checkHeartbeat() {
+void WiThrottle::checkHeartbeat(RingStream * stream) {
   // if eStop time passed... eStop any locos still assigned to this client and then drop the connection
   if(heartBeatEnable && (millis()-heartBeat > ESTOP_SECONDS*1000)) {
-  if (Diag::WITHROTTLE)  DIAG(F("%l WiThrottle(%d) eStop(%ds) timeout, drop connection"), millis(), clientid, ESTOP_SECONDS);
+    if (Diag::WITHROTTLE)  DIAG(F("%l WiThrottle(%d) eStop(%ds) timeout, drop connection"), millis(), clientid, ESTOP_SECONDS);
     LOOPLOCOS('*', -1) { 
       if (myLocos[loco].throttle!='\0') {
         if (Diag::WITHROTTLE) DIAG(F("%l  eStopping cab %d"),millis(),myLocos[loco].cab);
@@ -405,15 +447,65 @@ void WiThrottle::checkHeartbeat() {
       }
     }
     delete this;
-   }
+    return;
+  }
+   
+   // send any outstanding speed/direction/function changes for this clients locos
+   // Changes may have been caused by this client, or another non-Withrottle or Exrail
+  bool streamHasBeenMarked=false; 
+  LOOPLOCOS('*', -1) { 
+    if (myLocos[loco].throttle!='\0' && myLocos[loco].broadcastPending) {
+      if (!streamHasBeenMarked) {
+	stream->mark(clientid);
+	streamHasBeenMarked=true;
+      }
+      myLocos[loco].broadcastPending=false;
+      int cab=myLocos[loco].cab;
+      char lors=LorS(cab);
+      char throttle=myLocos[loco].throttle;
+      StringFormatter::send(stream,F("M%cA%c%d<;>V%d\n"),
+			    throttle, lors , cab, DCCToWiTSpeed(DCC::getThrottleSpeed(cab)));
+      StringFormatter::send(stream,F("M%cA%c%d<;>R%d\n"), 
+			    throttle, lors , cab, DCC::getThrottleDirection(cab));
+      
+      // compare the DCC functionmap with the local copy and send changes  
+      uint32_t dccFunctionMap=DCC::getFunctionMap(cab);
+      uint32_t myFunctionMap=myLocos[loco].functionMap;
+      myLocos[loco].functionMap=dccFunctionMap;
+      
+      // loop the maps sending any bit changed
+      // Loop is terminated as soon as no changes are left
+      for (byte fn=0;dccFunctionMap!=myFunctionMap;fn++) {
+	if ((dccFunctionMap&1) != (myFunctionMap&1)) {
+	  StringFormatter::send(stream,F("M%cA%c%d<;>F%c%d\n"),
+				throttle, lors , cab, (dccFunctionMap&1)?'1':'0',fn);
+	} 
+	// shift just checked bit off end of both maps
+	dccFunctionMap>>=1;
+	myFunctionMap>>=1;
+      } 
+    }
+    }
+  if (streamHasBeenMarked)   stream->commit();     
 }
 
+void WiThrottle::markForBroadcast(int cab) {
+  for (WiThrottle* wt=firstThrottle; wt!=NULL ; wt=wt->nextThrottle) 
+      wt->markForBroadcast2(cab);
+}
+void WiThrottle::markForBroadcast2(int cab) {
+  LOOPLOCOS('*', cab) { 
+    myLocos[loco].broadcastPending=true;
+  }
+}
+
+
 char WiThrottle::LorS(int cab) {
-    return (cab<127)?'S':'L';
+  return (cab<=HIGHEST_SHORT_ADDR)?'S':'L';
 }
 
 // Drive Away feature. Callback handling
- 
+
 RingStream * WiThrottle::stashStream;
 WiThrottle * WiThrottle::stashInstance;
 byte         WiThrottle::stashClient;
@@ -421,13 +513,33 @@ char         WiThrottle::stashThrottleChar;
 
 void WiThrottle::getLocoCallback(int16_t locoid) {
   stashStream->mark(stashClient);
-  if (locoid<0) StringFormatter::send(stashStream,F("HMNo loco found on prog track\n"));
-  else {
-    char addcmd[20]={'M',stashThrottleChar,'+',LorS(locoid) };
-    itoa(locoid,addcmd+4,10);
-    stashInstance->multithrottle(stashStream, (byte *)addcmd);
-    DCCWaveform::progTrack.setPowerMode(POWERMODE::ON);
-    DCC::setProgTrackSyncMain(true);  // <1 JOIN> so we can drive loco away
+  
+  if (locoid<=0) {
+    StringFormatter::send(stashStream,F("HMNo loco found on prog track\n"));
+    stashStream->commit();                  // done here, commit and return
+    return;
   }
+
+  // short or long
+  char addrchar;
+  if (locoid & LONG_ADDR_MARKER) {          // maker bit indicates long addr
+    locoid = locoid ^ LONG_ADDR_MARKER;     // remove marker bit to get real long addr
+    if (locoid <= HIGHEST_SHORT_ADDR ) {    // out of range for long addr
+      StringFormatter::send(stashStream,F("HMLong addr %d <= %d unsupported\n"), locoid, HIGHEST_SHORT_ADDR);
+      stashStream->commit();                // done here, commit and return
+      return;
+    }
+    addrchar = 'L';
+  } else {
+    addrchar = 'S';
+  }
+  
+  char addcmd[20]={'M',stashThrottleChar,'+', addrchar};
+  itoa(locoid,addcmd+4,10);
+  stashInstance->multithrottle(stashStream, (byte *)addcmd);
+  DCCWaveform::progTrack.setPowerMode(POWERMODE::ON);
+  DCC::setProgTrackSyncMain(true);          // <1 JOIN> so we can drive loco away
   stashStream->commit();
+  CommandDistributor::broadcastPower();
+
 }

WiThrottle.h

@@ -1,5 +1,7 @@
 /*
- *  © 2020, Chris Harlow. All rights reserved.
+ *  © 2021 Mike S
+ *  © 2020-2021 Chris Harlow
+ *  All rights reserved.
  *  
  *  This file is part of Asbelos DCC API
  *
@@ -24,6 +26,9 @@
 struct MYLOCO {
     char throttle; //indicates which throttle letter on client, often '0','1' or '2'
     int cab; //address of this loco
+    bool broadcastPending;
+    uint32_t functionMap;
+    uint32_t functionToggles;
 };
 
 class WiThrottle {
@@ -31,14 +36,15 @@ class WiThrottle {
     static void loop(RingStream * stream);
     void parse(RingStream * stream, byte * cmd);
     static WiThrottle* getThrottle( int wifiClient); 
-    
+    static void markForBroadcast(int cab);
+      
   private: 
     WiThrottle( int wifiClientId);
     ~WiThrottle();
    
       static const int MAX_MY_LOCO=10;      // maximum number of locos assigned to a single client
-      static const int HEARTBEAT_SECONDS=4; // heartbeat at 4secs to provide messaging transport
-      static const int ESTOP_SECONDS=8;     // eStop if no incoming messages for more than 8secs
+      static const int HEARTBEAT_SECONDS=10; // heartbeat at 4secs to provide messaging transport
+      static const int ESTOP_SECONDS=20;     // eStop if no incoming messages for more than 8secs
       static WiThrottle* firstThrottle;
       static int getInt(byte * cmd);
       static int getLocoId(byte * cmd);
@@ -62,8 +68,8 @@ class WiThrottle {
       void multithrottle(RingStream * stream, byte * cmd);
       void locoAction(RingStream * stream, byte* aval, char throttleChar, int cab);
       void accessory(RingStream *, byte* cmd);
-      void checkHeartbeat(); 
-
+      void checkHeartbeat(RingStream * stream); 
+      void markForBroadcast2(int cab);
        // callback stuff to support prog track acquire
        static RingStream * stashStream;
        static WiThrottle * stashInstance;

WifiInboundHandler.cpp

@@ -1,4 +1,7 @@
 /*
+ *  © 2021 Fred Decker
+ *  © 2021 Fred Decker
+ *  © 2020-2021 Chris Harlow
  *  © 2020, Chris Harlow. All rights reserved.
  *  © 2020, Harald Barth.
  *  
@@ -152,7 +155,7 @@ WifiInboundHandler::INBOUND_STATE WifiInboundHandler::loop2() {
         if (ch=='E' || ch=='l') { // ERROR or "link is not valid"
           if (clientPendingCIPSEND>=0) {
             // A CIPSEND was errored... just toss it away
-            purgeCurrentCIPSEND();  
+            purgeCurrentCIPSEND(); 
           }
           loopState=SKIPTOEND; 
           break; 
@@ -231,6 +234,7 @@ WifiInboundHandler::INBOUND_STATE WifiInboundHandler::loop2() {
         if (ch=='C') {
          // got "x C" before CLOSE or CONNECTED, or CONNECT FAILED
          if (runningClientId==clientPendingCIPSEND) purgeCurrentCIPSEND();
+         else CommandDistributor::forget(runningClientId);
         }
         loopState=SKIPTOEND;   
         break;
@@ -245,8 +249,9 @@ WifiInboundHandler::INBOUND_STATE WifiInboundHandler::loop2() {
 
 void WifiInboundHandler::purgeCurrentCIPSEND() {
          // A CIPSEND was sent but errored... or the client closed just toss it away
+         CommandDistributor::forget(clientPendingCIPSEND); 
          DIAG(F("Wifi: DROPPING CIPSEND=%d,%d"),clientPendingCIPSEND,currentReplySize);
-         for (int i=0;i<=currentReplySize;i++) outboundRing->read();
+         for (int i=0;i<currentReplySize;i++) outboundRing->read();
          pendingCipsend=false;  
          clientPendingCIPSEND=-1;
 }

WifiInboundHandler.h

@@ -1,4 +1,6 @@
 /*
+ *  © 2021 Harald Barth
+ *  © 2021 Fred Decker
  *  (c) 2021 Fred Decker.  All rights reserved.
  *  (c) 2020 Chris Harlow. All rights reserved.
  *

WifiInterface.cpp

@@ -1,22 +1,24 @@
 /*
-    © 2020, Chris Harlow. All rights reserved.
-    © 2020, Harald Barth.
-
-    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/>.
-*/
+ *  © 2021 Fred Decker
+ *  © 2020-2022 Harald Barth
+ *  © 2020-2022 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/>.
+ */
 #ifndef ARDUINO_AVR_UNO_WIFI_REV2
 // This code is NOT compiled on a unoWifiRev2 processor which uses a different architecture 
 #include "WifiInterface.h"        /* config.h included there */
@@ -75,13 +77,13 @@ bool WifiInterface::setup(long serial_link_speed,
   (void) channel;
 #endif  
   
-#if NUM_SERIAL > 0
+#if NUM_SERIAL > 0 && !defined(SERIAL1_COMMANDS)
   Serial1.begin(serial_link_speed);
   wifiUp = setup(Serial1, wifiESSID, wifiPassword, hostname, port, channel);
 #endif
 
 // Other serials are tried, depending on hardware.
-#if NUM_SERIAL > 1
+#if NUM_SERIAL > 1 && !defined(SERIAL2_COMMANDS)
   if (wifiUp == WIFI_NOAT)
   {
     Serial2.begin(serial_link_speed);
@@ -89,7 +91,7 @@ bool WifiInterface::setup(long serial_link_speed,
   }
 #endif
   
-#if NUM_SERIAL > 2
+#if NUM_SERIAL > 2 && !defined(SERIAL3_COMMANDS)
   if (wifiUp == WIFI_NOAT)
   {
     Serial3.begin(serial_link_speed);
@@ -277,10 +279,16 @@ wifiSerialState WifiInterface::setup2(const FSH* SSid, const FSH* password,
 
   StringFormatter::send(wifiStream, F("AT+CIPSERVER=0\r\n")); // turn off tcp server (to clean connections before CIPMUX=1)
   checkForOK(1000, true); // ignore result in case it already was off
-   
+
   StringFormatter::send(wifiStream, F("AT+CIPMUX=1\r\n")); // configure for multiple connections
   if (!checkForOK(1000, true)) return WIFI_DISCONNECTED;
 
+  if(!oldCmd) {                                                                    // no idea to test this on old firmware
+    StringFormatter::send(wifiStream, F("AT+MDNS=1,\"%S\",\"withrottle\",%d\r\n"),
+			  hostname, port);                                         // mDNS responder
+    checkForOK(1000, true);                                                        // dont care if not supported
+  }
+
   StringFormatter::send(wifiStream, F("AT+CIPSERVER=1,%d\r\n"), port); // turn on server on port
   if (!checkForOK(1000, true)) return WIFI_DISCONNECTED;
 #endif //DONT_TOUCH_WIFI_CONF
@@ -316,19 +324,45 @@ wifiSerialState WifiInterface::setup2(const FSH* SSid, const FSH* password,
 
 
 // This function is used to allow users to enter <+ commands> through the DCCEXParser
+// <+command>  sends AT+command to the ES and returns to the caller.
 // Once the user has made whatever changes to the AT commands, a <+X> command can be used
 // to force on the connectd flag so that the loop will start picking up wifi traffic.
 // If the settings are corrupted <+RST> will clear this and then you must restart the arduino.
+
+// Using the <+> command with no command string causes the code to enter an echo loop so that all
+// input is directed to the ES and all ES output written to the USB Serial.
+// The sequence "!!!" returns the Arduino to the normal loop mode
+
  
-void WifiInterface::ATCommand(const byte * command) {
+void WifiInterface::ATCommand(HardwareSerial * stream,const byte * command) {
   command++;
+  if (*command=='\0') { // User gave <+> command  
+    stream->print(F("\nES AT command passthrough mode, use ! to exit\n"));
+    while(stream->available()) stream->read(); // Drain serial input first 
+    bool startOfLine=true;
+    while(true) {
+      while (wifiStream->available()) stream->write(wifiStream->read());
+      if (stream->available()) {
+        int cx=stream->read();
+        // A newline followed by !!! is an exit
+        if (cx=='\n' || cx=='\r') startOfLine=true; 
+        else if (startOfLine && cx=='!')  break;
+        else startOfLine=false; 
+        stream->write(cx);
+        wifiStream->write(cx);  
+      }
+    }
+    stream->print(F("Passthrough Ended"));
+    return; 
+  }
+  
   if (*command=='X') {
-     connected = true;
-     DIAG(F("++++++ Wifi Connction forced on ++++++++"));
+    connected = true;
+    DIAG(F("++++++ Wifi Connction forced on ++++++++"));
   }
   else {
-        StringFormatter::  send(wifiStream, F("AT+%s\r\n"), command);
-        checkForOK(10000,  true);
+    StringFormatter::  send(wifiStream, F("AT+%s\r\n"), command);
+    checkForOK(10000,  true);
   }
 }
 

WifiInterface.h

@@ -1,7 +1,8 @@
 /*
- *  © 2020, Chris Harlow. All rights reserved.
+ *  © 2020-2021 Chris Harlow
  *  © 2020, Harald Barth.
- *  
+ *  All rights reserved.
+ *
  *  This file is part of CommandStation-EX
  *
  *  This is free software: you can redistribute it and/or modify
@@ -37,7 +38,7 @@ public:
                           const int port,
                           const byte channel);
   static void loop();
-  static void ATCommand(const byte *command);
+  static void ATCommand(HardwareSerial * stream,const byte *command);
   
 private:
   static wifiSerialState setup(Stream &setupStream, const FSH *SSSid, const FSH *password,

config.example.h

@@ -1,5 +1,8 @@
 /*
- *  COPYRIGHT (c) 2020 Fred Decker
+ *  © 2021 Neil McKechnie
+ *  © 2020-2021 Harald Barth
+ *  © 2020-2021 Fred Decker
+ *  © 2020-2021 Chris Harlow
  *  
  *  This file is part of CommandStation-EX
  *
@@ -26,7 +29,7 @@ The configuration file for DCC-EX Command Station
 /////////////////////////////////////////////////////////////////////////////////////
 //  NOTE: Before connecting these boards and selecting one in this software
 //        check the quick install guides!!! Some of these boards require a voltage
-//        generating resitor on the current sense pin of the device. Failure to select
+//        generating resistor on the current sense pin of the device. Failure to select
 //        the correct resistor could damage the sense pin on your Arduino or destroy
 //        the device.
 //
@@ -82,7 +85,7 @@ The configuration file for DCC-EX Command Station
 // WIFI_PASSWORD is the network password for your home network or if
 // you want to change the password from default AP mode password
 // to the AP password you want. 
-// Your password may not conain ``"'' (double quote, ASCII 0x22).
+// Your password may not contain ``"'' (double quote, ASCII 0x22).
 #define WIFI_PASSWORD "Your network passwd"
 //
 // WIFI_HOSTNAME: You probably don't need to change this
@@ -122,12 +125,36 @@ The configuration file for DCC-EX Command Station
 
 //OR define OLED_DRIVER width,height in pixels (address auto detected)
 // 128x32 or 128x64 I2C SSD1306-based devices are supported.
-// Also 132x64 I2C SH1106 devices
+// Use 132,64 for a SH1106-based I2C device with a 128x64 display.
 // #define OLED_DRIVER 128,32
 
 // Define scroll mode as 0, 1 or 2
+//  *  #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).
 #define SCROLLMODE 1
 
+/////////////////////////////////////////////////////////////////////////////////////
+// DISABLE EEPROM
+//
+// If you do not need the EEPROM at all, you can disable all the code that saves
+// data in the EEPROM. You might want to do that if you are in a Arduino UNO
+// and want to use the EX-RAIL automation. Otherwise you do not have enough RAM
+// to do that. Of course, then none of the EEPROM related commands work.
+//
+// #define DISABLE_EEPROM
+
+/////////////////////////////////////////////////////////////////////////////////////
+// REDEFINE WHERE SHORT/LONG ADDR break is. According to NMRA the last short address
+// is 127 and the first long address is 128. There are manufacturers which have
+// another view. Lenz CS for example have considered addresses long from 100. If
+// you want to change to that mode, do 
+//#define HIGHEST_SHORT_ADDR 99
+// If you want to run all your locos addressed long format, you could even do a 
+//#define HIGHEST_SHORT_ADDR 0
+// We do not support to use the same address, for example 100(long) and 100(short)
+// at the same time, there must be a border.
+
 /////////////////////////////////////////////////////////////////////////////////////
 //
 // DEFINE TURNOUTS/ACCESSORIES FOLLOW NORM RCN-213
@@ -141,10 +168,32 @@ The configuration file for DCC-EX Command Station
 // don't add it to your config.h.
 //#define DCC_TURNOUTS_RCN_213
 
-// The following #define likewise inverts the behaviour of the <a> command 
-// for triggering DCC Accessory Decoders, so that <a addr subaddr 0> generates a 
+// By default, the driver which defines a DCC accessory decoder
+// does send out the same state change on the DCC packet as it
+// receives. This means a VPIN state=1 sends D=1 (close turnout
+// or signal green) in the DCC packet. This can be reversed if
+// necessary.
+//#define HAL_ACCESSORY_COMMAND_REVERSE
+
+// If you have issues with that the direction of the accessory commands is
+// reversed (for example when converting from another CS to DCC-EX) then
+// you can use this to reverse the sense of all accessory commmands sent
+// over DCC++. This #define likewise inverts the behaviour of the <a> command
+// for triggering DCC Accessory Decoders, so that <a addr subaddr 0> generates a
 // DCC packet with D=1 (close turnout) and <a addr subaddr 1> generates D=0 
 // (throw turnout).
 //#define DCC_ACCESSORY_RCN_213
+//
+// HANDLING MULTIPLE SERIAL THROTTLES
+// The command station always operates with the default Serial port.
+// Diagnostics are only emitted on the default serial port and not broadcast.
+// Other serial throttles may be added to the Serial1, Serial2, Serial3 ports
+// which may or may not exist on your CPU. (Mega has all 3)
+// To monitor a throttle on one or more serial ports, uncomment the defines below.
+// NOTE: do not define here the WiFi shield serial port or your wifi will not work.
+//
+//#define SERIAL1_COMMANDS
+//#define SERIAL2_COMMANDS
+//#define SERIAL3_COMMANDS
 
 /////////////////////////////////////////////////////////////////////////////////////

defines.h

@@ -1,22 +1,26 @@
 /*
-    © 2020, Harald Barth.
-
-    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/>.
-
-*/
+ *  © 2021 Neil McKechnie
+ *  © 2021 Mike S
+ *  © 2021 Fred Decker
+ *  © 2020-2021 Harald Barth
+ *  © 2020-2021 Chris Harlow
+ *
+ *  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 DEFINES_H
 #define DEFINES_H
@@ -36,22 +40,32 @@
 // WIFI_ON: All prereqs for running with WIFI are met
 // Note: WIFI_CHANNEL may not exist in early config.h files so is added here if needed.
 
-#if (defined(ARDUINO_AVR_MEGA) || defined(ARDUINO_AVR_MEGA2560) || defined(ARDUINO_SAMD_ZERO)  || defined(TEENSYDUINO))
+#if (defined(ARDUINO_AVR_MEGA) || defined(ARDUINO_AVR_MEGA2560) || defined(ARDUINO_SAMD_ZERO)  || defined(TEENSYDUINO)) || defined(ARDUINO_AVR_NANO_EVERY)
  #define BIG_RAM
 #endif 
-#if ENABLE_WIFI && defined(BIG_RAM)
-#define WIFI_ON true
-#ifndef WIFI_CHANNEL
-#define WIFI_CHANNEL 1
-#endif
+#if ENABLE_WIFI
+  #if defined(BIG_RAM)
+    #define WIFI_ON true
+    #ifndef WIFI_CHANNEL
+      #define WIFI_CHANNEL 1
+    #endif
+  #else
+    #define WIFI_WARNING
+    #define WIFI_ON false
+  #endif
 #else
-#define WIFI_ON false
+  #define WIFI_ON false
 #endif
 
-#if ENABLE_ETHERNET && defined(BIG_RAM)
-#define ETHERNET_ON true
+#if ENABLE_ETHERNET
+  #if defined(BIG_RAM)
+    #define ETHERNET_ON true
+  #else
+    #define ETHERNET_WARNING
+    #define ETHERNET_ON false
+  #endif
 #else
-#define ETHERNET_ON false
+  #define ETHERNET_ON false
 #endif
 
 #if WIFI_ON && ETHERNET_ON
@@ -65,8 +79,12 @@
 //
 #define WIFI_SERIAL_LINK_SPEED 115200
 
-#if __has_include ( "myAutomation.h") && defined(BIG_RAM)
-  #define RMFT_ACTIVE
+#if __has_include ( "myAutomation.h")
+  #if defined(BIG_RAM) || defined(DISABLE_EEPROM)
+    #define EXRAIL_ACTIVE
+  #else
+    #define EXRAIL_WARNING
+  #endif
 #endif
 
-#endif
+#endif

freeMemory.cpp

@@ -1,6 +1,7 @@
 /*
- *  © 2020, Harald Barth
- *  © 2021, Neil McKechnie
+ *  © 2021 Neil McKechnie
+ *  © 2021 Mike S
+ *  © 2020 Harald Barth
  *  
  *  This file is part of Asbelos DCC-EX
  *

freeMemory.h

@@ -1,6 +1,6 @@
 /*
- *  © 2020, Harald Barth
- *  © 2021, Neil McKechnie
+ *  © 2021 Neil McKechnie
+ *  © 2020 Harald Barth
  *  
  *  This file is part of DCC-EX
  *

installer.json

@@ -0,0 +1,270 @@
+[
+    {
+        "Name": "BaseStationClassic",
+        "Git": "DCC-EX/BaseStation-Classic",
+        "Libraries": [
+            {
+                "Name": "Ethernet",
+                "Repo": "arduino-libraries/Ethernet",
+                "Location": "libraries/Ethernet",
+                "LibraryDownloadAvailable": true
+            }
+        ],
+        "SupportedBoards": [
+            {
+                "Name": "Uno",
+                "FQBN": "arduino:avr:uno",
+                "Platforms": [
+                    {
+                        "Architecture": "avr",
+                        "Package": "arduino"
+                    }
+                ],
+                "SupportedMotoShields": [
+                    {
+                        "Name": "Arduino Motor Shield",
+                        "Declaration": "STANDARD_MOTOR_SHIELD"
+                    },
+                    {
+                        "Name": "Pololu MC33926 Motor Shield",
+                        "Declaration": "POLOLU_MOTOR_SHIELD"
+                    }
+                ],
+                "ExtraLibraries": []
+            },
+            {
+                "Name": "Mega",
+                "FQBN": "arduino:avr:mega",
+                "Platforms": [
+                    {
+                        "Architecture": "avr",
+                        "Package": "arduino"
+                    }
+                ],
+                "SupportedMotoShields": [
+                    {
+                        "Name": "Arduino Motor Shield",
+                        "Declaration": "STANDARD_MOTOR_SHIELD"
+                    },
+                    {
+                        "Name": "Pololu MC33926 Motor Shield",
+                        "Declaration": "POLOLU_MOTOR_SHIELD"
+                    }
+                ],
+                "ExtraLibraries": []
+            }
+        ],
+        "DisplayName": "Base Station Classic",
+        "InputFileLocation": "DCCpp",
+        "AllowAdvanced": false,
+        "ConfigFile": "DCCpp/Config.h"
+    },
+    {
+        "Name": "CommandStation-EX",
+        "Git": "DCC-EX/CommandStation-EX",
+        "Libraries": [
+            {
+                "Name": "Ethernet",
+                "Repo": "arduino-libraries/Ethernet",
+                "Location": "libraries/Ethernet",
+                "LibraryDownloadAvailable": true
+            },
+            {
+                "Name": "DIO2",
+                "Repo": "",
+                "Location": "libraries/DIO2",
+                "LibraryDownloadAvailable": true
+            }
+        ],
+        "SupportedBoards": [
+            {
+                "Name": "Uno",
+                "FQBN": "arduino:avr:uno",
+                "Platforms": [
+                    {
+                        "Architecture": "avr",
+                        "Package": "arduino"
+                    }
+                ],
+                "SupportedMotoShields": [
+                    {
+                        "Name": "Arduino Motor Shield",
+                        "Declaration": "STANDARD_MOTOR_SHIELD"
+                    },
+                    {
+                        "Name": "Pololu MC33926 Motor Shield",
+                        "Declaration": "POLOLU_MOTOR_SHIELD"
+                    }
+                ],
+                "ExtraLibraries": []
+            },
+            {
+                "Name": "Mega",
+                "FQBN": "arduino:avr:mega",
+                "Platforms": [
+                    {
+                        "Architecture": "avr",
+                        "Package": "arduino"
+                    }
+                ],
+                "SupportedMotoShields": [
+                    {
+                        "Name": "Arduino Motor Shield",
+                        "Declaration": "STANDARD_MOTOR_SHIELD"
+                    },
+                    {
+                        "Name": "Pololu MC33926 Motor Shield",
+                        "Declaration": "POLOLU_MOTOR_SHIELD"
+                    }
+                ],
+                "ExtraLibraries": []
+            },
+            {
+                "Name": "Mega Wifi",
+                "FQBN": "arduino:avr:mega",
+                "Platforms": [
+                    {
+                        "Architecture": "avr",
+                        "Package": "arduino"
+                    }
+                ],
+                "SupportedMotoShields": [
+                    {
+                        "Name": "Arduino Motor Shield",
+                        "Declaration": "STANDARD_MOTOR_SHIELD"
+                    },
+                    {
+                        "Name": "Pololu MC33926 Motor Shield",
+                        "Declaration": "POLOLU_MOTOR_SHIELD"
+                    }
+                ],
+                "ExtraLibraries": []
+            },
+            {
+                "Name": "Nano",
+                "FQBN": "arduino:avr:nano",
+                "Platforms": [
+                    {
+                        "Architecture": "avr",
+                        "Package": "arduino"
+                    }
+                ],
+                "SupportedMotoShields": [
+                    {
+                        "Name": "Arduino Motor Shield",
+                        "Declaration": "STANDARD_MOTOR_SHIELD"
+                    },
+                    {
+                        "Name": "Pololu MC33926 Motor Shield",
+                        "Declaration": "POLOLU_MOTOR_SHIELD"
+                    }
+                ],
+                "ExtraLibraries": []
+            },
+            {
+                "Name": "Nano Every",
+                "FQBN": "arduino:megaavr:nanoevery",
+                "Platforms": [
+                    {
+                        "Architecture": "megaavr",
+                        "Package": "arduino"
+                    }
+                ],
+                "SupportedMotoShields": [
+                    {
+                        "Name": "Arduino Motor Shield",
+                        "Declaration": "STANDARD_MOTOR_SHIELD"
+                    },
+                    {
+                        "Name": "Pololu MC33926 Motor Shield",
+                        "Declaration": "POLOLU_MOTOR_SHIELD"
+                    }
+                ],
+                "ExtraLibraries": []
+            },
+            {
+                "Name": "Teensy 3.x",
+                "FQBN": "teensy:avr:teensy31",
+                "Platforms": [
+                    {
+                        "Architecture": "teensy",
+                        "Package": "arduino"
+                    }
+                ],
+                "SupportedMotoShields": [
+                    {
+                        "Name": "Arduino Motor Shield",
+                        "Declaration": "STANDARD_MOTOR_SHIELD"
+                    },
+                    {
+                        "Name": "Pololu MC33926 Motor Shield",
+                        "Declaration": "POLOLU_MOTOR_SHIELD"
+                    }
+                ],
+                "ExtraLibraries": []
+            },
+            {
+                "Name": "Teensy 4.x",
+                "FQBN": "teensy:avr:teensy41",
+                "Platforms": [
+                    {
+                        "Architecture": "teensy",
+                        "Package": "arduino"
+                    }
+                ],
+                "SupportedMotoShields": [
+                    {
+                        "Name": "Arduino Motor Shield",
+                        "Declaration": "STANDARD_MOTOR_SHIELD"
+                    },
+                    {
+                        "Name": "Pololu MC33926 Motor Shield",
+                        "Declaration": "POLOLU_MOTOR_SHIELD"
+                    }
+                ],
+                "ExtraLibraries": []
+            },
+            {
+                "Name": "SAMD21",
+                "FQBN": "SparkFun:samd",
+                "Platforms": [
+                    {
+                        "Architecture": "avr",
+                        "Package": "arduino"
+                    },
+                    {
+                        "Architecture": "samd",
+                        "Package": "arduino"
+                    },
+                    {
+                        "Architecture": "samd",
+                        "Package": "SparkFun"
+                    }
+                ],
+                "SupportedMotoShields": [
+                    {
+                        "Name": "Arduino Motor Shield",
+                        "Declaration": "STANDARD_MOTOR_SHIELD"
+                    },
+                    {
+                        "Name": "Pololu MC33926 Motor Shield",
+                        "Declaration": "POLOLU_MOTOR_SHIELD"
+                    },
+                    {
+                        "Name": "FireBox MK1",
+                        "Declaration": "FIREBOX_MK1"
+                    },
+                    {
+                        "Name": "FireBox MK1S",
+                        "Declaration": "FIREBOX_MK1S"
+                    }
+                ],
+                "ExtraLibraries": []
+            }
+        ],
+        "DisplayName": "CommandStation EX",
+        "InputFileLocation": "",
+        "AllowAdvanced": true,
+        "ConfigFile": "config.h"
+    }
+]

myAutomation.example.h

@@ -1,19 +1,18 @@
 /* This is an automation example file.
- *  The presence of a file calle "myAutomation.h" brings EX-RAIL code into
+ *  The presence of a file called "myAutomation.h" brings EX-RAIL code into
  *  the command station.
- *  The auotomation may have multiple concurrent tasks. 
+ *  The automation may have multiple concurrent tasks.
  *  A task may 
  *  - Act as a ROUTE setup macro for a user to drive over 
  *  - drive a loco through an AUTOMATION 
  *  - automate some cosmetic part of the layout without any loco.
  *  
- *  At startup, a single task is created to execute the first 
- *  instruction after E$XRAIL. 
+ *  At startup, a single task is created to execute the startup sequence.
  *  This task may simply follow a route, or may START  
- *  further tasks (thats is.. send a loco out along a route).
+ *  further tasks (that is.. send a loco out along a route).
  *  
  *  Where the loco id is not known at compile time, a new task 
- *  can be creatd with the command:
+ *  can be created with the command:
  *  </ START [cab] route> 
  *  
  *  A ROUTE, AUTOMATION or SEQUENCE are internally identical in ExRail terms  
@@ -24,11 +23,10 @@
  *  
  */
 
-EXRAIL   // myAutomation must start with the EXRAIL instruction
-  // This is the default starting route, AKA SEQUENCE(0)  
-  SENDLOCO(3,1) // send loco 3 off along route 1
-  SENDLOCO(10,2) // send loco 10 off along route 2
-  DONE     // This just ends the startup thread, leaving 2 others running.
+// This is the startup sequence, AKA SEQUENCE(0)
+SENDLOCO(3,1) // send loco 3 off along route 1
+SENDLOCO(10,2) // send loco 10 off along route 2
+DONE     // This just ends the startup thread, leaving 2 others running.
 
 /* SEQUENCE(1) is a simple shuttle between 2 sensors      
  *  S20 and S21 are sensors on arduino pins 20 and 21 
@@ -78,7 +76,3 @@ EXRAIL   // myAutomation must start with the EXRAIL instruction
    AT(33) STOP
    DELAY(20000)  // wait 20 seconds 
    FOLLOW(2)   // follow sequence 2... ie repeat the process
-   
-   ENDEXRAIL    // marks the end of the EXRAIL program. 
-    
-   

myHal.cpp_example.txt

@@ -0,0 +1,195 @@
+//  Sample myHal.cpp file.
+//
+// To use this file, copy it to myHal.cpp and uncomment the directives and/or
+// edit them to satisfy your requirements.  If you only want to use up to 
+// two MCP23017 GPIO Expander modules and/or up to two PCA9685 Servo modules,
+// then you don't need this file as DCC++EX configures these for free!
+
+// Note that if the file has a .cpp extension it WILL be compiled into the build
+// and the halSetup() function WILL be invoked.
+//
+// To prevent this, temporarily rename the file to myHal.txt or similar.
+//
+
+// The #if directive prevent compile errors for Uno and Nano by excluding the 
+//  HAL directives from the build.
+#if !defined(IO_NO_HAL)
+
+// Include devices you need.
+#include "IODevice.h"     // Always recommended to include this
+
+// Optional includes, comment out if not in use
+#include "IO_HCSR04.h"    // Ultrasonic range sensor
+#include "IO_VL53L0X.h"   // Laser time-of-flight sensor
+#include "IO_DFPlayer.h"  // MP3 sound player
+#include "IO_PCA9555.h"   // PCA/TCA9555
+
+
+//==========================================================================
+// The function halSetup() is invoked from CS if it exists within the build.
+// The setup calls are included between the open and close braces "{ ... }".
+// Comments (lines preceded by "//") are optional.
+//==========================================================================
+
+void halSetup() {
+
+  //=======================================================================
+  // The following directive defines a PCA9685 PWM Servo driver module.
+  //=======================================================================
+  // The parameters are: 
+  //   First Vpin=100
+  //   Number of VPINs=16 (numbered 100-115)
+  //   I2C address of module=0x40
+
+  //PCA9685::create(100, 16, 0x40);
+
+
+  //=======================================================================
+  // The following directive defines an MCP23017 16-port I2C GPIO Extender module.
+  //=======================================================================
+  // The parameters are: 
+  //   First Vpin=196
+  //   Number of VPINs=16 (numbered 196-211)
+  //   I2C address of module=0x22
+
+  //MCP23017::create(196, 16, 0x22);
+
+
+  // Alternative form, which allows the INT pin of the module to request a scan
+  // by pulling Arduino pin 40 to ground.  Means that the I2C isn't being polled
+  // all the time, only when a change takes place. Multiple modules' INT pins
+  // may be connected to the same Arduino pin.
+
+  //MCP23017::create(196, 16, 0x22, 40);
+
+
+  //=======================================================================
+  // The following directive defines an PCA9555 / TCA95555 16-port I2C GPIO Extender module.
+  //=======================================================================
+  // The parameters are: 
+  //   First Vpin=196
+  //   Number of VPINs=16 (numbered 196-211)
+  //   I2C address of module=0x22
+
+  //PCA9555::create(196, 16, 0x22);
+
+  // Alternative form, which allows the INT pin of the module to request a scan
+  // by pulling Arduino pin 22 to ground. Means that the I2C isn't being polled
+  // all the time, only when a change takes place. Multiple modules' INT pins
+  // may be connected to the same Arduino pin.
+
+  //PCA9555::create(196, 16, 0x22, 22);
+  
+
+  //=======================================================================
+  // The following directive defines an MCP23008 8-port I2C GPIO Extender module.
+  //=======================================================================
+  // The parameters are: 
+  //   First Vpin=300
+  //   Number of VPINs=8 (numbered 300-307)
+  //   I2C address of module=0x22
+
+
+  //=======================================================================
+  // The following directive defines an MCP23008 8-port I2C GPIO Extender module.
+  //=======================================================================
+  // The parameters are: 
+  //   First Vpin=300
+  //   Number of VPINs=8 (numbered 300-307)
+  //   I2C address of module=0x22
+
+  //MCP23008::create(300, 8, 0x22);
+
+
+  //=======================================================================
+  // The following directive defines a PCF8574 8-port I2C GPIO Extender module.
+  //=======================================================================
+  // The parameters are: 
+  //   First Vpin=200
+  //   Number of VPINs=8 (numbered 200-207)
+  //   I2C address of module=0x23
+
+  //PCF8574::create(200, 8, 0x23);
+
+
+  // Alternative form using INT pin (see above)
+
+  //PCF8574::create(200, 8, 0x23, 40);
+
+
+  //=======================================================================
+  // The following directive defines an HCSR04 ultrasonic ranging module.
+  //=======================================================================
+  // The parameters are: 
+  //   Vpin=2000 (only one VPIN per directive)
+  //   Number of VPINs=1
+  //   Arduino pin connected to TRIG=30
+  //   Arduino pin connected to ECHO=31
+  //   Minimum trigger range=20cm (VPIN goes to 1 when <20cm)
+  //   Maximum trigger range=25cm (VPIN goes to 0 when >25cm)
+  // Note: Multiple devices can be configured by using a different ECHO pin
+  // for each one.  The TRIG pin can be shared between multiple devices.
+  // Be aware that the 'ping' of one device may be received by another
+  // device and position them accordingly!
+
+  //HCSR04::create(2000, 30, 31, 20, 25);
+  //HCSR04::create(2001, 30, 32, 20, 25);
+
+
+  //=======================================================================
+  // The following directive defines a single VL53L0X Time-of-Flight range sensor.
+  //=======================================================================
+  // The parameters are:
+  //   VPIN=5000
+  //   Number of VPINs=1
+  //   I2C address=0x29 (default for this chip)
+  //   Minimum trigger range=200mm (VPIN goes to 1 when <20cm)
+  //   Maximum trigger range=250mm (VPIN goes to 0 when >25cm)
+
+  //VL53L0X::create(5000, 1, 0x29, 200, 250); 
+
+  // For multiple VL53L0X modules, add another parameter which is a VPIN connected to the
+  // module's XSHUT pin.  This allows the modules to be configured, at start,
+  // with distinct I2C addresses.  In this case, the address 0x29 is only used during
+  // initialisation to configure each device in turn with the desired unique I2C address.
+  // The examples below have the modules' XSHUT pins connected to the first two pins of 
+  // the first MCP23017 module (164 and 165), but Arduino pins may be used instead.
+  // The first module here is given I2C address 0x30 and the second is 0x31.
+
+  //VL53L0X::create(5000, 1, 0x30, 200, 250, 164); 
+  //VL53L0X::create(5001, 1, 0x31, 200, 250, 165); 
+
+
+  //=======================================================================
+  // Play mp3 files from a Micro-SD card, using a DFPlayer MP3 Module.
+  //=======================================================================
+  // Parameters: 
+  //   10000 = first VPIN allocated.
+  //   10 = number of VPINs allocated.
+  //   Serial1 = name of serial port (usually Serial1 or Serial2).
+  // With these parameters, up to 10 files may be played on pins 10000-10009.
+  // Play is started from EX-RAIL with SET(10000) for first mp3 file, SET(10001)
+  // for second file, etc.  Play may also be initiated by writing an analogue
+  // value to the first pin, e.g. SERVO(10000,23,0) will play the 23rd mp3 file.
+  // SERVO(10000,23,30) will do the same thing, as well as setting the volume to 
+  // 30 (maximum value).
+  // Play is stopped by RESET(10000) (or any other allocated VPIN).
+  // Volume may also be set by writing an analogue value to the second pin for the player, 
+  // e.g. SERVO(10001,30,0) sets volume to maximum (30).
+  // The EX-RAIL script may check for completion of play by calling WAITFOR(pin), which will only proceed to the
+  // following line when the player is no longer busy.
+  // E.g.
+  //    SEQUENCE(1)
+  //      AT(164)           // Wait for sensor attached to pin 164 to activate
+  //      SET(10003)        // Play fourth MP3 file
+  //      LCD(4, "Playing") // Display message on LCD/OLED
+  //      WAITFOR(10003)    // Wait for playing to finish
+  //      LCD(4, " ")       // Clear LCD/OLED line 
+  //      FOLLOW(1)         // Go back to start
+
+  // DFPlayer::create(10000, 10, Serial1);
+
+
+}
+
+#endif

mySetup.cpp_example.txt

@@ -1,214 +0,0 @@
-//  Sample mySetup.cpp file.
-//
-// To use this file, copy it to mySetup.cpp and uncomment the directives and/or
-// edit them to satisfy your requirements.  
-
-// Note that if the file has a .cpp extension it WILL be compiled into the build
-// and the mySetup() function WILL be invoked.
-//
-// To prevent this, temporarily rename it to mySetup.txt or similar.
-//
-
-#include "IODevice.h"
-#include "Turnouts.h"
-#include "Sensors.h"
-#include "IO_HCSR04.h"
-#include "IO_VL53L0X.h"
-
-
-// The #if directive prevent compile errors for Uno and Nano by excluding the 
-//  HAL directives from the build.
-#if !defined(IO_NO_HAL)
-
-
-// Examples of statically defined HAL directives (alternative to the create() call).
-// These have to be outside of the mySetup() function.
-
-//=======================================================================
-// The following directive defines a PCA9685 PWM Servo driver module.
-//=======================================================================
-// The parameters are: 
-//   First Vpin=100
-//   Number of VPINs=16 (numbered 100-115)
-//   I2C address of module=0x40
-
-//PCA9685 pwmModule1(100, 16, 0x40);
-
-
-//=======================================================================
-// The following directive defines an MCP23017 16-port I2C GPIO Extender module.
-//=======================================================================
-// The parameters are: 
-//   First Vpin=196
-//   Number of VPINs=16 (numbered 196-211)
-//   I2C address of module=0x22
-
-//MCP23017 gpioModule2(196, 16, 0x22);
-
-
-// Alternative form, which allows the INT pin of the module to request a scan
-// by pulling Arduino pin 40 to ground.  Means that the I2C isn't being polled
-// all the time, only when a change takes place. Multiple modules' INT pins
-// may be connected to the same Arduino pin.
-
-//MCP23017 gpioModule2(196, 16, 0x22, 40);
-
-
-//=======================================================================
-// The following directive defines an MCP23008 8-port I2C GPIO Extender module.
-//=======================================================================
-// The parameters are: 
-//   First Vpin=300
-//   Number of VPINs=8 (numbered 300-307)
-//   I2C address of module=0x22
-
-//MCP23008 gpioModule3(300, 8, 0x22);
-
-
-//=======================================================================
-// The following directive defines a PCF8574 8-port I2C GPIO Extender module.
-//=======================================================================
-// The parameters are: 
-//   First Vpin=200
-//   Number of VPINs=8 (numbered 200-207)
-//   I2C address of module=0x23
-
-//PCF8574 gpioModule4(200, 8, 0x23);
-
-
-// Alternative form using INT pin (see above)
-
-//PCF8574 gpioModule4(200, 8, 0x23, 40);
-
-
-//=======================================================================
-// The following directive defines an HCSR04 ultrasonic ranging module.
-//=======================================================================
-// The parameters are: 
-//   Vpin=2000 (only one VPIN per directive)
-//   Number of VPINs=1
-//   Arduino pin connected to TRIG=30
-//   Arduino pin connected to ECHO=31
-//   Minimum trigger range=20cm (VPIN goes to 1 when <20cm)
-//   Maximum trigger range=25cm (VPIN goes to 0 when >25cm)
-// Note: Multiple devices can be configured by using a different ECHO pin
-// for each one.  The TRIG pin can be shared between multiple devices.
-// Be aware that the 'ping' of one device may be received by another
-// device and position them accordingly!
-
-//HCSR04 sonarModule1(2000, 30, 31, 20, 25);
-//HCSR04 sonarModule2(2001, 30, 32, 20, 25);
-
-
-//=======================================================================
-// The following directive defines a single VL53L0X Time-of-Flight range sensor.
-//=======================================================================
-// The parameters are:
-//   VPIN=5000
-//   Number of VPINs=1
-//   I2C address=0x29 (default for this chip)
-//   Minimum trigger range=200mm (VPIN goes to 1 when <20cm)
-//   Maximum trigger range=250mm (VPIN goes to 0 when >25cm)
-
-//VL53L0X tofModule1(5000, 1, 0x29, 200, 250); 
-
-// For multiple VL53L0X modules, add another parameter which is a VPIN connected to the
-// module's XSHUT pin.  This allows the modules to be configured, at start,
-// with distinct I2C addresses.  In this case, the address 0x29 is only used during
-// initialisation to configure each device in turn with the desired unique I2C address.
-// The examples below have the modules' XSHUT pins connected to the first two pins of 
-// the first MCP23017 module (164 and 165), but Arduino pins may be used instead.
-// The first module here is given I2C address 0x30 and the second is 0x31.
-
-//VL53L0X tofModule1(5000, 1, 0x30, 200, 250, 164); 
-//VL53L0X tofModule2(5001, 1, 0x31, 200, 250, 165); 
-
-
-//=======================================================================
-// The function mySetup() is invoked from CS if it exists within the build.
-// It is called just before mysetup.h is executed, so things set up within here can be
-// referenced by commands in mySetup.h.
-//=======================================================================
-
-void mySetup() {
-
-  // Alternative way of creating a module driver, which has to be within the mySetup() function
-  // The other devices can also be created in this way.  The parameter lists for the
-  // create() function are identical to the parameter lists for the declarations.
-
-  //MCP23017::create(196, 16, 0x22);
-
-
-  //=======================================================================
-  // Creating a Turnout
-  //=======================================================================
-  // Parameters: same as <T> command for Servo turnouts
-  // ID and VPIN are 100, sonar moves between positions 102 and 490 with slow profile.
-  // Profile may be Instant, Fast, Medium, Slow or Bounce.
-
-  //ServoTurnout::create(100, 100, 490, 102, PCA9685::Slow);
-
-
-  //=======================================================================
-  // DCC Accessory turnout
-  //=======================================================================
-  // Parameters: same as <T> command for DCC Accessory turnouts
-  //  ID=3000
-  //  Decoder address=23
-  //  Decoder subaddress = 1
-
-  //DCCTurnout::create(3000, 23, 1);
-
-
-  //=======================================================================
-  // Creating a Sensor
-  //=======================================================================
-  // Parameters: As for the <S> command,
-  //  id = 164,
-  //  Vpin = 164 (configured above as pin 0 of an MCP23017)
-  //  Pullup enable = 1 (enabled)
-
-  //Sensor::create(164, 164, 1);
-
-
-  //=======================================================================
-  // Way of creating lots of identical sensors in a range
-  //=======================================================================
-
-  //for (int i=165; i<180; i++) 
-  //  Sensor::create(i, i, 1);
-
-
-  //=======================================================================
-  // Play mp3 files from a Micro-SD card, using a DFPlayer MP3 Module.
-  //=======================================================================
-  // Parameters: 
-  //   10000 = first VPIN allocated.
-  //   10 = number of VPINs allocated.
-  //   Serial1 = name of serial port (usually Serial1 or Serial2).
-  // With these parameters, up to 10 files may be played on pins 10000-10009.
-  // Play is started from EX-RAIL with SET(10000) for first mp3 file, SET(10001)
-  // for second file, etc.  Play may also be initiated by writing an analogue
-  // value to the first pin, e.g. SERVO(10000,23,0) will play the 23rd mp3 file.
-  // SERVO(10000,23,30) will do the same thing, as well as setting the volume to 
-  // 30 (maximum value).
-  // Play is stopped by RESET(10000) (or any other allocated VPIN).
-  // Volume may also be set by writing an analogue value to the second pin for the player, 
-  // e.g. SERVO(10001,30,0) sets volume to maximum (30).
-  // The EX-RAIL script may check for completion of play by calling WAITFOR(pin), which will only proceed to the
-  // following line when the player is no longer busy.
-  // E.g.
-  //    SEQUENCE(1)
-  //      AT(164)           // Wait for sensor attached to pin 164 to activate
-  //      SET(10003)        // Play fourth MP3 file
-  //      LCD(4, "Playing") // Display message on LCD/OLED
-  //      WAITFOR(10003)    // Wait for playing to finish
-  //      LCD(4, " ")       // Clear LCD/OLED line 
-  //      FOLLOW(1)         // Go back to start
-
-  // DFPlayer::create(10000, 10, Serial1);
-
-
-}
-
-#endif

release_notes.md

@@ -1,16 +1,88 @@
-The DCC-EX Team is pleased to release CommandStation-EX-v3.1.0 as a Production Release.  Release v3.1.0 is a minor release that adds additional features and fixes a number of bugs. With the number of new features, this could have easily been a major release. The team is continually improving the architecture of DCC++EX to make it more flexible and optimizing the code so as to get more performance from the Arduino (and other) microprocessors.  This release includes all of the Point Releases from v3.0.1 to v3.0.16.
+The DCC-EX Team is pleased to release CommandStation-EX-v4.0.0 as a Production Release.  Release v4.0.0 is a Major release that adds significant new product design, plus Automation features and bug fixes. The team continues improving the architecture of DCC++EX to make it more flexible and optimizing the code so as to get more performance from the Arduino (and other) microprocessors.  This release includes all of the Point Releases from v3.2.0 to v3.2.0 rc13.
 
 **Downloads (zip and tar.gz) below. These are named without version number in the folder name to make the Arduino IDE happy.**
 
-[CommandStation-EX.zip](https://github.com/DCC-EX/CommandStation-EX/releases/download/v3.1.0-Prod/CommandStation-EX.zip)
-[CommandStation-EX.tar.gz](https://github.com/DCC-EX/CommandStation-EX/releases/download/v3.1.0-Prod/CommandStation-EX.tar.gz)
+[CommandStation-EX.zip](https://github.com/DCC-EX/CommandStation-EX/releases/download/v4.0.0-Prod/CommandStation-EX.zip)
+
+
+
+[CommandStation-EX.tar.gz](https://github.com/DCC-EX/CommandStation-EX/releases/download/v0.0.0-Prod/CommandStation-EX.tar.gz)
 
 **Known Issues**
 
-- **Wi-Fi** - works, but requires sending <AT> commands from a serial monitor if you want to switch between AP mode and STA station mode after initial setup
-- **Pololu Motor Shield** - is supported with this release, but the user may have to adjust timings to enable programming mode due to limitation in its current sensing circuitry
+- **Wi-Fi** - Requires sending `<AT>` commands from a serial monitor if you want to switch between AP mode and STA station mode after initial setup
+- **Pololu Motor Shield** - is supported with this release, but the user may have to adjust timings to enable programming mode due to limitations in its current sensing circuitry
 
-#### Summary of key features and/or bug fixes by Point Release
+**All New Major DCC++EX 4.0.0 features**
+
+- **New HAL Hardware Abstraction Layer API** that automatically detects and greatly simplifies interfacing to many predefined accessory boards for servos, signals & sensors and added I/O (digital and analog inputs and outputs, servos etc). 
+- HAL Support for;
+  - MCP23008, MCP23017 and PCF9584 I2C GPIO Extender modules. 
+  - PCA9685 PWM (servo & signal) control modules. 
+  - Analogue inputs on Arduino pins and on ADS111x I2C modules. 
+  - MP3 sound playback via DFPlayer module. 
+  - HC-SR04 Ultrasonic range sensor module. 
+  - VL53L0X Laser range sensor module (Time-Of-Flight). 
+  - A new `<D HAL SHOW>` command to list the HAL devices attached to the command station
+ 
+**New Command Station Broadcast throttle logic**
+
+- Synchronizes multiple WiThrottles and PC based JMRI Throttles for direction, speed and F-key updates
+
+**New ‘Discovered Servers’ on WiFi Throttles**
+
+- Our New multicast Dynamic Network Server (mDNS) enhancement allows us to display the available WiFi server connections to a DCC++EX Command Station. Selecting it allows your WiThrottle App to connect to and load Server Rosters and function keys to your throttle from the new DCC++EX Command Station Server Roster.
+
+**New DCC++EX 4.0.0 with EX-RAIL Extended Railroad Automation Instruction Language**
+
+- Use to control your entire layout or as a separate accessory/animation controller
+- Awesome, cleverly powerful yet simple user friendly scripting language for user built Automation & Routing scripts. 
+- You can control Engines, Sensors, Turnouts, Signals, Outputs and Accessories that are entered into your new myAutomation.h file, then uploaded into the DCC++EX Command Station.
+- EX-RAIL scripts are automatically displayed as Automation {Handoff} and Route {Set} buttons on supported WiFi Throttle Apps.
+
+**New EX-RAIL ‘Roster’ Feature**
+
+- List and store user defined engine roster & function keys inside the command station, and automatically load them in WiFi Throttle Apps.
+- When choosing “DCC++EX” from discovered servers an Engine Driver or WiThrottle is directly connected to the Command Station. 
+- The EX-RAIL ’ROSTER’ command allows all the engine numbers, names and function keys you’ve listed in your myAutomation.h file to automatically upload the Command Station's ‘Server Roster’ into your Engine Driver and WiThrottle Apps.  
+
+**New JMRI 4.99.2 and above specific DCC++EX 4.0 features**
+
+- Enhanced JMRI DCC++ Configure Base Station pane for building and maintaining Sensor, Turnout and Output devices, or these can automatically be populated from the DCC++EX Command Station's mySetup.h file into JMRI.
+
+- JMRI now supports multiple serial connected DCC++EX Command Stations, to display and track separate "Send DCC++ Command" and "DCC++ Traffic" Monitors for each Command Station at the same time.
+  For example: Use an Uno DCC++EX DecoderPro Programming Station {DCC++Prg} on a desktop programming track and a second Mega DCC++EX EX-RAIL Command Station for Operations {DCC++Ops} on the layout with an additional `<JOINED>` programming spur or siding track for acquiring an engine and ‘Drive Away’ onto the mainline (see the DriveAway feature for more information).
+
+**DCC++EX 4.0.0 additional product enhancements**
+
+- Additional Motor Shields and Motor Board {boosters) supported
+- Additional Accessory boards supported for GPIO expansion, Sensors, Servos & Signals
+- Additional diagnostic commands like ‘D ACK RETRY’ and ‘D EXRAIL ON’ events, ‘D HAL SHOW’ devices and ‘D SERVO’ positions, and ‘D RESET’ the command station while maintaining the serial connection with JMRI
+- Automatic retry on failed ACK detection to give decoders another chance
+- New EX-RAIL ’/’ slash command allows JMRI to directly communicate with many EX-RAIL scripts
+- Turnout class revised to expand turnout capabilities and allow turnout names/descriptors to display in WiThrottle Apps.
+- Build turnouts through either or both mySetup.h and myAutomation.h files, and have them automatically passed to, and populate, JMRI Turnout Tables
+- Turnout user names display in Engine Driver & WiThrottles
+- Output class now allows ID > 255. 
+- Configuration options to globally flip polarity of DCC Accessory states when driven from `<a>` command and `<T>` command.
+- Increased use of display for showing loco decoder programming information. 
+- Can disable EEPROM memory code to allow room for DCC++EX 4.0 to fit on a Uno Command Station
+- Can define border between long and short addresses 
+- Native non-blocking I2C drivers for AVR and Nano architectures (fallback to blocking Wire library for other platforms). 
+- EEPROM layout change - deletes EEPROM contents on first start following upgrade. 
+
+**4.0.0 Bug Fixes**
+
+- Compiles on Nano Every
+- Diagnostic display of ack pulses >32ms
+- Current read from wrong ADC during interrupt
+- AT(+) Command Pass Through 
+- CiDAP WiFi Drop out and the WiThrottle F-key looping error corrected
+- One-off error in CIPSEND drop
+- Common Fault Pin Error
+- Uno Memory Utilization optimized
+
+#### Summary of Release 3.1.0 key features and/or bug fixes by Point Release
 
 **Summary of the key new features added to CommandStation-EX V3.0.16**
 
@@ -154,7 +226,7 @@ The DCC-EX Team is pleased to release CommandStation-EX-v3.1.0 as a Production R
 - Neil McKechnie - Worcestershire, UK (NeilMck)
 - Fred Decker - Holly Springs, North Carolina, USA (FlightRisk)
 - Dave Cutting - Logan, Utah, USA (Dave Cutting/ David Cutting)
-- M Steve Todd -  
+- M Steve Todd - Oregon, USA (MSteveTodd) 
 - Scott Catalano - Pennsylvania
 - Gregor Baues - Île-de-France, France (grbba)
 
@@ -174,6 +246,7 @@ The DCC-EX Team is pleased to release CommandStation-EX-v3.1.0 as a Production R
 - Roger Beschizza - Dorset, UK (Roger Beschizza)
 - Keith Ledbetter - Chicago, Illinois, USA (Keith Ledbetter)
 - Kevin Smith - Rochester Hills, Michigan USA (KC Smith)
+- Colin Grabham - Central NSW, Australia (Kebbin)
 
 **WebThrotle-EX**
 
@@ -185,13 +258,14 @@ The DCC-EX Team is pleased to release CommandStation-EX-v3.1.0 as a Production R
 
 - Larry Dribin - Release Management
 - Kevin Smith - Rochester Hills, Michigan USA (KC Smith)
+- Herb Morton - Kingwood Texas, USA (Ash++)
 - Keith Ledbetter
-- BradVan der Elst
+- Brad Van der Elst
 - Andrew Pye
 - Mike Bowers
 - Randy McKenzie
 - Roberto Bravin
-- Sim Brigden
+- Sam Brigden
 - Alan Lautenslager
 - Martin Bafver
 - Mário André Silva
@@ -202,5 +276,7 @@ The DCC-EX Team is pleased to release CommandStation-EX-v3.1.0 as a Production R
 
 **Downloads (zip and tar.gz) below. These are named without version number in the folder name to make the Arduino IDE happy.**
 
-[CommandStation-EX.zip](https://github.com/DCC-EX/CommandStation-EX/releases/download/v3.1.0-Prod/CommandStation-EX.zip)
-[CommandStation-EX.tar.gz](https://github.com/DCC-EX/CommandStation-EX/releases/download/v3.1.0-Prod/CommandStation-EX.tar.gz)
+[CommandStation-EX.zip](https://github.com/DCC-EX/CommandStation-EX/releases/download/v4.0.0-Prod/CommandStation-EX.zip)
+
+
+[CommandStation-EX.tar.gz](https://github.com/DCC-EX/CommandStation-EX/releases/download/v4.0.0-Prod/CommandStation-EX.tar.gz)

version.h

@@ -3,25 +3,44 @@
 
 #include "StringFormatter.h"
 
-#define VERSION "3.2.0 rc1"
-// 3.2.0 Major functional and non-functional changes.
-//       New HAL added for I/O (digital and analogue inputs and outputs, servos etc).
+#define VERSION "4.0.1"
+// 4.0.1 EXRAIL BROADCAST("msg") 
+//       EXRAIL POWERON
+// 4.0.0 Major functional and non-functional changes.
+//       Engine Driver "DriveAway" feature enhancement
+//       'Discovered Server' multicast Dynamic Network Server (mDNS) displays available WiFi connections to a DCC++EX Command Station
+//       New EX-RAIL "Extended Railroad Automation Instruction Language" automation capability.
+//         EX-Rail Function commands for creating Automation, Route & Sequence Scripts
+//         EX-RAIL “ROSTER” Engines Id & Function key layout on Engine Driver or WiThrottle
+//         EX-RAIL DCC++EX Commands to Control EX-RAIL via JMRI Send pane and IDE Serial monitors
+//       New JMRI feature enhancements; 
+//         Reads DCC++EX EEPROM & automatically uploades any Signals, DCC Turnouts, Servo Turnouts, Vpin Turnouts , & Output pane
+//         Turnout class revised to expand turnout capabilities, new commands added.
+//         Provides for multiple additional DCC++EX WiFi connections as accessory controllers or CS for a programming track when Motor Shields are added
+//         Supports Multiple Command Station connections and individual tracking of Send DCC++ Command panes and DCC++ Traffic Monitor panes
+//       New HAL added for I/O (digital and analogue inputs and outputs, servos etc)
+//         Automatically detects & connects to supported devices included in your config.h file
 //         Support for MCP23008, MCP23017 and PCF9584 I2C GPIO Extender modules.
 //         Support for PCA9685 PWM (servo) control modules.
 //         Support for analogue inputs on Arduino pins and on ADS111x I2C modules.
 //         Support for MP3 sound playback via DFPlayer module.
 //         Support for HC-SR04 Ultrasonic range sensor module.
 //         Support for VL53L0X Laser range sensor module (Time-Of-Flight).
-//       Native non-blocking I2C drivers for AVR and Nano architectures (fallback
-//       to blocking Wire library for other platforms).
+//         Added <D HAL SHOW> diagnostic command to show configured devices
+//       New Processor Support added
+//         Compiles on Nano Every and Teensy
+//       Native non-blocking I2C drivers for AVR and Nano architectures (fallback to blocking Wire library for other platforms).
+//       Can disable EEPROM code
 //       EEPROM layout change - deletes EEPROM contents on first start following upgrade.
-//       New EX-RAIL automation capability.
-//       Turnout class revised to expand turnout capabilities, new commands added.
 //       Output class now allows ID > 255.
-//       Configuration options to globally flip polarity of DCC Accessory states when driven
-//       from <a> command and <T> command.
+//       Configuration options to globally flip polarity of DCC Accessory states when driven from <a> command and <T> command.
 //       Increased use of display for showing loco decoder programming information.
-//       ...
+//       Can define border between long and short addresses
+//       Turnout and accessory states (thrown/closed = 0/1 or 1/0) can be set to match RCN-213
+//       Bugfix: one-off error in CIPSEND drop
+//       Bugfix: disgnostic display of ack pulses >32kus
+//       Bugfix: Current read from wrong ADC during interrupt
+// 3.2.0 Development Release Includes all of 3.1.1 thru 3.1.7 enhancements
 // 3.1.7 Bugfix: Unknown locos should have speed forward 
 // 3.1.6 Make output ID two bytes and guess format/size of registered outputs found in EEPROM
 // 3.1.5 Fix LCD corruption on power-up