I keep this version in sync with the current development of the master. Anyhow my use case is a little bit different. Even, if I have some SONOFF devices, I like to build(solder) my own based on different versions of the ESP8266, depending on my different requirements (batterie, external Antenna, add on I2C devices and others). Additionally I try to improve the overall project.
Additional features:
- DeepSleep support up to 136 Years (deepsleep=xxx [sec]). Support also 1day or more deepsleep. Just define deepsleep e.g. 1 day = 86400. (wakes up every hour for <0.3 seconds until time reached. just set deepsleep through serial or MQTT to a value in sec from 10 - 4.294.967.295 (136 Years :-))
- Improved Startuptime incl TLS MQTT and measurement in <9 sek
- Support for I2C 8-channel DIO extension board PCF-8574 (large extension to support 32 relays and pulsetimers on 8 relays (can be changed by changing constant MAX_PULSETIMER).
- Support CHIRP moisture sensor.
- Report total UPTIME (seconds) between two deepsleep cycle. This allows to see uptime, even if connect was not successfull or there was a reboot. Using RTC memory to ensure correct uptime
- Added support of "counterdevider[1..MAX_COUNTERS]" (serial and MQTT command), to count only the 1 count every counterdeviderX impulses (max 65.000 impulses = 1 count, default 1s).
- Added Support for Shutter use-Case. In this case two relays are paired into one switch. Based on the value on the first relay the second relay will set automatically. Use Setoption14 and Setoption81 to set it. See Wiki. Additionally you can define a MASK to exclude relays from the INTERLOCK behaviour.
- Added more support for the shutter Use-Case. The Setoption80 is required, if someone changes the target position if the shutter is still operating. Please see Shutter wiki for more details.
Note that deep sleep on ESP-01 is not possible without hardware modifications because it's required to connect GPIO16 to RST, see stefanbode#40. The same applies most likely to other modules like ESP-02, ESP-04 etc
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!
Current version is 6.1.1c - See sonoff/_releasenotes.ino for release information and sonoff/_changelog.ino for change information.
A Sonoff device is not a toy. It uses Mains AC so there is a danger of electrocution if not installed properly. If you don't know how to install it, please call an electrician. Remember: SAFETY FIRST. It is not worth to risk yourself, your family and your home if you don't know exactly what you are doing. Never try to flash a Sonoff device while it is connected to MAINS AC.
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.
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.
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 1M (no 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.hfile. It assures keeping your settings when you download and compile a new version. To useuser_config.override.hyou will have to make a copy of the provideduser_config.override_sample.hfile and add your setting overrides. To enable the override file you will need to use a compile define as documented in theuser_config_override_sample.hfile.
- 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
ModulesandModule. - After reboot select config menu again or use commands
GPIOsandGPIOto change GPIO with desired sensor.
See wiki migration path for instructions how to migrate to a major version. Pay attention to the following version breaks due to dynamic settings updates:
- Migrate to Sonoff-Tasmota 3.9.x
- Migrate to Sonoff-Tasmota 4.x
- Migrate to Sonoff-Tasmota 5.14
- Migrate to Sonoff-Tasmota 6.x
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 with Energy Monitoring
- iTead Sonoff Pow R2 with Energy Monitoring
- iTead Sonoff 4CH (R2)
- iTead Sonoff 4CH Pro (R2)
- iTead Sonoff S20 Smart Socket
- Sonoff S22 Smart Socket
- iTead Sonoff S26 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 iFan02
- 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
- BlitzWolf BW-SHP2 Smart Socket with Energy Monitoring
- Luani HVIO board
- Wemos D1 mini, NodeMcu and Ledunia
Different firmware images are released based on Features and Sensors selection guided by code and memory usage.
- The Minimal version allows intermediate OTA uploads to support larger versions and does NOT change any persistent parameter.
- The Classic version allows single OTA uploads as did the previous Sonoff-Tasmota versions.
| Feature or Sensor | sonoff | classic | minimal | knx | allsensors |
|---|---|---|---|---|---|
| MY_LANGUAGE en-GB | x | x | x | x | x |
| MQTT_LIBRARY_TYPE PUBSUBCLIENT | x | x | x | x | x |
| USE_DOMOTICZ | x | x | - | x | x |
| USE_HOME_ASSISTANT | x | x | - | x | x |
| USE_MQTT_TLS | - | - | - | - | - |
| USE_KNX | - | - | - | x | - |
| USE_WEBSERVER | x | x | x | x | x |
| USE_EMULATION | x | x | - | - | x |
| USE_DISCOVERY | x | x | - | x | x |
| WEBSERVER_ADVERTISE | x | x | - | x | x |
| MQTT_HOST_DISCOVERY | x | x | - | x | x |
| USE_TIMERS | x | - | - | x | x |
| USE_TIMERS_WEB | x | - | - | x | x |
| USE_SUNRISE | x | - | - | x | x |
| USE_RULES | x | - | - | x | x |
| USE_ADC_VCC | x | x | x | x | x |
| USE_DS18B20 | x | x | - | x | - |
| USE_DS18x20 | - | - | - | - | x |
| USE_DS18x20_LEGACY | - | - | - | - | - |
| USE_I2C | x | x | - | x | x |
| USE_SHT | x | x | - | x | x |
| USE_SHT3X | x | x | - | x | x |
| USE_HTU | x | x | - | x | x |
| USE_LM75AD | x | - | - | x | x |
| USE_BMP | x | x | - | x | x |
| USE_BME680 | - | - | - | - | x |
| USE_SGP30 | x | - | - | x | x |
| USE_BH1750 | x | x | - | x | x |
| USE_VEML6070 | - | - | - | - | x |
| USE_TSL2561 | - | - | - | - | x |
| USE_SI1145 | - | - | - | - | x |
| USE_ADS1115 | - | - | - | - | x |
| USE_ADS1115_I2CDEV | - | - | - | - | - |
| USE_INA219 | - | - | - | - | x |
| USE_MGS | - | - | - | - | x |
| USE_SPI | - | - | - | - | - |
| USE_MHZ19 | x | x | - | x | x |
| USE_SENSEAIR | x | - | - | x | x |
| USE_PMS5003 | x | - | - | x | x |
| USE_NOVA_SDS | x | - | - | x | x |
| USE_PZEM004T | x | - | - | x | x |
| USE_SERIAL_BRIDGE | x | - | - | x | x |
| USE_SDM120 | - | - | - | - | x |
| USE_SDM630 | - | - | - | - | x |
| USE_IR_REMOTE | x | x | - | x | x |
| USE_IR_HVAC | - | - | - | - | x |
| USE_IR_RECEIVE | x | - | - | x | x |
| USE_WS2812 | x | x | - | x | x |
| USE_WS2812_DMA | - | - | - | - | - |
| USE_ARILUX_RF | x | - | - | x | x |
| USE_SR04 | x | - | - | x | x |
| USE_RF_FLASH | x | - | - | x | x |
| ESP/Arduino library version | sonoff | classic | minimal | knx | allsensors |
|---|---|---|---|---|---|
| ESP/Arduino lib v2.3.0 | 538k | 490k | 407k | 548k | 562k |
| ESP/Arduino lib v2.4.0 | 543k | 498k | 414k | 553k | 565k |
| ESP/Arduino lib v2.4.1 | 544k | 500k | 416k | 555k | 567k |
See Tasmota ESP/Arduino library version related issues for more information.
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 implementing or out of gratitude
Libraries used with Sonoff-Tasmota are:
- ESP8266 core for Arduino
- Adafruit SGP30
- ArduinoJson
- Bosch BME680
- C2 Programmer
- Esp8266MqttClient
- esp-knx-ip
- esp-mqtt-arduino
- ESPAsyncUDP
- I2Cdevlib
- IRremoteEsp8266
- JobaTsl2561
- MultiChannelGasSensor
- NeoPixelBus
- OneWire
- PubSubClient
People helping to keep the show on the road:
- David Lang providing initial issue resolution and code optimizations
- Heiko Krupp for his IRSend, HTU21, SI70xx and Wemo/Hue emulation drivers
- Wiktor Schmidt for Travis CI implementation
- Thom Dietrich for PlatformIO optimizations
- Marinus van den Broek for his EspEasy groundwork
- Pete Ba for more user friendly energy monitor calibration
- Lobradov providing compile optimization tips
- Flexiti for his initial timer implementation
- reloxx13 for his TasmoAdmin management tool
- Joachim Banzhaf for his TSL2561 library and driver
- Gijs Noorlander for his MHZ19 and SenseAir drivers
- Emontnemery for his HomeAssistant Discovery concept and many code tuning tips
- Aidan Mountford for his HSB support
- Daniel Ztolnai for his Serial Bridge implementation
- Gerhard Mutz for his SGP30 and Sunrise/Sunset driver
- Nuno Ferreira for his HC-SR04 driver
- Adrian Scillato for his (security)fixes and implementing and maintaining KNX
- Gennaro Tortone for implementing and maintaining Eastron drivers
- Raymond Mouthaan for managing Wemos Wiki information
- Norbert Richter, Frogmore42 and Jason2866 for providing many issue answers
- Many more providing Tips, Pocs or PRs
This program is licensed under GPL-3.0