Merge 2c133da14040d63993a71bd82ded11560255d646 into 14724aeb2a63a6671eb7079d89ab63770c3e791f

DCCACK.cpp

@@ -67,24 +67,16 @@ CALLBACK_STATE DCCACK::callbackState=READY;
 ACK_CALLBACK DCCACK::ackManagerCallback;
 
 void  DCCACK::Setup(int cv, byte byteValueOrBitnum, ackOp const program[], ACK_CALLBACK callback) {
-  // On ESP32 the joined track is hidden from sight (it has type MAIN)
-  // and because of that we need first check if track was joined and
-  // then unjoin if necessary. This requires that the joined flag is
-  // cleared when the prog track is removed.
   ackManagerRejoin=TrackManager::isJoined();
-  //DIAG(F("Joined is %d"), ackManagerRejoin);
   if (ackManagerRejoin) {
     // Change from JOIN must zero resets packet.
     TrackManager::setJoin(false);
     DCCWaveform::progTrack.clearResets();
   }
+
   progDriver=TrackManager::getProgDriver();
-  //DIAG(F("Progdriver is %d"), progDriver);
   if (progDriver==NULL) {
-    if (ackManagerRejoin) {
-      DIAG(F("Joined but no Prog track"));
-      TrackManager::setJoin(false);
-    }
+    TrackManager::setJoin(ackManagerRejoin);
     callback(-3); // we dont have a prog track!
     return;
   }

DCCEXParser.cpp

@@ -402,8 +402,7 @@ void DCCEXParser::parseOne(Print *stream, byte *com, RingStream * ringStream)
            || (p[activep] > 1) || (p[activep] < 0) // invalid activate 0|1
 	      ) break;
           // Honour the configuration option (config.h) which allows the <a> command to be reversed
-	  // Because of earlier confusion we need to do the same thing under both defines
-#if defined(DCC_ACCESSORY_COMMAND_REVERSE) || defined(DCC_ACCESSORY_RCN_213)
+#ifdef DCC_ACCESSORY_COMMAND_REVERSE
           DCC::setAccessory(address, subaddress,p[activep]==0,onoff);
 #else
           DCC::setAccessory(address, subaddress,p[activep]==1,onoff);

DCCTimerESP.cpp

@@ -80,7 +80,7 @@ int DCCTimer::freeMemory() {
 
 #include "esp_idf_version.h"
 #if ESP_IDF_VERSION_MAJOR > 4
-#error "DCC-EX does not support compiling with IDF version 5.0 or later. Downgrade your ESP32 library to a version that contains IDF version 4. Arduino ESP32 library 3.0.0 is too new. Downgrade to one of 2.0.9 to 2.0.17"
+#error "DCC-EX does not support compiling with IDF version 5.0 or later. Downgrade your ESP32 library to a version that contains IDE version 4. Arduino ESP32 library 3.0.0 is too new. Downgrade to one of 2.0.9 to 2.0.17"
 #endif
 
 #include "DIAG.h"

EXRAIL2.cpp

@@ -1328,7 +1328,7 @@ void RMFT2::clockEvent(int16_t clocktime, bool change) {
 void RMFT2::powerEvent(int16_t track, bool overload) {
   // Hunt for an ONOVERLOAD for this item
   if (Diag::CMD)
-   DIAG(F("powerEvent : %c"), track + 'A');
+   DIAG(F("powerEvent : %c"), track);
   if (overload) {
     onOverloadLookup->handleEvent(F("POWER"),track);
   }

EXRAILMacros.h

@@ -516,7 +516,7 @@ int RMFT2::onLCCLookup[RMFT2::countLCCLookup];
 #ifndef IO_NO_HAL
 #define EXTT_TURNTABLE(id,vpin,home,description...) OPCODE_EXTTTURNTABLE,V(id),OPCODE_PAD,V(vpin),OPCODE_PAD,V(home),
 #endif
-#define FADE(pin,value,ms) OPCODE_SERVO,V(pin),OPCODE_PAD,V(value),OPCODE_PAD,V((int16_t)PCA9685::ProfileType::UseDuration|(int16_t)PCA9685::ProfileType::NoPowerOff),OPCODE_PAD,V(ms/100L),
+#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),
 #define FON(func) OPCODE_FON,V(func),

GITHUB_SHA.h

@@ -1 +1 @@
-#define GITHUB_SHA "devel-202501021826Z"
+#define GITHUB_SHA "devel-202411091200Z"

IODevice.h

@@ -38,7 +38,6 @@
 #include "FSH.h"
 #include "I2CManager.h"
 #include "inttypes.h"
-#include "TemplateForEnums.h"
 
 typedef uint16_t VPIN;
 // Limit VPIN number to max 32767.  Above this number, printing often gives negative values.

MotorDriver.h

@@ -28,9 +28,12 @@
 #include "DCCTimer.h"
 #include <wiring_private.h>
 
-#include "TemplateForEnums.h"
 // use powers of two so we can do logical and/or on the track modes in if clauses.
 // For example TRACK_MODE_DC_INV is (TRACK_MODE_DC|TRACK_MODIFIER_INV)
+template<class T> inline T operator~ (T a) { return (T)~(int)a; }
+template<class T> inline T operator| (T a, T b) { return (T)((int)a | (int)b); }
+template<class T> inline T operator& (T a, T b) { return (T)((int)a & (int)b); }
+template<class T> inline T operator^ (T a, T b) { return (T)((int)a ^ (int)b); }
 enum TRACK_MODE : byte {
   // main modes
   TRACK_MODE_NONE = 1, TRACK_MODE_MAIN = 2, TRACK_MODE_PROG = 4,

README.md

@@ -1,39 +1,77 @@
-# What is DCC-EX?
-DCC-EX is a team of dedicated enthusiasts producing open source DCC & DC solutions for you to run your complete model railroad layout. Our easy to use, do-it-yourself, and free open source products run on off-the-shelf Arduino technology and are supported by numerous third party hardware and apps like JMRI, Engine Driver, wiThrottle, Rocrail and more. 
+# What is DCC++ EX?
+DCC++ EX is the organization maintaining several codebases that together represent a fully open source DCC system. Currently, this includes the following:
 
-Currently, our products include the following:
+* [CommandStation-EX](https://github.com/DCC-EX/CommandStation-EX/releases) - the latest take on the DCC++ command station for controlling your trains. Runs on an Arduino board, and includes advanced features such as a WiThrottle server implementation, turnout operation, general purpose inputs and outputs (I/O), and JMRI integration.
+* [exWebThrottle](https://github.com/DCC-EX/exWebThrottle) - a simple web based controller for your DCC++ command station.
+* [BaseStation-installer](https://github.com/DCC-EX/BaseStation-Installer) - an installer executable that takes care of downloading and installing DCC++ firmware onto your hardware setup.
+* [BaseStation-Classic](https://github.com/DCC-EX/BaseStation-Classic) - the original DCC++ software, packaged in a stable release. No active development, bug fixes only.
 
-* [EX-CommandStation](https://github.com/DCC-EX/CommandStation-EX/releases)
-* [EX-WebThrottle](https://github.com/DCC-EX/exWebThrottle)
-* [EX-Installer](https://github.com/DCC-EX/EX-Installer)
-* [EX-MotoShield8874](https://dcc-ex.com/reference/hardware/motorboards/ex-motor-shield-8874.html#gsc.tab=0)
-* [EX-DCCInspector](https://github.com/DCC-EX/DCCInspector-EX)
-* [EX-Toolbox](https://github.com/DCC-EX/EX-Toolbox)
-* [EX-Turntable](https://github.com/DCC-EX/EX-Turntable)
-* [EX-IOExpander](https://github.com/DCC-EX/EX-IOExpander)
-* [EX-FastClock](https://github.com/DCC-EX/EX-FastClock)
-* [DCCEXProtocol](https://github.com/DCC-EX/DCCEXProtocol)
+A basic DCC++ EX hardware setup can use easy to find, widely avalable Arduino boards that you can assemble yourself.
+
+Both CommandStation-EX and BaseStation-Classic support much of the NMRA Digital Command Control (DCC) [standards](http://www.nmra.org/dcc-working-group "NMRA DCC Working Group"), including:
+
+* simultaneous control of multiple locomotives
+* 2-byte and 4-byte locomotive addressing
+* 28 or 128-step speed throttling
+* Activate/de-activate all accessory function addresses 0-2048
+* 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 many more custom features. see [What's new in CommandStation-EX?](#whats-new-in-commandstation-ex)
 
-Details of these projects can be found on [our web site](https://dcc-ex.com/).
 
 # What’s in this Repository?
 
-This repository, CommandStation-EX, contains a complete DCC-EX *EX-CommmandStation* sketch designed for compiling and uploading into an Arduino Uno, Mega, or Nano.
+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: 
 
-1. (recommended for all levels of user) our [automated installer](https://github.com/DCC-EX/EX-Installer)
+1. (beginner) our [automated installer](https://github.com/DCC-EX/BaseStation-Installer)
 2. (intermediate) download the latest version from the [releases page](https://github.com/DCC-EX/CommandStation-EX/releases)
 3. (advanced) use git clone on this repository 
 
-Refer to [our web site](https://https://dcc-ex.com/ex-commandstation/get-started/index.html#/) for the hardware required for this project.
+Not using the installer? Open the file "CommandStation-EX.ino" in the
+Arduino IDE. Please do not rename the folder containing the sketch
+code, nor add any files in that folder. The Arduino IDE relies on the
+structure and name of the folder to properly display and compile the
+code. Rename or copy config.example.h to config.h. If you do not have 
+the standard setup, you must edit config.h according to the help texts 
+in config.h.
 
-**We seriously recommend using the EX-Installer**, however if you choose not to use the installer... 
+## What's new in CommandStation-EX?
 
-* Open the file ``CommandStation-EX.ino`` in the Arduino IDE or Visual Studio Code (VSC). Please do not rename the folder containing the sketch code, nor add any files in that folder. The Arduino IDE relies on the structure and name of the folder to properly display and compile the code. 
-* Rename or copy ``config.example.h`` to ``config.h``. 
-* You must edit ``config.h`` according to the help texts in ``config.h``.
+* WiThrottle server built in. Connect Engine Driver or WiThrottle clients directly to your Command Station (or through JMRI as before)
+* WiFi and Ethernet shield support
+* No more jumpers or soldering!
+* Direct support for all the most popular motor control boards including single pin (Arduino) or dual pin (IBT_2) type PWM inputs without the need for an adapter circuit
+* I2C Display support (LCD and OLED)
+* Improved short circuit detection and automatic reset from an overload
+* Current reading, sensing and ACK detection settings in milliAmps instead of just pin readings
+* Improved adherence to the NMRA DCC specification
+* Complete support for all the old commands and front ends like JMRI
+* Railcom cutout (beta)
+* Simpler, modular, faster code with an API Library for developers for easy expansion
+* New features and functions in JMRI
+* Ability to join MAIN and PROG tracks into one MAIN track to run your locos
+* "Drive-Away" feature - Throttles with support, 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
+* Diagnostic commands to test decoders that aren't reading or writing correctly
+* Support for Uno, Nano, Mega, Nano Every and Teensy microcontrollers
+* User Functions: Filter regular commands (like a turnout or output command) and pass it to your own function or accessory
+* Support for LCN (layout control nodes)
+* mySetup.h file that acts like an Autoexec.Bat command to send startup commands to the CS
+* High Accuracty Waveform option for rock steady DCC signals
+* New current response outputs current in mA, overlimit current, and maximum board capable current. Support for new current meter in JMRI
+* USB Browser based EX-WebThrottle
+* New, simpler, function control command
+* Number of locos discovery command `<#>`
+* Emergency stop command <!>
+* Release cabs from memory command <-> all cabs, <- CAB> for just one loco address
+* 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, 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/)
+You can learn more at the [DCC++ EX website](https://dcc-ex.com/)
 
+- November 14, 2020

TemplateForEnums.h

@@ -1,26 +0,0 @@
-/*
- *  © 2024, 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/>.
- */
-#ifndef TemplateForEnums
-#define TemplateForEnums
-template<class T> inline T operator~ (T a) { return (T)~(int)a; }
-template<class T> inline T operator| (T a, T b) { return (T)((int)a | (int)b); }
-template<class T> inline T operator& (T a, T b) { return (T)((int)a & (int)b); }
-template<class T> inline T operator^ (T a, T b) { return (T)((int)a ^ (int)b); }
-#endif
-

TrackManager.cpp

@@ -246,6 +246,9 @@ bool TrackManager::setTrackMode(byte trackToSet, TRACK_MODE mode, int16_t dcAddr
 #endif
 #ifndef DISABLE_PROG
     if (mode & TRACK_MODE_PROG) {
+#else
+    if (false) {
+#endif
       // only allow 1 track to be prog
       FOR_EACH_TRACK(t)
 	if ( (track[t]->getMode() & TRACK_MODE_PROG) && t != trackToSet) {
@@ -258,7 +261,6 @@ bool TrackManager::setTrackMode(byte trackToSet, TRACK_MODE mode, int16_t dcAddr
     } else {
       track[trackToSet]->makeProgTrack(false); // only the prog track knows it's type
     }
-#endif
 
     // When a track is switched, we must clear any side effects of its previous 
     // state, otherwise trains run away or just dont move.
@@ -356,24 +358,11 @@ bool TrackManager::setTrackMode(byte trackToSet, TRACK_MODE mode, int16_t dcAddr
         applyDCSpeed(trackToSet);
     }
 
-#ifdef ARDUINO_ARCH_ESP32
-#ifndef DISABLE_PROG
-    if (tempProgTrack == trackToSet && oldmode & TRACK_MODE_MAIN && !(mode & TRACK_MODE_PROG)) {
-      // If we just take away the prog track, the join should not
-      // be active either. So do in effect an unjoin
-      //DIAG(F("Unsync"));
-      tempProgTrack = MAX_TRACKS+1;
-      progTrackSyncMain=false;
-      if (joinRelay!=UNUSED_PIN) digitalWrite(joinRelay,LOW);
-    }
-#endif
-#endif
     // Turn off power if we changed the mode of this track
-    if (mode != oldmode) {
+    if (mode != oldmode)
       track[trackToSet]->setPower(POWERMODE::OFF);
-    }
-
     streamTrackState(NULL,trackToSet);
+
     //DIAG(F("TrackMode=%d"),mode);
     return true; 
 }

Turnouts.cpp

@@ -312,6 +312,12 @@
  * 
  *************************************************************************************/
 
+#if defined(DCC_TURNOUTS_RCN_213)
+  const bool DCCTurnout::rcn213Compliant = true;
+#else
+  const bool DCCTurnout::rcn213Compliant = false;
+#endif
+
   // DCCTurnoutData contains data specific to this subclass that is 
   // written to EEPROM when the turnout is saved.
   struct DCCTurnoutData {
@@ -379,10 +385,7 @@
     // DCC++ Classic behaviour is that Throw writes a 1 in the packet,
     // and Close writes a 0.  
     // RCN-213 specifies that Throw is 0 and Close is 1.
-#if defined(DCC_TURNOUTS_RCN_213)
-    close = !close;
-#endif
-    DCC::setAccessory(_dccTurnoutData.address, _dccTurnoutData.subAddress, close);
+    DCC::setAccessory(_dccTurnoutData.address, _dccTurnoutData.subAddress, close ^ !rcn213Compliant);
     return true;
   }
 

Turnouts.h

@@ -245,6 +245,8 @@ public:
   // Load a VPIN turnout definition from EEPROM.  The common Turnout data has already been read at this point.
   static Turnout *load(struct TurnoutData *turnoutData);
   void print(Print *stream) override;
+  // Flag whether DCC Accessory packets are to contain 1=close/0=throw(RCN-213) or 1=throw/0-close (DCC++ Classic)
+  static const bool rcn213Compliant;
 
 protected:
   bool setClosedInternal(bool close) override;

config.example.h

@@ -1,7 +1,7 @@
 /*
  *  © 2022 Paul M. Antoine
  *  © 2021 Neil McKechnie
- *  © 2020-2025 Harald Barth
+ *  © 2020-2023 Harald Barth
  *  © 2020-2021 Fred Decker
  *  © 2020-2021 Chris Harlow
  *  © 2023 Nathan Kellenicki
@@ -45,14 +45,15 @@ The configuration file for DCC-EX Command Station
 //        the correct resistor could damage the sense pin on your Arduino or destroy
 //        the device.
 //
-// DEFINE MOTOR_SHIELD_TYPE BELOW. THESE ARE EXAMPLES. Full list in MotorDrivers.h
+// DEFINE MOTOR_SHIELD_TYPE BELOW. THESE ARE EXAMPLES. FULL LIST IN MotorDrivers.h
 //
 //  STANDARD_MOTOR_SHIELD : Arduino Motor shield Rev3 based on the L298 with 18V 2A per channel
 //  POLOLU_MOTOR_SHIELD   : Pololu MC33926 Motor Driver (not recommended for prog track)
+//  FUNDUMOTO_SHIELD      : Fundumoto Shield, no current sensing (not recommended, no short protection)
+//  FIREBOX_MK1           : The Firebox MK1                    
+//  FIREBOX_MK1S          : The Firebox MK1S
+//  IBT_2_WITH_ARDUINO    : Arduino Motor Shield for PROG and IBT-2 for MAIN
 //  EX8874_SHIELD         : DCC-EX TI DRV8874 based motor shield
-//  EXCSB1                : DCC-EX CSB-1 hardware
-//  EXCSB1_WITH_EX8874    : DCC-EX CSB-1 hardware with DCC-EX TI DRV8874 shield
-//  NO_SHIELD             : CS without any motor shield (as an accessory only CS)
 //   |
 //   +-----------------------v
 //
@@ -80,7 +81,7 @@ The configuration file for DCC-EX Command Station
 
 /////////////////////////////////////////////////////////////////////////////////////
 //
-// NOTE: Not supported on Arduino Uno or Nano
+// NOTE: Only supported on Arduino Mega
 // Set to false if you not even want it on the Arduino Mega
 //
 #define ENABLE_WIFI true
@@ -115,13 +116,13 @@ The configuration file for DCC-EX Command Station
 // Your password may not contain ``"'' (double quote, ASCII 0x22).
 #define WIFI_PASSWORD "Your network passwd"
 //
-// WIFI_HOSTNAME: You can change this if you have more than one
-// CS to make them show up with different names on the network.
-// Otherwise do not touch.
+// WIFI_HOSTNAME: You probably don't need to change this
 #define WIFI_HOSTNAME "dccex"
 //
-// WIFI_CHANNEL: The default channel is set to "1". If you need to use an
-// alternate channel (we recommend using only 1,6, or 11) you may change it here.
+// WIFI_CHANNEL: If the line "#define ENABLE_WIFI true" is uncommented, 
+// WiFi will be enabled (Mega only). The default channel is set to "1" whether
+// this line exists or not. If you need to use an alternate channel (we recommend
+// using only 1,6, or 11) you may change it here.
 #define WIFI_CHANNEL 1
 //
 // WIFI_FORCE_AP: If you'd like to specify your own WIFI_SSID in AP mode, set this
@@ -131,9 +132,8 @@ The configuration file for DCC-EX Command Station
 
 /////////////////////////////////////////////////////////////////////////////////////
 //
-// ENABLE_ETHERNET: Set to true if you have an Arduino Ethernet card (wired) based
-// on the W5100/W5500 ethernet chip or an STM32 CS with builin ethernet like the F429ZI.
-// This is not for Wifi. You will then need the Arduino Ethernet library as well.
+// ENABLE_ETHERNET: Set to true if you have an Arduino Ethernet card (wired). This
+// is not for Wifi. You will then need the Arduino Ethernet library as well
 //
 //#define ENABLE_ETHERNET true
 
@@ -269,10 +269,9 @@ The configuration file for DCC-EX Command Station
 // 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). This is the same as DCC_ACCESSORY_COMMAND_REVERSE
+// (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.
@@ -334,7 +333,7 @@ The configuration file for DCC-EX Command Station
 // to the sabertooth controller _as_well_. Default: Undefined.
 //
 //#define SABERTOOTH 1
-
+//
 /////////////////////////////////////////////////////////////////////////////////////
 //
 // SENSORCAM
@@ -346,7 +345,7 @@ The configuration file for DCC-EX Command Station
 //#define SENSORCAM2_VPIN 600   //define other CAM's if installed.
 //#define CAM2 SENSORCAM2_VPIN+ //for EX-RAIL commands e.g. IFLT(CAM2 020,1)
 //
-// For smoother power-up, when using the CAM, you may need a STARTUP_DELAY.
-// That is described further above.
+// For smoother power-up, define a STARTUP_DELAY to allow CAM to initialise ref images
+//#define STARTUP_DELAY 5000    // up to 20sec. CS delay
 //
 /////////////////////////////////////////////////////////////////////////////////////

version.h

@@ -3,11 +3,7 @@
 
 #include "StringFormatter.h"
 
-#define VERSION "5.2.95"
-// 5.2.95 - Release candidate for 5.4
-// 5.2.94 - Bugfix: Less confusion and simpler code around the RCN213 defines
-// 5.2.93 - Bugfix ESP32: clear progTrackSyncMain (join flag) when prog track is removed
-// 5.2.92 - Bugfix: FADE power off fix, EXRAIL power diagnostic fix.
+#define VERSION "5.2.91"
 // 5.2.91 - Bugfix: Neopixel I2C overlap check
 // 5.2.90 - Bugfix: EXRAIL EXTT_TURNTABLE() now has description as optional in line with ocumentation (also fixed DCC_TURNTABLE) 
 // 5.2.89 - EXRAIL SET(vpin[,npins]) RESET(vpin,[,npins]) pin range manipulation