PID Control

.github/ISSUE_TEMPLATE/Bug_report.md

@@ -4,16 +4,24 @@ about: Create a report to help us improve
 
 ---
 
+**IMPORTANT NOTICE**
+If you do not complete the template below it is likely that your issue will not be addressed. When providing information about your issue please be as extensive as possible so that it can be solved by as little as possible responses.
+
+**FAILURE TO COMPLETE THE REQUESTED INFORMATION WILL RESULT IN YOUR ISSUE BEING CLOSED**
+
 **Describe the bug**
 _A clear and concise description of what the bug is._
 
 
 _Also, make sure these boxes are checked [x] before submitting your issue - Thank you!_
 - [ ] _Searched the problem in issues and in the wiki_
 - [ ] _Hardware used_ : 
+- [ ] _Development/Compiler/Upload tools used_ :
+- [ ] _If a pre-compiled release or development binary was used, which one?_ :
+- [ ] _You have tried latest release or development binaries?_ :
 - [ ] _Provide the output of command_``status 0`` :
 ```
-STATUS 0 OUTPUT HERE
+STATUS 0 OUTPUT HERE - DO NOT DELETE THE MARKERS ABOVE AND BELOW THIS LINE
 ```
 
 **To Reproduce**

.github/ISSUE_TEMPLATE/Custom.md

@@ -4,13 +4,21 @@ about: Users Troubleshooting Help
 
 ---
 
+**IMPORTANT NOTICE**
+If you do not complete the template below it is likely that your issue will not be addressed. When providing information about your issue please be as extensive as possible so that it can be solved by as little as possible responses.
+
+**FAILURE TO COMPLETE THE REQUESTED INFORMATION WILL RESULT IN YOUR ISSUE BEING CLOSED**
+
 Make sure these boxes are checked [x] before submitting your issue - Thank you!
 
 - [ ] Searched the problem in issues (https://github.com/arendst/Sonoff-Tasmota/issues)
 - [ ] Searched the problem in the wiki (https://github.com/arendst/Sonoff-Tasmota/wiki/Troubleshooting)
 - [ ] Searched the problem in the forum (https://groups.google.com/d/forum/sonoffusers)
 - [ ] Searched the problem in the chat (https://discord.gg/Ks2Kzd4)
+- [ ] Development/Compiler/Upload tools used :
 - [ ] Hardware used : 
+- [ ] If a pre-compiled release or development binary was used, which one? :
+- [ ] You have tried latest release or development binaries? :
 - [ ] Provide the output of command ``status 0`` :
 ```
 STATUS 0 OUTPUT HERE

.gitignore

@@ -12,3 +12,6 @@ build
 
 ## Visual Studio Code specific ######
 .vscode
+.vscode/.browse.c_cpp.db*
+.vscode/c_cpp_properties.json
+.vscode/launch.json

API.md

@@ -0,0 +1,65 @@
+## Sonoff-Tasmota basic API information
+Sonoff-Tasmota can easily be extended by developers using provided function pointers as callback Ids. This document lists the available callback function Ids. See the wiki (https://github.com/arendst/Sonoff-Tasmota/wiki/Sensor-API) for more information.
+
+Callback availability can be checked by searching for either XdrvCall, XsnsCall, XdspCall and XnrgCall.
+
+## Driver, Sensor and Energy Callback Ids
+The following table lists Callback Ids and their availability for a Driver, Sensor or Energy service.
+
+Callback Id                 | Bool | Version  | xdrv | xsns | xnrg | Description
+----------------------------|------|----------|------|------|------|----------------------------------
+FUNC_SETTINGS_OVERRIDE      |      | 6.2.1.19 |  x   |      |      | Override start-up settings
+FUNC_MODULE_INIT            |  x   | 6.2.1.17 |  x   |      |      | Init module specific parameters
+FUNC_PRE_INIT               |      |          |  x   |      |  x   | Once GPIO have been established
+FUNC_INIT                   |      |          |  x   |  x   |  x   | At end of initialisation
+FUNC_LOOP                   |      |          |  x   |      |      | In main loop
+FUNC_EVERY_50_MSECOND       |      |          |  x   |  x   |      |
+FUNC_EVERY_100_MSECOND      |      |          |  x   |  x   |      |
+FUNC_EVERY_200_MSECOND      |      |          |      |  x   |  x   |
+FUNC_EVERY_250_MSECOND      |      |          |  x   |      |      |
+FUNC_EVERY_SECOND           |      |          |  x   |  x   |  x   |
+FUNC_PREP_BEFORE_TELEPERIOD |      |          |      |  x   |      | Deprecated. Use a FUNC_EVERY_
+FUNC_JSON_APPEND            |      |          |      |  x   |      | Extend teleperiod JSON text
+FUNC_WEB_APPEND             |      |          |      |  x   |      | Extend webgui ajax info
+FUNC_SAVE_BEFORE_RESTART    |      |          |      |  x   |      | Just before a planned restart
+FUNC_COMMAND                |  x   |          |  x   |  x   |      | When a command is not recognized
+FUNC_MQTT_SUBSCRIBE         |      | 5.12.0k  |  x   |      |      | At end of MQTT subscriptions
+FUNC_MQTT_INIT              |      | 5.12.0k  |  x   |      |      | Once at end of MQTT connection
+FUNC_MQTT_DATA              |  x   | 5.12.0k  |  x   |      |      | Before decoding command
+FUNC_SET_POWER              |      |          |  x   |      |      | Before setting relays
+FUNC_SET_DEVICE_POWER       |  x   | 6.2.1.18 |  x   |      |      | Set relay
+FUNC_SHOW_SENSOR            |      |          |  x   |      |      | When FUNC_JSON_APPEND completes
+FUNC_RULES_PROCESS          |  x   | 6.0.0    |  x   |      |      | Process specific rule
+FUNC_SERIAL                 |  x   |          |  x   |      |  x   | Process serial data
+FUNC_FREE_MEM               |      |          |  x   |      |      | Show free memory for debugging
+FUNC_BUTTON_PRESSED         |  x   | 6.2.1.18 |  x   |      |      | When a button is pressed
+FUNC_WEB_ADD_BUTTON         |      | 6.2.1.14 |  x   |  x   |      | Add a Configuration Button to GUI
+FUNC_WEB_ADD_MAIN_BUTTON    |      | 6.2.1.14 |  x   |  x   |      | Add a main button to GUI
+FUNC_WEB_ADD_HANDLER        |      | 6.2.1.14 |  x   |  x   |      | Add a webserver handler
+
+## Display Call back Ids
+The following table lists all Callback Ids for a Display service.
+
+Callback Id                   | Bool | Version  | Description
+------------------------------|------|----------|---------------------
+FUNC_DISPLAY_INIT_DRIVER      |      | 6.1.1.7  |
+FUNC_DISPLAY_INIT             |      | 6.1.1.7  |
+FUNC_DISPLAY_EVERY_50_MSECOND |      | 6.1.1.7  |
+FUNC_DISPLAY_EVERY_SECOND     |      | 6.1.1.7  |
+FUNC_DISPLAY_MODEL            |  x   | 6.1.1.7  |
+FUNC_DISPLAY_MODE             |      | 6.1.1.7  |
+FUNC_DISPLAY_POWER            |      | 6.1.1.7  |
+FUNC_DISPLAY_CLEAR            |      | 6.1.1.7  |
+FUNC_DISPLAY_DRAW_FRAME       |      | 6.1.1.7  |
+FUNC_DISPLAY_DRAW_HLINE       |      | 6.1.1.7  |
+FUNC_DISPLAY_DRAW_VLINE       |      | 6.1.1.7  |
+FUNC_DISPLAY_DRAW_LINE        |      | 6.1.1.7  |
+FUNC_DISPLAY_DRAW_CIRCLE      |      | 6.1.1.7  |
+FUNC_DISPLAY_FILL_CIRCLE      |      | 6.1.1.7  |
+FUNC_DISPLAY_DRAW_RECTANGLE   |      | 6.1.1.7  |
+FUNC_DISPLAY_FILL_RECTANGLE   |      | 6.1.1.7  |
+FUNC_DISPLAY_TEXT_SIZE        |      | 6.1.1.7  |
+FUNC_DISPLAY_FONT_SIZE        |      | 6.1.1.7  |
+FUNC_DISPLAY_ROTATION         |      | 6.1.1.7  |
+FUNC_DISPLAY_DRAW_STRING      |      | 6.1.1.7  |
+FUNC_DISPLAY_ONOFF            |      | 6.1.1.7  |

README.md

@@ -5,21 +5,26 @@ Alternative firmware for _ESP8266 based devices_ like [iTead](https://www.itead.
 [![GitHub version](https://img.shields.io/github/release/arendst/Sonoff-Tasmota.svg)](https://github.com/arendst/Sonoff-Tasmota/releases/latest)
 [![GitHub download](https://img.shields.io/github/downloads/arendst/Sonoff-Tasmota/total.svg)](https://github.com/arendst/Sonoff-Tasmota/releases/latest)
 [![License](https://img.shields.io/github/license/arendst/Sonoff-Tasmota.svg)](https://github.com/arendst/Sonoff-Tasmota/blob/development/LICENSE.txt)
+[![Chat](https://img.shields.io/discord/479389167382691863.svg)](https://discord.gg/Ks2Kzd4)
 
 If you like **Sonoff-Tasmota**, give it a star, or fork it and contribute!
 
 [![GitHub stars](https://img.shields.io/github/stars/arendst/Sonoff-Tasmota.svg?style=social&label=Star)](https://github.com/arendst/Sonoff-Tasmota/stargazers)
 [![GitHub forks](https://img.shields.io/github/forks/arendst/Sonoff-Tasmota.svg?style=social&label=Fork)](https://github.com/arendst/Sonoff-Tasmota/network)
 [![donate](https://img.shields.io/badge/donate-PayPal-blue.svg)](https://paypal.me/tasmota)
 
+See [RELEASENOTES.md](https://github.com/arendst/Sonoff-Tasmota/blob/development/RELEASENOTES.md) for release information.
+
+In addition to the [release webpage](https://github.com/arendst/Sonoff-Tasmota/releases/latest) the binaries can also be OTA downloaded from http://thehackbox.org/tasmota/release/
+
 ### Development
-[![Dev Version](https://img.shields.io/badge/development%20version-6.1.1.13-blue.svg)](https://github.com/arendst/Sonoff-Tasmota)
+[![Dev Version](https://img.shields.io/badge/development%20version-6.4.1.x-blue.svg)](https://github.com/arendst/Sonoff-Tasmota)
 [![Download Dev](https://img.shields.io/badge/download-development-yellow.svg)](http://thehackbox.org/tasmota/)
 [![Build Status](https://img.shields.io/travis/arendst/Sonoff-Tasmota.svg)](https://travis-ci.org/arendst/Sonoff-Tasmota)
 
 See [RELEASENOTES.md](https://github.com/arendst/Sonoff-Tasmota/blob/development/RELEASENOTES.md) for release information and [sonoff/_changelog.ino](https://github.com/arendst/Sonoff-Tasmota/blob/development/sonoff/_changelog.ino) for detailed change information.
 
-The compiled development versions from current codebase are built around 6AM GMT+2 everyday and posted at http://thehackbox.org/tasmota/ (this web address can be used for OTA too). Remember that these are based on the current development codebase and it is not recommended to flash devices in hard to reach places with this firmware.
+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
 :warning: **DANGER OF ELECTROCUTION** :warning:
@@ -59,7 +64,7 @@ See [Community](https://groups.google.com/d/forum/sonoffusers) for forum.<br />
 See [Chat](https://discord.gg/Ks2Kzd4) for 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 Basic (R2)](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)
@@ -90,9 +95,15 @@ The following devices are supported:
 - [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)
-- [BlitzWolf BW-SHP2 Smart Socket with Energy Monitoring](https://www.banggood.com/BlitzWolf-BW-SHP2-Smart-WIFI-Socket-EU-Plug-220V-16A-Work-with-Amazon-Alexa-Google-Assistant-p-1292899.html)
+- [BlitzWolf BW-SHP2 Smart Socket with Energy Monitoring](https://www.banggood.com/BlitzWolf-BW-SHP2-Smart-WIFI-Socket-EU-Plug-220V-16A-Work-with-Amazon-Alexa-Google-Assistant-p-1292899.html)<img src="https://github.com/arendst/arendst.github.io/blob/master/media/shelly2_small_250a.png" width="250" align="right" />
 - [Luani HVIO board](https://luani.de/projekte/esp8266-hvio/)
-- Wemos D1 mini, NodeMcu and Ledunia
+- [Wemos D1 mini](https://wiki.wemos.cc/products:d1:d1_mini)
+- [HuaFan Smart Socket](https://github.com/arendst/Sonoff-Tasmota/wiki/HuaFan-Smart-Socket)
+- [Hyleton-313 Smart Plug](https://github.com/arendst/Sonoff-Tasmota/wiki/Hyleton-313-Smart-Plug)
+- [Allterco Shelly 1](https://shelly.cloud/shelly1-open-source/)
+- [Allterco Shelly 2 with Energy Monitoring](https://shelly.cloud/shelly2/)
+- NodeMcu and Ledunia
+- [KS-602 based switches like GresaTek, Jesiya, NewRice, Lyasi etc](https://ucexperiment.wordpress.com/2017/11/14/reprogramming-a-lyasi-wifi-wall-switch-with-esp8285/)
 
 ### Contribute
 You can contribute to Sonoff-Tasmota by
@@ -108,21 +119,27 @@ You can contribute to Sonoff-Tasmota by
 Libraries used with Sonoff-Tasmota are:
 - [ESP8266 core for Arduino](https://github.com/esp8266/Arduino)
 - [Adafruit CCS811](https://github.com/adafruit/Adafruit_CCS811)
+- [Adafruit ILI9341](https://github.com/adafruit/Adafruit_ILI9341)
+- [Adafruit LED Backpack](https://github.com/adafruit/Adafruit-LED-Backpack-Library)
 - [Adafruit SGP30](https://github.com/adafruit/Adafruit_SGP30)
+- [Adafruit SSD1306](https://github.com/adafruit/Adafruit_SSD1306)
+- [Adafruit GFX](https://github.com/adafruit/Adafruit-GFX-Library)
 - [ArduinoJson](https://arduinojson.org/)
+- [arduino mqtt](https://github.com/256dpi/arduino-mqtt)
 - [Bosch BME680](https://github.com/BoschSensortec/BME680_driver)
 - [C2 Programmer](http://app.cear.ufpb.br/~lucas.hartmann/tag/efm8bb1/)
-- [Esp8266MqttClient](https://github.com/tuanpmt/ESP8266MQTTClient)
+- [esp-epaper-29-ws-20171230-gemu](https://github.com/gemu2015/Sonoff-Tasmota/tree/displays/lib)
 - [esp-knx-ip](https://github.com/envy/esp-knx-ip)
-- [esp-mqtt-arduino](https://github.com/i-n-g-o/esp-mqtt-arduino)
-- [ESPAsyncUDP](https://github.com/me-no-dev/ESPAsyncUDP)
 - [I2Cdevlib](https://github.com/jrowberg/i2cdevlib)
 - [IRremoteEsp8266](https://github.com/markszabo/IRremoteESP8266)
 - [JobaTsl2561](https://github.com/joba-1/Joba_Tsl2561)
+- [Liquid Cristal](https://github.com/marcoschwartz/LiquidCrystal_I2C)
 - [MultiChannelGasSensor](http://wiki.seeedstudio.com/Grove-Multichannel_Gas_Sensor/)
 - [NeoPixelBus](https://github.com/Makuna/NeoPixelBus)
+- [NewPing](https://bitbucket.org/teckel12/arduino-new-ping/wiki/Home)
 - [OneWire](https://github.com/PaulStoffregen/OneWire)
 - [PubSubClient](https://github.com/knolleary/pubsubclient)
+- [rc-switch](https://github.com/sui77/rc-switch)
 
 #### People inspiring me
 People helping to keep the show on the road:
@@ -136,16 +153,19 @@ People helping to keep the show on the road:
 - Flexiti for his initial timer implementation
 - reloxx13 for his [TasmoAdmin](https://github.com/reloxx13/TasmoAdmin) management tool
 - Joachim Banzhaf for his TSL2561 library and driver
-- Gijs Noorlander for his MHZ19 and SenseAir drivers
+- Gijs Noorlander for his MHZ19, SenseAir and updated PubSubClient 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
+- Gerhard Mutz for his SGP30, Sunrise/Sunset and display support drivers
 - 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
+- Norbert Richter for his decode-config.py tool
+- Andre Thomas for providing [thehackbox](http://thehackbox.org/tasmota/) OTA support and daily development builds
+- Joel Stein and digiblur for their Tuya research and driver
+- Frogmore42 and Jason2866 for providing many issue answers
 - Many more providing Tips, Pocs or PRs
 
 ### License

REFERENCE.md

@@ -0,0 +1,17 @@
+## Tasmota Reference
+Tasmota backgound information.
+
+## Supported Smart Switch with Energy Monitoring GPIO usage
+Module | GPIO00 | GPIO01 | GPIO02 | GPIO03 | GPIO04 | GPIO05 | GPIO12 | GPIO13 | GPIO14 | GPIO15
+-------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------
+Sonoff Pow  | KEY1  |  -  |  -  |  -  |  -  |  NRG_SEL  |  REL1  |  NRG_CF1  |  HLW_CF  |  LED1
+Sonoff Pow R2 |  KEY1  |  RXD  |  -  |  TXD  |  -  |  -  |  REL1  |  LED1_INV  |  -  |  -
+Shelly 2  |  -  |  RXD  |  -  |  TXD  |  REL1  |  REL2  |  SWT1  |  -  |  SWT2  |  -
+Huafan SS  |  LED1_INV  |  -  |  -  |  LED2_INV  |  KEY1  |  REL1_INV  |  NRG_CF1  |  NRG_SEL  |  HLW_CF  |  -
+KMC 70011  |  KEY1  |  -  |  -  |  -  |  HLW_CF  |  NRG_CF1  |  NRG_SEL  |  LED1_INV  |  REL1  |  -
+Teckin  |  -  |  KEY1  |  -  |  LED2_INV  |  HJL_CF  |  NRG_CF1  |  NRG_SEL_INV  |  LED1_INV  |  REL1  |  -
+AplicWDP303075  |  -  |  -  |  -  |  KEY1  |  HLW_CF  |  NRG_CF1  |  NRG_SEL_INV  |  LED1_INV  |  REL1  |  -
+Gosund SP1 v23  |  -  |  LED1_INV  |  -  |  KEY1  |  HJL_CF  |  NRG_CF1  |  NRG_SEL_INV  |  LED2_INV  |  REL1  |  -
+SK03 Outdoor  |  KEY1  |  -  |  -  |  -  |  HLW_CF  |  NRG_CF1  |  NRG_SEL_INV  |  LED2_INV  |  LED1_INV  |  REL1
+BlitzWolf SHP  |  LED2_INV  |  -  |  LED1_INV  |  -  |  -  |  HJL_CF  |  NRG_SEL_INV  |  KEY1  |  NRG_CF1  |  REL1
+Teckin US |  LED2_INV |  - |  LED1_INV |  - |  REL1 |  HJL_CF |  NRG_SEL_INV |  KEY1 |  NRG_CF1 |  -