Tasmota

Mirror of arendst/Tasmota@github.com - Open-source firmware for ESP8266/8285/32-based smart home products

arduino automation esp8266 firmware iot knx mqtt ota smart-home sonoff tasmota tuya

Go to file

Theo Arends 17e4f91f47 Merge pull request #5489 from ascillato/patch-1 Hiding User Configurable Pins for SHELLY 1		2019-03-19 10:37:19 +01:00
.github	Merge pull request #5409 from ascillato/patch-2	2019-03-06 18:25:49 +01:00
api	Add program to decode some status messages	2018-05-19 17:31:55 +02:00
arduino	Delete platform.txt	2019-02-17 12:49:50 +01:00
lib	6.4.2.22 Remove support for MQTT_LIBRARY_TYPE	2019-03-15 14:29:47 +01:00
pio	Add platformio floats removal	2018-02-03 16:36:25 +01:00
sonoff	Hiding User Configurable Pins for SHELLY 1	2019-03-17 22:10:10 -03:00
tools	decode-config.py: adapt settings	2019-03-14 18:29:09 +01:00
.gitattributes	Fix xsns_26_lm75ad.ino line endings	2018-06-25 17:35:42 +02:00
.gitignore	Add new compare operators ("==", "!=" ,">=" and "<=") for rule	2019-02-05 09:34:17 -05:00
.travis.yml	Remove Travis deploy	2018-07-23 12:11:04 +02:00
API.md	Add support for sensor SCD30	2019-03-10 13:33:32 +01:00
CODE_OF_CONDUCT.md	Create CODE_OF_CONDUCT.md	2019-03-05 23:57:28 -03:00
CONTRIBUTING.md	Update CONTRIBUTING.md	2019-03-06 08:25:48 +01:00
Doxyfile	6.4.0.1 New dev release	2018-12-16 16:26:40 +01:00
LICENSE.txt	v5.1.0	2017-05-13 13:02:10 +02:00
README.md	delete arduino mqtt link	2019-03-15 14:54:49 +01:00
REFERENCE.md	Updates for release 6.4.0	2018-12-15 17:15:51 +01:00
RELEASENOTES.md	Release 6.4.1	2018-12-24 16:45:41 +01:00
SUPPORT.md	Create SUPPORT.md	2019-03-05 23:58:00 -03:00
TEMPLATE.md	Update TEMPLATE.md	2019-02-14 16:52:55 +01:00
esp8266.flash.1m0.ld	Add 1M flash with no spiffs linker script	2017-04-25 18:16:40 +02:00
platformio.ini	Workaround NeoPixelBus STAGE compile error	2019-03-15 11:25:02 +01:00
updateDocs.sh	6.4.0.1 New dev release	2018-12-16 16:26:40 +01:00

README.md

Sonoff-Tasmota

Alternative firmware for ESP8266 based devices like iTead Sonoff with web UI, rules and timers, OTA updates, custome device templates and sensors support. Allows control over MQTT, HTTP, Serial and KNX for integrations with smart home systems. Written for Arduino IDE and PlatformIO.

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

See RELEASENOTES.md for release information.

In addition to the release webpage the binaries can also be OTA downloaded from http://thehackbox.org/tasmota/release/

Development

See RELEASENOTES.md for release information and sonoff/_changelog.ino for detailed change information.

The development codebase is checked hourly for changes and if new commits have been merged and compile successfuly they will be posted at http://thehackbox.org/tasmota/ (this web address can be used for OTA too). It is important to note that these are based on the current development codebase and it is not recommended to flash it to devices used in production or which are hard to reach in the event that you need to manually flash the device if OTA failed. The last compiled commit number is also posted on the same page along with the current build status (if a firmware rebuild is in progress).

Disclaimer

⚠️ DANGER OF ELECTROCUTION ⚠️

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.

Note

Please do not ask to add devices where you can't provide a basic working configuration (other than sonoff). Since there are thousands of them..

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 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.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.

Migration Information

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: