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
Что это такое?Tasmota — это open-source альтернативная прошивка для умных устройств на базе ESP8266 и ESP32. Она добавляет веб-интерфейс, OTA-обновления, автоматизацию с таймерами и правилами, а также полностью локальное управление через MQTT, HTTP, Serial или KNX.
То есть она работает на самом умном устройстве, а не на моём компьютере?Да — она заменяет заводскую прошивку на чипе ESP внутри устройства. Компьютер нужен только для прошивки или сборки; проект написан под PlatformIO.
Как установить её на устройство?Проще всего через Tasmota WebInstaller — он прошивает устройство прямо из браузера. Также можно скачать готовые бинарники и прошить их по инструкции по установке или собрать свою версию с помощью PlatformIO.
Для работы нужно облако производителя или аккаунт?Нет — устройствами управляют полностью локально через MQTT, HTTP, Serial или KNX, так что ни от какого облачного сервиса производителя они не зависят.
Что будет, если обновление пройдёт неудачно?Если OTA-обновление не удастся, придётся быть готовым перепрошить устройство через последовательный интерфейс программирования (serial). Поэтому тестируйте обновления перед установкой и всегда сначала делайте резервную копию конфигурации устройства.
Нужны ли специальные навыки или электрик, чтобы пользоваться этим безопасно?Первая прошивка по силам новичку, но устройства, работающие от сети 220 В, при неправильной установке опасны — можно получить удар током. Если не уверены, вызовите электрика, и никогда не прошивайте устройство по serial, пока оно подключено к сети.
На какие устройства её можно прошить?На устройства на базе ESP8266 и ESP32; оборудование Sonoff и Tuya упомянуто отдельно. Одно предупреждение для самостоятельных сборок: устройства на ESP8285 поддерживают только Flash Mode DOUT — другие режимы могут выглядеть так, будто устройство превратилось в «кирпич».
А если моего устройства нет в списке поддерживаемых модулей?Сначала попробуйте Templates. Если его нет и в Tasmota Device Templates Repository, можно создать свой Template — README лишь просит не просить добавить новые устройства, если только им не нужен дополнительный код для новых функций.
Оно работает с Home Assistant?Да — обнаружение Home Assistant давно является частью проекта: его начал Erik Montnemery, а поддерживают участники сообщества. Устройства Tasmota могут сами автоматически анонсировать себя в Home Assistant.
Это только для брендов Sonoff и Tuya?Нет, это просто самые известные устройства. Работать она может на любом устройстве на базе ESP8266/ESP32, а репозиторий шаблонов сообщества служит базой данных поддерживаемых устройств.
Оно поддерживает устройства Zigbee?Да, в сборках для ESP32 появилась поддержка Zigbee — заслуга Stephan Hadinger, который также улучшил эмуляцию Hue, поддержку LVGL и скриптового языка Berry.
Creator
arendst
Size
282.4 MB
Stars
24.9K
Age
9y
Commits · 90 Days