ArduinoOTA.h - support any proper Arduino networking library

Author: JAndrassy

README.md

@@ -36,6 +36,9 @@ The library is a modification of the Arduino WiFi101OTA library.
 
 ## Supported networking libraries
 
+The ArduinoOTA library will work any proper Arduino Ethernet or WiFi library. For Ethernet library add `#define OTETHERNET` before including the ArduinoOTA library. If you don't want a network port or the library doesn't support it, add `#define NO_OTA_PORT` before including the ArduinoOTA library. If you only want to use InternalStorage without the network upload from IDE, add `#define NO_OTA_NETWORK` before including the ArduinoOTA library.
+
+Tested libraries are:
 * Ethernet library - Ethernet shields and modules with Wiznet 5100, 5200 and 5500 chips
 * WiFi101 - MKR 1000, Arduino WiFi101 shield and Adafruit WINC1500 WiFi shield or module
 * WiFiNINA - MKR 1010, MKR 4000, Nano 33 IoT and any supported MCU with attached ESP32 as SPI network adapter with WiFiNINA firmware
@@ -44,7 +47,7 @@ The library is a modification of the Arduino WiFi101OTA library.
 * EthernetENC - shields and modules with ENC28j60 chip
 * WiFi library of the Pico Core including its Ethernet network interfaces
 
-EthernetENC library doesn't support UDP multicast for MDNS, so Arduino IDE will not show the network upload port.
+EthernetENC and WiFiEspAT with esp8266 doesn't support UDP multicast for MDNS, so Arduino IDE will not show the network upload port.
 
 ## Installation
 
@@ -68,7 +71,7 @@ For upload the 'OTA programmer' technique can be configured.
 
 ## OTA Upload from IDE without 'network port'
 
-Some of the supported networking libraries don't have the UDP.beginMulticast function and can't start a MDNS service to propagate the network port for Arduino IDE. And sometimes the MDNS port is not detected for the good libraries too. Arduino IDE doesn't yet allow to enter the IP address. 
+Some networking libraries don't have the UDP.beginMulticast function and can't start a MDNS service to propagate the network port for Arduino IDE. And sometimes the MDNS port is not detected for the good libraries too. Arduino IDE doesn't yet allow to enter the IP address. 
 
 The workaround is to configure a fake programmer for Arduino OTA. You can use [my_boards](https://github.com/jandrassy/my_boards) as starting point. For Arduino Mega it is the best option for all ArduinoOTA aspects, for other boards it gives you control about your custom settings. In your copy of my_boards in programmers.txt, configure the IP address and restart the IDE. Note: the esp boards packages can't be used as referenced packages in my_boards style.
 

examples/ATmega_SD/ATmega_SD.ino

@@ -20,6 +20,7 @@
 #include <SPI.h>
 #include <SD.h>
 #include <Ethernet.h>
+#define OTETHERNET
 #include <ArduinoOTA.h>
 
 // Enter a MAC address for your controller below.

examples/Advanced/OTASketchDownload/OTASketchDownload.ino

@@ -16,10 +16,12 @@
  by Juraj Andrassy
  */
 
-#include <ArduinoOTA.h> // only for InternalStorage
 #include <Ethernet.h>
 #include <ArduinoHttpClient.h>
 
+#define NO_OTA_NETWORK
+#include <ArduinoOTA.h> // only for InternalStorage
+
 const short VERSION = 1;
 
 byte mac[] = { 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0xED };

examples/Advanced/OTASketchDownloadWifi/OTASketchDownloadWifi.ino

@@ -20,10 +20,12 @@
   based on Juraj Andrassy sample sketch 'OTASketchDownload'
 */
 
-#include <ArduinoOTA.h> // only for InternalStorage
 #include <WiFiNINA.h>
 #include <ArduinoHttpClient.h>
 
+#define NO_OTA_NETWORK
+#include <ArduinoOTA.h> // only for InternalStorage
+
 // Please enter your WiFi sensitive data in the arduino_secrets.h file
 #include "arduino_secrets.h"
 

examples/Advanced/SD2Flash2BootAVRHex/SD2Flash2BootAVRHex.ino

@@ -10,6 +10,7 @@
  by Juraj Andrassy
  */
 
+#define NO_OTA_NETWORK
 #include <ArduinoOTA.h> // include before SD.h (to not intialize SDStorage)
 #include <SD.h>
 #include "kk_ihex_read.h"

examples/OTEthernet/OTEthernet.ino

@@ -19,6 +19,7 @@
 
 #include <SPI.h>
 #include <Ethernet.h>
+#define OTETHERNET
 #include <ArduinoOTA.h>
 
 //#define Serial SerialUSB

examples/OTEthernet_SD/OTEthernet_SD.ino

@@ -20,6 +20,7 @@
 #include <SPI.h>
 #include <SD.h>
 #include <Ethernet.h>
+#define OTETHERNET
 #include <ArduinoOTA.h>
 #include <SDU.h>
 

src/ArduinoOTA.h

@@ -116,45 +116,32 @@ class ArduinoOTAMdnsClass : public ArduinoOTAClass<NetServer, NetClient> {
 
 };
 
-#if defined(NO_OTA_NETWORK)
-// Disable network libraries
-#elif defined(ethernet_h_) || defined(ethernet_h) // Ethernet library
+#ifndef NO_OTA_NETWORK
+
+#if defined(ethernet_h_) || defined(ethernet_h) || defined(UIPETHERNET_H)
+#define OTETHERNET
+#endif
+#if defined(UIPETHERNET_H) || defined(WIFIESPAT1) // no UDP multicast implementation
+#define NO_OTA_PORT
+#endif
+
+#ifdef OTETHERNET
 #ifdef NO_OTA_PORT
 ArduinoOTAClass  <EthernetServer, EthernetClient>   ArduinoOTA;
 #else
 ArduinoOTAMdnsClass  <EthernetServer, EthernetClient, EthernetUDP>   ArduinoOTA;
 #endif
 
-#elif defined(UIPETHERNET_H) // no UDP multicast implementation yet
-ArduinoOTAClass  <EthernetServer, EthernetClient>   ArduinoOTA;
-
-#elif defined(WiFiNINA_h) || defined(WIFI_H)  || defined(WiFiS3_h) || defined(ESP8266) || defined(ESP32) // NINA, WiFi101 and Espressif WiFi
-#ifdef NO_OTA_PORT
-ArduinoOTAClass  <WiFiServer, WiFiClient> ArduinoOTA;
 #else
-#include <WiFiUdp.h>
-ArduinoOTAMdnsClass <WiFiServer, WiFiClient, WiFiUDP> ArduinoOTA;
-#endif
-
-#elif defined(_WIFI_ESP_AT_H_) && !defined(WIFIESPAT1) && !defined(NO_OTA_PORT) // WiFiEspAT with AT2 has UDP multicast
-ArduinoOTAMdnsClass  <WiFiServer, WiFiClient, WiFiUDP> ArduinoOTA;
-
-#elif defined(WiFi_h) || defined(_WIFI_ESP_AT_H_) // WiFi, WiFiLink and WiFiEspAT lib (no UDP multicast) for WiFiLink the firmware handles mdns
-ArduinoOTAClass  <WiFiServer, WiFiClient> ArduinoOTA;
-
-#elif defined(_WIFISPI_H_INCLUDED) // no UDP multicast implementation
-ArduinoOTAClass  <WiFiSpiServer, WiFiSpiClient> ArduinoOTA;
 
-#elif defined(ARDUINO_ARCH_RP2040) && !defined(ARDUINO_ARCH_MBED)
 #ifdef NO_OTA_PORT
 ArduinoOTAClass  <WiFiServer, WiFiClient> ArduinoOTA;
 #else
 #include <WiFiUdp.h>
 ArduinoOTAMdnsClass <WiFiServer, WiFiClient, WiFiUDP> ArduinoOTA;
 #endif
+#endif
 
-#else
-#warning "Network library not included or not supported"
 #endif
 
 #endif