|
1 | | - |
| 1 | +# Tasmota Documentation |
| 2 | +This is the repo for documentation of the Tasmota open source alternative firmware for ESP8266 available from https://github.com/arendst/Tasmota |
2 | 3 |
|
3 | | -Alternative firmware for [ESP8266](https://en.wikipedia.org/wiki/ESP8266) 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**. |
4 | | -_Written for Arduino IDE and PlatformIO._ |
| 4 | +## Editing Files |
5 | 5 |
|
6 | | -[](https://github.com/arendst/Tasmota/releases/latest) |
7 | | -[](https://github.com/arendst/Tasmota/releases/latest) |
8 | | -[](https://github.com/arendst/Tasmota/blob/development/LICENSE.txt) |
9 | | -[](https://discord.gg/Ks2Kzd4) |
| 6 | +Use strict markdown syntax |
10 | 7 |
|
11 | | -If you like **Tasmota**, give it a star, or fork it and contribute! |
| 8 | +## Enhancements |
| 9 | + |
| 10 | + |
| 11 | +### Disable click on zoom for an image |
| 12 | +Images support click on zoom function. If you don't want to use it: |
| 13 | +``` |
| 14 | + |
| 15 | +``` |
| 16 | +### Image resizing |
| 17 | +Due to click on zoom you can directly link to a big image but make it render smaller on the page: |
| 18 | + |
| 19 | +``` |
| 20 | + |
| 21 | + |
| 22 | +
|
| 23 | +<!-- Supports percentage --> |
| 24 | +
|
| 25 | + |
| 26 | +``` |
| 27 | + |
| 28 | +### Rendering Alert Tags |
| 29 | + |
| 30 | +Blockquotes `>` can now look even fancier: |
| 31 | + |
| 32 | +?> =`?>` |
| 33 | + |
| 34 | +!> = `!>` |
| 35 | + |
| 36 | +> [!TIP] |
| 37 | +> `> [!TIP]` |
| 38 | +
|
| 39 | +> [!DANGER] |
| 40 | +> `> [!DANGER]` |
| 41 | +
|
| 42 | +> [!NOTE] |
| 43 | +> `> [!NOTE]` |
| 44 | +
|
| 45 | +> [!EXAMPLE] |
| 46 | +> `> [!EXAMPLE]` |
| 47 | +
|
| 48 | +### Creating Tabs |
| 49 | +Tabs inside tabs are not supported. |
| 50 | + |
| 51 | +``` |
| 52 | +<!-- tabs:start --> |
| 53 | +
|
| 54 | +#### ** First Tab Title ** |
| 55 | +
|
| 56 | +Hello! |
| 57 | +
|
| 58 | +#### ** Second Tab Title ** |
| 59 | +
|
| 60 | +Bonjour! |
| 61 | +
|
| 62 | +#### ** Third Tab Title ** |
| 63 | +
|
| 64 | +Ciao! |
| 65 | +
|
| 66 | +<!-- tabs:end --> |
| 67 | +``` |
12 | 68 |
|
13 | | -[](https://github.com/arendst/Tasmota/stargazers) |
14 | | -[](https://github.com/arendst/Tasmota/network) |
15 | | -[](https://paypal.me/tasmota) |
16 | | - |
17 | | -See [RELEASENOTES.md](https://github.com/arendst/Tasmota/blob/development/RELEASENOTES.md) for release information. |
18 | | - |
19 | | -In addition to the [release webpage](https://github.com/arendst/Tasmota/releases/latest) the binaries can also be downloaded from http://thehackbox.org/tasmota/release/ |
20 | | - |
21 | | -## Development |
22 | | -[](https://github.com/arendst/Tasmota) |
23 | | -[](http://thehackbox.org/tasmota/) |
24 | | -[](https://travis-ci.org/arendst/Tasmota) |
25 | | - |
26 | | -See [tasmota/_changelog.ino](https://github.com/arendst/Tasmota/blob/development/tasmota/_changelog.ino) for detailed change information. |
27 | | - |
28 | | -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. |
29 | | - |
30 | | -The Tasmota development codebase is checked every 1-2 hours for changes. If new commits have been merged and they compile successfuly, new binary files for every variant (excluding non-English languages) will be posted at http://thehackbox.org/tasmota/ (this web address can be used for OTA updates too). The last compiled commit number is also indicated on the same page. 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. |
31 | | - |
32 | | -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. |
33 | | - |
34 | | -## Disclaimer |
35 | | -:warning: **DANGER OF ELECTROCUTION** :warning: |
36 | | - |
37 | | -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). |
38 | | - |
39 | | -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. |
40 | | - |
41 | | -## Note |
42 | | -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://github.com/arendst/Tasmota/wiki/Templates) first. If it is not listed in the [Tasmota Device Templates Repository](http://blakadder.github.io/templates) create your own [Template](https://github.com/arendst/Tasmota/wiki/Templates#creating-your-template-). |
43 | | - |
44 | | -## Quick Install |
45 | | -Download one of the released binaries from https://github.com/arendst/Tasmota/releases and flash it to your hardware as [documented in the wiki](https://github.com/arendst/Tasmota/wiki/Flashing). |
46 | | - |
47 | | -## Important User Compilation Information |
48 | | -If you want to compile Tasmota yourself keep in mind the following: |
49 | | - |
50 | | -- Only Flash Mode **DOUT** is supported. Do not use Flash Mode DIO / QIO / QOUT as it might seem to brick your device. |
51 | | -- Tasmota uses a 1M linker script WITHOUT spiffs **1M (no SPIFFS)** for optimal code space. |
52 | | -- 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. To enable the override you have to set a compile define as documented in the `user_config_override_sample.h` file. |
53 | | - |
54 | | -## Configuration Information |
55 | | -Please refer to the installation and configuration articles in the [wiki](https://github.com/arendst/Tasmota/wiki). |
56 | | - |
57 | | -## Migration Information |
58 | | -See [wiki migration path](https://github.com/arendst/Tasmota/wiki/Upgrading#migration-path) for instructions how to migrate to a major version. Pay attention to the following version breaks due to dynamic settings updates: |
59 | | - |
60 | | -1. Migrate to **Sonoff-Tasmota 3.9.x** |
61 | | -2. Migrate to **Sonoff-Tasmota 4.x** |
62 | | -3. Migrate to **Sonoff-Tasmota 5.14** |
63 | | -4. Migrate to **Sonoff-Tasmota 6.7.1** |
64 | | -5. Migrate to **Tasmota 7.x** |
65 | | - |
66 | | -## Support Information |
67 | | -<img src="https://user-images.githubusercontent.com/5904370/68332933-e6e5a600-00d7-11ea-885d-50395f7239a1.png" width=150 align="right" /> |
68 | | - |
69 | | -For a database of supported devices see [Tasmota Device Templates Repository](https://blakadder.github.io/templates) |
70 | | - |
71 | | -See [Wiki](https://github.com/arendst/Tasmota/wiki) for use instructions and how-to's.<br /> |
72 | | -See [Community](https://groups.google.com/d/forum/sonoffusers) for forum.<br /> |
73 | | -Visit [Discord Chat](https://discord.gg/Ks2Kzd4) for discussions and troubleshooting. |
74 | | - |
75 | | -## Contribute |
76 | | -You can contribute to Tasmota by |
77 | | -- providing Pull Requests (Features, Proof of Concepts, Language files or Fixes) |
78 | | -- testing new released features and report issues |
79 | | -- donating to acquire hardware for testing and implementing or out of gratitude |
80 | | -- contributing missing documentation for features and devices on our [Wiki](https://github.com/arendst/Tasmota/wiki) |
81 | | - |
82 | | -[](https://paypal.me/tasmota) |
83 | | - |
84 | | -## Credits |
85 | | - |
86 | | -### Libraries Used |
87 | | -Libraries used with Tasmota are: |
88 | | -- [ESP8266 core for Arduino](https://github.com/esp8266/Arduino) |
89 | | -- [Adafruit CCS811](https://github.com/adafruit/Adafruit_CCS811) |
90 | | -- [Adafruit ILI9341](https://github.com/adafruit/Adafruit_ILI9341) |
91 | | -- [Adafruit LED Backpack](https://github.com/adafruit/Adafruit-LED-Backpack-Library) |
92 | | -- [Adafruit MAX31865](https://github.com/adafruit/Adafruit_MAX31865) |
93 | | -- [Adafruit SGP30](https://github.com/adafruit/Adafruit_SGP30) |
94 | | -- Adafruit based SH1106 |
95 | | -- [Adafruit SSD1306](https://github.com/adafruit/Adafruit_SSD1306) |
96 | | -- Adafruit based SSD1351 |
97 | | -- [Adafruit GFX](https://github.com/adafruit/Adafruit-GFX-Library) |
98 | | -- [ArduinoJson](https://arduinojson.org/) |
99 | | -- AT24C256 I2C eeprom |
100 | | -- [Base64](https://github.com/Densaugeo/base64_arduino) |
101 | | -- [Bear SSL](https://github.com/earlephilhower/bearssl-esp8266.git) |
102 | | -- [Bosch BME680](https://github.com/BoschSensortec/BME680_driver) |
103 | | -- [C2 Programmer](http://app.cear.ufpb.br/~lucas.hartmann/tag/efm8bb1/) |
104 | | -- [esp-epaper-29-ws-20171230-gemu](https://github.com/gemu2015/Sonoff-Tasmota/tree/displays/lib) |
105 | | -- [esp-knx-ip](https://github.com/envy/esp-knx-ip) |
106 | | -- FrogmoreScd30 |
107 | | -- FT6236 |
108 | | -- [I2Cdevlib](https://github.com/jrowberg/i2cdevlib) |
109 | | -- [IRremoteEsp8266](https://github.com/markszabo/IRremoteESP8266) |
110 | | -- [JaretBurkett ILI9488](https://github.com/jaretburkett/ILI9488) |
111 | | -- [JobaTsl2561](https://github.com/joba-1/Joba_Tsl2561) |
112 | | -- [LinkedList](https://github.com/ivanseidel/LinkedList) |
113 | | -- [Liquid Cristal](https://github.com/marcoschwartz/LiquidCrystal_I2C) |
114 | | -- [MultiChannelGasSensor](http://wiki.seeedstudio.com/Grove-Multichannel_Gas_Sensor/) |
115 | | -- [NeoPixelBus](https://github.com/Makuna/NeoPixelBus) |
116 | | -- [NewPing](https://bitbucket.org/teckel12/arduino-new-ping/wiki/Home) |
117 | | -- [OneWire](https://github.com/PaulStoffregen/OneWire) |
118 | | -- [PubSubClient](https://github.com/knolleary/pubsubclient) |
119 | | -- [rc-switch](https://github.com/sui77/rc-switch) |
120 | | -- TasmotaModbus |
121 | | -- TasmotaSerial |
122 | | -- [Vl53l0x](https://github.com/pololu/vl53l0x-arduino) |
123 | | -- Xlatb Ra8876 |
124 | | - |
125 | | -### People inspiring me |
126 | | -People helping to keep the show on the road: |
127 | | -- David Lang providing initial issue resolution and code optimizations |
128 | | -- Heiko Krupp for his IRSend, HTU21, SI70xx and Wemo/Hue emulation drivers |
129 | | -- Wiktor Schmidt for Travis CI implementation |
130 | | -- Thom Dietrich for PlatformIO optimizations |
131 | | -- Marinus van den Broek for his EspEasy groundwork |
132 | | -- Pete Ba for more user friendly energy monitor calibration |
133 | | -- Lobradov providing compile optimization tips |
134 | | -- Flexiti for his initial timer implementation |
135 | | -- reloxx13 for his [TasmoAdmin](https://github.com/reloxx13/TasmoAdmin) management tool |
136 | | -- Joachim Banzhaf for his TSL2561 library and driver |
137 | | -- Gijs Noorlander for his MHZ19, SenseAir and updated PubSubClient drivers |
138 | | -- Emontnemery for his HomeAssistant Discovery concept and many code tuning tips |
139 | | -- Aidan Mountford for his HSB support |
140 | | -- Daniel Ztolnai for his Serial Bridge implementation |
141 | | -- Gerhard Mutz for multiple sensor & display drivers, Sunrise/Sunset, and scripting |
142 | | -- Nuno Ferreira for his HC-SR04 driver |
143 | | -- Adrian Scillato for his (security)fixes and implementing and maintaining KNX |
144 | | -- Gennaro Tortone for implementing and maintaining Eastron drivers |
145 | | -- Raymond Mouthaan for managing Wemos Wiki information |
146 | | -- Norbert Richter for his decode-config.py tool |
147 | | -- Andre Thomas for providing [thehackbox](http://thehackbox.org/tasmota/) OTA support and daily development builds |
148 | | -- Joel Stein, digiblur and Shantur Rathore for their Tuya research and driver |
149 | | -- Frogmore42 and Jason2866 for providing many issue answers |
150 | | -- Blakadder for editing the wiki and providing template management |
151 | | -- Stephan Hadinger for refactoring light driver, enhancing HueEmulation and Zigbee support |
152 | | -- tmo for designing the official Tasmota logo |
153 | | -- Stefan Bode for his Shutter and Deep sleep drivers |
154 | | -- Many more providing Tips, Wips, Pocs, PRs and Donations |
155 | | - |
156 | | -## License |
157 | | - |
158 | | -This program is licensed under GPL-3.0 |
0 commit comments