2017-08-08 15:08:08 +01:00
## Sonoff-Tasmota
2018-04-14 13:39:16 +01:00
Alternative firmware for _ESP8266 based devices_ like [iTead ](https://www.itead.cc/ ) _**Sonoff**_ with **web** , **timers** , 'Over The Air' (**OTA**) firmware updates and **sensors support** , allowing control under **Serial** , **HTTP** and **MQTT** , so as to be used on **Smart Home Systems** . Written for Arduino IDE and PlatformIO.
[](https://github.com/arendst/Sonoff-Tasmota/releases/latest)
[](https://github.com/arendst/Sonoff-Tasmota/releases/latest)
[](https://github.com/arendst/Sonoff-Tasmota/blob/development/LICENSE.txt)
2018-04-15 09:18:48 +01:00
If you like **Sonoff-Tasmota** , give it a star, or fork it and contribute!
2018-04-14 13:39:16 +01:00
[](https://github.com/arendst/Sonoff-Tasmota/stargazers)
[](https://github.com/arendst/Sonoff-Tasmota/network)
### Development:
[](https://travis-ci.org/arendst/Sonoff-Tasmota)
2018-04-18 16:24:23 +01:00
Current version is **5.12.0m** - See [sonoff/_releasenotes.ino ](https://github.com/arendst/Sonoff-Tasmota/blob/development/sonoff/_releasenotes.ino ) for change information.
2017-08-08 15:08:08 +01:00
2018-04-02 10:24:36 +01:00
### Quick install
2017-08-08 15:08:08 +01:00
2018-04-02 10:31:05 +01:00
Download one of the released binaries from https://github.com/arendst/Sonoff-Tasmota/releases and flash it to your hardware as documented in the wiki.
2017-08-08 15:08:08 +01:00
2018-04-02 10:31:05 +01:00
### Important User Compilation Information
2017-08-08 15:08:08 +01:00
2018-04-02 10:31:05 +01:00
If you want to compile Sonoff-Tasmota yourself keep in mind the following:
2017-08-08 15:08:08 +01:00
2018-04-02 10:24:36 +01:00
- Only Flash Mode **DOUT** is supported. Do not use Flash Mode DIO / QIO / QOUT as it might seem to brick your device. See [Wiki ](https://github.com/arendst/Sonoff-Tasmota/wiki/Theo's-Tasmota-Tips ) for background information.
2018-04-02 10:34:49 +01:00
- Sonoff-Tasmota uses a 1M linker script WITHOUT spiffs for optimal code space. If you compile using ESP/Arduino library 2.3.0 then download the provided new linker script to your Arduino IDE or Platformio base folder. Later version of ESP/Arduino library already contain the correct linker script. See [Wiki > Prerequisite ](https://github.com/arendst/Sonoff-Tasmota/wiki/Prerequisite ).
- To make compile time changes to Sonoff-Tasmota it can use the ``user_config_override.h`` file. It assures keeping your settings when you download and compile a new version. To use ``user_config.override.h`` you will have to make a copy of the provided ``user_config.override_sample.h`` file and add your setting overrides. To enable the override file you will need to use a compile define as documented in the ``user_config_override_sample.h`` file.
2017-08-08 15:08:08 +01:00
### Version Information
2017-09-08 10:21:54 +01:00
- Sonoff-Tasmota provides all (Sonoff) modules in one file and starts with module Sonoff Basic.
2017-08-08 15:08:08 +01:00
- Once uploaded select module using the configuration webpage or the commands ```Modules``` and ```Module```.
- After reboot select config menu again or use commands ```GPIOs``` and ```GPIO``` to change GPIO with desired sensor.
< img src = "https://github.com/arendst/arendst.github.io/blob/master/media/sonoffbasic.jpg" width = "250" align = "right" / >
See [Wiki ](https://github.com/arendst/Sonoff-Tasmota/wiki ) for more information.< br />
See [Community ](https://groups.google.com/d/forum/sonoffusers ) for forum and more user experience.
The following devices are supported:
2017-11-07 14:57:24 +00:00
- [iTead Sonoff Basic ](https://www.itead.cc/smart-home/sonoff-wifi-wireless-switch-1.html )
- [iTead Sonoff RF ](https://www.itead.cc/smart-home/sonoff-rf.html )
- [iTead Sonoff SV ](https://www.itead.cc/smart-home/sonoff-sv.html )< img src = "https://github.com/arendst/arendst.github.io/blob/master/media/sonoff_th.jpg" width = "250" align = "right" />
- [iTead Sonoff TH10/TH16 with temperature sensor ](https://www.itead.cc/smart-home/sonoff-th.html )
2017-12-01 14:59:53 +00:00
- [iTead Sonoff Dual (R2) ](https://www.itead.cc/smart-home/sonoff-dual.html )
2017-11-07 14:57:24 +00:00
- [iTead Sonoff Pow ](https://www.itead.cc/smart-home/sonoff-pow.html )
- [iTead Sonoff 4CH ](https://www.itead.cc/smart-home/sonoff-4ch.html )
- [iTead Sonoff 4CH Pro ](https://www.itead.cc/smart-home/sonoff-4ch-pro.html )
- [iTead S20 Smart Socket ](https://www.itead.cc/smart-socket.html )
2017-12-28 12:43:51 +00:00
- [Sonoff S22 Smart Socket ](https://github.com/arendst/Sonoff-Tasmota/issues/627 )
2018-02-04 17:09:09 +00:00
- [iTead Sonoff S31 Smart Socket with Energy Monitoring ](https://www.itead.cc/sonoff-s31.html )
2017-11-07 14:57:24 +00:00
- [iTead Slampher ](https://www.itead.cc/slampher.html )
2017-12-01 14:59:53 +00:00
- [iTead Sonoff Touch ](https://www.itead.cc/sonoff-touch.html )
2017-11-07 14:57:24 +00:00
- [iTead Sonoff T1 ](https://www.itead.cc/sonoff-t1.html )
- [iTead Sonoff SC ](https://www.itead.cc/sonoff-sc.html )
- [iTead Sonoff Led ](https://www.itead.cc/sonoff-led.html )< img src = "https://github.com/arendst/arendst.github.io/blob/master/media/sonoff4ch.jpg" height = "250" align = "right" />
- [iTead Sonoff BN-SZ01 Ceiling Led ](https://www.itead.cc/bn-sz01.html )
- [iTead Sonoff B1 ](https://www.itead.cc/sonoff-b1.html )
- [iTead Sonoff RF Bridge 433 ](https://www.itead.cc/sonoff-rf-bridge-433.html )
2017-08-08 15:08:08 +01:00
- [iTead Sonoff Dev ](https://www.itead.cc/sonoff-dev.html )
- [iTead 1 Channel Switch 5V / 12V ](https://www.itead.cc/smart-home/inching-self-locking-wifi-wireless-switch.html )
- [iTead Motor Clockwise/Anticlockwise ](https://www.itead.cc/smart-home/motor-reversing-wifi-wireless-switch.html )
- [Electrodragon IoT Relay Board ](http://www.electrodragon.com/product/wifi-iot-relay-board-based-esp8266/ )
2017-12-28 12:43:51 +00:00
- AI Light or any my9291 compatible RGBW LED bulb
- H801 PWM LED controller
- [MagicHome PWM LED controller ](https://github.com/arendst/Sonoff-Tasmota/wiki/MagicHome-LED-strip-controller )
- AriLux AL-LC01, AL-LC06 and AL-LC11 PWM LED controller
- [Supla device - Espablo-inCan mod. for electrical Installation box ](https://forum.supla.org/viewtopic.php?f=33&t=2188 )
- [Luani HVIO board ](https://luani.de/projekte/esp8266-hvio/ )
2018-02-15 11:29:07 +00:00
- Wemos D1 mini, NodeMcu and Ledunia
2017-09-08 10:07:04 +01:00
2018-04-15 09:18:48 +01:00
### Contribute
You can contribute to Sonoff-Tasmota by
- 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 implementating or out of gratitude
[](https://paypal.me/tasmota)
2017-09-08 10:07:04 +01:00
### License
2017-09-08 11:57:08 +01:00
This program is licensed under GPL-3.0
