Tasmota/README.md

Sonoff-Tasmota

Alternative firmware for ESP8266 based devices like iTead Sonoff with web, timers, 'Over The Air' (OTA) firmware updates and sensors support, allowing control under Serial, HTTP, MQTT and KNX, so as to be used on Smart Home Systems. Written for Arduino IDE and PlatformIO.

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

Development:

Current version is 5.12.0m - See sonoff/_releasenotes.ino for change information.

Quick install

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.

Important User Compilation Information

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

• Only Flash Mode DOUT is supported. Do not use Flash Mode DIO / QIO / QOUT as it might seem to brick your device. See Wiki for background information.
• 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.
• 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.

Version Information

• Sonoff-Tasmota provides all (Sonoff) modules in one file and starts with module Sonoff Basic.
• 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.

See Wiki for more information.
See Community for forum and more user experience.

The following devices are supported:

• iTead Sonoff Basic
• iTead Sonoff RF
• iTead Sonoff SV
• iTead Sonoff TH10/TH16 with temperature sensor
• iTead Sonoff Dual (R2)
• iTead Sonoff Pow
• iTead Sonoff Pow R2
• iTead Sonoff 4CH
• iTead Sonoff 4CH Pro
• iTead S20 Smart Socket
• Sonoff S22 Smart Socket
• iTead Sonoff S31 Smart Socket with Energy Monitoring
• iTead Slampher
• iTead Sonoff Touch
• iTead Sonoff T1
• iTead Sonoff SC
• iTead Sonoff Led
• iTead Sonoff BN-SZ01 Ceiling Led
• iTead Sonoff B1
• iTead Sonoff RF Bridge 433
• iTead Sonoff Dev
• iTead 1 Channel Switch 5V / 12V
• iTead Motor Clockwise/Anticlockwise
• Electrodragon IoT Relay Board
• AI Light or any my9291 compatible RGBW LED bulb
• H801 PWM LED controller
• MagicHome PWM LED controller
• AriLux AL-LC01, AL-LC06 and AL-LC11 PWM LED controller
• Supla device - Espablo-inCan mod. for electrical Installation box
• Luani HVIO board
• Wemos D1 mini, NodeMcu and Ledunia

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

License

This program is licensed under GPL-3.0