- Why do we need this AsyncDNSServer_ESP32_Ethernet library
- Changelog
- Prerequisites
- Installation
- Libraries' Patches
- HOWTO Fix
Multiple Definitions
Linker Error - HOWTO Use analogRead() with ESP32 running WiFi and/or BlueTooth (BT/BLE)
- HOWTO Setting up the Async DNS Server
- How to connect W5500, W6100 or ENC28J60 to ESP32
- How to connect W5500, W6100 or ENC28J60 to ESP32_S2/S3/C3
- Examples
- Example AsyncDNSServer_ESP32_SC_W5500
- Debug
- Troubleshooting
- Issues
- TO DO
- DONE
- Contributions and Thanks
- Contributing
- License
- Copyright
Why do we need this AsyncDNSServer_ESP32_Ethernet library
This AsyncDNSServer_ESP32_Ethernet library is a fully asynchronous DNSServer
library, designed for a trouble-free, multi-connection network environment, for ESP32/S2/S3/C3 boards using LwIP W5500, W6100 or ENC28J60 Ethernet.
This library is based on, modified from:
to apply the better and faster asynchronous feature of the powerful AsyncDNSServer_ESP32_Ethernet Library into ESP32/S2/S3/C3 boards using LwIP W5500, W6100 or ENC28J60 Ethernet.
- Using asynchronous network means that you can handle more than one connection at the same time
- You are called once the packet is ready
- After a DNS Client connected to this Async DNS server, you are immediately ready to handle other connections while the Server is taking care of receiving and responding to the UDP packets in the background.
- You are not required to check in a tight loop() the arrival of the DNS requesting packets to process them.
- Speed is OMG
- ESP32 boards
- ESP32_S3-based boards (ESP32S3_DEV, ESP32_S3_BOX, UM TINYS3, UM PROS3, UM FEATHERS3, etc.)
- ESP32-S2 (ESP32-S2 Saola, AI-Thinker ESP-12K, etc.)
- ESP32-C3 (ARDUINO_ESP32C3_DEV, etc.)
using LwIP W5500, W6100 or ENC28J60 Ethernet
FULL_DUPLEX, 100Mbps
FULL_DUPLEX, 100Mbps
FULL_DUPLEX, 10Mbps
Arduino IDE 1.8.19+
for ArduinoESP32 Core 2.0.6+
for ESP32-based boards.
WebServer_ESP32_W5500 library 1.5.2+
forESP32
using W5500. To install, checkWebServer_ESP32_W6100 library 1.5.2+
forESP32
using W6100. To install, checkWebServer_ESP32_ENC library 1.5.1+
forESP32
using ENC28J60. To install, checkAsyncUDP_ESP32_W5500 library 2.0.0+
forESP32
using W5500. To install, checkAsyncUDP_ESP32_W6100 library 2.0.0+
forESP32
using W6100. To install, checkAsyncUdp_ESP32_ENC library 2.0.0+
forESP32
using ENC28J60. To install, check
WebServer_ESP32_SC_W5500 library 1.2.1+
forESP32_S2/S3/C3
using W5500. To install, checkWebServer_ESP32_SC_W6100 library 1.2.1+
forESP32_S2/S3/C3
using W6100. To install, checkWebServer_ESP32_SC_ENC library 1.2.0+
forESP32_S2/S3/C3
using ENC28J60. To install, checkAsyncUDP_ESP32_SC_Ethernet library 2.2.0+
forESP32_S2/S3/C3
using W5500, W6100 or ENC28J60. To install, check
The suggested way to install is to:
The best way is to use Arduino Library Manager
. Search for AsyncDNSServer_ESP32_Ethernet
, then select / install the latest version. You can also use this link for more detailed instructions.
- Navigate to AsyncDNSServer_ESP32_Ethernet page.
- Download the latest release
AsyncDNSServer_ESP32_Ethernet-main.zip
. - Extract the zip file to
AsyncDNSServer_ESP32_Ethernet-main
directory - Copy the whole
AsyncDNSServer_ESP32_Ethernet-main
folder to Arduino libraries' directory such as~/Arduino/libraries/
.
- Install VS Code
- Install PlatformIO
- Install AsyncDNSServer_ESP32_Ethernet library by using Library Manager. Search for AsyncDNSServer_ESP32_Ethernet in Platform.io Author's Libraries
- Use included platformio.ini file from examples to ensure that all dependent libraries will installed automatically. Please visit documentation for the other options and examples at Project Configuration File
To fix ESP32 compile error
, just copy the following file into the ESP32
cores/esp32 directory (e.g. ./arduino-1.8.19/hardware/espressif/cores/esp32) to overwrite the old file:
The current library implementation, using xyz-Impl.h
instead of standard xyz.cpp
, possibly creates certain Multiple Definitions
Linker error in certain use cases.
You can include this .hpp
file
// Can be included as many times as necessary, without `Multiple Definitions` Linker Error
#include "AsyncDNSServer_ESP32_Ethernet.hpp" //https://github.com/khoih-prog/AsyncDNSServer_ESP32_Ethernet
in many files. But be sure to use the following .h
file in just 1 .h
, .cpp
or .ino
file, which must not be included in any other file, to avoid Multiple Definitions
Linker Error
// To be included only in main(), .ino with setup() to avoid `Multiple Definitions` Linker Error
#include "AsyncDNSServer_ESP32_Ethernet.h" //https://github.com/khoih-prog/AsyncDNSServer_ESP32_Ethernet
Please have a look at ESP_WiFiManager Issue 39: Not able to read analog port when using the autoconnect example to have more detailed description and solution of the issue.
ADC1
controls ADC function for pins GPIO32-GPIO39ADC2
controls ADC function for pins GPIO0, 2, 4, 12-15, 25-27
Look in file adc_common.c
In
ADC2
, there're two locks used for different cases:
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.lock shared between tasks: when several tasks sharing the
ADC2
, we want to guarantee all 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 to acquire 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 the fix mentioned at the end of ESP_WiFiManager Issue 39: Not able to read analog port when using the autoconnect example to work with ESP32 WiFi/BlueTooth (BT/BLE)
For ESP32 using LwIP W5500 Ethernet
#include <AsyncDNSServer_ESP32_Ethernet.h>
#include <ESPAsyncWebServer.h>
const byte DNS_PORT = 53;
IPAddress apIP;
AsyncDNSServer dnsServer;
AsyncWebServer server(80);
void setup()
{
...
///////////////////////////////////
// To be called before ETH.begin()
ESP32_W5500_onEvent();
// start the ethernet connection and the server:
// Use DHCP dynamic IP and random mac
//bool begin(int MISO_GPIO, int MOSI_GPIO, int SCLK_GPIO, int CS_GPIO, int INT_GPIO, int SPI_CLOCK_MHZ,
// int SPI_HOST, uint8_t *W5500_Mac = W5500_Default_Mac);
ETH.begin( MISO_GPIO, MOSI_GPIO, SCK_GPIO, CS_GPIO, INT_GPIO, SPI_CLOCK_MHZ, ETH_SPI_HOST );
//ETH.begin( MISO_GPIO, MOSI_GPIO, SCK_GPIO, CS_GPIO, INT_GPIO, SPI_CLOCK_MHZ, ETH_SPI_HOST, mac[millis() % NUMBER_OF_MAC] );
// Static IP, leave without this line to get IP via DHCP
//bool config(IPAddress local_ip, IPAddress gateway, IPAddress subnet, IPAddress dns1 = 0, IPAddress dns2 = 0);
//ETH.config(myIP, myGW, mySN, myDNS);
ESP32_W5500_waitForConnect();
///////////////////////////////////
apIP = ETH.localIP();
///////////////////////////////////
// modify TTL associated with the domain name (in seconds)
// default is 60 seconds
dnsServer.setTTL(300);
// set which return code will be used for all other domains (e.g. sending
// ServerFailure instead of NonExistentDomain will reduce number of queries
// sent by clients)
// default is AsyncDNSReplyCode::NonExistentDomain
dnsServer.setErrorReplyCode(AsyncDNSReplyCode::ServerFailure);
// start DNS server for a specific domain name
dnsServer.start(DNS_PORT, "*", apIP);
...
}
void loop()
{
}
You can change the INT
pin to another one. Default is GPIO4
// Must connect INT to GPIOxx or not working
#define INT_GPIO 4
W5500, W6100 or ENC28J60 | <---> | ESP32 |
---|---|---|
MOSI | <---> | GPIO23 |
MISO | <---> | GPIO19 |
SCK | <---> | GPIO18 |
CS/SS | <---> | GPIO5 |
INT | <---> | GPIO4 |
RST | <---> | RST |
GND | <---> | GND |
3.3V | <---> | 3.3V |
FULL_DUPLEX, 100Mbps
FULL_DUPLEX, 100Mbps
FULL_DUPLEX, 10Mbps
You can change the INT
pin to another one. Default is GPIO4
// Must connect INT to GPIOxx or not working
#define INT_GPIO 4
W5500, W6100 or ENC28J60 | <---> | ESP32_S3 |
---|---|---|
MOSI | <---> | GPIO11 |
MISO | <---> | GPIO13 |
SCK | <---> | GPIO12 |
CS/SS | <---> | GPIO10 |
INT | <---> | GPIO4 |
RST | <---> | RST |
GND | <---> | GND |
3.3V | <---> | 3.3V |
You can change the INT
pin to another one. Default is GPIO4
// Must connect INT to GPIOxx or not working
#define INT_GPIO 4
W5500, W6100 or ENC28J60 | <---> | ESP32_S2 |
---|---|---|
MOSI | <---> | GPIO35 |
MISO | <---> | GPIO37 |
SCK | <---> | GPIO36 |
CS/SS | <---> | GPIO34 |
INT | <---> | GPIO4 |
RST | <---> | RST |
GND | <---> | GND |
3.3V | <---> | 3.3V |
You can change the INT
pin to another one. Default is GPIO4
// Must connect INT to GPIOxx or not working
#define INT_GPIO 10
W5500, W6100 or ENC28J60 | <---> | ESP32_C3 |
---|---|---|
MOSI | <---> | GPIO6 |
MISO | <---> | GPIO5 |
SCK | <---> | GPIO4 |
CS/SS | <---> | GPIO7 |
INT | <---> | GPIO10 |
RST | <---> | RST |
GND | <---> | GND |
3.3V | <---> | 3.3V |
- AsyncCaptivePortalAdvanced_ESP32_W5500
- AsyncCaptivePortal_ESP32_W5500
- AsyncDNServerFull_ESP32_W5500
- AsyncDNSServer_ESP32_W5500
- AsyncCaptivePortalAdvanced_ESP32_ENC
- AsyncCaptivePortal_ESP32_ENC
- AsyncDNServerFull_ESP32_ENC
- AsyncDNSServer_ESP32_ENC
- AsyncCaptivePortalAdvanced_ESP32_SC_W5500
- AsyncCaptivePortal_ESP32_SC_W5500
- AsyncDNServerFull_ESP32_SC_W5500
- AsyncDNSServer_ESP32_SC_W5500
- AsyncCaptivePortalAdvanced_ESP32_SC_ENC
- AsyncCaptivePortal_ESP32_SC_ENC
- AsyncDNServerFull_ESP32_SC_ENC
- AsyncDNSServer_ESP32_SC_ENC
- AsyncCaptivePortalAdvanced_ESP32_W6100
- AsyncCaptivePortal_ESP32_W6100
- AsyncDNServerFull_ESP32_W6100
- AsyncDNSServer_ESP32_W6100
- AsyncCaptivePortalAdvanced_ESP32_SC_W6100
- AsyncCaptivePortal_ESP32_SC_W6100
- AsyncDNServerFull_ESP32_SC_W6100
- AsyncDNSServer_ESP32_SC_W6100
Example AsyncDNSServer_ESP32_SC_W5500
Debug is enabled by default on Serial. To disable, use level 0
#define ASYNC_DNS_ESP32_ETHERNET_DEBUG_PORT Serial
// Use from 0 to 4. Higher number, more debugging messages and memory usage.
#define _ASYNC_DNS_ESP32_ETHERNET_LOGLEVEL_ 0
You can also change the debugging level from 0 to 4
#define ASYNC_DNS_ESP32_ETHERNET_DEBUG_PORT Serial
// Use from 0 to 4. Higher number, more debugging messages and memory usage.
#define _ASYNC_DNS_ESP32_ETHERNET_LOGLEVEL_ 4
If you get compilation errors, more often than not, you may need to install a newer version of Arduino IDE, the Arduino ESP32
core or depending libraries.
Sometimes, the library will only work if you update the ESP32
core to the latest and stable version because I'm always using the latest stable cores/libraries.
Submit issues to: AsyncDNSServer_ESP32_Ethernet issues
- Fix bug. Add enhancement
- Add support to more
LwIP Ethernet
shields
- Add support to ESP32/S3-based boards using LwIP W5500 or ENC28J60 Ethernet
- Add debugging features
- Add astyle using
allman
style. Restyle the library - Add support to ESP32_S2/C3-based boards using LwIP W5500 or ENC28J60 Ethernet
- Add support to ESP32/S2/S3/C3-based boards using LwIP W6100 Ethernet
- Based on and modified from Develo's ESPAsyncDNSServer Library.
![]() ⭐️ Develo |
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
- The library is licensed under GPLv3
- Copyright (c) 2016- Develo
- Copyright (c) 2022- Khoi Hoang