Tasmota/README.md

131 lines
7.5 KiB
Markdown
Raw Normal View History

2018-03-18 02:38:15 +00:00
# Sonoff-Tasmota (KNX_MOD)
2018-03-17 18:37:43 +00:00
2018-03-18 02:49:49 +00:00
This is a [MOD](https://github.com/ascillato/Sonoff-Tasmota_KNX) for Sonoff-Tasmota to integrate KNX Protocol to its features.
2018-03-18 02:38:15 +00:00
2018-03-18 02:49:49 +00:00
This MOD requires the KNX Library [ascillato/ESP-KNX-IP_Lite](https://github.com/ascillato/ESP-KNX-IP_Lite)
2018-03-18 02:38:15 +00:00
2018-03-18 03:10:23 +00:00
Basic Functionality is Available. **Work in progress**.
2018-03-18 02:38:15 +00:00
-----------------------------------------------------------------------------------------------------------------------------------
## Road Map ##
**For Sonoff-Tasmota_KNX:**
- [x] Add Web Menu (uses the one provided by the library)
- [x] Add Feature to Receive telegrams and modify Relay Status
- [x] Add Feature to Receive telegrams from multiple Group Addresses to modify just one relay status (useful for scenes)
- [x] Add Feature to Send telegrams of relay status change
- [ ] Add Feature to Send telegrams of one relay status to multiple Group Addresses (useful for scenes)
- [x] Add Feature to Send telegrams of button pressed
- [x] Add Feature to receive telegrams to toggle relay status
2018-03-18 04:08:40 +00:00
- [ ] Add Feature to read Temperature from Tasmota
- [x] Add Feature to send Temperature by a set interval
- [x] Add Feature to receive command to read temperature
2018-03-18 22:32:22 +00:00
- [ ] Add Feature to recognize Tasmota config to show the same amount of relays, buttons, etc
2018-03-18 02:38:15 +00:00
- [ ] Add Feature to Save Config
- [ ] Add Feature to Load Config
- [ ] Change Web Menu to a Tasmota one to save FLASH and RAM
2018-03-18 02:57:19 +00:00
- [ ] Complete all the language files with keys
2018-03-18 02:38:15 +00:00
- [ ] Optimize code to reduce Flash and RAM
2018-03-18 02:49:49 +00:00
**For ESP_KNX_IP_LITE:**
2018-03-18 02:38:15 +00:00
- [x] Add Functions to control library from code and not only by Web Menu
- [ ] Complete needed functions for Tasmota
- [ ] Add WebUI Functions
- [ ] Change all *_id_t to config_id_t so as to have control over webpage order
- [ ] Mod GA_Register function to be similar to CB_Register (needed for Send telegrams of one relay status to multiple Group Addresses)
- [ ] Optimize code to reduce Flash and RAM
2018-03-17 18:37:43 +00:00
2018-03-18 02:49:49 +00:00
-----------------------------------------------------------------------------------------------------------------------------------
## Modifications to [Original Tasmota](https://github.com/arendst/Sonoff-Tasmota) ##
* Adding the file _/sonoff/xdrv_08_KNX.ino_
* Add the entry `#define USE_KNX` on _/sonoff/user_config.h_
* Add entries to the file _/sonoff/webserver.ino_
* Add entries to the file _/sonoff/sonoff.ino_
* Add entries to language files
Up to now, enabling KNX uses +14.7k of code
2018-03-17 18:37:43 +00:00
2018-03-18 02:55:06 +00:00
There is **NO CONFLICT** with MQTT, Home Assistant, Web, etc. Tests show fast response of all features running at same time.
2018-03-17 18:37:43 +00:00
-----------------------------------------------------------------------------------------------------------------------------------
2018-03-18 22:27:39 +00:00
## Contributors to this Project ##
* Adrian Scillato [ascillato](https://github.com/ascillato)
* Sisamiwe [sisamiwe](https://github.com/sisamiwe) - Thanks for the guide on using KNX.
* Nico Weichbrodt [envy](https://github.com/envy) - Thanks for the patience and help with the modifications to ESP_KNX_IP.
-----------------------------------------------------------------------------------------------------------------------------------
2018-03-17 18:33:57 +00:00
## Sonoff-Tasmota
2017-08-08 15:08:08 +01:00
Provide ESP8266 based Sonoff by [iTead Studio](https://www.itead.cc/) and ElectroDragon IoT Relay with Serial, Web and MQTT control allowing 'Over the Air' or OTA firmware updates using Arduino IDE.
Current version is **5.12.0h** - 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
### ATTENTION All versions
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.
2017-09-08 10:21:54 +01:00
### ATTENTION Version 5 and up
2017-08-08 15:08:08 +01:00
2017-09-08 10:21:54 +01:00
These versions use a new linker script to free flash memory for future code additions. It moves the settings from Spiffs to Eeprom. If you compile your own firmware download the new linker to your IDE or Platformio base folder. See [Wiki > Prerequisite](https://github.com/arendst/Sonoff-Tasmota/wiki/Prerequisite).
2017-08-08 15:08:08 +01:00
Best practice to implement is:
- Open the webpage to your device
- Perform option ``Backup Configuration``
- Upgrade new firmware using ``Firmware upgrade``
- If configuration conversion fails keep the webpage open and perform ``Restore Configuration``
You should now have a device with 32k more code memory to play with.
### 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:
- [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)
- [iTead Sonoff Dual (R2)](https://www.itead.cc/smart-home/sonoff-dual.html)
- [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)
- [Sonoff S22 Smart Socket](https://github.com/arendst/Sonoff-Tasmota/issues/627)
- [iTead Sonoff S31 Smart Socket with Energy Monitoring](https://www.itead.cc/sonoff-s31.html)
- [iTead Slampher](https://www.itead.cc/slampher.html)
- [iTead Sonoff Touch](https://www.itead.cc/sonoff-touch.html)
- [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/)
- 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/)
- Wemos D1 mini, NodeMcu and Ledunia
2017-09-08 10:07:04 +01:00
### License
2018-03-07 22:35:16 +00:00
This program is licensed under GPL-3.0