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 是一个开源替代固件,适用于基于 ESP8266 和 ESP32 的智能设备,提供网页界面、OTA 在线升级、定时/规则自动化,并且完全通过 MQTT、HTTP、串口或 KNX 实现本地控制。
所以它是运行在智能设备本身上,而不是我的电脑上?没错——它会替换设备内 ESP 芯片上的原厂固件。你的电脑只在刷机或编译时才需要;这个项目是为 PlatformIO 编写的。
我怎么把它装到设备上?最简单的方法是用 Tasmota WebInstaller,直接在浏览器里刷入固件。也可以下载官方发布的固件文件,按照安装指南刷入,或者用 PlatformIO 编译你自己的版本。
它需要厂商的云服务或账号才能用吗?不需要——设备完全通过 MQTT、HTTP、串口或 KNX 在本地控制,不依赖任何厂商的云服务。
如果升级出了问题怎么办?如果 OTA 升级失败,你必须准备好通过串口编程接口给设备刷机,所以在应用更新之前先测试一下,并且一定要先备份设备的配置。
我需要特殊技能或电工才能安全使用吗?初次刷机对新手很友好,但如果安装不当,市电供电的设备有触电危险——不确定的话请找电工,而且千万不要在设备接通交流电源时进行串口刷机。
哪些设备可以刷入它?基于 ESP8266 和 ESP32 的设备;文档特别点名了 Sonoff 和 Tuya 的硬件。自制固件有一个注意事项:基于 ESP8285 的设备只支持 DOUT 刷写模式,其他模式看起来可能会把设备刷坏。
如果我的设备不在支持的模块列表里怎么办?先试试 Templates(模板)。如果 Tasmota Device Templates Repository 里也没有,你可以自己创建一个 Template——README 只要求你不要再请求添加新设备,除非它们需要为新增功能编写额外的代码。
它能配合 Home Assistant 使用吗?可以——Home Assistant 自动发现是项目的老牌功能,由 Erik Montnemery 发起并由社区贡献者维护,所以 Tasmota 设备可以自动向 Home Assistant 报告自己。
它只支持 Sonoff 和 Tuya 这两个牌子吗?不是,它们只是最有名的目标设备。任何基于 ESP8266/ESP32 的设备都能运行它,社区 Templates Repository 就是支持设备清单的数据库。
它支持 Zigbee 设备吗?支持,ESP32 版本加入了 Zigbee 支持——这项贡献归功于 Stephan Hadinger,他还增强了 Hue 模拟、LVGL 和 Berry 脚本支持。
Creator
arendst
Size
282.4 MB
Stars
24.9K
Age
9y
Commits · 90 Days