ESP Web Tools
- ESP Web Tools allows you to manage ESP8266 and ESP32 devices in the - browser: install new firmware, update firmware, connect device to the - Wi-Fi network, visit the device's hosted web interface and add devices - to Home Assistant. + User friendly tools to manage ESP8266 and ESP32 devices in the browser:
+-
+
- Install & update firmware +
- Connect device to the Wi-Fi network +
- Visit the device's hosted web interface +
- Access logs and send terminal commands +
- + Add devices to + Home Assistant + +
- ESP Web Tools works by combining - Web Serial, Improv Wi-Fi (optional), - and a manifest which describes the firmware. It will automatically find - the supported firmware files from the manifest by detecting the chipset - of the connected ESP device. -
-- Web Serial is available in Google Chrome and Microsoft Edge - browsers. Android support should be possible but has not been implemented yet. -
-Try a live demo
This demo will install @@ -178,90 +179,113 @@ >. -
- If you don't see your ESP device in the list of devices to choose, you - might need to install - the drivers. -
Products using ESP Web Tools
-
- WLED
-- Fast and feature-rich firmware to control NeoPixel (WS2812B, WS2811, - SK6812) LEDs and SPI based chipsets like the WS2801 and APA102. -
- -
- Tasmota
-- Firmware with easy configuration using webUI, OTA updates, automation - using timers or rules, expandability and entirely local control over - MQTT, HTTP, Serial or KNX. -
- -
- CanAirIO
-- Citizen science initiative for monitoring air quality. CanAirIO uses - mobile and fixed sensors to measure air quality with smartphones and - ESP32 devices. -
- -
- ESPHome
-- No-code platform for ESP devices. Uses ESP Web Tools in their - dashboard to install ESPHome on devices. -
-- Website -
+ + +How it works
++ ESP Web Tools works by combining + Web Serial, Improv Wi-Fi (optional), + and a manifest which describes the firmware. ESP Web Tools detects the + chipset of the connected ESP device and automatically selects the right + firmware variant from the manifest. +
++ Web Serial is available in Google Chrome and Microsoft Edge + browsers. Android support should be possible but has not been implemented yet. +
+ +Configuring Wi-Fi
++ ESP Web Tools supports the + Improv Wi-Fi serial standard. This is an open standard to allow configuring Wi-Fi via the serial + port. +
++ If the firmware supports Improv, a user will be asked to connect the + device to the network after installing the firmware. Once connected, the + device can send the user to a URL to finish configuration. For example, + this can be a link to the device's IP address where it serves a local + UI. +
++ At any time in the future a user can use ESP Web Tools to find the + device link or to reconfigure the Wi-Fi settings without doing a + reinstall. +
+
+ 
+ Screenshot showing the ESP Web Tools interface
+
Viewing logs & sending commands
++ ESP Web Tools allows users to open a serial console to see the logs and + send commands. +
+
+ 
+ Screenshot showing the ESP Web Tools logs & console
+
Adding ESP Web Tools to your website
To add this to your own website, you need to include the ESP Web Tools - JavaScript files on your website, create a manifest file and render the - ESP Web Tools button. + JavaScript files on your website, create a manifest file and add the ESP + Web Tools button HTML.
You can import the JavaScript files directly from the unpkg CDN or @@ -288,7 +312,8 @@ >
ESP Web Tools requires that your website is served over
- https:// to work. This is a Web Serial security limitation.
+ https:// to work. This is a Web Serial security
+ requirement.
If your manifest or the firmware files are hosted on another server,
@@ -314,7 +339,7 @@
of ESP devices. Current supported chip families are
ESP8266, ESP32, ESP32-C3 and
ESP32-S2. The correct build will be automatically selected
- based on the type of the ESP device we detect via the serial port.
+ based on the type of the connected ESP device.
{
@@ -370,33 +395,6 @@
new_install_improv_wait_time to the number of seconds to
wait. Set to 0 to disable Improv Serial detection.
- Configuring Wi-Fi
-
- ESP Web Tools supports the
- Improv Wi-Fi serial standard. This is an open standard to allow configuring Wi-Fi via the serial
- port.
-
-
- If the firmware supports Improv, a user will be asked to connect the
- device to the network after installing the firmware. Once connected, the
- device can send the user to a URL to finish configuration. For example,
- this can be a link to the device's IP address where it serves a local
- UI.
-
-
- At any time in the future a user can use ESP Web Tools to find the
- device link or to reconfigure the Wi-Fi settings without doing a
- reinstall.
-
-
-
- Screenshot showing the ESP Web Tools interface
-
Customizing the look and feel
@@ -437,41 +435,6 @@
</esp-web-install-button>
- Viewing logs & sending commands
-- ESP Web Tools allows users to open a serial console to see the logs and - send commands. -
-
-
- Screenshot showing the ESP Web Tools logs & console
-
USB Serial Drivers
-- If the serial port is not showing up, your computer might be missing the - drivers for the USB serial chip used in your ESP device. These drivers - work for most ESP devices: -
-