Recent changes to Rules_section

Rules_section modified by Damago

Damago — Sat, 08 Nov 2014 03:05:20 -0000

--- v5
+++ v6
@@ -10,80 +10,80 @@
   * and another optional action list to be executed when the condition is evaluated as true and id was false before (i.e. the condition had just changed from false to true) (type="on-false"), 
   * and another optional action list to be executed in case when the condition was false before and had just become true (type="on-true").

-            <rule id="xxxx">
-                <condition type="...." trigger="true">
+            <rule id="xxxx">
+                <condition type="...." trigger="true">
                     .....
-                </condition>
-                <actionlist>
-                    <action ..... />
+                </condition>
+                <actionlist>
+                    <action .....=""/>
                     .....
-                </actionlist>
-                <actionlist type="on-false">
-                    <action ..... />
-                </actionlist>
-                <actionlist type="if-true">
-                    <action ..... />
-                </actionlist>
-                <actionlist type="if-false">
-                    <action ..... />
-                </actionlist>
-            </rule>
+                </actionlist>
+                <actionlist type="on-false">
+                    <action .....=""/>
+                </actionlist>
+                <actionlist type="if-true">
+                    <action .....=""/>
+                </actionlist>
+                <actionlist type="if-false">
+                    <action .....=""/>
+                </actionlist>
+            </rule>

 The rule will be evaluated whenever one of its "trigger" conditions defined within the rule's condition changes it's state. Than the rule itself is evaluated and linknx decieds which actionlist should be executed. 

 The following condition's types are available (see [Condition's_Syntax] section): 

-  * object: true if the object has the specified value (<Description> section of rule definition is purely for informative purposes 
+  * object: true if the object has the specified value (<Description> section of rule definition is purely for informative purposes 

 First sample rule: 

-            <rule id="cur_time_date">
-                <condition type="timer" trigger="true">
-                    <every>3600</every>
-                </condition>
-                <actionlist>
-                    <action type="set-value" id="cur_time" value="now" />
-                    <action type="set-value" id="cur_date" value="now" />
-                </actionlist>
-            </rule>
+            <rule id="cur_time_date">
+                <condition type="timer" trigger="true">
+                    <every>3600</every>
+                </condition>
+                <actionlist>
+                    <action type="set-value" id="cur_time" value="now"/>
+                    <action type="set-value" id="cur_date" value="now"/>
+                </actionlist>
+            </rule>

 This rule will trigger and evaluate to true every 3600 seconds. The configured actions will then send current time/date on the KNX bus. 

 Now we can have a look at a more complex timer condition: 

-            <rule id="heating_morning">
-                <condition type="and">
-                    <condition type="object" id="heating_auto" value="on" />
-                    <condition type="or">
-                        <condition type="timer" trigger="true">
-                            <at hour="6" min="30" exception="no" wdays="12345" />
-                            <until hour="8" min="0" />
-                        </condition>
-                        <condition type="timer" trigger="true">
-                            <at hour="8" min="0" wdays="67" />
-                            <until hour="12" min="0" />
-                        </condition>
-                        <condition type="timer" trigger="true">
-                            <at hour="8" min="0" exception="yes" />
-                            <until hour="12" min="0" />
-                        </condition>
-                    </condition>
-                </condition>
-                <actionlist>
-                    <action type="set-value" id="heating_kitchen" value="comfort" />
-                    <action type="set-value" id="heating_living" value="standby" />
-                    <action type="set-value" id="heating_bathroom" value="on" />
-                    <action type="set-value" id="heating_bedroom1" value="comfort" />
-                    <action type="set-value" id="heating_bedroom2" value="comfort" />
-                </actionlist>
-                <actionlist type="on-false">
-                    <action type="set-value" id="heating_kitchen" value="frost" />
-                    <action type="set-value" id="heating_living" value="frost" />
-                    <action type="set-value" id="heating_bathroom" value="off" />
-                    <action type="set-value" id="heating_bedroom1" value="frost" />
-                    <action type="set-value" id="heating_bedroom2" value="frost" />
-                </actionlist>
-            </rule>
+            <rule id="heating_morning">
+                <condition type="and">
+                    <condition type="object" id="heating_auto" value="on"/>
+                    <condition type="or">
+                        <condition type="timer" trigger="true">
+                            <at hour="6" min="30" exception="no" wdays="12345"/>
+                            <until hour="8" min="0"/>
+                        </condition>
+                        <condition type="timer" trigger="true">
+                            <at hour="8" min="0" wdays="67"/>
+                            <until hour="12" min="0"/>
+                        </condition>
+                        <condition type="timer" trigger="true">
+                            <at hour="8" min="0" exception="yes"/>
+                            <until hour="12" min="0"/>
+                        </condition>
+                    </condition>
+                </condition>
+                <actionlist>
+                    <action type="set-value" id="heating_kitchen" value="comfort"/>
+                    <action type="set-value" id="heating_living" value="standby"/>
+                    <action type="set-value" id="heating_bathroom" value="on"/>
+                    <action type="set-value" id="heating_bedroom1" value="comfort"/>
+                    <action type="set-value" id="heating_bedroom2" value="comfort"/>
+                </actionlist>
+                <actionlist type="on-false">
+                    <action type="set-value" id="heating_kitchen" value="frost"/>
+                    <action type="set-value" id="heating_living" value="frost"/>
+                    <action type="set-value" id="heating_bathroom" value="off"/>
+                    <action type="set-value" id="heating_bedroom1" value="frost"/>
+                    <action type="set-value" id="heating_bedroom2" value="frost"/>
+                </actionlist>
+            </rule>

 This rule will only execute its action lists at specific times, but if heating_auto object is "on".  
 First action list will be executed: 
@@ -98,21 +98,43 @@

 Note that the object condition on "heating_auto" has no trigger flag. This means that if "heating_auto" is turned on at 7:00 am a week day, the action list will not be executed at that time because the rule is not evaluated on change of "heating_auto"'s value. 

+Next example: tell linknx to evaluate the rule during startup:
+
+            <rule id="calculate_any_light_status" init="eval">
+              <condition type="or">
+                 <condition type="object" id="light1" value="on" trigger="true"/>
+                 <condition type="object" id="light2" value="on" trigger="true"/>
+                 <condition type="object" id="light3" value="on" trigger="true"/>
+              </condition>
+              <actionlist>
+                 <action type="set-value" id="some_light_on" value="on"/>
+              </actionlist>
+              <actionlist type="on-false">
+                 <action type="set-value" id="some_light_on" value="off"/>
+              </actionlist>
+            </rule>
+
+The same can be forced to true or false during startup:
+
+              <rule id="calculate_any_light_status" init="true">
+
+              <rule id="calculate_any_light_status" init="false">
+  
 Last example, this time with a "dim-up" action: 

-            <rule id="wakeup_alarm">
-                <condition type="and">
-                    <condition type="object" id="absence" value="off" />
-                    <condition type="object" id="wakeup_active" value="on" />
-                    <condition type="timer" trigger="true">
-                        <at hour="6" min="30" exception="no" wdays="12345" />
-                    </condition>
-                </condition>
-                <actionlist>
-                    <action type="dim-up" id="dim_value_bedroom2"
-                        start="0" stop="240" duration="1800" />
-                </actionlist>
-            </rule>
+            <rule id="wakeup_alarm">
+                <condition type="and">
+                    <condition type="object" id="absence" value="off"/>
+                    <condition type="object" id="wakeup_active" value="on"/>
+                    <condition type="timer" trigger="true">
+                        <at hour="6" min="30" exception="no" wdays="12345"/>
+                    </condition>
+                </condition>
+                <actionlist>
+                    <action type="dim-up" id="dim_value_bedroom2" +="" start="0" stop="240" duration="1800"/>
+                </actionlist>
+            </rule>

 This rule will start dimming the bedroom light progressively from 0 to 94% (=240/255) during half an hour (=1800 sec). It will only execute at 6:30 am every week day that is not flagged as an exception day, if it is activated (`wakeup_active on`) and if we are at home (`absence off`).

Rules_section modified by Anthony

Anthony — Fri, 20 Jun 2014 06:26:55 -0000

--- v4
+++ v5
@@ -5,10 +5,10 @@
 A rule is composed of:

   * one condition which has at least one defined trigger, 
-  * an (optional) action list to be executed when the condition is evaluated as true, 
-  * and another optional action list to be executed when the condition is evaluated as false, 
-  * and another optional action list to be executed when the condition is evaluated as true and id was false before (i.e. the condition had just changed from false to true), 
-  * and another optional action list to be executed in case when the condition was false before and had just become true. 
+  * an (optional) action list to be executed when the condition is evaluated as true (type="if-true"), 
+  * and another optional action list to be executed when the condition is evaluated as false (type="if-false"), 
+  * and another optional action list to be executed when the condition is evaluated as true and id was false before (i.e. the condition had just changed from false to true) (type="on-false"), 
+  * and another optional action list to be executed in case when the condition was false before and had just become true (type="on-true"). 

             <rule id="xxxx">
                 <condition type="...." trigger="true">

Rules_section modified by Damago

Damago — Fri, 20 Jun 2014 06:26:55 -0000

--- v3
+++ v4
@@ -115,3 +115,7 @@
             </rule>

 This rule will start dimming the bedroom light progressively from 0 to 94% (=240/255) during half an hour (=1800 sec). It will only execute at 6:30 am every week day that is not flagged as an exception day, if it is activated (`wakeup_active on`) and if we are at home (`absence off`). 
+
+## Rules on linknx startup
+
+Please note, that some rules will be evaluated and triggered when linknx starts up and reads the configuration file, and some will not be triggered. This can be to some extent controlled by the init=true or init=false attribute. The detailed [Linknx_rules_on_startup] page contains detailed discussion of this topic.

Rules_section modified by Damago

Damago — Fri, 20 Jun 2014 06:26:55 -0000

Rules_section modified by Damago

Damago — Fri, 20 Jun 2014 06:26:55 -0000

--- v1
+++ v2
@@ -33,21 +33,19 @@

 The following condition's types are available (see [Condition's_Syntax] section): 

-  * object: true if the object has the specified value (
-        
-                <rule id="cur_time_date">
-        
+  * object: true if the object has the specified value (<Description> section of rule definition is purely for informative purposes 
+
+First sample rule: 

-               <condition type="timer" trigger="true">
-                   <every>3600</every>
-               </condition>
-               <actionlist>
-                   <action type="set-value" id="cur_time" value="now" />
-                   <action type="set-value" id="cur_date" value="now" />
-               </actionlist>
-    
-
-</rule>
+            <rule id="cur_time_date">
+                <condition type="timer" trigger="true">
+                    <every>3600</every>
+                </condition>
+                <actionlist>
+                    <action type="set-value" id="cur_time" value="now" />
+                    <action type="set-value" id="cur_date" value="now" />
+                </actionlist>
+            </rule>

 This rule will trigger and evaluate to true every 3600 seconds. The configured actions will then send current time/date on the KNX bus.

Rules_section modified by Damago

Damago — Fri, 20 Jun 2014 06:26:54 -0000

Rules section

This page defines syntax and possible scenarios within Rules section of a linknx [Configuration] file.

A rule is composed of:

one condition which has at least one defined trigger,
an (optional) action list to be executed when the condition is evaluated as true,
and another optional action list to be executed when the condition is evaluated as false,
and another optional action list to be executed when the condition is evaluated as true and id was false before (i.e. the condition had just changed from false to true),

and another optional action list to be executed in case when the condition was false before and had just become true.

    &lt;rule id="xxxx"&gt;
        &lt;condition type="...." trigger="true"&gt;
            .....
        &lt;/condition&gt;
        &lt;actionlist&gt;
            &lt;action ..... /&gt;
            .....
        &lt;/actionlist&gt;
        &lt;actionlist type="on-false"&gt;
            &lt;action ..... /&gt;
        &lt;/actionlist&gt;
        &lt;actionlist type="if-true"&gt;
            &lt;action ..... /&gt;
        &lt;/actionlist&gt;
        &lt;actionlist type="if-false"&gt;
            &lt;action ..... /&gt;
        &lt;/actionlist&gt;
    &lt;/rule&gt;

The rule will be evaluated whenever one of its "trigger" conditions defined within the rule's condition changes it's state. Than the rule itself is evaluated and linknx decieds which actionlist should be executed.

The following condition's types are available (see [Condition's_Syntax] section):

object: true if the object has the specified value (

        &lt;rule id="cur_time_date"&gt;

       &lt;condition type="timer" trigger="true"&gt;
           &lt;every&gt;3600&lt;/every&gt;
       &lt;/condition&gt;
       &lt;actionlist&gt;
           &lt;action type="set-value" id="cur_time" value="now" /&gt;
           &lt;action type="set-value" id="cur_date" value="now" /&gt;
       &lt;/actionlist&gt;

</rule>

This rule will trigger and evaluate to true every 3600 seconds. The configured actions will then send current time/date on the KNX bus.

Now we can have a look at a more complex timer condition:

        &lt;rule id="heating_morning"&gt;
            &lt;condition type="and"&gt;
                &lt;condition type="object" id="heating_auto" value="on" /&gt;
                &lt;condition type="or"&gt;
                    &lt;condition type="timer" trigger="true"&gt;
                        &lt;at hour="6" min="30" exception="no" wdays="12345" /&gt;
                        &lt;until hour="8" min="0" /&gt;
                    &lt;/condition&gt;
                    &lt;condition type="timer" trigger="true"&gt;
                        &lt;at hour="8" min="0" wdays="67" /&gt;
                        &lt;until hour="12" min="0" /&gt;
                    &lt;/condition&gt;
                    &lt;condition type="timer" trigger="true"&gt;
                        &lt;at hour="8" min="0" exception="yes" /&gt;
                        &lt;until hour="12" min="0" /&gt;
                    &lt;/condition&gt;
                &lt;/condition&gt;
            &lt;/condition&gt;
            &lt;actionlist&gt;
                &lt;action type="set-value" id="heating_kitchen" value="comfort" /&gt;
                &lt;action type="set-value" id="heating_living" value="standby" /&gt;
                &lt;action type="set-value" id="heating_bathroom" value="on" /&gt;
                &lt;action type="set-value" id="heating_bedroom1" value="comfort" /&gt;
                &lt;action type="set-value" id="heating_bedroom2" value="comfort" /&gt;
            &lt;/actionlist&gt;
            &lt;actionlist type="on-false"&gt;
                &lt;action type="set-value" id="heating_kitchen" value="frost" /&gt;
                &lt;action type="set-value" id="heating_living" value="frost" /&gt;
                &lt;action type="set-value" id="heating_bathroom" value="off" /&gt;
                &lt;action type="set-value" id="heating_bedroom1" value="frost" /&gt;
                &lt;action type="set-value" id="heating_bedroom2" value="frost" /&gt;
            &lt;/actionlist&gt;
        &lt;/rule&gt;

This rule will only execute its action lists at specific times, but if heating_auto object is "on".
First action list will be executed:

At 6:30 am every week day that is not flagged as an exception day in "services" section
At 8:00 am every weekend day or day flagged as an exception day

Second action list will be executed:

At 8:00 am every week day that is not flagged as an exception day in "services" section
At 12:00 am every weekend day or day flagged as an exception day

Note that the object condition on "heating_auto" has no trigger flag. This means that if "heating_auto" is turned on at 7:00 am a week day, the action list will not be executed at that time because the rule is not evaluated on change of "heating_auto"'s value.

Last example, this time with a "dim-up" action:

        &lt;rule id="wakeup_alarm"&gt;
            &lt;condition type="and"&gt;
                &lt;condition type="object" id="absence" value="off" /&gt;
                &lt;condition type="object" id="wakeup_active" value="on" /&gt;
                &lt;condition type="timer" trigger="true"&gt;
                    &lt;at hour="6" min="30" exception="no" wdays="12345" /&gt;
                &lt;/condition&gt;
            &lt;/condition&gt;
            &lt;actionlist&gt;
                &lt;action type="dim-up" id="dim_value_bedroom2"
                    start="0" stop="240" duration="1800" /&gt;
            &lt;/actionlist&gt;
        &lt;/rule&gt;

This rule will start dimming the bedroom light progressively from 0 to 94% (=240/255) during half an hour (=1800 sec). It will only execute at 6:30 am every week day that is not flagged as an exception day, if it is activated (wakeup_active on) and if we are at home (absence off).