ESP8266 and ESP32 support

Author: JAndrassy

README.md

@@ -12,6 +12,7 @@ The library is a modification of the Arduino WiFi101OTA library.
 * ATmega AVR with at least 64 kB of flash (Arduino Mega, [MegaCore](https://github.com/MCUdude/MegaCore) MCUs, MightyCore 1284p and 644)
 * Arduino SAMD boards like Zero, M0 or MKR 
 * nRF5 board supported by [nRF5 core](https://github.com/sandeepmistry/arduino-nRF5).
+* boards supported by ESP8266 and ESP32 Arduino boards package  
 
 ## Supported networking libraries
 
@@ -22,6 +23,7 @@ The library is a modification of the Arduino WiFi101OTA library.
 * UIPEthernet - shields and modules with ENC28j60 chip
 * WiFiSpi - esp8266 as SPI network adapter with WiFiSpi library updated with [this PR](https://github.com/JiriBilek/WiFiSpi/pull/12)
 * WiFi - Arduino WiFi Shield (not tested)
+* WiFi library of ESP8266 and ESP32 Arduino boards package
 
 UIPEthernet, WiFiSpi and WiFi library don't support UDP multicast for MDNS, so Arduino IDE will not show the network upload port. WiFiLink doesn't support UDP multicast, but the firmware propagates the MDNS record.
 
@@ -35,13 +37,15 @@ Arduino SAMD boards (Zero, M0, MKR) are supported 'out of the box'.
 
 For nRF5 boards two lines need to be added to platform.txt file of the nRF5 Arduino package (until the PR that adds them is accepted and included in a release). Only nRF51 was tested until now. For details scroll down.
 
+For ESP8266 and ESP32 boards, platform.local.txt from extras folder need to be copied into boards package installation folder and the bundled ArduinoOTA library must be deleted. For details scroll down.
+
 ATmega boards require to flash a modified Optiboot bootloader for flash write operations. Details are below.
 
 ## ATmega support
 
 The size of networking library and SD library limit the use of ArduinoOTA library to ATmega MCUs with at least 64 kB flash memory. 
 
-*There are other network upload options for here excluded ATmega328p ([Ariadne bootloader](https://github.com/loathingKernel/ariadne-bootloader) for Wiznet chips, [WiFiLink firmware](https://github.com/jandrassy/arduino-firmware-wifilink) for the esp8266).*
+*There are other network upload options for here excluded ATmega328p: ([Ariadne bootloader](https://github.com/loathingKernel/ariadne-bootloader) for Wiznet chips, [WiFiLink firmware](https://github.com/jandrassy/arduino-firmware-wifilink) for the esp8266).*
 
 For upload over InternalStorage, Optiboot bootloader with [`copy_flash_pages` function](https://github.com/Optiboot/optiboot/pull/269) is required. Arduino AVR package doesn't use Optiboot for Arduino Mega. For Arduino Mega you can download [my boards definitions](https://github.com/jandrassy/my_boards) and use it [to burn](https://arduino.stackexchange.com/questions/473/how-do-i-burn-the-bootloader) the modified Optiboot and to upload sketches to your Mega over USB and over network. 
 
@@ -51,6 +55,20 @@ To use remote upload from IDE with SDStorage or InternalStorage, copy platform.l
 
 The IDE upload tool is installed with Arduino AVR core package. At least version 1.2 of the arduinoOTA tool is required. For upload from command line without IDE see the command template in extras/avr/platform.local.txt.
 
+## ESP8266 and ESP32 support
+
+The ArduinoOTA library bundled with ESP8266 and ESP32 Arduino packages works only with native WiFi libraries. This library allows to upload a sketch to esp8266 or esp32 over Ethernet with Ethernet or UIPEthernet library. Upload over the native WiFi library works too.
+
+To use this library instead of the bundled library, the bundled library must be removed from the boards package library folder. To override the configuration of OTA upload in platform.txt, copy the platform.local.txt file from extras folder of this library next to platform.txt file in boards package installation folder. Packages are located in ~/.arduino15/packages/ on Linux and %userprofile%\AppData\Local\Arduino15\packages\ on Windows (AppData is a hidden folder).
+
+The esp8266 boards package has bundled Ethernet library. It is an old version of the Arduino Ethernet library which works only with W5100 chips. It is better to remove it from boards package and install the Ethernet library from Library Manager in IDE.
+
+This library supports SPIFFS upload to esp8266 and esp32, but the IDE plugins have the network upload tool hardcoded to espota. It can't be changed in configuration. To upload SPIFFS, call the plugin in Tools menu and after it fails to upload over network, go to location of the created bin file and upload the file with arduinoOTA tool from command line. The location of the file is printed in the IDE console window. Upload command example (linux):
+```
+~/arduino-1.8.8/hardware/tools/avr/bin/arduinoOTA -address 192.168.1.107 -port 65280 -username arduino -password password -sketch OTEthernet.spiffs.bin -upload /data -b
+```
+(the same command can be used to upload the sketch binary, only use `-upload /sketch`)
+
 ## nRF5 support
 
 Note: Only nRF51 was tested for now
@@ -78,6 +96,10 @@ void shutdown() {
 * ATmega
     - Arduino Mega
     - Badio 1284p
+* esp8266
+    - Wemos D1 mini
+* esp32
+    - ESP32 Dev Module    
 
 ## Contribution
 

extras/avr/platform.local.txt

@@ -1,4 +1,6 @@
 
+# This configuration file supports the general ArduinoOTA library https://github.com/jandrassy/ArduinoOTA
+
 ## Create output (bin file)
 recipe.objcopy.bin.pattern="{compiler.path}{compiler.elf2hex.cmd}" -O binary {compiler.elf2hex.extra_flags} "{build.path}/{build.project_name}.elf" "{build.path}/{build.project_name}.bin"
 

extras/esp32/platform.local.txt

@@ -0,0 +1,6 @@
+
+# This configuration file supports the general ArduinoOTA library https://github.com/jandrassy/ArduinoOTA
+
+tools.esptool_py.network_cmd={runtime.tools.arduinoOTA.path}/bin/arduinoOTA
+tools.esptool_py.upload.network_pattern="{network_cmd}" -address {serial.port} -port 65280 -username arduino -password "{network.password}" -sketch "{build.path}/{build.project_name}.bin" -upload /sketch -b
+

extras/esp8266/platform.local.txt

@@ -0,0 +1,6 @@
+
+# This configuration file supports the general ArduinoOTA library https://github.com/jandrassy/ArduinoOTA
+
+tools.esptool.network_cmd={runtime.tools.arduinoOTA.path}/bin/arduinoOTA
+tools.esptool.upload.network_pattern="{network_cmd}" -address {serial.port} -port 65280 -username arduino -password "{network.password}" -sketch "{build.path}/{build.project_name}.bin" -upload /sketch -b
+

library.properties

@@ -1,9 +1,9 @@
 name=ArduinoOTA
-version=1.0.0
+version=1.0.1
 author=Arduino,Juraj Andrassy
 maintainer=Juraj Andrassy <[email protected]>
 sentence=Upload sketch over network to Arduino board with WiFi or Ethernet libraries 
-paragraph=Based on WiFi101OTA library. http://www.arduino.cc/en/Reference/WiFi101OTA
+paragraph=Based on WiFi101OTA library. Uploads over Ethernet, UIPEthernet, WiFi101, WiFiNina, WiFiLink, WiFi to SAMD, nRF5, esp8266, esp32 and to ATmega with more then 64 kB flash memory. 
 category=Other
 url=https://github.com/jandrassy/ArduinoOTA
 architectures=*

src/ArduinoOTA.h

@@ -24,6 +24,8 @@
 #if FLASHEND >= 0xFFFF
 #include "InternalStorageAVR.h"
 #endif
+#elif defined(ESP8266) || defined(ESP32)
+#include "InternalStorageESP.h"
 #else
 #include "InternalStorage.h"
 #endif
@@ -73,7 +75,11 @@ class ArduinoOTAMdnsClass : public ArduinoOTAClass<NetServer, NetClient> {
 
   void begin(IPAddress localIP, const char* name, const char* password, OTAStorage& storage) {
     ArduinoOTAClass<NetServer, NetClient>::begin(localIP, name, password, storage);
+#if defined(ESP8266) && !(defined(ethernet_h_) || defined(ethernet_h) || defined(UIPETHERNET_H))
+    mdnsSocket.beginMulticast(localIP, IPAddress(224, 0, 0, 251), 5353);
+#else
     mdnsSocket.beginMulticast(IPAddress(224, 0, 0, 251), 5353);
+#endif
   }
 
   void poll() {
@@ -86,7 +92,10 @@ class ArduinoOTAMdnsClass : public ArduinoOTAClass<NetServer, NetClient> {
 #if defined(ethernet_h_) || defined(ethernet_h) // Ethernet library
 ArduinoOTAMdnsClass  <EthernetServer, EthernetClient, EthernetUDP>   ArduinoOTA;
 
-#elif defined(WiFiNINA_h) || defined(WIFI_H) // NINA and WiFi101
+#elif defined(UIPETHERNET_H) // no UDP multicast implementation yet
+ArduinoOTAClass  <EthernetServer, EthernetClient>   ArduinoOTA;
+
+#elif defined(WiFiNINA_h) || defined(WIFI_H) || defined(ESP8266) || defined(ESP32) // NINA, WiFi101 and Espressif WiFi
 #include <WiFiUdp.h>
 ArduinoOTAMdnsClass <WiFiServer, WiFiClient, WiFiUDP> ArduinoOTA;
 
@@ -96,12 +105,8 @@ ArduinoOTAClass  <WiFiServer, WiFiClient> ArduinoOTA;
 #elif defined(_WIFISPI_H_INCLUDED) // no UDP multicast implementation
 ArduinoOTAClass  <WiFiSpiServer, WiFiSpiClient> ArduinoOTA;
 
-#elif defined(UIPETHERNET_H) // no UDP multicast implementation
-ArduinoOTAClass  <EthernetServer, EthernetClient>   ArduinoOTA;
-
 #else
 #error "Network library not included or not supported"
 #endif
 
 #endif
-

src/InternalStorage.cpp

@@ -21,7 +21,7 @@
  by Juraj Andrassy
 */
 
-#ifndef __AVR__
+#if !defined(__AVR__) && !defined(ESP8266) && !defined(ESP32)
 
 #include <Arduino.h>
 

src/InternalStorageESP.cpp

@@ -0,0 +1,64 @@
+/*
+  Copyright (c) 2019 Juraj Andrassy.  All right reserved.
+
+  This library is free software; you can redistribute it and/or
+  modify it under the terms of the GNU Lesser General Public
+  License as published by the Free Software Foundation; either
+  version 2.1 of the License, or (at your option) any later version.
+
+  This library 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 Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public
+  License along with this library; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+*/
+
+#if defined(ESP8266) || defined(ESP32)
+
+#include <Arduino.h>
+
+#ifdef ESP32
+#include <Update.h>
+#endif
+
+#include "InternalStorageESP.h"
+
+InternalStorageESPClass::InternalStorageESPClass()
+{
+}
+
+int InternalStorageESPClass::open(int length, uint8_t command)
+{
+  return Update.begin(length, command == 0 ? U_FLASH : U_SPIFFS);
+}
+
+size_t InternalStorageESPClass::write(uint8_t b)
+{
+  return Update.write(&b, 1);
+}
+
+void InternalStorageESPClass::close()
+{
+  Update.end(false);
+}
+
+void InternalStorageESPClass::clear()
+{
+}
+
+void InternalStorageESPClass::apply()
+{
+  ESP.restart();
+}
+
+long InternalStorageESPClass::maxSize()
+{
+  return ESP.getFlashChipSize() / 2; // Update.begin() in open() does the exact check
+}
+
+InternalStorageESPClass InternalStorage;
+
+#endif

src/InternalStorageESP.h

@@ -0,0 +1,44 @@
+/*
+  Copyright (c) 2019 Juraj Andrassy.  All right reserved.
+
+  This library is free software; you can redistribute it and/or
+  modify it under the terms of the GNU Lesser General Public
+  License as published by the Free Software Foundation; either
+  version 2.1 of the License, or (at your option) any later version.
+
+  This library 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 Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public
+  License along with this library; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+*/
+
+#ifndef _INTERNAL_STORAGE_ESP_H_INCLUDED
+#define _INTERNAL_STORAGE_ESP_H_INCLUDED
+
+#include "OTAStorage.h"
+
+class InternalStorageESPClass : public OTAStorage {
+public:
+
+  InternalStorageESPClass();
+
+  virtual int open(int length) {
+    return open(length, 0);
+  }
+  virtual int open(int length, uint8_t command);
+  virtual size_t write(uint8_t);
+  virtual void close();
+  virtual void clear();
+  virtual void apply();
+  virtual long maxSize();
+
+private:
+};
+
+extern InternalStorageESPClass InternalStorage;
+
+#endif

src/OTAStorage.cpp

@@ -28,6 +28,10 @@ OTAStorage::OTAStorage() :
         SKETCH_START_ADDRESS(0),
         PAGE_SIZE(SPM_PAGESIZE),
         MAX_FLASH((uint32_t) FLASHEND + 1)
+#elif defined(ESP8266) || defined(ESP32)
+        SKETCH_START_ADDRESS(0), // not used
+        PAGE_SIZE(0), // not used
+        MAX_FLASH(0) // not used
 #endif
 {
   bootloaderSize = 0;
@@ -46,6 +50,8 @@ void ExternalOTAStorage::apply() {
 #ifdef __AVR__
   wdt_enable(WDTO_15MS);
   while (true);
+#elif defined(ESP8266) || defined(ESP32)
+  ESP.restart();
 #else
   NVIC_SystemReset();
 #endif

src/OTAStorage.h

@@ -17,7 +17,7 @@
 
  WiFi101OTA version Feb 2017
  by Sandeep Mistry (Arduino)
- modified for ArduinoOTA Dec 2018
+ modified for ArduinoOTA Dec 2018, Apr 2019
  by Juraj Andrassy
 */
 
@@ -32,6 +32,10 @@ class OTAStorage {
   OTAStorage();
 
   virtual int open(int length) = 0;
+  virtual int open(int length, uint8_t command) {
+    (void) command;
+    return open(length);
+  }
   virtual size_t write(uint8_t) = 0;
   virtual void close() = 0;
   virtual void clear() = 0;

src/WiFiOTA.cpp

@@ -17,7 +17,7 @@
 
  WiFi101OTA version Feb 2017
  by Sandeep Mistry (Arduino)
- modified for ArduinoOTA Dec 2018
+ modified for ArduinoOTA Dec 2018, Apr 2019
  by Juraj Andrassy
 */
 
@@ -251,6 +251,12 @@ void WiFiOTAClass::pollServer(Client& client)
       }
     } while (header != "");
 
+    bool dataUpload = false;
+#if defined(ESP8266) || defined(ESP32)
+    if (request == "POST /data HTTP/1.1") {
+      dataUpload = true;
+    } else
+#endif
     if (request != "POST /sketch HTTP/1.1") {
       flushRequestBody(client, contentLength);
       sendHttpResponse(client, 404, "Not Found");
@@ -268,7 +274,7 @@ void WiFiOTAClass::pollServer(Client& client)
       return;
     }
 
-    if (_storage == NULL || !_storage->open(contentLength)) {
+    if (_storage == NULL || !_storage->open(contentLength, dataUpload)) {
       flushRequestBody(client, contentLength);
       sendHttpResponse(client, 500, "Internal Server Error");
       return;