2019-11-08 10:01:11 +00:00
! [ Tasmota logo ] ( / tools / logo / TASMOTA_FullLogo_Vector . svg )
2017-08-08 15:08:08 +01:00
2021-04-21 15:49:58 +01:00
Alternative firmware for [ ESP8266 ] ( https : / / en . wikipedia . org / wiki / ESP8266 ) and [ ESP32 ] ( https : / / en . wikipedia . org / wiki / 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 * * .
2020-07-16 17:21:19 +01:00
_Written for PlatformIO with limited support for Arduino IDE . _
2018-04-02 21:41:04 +01:00
2021-04-30 13:06:34 +01:00
[ ! [ GitHub version ] ( https : / / img . shields . io / github / release / arendst / Tasmota . svg ) ] ( http : / / ota . tasmota . com / tasmota / release )
2019-10-27 11:04:08 +00:00
[ ! [ GitHub download ] ( https : / / img . shields . io / github / downloads / arendst / Tasmota / total . svg ) ] ( https : / / github . com / arendst / Tasmota / releases / latest )
2019-11-17 15:05:47 +00:00
[ ! [ License ] ( https : / / img . shields . io / github / license / arendst / Tasmota . svg ) ] ( LICENSE . txt )
2018-11-23 18:03:11 +00:00
[ ! [ Chat ] ( https : / / img . shields . io / discord / 479389167382691863. svg ) ] ( https : / / discord . gg / Ks2Kzd4 )
2020-09-26 22:20:55 +01:00
[ ! [ Gitpod Ready - to - Code ] ( https : / / img . shields . io / badge / Gitpod - Ready - - to - - Code - blue ? logo = gitpod ) ] ( https : / / gitpod . io / #https://github.com/arendst/Tasmota)
2018-04-02 21:41:04 +01:00
2020-07-16 17:21:19 +01:00
If you like * * Tasmota * * , give it a star , or fork it and contribute !
2018-07-02 13:49:58 +01:00
2019-10-27 11:04:08 +00:00
[ ! [ GitHub stars ] ( https : / / img . shields . io / github / stars / arendst / Tasmota . svg ? style = social & label = Star ) ] ( https : / / github . com / arendst / Tasmota / stargazers )
[ ! [ GitHub forks ] ( https : / / img . shields . io / github / forks / arendst / Tasmota . svg ? style = social & label = Fork ) ] ( https : / / github . com / arendst / Tasmota / network )
2018-07-02 13:49:58 +01:00
[ ! [ donate ] ( https : / / img . shields . io / badge / donate - PayPal - blue . svg ) ] ( https : / / paypal . me / tasmota )
2017-08-08 15:08:08 +01:00
2020-10-03 11:08:43 +01:00
See [ RELEASENOTES . md ] ( https : / / github . com / arendst / Tasmota / blob / master / RELEASENOTES . md ) for release information .
2018-10-27 10:37:42 +01:00
2021-04-30 13:06:34 +01:00
Firmware binaries can be downloaded from http : / / ota . tasmota . com / tasmota / release / or http : / / ota . tasmota . com / tasmota32 / release / for ESP32 binaries .
2018-10-27 10:37:42 +01:00
2021-08-08 15:20:49 +01:00
Easy initial installation of Tasmota can be performed using the [ Tasmota WebInstaller ] ( https : / / arendst . github . io / Tasmota - firmware / ) .
2021-07-13 10:43:50 +01:00
2019-07-06 14:15:29 +01:00
## Development
2019-11-13 10:15:24 +00:00
2021-10-24 09:48:11 +01:00
[ ! [ Dev Version ] ( https : / / img . shields . io / badge / development % 20 version - v10 .0 . x . x - blue . svg ) ] ( https : / / github . com / arendst / Tasmota )
2020-08-29 16:50:44 +01:00
[ ! [ Download Dev ] ( https : / / img . shields . io / badge / download - development - yellow . svg ) ] ( http : / / ota . tasmota . com / tasmota / )
2020-05-06 08:49:02 +01:00
[ ! [ Tasmota CI ] ( https : / / github . com / arendst / Tasmota / workflows / Tasmota % 20 CI / badge . svg ) ] ( https : / / github . com / arendst / Tasmota / actions ? query = workflow % 3 A % 22 Tasmota + CI % 22 )
[ ! [ Tasmota ESP32 CI ] ( https : / / github . com / arendst / Tasmota / workflows / Tasmota % 20 ESP32 % 20 CI / badge . svg ) ] ( https : / / github . com / arendst / Tasmota / actions ? query = workflow % 3 A % 22 Tasmota + ESP32 + CI % 22 )
2020-05-26 06:54:53 +01:00
[ ! [ Build_firmware ] ( https : / / github . com / arendst / Tasmota / workflows / Build_firmware / badge . svg ) ] ( https : / / github . com / arendst / Tasmota / actions ? query = workflow % 3 ABuild_firmware )
2018-08-28 17:13:14 +01:00
2020-10-09 15:40:10 +01:00
See [ CHANGELOG . md ] ( CHANGELOG . md ) for detailed change information .
2018-08-28 20:17:13 +01:00
2019-10-23 15:06:15 +01:00
Unless your Tasmota powered device exhibits a problem or you need to make use of a feature that is not available in the Tasmota version currently installed on your device , 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.
2019-10-07 20:15:28 +01:00
2021-04-30 13:06:34 +01:00
Every commit made to the development branch , which is compiling successfuly , 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 .
2019-10-07 20:15:28 +01:00
2019-10-23 15:06:15 +01:00
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 .
2018-04-02 21:52:24 +01:00
2019-07-06 14:15:29 +01:00
## Disclaimer
2019-11-13 10:15:24 +00:00
2018-06-11 18:42:30 +01:00
: warning : * * DANGER OF ELECTROCUTION * * : warning :
2019-11-08 11:50:01 +00:00
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 ) .
2018-06-11 18:42:30 +01:00
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.
2019-07-06 14:15:29 +01:00
## Note
2019-11-13 10:15:24 +00:00
2021-04-30 13:06:34 +01:00
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 ] ( https : / / tasmota . github . io / docs / Templates ) first . If it is not listed in the [ Tasmota Device Templates Repository ] ( http : / / templates . blakadder . com ) create your own [ Template ] ( https : / / tasmota . github . io / docs / Templates #creating-your-template).
2019-01-29 10:48:20 +00:00
2019-07-06 14:15:29 +01:00
## Quick Install
2021-04-30 13:06:34 +01:00
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 ] ( https : / / tasmota . github . io / docs / Getting - Started ) .
2017-08-08 15:08:08 +01:00
2019-07-06 14:15:29 +01:00
## Important User Compilation Information
2019-10-27 11:04:08 +00:00
If you want to compile Tasmota yourself keep in mind the following :
2017-08-08 15:08:08 +01:00
2021-04-18 15:03:30 +01:00
- For ESP8285 based devices only Flash Mode * * DOUT * * is supported . Do not use Flash Mode DIO / QIO / QOUT as it might seem to brick your device .
- For ESP8285 based devices Tasmota uses a 1 M linker script WITHOUT spiffs * * 1 M ( no SPIFFS ) * * for optimal code space .
2020-10-16 14:46:42 +01:00
- To make compile time changes to Tasmota use the ` user_config_override . h ` file . It assures keeping your custom settings when you download and compile a new version . You have to make a copy from the provided ` user_config_override_sample . h ` file and add your setting overrides .
2017-08-08 15:08:08 +01:00
2019-10-07 20:15:28 +01:00
## Configuration Information
2019-11-13 10:15:24 +00:00
2019-11-22 21:44:38 +00:00
Please refer to the installation and configuration articles in our [ documentation ] ( https : / / tasmota . github . io / docs ) .
2017-08-08 15:08:08 +01:00
2019-07-06 14:15:29 +01:00
## Migration Information
2019-11-13 10:15:24 +00:00
2020-03-29 22:28:41 +01:00
See [ wiki migration path ] ( https : / / tasmota . github . io / docs / Upgrading #migration-path) for instructions how to migrate to a major version. Pay attention to the following version breaks due to dynamic settings updates:
2018-07-02 13:49:58 +01:00
1. Migrate to * * Sonoff - Tasmota 3.9 . x * *
2. Migrate to * * Sonoff - Tasmota 4. x * *
3. Migrate to * * Sonoff - Tasmota 5.14 * *
2020-11-10 09:39:36 +00:00
4. Migrate to * * Sonoff - Tasmota 6.7 .1 * * ( http : / / ota . tasmota . com / tasmota / release - 6.7 .1 / )
5. Migrate to * * Tasmota 7.2 .0 * * ( http : / / ota . tasmota . com / tasmota / release - 7.2 .0 / )
2019-12-23 16:41:36 +00:00
2019-12-23 13:05:26 +00:00
- - - Major change in parameter storage layout - - -
2019-12-23 16:41:36 +00:00
2020-11-10 09:39:36 +00:00
6. Migrate to * * Tasmota 8.5 .1 * * ( http : / / ota . tasmota . com / tasmota / release - 8.5 .1 / )
2018-07-02 13:49:58 +01:00
2020-10-03 11:08:43 +01:00
- - - Major change in internal GPIO function representation - - -
2020-11-10 09:39:36 +00:00
7. Migrate to * * Tasmota 9.1 * * ( http : / / ota . tasmota . com / tasmota / release - 9.1 .0 / )
2020-10-03 11:08:43 +01:00
While fallback or downgrading is common practice it was never supported due to Settings additions or changes in newer releases . Starting with version * * v9 .0 .0 .1 * * the internal GPIO function representation has changed in such a way that fallback is only possible to the latest GPIO configuration before installing * * v9 .0 .0 .1 * * .
2019-07-06 14:15:29 +01:00
## Support Information
2019-11-13 10:15:24 +00:00
2019-11-08 11:50:01 +00:00
< img src = " https://user-images.githubusercontent.com/5904370/68332933-e6e5a600-00d7-11ea-885d-50395f7239a1.png " width = 150 align = " right " / >
2019-05-22 17:39:31 +01:00
2020-03-29 22:28:41 +01:00
For a database of supported devices see [ Tasmota Device Templates Repository ] ( https : / / templates . blakadder . com )
2017-08-08 15:08:08 +01:00
2019-11-29 14:22:28 +00:00
If you ' re looking for support on **Tasmota** there are some options available:
2019-12-01 12:22:23 +00:00
### Documentation
2019-11-29 14:22:28 +00:00
2021-08-08 16:13:04 +01:00
* [ Documentation Site ] ( https : / / tasmota . github . io / docs ) : For information on how to flash Tasmota , configure , use and expand it
2020-03-29 22:28:41 +01:00
* [ FAQ and Troubleshooting ] ( https : / / tasmota . github . io / docs / FAQ / ) : For information on common problems and solutions .
* [ Commands Information ] ( https : / / tasmota . github . io / docs / Commands ) : For information on all the commands supported by Tasmota .
2019-11-29 14:22:28 +00:00
2019-12-01 12:22:23 +00:00
### Support's Community
2019-11-29 14:22:28 +00:00
2020-12-18 20:54:05 +00:00
* [ Tasmota Discussions ] ( https : / / github . com / arendst / Tasmota / discussions ) : For Tasmota usage questions , Feature Requests and Projects .
* [ Tasmota Users Chat ] ( https : / / discord . gg / Ks2Kzd4 ) : For support , troubleshooting and general questions . You have better chances to get fast answers from members of the Tasmota Community .
2019-11-29 14:22:28 +00:00
* [ Search in Issues ] ( https : / / github . com / arendst / Tasmota / issues ) : You might find an answer to your question by searching current or closed issues .
2020-12-18 20:54:05 +00:00
* [ Software Problem Report ] ( https : / / github . com / arendst / Tasmota / issues / new ? template = Bug_report . md ) : For reporting problems of Tasmota Software .
2017-08-08 15:08:08 +01:00
2019-07-06 14:15:29 +01:00
## Contribute
2019-11-13 10:15:24 +00:00
2019-10-27 11:04:08 +00:00
You can contribute to Tasmota by
2020-12-18 20:54:05 +00:00
- Providing Pull Requests ( Features , Proof of Concepts , Language files or Fixes )
- Testing new released features and report issues
- Donating to acquire hardware for testing and implementing or out of gratitude
- Contributing missing [ documentation ] ( https : / / tasmota . github . io / docs ) for features and devices
2018-04-15 16:07:47 +01:00
[ ! [ donate ] ( https : / / img . shields . io / badge / donate - PayPal - blue . svg ) ] ( https : / / paypal . me / tasmota )
2019-07-06 14:15:29 +01:00
## Credits
2018-04-23 16:14:19 +01:00
2018-04-23 15:59:04 +01:00
People helping to keep the show on the road :
2018-04-23 16:18:24 +01:00
- David Lang providing initial issue resolution and code optimizations
2018-04-23 15:59:04 +01:00
- Heiko Krupp for his IRSend , HTU21 , SI70xx and Wemo / Hue emulation drivers
- Wiktor Schmidt for Travis CI implementation
- Thom Dietrich for PlatformIO optimizations
2018-04-23 16:18:24 +01:00
- Marinus van den Broek for his EspEasy groundwork
2018-04-23 15:59:04 +01:00
- Pete Ba for more user friendly energy monitor calibration
- Lobradov providing compile optimization tips
- Flexiti for his initial timer implementation
2018-06-26 16:47:10 +01:00
- reloxx13 for his [ TasmoAdmin ] ( https : / / github . com / reloxx13 / TasmoAdmin ) management tool
2018-04-23 15:59:04 +01:00
- Joachim Banzhaf for his TSL2561 library and driver
2021-03-09 18:28:06 +00:00
- Andre Thomas for providing many drivers
2018-10-27 10:37:42 +01:00
- Gijs Noorlander for his MHZ19 , SenseAir and updated PubSubClient drivers
2020-03-19 14:58:37 +00:00
- Erik Montnemery for his HomeAssistant Discovery concept and many code tuning tips
- Federico Leoni for continued HomeAssistant Discovery support
2018-04-23 15:59:04 +01:00
- Aidan Mountford for his HSB support
2018-04-23 16:18:24 +01:00
- Daniel Ztolnai for his Serial Bridge implementation
2019-05-23 16:09:20 +01:00
- Gerhard Mutz for multiple sensor & display drivers , Sunrise / Sunset , and scripting
2018-04-23 15:59:04 +01:00
- Nuno Ferreira for his HC - SR04 driver
- Adrian Scillato for his ( security ) fixes and implementing and maintaining KNX
2018-05-15 16:13:51 +01:00
- Gennaro Tortone for implementing and maintaining Eastron drivers
2018-04-23 15:59:04 +01:00
- Raymond Mouthaan for managing Wemos Wiki information
2020-01-02 14:34:17 +00:00
- Norbert Richter for his [ decode - config . py ] ( https : / / github . com / tasmota / decode - config ) tool
2019-10-23 15:06:15 +01:00
- Joel Stein , digiblur and Shantur Rathore for their Tuya research and driver
2020-03-19 14:58:37 +00:00
- Frogmore42 for providing many issue answers
- Jason2866 for platformio support and providing many issue answers
- Blakadder for managing the new document site and providing template management
2021-06-13 14:30:45 +01:00
- Stephan Hadinger for refactoring light driver , enhancing HueEmulation , LVGL , Zigbee and Berry support
2019-10-23 15:06:15 +01:00
- tmo for designing the official Tasmota logo
- Stefan Bode for his Shutter and Deep sleep drivers
2020-03-19 14:58:37 +00:00
- Jacek Ziółkowski for his [ TDM ] ( https : / / github . com / jziolkowski / tdm ) management tool and [ Tasmotizer ] ( https : / / github . com / tasmota / tasmotizer ) flashing tool
- Christian Staars for NRF24L01 and HM - 10 Bluetooth sensor support
2020-05-06 03:45:53 +01:00
- Paul Diem for UDP Group communication support
2020-04-23 07:59:10 +01:00
- Jörg Schüler - Maroldt for his initial ESP32 port
2020-05-10 22:00:57 +01:00
- Javier Arigita for his thermostat driver
2019-10-23 15:06:15 +01:00
- Many more providing Tips , Wips , Pocs , PRs and Donations
2018-04-23 15:59:04 +01:00
2019-07-06 14:15:29 +01:00
## License
2017-09-08 10:07:04 +01:00
2018-03-07 22:35:16 +00:00
This program is licensed under GPL - 3.0
