Merge e7a59f3889 into 3b162996ad

CommandStation-EX.ino

@@ -52,6 +52,10 @@
 #include "DCCEX.h"
 #include "Display_Implementation.h"
 
+#ifdef ARDUINO_ARCH_ESP32
+  #include <ArduinoOTA.h>
+#endif // ARDUINO_ARCH_ESP32
+
 #ifdef CPU_TYPE_ERROR
 #error CANNOT COMPILE - DCC++ EX ONLY WORKS WITH THE ARCHITECTURES LISTED IN defines.h
 #endif
@@ -101,6 +105,9 @@ void setup()
 #else
   // ESP32 needs wifi on always
   WifiESP::setup(WIFI_SSID, WIFI_PASSWORD, WIFI_HOSTNAME, IP_PORT, WIFI_CHANNEL, WIFI_FORCE_AP);
+  #if OTA_AUTO_INIT
+    Diag::OTA = true;
+  #endif // OTA_AUTO_INIT
 #endif // ARDUINO_ARCH_ESP32
 
 #if ETHERNET_ON
@@ -150,6 +157,50 @@ void loop()
 #ifndef WIFI_TASK_ON_CORE0
   WifiESP::loop();
 #endif
+  // Responsibility 4: Optionally handle Arduino OTA updates
+  if (Diag::OTA) {
+    static bool otaInitialised = false;
+    // Initialise OTA if not already done
+    if (!otaInitialised) {
+      ArduinoOTA.setHostname(WIFI_HOSTNAME);
+      // Prevent locos from moving during OTA
+      ArduinoOTA.onStart([]() {
+        // Emergency stop all locos
+        DCC::setThrottle(0,1,1);
+        // Disable tracks power
+        TrackManager::setMainPower(POWERMODE::OFF);
+        TrackManager::setProgPower(POWERMODE::OFF);
+        // Broadcast power status
+        CommandDistributor::broadcastPower();
+        DISPLAY_START (
+          LCD(0,F("OTA update"));
+          LCD(1,F("In progress..."));
+        );
+      });
+      ArduinoOTA.onEnd([]() {
+        DISPLAY_START (
+          LCD(0,F("OTA update"));
+          LCD(1,F("Complete"));
+        );
+      });
+      ArduinoOTA.onError([](ota_error_t error) {
+        DISPLAY_START (
+          LCD(0,F("OTA update"));
+          LCD(1,F("Error: %d"), error);
+        );
+      });
+      // Set OTA password if defined
+      #ifdef OTA_AUTH
+        ArduinoOTA.setPassword(OTA_AUTH);
+      #endif // OTA_AUTH
+      ArduinoOTA.begin();
+      otaInitialised = true;
+    }
+    // Handle OTA if initialised
+    else {
+      ArduinoOTA.handle();
+    }
+  }
 #endif //ARDUINO_ARCH_ESP32
 #if ETHERNET_ON
   EthernetInterface::loop();

DCCEXParser.cpp

@@ -168,6 +168,7 @@ const int16_t HASH_KEYWORD_ANOUT = -26399;
 const int16_t HASH_KEYWORD_WIFI = -5583;
 const int16_t HASH_KEYWORD_ETHERNET = -30767;
 const int16_t HASH_KEYWORD_WIT = 31594;
+const int16_t HASH_KEYWORD_OTA = 22938;
 
 int16_t DCCEXParser::stashP[MAX_COMMAND_PARAMS];
 bool DCCEXParser::stashBusy;
@@ -1084,6 +1085,11 @@ bool DCCEXParser::parseD(Print *stream, int16_t params, int16_t p[])
         IODevice::writeAnalogue(p[1], p[2], params>3 ? p[3] : 0);
         break;
 
+    case HASH_KEYWORD_OTA:    // <D OTA ON/OFF>
+        Diag::OTA = onOff;
+        DIAG(F("OTA=%S"), onOff ? F("ON") : F("OFF"));
+        return true;
+
     default: // invalid/unknown
         break;
     }

StringFormatter.cpp

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

StringFormatter.h

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

config.example.h

@@ -117,6 +117,9 @@ The configuration file for DCC-EX Command Station
 #define WIFI_PASSWORD "Your network passwd"
 //
 // WIFI_HOSTNAME: You probably don't need to change this
+// Note: If you're using OTA updates (OTA_ENABLED == true), and decide
+// to modify this name, remember to concurrently update the "upload_port"
+// in the corresponding environment within the platformio.ini file.
 #define WIFI_HOSTNAME "dccex"
 //
 // WIFI_CHANNEL: If the line "#define ENABLE_WIFI true" is uncommented,
@@ -129,6 +132,21 @@ The configuration file for DCC-EX Command Station
 // true. Otherwise it is assumed that you'd like to connect to an existing network
 // with that SSID.
 #define WIFI_FORCE_AP false
+//
+// OTA_AUTO_INIT: Set this to true if you want OTA updates to be initialized
+// automatically upon startup. If set to false, OTA updates will remain
+// unavailable until the "<C OTA 1>" command is executed.
+// Please note that this feature requires the use of ARDUINO_ARCH_ESP32 as your board.
+#define OTA_AUTO_INIT false
+//
+// OTA_AUTH: Set this to your desired password if you wish to secure OTA updates.
+// If not set, OTA updates will be password-free.
+// Note: Upon modifying the OTA password, ensure to update the "upload_flags → --auth"
+// in the relevant environment within the platformio.ini file.
+// To deactivate OTA authorization, comment out the line below and comment out
+// the "upload_flags" line in the platformio.ini file.
+// #define OTA_AUTH "dccex-ota"
+
 
 /////////////////////////////////////////////////////////////////////////////////////
 //

platformio.ini

@@ -176,6 +176,20 @@ build_flags = -std=c++17
 monitor_speed = 115200
 monitor_echo = yes
 
+[env:ESP32-OTA]
+platform = espressif32
+board = esp32dev
+framework = arduino
+lib_deps = ${env.lib_deps}
+build_flags = -std=c++17
+monitor_speed = 115200
+monitor_echo = yes
+upload_protocol = espota
+upload_port = dccex
+upload_flags =
+	--timeout=10
+	--auth=dccex-ota
+
 [env:Nucleo-F411RE]
 platform = ststm32
 board = nucleo_f411re