mirrors
/
Tasmota
mirror of https://github.com/arendst/Tasmota.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated Rules (markdown)

Michael Ingraham 2019-03-08 16:14:04 -05:00
parent 33d76f1b8b
commit 1b38a37e00
1 changed files with 65 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

130
Rules.md

@ -3,13 +3,13 @@ Starting with version **5.12.0l** Sonoff-Tasmota optionally provides Rules heavi
***Currently no "IF" directive or nested rules are supported***
# Summary
- [Introduction](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#introduction)
- [Rule Commands](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#rule-commands)
- [Rule Syntax](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#rule-syntax)
- [Trigger](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#trigger)
- [Command](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#command)
- [Examples](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#examples)
- [Changelog of Rules](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#changelog-of-rules)
- [Introduction](Rules#introduction)
- [Rule Commands](Rules#rule-commands)
- [Rule Syntax](Rules#rule-syntax)
- [Trigger](Rules#trigger)
- [Command](Rules#command)
- [Examples](Rules#examples)
- [Changelog of Rules](Rules#changelog-of-rules)
## Introduction
@ -17,7 +17,7 @@ Rules expand the available functionality in Sonoff-Tasmota with user flexibility
Using rules many issues can be resolved.
Adding Rules is the same as issuing [commands](https://github.com/arendst/Sonoff-Tasmota/wiki/Commands).
Adding Rules is the same as issuing [commands](Commands).
## Rule Commands
@ -190,14 +190,14 @@ Example triggers are:
- ``INA219#Current>0.100`` whenever the current drawn is more than 0.1A
- ``Energy#Power>100`` whenever the power used is more than 100W
Devices using RfReceived (Sonoff Bridge) or IrReceived are also supported based on their JSON message like:
Devices using RfReceived ([Sonoff RF Bridge](Sonoff-RF-Bridge-433)) or IrReceived are also supported based on their JSON message like:
- ``IrReceived#Data=801`` whenever an IR signal for a RC5 remote control button 1 is received (6.1.0)
- ``RfReceived#RfKey=4`` whenever the Sonoff Bridge receives a recognized Rf signal (6.1.0)
- ``RfReceived#RfKey=4`` whenever the [Sonoff RF Bridge](Sonoff-RF-Bridge-433) receives a recognized Rf signal (6.1.0)
To trigger on a sensor at TelePeriod time only you may prefix the sensor with the word ``tele-`` to distinguish it from the above shown trigger. See example 5 below.
[BackToTop](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#summary)
[BackToTop](Rules#summary)
### Command
@ -233,11 +233,11 @@ Examples:
- `on Rules#Timer=1 do Mem2 %time% endon` sets Mem2 to the current time (minutes elapsed since midnight)
- `on wifi#disconnected do var1 %timestamp% endon on wifi#connected do var2 %timestamp% endon on mqtt#connected do publish stat/[topic]/BLACKOUT {"From":"%var1%","To":"%var2%"} endon`
See example 5 [below](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#5-use-of-variables-and-tele-).
See example 5 [below](Rules#5-use-of-variables-and-tele-).
***Note Currently no ``if`` directive or nested rules are supported.***
[BackToTop](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#summary)
[BackToTop](Rules#summary)
------------------------------------------------------------------------------
@ -245,58 +245,58 @@ See example 5 [below](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#5-use
The following examples will explain some use cases.
[1. Prevent Wemos D1 mini load overcurrent](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#1-prevent-wemos-d1-mini-load-overcurrent)
[1. Prevent Wemos D1 mini load overcurrent](Rules#1-prevent-wemos-d1-mini-load-overcurrent)
[2. Execute any MQTT message when a button is pressed](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#2-execute-any-mqtt-message-when-a-button-is-pressed)
[2. Execute any MQTT message when a button is pressed](Rules#2-execute-any-mqtt-message-when-a-button-is-pressed)
[3. Execute Several Commands when a Timer Expires](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#3-execute-several-commands-when-a-timer-expires)
[3. Execute Several Commands when a Timer Expires](Rules#3-execute-several-commands-when-a-timer-expires)
[4. Usage of one-shot (once)](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#4-usage-of-one-shot-once)
[4. Usage of one-shot (once)](Rules#4-usage-of-one-shot-once)
[5. Use of Variables and tele-](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#5-use-of-variables-and-tele-)
[5. Use of Variables and tele-](Rules#5-use-of-variables-and-tele-)
[6. Use a Potentiometer](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#6-use-a-potentiometer)
[6. Use a Potentiometer](Rules#6-use-a-potentiometer)
[7. Setting Variables](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#7-setting-variables)
[7. Setting Variables](Rules#7-setting-variables)
[8. Arithmetic Commands to be used with VARs](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#8-arithmetic-commands-to-be-used-with-vars)
[8. Arithmetic Commands to be used with VARs](Rules#8-arithmetic-commands-to-be-used-with-vars)
[8.a. Sending the value of a sensor to MQTT only when a delta is reached](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#8a-sending-the-value-of-a-sensor-to-mqtt-only-when-a-delta-is-reached)
[8.a. Sending the value of a sensor to MQTT only when a delta is reached](Rules#8a-sending-the-value-of-a-sensor-to-mqtt-only-when-a-delta-is-reached)
[8.b. Adjust the value of a sensor and send it by MQTT](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#8b-adjust-the-value-of-a-sensor-and-send-it-by-mqtt)
[8.b. Adjust the value of a sensor and send it by MQTT](Rules#8b-adjust-the-value-of-a-sensor-and-send-it-by-mqtt)
[9. Simple Thermostat Example](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#9-simple-thermostat-example)
[9. Simple Thermostat Example](Rules#9-simple-thermostat-example)
[10. Simple Staircase Timer](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#10-simple-staircase-timer)
[10. Simple Staircase Timer](Rules#10-simple-staircase-timer)
[10.a. Advanced PIR rules for Staircase](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#10a-advanced-pir-rules-for-staircase)
[10.a. Advanced PIR rules for Staircase](Rules#10a-advanced-pir-rules-for-staircase)
[11. Energy Saving Smart Switch](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#11-energy-saving-smart-switch)
[11. Energy Saving Smart Switch](Rules#11-energy-saving-smart-switch)
[12. Controlling Timers Enable from a switch](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#12-controlling-timers-enable-from-a-switch)
[12. Controlling Timers Enable from a switch](Rules#12-controlling-timers-enable-from-a-switch)
[13. Toggle a Relay only when holding the button for 2 seconds](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#13-toggle-a-relay-only-when-holding-the-button-for-2-seconds)
[13. Toggle a Relay only when holding the button for 2 seconds](Rules#13-toggle-a-relay-only-when-holding-the-button-for-2-seconds)
[14. Rule to Make Sure Light is on at Night](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#14-rule-to-make-sure-light-is-on-at-night)
[14. Rule to Make Sure Light is on at Night](Rules#14-rule-to-make-sure-light-is-on-at-night)
[15. Rule to enable a PIR Sensor only at night](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#15-rule-to-enable-a-pir-sensor-only-at-night)
[15. Rule to enable a PIR Sensor only at night](Rules#15-rule-to-enable-a-pir-sensor-only-at-night)
[16. Using an external button with single press - double press and hold](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#16-using-an-external-button-with-single-press---double-press-and-hold)
[16. Using an external button with single press - double press and hold](Rules#16-using-an-external-button-with-single-press---double-press-and-hold)
[17. Rule to enable or disable doorbell relay with HTTP call](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#17-rule-to-enable-or-disable-doorbell-relay-with-http-call)
[17. Rule to enable or disable doorbell relay with HTTP call](Rules#17-rule-to-enable-or-disable-doorbell-relay-with-http-call)
[18. Rule to force automatic reconnection to MQTT server via SD DNS](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#18-rule-to-force-automatic-reconnection-to-mqtt-server-via-sd-dns)
[18. Rule to force automatic reconnection to MQTT server via SD DNS](Rules#18-rule-to-force-automatic-reconnection-to-mqtt-server-via-sd-dns)
[19. Rule to change distance to percentage](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#19-rule-to-change-distance-to-percentage)
[19. Rule to change distance to percentage](Rules#19-rule-to-change-distance-to-percentage)
[20. Rules to distinguish Switch1 and Switch2 without the use of Relay1 and Relay2](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules/#20-rules-to-distinguish-switch1-and-switch2-without-the-use-of-relay1-and-relay2)
[20. Rules to distinguish Switch1 and Switch2 without the use of Relay1 and Relay2](Rules/#20-rules-to-distinguish-switch1-and-switch2-without-the-use-of-relay1-and-relay2)
[21. Rule for receiving state of intercom doorbell (or anything that triggers your SWITCHX more than one times).](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#21-rule-for-receiving-state-of-intercom-doorbell-or-anything-that-triggers-your-switchx-more-than-one-times)
[21. Rule for receiving state of intercom doorbell (or anything that triggers your SWITCHX more than one times).](Rules#21-rule-for-receiving-state-of-intercom-doorbell-or-anything-that-triggers-your-switchx-more-than-one-times)
[22. Invoking rules using clock timer to control a luminance-triggered switch only in mornings](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#22-invoking-rules-using-clock-timer-to-control-a-luminance-triggered-switch-only-in-mornings)
[22. Invoking rules using clock timer to control a luminance-triggered switch only in mornings](Rules#22-invoking-rules-using-clock-timer-to-control-a-luminance-triggered-switch-only-in-mornings)
[BackToTop](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#summary)
[BackToTop](Rules#summary)
------------------------------------------------------------------------------
@ -318,7 +318,7 @@ Result
- When a user raises brightness to a level using more than 0.1A the rule kicks in and lowers the current by executing command ``Dimmer 10`` and changes the color to Red with command ``Color 10,0,0``.
[BackToExamples](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#examples)
[BackToExamples](Rules#examples)
------------------------------------------------------------------------------
@ -346,7 +346,7 @@ Result
- When button 1 is pressed the rule kicks in and sends a MQTT message substituting variable ``%value%`` with the button state like ``cmnd/ring2/power 2``. When button 2 is pressed a MQTT message like ``cmnd/strip1/power 2`` will be sent.
[BackToExamples](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#examples)
[BackToExamples](Rules#examples)
------------------------------------------------------------------------------
@ -369,7 +369,7 @@ Result
If you want to have blink functionality define a rule like ``on clock#Timer=5 do power 3 endon``
[BackToExamples](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#examples)
[BackToExamples](Rules#examples)
------------------------------------------------------------------------------
@ -388,7 +388,7 @@ Now the MQTT message will be sent once, and only once, while the condition is me
It meets the 'hard thermostat' requests that have been common.
[BackToExamples](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#examples)
[BackToExamples](Rules#examples)
------------------------------------------------------------------------------
@ -412,7 +412,7 @@ Result
Clever Dickies now finally have a way to send Temperatures from multiple DS18B20 to Domoticz.
[BackToExamples](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#examples)
[BackToExamples](Rules#examples)
------------------------------------------------------------------------------
@ -442,7 +442,7 @@ Result
NOTE: You might want to execute command ``SaveData 2`` to reduce flash writes ;-)
[BackToExamples](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#examples)
[BackToExamples](Rules#examples)
------------------------------------------------------------------------------
@ -507,7 +507,7 @@ Note that the following won't work:
Well at least not as you probably would expect. The var1 value used by the power1 command will be the value present before the backlog command is executed. This is so, because the rule will replace %var1% BEFORE the backlog commands are put in the backlog-log.
[BackToExamples](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#examples)
[BackToExamples](Rules#examples)
------------------------------------------------------------------------------
@ -574,7 +574,7 @@ on event#sendtemp do publish stat/sonoff/temp %var1% endon
```
[BackToExamples](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#examples)
[BackToExamples](Rules#examples)
------------------------------------------------------------------------------
@ -682,7 +682,7 @@ TIMERS:
`Rule2 on Clock#Timer=1 do mem 1 endon on Clock#Timer=2 do mem 0`
[BackToExamples](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#examples)
[BackToExamples](Rules#examples)
------------------------------------------------------------------------------
@ -706,7 +706,7 @@ TIMERS:
* After the RuleTimer1 expires the light will be switched off (if you forgot to switch it off)
[BackToExamples](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#examples)
[BackToExamples](Rules#examples)
------------------------------------------------------------------------------
#### 10.a. Advanced PIR rules for Staircase
@ -765,7 +765,7 @@ The LEDs turn off after the RuleTimer expires
* Rule3 is active on daylight and pipe the PIR signal in a power1 off signal. The LEDs stay off.
[BackToExamples](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#examples)
[BackToExamples](Rules#examples)
------------------------------------------------------------------------------
@ -789,7 +789,7 @@ Rule on switch1#state=1 do var1 100 endon on switch1#state=0 do backlog var1 0;
```
[BackToExamples](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#examples)
[BackToExamples](Rules#examples)
------------------------------------------------------------------------------
@ -808,7 +808,7 @@ Switchmode1 1 will make Switch1#state to be 1 when ON and 0 when OFF
If you don't set Switchmode1 or it is equal 0, it will only have Switch1#state=2 (toggle) and the previous rule will not work.
[BackToExamples](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#examples)
[BackToExamples](Rules#examples)
------------------------------------------------------------------------------
@ -837,7 +837,7 @@ Rule 1
`on button1#state=2 do delay endon` : Do nothing when short pressing the button1 (state = 2 means TOGGLE) <br>
`Rule 1` : To enable rules
NOTE: There is not a state number for "double press" for Buttons. It is designed that double press will toggle the relay. More information at: https://github.com/arendst/Sonoff-Tasmota/wiki/Control-other-devices
NOTE: There is not a state number for "double press" for Buttons. It is designed that double press will toggle the relay. See [Control Other Devices](control-other-devices) for more information.
In the case you do not want the double press feature you can configure your button as switch and also set the SwitchMode that fits you (like SwitchMode 5 to make it behave as a pushbutton) [SWITCH does not have double press ]
@ -852,7 +852,7 @@ Rule 1
```
[BackToExamples](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#examples)
[BackToExamples](Rules#examples)
------------------------------------------------------------------------------
@ -875,7 +875,7 @@ The previous rules are conditionals that represent the following logic:
IF %time%>%sunset DO power1 1 / IF %time%<%sunrise DO power1 1
[BackToExamples](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#examples)
[BackToExamples](Rules#examples)
------------------------------------------------------------------------------
@ -899,7 +899,7 @@ on event#checksunset>%sunset% do power1 1 endon
Rule1 1
```
[BackToExamples](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#examples)
[BackToExamples](Rules#examples)
------------------------------------------------------------------------------
@ -908,7 +908,7 @@ Rule1 1
You can have all 3 actions but only if defining your GPIO as button. In this case the double press will toggle the relay.
There is also an [option](https://github.com/arendst/Sonoff-Tasmota/wiki/Control-other-devices) to swap the actions of the **single press** and **double press**.
There is also an [option](Control-other-devices) to swap the actions of the **single press** and **double press**.
So,
@ -975,7 +975,7 @@ Rule on Switch1#State=3 do Power1 2 endon on Switch1#State=2 do Delay endon
Rule 1
```
[BackToExamples](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#examples)
[BackToExamples](Rules#examples)
------------------------------------------------------------------------------
@ -1034,7 +1034,7 @@ http://<tasmotaIP>/cm?&user=<tasmotaUsername>&password=<tasmotaPassword>&cmnd=ev
```
[BackToExamples](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#examples)
[BackToExamples](Rules#examples)
#### 18. Rule to force automatic reconnection to MQTT server via SD DNS
@ -1063,7 +1063,7 @@ mosquitto_pub -h mqtt_server.local -t "cmnd/sonoff-0657/MqttHost" -m ''
```
[BackToExamples](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#examples)
[BackToExamples](Rules#examples)
------------------------------------------------------------------------------
@ -1082,7 +1082,7 @@ on event#senddistance do backlog SCALE1 %var1%, 128, 69, 0, 100; event pubdata e
on event#pubdata do publish tele/pannrum-temp/SENSOR %var1% endon
```
[BackToExamples](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#examples)
[BackToExamples](Rules#examples)
------------------------------------------------------------------------------
@ -1128,7 +1128,7 @@ Output:
00:05:16 MQT: stat/wemos-4/RESULT = {"POWER1":"0"}
```
[BackToExamples](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#examples)
[BackToExamples](Rules#examples)
------------------------------------------------------------------------------
@ -1168,7 +1168,7 @@ description:
In this case we have lock for 60 seconds for multiple people calls or to be resistant for speaker voltage drops.
[BackToExamples](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#examples)
[BackToExamples](Rules#examples)
#### 22. Invoking Rules using Clock Timer to control a Luminance triggered switch (only in mornings)
@ -1219,7 +1219,7 @@ Rule2 1
------------------------------------------------------------------------------
[BackToTop](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#summary)
[BackToTop](Rules#summary)
##### Changelog of Rules
- 6.4.1.2
@ -1227,4 +1227,4 @@ Rule2 1
- 6.1.1.11:
- %sunset%, %sunrise% added
[BackToTop](https://github.com/arendst/Sonoff-Tasmota/wiki/Rules#summary)
[BackToTop](Rules#summary)