Tasmota README

The project's README from github.com/arendst/Tasmota. As one markdown file: README.md.

Tasmota logoTasmota logo

Alternative firmware for ESP8266 and ESP32 based devices with easy configuration using webUI, OTA updates, automation using timers or rules, expandability and entirely local control over MQTT, HTTP, Serial or KNX. Written for PlatformIO.

GitHub version GitHub download License Discord


In light of current events we like to support the people behind PlatformIO Project, especially Ivan Kravets, and wish them the strength to help stop the war. See platformio-is-ukrainian-project-please-help-us-stop-the-war for what you can do.


Easy install

Easy initial installation of Tasmota can be performed using the Tasmota WebInstaller.

If you like Tasmota, give it a star, or fork it and contribute!

GitHub stars GitHub forks donate

See RELEASENOTES.md for release information.

Firmware binaries can be downloaded from http://ota.tasmota.com/tasmota/release/ or http://ota.tasmota.com/tasmota32/release/ for ESP32 binaries.

Development

Dev Version Download Dev Tasmota CI Build_development

See CHANGELOG.md for detailed change information.

Unless your Tasmota powered device exhibits a problem or lacks a feature that you need, leave your device alone - it works so don’t make unnecessary changes! If the release version (i.e., the master branch) exhibits unexpected behaviour for your device and configuration, you should upgrade to the latest development version instead to see if your problem is resolved as some bugs in previous releases or development builds may already have been resolved.

Every commit made to the development branch, which is compiling successfully, will post new binary files at http://ota.tasmota.com/tasmota/ (this web address can be used for OTA updates too). It is important to note that these binaries are based on the current development codebase. These commits are tested as much as is possible and are typically quite stable. However, it is infeasible to test on the hundreds of different types of devices with all the available configuration options permitted.

Note that there is a chance, as with any upgrade, that the device may not function as expected. You must always account for the possibility that you may need to flash the device via the serial programming interface if the OTA upgrade fails. Even with the master release, you should always attempt to test the device or a similar prototype before upgrading a device which is in production or is hard to reach. And, as always, make a backup of the device configuration before beginning any firmware update.

Disclaimer

:warning: DANGER OF ELECTROCUTION :warning:

If your device connects to mains electricity (AC power) there is danger of electrocution if not installed properly. If you don't know how to install it, please call an electrician (Beware: certain countries prohibit installation without a licensed electrician present). Remember: SAFETY FIRST. It is not worth the risk to yourself, your family and your home if you don't know exactly what you are doing. Never tinker or try to flash a device using the serial programming interface while it is connected to MAINS ELECTRICITY (AC power).

We don't take any responsibility nor liability for using this software nor for the installation or any tips, advice, videos, etc. given by any member of this site or any related site.

Note

Please do not ask to add new devices unless it requires additional code for new features. If the device is not listed as a module, try using Templates first. If it is not listed in the Tasmota Device Templates Repository create your own Template.

Quick Install

Download one of the released binaries from http://ota.tasmota.com/tasmota/release/ or http://ota.tasmota.com/tasmota32/release/ and flash it to your hardware using our installation guide.

Important User Compilation Information

If you want to compile Tasmota yourself keep in mind the following:

Configuration Information

Please refer to the installation and configuration articles in our documentation.

Migration Information

See migration path for instructions how to migrate to a major version.

Do not upgrade from minimal to minimal version. It will most likely fail at some point and will require flashing via serial. If you do have to use minimal versions, always OTA to a full version of the same release before applying next minimal version.

Pay attention to the following version breaks due to dynamic settings updates:

  1. Migrate to Sonoff-Tasmota 3.9.x
  2. Migrate to Sonoff-Tasmota 4.x
  3. Migrate to Sonoff-Tasmota 5.14
  4. Migrate to Sonoff-Tasmota 6.7.1 (http://ota.tasmota.com/tasmota/release_6.7.1/sonoff.bin) - NOTICE underscore as a dash is not supported in older versions
  5. Migrate to Tasmota 7.2.0 (http://ota.tasmota.com/tasmota/release-7.2.0/tasmota.bin)

--- Major change in parameter storage layout ---

  1. Migrate to Tasmota 8.5.1 (http://ota.tasmota.com/tasmota/release-8.5.1/tasmota.bin)

--- Major change in internal GPIO function representation ---

  1. Migrate to Tasmota 9.1 (http://ota.tasmota.com/tasmota/release-9.1.0/tasmota.bin.gz)
  2. Upgrade to latest release (http://ota.tasmota.com/tasmota/release/tasmota.bin.gz)

While fallback or downgrading is common practice it was never supported due to Settings additions or changes in newer releases. Starting with release v9.1.0 Imogen the internal GPIO function representation has changed in such a way that fallback is only possible to the latest GPIO configuration before installing v9.1.0.

Support Information

For a database of supported devices see Tasmota Device Templates Repository

If you're looking for support on Tasmota there are some options available:

Documentation

Support's Community

Unofficial Community Resources

Contribute

You can contribute to Tasmota by

donate

Credits

People helping to keep the show on the road:

License

This program is licensed under GPL-3.0-only

Tasmota (arendst/Tasmota)

Searching Database…

24.9K ·GitHub
What is this?Tasmota is an open-source alternative firmware for ESP8266 and ESP32 based smart devices, adding a webUI, OTA updates, timer/rule automation and entirely local control over MQTT, HTTP, Serial or KNX.
So it runs on the smart device itself, not on my computer?Right — it replaces the stock firmware on the ESP chip inside the device. Your computer is only needed for flashing or compiling; the project is written for PlatformIO.
How do I get it onto a device?Easiest is the Tasmota WebInstaller, which flashes the firmware straight from the browser. Alternatively download released binaries and flash them per the installation guide, or compile your own build with PlatformIO.
Does it need a vendor cloud or account to work?No — devices are controlled entirely locally over MQTT, HTTP, Serial or KNX, so nothing depends on a vendor cloud service.
What happens if an update goes wrong?You must be ready to flash the device over the serial programming interface if an OTA upgrade fails, so test updates before applying them and always back up the device configuration first.
Do I need special skills or an electrician to use it safely?Initial flashing is beginner-friendly, but mains-powered devices carry electrocution danger if installed improperly — call an electrician if unsure, and never do serial flashing while the device is connected to AC power.
Which devices can it be flashed onto?ESP8266 and ESP32 based devices; Sonoff and Tuya hardware is called out explicitly. One caveat for custom builds: ESP8285 based devices only support Flash Mode DOUT, other modes may seem to brick them.
What if my device is not in the list of supported modules?Try Templates first. If it is not in the Tasmota Device Templates Repository either, you can create your own Template — the README only asks you not to request new devices unless they require additional code for new features.
Does it work with Home Assistant?Yes — Home Assistant discovery is a long-standing part of the project, started by Erik Montnemery and maintained by community contributors, so Tasmota devices can announce themselves to Home Assistant automatically.
Is it only for Sonoff and Tuya brands?No, those are just the best-known targets. Any ESP8266/ESP32 based device can run it, and the community Templates Repository serves as the database of supported devices.
Does it support Zigbee devices?Yes, ESP32 builds gained Zigbee support — credited to Stephan Hadinger, who also enhanced Hue emulation, LVGL and Berry scripting support.
Creator
arendst
Size
282 MB
Stars
24.9K
Age
9y
Commits · 90 Days