From d0d7e6c8234c485c03f77942b7d7f702aa60b16c Mon Sep 17 00:00:00 2001 From: Thomas Dietrich Date: Sun, 29 Jan 2017 13:26:28 +0100 Subject: [PATCH] Updated Button usage (markdown) --- Button-usage.md | 25 ++++++++++++++++--------- 1 file changed, 16 insertions(+), 9 deletions(-) diff --git a/Button-usage.md b/Button-usage.md index 67f633d0..69707c33 100644 --- a/Button-usage.md +++ b/Button-usage.md @@ -1,10 +1,17 @@ -The main button on sonoff provides the following features +The main button on a Sonoff-Tasmota flashed module provides the following functionalities: -- a short press toggles the relay either directly or by sending a MQTT message like ```cmnd/sonoff/1/light on```. This will blink the LED twice and sends a MQTT status message like ```stat/sonoff/LIGHT on```. If ```cmnd/sonoff/ButtonRetain on``` has been used the MQTT message will also contain the MQTT retain flag. -- two short presses toggles the relay. This will blink the LED twice and sends a MQTT status message like ```stat/sonoff/POWER on```. For Sonoff Dual this will switch relay 2. -- three short presses start Wifi smartconfig allowing for SSID and Password configuration using an Android mobile phone with the [ESP8266 SmartConfig](https://play.google.com/store/apps/details?id=com.cmmakerclub.iot.esptouch) app. The MQTT server still needs to be configured in the ```user_config.h``` file. The LED will blink during the config period. A single button press during this period will abort and restart sonoff. -- four short presses start Wifi manager providing an Access Point with IP address 192.168.4.1 and a web server allowing the configuration of both Wifi and MQTT parameters. The LED will blink during the config period. A single button press during this period will abort and restart sonoff. -- five short presses start Wifi Protected Setup (WPS) allowing for SSID and Password configuration using the routers WPS button or webpage. The LED will blink during the config period. A single button press during this period will abort and restart sonoff. -- six short presses will restart sonoff -- seven short presses start OTA download of firmware. The green LED is lit during the update -- pressing the button for over four seconds resets settings to defaults as defined in ```user_config.h``` and restarts the device +- **1 short press:** Toggles the relay either directly or by sending a MQTT message like ```cmnd/sonoff/1/light on```. This will blink the LED twice and sends a MQTT status message like ```stat/sonoff/LIGHT on```. If ```cmnd/sonoff/ButtonRetain on``` has been used the MQTT message will also contain the MQTT retain flag. + +- **2 short presses:** Toggles the relay. This will blink the LED twice and sends a MQTT status message like ```stat/sonoff/POWER on```. For Sonoff Dual this will switch relay 2. + +- **3 short presses:** Start Wifi smartconfig allowing for SSID and Password configuration using an Android mobile phone with the [ESP8266 SmartConfig](https://play.google.com/store/apps/details?id=com.cmmakerclub.iot.esptouch) app. The MQTT server still needs to be configured in the ```user_config.h``` file. The LED will blink during the config period. A single button press during this period will abort and restart sonoff. + +- **4 short presses:** Start Wifi manager providing an Access Point with IP address 192.168.4.1 and a web server allowing the configuration of both Wifi and MQTT parameters. The LED will blink during the config period. A single button press during this period will abort and restart sonoff. + +- **5 short presses:** Start Wifi Protected Setup (WPS) allowing for SSID and Password configuration using the routers WPS button or webpage. The LED will blink during the config period. A single button press during this period will abort and restart sonoff. + +- **6 short presses:** Will restart the module + +- **7 short presses:** Start OTA download of firmware. The green LED is lit during the update + +- **Pressing the button for over four seconds:** Reset settings to defaults as defined in ```user_config.h``` and restarts the device