Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
This repository was archived by the owner on Jan 29, 2023. It is now read-only.

A simple library that implements port mappings to router using UPnP SSDP for Arduino boards, running on nRF52, SAMD21/SAMD51, STM32F/L/H/G/WB/MP1, Teensy, RP2040-based boards, WT32_ETH01, Portenta_H7, etc. besides ESP8266/ESP32, using ESP WiFi, WiFiNINA, Ethernet W5x00, ESP8266/ESP32 AT-command WiFi, Portenta_H7 Murata WiFi or Vision-shield Ethe…

License

NotificationsYou must be signed in to change notification settings

khoih-prog/UPnP_Generic

Repository files navigation

arduino-library-badgeGitHub releaseGitHubcontributions welcomeGitHub issues

Table of Contents

Important Change from v3.5.0

Please have a look atHOWTO FixMultiple Definitions Linker Error

Why do we need thisUPnP_Generic library

Features

Many of us aremanually port-forwarding in Internet Gateway Device (IGD, Router) in order to provide access to local Web Services from the Internet.

This library provides the easier way to automatically port-forward by using theSimple Service Discovery Protocol (SSDP), running on nRF52, SAMD21/SAMD51, STM32F/L/H/G/WB/MP1, Teensy, ESP8266/ESP32, WT32_ETH01, Portenta_H7, etc. using ESP WiFi, WiFiNINA, Ethernet W5x00, LAN8720, ESP8266/ESP32 AT-command WiFi supportingUDP Multicast.

The SSDP provides a mechanism whereby network clients, with little or no static configuration, can discover network services. SSDP accomplishes this by providing for multicast discovery support as well as server based notification and discovery routing.

TheSSDP is used foradvertisement and discovery of network services and presence information. It accomplishes the task without assistance of server-based configuration mechanisms, such as Dynamic Host Configuration Protocol (DHCP) or Domain Name System (DNS), and without special static configuration of a network host. SSDP is the basis of the discovery protocol ofUniversal Plug and Play (UPnP) and is intended for use in residential or small office environments.

ThisUPnP_Generic library is created to automaticallyupdate your IGDs with the requested port-forward information, using one of the many available boards / shields. SeeCurrently Supported Boards.

The time between checks to update the UPnP Port Mappings isconfigurable to match your use case, and is set in the examples at 10 minutes. The LEASE_DURATION is also configurable and default to 10hrs (36000s). The Virtual Server Name can also be specified in the sketch and is shown in the IGD, e.g.NRF52-W5X00 orESP8266-WIFI as in the following picture:

The UPnP_Generic code is very short, can be immersed in your Projects and to be called in the loop() code.

ThisUPnP_Generic library is based on and modified fromOfek Pearl's TinyUPnP Library to add support to many boards and shields besidesESP32 and ESP8266.

Currently Supported Boards

  • ESP8266

  • ESP32

  • AdaFruit Feather nRF52832, nRF52840 Express, BlueFruit Sense, Itsy-Bitsy nRF52840 Express, Metro nRF52840 Express, NINA_B302_ublox, NINA_B112_ublox etc..

  • Arduino SAMD21 (ZERO, MKR, NANO_33_IOT, etc.).

  • Adafruit SAM21 (Itsy-Bitsy M0, Metro M0, Feather M0, Gemma M0, etc.).

  • Adafruit SAM51 (Itsy-Bitsy M4, Metro M4, Grand Central M4, Feather M4 Express, etc.).

  • Seeeduino SAMD21/SAMD51 boards (SEEED_WIO_TERMINAL, SEEED_FEMTO_M0, SEEED_XIAO_M0, Wio_Lite_MG126, WIO_GPS_BOARD, SEEEDUINO_ZERO, SEEEDUINO_LORAWAN, SEEED_GROVE_UI_WIRELESS, etc.)

  • STM32 (Nucleo-144, Nucleo-64, Nucleo-32, Discovery, STM32F1, STM32F3, STM32F4, STM32H7, STM32L0, etc.).

  • STM32F/L/H/G/WB/MP1 (Nucleo-64 L053R8,Nucleo-144, Nucleo-64, Nucleo-32, Discovery, STM32Fx, STM32H7, STM32Lx, STM32Gx, STM32WB, STM32MP1, etc.) having 64K+ Flash program memory.

  • RP2040-based boards, such asNano RP2040 Connect, usingArduino mbed OS for Nano boards.

  • RP2040-based boards, such asRASPBERRY_PI_PICO, ADAFRUIT_FEATHER_RP2040 and GENERIC_RP2040, usingArduino-mbed RP2040 core orEarle Philhower's arduino-pico core.

  • WT32_ETH01 boards using ESP32-based boards and LAN8720 Ethernet

  • Portenta_H7 using eitherMurata WiFi orVision-shield Ethernet

  • SAM DUE

  • Teensy (4.1, 4.0, 3.6, 3.5, 3,2, 3.1, 3.0)

  • AVR Mega1280, 2560, ADK.

Currently supported WiFi shields/modules

  • ESP8266 built-in WiFi
  • ESP32 built-in WiFi
  • WiFiNINA using WiFiNINA or WiFiNINA_Generic library.
  • ESP8266-AT, ESP32-AT WiFi shields using WiFiEspAT orESP8266_AT_WebServer library.
  • Portenta_H7 built-in Murata WiFi

Currently supported Ethernet shields/modules

  • W5x00's usingEthernet_Generic Library.
  • Ethernet2 Library is also supported after applying the fix to add Multicast feature. SeeLibraries' Patches
  • ENC28J60 using EthernetENC and UIPEthernet library are not supported as UDP Multicast is not available by design.
  • LAN8742A using STM32Ethernet / STM32 LwIP libraries is not supported as UDP Multicast is not enabled by design, unless you modify the code to add support.
  • LAN8720A in WT32-ETH01 usingWebServer_WT32_ETH01.
  • Teensy 4.1 built-in Ethernet usingNativeEthernet library
  • Teensy 4.1 built-in Ethernet usingQNEthernet library
  • Portenta_H7 using Ethernet fromPortenta Vision shields

Prerequisites

  1. Arduino IDE 1.8.16+ for Arduino

  2. ESP32 Core 2.0.2+ for ESP32-based boards.Latest release

  3. ESP8266 Core 3.0.2+ for ESP8266-based boards.Latest release. To use ESP8266 core 2.7.1+ for LittleFS.

  4. Arduino AVR core 1.8.5+ for Arduino (Use Arduino Board Manager) for AVR boards.GitHub release

  5. Arduino SAM DUE core v1.6.12+ for SAM DUE ARM Cortex-M3 boards.

  6. Arduino SAMD core 1.8.13+ for SAMD ARM Cortex-M0+ boards.GitHub release

  7. Adafruit SAMD core 1.7.10+ for SAMD ARM Cortex-M0+ and M4 boards (Nano 33 IoT, etc.).GitHub release

  8. Seeeduino SAMD core 1.8.2+ for SAMD21/SAMD51 boards (XIAO M0, Wio Terminal, etc.).Latest release

  9. Adafruit nRF52 v1.3.0+ for nRF52 boards such as Adafruit NRF52840_FEATHER, NRF52832_FEATHER, NRF52840_FEATHER_SENSE, NRF52840_ITSYBITSY, NRF52840_CIRCUITPLAY, NRF52840_CLUE, NRF52840_METRO, NRF52840_PCA10056, PARTICLE_XENON,NINA_B302_ublox, etc.GitHub release

  10. Arduino Core for STM32 v2.2.0+ for STM32F/L/H/G/WB/MP1 boards.GitHub release

  11. ArduinoCore-mbed mbed_rp2040, mbed_nano, mbed_portenta core 3.0.1+ for Arduino (Use Arduino Board Manager)Portenta_H7, RP2040-based boards, such as Nano_RP2040_Connect, RASPBERRY_PI_PICO.GitHub release

  12. Earle Philhower's arduino-pico core v1.13.1+ for RP2040-based boards such asRASPBERRY_PI_PICO, ADAFRUIT_FEATHER_RP2040 and GENERIC_RP2040, etc.GitHub release

  13. Teensy core v1.56+ for Teensy (4.1, 4.0, 3.6, 3.5, 3,2, 3.1, 3.0) boards.

  14. Depending on which Ethernet card you're using:

  1. WiFiNINA_Generic library v1.8.14-3+ to use WiFiNINA modules/shields. To install. checkarduino-library-badge if using WiFiNINA for boards such as Nano 33 IoT, nRF52, Teensy, etc.
  2. WiFiWebServer library v1.7.0+ to use WiFi/WiFiNINA modules/shields. To install, checkarduino-library-badge
  3. EthernetWebServer library v2.1.2+ to use Ethernet modules/shields on boards other than STM32F/L/H/G/WB/MP1. To install. checkarduino-library-badge.
  4. EthernetWebServer_STM32 library v1.4.0+ to use Ethernet modules/shields on STM32F/L/H/G/WB/MP1 boards. To install, checkarduino-library-badge.
  5. ESP8266_AT_WebServer library v1.5.3+ to use ESP8266-AT/ESP32-AT WiFi modules/shields. To install, checkarduino-library-badge
  6. DDNS_Generic library v1.6.1+ to use examples. To install, checkarduino-library-badge
  7. WebServer_WT32_ETH01 library v1.4.1+ to use WT32_ETH01 (ESP32 + LAN8720). To install, checkarduino-library-badge.
  8. QNEthernet Library version v0.14.0+ for Teensy 4.1 built-in Ethernet. UDP multicast has been supported.New

Installation

Use Arduino Library Manager

The best and easiest way is to useArduino Library Manager. Search forUPnP_Generic, then select / install the latest version.You can also use this linkarduino-library-badge for more detailed instructions.

Manual Install

Another way to install is to:

  1. Navigate toUPnP_Generic page.
  2. Download the latest releaseUPnP_Generic-master.zip.
  3. Extract the zip file toUPnP_Generic-master directory
  4. Copy wholeUPnP_Generic-master/src folder to Arduino libraries' directory such as~/Arduino/libraries/.

VS Code & PlatformIO

  1. InstallVS Code
  2. InstallPlatformIO
  3. InstallUPnP_Generic library by usingLibrary Manager. Search forUPnP_Generic inPlatform.io Author's Libraries
  4. Use includedplatformio.ini file from examples to ensure that all dependent libraries will installed automatically. Please visit documentation for the other options and examples atProject Configuration File

Packages' Patches

1. For Adafruit nRF52840 and nRF52832 boards

To be able to compile, run and automatically detect and display BOARD_NAME on nRF52840/nRF52832 boards, you have to copy the wholenRF52 Packages_Patches directory into Adafruit nRF52 directory (~/.arduino15/packages/adafruit/hardware/nrf52/1.3.0).

Supposing the Adafruit nRF52 version is 1.3.0. These files must be copied into the directory:

  • ~/.arduino15/packages/adafruit/hardware/nrf52/1.3.0/platform.txt
  • ~/.arduino15/packages/adafruit/hardware/nrf52/1.3.0/boards.txt
  • ~/.arduino15/packages/adafruit/hardware/nrf52/1.3.0/cores/nRF5/Udp.h
  • ~/.arduino15/packages/adafruit/hardware/nrf52/1.3.0/cores/nRF5/Print.h
  • ~/.arduino15/packages/adafruit/hardware/nrf52/1.3.0/cores/nRF5/Print.cpp
  • ~/.arduino15/packages/adafruit/hardware/nrf52/1.3.0/variants/NINA_B302_ublox/variant.h
  • ~/.arduino15/packages/adafruit/hardware/nrf52/1.3.0/variants/NINA_B302_ublox/variant.cpp
  • ~/.arduino15/packages/adafruit/hardware/nrf52/1.3.0/variants/NINA_B112_ublox/variant.h
  • ~/.arduino15/packages/adafruit/hardware/nrf52/1.3.0/variants/NINA_B112_ublox/variant.cpp
  • ~/.arduino15/packages/adafruit/hardware/nrf52/1.3.0/cores/nRF5/Udp.h

Whenever a new version is installed, remember to copy these files into the new version directory. For example, new version is x.yy.zThese files must be copied into the directory:

  • ~/.arduino15/packages/adafruit/hardware/nrf52/x.yy.z/platform.txt
  • ~/.arduino15/packages/adafruit/hardware/nrf52/x.yy.z/boards.txt
  • ~/.arduino15/packages/adafruit/hardware/nrf52/x.yy.z/cores/nRF5/Udp.h
  • ~/.arduino15/packages/adafruit/hardware/nrf52/x.yy.z/cores/nRF5/Print.h
  • ~/.arduino15/packages/adafruit/hardware/nrf52/x.yy.z/cores/nRF5/Print.cpp
  • ~/.arduino15/packages/adafruit/hardware/nrf52/x.yy.z/variants/NINA_B302_ublox/variant.h
  • ~/.arduino15/packages/adafruit/hardware/nrf52/x.yy.z/variants/NINA_B302_ublox/variant.cpp
  • ~/.arduino15/packages/adafruit/hardware/nrf52/x.yy.z/variants/NINA_B112_ublox/variant.h
  • ~/.arduino15/packages/adafruit/hardware/nrf52/x.yy.z/variants/NINA_B112_ublox/variant.cpp
  • ~/.arduino15/packages/adafruit/hardware/nrf52/x.yy.z/cores/nRF5/Udp.h

2. For Teensy boards

To be able to compile and run on Teensy boards, you have to copy the files inPackages_Patches for Teensy directory into Teensy hardware directory (./arduino-1.8.19/hardware/teensy/avr/boards.txt).

Supposing the Arduino version is 1.8.19. These files must be copied into the directory:

  • ./arduino-1.8.19/hardware/teensy/avr/boards.txt
  • ./arduino-1.8.19/hardware/teensy/avr/cores/teensy/Stream.h
  • ./arduino-1.8.19/hardware/teensy/avr/cores/teensy3/Stream.h
  • ./arduino-1.8.19/hardware/teensy/avr/cores/teensy4/Stream.h

Whenever a new version is installed, remember to copy this file into the new version directory. For example, new version is x.yy.zzThese files must be copied into the directory:

  • ./arduino-x.yy.zz/hardware/teensy/avr/boards.txt
  • ./arduino-x.yy.zz/hardware/teensy/avr/cores/teensy/Stream.h
  • ./arduino-x.yy.zz/hardware/teensy/avr/cores/teensy3/Stream.h
  • ./arduino-x.yy.zz/hardware/teensy/avr/cores/teensy4/Stream.h

3. For Arduino SAM DUE boards

To be able to compile and run on SAM DUE boards, you have to copy the wholeSAM DUE directory into Arduino sam directory (~/.arduino15/packages/arduino/hardware/sam/1.6.12).

Supposing the Arduino SAM core version is 1.6.12. This file must be copied into the directory:

  • ~/.arduino15/packages/arduino/hardware/sam/1.6.12/platform.txt

Whenever a new version is installed, remember to copy this file into the new version directory. For example, new version is x.yy.zzThis file must be copied into the directory:

  • ~/.arduino15/packages/arduino/hardware/sam/x.yy.zz/platform.txt

4. For Arduino SAMD boards

To be able to compile, run and automatically detect and display BOARD_NAME on Arduino SAMD (Nano-33-IoT, etc) boards, you have to copy the wholeArduino SAMD Packages_Patches directory into Arduino SAMD directory (~/.arduino15/packages/arduino/hardware/samd/1.8.13).

For core version v1.8.10+

Supposing the Arduino SAMD version is 1.8.13. Now only one file must be copied into the directory:

  • ~/.arduino15/packages/arduino/hardware/samd/1.8.13/platform.txt

Whenever a new version is installed, remember to copy this files into the new version directory. For example, new version is x.yy.zz

This file must be copied into the directory:

  • ~/.arduino15/packages/arduino/hardware/samd/x.yy.zz/platform.txt

For core version v1.8.9-

Supposing the Arduino SAMD version is 1.8.9. These files must be copied into the directory:

  • ~/.arduino15/packages/arduino/hardware/samd/1.8.9/platform.txt
  • ~/.arduino15/packages/arduino/hardware/samd/1.8.9/cores/arduino/Arduino.h

Whenever a new version is installed, remember to copy these files into the new version directory. For example, new version is x.yy.z

These files must be copied into the directory:

  • ~/.arduino15/packages/arduino/hardware/samd/x.yy.z/platform.txt
  • ~/.arduino15/packages/arduino/hardware/samd/x.yy.z/cores/arduino/Arduino.h

This is mandatory to fix thenotorious Arduino SAMD compiler error. SeeImprove Arduino compatibility with the STL (min and max macro)

 ...\arm-none-eabi\include\c++\7.2.1\bits\stl_algobase.h:243:56: error: macro "min" passed 3 arguments, but takes just 2     min(const _Tp& __a, const _Tp& __b, _Compare __comp)

Whenever the above-mentioned compiler error issue is fixed with the new Arduino SAMD release, you don't need to copy theArduino.h file anymore.

5. For Adafruit SAMD boards

To be able to compile, run and automatically detect and display BOARD_NAME on Adafruit SAMD (Itsy-Bitsy M4, etc) boards, you have to copy the wholeAdafruit SAMD Packages_Patches directory into Adafruit samd directory (~/.arduino15/packages/adafruit/hardware/samd/1.7.9).

Supposing the Adafruit SAMD core version is 1.7.9. This file must be copied into the directory:

  • ~/.arduino15/packages/adafruit/hardware/samd/1.7.9/platform.txt
  • ~/.arduino15/packages/adafruit/hardware/samd/1.7.9/cores/arduino/Print.h
  • ~/.arduino15/packages/adafruit/hardware/samd/1.7.9/cores/arduino/Print.cpp

Whenever a new version is installed, remember to copy this file into the new version directory. For example, new version is x.yy.zzThis file must be copied into the directory:

  • ~/.arduino15/packages/adafruit/hardware/samd/x.yy.zz/platform.txt
  • ~/.arduino15/packages/adafruit/hardware/samd/x.yy.zz/cores/arduino/Print.h
  • ~/.arduino15/packages/adafruit/hardware/samd/x.yy.zz/cores/arduino/Print.cpp

6. For Seeeduino SAMD boards

To be able to compile, run and automatically detect and display BOARD_NAME on Seeeduino SAMD (XIAO M0, Wio Terminal, etc) boards, you have to copy the wholeSeeeduino SAMD Packages_Patches directory into Seeeduino samd directory (~/.arduino15/packages/Seeeduino/hardware/samd/1.8.2).

Supposing the Seeeduino SAMD core version is 1.8.2. This file must be copied into the directory:

  • ~/.arduino15/packages/Seeeduino/hardware/samd/1.8.2/platform.txt
  • ~/.arduino15/packages/Seeeduino/hardware/samd/1.8.2/cores/arduino/Arduino.h
  • ~/.arduino15/packages/Seeeduino/hardware/samd/1.8.2/cores/arduino/Print.h
  • ~/.arduino15/packages/Seeeduino/hardware/samd/1.8.2/cores/arduino/Print.cpp

Whenever a new version is installed, remember to copy this file into the new version directory. For example, new version is x.yy.zzThis file must be copied into the directory:

  • ~/.arduino15/packages/Seeeduino/hardware/samd/x.yy.zz/platform.txt
  • ~/.arduino15/packages/Seeeduino/hardware/samd/x.yy.zz/cores/arduino/Arduino.h
  • ~/.arduino15/packages/Seeeduino/hardware/samd/x.yy.zz/cores/arduino/Print.h
  • ~/.arduino15/packages/Seeeduino/hardware/samd/x.yy.zz/cores/arduino/Print.cpp

7. For STM32 boards

7.1 For STM32 boards to use LAN8720

To use LAN8720 on some STM32 boards

  • Nucleo-144 (F429ZI, NUCLEO_F746NG, NUCLEO_F746ZG, NUCLEO_F756ZG)
  • Discovery (DISCO_F746NG)
  • STM32F4 boards (BLACK_F407VE, BLACK_F407VG, BLACK_F407ZE, BLACK_F407ZG, BLACK_F407VE_Mini, DIYMORE_F407VGT, FK407M1)

you have to copy the filesstm32f4xx_hal_conf_default.h andstm32f7xx_hal_conf_default.h into STM32 stm32 directory (~/.arduino15/packages/STM32/hardware/stm32/2.2.0/system) to overwrite the old files.

Supposing the STM32 stm32 core version is 2.2.0. These files must be copied into the directory:

  • ~/.arduino15/packages/STM32/hardware/stm32/2.2.0/system/STM32F4xx/stm32f4xx_hal_conf_default.h for STM32F4.
  • ~/.arduino15/packages/STM32/hardware/stm32/2.2.0/system/STM32F7xx/stm32f7xx_hal_conf_default.h for Nucleo-144 STM32F7.

Whenever a new version is installed, remember to copy this file into the new version directory. For example, new version is x.yy.zz,these files must be copied into the corresponding directory:

  • ~/.arduino15/packages/STM32/hardware/stm32/x.yy.zz/system/STM32F4xx/stm32f4xx_hal_conf_default.h
  • `~/.arduino15/packages/STM32/hardware/stm32/x.yy.zz/system/STM32F7xx/stm32f7xx_hal_conf_default.h

7.2 For STM32 boards to use Serial1

To use Serial1 on some STM32 boards without Serial1 definition (Nucleo-144 NUCLEO_F767ZI, Nucleo-64 NUCLEO_L053R8, etc.) boards, you have to copy the filesSTM32 variant.h into STM32 stm32 directory (~/.arduino15/packages/STM32/hardware/stm32/2.2.0). You have to modify the files corresponding to your boards, this is just an illustration how to do.

Supposing the STM32 stm32 core version is 2.2.0. These files must be copied into the directory:

  • ~/.arduino15/packages/STM32/hardware/stm32/2.2.0/variants/STM32F7xx/F765Z(G-I)T_F767Z(G-I)T_F777ZIT/NUCLEO_F767ZI/variant.h for Nucleo-144 NUCLEO_F767ZI.
  • ~/.arduino15/packages/STM32/hardware/stm32/2.2.0/variants/STM32L0xx/L052R(6-8)T_L053R(6-8)T_L063R8T/NUCLEO_L053R8/variant.h for Nucleo-64 NUCLEO_L053R8.

Whenever a new version is installed, remember to copy this file into the new version directory. For example, new version is x.yy.zz,these files must be copied into the corresponding directory:

  • ~/.arduino15/packages/STM32/hardware/stm32/x.yy.zz/variants/STM32F7xx/F765Z(G-I)T_F767Z(G-I)T_F777ZIT/NUCLEO_F767ZI/variant.h
  • ~/.arduino15/packages/STM32/hardware/stm32/x.yy.zz/variants/STM32L0xx/L052R(6-8)T_L053R(6-8)T_L063R8T/NUCLEO_L053R8/variant.h

8. For RP2040-based boards usingEarle Philhower arduino-pico core

8.1 To use BOARD_NAME

To be able to automatically detect and display BOARD_NAME on RP2040-based boards (RASPBERRY_PI_PICO, ADAFRUIT_FEATHER_RP2040, GENERIC_RP2040, etc) boards, you have to copy the fileRP2040 platform.txt into rp2040 directory (~/.arduino15/packages/rp2040/hardware/rp2040/1.4.0).

Supposing the rp2040 core version is 1.4.0. This file must be copied into the directory:

  • ~/.arduino15/packages/rp2040/hardware/rp2040/1.4.0/platform.txt

Whenever a new version is installed, remember to copy this file into the new version directory. For example, new version is x.yy.zzThis file must be copied into the directory:

  • ~/.arduino15/packages/rp2040/hardware/rp2040/x.yy.zz/platform.txt

With core after v1.5.0, this step is not necessary anymore thanks to the PRAdd -DBOARD_NAME="{build.board}" #136.

8.2 To avoid compile error relating to microsecondsToClockCycles

Some libraries, such asAdafruit DHT-sensor-library, require the definition of microsecondsToClockCycles().To be able to compile and run on RP2040-based boards, you have to copy the files inRP2040 Arduino.h into rp2040 directory (~/.arduino15/packages/rp2040/hardware/rp2040/1.4.0).

Supposing the rp2040 core version is 1.4.0. This file must be copied to replace:

  • ~/.arduino15/packages/rp2040/hardware/rp2040/1.4.0/cores/rp2040/Arduino.h

Whenever a new version is installed, remember to copy this file into the new version directory. For example, new version is x.yy.zzThis file must be copied to replace:

  • ~/.arduino15/packages/rp2040/hardware/rp2040/x.yy.zz/cores/rp2040/Arduino.h

With core after v1.5.0, this step is not necessary anymore thanks to the PRAdd defs for compatibility #142.

9. For Portenta_H7 boards using Arduino IDE in Linux

To be able to upload firmware to Portenta_H7 using Arduino IDE in Linux (Ubuntu, etc.), you have to copy the fileportenta_post_install.sh into mbed_portenta directory (~/.arduino15/packages/arduino/hardware/mbed_portenta/3.0.0/portenta_post_install.sh).

Then run the following command usingsudo

$ cd ~/.arduino15/packages/arduino/hardware/mbed_portenta/3.0.0$ chmod 755 portenta_post_install.sh$ sudo ./portenta_post_install.sh

This will create the file/etc/udev/rules.d/49-portenta_h7.rules as follows:

# Portenta H7 bootloader mode UDEV rulesSUBSYSTEMS=="usb", ATTRS{idVendor}=="2341", ATTRS{idProduct}=="035b", GROUP="plugdev", MODE="0666"

Supposing the ArduinoCore-mbed core version is 3.0.0. Now only one file must be copied into the directory:

  • ~/.arduino15/packages/arduino/hardware/mbed_portenta/3.0.0/portenta_post_install.sh

Whenever a new version is installed, remember to copy this files into the new version directory. For example, new version is x.yy.zz

This file must be copied into the directory:

  • ~/.arduino15/packages/arduino/hardware/mbed_portenta/x.yy.zz/portenta_post_install.sh

10. For RTL8720DN boards using AmebaD core

To avoid compile error relating to PROGMEM, you have to copy the fileRealtek AmebaD core pgmspace.h into Realtek AmebaD directory (~/.arduino15/packages/realtek/hardware/AmebaD/3.1.2/cores/arduino/avr/pgmspace.h).

Supposing the Realtek AmebaD core version is 3.1.2. This file must be copied into the directory:

  • ~/.arduino15/packages/realtek/hardware/AmebaD/3.1.2/cores/arduino/avr/pgmspace.h

Whenever a new version is installed, remember to copy this file into the new version directory. For example, new version is x.yy.zzThis file must be copied into the directory:

  • ~/.arduino15/packages/realtek/hardware/AmebaD/x.yy.zz/cores/arduino/avr/pgmspace.h

11. For SAMD21 and SAMD51 boards using ArduinoCore-fab-sam core

To avoid compile error relating to SAMD21/SAMD51, you have to copy the fileArduinoCore-fab-sam core pgmspace.h intoArduinoCore-fab-sam samd directory (~/.arduino15/packages/Fab_SAM_Arduino/hardware/samd/1.6.18-alpha2/boards.txt).

Supposing theArduinoCore-fab-sam samd core version is 1.6.18-alpha2. This file must be copied into the directory:

  • ~/.arduino15/packages/Fab_SAM_Arduino/hardware/samd/1.6.18-alpha2/boards.txt

Whenever a new version is installed, remember to copy this file into the new version directory. For example, new version is x.yy.zzThis file must be copied into the directory:

  • ~/.arduino15/packages/Fab_SAM_Arduino/hardware/samd/x.yy.zz/boards.txt

12. For Seeeduino RP2040 boards

To be able to compile, run and automatically detect and display BOARD_NAME on Seeeduino RP2040 (XIAO RP2040, Wio RP2040 Mini) boards, you have to copy the wholeSeeeduino RP2040 Packages_Patches directory into Seeeduino samd directory (~/.arduino15/packages/Seeeduino/hardware/rp2040/2.7.2).

Supposing the Seeeduino SAMD core version is 2.7.2. This file must be copied into the directory:

  • ~/.arduino15/packages/Seeeduino/hardware/rp2040/2.7.2/boards.txt
  • ~/.arduino15/packages/Seeeduino/hardware/rp2040/2.7.2/variants/Seeed_XIAO_RP2040/pins_arduino.h

Whenever a new version is installed, remember to copy this file into the new version directory. For example, new version is x.yy.zzThis file must be copied into the directory:

  • ~/.arduino15/packages/Seeeduino/hardware/samd/x.yy.zz/boards.txt
  • ~/.arduino15/packages/Seeeduino/hardware/samd/x.yy.zz/variants/Seeed_XIAO_RP2040/pins_arduino.h

Libraries' Patches

1. For application requiring 2K+ HTML page

If your application requires 2K+ HTML page, the currentEthernet library must be modified if you are using W5200/W5500 Ethernet shields. W5100 is not supported for 2K+ buffer. If you use boards requiring different CS/SS pin for W5x00 Ethernet shield, for example ESP32, ESP8266, nRF52, etc., you also have to modify the following libraries to be able to specify the CS/SS pin correctly.

2. For Ethernet library

To fixEthernet library, just copy these following files into theEthernet library directory to overwrite the old files:

3. For EthernetLarge library

To fixEthernetLarge library, just copy these following files into theEthernetLarge library directory to overwrite the old files:

4. For Ethernet2 library

To fixEthernet2 library, just copy these following files into theEthernet2 library directory to overwrite the old files:

To add UDP Multicast support, necessary for theUPnP_Generic library:

5. For Ethernet3 library

  1. To fixEthernet3 library, just copy these following files into theEthernet3 library directory to overwrite the old files:

6. For UIPEthernet library

To be able to compile and run on nRF52 boards with ENC28J60 using UIPEthernet library, you have to copy these following files into the UIPEthernetutility directory to overwrite the old files:

7. For fixing ESP32 compile error

To fixESP32 compile error, just copy the following file into theESP32 cores/esp32 directory (e.g. ./arduino-1.8.12/hardware/espressif/cores/esp32) to overwrite the old file:

8. For STM32 core F3 and F4 using UIPEthernet library

Check if you need to install the UIPEthernet patchnew STM32 core F3/F4 compatibility to avoid errors#include HardwareSPI.h on some STM32 boards (Nucleo-32 F303K8, etc.)

HOWTO FixMultiple Definitions Linker Error

The current library implementation, usingxyz-Impl.h instead of standardxyz.cpp, possibly creates certainMultiple Definitions Linker error in certain use cases.

You can use

#include <UPnP_Generic.hpp>               //https://github.com/khoih-prog/UPnP_Generic

in many files. But be sure to use the following#include <NTPClient_Generic.h>in just 1.h,.cpp or.ino file, which mustnot be included in any other file, to avoidMultiple Definitions Linker Error

// To be included only in main(), .ino with setup() to avoid `Multiple Definitions` Linker Error#include <UPnP_Generic.h>                //https://github.com/khoih-prog/UPnP_Generic

Check examplesmultiFileProject_Ethernet andmultiFileProject_WiFiNINA for a demo how to avoidmultiple-definitions linker error for multiple-file project

HOWTO Use analogRead() with ESP32 running WiFi and/or BlueTooth (BT/BLE)

Please have a look atESP_WiFiManager Issue 39: Not able to read analog port when using the autoconnect example to have more detailed description and solution of the issue.

1. ESP32 has 2 ADCs, named ADC1 and ADC2

2. ESP32 ADCs functions

  • ADC1 controls ADC function for pinsGPIO32-GPIO39
  • ADC2 controls ADC function for pinsGPIO0, 2, 4, 12-15, 25-27

3.. ESP32 WiFi uses ADC2 for WiFi functions

Look in fileadc_common.c

In ADC2, there're two locks used for different cases:

  1. lock shared with app and Wi-Fi:ESP32:When Wi-Fi using the ADC2, we assume it will never stop, so app checks the lock and returns immediately if failed.ESP32S2:The controller's control over the ADC is determined by the arbiter. There is no need to control by lock.

  2. lock shared between tasks:when several tasks sharing the ADC2, we want to guaranteeall the requests will be handled.Since conversions are short (about 31us), app returns the lock very soon,we use a spinlock to stand there waiting to do conversions one by one.

adc2_spinlock should be acquired first, then adc2_wifi_lock or rtc_spinlock.

  • In order to use ADC2 for other functions, we have toacquire complicated firmware locks and very difficult to do
  • So, it's not advisable to use ADC2 with WiFi/BlueTooth (BT/BLE).
  • Use ADC1, and pins GPIO32-GPIO39
  • If somehow it's a must to use those pins serviced by ADC2 (GPIO0, 2, 4, 12, 13, 14, 15, 25, 26 and 27), use thefix mentioned at the end ofESP_WiFiManager Issue 39: Not able to read analog port when using the autoconnect example to work with ESP32 WiFi/BlueTooth (BT/BLE).

Configuration Notes

1. How to use built-in WiFi in ESP8266/ESP32

It's taken care automatically.

2. How to select which built-in Ethernet or shield to use

In examples'defines.h

  1. Define UPNP_USING_ETHERNET == true and UPNP_USING_WIFI == false
// Select UPNP_USING_WIFI for boards using built-in WiFi, such as Nano-33-IoT#defineUPNP_USING_WIFIfalse#defineUPNP_USING_ETHERNETtrue
  1. To use W5x00 Ethernet, for example using Ethernet_Generic library
// Only one if the following to be true#defineUSE_UIP_ETHERNETfalse#defineUSE_ETHERNET_PORTENTA_H7false#defineUSE_NATIVE_ETHERNETfalse#defineUSE_QN_ETHERNETfalse#defineUSE_ETHERNET_GENERICtrue#defineUSE_ETHERNET_ESP8266false #defineUSE_ETHERNET_ENCfalse#defineUSE_CUSTOM_ETHERNETfalse

3. How to select which built-in WiFi or shield to use

In examples'defines.h

  1. Define UPNP_USING_WIFI == true and UPNP_USING_ETHERNET == false
// Select UPNP_USING_WIFI for boards using built-in WiFi, such as Nano-33-IoT#defineUPNP_USING_WIFItrue#defineUPNP_USING_ETHERNETfalse
  1. To use WiFiNINA, with WiFiNINA_Generic library => Define USE_WIFI_NINA == true
#defineUPNP_USING_ETHERNETfalse#defineUPNP_USING_WIFItrue// Select one to be true: USE_WIFI_NINA, UPNP_USING_WIFI_AT or USE_WIFI_CUSTOM#defineUSE_WIFI_NINAtrue// If not USE_WIFI_NINA, you can USE_WIFI_CUSTOM, then include the custom WiFi library here#defineUSE_WIFI_CUSTOMfalse...#include<WiFiWebServer.h>

Important:

  • TheEthernet_Shield_W5200, EtherCard, EtherSia libraries are not supported. Don't use unless you know how to modify those libraries.
  • Requests to support for any future custom Ethernet library will be ignored.Use at your own risk.

4. How to select another CS/SS pin to use

The default CS/SS pin is GPIO4(D2) for ESP8266, GPIO22 for ESP32, 10 for all other boards.

If the default pin is not correct, the easiest way is to change is to use

// To override the default CS/SS pin. Don't use unless you know exactly which pin to use#defineUSE_THIS_SS_PIN10

5. How to use W5x00 with ESP8266

To avoid using the default but not-working Ethernet library of ESP8266, rename the Ethernet.h/cpp to Ethernet_ESP8266.h/cpp to avoid library conflict if you're using the Arduino Ethernet library. The Ethernet2, Ethernet3, EthernetLarge library can be used without conflict.

These pins are tested OK with ESP8266 and W5x00

// For ESP8266// Pin                D0(GPIO16)    D1(GPIO5)    D2(GPIO4)    D3(GPIO0)    D4(GPIO2)    D8// Ethernet           0                 X            X            X            X        0// Ethernet2          X                 X            X            X            X        0// Ethernet3          X                 X            X            X            X        0// EthernetLarge      X                 X            X            X            X        0// Ethernet_ESP8266   0                 0            0            0            0        0// D2 is safe to used for Ethernet, Ethernet2, Ethernet3, EthernetLarge libs// Must use library patch for Ethernet, EthernetLarge libraries//Ethernet.setCsPin (USE_THIS_SS_PIN);  Ethernet.init (USE_THIS_SS_PIN);

6. How to increase W5x00 TX/RX buffer

  • ForEthernet3 library only, use as follows
// Use  MAX_SOCK_NUM = 4 for 4K, 2 for 8K, 1 for 16K RX/TX buffer  #ifndef ETHERNET3_MAX_SOCK_NUM    #defineETHERNET3_MAX_SOCK_NUM4  #endif    Ethernet.setCsPin (USE_THIS_SS_PIN);  Ethernet.init (ETHERNET3_MAX_SOCK_NUM);

7. How to use SPI2 for ESP32 using W5x00 and Ethernet_Generic Library

  • ForEthernet_Generic library only, to useSPI2 for ESP32
#define USING_SPI2                          true

Pin to use forSPI2

MOSI:  13MISO:  12SCK:   14SS:    5

8. How to use SPI1 for RP2040 using W5x00 and Ethernet_Generic Library

#define USING_SPI2                          true

Pin to use forSPI1

MOSI:  15MISO:  12SCK:   14SS:    13

HOWTO Usage

1. Include

#include "UPnP.h"#include <DDNS_Generic.h>  // optional

2. Declare

UPnP* uPnP;...uPnP = new UPnP(30000);  // -1 means blocking, preferably, use a timeout value (ms)

3. Setup

// you may repeat 'addPortMappingConfig' more than onceuPnP->addPortMappingConfig(localIP, LISTEN_PORT, RULE_PROTOCOL_TCP, LEASE_DURATION, FRIENDLY_NAME);// finally, commit the port mappings to the IGDint result = uPnP->commitPortMappings();portMappingAdded = ( (result == PORT_MAP_SUCCESS) || (result == ALREADY_MAPPED) );

4. Loop

// update UPnP port mapping every ms internal// you can provide an optional method for reconnecting to the WiFi (otherwise leave as NULL)uPnP->updatePortMappings(600000);  // 10 minutes

5. API

This is specific for thenRF52_PWM_LEDServer example to set the percentage to control the brightness of an LED:

http://<IP or DDNS>:<LISTEN_PORT>/?percentage=<0..100>

such as

http://192.168.2.132:5990/?percentage=20

or

http://account.duckdns.org:5990/?percentage=30

6. Print

// print all the port mappings that were configured using 'addPortMappingConfig' in the setup stepuPnP->printPortMappingConfig();// print all the current port mappings from the IGDuPnP->printAllPortMappings();

Examples:

A. For ESP8266 and ESP32 boards

  1. SimpleServerESP32
  2. SimpleServer_ESP8266
  3. PWM_LEDServer_ESP32
  4. PWM_LEDServer_ESP8266

B. For Ethernet shields

1. nRF52

  1. nRF52_SimpleServer
  2. nRF52_PWM_LEDServer

2. RP2040

  1. RP2040_SimpleServer
  2. RP2040_PWM_LEDServer

3. SAMD

  1. SAMD_SimpleServer
  2. SAMD_PWM_LEDServer

4. STM32

  1. STM32_SimpleServer
  2. STM32_PWM_LEDServer

5. PORTENTA_H7

  1. Portenta_H7_SimpleServerNew

6. TEENSY_4.1

  1. T41_QNEthernet_SimpleServerNew

7. General

  1. multiFileProject_EthernetNew

C. For WiFiNINA shields

1. nRF52

  1. nRF52_SimpleServer
  2. nRF52_PWM_LEDServer

2. RP2040

  1. RP2040_SimpleServer
  2. RP2040_PWM_LEDServer

3. SAMD

  1. SAMD_SimpleServer
  2. SAMD_PWM_LEDServer

4. STM32

  1. STM32_SimpleServer
  2. STM32_PWM_LEDServer

5. General

  1. multiFileProject_WiFiNINANew

D. For ESP8266-AT/ESP32-AT shields

1. nRF52

  1. nRF52_SimpleServer
  2. nRF52_PWM_LEDServer

2. SAMD

  1. SAMD_SimpleServer
  2. SAMD_PWM_LEDServer

3. STM32

  1. STM32_SimpleServer
  2. STM32_PWM_LEDServer

E. For WT32_ETH01 boards

  1. SimpleServer_WT32_ETH01
  2. PWM_LEDServer_WT32_ETH01

F. For WiFi shields

1. PORTENTA_H7

  1. Portenta_H7_SimpleServer
  2. Portenta_H7_PWM_LEDServer

/*
Note: This example uses the DDNS_Generic library (https://github.com/khoih-prog/DDNS_Generic)
You can access this WebServer by either localIP:LISTEN_PORT such as 192.169.2.100:5952
or DDNS_Host:LISTEN_PORT, such as account.duckdns.org:5952
*/
#include"defines.h"
#defineUPNP_USING_ETHERNETtrue
#include<UPnP_Generic.h>
#defineLISTEN_PORT5952
#defineLEASE_DURATION36000// seconds
#defineFRIENDLY_NAME"NRF52-W5X00"// this name will appear in your router port forwarding section
UPnP* uPnP;
EthernetWebServerserver(LISTEN_PORT);
#if defined(LED_BLUE)
#defineLED_PIN LED_BLUE// BLUE_LED on nRF52840 Feather Express, Itsy-Bitsy
#else
#defineLED_PIN3// RED LED
#endif
constint led = LED_PIN;
voidonUpdateCallback(constchar* oldIP,constchar* newIP)
{
Serial.print(F("DDNSGeneric - IP Change Detected: oldIP ="));
Serial.print(oldIP);
Serial.print(F(", newIP ="));
Serial.println(newIP);
}
voidhandleRoot()
{
#defineBUFFER_SIZE512
digitalWrite(led,1);
char temp[BUFFER_SIZE];
int sec =millis() /1000;
int min = sec /60;
int hr = min /60;
int day = hr /24;
hr = hr %24;
snprintf(temp, BUFFER_SIZE -1,
"<html>\
<head>\
<meta http-equiv='refresh' content='5'/>\
<title>%s</title>\
<style>\
body { background-color: #cccccc; font-family: Arial, Helvetica, Sans-Serif; Color: #000088; }\
</style>\
</head>\
<body>\
<h1>Hello from %s</h1>\
<h3>running UPnP_Generic & DDNS_Generic</h3>\
<h3>on %s</h3>\
<p>Uptime: %d d %02d:%02d:%02d</p>\
</body>\
</html>", BOARD_NAME, BOARD_NAME, SHIELD_TYPE, day, hr, min %60, sec %60);
server.send(200,F("text/html"), temp);
digitalWrite(led,0);
}
voidhandleNotFound()
{
digitalWrite(led,1);
String message =F("File Not Found\n\n");
message +=F("URI:");
message += server.uri();
message +=F("\nMethod:");
message += (server.method() == HTTP_GET) ?F("GET") :F("POST");
message +=F("\nArguments:");
message += server.args();
message +=F("\n");
for (uint8_t i =0; i < server.args(); i++)
{
message +="" + server.argName(i) +":" + server.arg(i) +"\n";
}
server.send(404,F("text/plain"), message);
digitalWrite(led,0);
}
voidinitEthernet()
{
#if USE_ETHERNET_GENERIC
ET_LOGWARN(F("=========== USE_ETHERNET_GENERIC ==========="));
#elif USE_ETHERNET_ENC
ET_LOGWARN(F("=========== USE_ETHERNET_ENC ==========="));
#elif USE_UIP_ETHERNET
ET_LOGWARN(F("=========== USE_UIP_ETHERNET ==========="));
#else
ET_LOGWARN(F("=========== USE_CUSTOM_ETHERNET ==========="));
#endif
ET_LOGWARN3(F("Board :"), BOARD_NAME,F(", setCsPin:"), USE_THIS_SS_PIN);
ET_LOGWARN(F("Default SPI pinout:"));
ET_LOGWARN1(F("MOSI:"), MOSI);
ET_LOGWARN1(F("MISO:"), MISO);
ET_LOGWARN1(F("SCK:"), SCK);
ET_LOGWARN1(F("SS:"), SS);
ET_LOGWARN(F("========================="));
// For other boards, to change if necessary
#if ( USE_ETHERNET_GENERIC || USE_ETHERNET_ENC )
// Must use library patch for Ethernet, Ethernet2, EthernetLarge libraries
Ethernet.init (USE_THIS_SS_PIN);
#elif USE_CUSTOM_ETHERNET
// You have to add initialization for your Custom Ethernet here
// This is just an example to setCSPin to USE_THIS_SS_PIN, and can be not correct and enough
//Ethernet.init(USE_THIS_SS_PIN);
#endif//( ( USE_ETHERNET_GENERIC || USE_ETHERNET_ENC )
// start the ethernet connection and the server:
// Use DHCP dynamic IP and random mac
uint16_tindex =millis() % NUMBER_OF_MAC;
// Use Static IP
//Ethernet.begin(mac[index], ip);
Ethernet.begin(mac[index]);
}
#defineRETRY_TIMES4
voidsetup()
{
pinMode(led, OUTPUT);
digitalWrite(led,0);
Serial.begin(115200);
while (!Serial &&millis() <5000);
Serial.print("\nStart nRF52_SimpleServer on"); Serial.print(BOARD_NAME);
Serial.print(" using"); Serial.println(SHIELD_TYPE);
Serial.println(UPNP_GENERIC_VERSION);
initEthernet();
IPAddress localIP = Ethernet.localIP();
Serial.print(F("Connected! IP address:"));
Serial.println(localIP);
////////////////
DDNSGeneric.service("duckdns");// Enter your DDNS Service Name - "duckdns" / "noip"
/*
For DDNS Providers where you get a token:
DDNSGeneric.client("domain", "token");
For DDNS Providers where you get username and password: ( Leave the password field empty "" if not required )
DDNSGeneric.client("domain", "username", "password");
*/
DDNSGeneric.client("account.duckdns.org","12345678-1234-1234-1234-123456789012");
DDNSGeneric.onUpdate(onUpdateCallback);
////////////////
uPnP =newUPnP(60000);// -1 means blocking, preferably, use a timeout value (ms)
if (uPnP)
{
uPnP->addPortMappingConfig(localIP, LISTEN_PORT, RULE_PROTOCOL_TCP, LEASE_DURATION, FRIENDLY_NAME);
bool portMappingAdded =false;
int retries =0;
while (!portMappingAdded && (retries < RETRY_TIMES))
{
Serial.println("Add Port Forwarding, Try #" +String(++retries));
int result = uPnP->commitPortMappings();
portMappingAdded = ( (result == PORT_MAP_SUCCESS) || (result == ALREADY_MAPPED) );
//Serial.println("commitPortMappings result =" + String(result));
if (!portMappingAdded)
{
// for debugging, you can see this in your router too under forwarding or UPnP
//uPnP->printAllPortMappings();
//Serial.println(F("This was printed because adding the required port mapping failed"));
if (retries < RETRY_TIMES)
delay(10000);// 10 seconds before trying again
}
}
uPnP->printAllPortMappings();
Serial.println(F("\nUPnP done"));
}
server.on(F("/"), handleRoot);
server.on(F("/inline"), []()
{
server.send(200,F("text/plain"),F("This works as well"));
});
server.onNotFound(handleNotFound);
server.begin();
Serial.print(F("HTTP EthernetWebServer is @ IP :"));
Serial.print(localIP);
Serial.print(F(", port ="));
Serial.println(LISTEN_PORT);
}
voidloop()
{
DDNSGeneric.update(300000);
uPnP->updatePortMappings(600000);// 10 minutes
server.handleClient();
}

2. Filedefines.h

#ifndefdefines_h
#definedefines_h
#defineDEBUG_ETHERNET_WEBSERVER_PORT Serial
// Debug Level from 0 to 4
#define_DDNS_GENERIC_LOGLEVEL_ 1
#define_UPNP_LOGLEVEL_ 2
// Select DDNS_USING_WIFI for boards using built-in WiFi, such as Nano-33-IoT
#defineDDNS_USING_WIFI false
#defineDDNS_USING_ETHERNET true
/////////////////////////////////
#if ( defined(NRF52840_FEATHER)|| defined(NRF52832_FEATHER)|| defined(NRF52_SERIES)|| defined(ARDUINO_NRF52_ADAFRUIT)|| \
defined(NRF52840_FEATHER_SENSE)|| defined(NRF52840_ITSYBITSY)|| defined(NRF52840_CIRCUITPLAY)|| defined(NRF52840_CLUE)|| \
defined(NRF52840_METRO)|| defined(NRF52840_PCA10056)|| defined(PARTICLE_XENON)|| defined(NINA_B302_ublox)|| defined(NINA_B112_ublox) )
#if defined(ETHERNET_USE_NRF528XX)
#undef ETHERNET_USE_NRF528XX
#endif
#defineETHERNET_USE_NRF528XX true
#else
#error For Adafruit nRF52 only.
#endif
#if (ETHERNET_USE_NRF528XX)
// Default pin 10 to SS/CS
#defineUSE_THIS_SS_PIN 10
#if defined(NRF52840_FEATHER)
#defineBOARD_TYPE "NRF52840_FEATHER"
#elif defined(NRF52832_FEATHER)
#defineBOARD_TYPE "NRF52832_FEATHER"
#elif defined(NRF52840_FEATHER_SENSE)
#defineBOARD_TYPE "NRF52840_FEATHER_SENSE"
#elif defined(NRF52840_ITSYBITSY)
#defineBOARD_TYPE "NRF52840_ITSYBITSY"
#defineUSE_THIS_SS_PIN 10 // For other boards
#elif defined(NRF52840_CIRCUITPLAY)
#defineBOARD_TYPE "NRF52840_CIRCUITPLAY"
#elif defined(NRF52840_CLUE)
#defineBOARD_TYPE "NRF52840_CLUE"
#elif defined(NRF52840_METRO)
#defineBOARD_TYPE "NRF52840_METRO"
#elif defined(NRF52840_PCA10056)
#defineBOARD_TYPE "NRF52840_PCA10056"
#elif defined(NINA_B302_ublox)
#defineBOARD_TYPE "NINA_B302_ublox"
#elif defined(NINA_B112_ublox)
#defineBOARD_TYPE "NINA_B112_ublox"
#elif defined(PARTICLE_XENON)
#defineBOARD_TYPE "PARTICLE_XENON"
#elif defined(ARDUINO_NRF52_ADAFRUIT)
#defineBOARD_TYPE "ARDUINO_NRF52_ADAFRUIT"
#else
#defineBOARD_TYPE "nRF52 Unknown"
#endif
#endif
#ifndefBOARD_NAME
#defineBOARD_NAME BOARD_TYPE
#endif
#include<SPI.h>
// To override the default CS/SS pin. Don't use unless you know exactly which pin to use
// You can define here or customize for each board at same place with BOARD_TYPE
// Check @ defined(SEEED_XIAO_M0)
//#define USE_THIS_SS_PIN 22 //21 //5 //4 //2 //15
// Only one if the following to be true
#defineUSE_ETHERNET_GENERIC true
#defineUSE_ETHERNET_ESP8266 false
#defineUSE_ETHERNET_ENC false
#defineUSE_UIP_ETHERNET false
#defineUSE_CUSTOM_ETHERNET false
////////////////////////////
#if (USE_ETHERNET_GENERIC||USE_ETHERNET_ENC||USE_UIP_ETHERNET )
#ifdefUSE_CUSTOM_ETHERNET
#undef USE_CUSTOM_ETHERNET
#endif
#defineUSE_CUSTOM_ETHERNET false
#endif
#ifUSE_ETHERNET_GENERIC
#defineSHIELD_TYPE "W5x00 using Ethernet_Generic Library on SPI0/SPI"
#defineETHERNET_LARGE_BUFFERS
#define_ETG_LOGLEVEL_ 1
#include"Ethernet_Generic.h"
#warning Using Ethernet_Generic lib
#elifUSE_ETHERNET_ENC
#include"EthernetENC.h"
#warning Using EthernetENC lib
#defineSHIELD_TYPE "ENC28J60 using EthernetENC Library"
#elifUSE_CUSTOM_ETHERNET
//#include "Ethernet_XYZ.h"
#include"Ethernet.h"
#warning Using Custom Ethernet library. You must include a library and initialize.
#defineSHIELD_TYPE "Custom Ethernet using Ethernet Library"
#elifUSE_UIP_ETHERNET
#include"UIPEthernet.h"
#warning Using UIPEthernet library
#defineSHIELD_TYPE "ENC28J60 using UIPEthernet Library"
#else
#ifdefUSE_ETHERNET_GENERIC
#undef USE_ETHERNET_GENERIC
#endif
#defineUSE_ETHERNET_GENERIC true
#include"Ethernet_Generic.h"
#warning Using default Ethernet_Generic lib
#defineSHIELD_TYPE "W5x00 using default Ethernet_Generic Library"
// Ethernet_Shield_W5200, EtherCard, EtherSia not supported
// Select just 1 of the following #include if uncomment #define USE_CUSTOM_ETHERNET
// Otherwise, standard Ethernet library will be used for W5x00
////////////////////////////
#endif// #if USE_ETHERNET_GENERIC
/////////////////////////////////
#ifndefBOARD_NAME
#ifdefARDUINO_BOARD
#defineBOARD_NAME ARDUINO_BOARD
#else
#defineBOARD_NAME BOARD_TYPE
#endif
#endif
#ifndefSHIELD_TYPE
#defineSHIELD_TYPE "Unknown shield"
#endif
/////////////////////////////////
#include<EthernetWebServer.h>
#include<DDNS_Generic.h>
// Enter a MAC address and IP address for your controller below.
#defineNUMBER_OF_MAC 20
bytemac[][NUMBER_OF_MAC]=
{
{0xDE,0xAD,0xBE,0xEF,0xFE,0x01 },
{0xDE,0xAD,0xBE,0xEF,0xBE,0x02 },
{0xDE,0xAD,0xBE,0xEF,0xFE,0x03 },
{0xDE,0xAD,0xBE,0xEF,0xBE,0x04 },
{0xDE,0xAD,0xBE,0xEF,0xFE,0x05 },
{0xDE,0xAD,0xBE,0xEF,0xBE,0x06 },
{0xDE,0xAD,0xBE,0xEF,0xFE,0x07 },
{0xDE,0xAD,0xBE,0xEF,0xBE,0x08 },
{0xDE,0xAD,0xBE,0xEF,0xFE,0x09 },
{0xDE,0xAD,0xBE,0xEF,0xBE,0x0A },
{0xDE,0xAD,0xBE,0xEF,0xFE,0x0B },
{0xDE,0xAD,0xBE,0xEF,0xBE,0x0C },
{0xDE,0xAD,0xBE,0xEF,0xFE,0x0D },
{0xDE,0xAD,0xBE,0xEF,0xBE,0x0E },
{0xDE,0xAD,0xBE,0xEF,0xFE,0x0F },
{0xDE,0xAD,0xBE,0xEF,0xBE,0x10 },
{0xDE,0xAD,0xBE,0xEF,0xFE,0x11 },
{0xDE,0xAD,0xBE,0xEF,0xBE,0x12 },
{0xDE,0xAD,0xBE,0xEF,0xFE,0x13 },
{0xDE,0xAD,0xBE,0xEF,0xBE,0x14 },
};
// Select the IP address according to your local network
IPAddressip(192,168,2,222);
/////////////////////////////////
#endif//defines_h

Debug Terminal Output Samples

1. SAMD_SimpleServer on SAMD_NANO_33_IOT with WiFiNINA using WiFiNINA_Generic Library

Debug terminal output when running exampleSAMD_SimpleServer on SAMD21 SAMD_NANO_33_IOT with WiFiNINA using WiFiNINA_Generic Library

Start SAMD_SimpleServer on SAMD_NANO_33_IOT with WiFiNINA using WiFiNINA_Generic LibraryUPnP_Generic v3.5.0Connecting to HueNet1IP address: 192.168.2.128Add Port Forwarding, Try # 1[UPnP] IGD current port mappings:0.   Blynk Server                  192.168.2.110     9443   9443   TCP    01.   Blynk WebServer               192.168.2.110     80     80     TCP    02.   Blynk Hardware Server         192.168.2.110     8080   8080   TCP    03.   Blynk Server                  192.168.2.110     9443   1443   TCP    04.   Blynk Secondary Server        192.168.2.112     9443   2443   TCP    05.   Blynk Sec. Hardware Server    192.168.2.112     8080   1080   TCP    06.   Blynk Server SSL              192.168.2.110     9443   443    TCP    07.   MariaDB / MySQL               192.168.2.112     5698   5698   TCP    08.   MariaDB / MySQL               192.168.2.112     3306   3306   TCP    09.   SAMD-WIFI-ESPAT               192.168.2.134     5990   5990   TCP    2241010.  NRF52-WIFI-ESPAT              192.168.2.101     7052   7052   TCP    2211011.  STM32-WIFI-ESPAT              192.168.2.133     7032   7032   TCP    1231512.  STM32-W5X00                   192.168.2.85      6032   6032   TCP    3400513.  NRF52-W5X00                   192.168.2.85      5952   5952   TCP    3234014.  STM32-LED-W5X00               192.168.2.85      6033   6033   TCP    3445515.  SAMD-WIFININA                 192.168.2.128     5995   5995   TCP    35970UPnP doneHTTP WiFiNINAWebServer is @ IP : 192.168.2.128, port = 5995[DDNS] Access whatismyipaddressConnected[DDNS] httpCode = 200HttpClient::responseBody => bodyLength =14[DDNS] Current Public IP = aaa.bbb.ccc.ddd[DDNS] response = aaa.bbb.ccc.dddConnectedDDNSGeneric - IP Change Detected: aaa.bbb.ccc.ddd[DDNS] Updated IP = aaa.bbb.ccc.ddd

2. nRF52_SimpleServer on Adafruit NRF52840_FEATHER with W5500 using Ethernet_Generic Library

Debug terminal output when running examplenRF52_SimpleServer on Adafruit NRF52840_FEATHER with W5500 & Ethernet_Generic Library

Start nRF52_SimpleServer on NRF52840_FEATHER with W5x00 & Ethernet_Generic LibraryUPnP_Generic v3.5.0Try # 1[UPnP] IGD current port mappings:0.   Blynk Server                  192.168.2.110     9443   9443   TCP    01.   Blynk WebServer               192.168.2.110     80     80     TCP    02.   Blynk Hardware Server         192.168.2.110     8080   8080   TCP    03.   Blynk Server                  192.168.2.110     9443   1443   TCP    04.   Blynk Secondary Server        192.168.2.112     9443   2443   TCP    05.   Blynk Sec. Hardware Server    192.168.2.112     8080   1080   TCP    06.   Blynk Server SSL              192.168.2.110     9443   443    TCP    07.   MariaDB / MySQL               192.168.2.112     5698   5698   TCP    08.   MariaDB / MySQL               192.168.2.112     3306   3306   TCP    09.   SAMD-WIFI-ESPAT               192.168.2.101     5990   5990   TCP    3594010.  NRF52-W5X00                   192.168.2.99      5952   5952   TCP    35985UPnP doneHTTP EthernetWebServer is @ IP : 192.168.2.99[DDNS] Access whatismyipaddress[DDNS] httpCode = 200[DDNS] Current Public IP = aaa.bbb.ccc.ddd[DDNS] response = aaa.bbb.ccc.ddd[DDNS] Sending HTTP_GET to duckdns[DDNS] HTTP_GET = http://www.duckdns.org/update?domains=account.duckdns.org&token=12345678-1234-1234-1234-123456789012&ip=aaa.bbb.ccc.ddd[DDNS] httpCode = 200DDNSGeneric - IP Change Detected: aaa.bbb.ccc.ddd[DDNS] Updated IP = aaa.bbb.ccc.ddd

3. nRF52_SimpleServer on Adafruit NRF52840_FEATHER with W5500 using Ethernet_Generic Library

Debug terminal output when running examplenRF52_SimpleServer on Adafruit NRF52840_FEATHER with W5500 using Ethernet_Generic Library

Start nRF52_SimpleServer on NRF52840_FEATHER with W5x00 & Ethernet_Generic LibraryUPnP_Generic v3.5.0_pinCS = 0W5100 init, using SS_PIN_DEFAULT = 10, new ss_pin = 10, W5100Class::ss_pin = 10W5100::init: W5500, SSIZE =4096**[UPnP] IGD current port mappings:0.   Blynk Server                  192.168.2.110     9443   9443   TCP    01.   Blynk WebServer               192.168.2.110     80     80     TCP    02.   Blynk Hardware Server         192.168.2.110     8080   8080   TCP    03.   Blynk Server                  192.168.2.110     9443   1443   TCP    04.   Blynk Secondary Server        192.168.2.112     9443   2443   TCP    05.   Blynk Sec. Hardware Server    192.168.2.112     8080   1080   TCP    06.   Blynk Server SSL              192.168.2.110     9443   443    TCP    07.   MariaDB / MySQL               192.168.2.112     5698   5698   TCP    08.   MariaDB / MySQL               192.168.2.112     3306   3306   TCP    09.   SAMD-LED-W5X00                192.168.2.85      5999   5999   TCP    2535510.  SAMD-LED-WIFININA             192.168.2.128     5996   5996   TCP    3133011.  ESP8266-LED-WIFI              192.168.2.81      8267   8267   TCP    3226512.  ESP32-LED-WIFI                192.168.2.82      5933   5933   TCP    3399513.  NRF52-LED-W5X00               192.168.2.88      5953   5953   TCP    3423014.  SAMD-W5X00                    192.168.2.84      5990   5990   TCP    3545015.  nRF52-W5X00                   192.168.2.93      5991   5991   TCP    35970UPnP doneHTTP EthernetWebServer is @ IP : 192.168.2.84[DDNS] Access whatismyipaddress[DDNS] httpCode = 200[DDNS] Current Public IP = aaa.bbb.ccc.ddd[DDNS] response = aaa.bbb.ccc.ddd[DDNS] Sending HTTP_GET to duckdns[DDNS] HTTP_GET = http://www.duckdns.org/update?domains=account.duckdns.org&token=12345678-1234-1234-1234-123456789012&ip=aaa.bbb.ccc.ddd[DDNS] httpCode = 200DDNSGeneric - IP Change Detected: aaa.bbb.ccc.ddd[DDNS] Updated IP = aaa.bbb.ccc.ddd

and screenshot for nRF52840 NINA_B302_ublox with W5500 & Ethernet_Generic Library

4. STM32_SimpleServer on STM32F7 Nucleo-144 NUCLEO_F767ZI with W5500 using Ethernet_Generic Library

Debug terminal output when running exampleSTM32_SimpleServer on STM32F7 Nucleo-144 NUCLEO_F767ZI with W5500 using Ethernet_Generic Library

Start STM32_SimpleServer on NUCLEO_F767ZI with W5x00 & Ethernet_Generic LibraryUPnP_Generic v3.5.0Add Port Forwarding, Try # 1[UPnP] IGD current port mappings:0.   Blynk Server                  192.168.2.110     9443   9443   TCP    01.   Blynk WebServer               192.168.2.110     80     80     TCP    02.   Blynk Hardware Server         192.168.2.110     8080   8080   TCP    03.   Blynk Server                  192.168.2.110     9443   1443   TCP    04.   Blynk Secondary Server        192.168.2.112     9443   2443   TCP    05.   Blynk Sec. Hardware Server    192.168.2.112     8080   1080   TCP    06.   Blynk Server SSL              192.168.2.110     9443   443    TCP    07.   MariaDB / MySQL               192.168.2.112     5698   5698   TCP    08.   MariaDB / MySQL               192.168.2.112     3306   3306   TCP    09.   SAMD-LED-WIFI-ESPAT           192.168.2.134     5991   5991   TCP    3004510.  SAMD-WIFI-ESPAT               192.168.2.134     5990   5990   TCP    3480011.  ESP32-LED-WIFI                192.168.2.82      5933   5933   TCP    3229512.  STM32-W5X00                   192.168.2.85      6032   6032   TCP    35985UPnP doneHTTP EthernetWebServer is @ IP : 192.168.2.85, port = 6032[DDNS] Access whatismyipaddress[DDNS] httpCode = 200[DDNS] Current Public IP = 216.154.52.212[DDNS] response = 216.154.52.212[DDNS] Sending HTTP_GET to duckdns[DDNS] HTTP_GET = http://www.duckdns.org/update?domains=account.duckdns.org&token=12345678-1234-1234-1234-123456789012&ip=216.154.52.212[DDNS] httpCode = 200DDNSGeneric - IP Change Detected: 216.154.52.212[DDNS] Updated IP = 216.154.52.212

5. SAMD_SimpleServer on Adafruit SAMD51 ITSYBITSY_M4 with ESP8266_AT shield

Debug terminal output when running exampleSAMD_SimpleServer on Adafruit SAMD51 ITSYBITSY_M4 with ESP8266_AT shield usingESP8266_AT_WebServer Library

Start SAMD_SimpleServer on ITSYBITSY_M4 with ESP8266_AT shieldUPnP_Generic v3.5.0WiFi shield init doneConnected to HueNet1IP address: 192.168.2.134Add Port Forwarding, Try # 1[UPnP] IGD current port mappings:0.   Blynk Server                  192.168.2.110     9443   9443   TCP    01.   Blynk WebServer               192.168.2.110     80     80     TCP    02.   Blynk Hardware Server         192.168.2.110     8080   8080   TCP    03.   Blynk Server                  192.168.2.110     9443   1443   TCP    04.   Blynk Secondary Server        192.168.2.112     9443   2443   TCP    05.   Blynk Sec. Hardware Server    192.168.2.112     8080   1080   TCP    06.   Blynk Server SSL              192.168.2.110     9443   443    TCP    07.   MariaDB / MySQL               192.168.2.112     5698   5698   TCP    08.   MariaDB / MySQL               192.168.2.112     3306   3306   TCP    0 9.   ESP8266-WIFI                  192.168.2.81      8266   8266   TCP    1869510.  ESP32                         192.168.2.82      5932   5932   TCP    2375511.  SAMD-LED-WIFININA             192.168.2.128     5996   5996   TCP    2935512.  ESP32-LED-WIFI                192.168.2.82      5933   5933   TCP    3127513.  NRF52-LED-W5X00               192.168.2.88      5953   5953   TCP    3220514.  SAMD-W5X00                    192.168.2.84      5990   5990   TCP    3307515.  SAMD-LED-W5X00                192.168.2.93      5991   5991   TCP    3364516.  SAMD-WIFI                     192.168.2.128     5995   5995   TCP    3586017.  SAMD-WIFI-ESPAT               192.168.2.134     5990   5990   TCP    35985UPnP doneHTTP EthernetWebServer is @ IP : 192.168.2.134, port = 5990[DDNS] Access whatismyipaddress[DDNS] httpCode = 200[DDNS] Current Public IP = aaa.bbb.ccc.ddd[DDNS] response = aaa.bbb.ccc.ddd[DDNS] Sending HTTP_GET to duckdns[DDNS] HTTP_GET = http://www.duckdns.org/update?domains=account.duckdns.org&token=12345678-1234-1234-1234-123456789012&ip=aaa.bbb.ccc.ddd[DDNS] httpCode = 200DDNSGeneric - IP Change Detected: aaa.bbb.ccc.ddd[DDNS] Updated IP = aaa.bbb.ccc.ddd

6. PWM_LEDServer_ESP32 on ESP32_DEV

Debug terminal output when running examplePWM_LEDServer_ESP32 on ESP32_DEV

Start PWM_LEDServer_ESP32 on ESP32_DEVUPnP_Generic v3.5.0Connecting to HueNet1..IP address: 192.168.2.82Add Port Forwarding, Try # 1[UPnP] IGD current port mappings:0.   Blynk Server                  192.168.2.110     9443   9443   TCP    01.   Blynk WebServer               192.168.2.110     80     80     TCP    02.   Blynk Hardware Server         192.168.2.110     8080   8080   TCP    03.   Blynk Server                  192.168.2.110     9443   1443   TCP    04.   Blynk Secondary Server        192.168.2.112     9443   2443   TCP    05.   Blynk Sec. Hardware Server    192.168.2.112     8080   1080   TCP    06.   Blynk Server SSL              192.168.2.110     9443   443    TCP    07.   MariaDB / MySQL               192.168.2.112     5698   5698   TCP    08.   MariaDB / MySQL               192.168.2.112     3306   3306   TCP    0 9.   ESP8266-WIFI                  192.168.2.81      8266   8266   TCP    889510.  ESP32                         192.168.2.82      5932   5932   TCP    2770511.  SAMD-LED-WIFININA             192.168.2.128     5996   5996   TCP    2995512.  ESP8266-LED-WIFI              192.168.2.82      5933   5933   TCP    3157513.  NRF52-LED-W5X00               192.168.2.88      5953   5953   TCP    3220514.  SAMD-W5X00                    192.168.2.84      5990   5990   TCP    3307515.  SAMD-LED-W5X00                192.168.2.93      5991   5991   TCP    3364516.  SAMD-WIFI                     192.168.2.128     5995   5995   TCP    3546017.  ESP32_DEV-LED-WIFI            192.168.2.81      8267   8267   TCP    35970UPnP doneHTTP EthernetWebServer is @ IP : 192.168.2.82, port = 5932Gateway Address: 192.168.2.1Network Mask: 255.255.255.0[DDNS] Current Public IP = aaa.bbb.ccc.ddd[DDNS] Sending HTTP_GET to duckdns[DDNS] HTTP_GET = http://www.duckdns.org/update?domains=account.duckdns.org&token=12345678-1234-1234-1234-123456789012&ip=aaa.bbb.ccc.dddDDNSGeneric - IP Change Detected: aaa.bbb.ccc.ddd[DDNS] Updated IP = aaa.bbb.ccc.ddd

7. RP2040_PWM_LEDServer on MBED NANO_RP2040_CONNECT with WiFiNINA using WiFiNINA_Generic Library

Debug terminal output when running exampleRP2040_PWM_LEDServer on MBED NANO_RP2040_CONNECT with WiFiNINA using WiFiNINA_Generic Library

Start RP2040_PWM_LEDServer on MBED NANO_RP2040_CONNECT with WiFiNINA using WiFiNINA_Generic LibraryUPnP_Generic v3.5.0Connecting to HueNet1IP address: 192.168.2.153Add Port Forwarding, Try # 1[UPnP] IGD current port mappings:0.   Blynk Server                  192.168.2.110     9443   9443   TCP    0      1.   Blynk WebServer               192.168.2.110     80     80     TCP    0      2.   Blynk Hardware Server         192.168.2.110     8080   8080   TCP    0      3.   Blynk Server                  192.168.2.110     9443   1443   TCP    0      4.   Blynk Secondary Server        192.168.2.112     9443   2443   TCP    0      5.   Blynk Sec. Hardware Server    192.168.2.112     8080   1080   TCP    0      6.   Blynk Server SSL              192.168.2.110     9443   443    TCP    0      7.   MariaDB / MySQL               192.168.2.112     5698   5698   TCP    0      8.   MariaDB / MySQL               192.168.2.112     3306   3306   TCP    0      9.   RP2040-LED-WIFININA           192.168.2.153     6053   6053   TCP    35985  UPnP doneHTTP WiFiWebServer is @ IP : 192.168.2.153, port = 6053[DDNS] Access whatismyipaddressConnected[DDNS] httpCode = 200HttpClient::responseBody => bodyLength =14[DDNS] Current Public IP = aaa.bbb.ccc.ddd[DDNS] response = aaa.bbb.ccc.dddConnectedDDNSGeneric - IP Change Detected: aaa.bbb.ccc.ddd[DDNS] Updated IP = aaa.bbb.ccc.ddd

8. RP2040_PWM_LEDServer on RASPBERRY_PI_PICO with W5x00 using Ethernet_Generic Library

Debug terminal output when running exampleRP2040_PWM_LEDServer on RASPBERRY_PI_PICO with W5x00 using Ethernet_Generic Library

Start RP2040_PWM_LEDServer on RASPBERRY_PI_PICO with W5x00 using Ethernet_Generic LibraryUPnP_Generic v3.5.0Connected! IP address: 192.168.2.117Add Port Forwarding, Try # 1[UPnP] IGD current port mappings:0.   Blynk Server                  192.168.2.110     9443   9443   TCP    0      1.   Blynk WebServer               192.168.2.110     80     80     TCP    0      2.   Blynk Hardware Server         192.168.2.110     8080   8080   TCP    0      3.   Blynk Server                  192.168.2.110     9443   1443   TCP    0      4.   Blynk Secondary Server        192.168.2.112     9443   2443   TCP    0      5.   Blynk Sec. Hardware Server    192.168.2.112     8080   1080   TCP    0      6.   Blynk Server SSL              192.168.2.110     9443   443    TCP    0      7.   MariaDB / MySQL               192.168.2.112     5698   5698   TCP    0      8.   MariaDB / MySQL               192.168.2.112     3306   3306   TCP    0      9.   RP2040-LED-WIFININA           192.168.2.153     6053   6053   TCP    32580  10.  RP2040-WIFININA               192.168.2.153     6052   6052   TCP    32850  11.  RP2040-LED-W5X00              192.168.2.117     5953   5953   TCP    35970  UPnP doneHTTP EthernetWebServer is @ IP : 192.168.2.117, port = 5953Gateway Address: 192.168.2.1Network Mask: 255.255.255.0[DDNS] Access whatismyipaddressConnected[DDNS] httpCode = 200HttpClient::responseBody => bodyLength =14[DDNS] Current Public IP = aaa.bbb.ccc.ddd[DDNS] response = aaa.bbb.ccc.dddConnectedDDNSGeneric - IP Change Detected: aaa.bbb.ccc.ddd[DDNS] Updated IP = aaa.bbb.ccc.ddd

9. RP2040_SimpleServer on MBED RASPBERRY_PI_PICO with W5x00 using Ethernet_Generic Library

Debug terminal output when running exampleRP2040_SimpleServer on MBED RASPBERRY_PI_PICO using W5x00 using Ethernet_Generic Library

Start RP2040_SimpleServer on MBED RASPBERRY_PI_PICO using W5x00 using Ethernet_Generic LibraryUPnP_Generic v3.5.0Connected! IP address: 192.168.2.92Add Port Forwarding, Try # 1[UPnP] IGD current port mappings:0.   Blynk Server                  192.168.2.110     9443   9443   TCP    0      1.   Blynk WebServer               192.168.2.110     80     80     TCP    0      2.   Blynk Hardware Server         192.168.2.110     8080   8080   TCP    0      3.   Blynk Server                  192.168.2.110     9443   1443   TCP    0      4.   Blynk Secondary Server        192.168.2.112     9443   2443   TCP    0      5.   Blynk Sec. Hardware Server    192.168.2.112     8080   1080   TCP    0      6.   Blynk Server SSL              192.168.2.110     9443   443    TCP    0      7.   MariaDB / MySQL               192.168.2.112     5698   5698   TCP    0      8.   MariaDB / MySQL               192.168.2.112     3306   3306   TCP    0      9.   RP2040-LED-WIFININA           192.168.2.153     6053   6053   TCP    32070  10.  RP2040-WIFININA               192.168.2.153     6052   6052   TCP    32340  11.  RP2040-LED-W5X00              192.168.2.117     5953   5953   TCP    35460  12.  RP2040-W5X00                  192.168.2.92      5952   5952   TCP    35985  UPnP doneHTTP EthernetWebServer is @ IP : 192.168.2.92, port = 5952[DDNS] Access whatismyipaddressConnected[DDNS] httpCode = 200HttpClient::responseBody => bodyLength =14[DDNS] Current Public IP = aaa.bbb.ccc.ddd[DDNS] response = aaa.bbb.ccc.dddConnectedDDNSGeneric - IP Change Detected: aaa.bbb.ccc.ddd[DDNS] Updated IP = aaa.bbb.ccc.ddd

10. PWM_LEDServer_ESP32 on ESP32S2_DEV

Debug terminal output when running examplePWM_LEDServer_ESP32 on ESP32S2_DEV

Start PWM_LEDServer_ESP32 on ESP32S2_DEVUPnP_Generic v3.5.0Connecting to HueNet1.......IP address: 192.168.2.190Add Port Forwarding, Try # 1[UPnP] IGD current port mappings:0.   Blynk Server                  192.168.2.110     9443   9443   TCP    0      1.   Blynk WebServer               192.168.2.110     80     80     TCP    0      2.   Blynk Hardware Server         192.168.2.110     8080   8080   TCP    0      3.   Blynk Server                  192.168.2.110     9443   1443   TCP    0      4.   Blynk Secondary Server        192.168.2.112     9443   2443   TCP    0      5.   Blynk Sec. Hardware Server    192.168.2.112     8080   1080   TCP    0      6.   Blynk Server SSL              192.168.2.110     9443   443    TCP    0      7.   MariaDB / MySQL               192.168.2.112     5698   5698   TCP    0      8.   MariaDB / MySQL               192.168.2.112     3306   3306   TCP    0      9.   RP2040-LED-WIFININA           192.168.2.153     6053   6053   TCP    11610  10.  RP2040-WIFININA               192.168.2.153     6052   6052   TCP    11880  11.  RP2040-W5X00                  192.168.2.92      5952   5952   TCP    15525  12.  RP2040-LED-W5X00              192.168.2.119     5953   5953   TCP    16575  13.  ESP32S2_DEV-WIFI              192.168.2.190     5932   5932   TCP    35295  14.  ESP32S2_DEV-WIFI              192.168.2.190     5933   5933   TCP    35970  UPnP doneHTTP WiFiWebServer is @ IP : 192.168.2.190, port = 5933Gateway Address: 192.168.2.1Network Mask: 255.255.255.0DDNSGeneric - IP Change Detected: aaa.bbb.ccc.ddd[DDNS] Updated IP = aaa.bbb.ccc.ddd

11. PWM_LEDServer_ESP8266 on ESP8266_NODEMCU_ESP12E

Debug terminal output when running examplePWM_LEDServer_ESP32 on ESP8266_NODEMCU_ESP12E

Start PWM_LEDServer_ESP8266 on ESP8266_NODEMCU_ESP12EUPnP_Generic v3.5.0Connecting to HueNet1...........IP address: 192.168.2.135Add Port Forwarding, Try # 1[UPnP] IGD current port mappings:0.   Blynk Server                  192.168.2.110     9443   9443   TCP    0      1.   Blynk WebServer               192.168.2.110     80     80     TCP    0      2.   Blynk Hardware Server         192.168.2.110     8080   8080   TCP    0      3.   Blynk Server                  192.168.2.110     9443   1443   TCP    0      4.   Blynk Secondary Server        192.168.2.112     9443   2443   TCP    0      5.   Blynk Sec. Hardware Server    192.168.2.112     8080   1080   TCP    0      6.   Blynk Server SSL              192.168.2.110     9443   443    TCP    0      7.   MariaDB / MySQL               192.168.2.112     5698   5698   TCP    0      8.   MariaDB / MySQL               192.168.2.112     3306   3306   TCP    0      9.   RP2040-LED-WIFININA           192.168.2.153     6053   6053   TCP    11310  10.  RP2040-WIFININA               192.168.2.153     6052   6052   TCP    11580  11.  RP2040-W5X00                  192.168.2.92      5952   5952   TCP    15225  12.  RP2040-LED-W5X00              192.168.2.119     5953   5953   TCP    16275  13.  ESP32S2_DEV-WIFI              192.168.2.190     5932   5932   TCP    34995  14.  ESP32S2_DEV-WIFI              192.168.2.190     5933   5933   TCP    35670  15.  ESP8266_NODEMCU_ESP12E-WIFI   192.168.2.135     8267   8267   TCP    35910  UPnP doneHTTP WiFiWebServer is @ IP : 192.168.2.135, port = 8267Gateway Address: 192.168.2.1Network Mask: 255.255.255.0DDNSGeneric - IP Change Detected: aaa.bbb.ccc.ddd[DDNS] Updated IP = aaa.bbb.ccc.ddd

12. SimpleServer_WT32_ETH01 on WT32-ETH01 with ETH_PHY_LAN8720

Debug terminal output when running exampleSimpleServer_WT32_ETH01 on WT32-ETH01 with ETH_PHY_LAN8720

Start SimpleServer_WT32_ETH01 on WT32-ETH01 with ETH_PHY_LAN8720WebServer_WT32_ETH01 v1.4.1DDNS_Generic v1.6.1UPnP_Generic v3.5.0ETH MAC: A8:03:2A:A1:61:73, IPv4: 192.168.2.232FULL_DUPLEX, 100MbpsIP address: 192.168.2.232[UPnP] UDP_TX_PACKET_MAX_SIZE= 1000[UPnP] UDP_TX_RESPONSE_MAX_SIZE= 8192[UPnP] newUpnpRule= 0.0.0.0Add Port Forwarding, Try # 1[UPnP] Testing WT32_ETH01 Ethernet connection for IP : 192.168.2.232 ==> GOOD[UPnP] Internet connection GOOD[UPnP] isGatewayInfoValid : 0.0.0.0 , port : 0[UPnP] Path :  , actionPort : 0[UPnP] actionPath :  , serviceTypeName : [UPnP] Gateway info not valid[UPnP] GW IP = 192.168.2.1[UPnP] Sending M-SEARCH to : 239.255.255.250 , Port : 1900[UPnP] Received packet, size = 331 , IP = 192.168.2.1[UPnP] Port = 1900[UPnP] IGD found[UPnP] IGD location found : http://192.168.2.1:5431/dyndev/uuid:2166898a-7de8-40ed-a1e1-b29a1d140d04[UPnP] 192.168.2.1[UPnP] 5431[UPnP] /dyndev/uuid:2166898a-7de8-40ed-a1e1-b29a1d140d04[UPnP] Connecting to IGD with host : 192.168.2.1 , port : 5431[UPnP] Connected to IGD[UPnP] called getIGDEventURLs[UPnP] deviceInfo->actionPath :  , deviceInfo->path : /dyndev/uuid:2166898a-7de8-40ed-a1e1-b29a1d140d04[UPnP] URLBase tag found : http://192.168.2.1:5431/[UPnP] Translated to base host : 192.168.2.1  and base port : 5431[UPnP] urn:schemas-upnp-org:service:WANPPPConnection:1 service found![UPnP] controlURL tag found! Setting actionPath to : /uuid:a4781538-557f-46eb-91f0-c898f3a661d5/WANPPPConnection:1[UPnP] Port : 5431 , actionPort : 5431[UPnP] isGatewayInfoValid : 192.168.2.1 , port : 5431[UPnP] Path : /dyndev/uuid:2166898a-7de8-40ed-a1e1-b29a1d140d04 , actionPort : 5431[UPnP] actionPath : /uuid:a4781538-557f-46eb-91f0-c898f3a661d5/WANPPPConnection:1 , serviceTypeName : urn:schemas-upnp-org:service:WANPPPConnection:1[UPnP] Gateway info valid[UPnP] Verify port mapping for rule : ESP32_DEV-WT32_ETH01[UPnP] Apply action : GetSpecificPortMappingEntry  on port mapping : ESP32_DEV-WT32_ETH01[UPnP] Connecting to IGD with host : 192.168.2.1 , port : 5431[UPnP] Connected to IGD[UPnP] Host: 192.168.2.1:5431[UPnP] Port mapping found in IGD[UPnP] All port mappings found in IGD, doing nothing[UPnP] isGatewayInfoValid : 192.168.2.1 , port : 5431[UPnP] Path : /dyndev/uuid:2166898a-7de8-40ed-a1e1-b29a1d140d04 , actionPort : 5431[UPnP] actionPath : /uuid:a4781538-557f-46eb-91f0-c898f3a661d5/WANPPPConnection:1 , serviceTypeName : urn:schemas-upnp-org:service:WANPPPConnection:1[UPnP] Gateway info valid[UPnP] Connecting to IGD with host : 192.168.2.1 , port : 5431[UPnP] Connected to IGD[UPnP] IGD current port mappings:0.   Blynk Server                  192.168.2.110     9443   9443   TCP    0      1.   Blynk WebServer               192.168.2.110     80     80     TCP    0      2.   Blynk Hardware Server         192.168.2.110     8080   8080   TCP    0      3.   Blynk Server                  192.168.2.110     9443   1443   TCP    0      4.   Blynk Secondary Server        192.168.2.112     9443   2443   TCP    0      5.   Blynk Sec. Hardware Server    192.168.2.112     8080   1080   TCP    0      6.   Blynk Server SSL              192.168.2.110     9443   443    TCP    0      7.   MariaDB / MySQL               192.168.2.112     5698   5698   TCP    0      8.   MariaDB / MySQL               192.168.2.112     3306   3306   TCP    0      9.   ESP8266_NODEMCU_ESP12E-WIFI   192.168.2.36      8266   8266   TCP    33690  76.  ESP32_DEV-WT32_ETH01          192.168.2.232     5931   5931   TCP    35070  UPnP doneHTTP WiFiWebServer is @ IP : 192.168.2.232, port = 5931Gateway Address: 192.168.2.1Network Mask: 255.255.255.0DDNSGeneric - IP Change Detected: aaa.bbb.ccc.ddd[DDNS] Updated IP = aaa.bbb.ccc.ddd

13. Portenta_H7_SimpleServer on PORTENTA_H7_M7 using Portenta_H7 WiFi

Debug terminal output when running examplePortenta_H7_SimpleServer on PORTENTA_H7_M7 using Portenta_H7 WiFi

Start Portenta_H7_SimpleServer on PORTENTA_H7_M7 using Portenta_H7 WiFiUPnP_Generic v3.5.0Connecting to HueNet1IP address: 192.168.2.130Add Port Forwarding, Try # 1[UPnP] IGD current port mappings:0.   Blynk Server                  192.168.2.110     9443   9443   TCP    0      1.   Blynk WebServer               192.168.2.110     80     80     TCP    0      2.   Blynk Hardware Server         192.168.2.110     8080   8080   TCP    0      3.   Blynk Server                  192.168.2.110     9443   1443   TCP    0      4.   Blynk Secondary Server        192.168.2.112     9443   2443   TCP    0      5.   Blynk Sec. Hardware Server    192.168.2.112     8080   1080   TCP    0      6.   Blynk Server SSL              192.168.2.110     9443   443    TCP    0      7.   MariaDB / MySQL               192.168.2.112     5698   5698   TCP    0      8.   MariaDB / MySQL               192.168.2.112     3306   3306   TCP    0      9.   Portenta_H7-WIFI              192.168.2.130     6032   6032   TCP    35970  UPnP doneHTTP WiFiWebServer is @ IP : 192.168.2.130, port = 6032[DDNS] Access whatismyipaddressConnected[DDNS] httpCode = 200HttpClient::responseBody => bodyLength =15[DDNS] Current Public IP = aaa.bbb.ccc.ddd[DDNS] response = aaa.bbb.ccc.dddConnectedDDNSGeneric - IP Change Detected: aaa.bbb.ccc.ddd[DDNS] Updated IP = aaa.bbb.ccc.ddd

14. Portenta_H7_SimpleServer on PORTENTA_H7_M7 using Ethernet

Debug terminal output when running examplePortenta_H7_SimpleServer on PORTENTA_H7_M7 using Ethernet using Portenta_Ethernet Library

Start Portenta_H7_SimpleServer on PORTENTA_H7_M7 using Ethernet using Portenta_Ethernet LibraryUPnP_Generic v3.5.0Add Port Forwarding, Try # 1[UPnP] IGD current port mappings:0.   Blynk Server                  192.168.2.110     9443   9443   TCP    0      1.   Blynk WebServer               192.168.2.110     80     80     TCP    0      4.   Blynk Secondary Server        192.168.2.112     9443   2443   TCP    0      6.   Blynk Server SSL              192.168.2.110     9443   443    TCP    0      7.   MariaDB / MySQL               192.168.2.112     5698   5698   TCP    0      8.   MariaDB / MySQL               192.168.2.112     3306   3306   TCP    0      9.   Portenta_H7-LED-WIFI          192.168.2.130     6033   6033   TCP    35040  10.  Portenta_H7-ETH               192.168.2.132     6032   6032   TCP    35970  UPnP doneHTTP EthernetWebServer is @ IP : 192.168.2.132, port = 6032[DDNS] Access whatismyipaddressConnected[DDNS] httpCode = 200HttpClient::responseBody => bodyLength =15[DDNS] Current Public IP = aaa.bbb.ccc.ddd[DDNS] response = aaa.bbb.ccc.dddConnectedDDNSGeneric - IP Change Detected: oldIP = , newIP = aaa.bbb.ccc.ddd[DDNS] Updated IP = aaa.bbb.ccc.ddd

15. T41_QNEthernet_SimpleServer on TEENSY 4.1

Debug terminal output when running exampleT41_QNEthernet_SimpleServer on Teensy 4.1 using built-in Ethernet with QNEthernet Library

Start T41_QNEthernet_SimpleServer on TEENSY 4.1UPnP_Generic v3.5.0IP Address = 192.168.2.123[UPnP] UDP_TX_PACKET_MAX_SIZE= 1000[UPnP] UDP_TX_RESPONSE_MAX_SIZE= 8192[UPnP] newUpnpRule= 0.0.0.0Add Port Forwarding, Try # 1[UPnP] Internet connection GOOD[UPnP] isGatewayInfoValid : 0.0.0.0 , port : 0[UPnP] Path :  , actionPort : 0[UPnP] actionPath :  , serviceTypeName : [UPnP] Gateway info not valid[UPnP] GW IP = 192.168.2.1[UPnP] Sending M-SEARCH to : 239.255.255.250 , Port : 1900[UPnP] Received packet, size = 331 , IP = 192.168.2.1[UPnP] Port = 1900[UPnP] IGD found[UPnP] IGD location found : http://192.168.2.1:5431/dyndev/uuid:23a5ccd0-54ea-4ff8-9607-26c3b838e44c[UPnP] 192.168.2.1[UPnP] 5431[UPnP] /dyndev/uuid:23a5ccd0-54ea-4ff8-9607-26c3b838e44c[UPnP] Connecting to IGD with host : 192.168.2.1 , port : 5431[UPnP] Connected to IGD[UPnP] called getIGDEventURLs[UPnP] deviceInfo->actionPath :  , deviceInfo->path : /dyndev/uuid:23a5ccd0-54ea-4ff8-9607-26c3b838e44c[UPnP] URLBase tag found : http://192.168.2.1:5431/[UPnP] Translated to base host : 192.168.2.1  and base port : 5431[UPnP] urn:schemas-upnp-org:service:WANPPPConnection:1 service found![UPnP] controlURL tag found! Setting actionPath to : /uuid:3e3d865a-8e93-453c-998d-0049f6ff26f5/WANPPPConnection:1[UPnP] Port : 5431 , actionPort : 5431[UPnP] isGatewayInfoValid : 192.168.2.1 , port : 5431[UPnP] Path : /dyndev/uuid:23a5ccd0-54ea-4ff8-9607-26c3b838e44c , actionPort : 5431[UPnP] actionPath : /uuid:3e3d865a-8e93-453c-998d-0049f6ff26f5/WANPPPConnection:1 , serviceTypeName : urn:schemas-upnp-org:service:WANPPPConnection:1[UPnP] Gateway info valid[UPnP] Verify port mapping for rule : T41-QNEth[UPnP] Apply action : GetSpecificPortMappingEntry  on port mapping : T41-QNEth[UPnP] Connecting to IGD with host : 192.168.2.1 , port : 5431[UPnP] Connected to IGD[UPnP] Host: 192.168.2.1:5431[UPnP] Port mapping found in IGD[UPnP] All port mappings found in IGD, doing nothing[UPnP] isGatewayInfoValid : 192.168.2.1 , port : 5431[UPnP] Path : /dyndev/uuid:23a5ccd0-54ea-4ff8-9607-26c3b838e44c , actionPort : 5431[UPnP] actionPath : /uuid:3e3d865a-8e93-453c-998d-0049f6ff26f5/WANPPPConnection:1 , serviceTypeName : urn:schemas-upnp-org:service:WANPPPConnection:1[UPnP] Gateway info valid[UPnP] Connecting to IGD with host : 192.168.2.1 , port : 5431[UPnP] Connected to IGD[UPnP] IGD current port mappings:0.   Blynk Server                  192.168.2.110     9443   9443   TCP    0      1.   Blynk WebServer               192.168.2.110     80     80     TCP    0      2.   Blynk Hardware Server         192.168.2.110     8080   8080   TCP    0      3.   Blynk Server                  192.168.2.110     9443   1443   TCP    0      4.   Blynk Secondary Server        192.168.2.112     9443   2443   TCP    0      5.   Blynk Sec. Hardware Server    192.168.2.112     8080   1080   TCP    0      6.   Blynk Server SSL              192.168.2.110     9443   443    TCP    0      7.   MariaDB / MySQL               192.168.2.112     5698   5698   TCP    0      8.   MariaDB / MySQL               192.168.2.112     3306   3306   TCP    0      9.   T41-QNEth                     192.168.2.123     6032   6032   TCP    35355UPnP doneHTTP EthernetWebServer is @ IP : 192.168.2.123, port = 6032[DDNS] Access ifconfig.meConnected[DDNS] httpCode = 200HttpClient::responseBody => bodyLength =-1[DDNS] Current Public IP = aaa.bbb.ccc.ddd[DDNS] response = aaa.bbb.ccc.dddConnectedDDNSGeneric - IP Change Detected: oldIP = , newIP = aaa.bbb.ccc.ddd[DDNS] Updated IP = aaa.bbb.ccc.ddd

Debug

Debug is enabled by default on Serial. To disable, add at the beginning of sketch

/* Comment this out to disable prints and save space*/// Debug Level from 0 to 4#define_DDNS_GENERIC_LOGLEVEL_1#define_UPNP_LOGLEVEL_3

Troubleshooting

If you get compilation errors, more often than not, you may need to install a newer version of the board's core, dependent libraries or this library version.

Sometimes, the library will only work if you update the core to the newer or older version because some function compatibility.

Issues

Submit issues to:UPnP_Generic issues

TO DO

  1. Bug Searching and Killing
  2. Support more non-compatible Ethernet Libraries such as Ethernet_Shield_W5200, EtherCard, EtherSia

DONE

  1. Add support to Arduino SAMD21 (ZERO, MKR, NANO_33_IOT, etc.)
  2. Add support to Adafruit SAMD21 (Itsy-Bitsy M0, Metro M0, Feather M0 Express, etc.).
  3. Add support to Adafruit SAMD51 (Itsy-Bitsy M4, Metro M4, Grand Central M4, Feather M4 Express, etc.).
  4. Add support to Adafruit nRF52 ( Feather nRF52832, nRF52840 Express, BlueFruit Sense, Itsy-Bitsy nRF52840 Express, Metro nRF52840 Express, NINA_B302_ublox, NINA_B112_ublox, etc.
  5. Add support to Seeeduino SAMD21/SAMD51 boards (SEEED_WIO_TERMINAL, SEEED_FEMTO_M0, SEEED_XIAO_M0, Wio_Lite_MG126, WIO_GPS_BOARD, SEEEDUINO_ZERO, SEEEDUINO_LORAWAN, SEEED_GROVE_UI_WIRELESS, etc.)
  6. Add support to STM32F/L/H/G/WB/MP1 (Nucleo-144, Nucleo-64, Nucleo-32, Discovery, STM32Fx, STM32H7, STM32Lx, STM32Gx, STM32WB, STM32MP1, etc.) having 64K+ Flash program memory.
  7. Add support to Ethernet W5x00, using eitherEthernet,Ethernet2,Ethernet3 orEthernetLarge library
  8. Add support to WiFiNINA using WiFiNINA or WiFiNINA_Generic library.
  9. Add support to ESP8266-AT, ESP32-AT WiFi shields usingESP8266_AT_WebServer or WiFiEspAT library.
  10. Add support to RP2040-based boards, such asRASPBERRY_PI_PICO, ADAFRUIT_FEATHER_RP2040 and GENERIC_RP2040, usingEarle Philhower's arduino-pico core.
  11. Add support to RP2040-based boards, such asNANO_RP2040_CONNECT, RASPBERRY_PI_PICO, ADAFRUIT_FEATHER_RP2040 and GENERIC_RP2040, usingArduino-mbed RP2040 core.
  12. Add Version String and Table of Contents
  13. Add support toWT32_ETH01 boards using ESP32-based boards and LAN8720 Ethernet
  14. Add support toPortenta_H7, using eitherMurata WiFi orVision-shield Ethernet
  15. Use newEthernet_Generic library as default for W5x00.
  16. SupportSPI2 for ESP32
  17. Add support to SPI1 for RP2040 usingarduino-pico core
  18. Add examplemultiFileProject_Ethernet andmultiFileProject_WiFiNINA to demo how to avoidmultiple-definitions linker error for multiple-file project
  19. Add support to Teensy 4.1 built-in Ethernet usingNativeEthernet library
  20. Add support to Teensy 4.1 built-in Ethernet usingQNEthernet library

Contributions and Thanks

Many thanks for everyone for bug reporting, new feature suggesting, testing and contributing to the development of this library.

  1. Based on and modified from theOfek Pearl's TinyUPnP Library to add support to many boards and shields besidesESP32 and ESP8266
  2. Thanks to good work ofMiguel Wisintainer for working with, developing, debugging and testing.
ofekp
⭐️ Ofek Pearl
tcpipchip
⭐️ Miguel Wisintainer

Contributing

If you want to contribute to this project:

  • Report bugs and errors
  • Ask for enhancements
  • Create issues and pull requests
  • Tell other people about this library

License

  • The library is licensed underGPLv3.0

Copyright

Copyright 2020- Khoi Hoang

About

A simple library that implements port mappings to router using UPnP SSDP for Arduino boards, running on nRF52, SAMD21/SAMD51, STM32F/L/H/G/WB/MP1, Teensy, RP2040-based boards, WT32_ETH01, Portenta_H7, etc. besides ESP8266/ESP32, using ESP WiFi, WiFiNINA, Ethernet W5x00, ESP8266/ESP32 AT-command WiFi, Portenta_H7 Murata WiFi or Vision-shield Ethe…

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published
[8]ページ先頭
©2009-2025 Movatter.jp