Difference between revisions of "Rules Complete Examples"

From wiki.netio-products.com
Jump to navigation Jump to search
(Rule definition)
(18 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== NR01 - WatchDog ==
+
== NR01 - WatchDog (ping) to 1 IP address ==
 
The WatchDog functionality is used to monitor connectivity to specified IP address (or URL) by sending PING request to it.
 
The WatchDog functionality is used to monitor connectivity to specified IP address (or URL) by sending PING request to it.
  
 
The ping in this example is sent every 60s and waits 5s for the device to respond. If the ping fails, Watchdog returns <code>false</code> and restarts (ACTION: 2 = SHORT OFF) device connected to first output. After restart, it waits 120 seconds and starts monitoring again. If the device does not respond, WatchDog remains in ERROR state until next successful ping.
 
The ping in this example is sent every 60s and waits 5s for the device to respond. If the ping fails, Watchdog returns <code>false</code> and restarts (ACTION: 2 = SHORT OFF) device connected to first output. After restart, it waits 120 seconds and starts monitoring again. If the device does not respond, WatchDog remains in ERROR state until next successful ping.
  
===Watchdog definition===
+
===WatchDog definition===
  
 
WatchDog name: '''NR01_WDT'''
 
WatchDog name: '''NR01_WDT'''
Line 14: Line 14:
 
   "timeout": 5,
 
   "timeout": 5,
 
   "maxTimeouts": 0,
 
   "maxTimeouts": 0,
   "timeToReboot": 120
+
   "timeToReboot": 120,
 +
  "maxRestarts": -1
 
}</nowiki>
 
}</nowiki>
  
Line 31: Line 32:
 
}</nowiki>
 
}</nowiki>
  
== NR02 - Digital Inputs ==
+
== NR02 - Digital Inputs (Push button to Toggle Outputs 1 and 2)==
  
 
Rule is used for managing outputs in response to change of Digital Inputs (DI) state. Rule monitors state of first DI. When DI switches from OFF (0) to ON (1), Rule switches (toggles) Outputs 1 & 2 to their opposite states (ACTION 4 = TOGGLE).
 
Rule is used for managing outputs in response to change of Digital Inputs (DI) state. Rule monitors state of first DI. When DI switches from OFF (0) to ON (1), Rule switches (toggles) Outputs 1 & 2 to their opposite states (ACTION 4 = TOGGLE).
Line 50: Line 51:
 
}</nowiki>
 
}</nowiki>
  
== NR03 - Load Watchdog ==
+
== NR03 - Load Watchdog (Restart device if it's more than 2 minutes in IDLE mode ==
 
Rule monitors load (Watts) on Output 1. If the load is between 1-20W for at least 2 minutes, it restarts (ACTION 2 = SHORT OFF) the output.
 
Rule monitors load (Watts) on Output 1. If the load is between 1-20W for at least 2 minutes, it restarts (ACTION 2 = SHORT OFF) the output.
 
Example uses PAB (Power Analysis Block) functionality to determine if measured value (load in our case) lies in given range for a period of time. When it does, defined Rule triggers device restart.
 
Example uses PAB (Power Analysis Block) functionality to determine if measured value (load in our case) lies in given range for a period of time. When it does, defined Rule triggers device restart.
Line 115: Line 116:
 
}</nowiki>
 
}</nowiki>
  
== NR05 - Load Watchdog with zones ==
+
== NR05 - Load Watchdog with zones (indicate OFF / IDLE / RUN mode by switched on output)==
 
Rule monitors load (Watts) on Output 1. Measured load is then classified to several zones defined with thresholds (limit values). Depending on the zone in which the measured load is currently located, different actions can be triggered. Load value has to be between defined threshold for at least 10seconds in order to be placed to respective zone.
 
Rule monitors load (Watts) on Output 1. Measured load is then classified to several zones defined with thresholds (limit values). Depending on the zone in which the measured load is currently located, different actions can be triggered. Load value has to be between defined threshold for at least 10seconds in order to be placed to respective zone.
 
Example is composed of one PAB that classifies the zones and three Rules for 3 separate actions. Actions do the following:
 
Example is composed of one PAB that classifies the zones and three Rules for 3 separate actions. Actions do the following:
Line 150: Line 151:
 
     "OUTPUTS/2/ACTION": 1,
 
     "OUTPUTS/2/ACTION": 1,
 
     "OUTPUTS/3/ACTION": 0,
 
     "OUTPUTS/3/ACTION": 0,
     "OUTPUTS/4/ACTION": 0,
+
     "OUTPUTS/4/ACTION": 0
 
   }
 
   }
 
}</nowiki>
 
}</nowiki>
Line 159: Line 160:
 
{
 
{
 
   "conditions": {
 
   "conditions": {
     "PAB/NR05_PAB/ZONE": 0
+
     "PAB/NR05_PAB/ZONE": 1
 
   },
 
   },
 
   "actions": {
 
   "actions": {
 
     "OUTPUTS/2/ACTION": 0,
 
     "OUTPUTS/2/ACTION": 0,
 
     "OUTPUTS/3/ACTION": 1,
 
     "OUTPUTS/3/ACTION": 1,
     "OUTPUTS/4/ACTION": 0,
+
     "OUTPUTS/4/ACTION": 0
 
   }
 
   }
 
}</nowiki>
 
}</nowiki>
Line 173: Line 174:
 
{
 
{
 
   "conditions": {
 
   "conditions": {
     "PAB/NR05_PAB/ZONE": 0
+
     "PAB/NR05_PAB/ZONE": 2
 
   },
 
   },
 
   "actions": {
 
   "actions": {
 
     "OUTPUTS/2/ACTION": 0,
 
     "OUTPUTS/2/ACTION": 0,
 
     "OUTPUTS/3/ACTION": 0,
 
     "OUTPUTS/3/ACTION": 0,
     "OUTPUTS/4/ACTION": 1,
+
     "OUTPUTS/4/ACTION": 1
 
   }
 
   }
 
}</nowiki>
 
}</nowiki>
  
== NR06 - WatchDog for 2 IPs ==
+
== NR06 - WatchDog for 2 IPs (Verify IP connectivity outage with 2 IPs)==
 
The WatchDog functionality is used to monitor connectivity to specified IP address (or URL) by sending PING request to it.
 
The WatchDog functionality is used to monitor connectivity to specified IP address (or URL) by sending PING request to it.
  
Line 188: Line 189:
 
The ping for both IPs is sent every 30s and waits 5s for device to respond. There are 5 consecutive timeouts tolerated before the ping is considered as failed. When the ping fails, Watchdog returns <code>false</code> and remains in ERROR state.
 
The ping for both IPs is sent every 30s and waits 5s for device to respond. There are 5 consecutive timeouts tolerated before the ping is considered as failed. When the ping fails, Watchdog returns <code>false</code> and remains in ERROR state.
  
In case both of the defined WatchDogs are in ERORR state, the Rule is triggered which then restarts Output 1.
+
In case both of the defined WatchDogs are in ERROR state, the Rule is triggered which then restarts Output 1.
  
 
===WatchDogs definition===
 
===WatchDogs definition===
Line 199: Line 200:
 
   "pingInterval": 30,
 
   "pingInterval": 30,
 
   "timeout": 5,
 
   "timeout": 5,
   "maxTimeouts": 5
+
   "maxTimeouts": 5,
 +
  "timeToReboot": 120,
 +
  "maxRestarts": -1
 
}</nowiki>
 
}</nowiki>
  
Line 209: Line 212:
 
   "pingInterval": 60,
 
   "pingInterval": 60,
 
   "timeout": 5,
 
   "timeout": 5,
   "maxTimeouts": 5
+
   "maxTimeouts": 5,
 +
  "timeToReboot": 120,
 +
  "maxRestarts": -1
 
}</nowiki>
 
}</nowiki>
  
Line 219: Line 224:
 
{
 
{
 
   "conditions": {
 
   "conditions": {
     "operator": "AND"
+
     "operator": "AND",
     "WDT/NR06_WDT_1/FAIL": true
+
     "WDT/NR06_WDT_1/FAIL": true,
 
     "WDT/NR06_WDT_2/FAIL": true
 
     "WDT/NR06_WDT_2/FAIL": true
 
   },
 
   },
Line 254: Line 259:
 
}</nowiki>
 
}</nowiki>
  
== NR08 - Load Watchdog -> Turn ON output after period of time ==
+
== NR08 - Load Watchdog -> Turn output ON after period of time ==
 +
 
 +
In this example we want to measure load on output 1 and indicate when the power is abnormally low for a period of time by switching device on Output 2 ON (could be control light, sound alarm etc.).
 +
 
 +
In PAB we define indication for low power usage (1-20W) that is measured for period of 30 minutes (1800 seconds).
 +
In Rule we define switching Output 2 = ON (ACTION 1 = TURN ON) based on fulfilled PAB condition. This set up counts with human interaction after the Rule action gets processed. (e.g. restarting/replacing device on Output 1 and turning Output 2 OFF).
 +
It is possible to alter this behavior in such a way that the control light (Output 2) turns automatically OFF when load on Output 1 returns to standard values, i.e. higher than 20W (device gets repaired/replaced) or drops to 0W (device was removed or Output 1 turned OFF). This setup is defined in Rule '''NR08_ALT'''
  
 
===PAB definition===
 
===PAB definition===
  
PAB name: '''NR03_PAB'''
+
PAB name: '''NR08_PAB'''
 
  <nowiki>
 
  <nowiki>
 
{
 
{
Line 265: Line 276:
 
   "lowerBound": 1,
 
   "lowerBound": 1,
 
   "upperBound": 20,
 
   "upperBound": 20,
   "timeHysteresis": 120
+
   "timeHysteresis": 1800
 +
}</nowiki>
 +
 
 +
===Rule definition===
 +
 
 +
Rule name: '''NR08_RULE'''
 +
 
 +
<nowiki>
 +
{
 +
  "conditions": {
 +
    "PAB/NR08_PAB/IN": true
 +
  },
 +
  "actions": {
 +
    "OUTPUTS/2/ACTION": 1
 +
  }
 +
}</nowiki>
 +
 
 +
Rule name: '''NR08_RULE_ALT'''
 +
 
 +
<nowiki>
 +
{
 +
  "conditions": {
 +
    "PAB/NR08_PAB/IN": true
 +
  },
 +
  "actions": {
 +
    "OUTPUTS/2/ACTION": "${COND_RESULT}"
 +
  }
 
}</nowiki>
 
}</nowiki>
 +
 +
== NR09 - Digital Inputs with Schedule ==
 +
 +
Examples shows usage when we want to detect switching of Digital Input to ON state (1) but to (not) react only during specified hours (e.g. outside of working hours).
 +
Reaction hours are defined with Schedule functionality. Schedule can be defined manually or imported as a configuration file.
 +
 +
===Schedule definition===
 +
 +
Schedule name: '''NR09_SCHEDULE'''
  
 
===Rule definition===
 
===Rule definition===
  
Rule name: '''NR03_RULE'''
+
Rule name: '''NR09_RULE'''
  
 
  <nowiki>
 
  <nowiki>
 
{
 
{
 
   "conditions": {
 
   "conditions": {
     "PAB/NR03_PAB/IN": true
+
     "INPUTS/1/STATE": "on"
 +
  },
 +
  "filters": {
 +
    "SCHEDULE/NR09_SCHEDULE/ACTIVE": false
 
   },
 
   },
 
   "actions": {
 
   "actions": {
 
     "OUTPUTS/1/ACTION": 2
 
     "OUTPUTS/1/ACTION": 2
 +
  }
 +
}</nowiki>
 +
 +
== NRXX - Total load (8QS)==
 +
<nowiki>
 +
{
 +
  "type": "RANGE",
 +
  "source": "OUTPUTS/TOTAL/LOAD",
 +
  "lowerBound": 30,
 +
  "upperBound": 100,
 +
  "timeHysteresis": 3
 +
}</nowiki>
 +
 +
 +
  <nowiki>
 +
{
 +
  "conditions": {
 +
    "operator": "OR",
 +
    "PAB/total_outputs/IN": true
 +
  },
 +
  "actions": {
 +
    "OUTPUTS/1/ACTION": 4,
 +
    "CLOUD/OUTPUT/1/ALARM": 1
 +
  }
 +
}</nowiki>
 +
 +
== NRXXX - Negative load ==
 +
<nowiki>
 +
{
 +
  "type": "RANGE",
 +
  "source": "OUTPUTS/1/LOAD",
 +
  "lowerBound": -400,
 +
  "upperBound": 0,
 +
  "timeHysteresis": 2
 +
}</nowiki>
 +
 +
 +
  <nowiki>
 +
{
 +
  "conditions": {
 +
    "PAB/negative/IN": true
 +
  },
 +
  "actions": {
 +
    "OUTPUTS/3/ACTION": 4,
 +
    "OUTPUTS/4/ACTION": 4
 
   }
 
   }
 
}</nowiki>
 
}</nowiki>

Revision as of 00:06, 6 January 2022

NR01 - WatchDog (ping) to 1 IP address

The WatchDog functionality is used to monitor connectivity to specified IP address (or URL) by sending PING request to it.

The ping in this example is sent every 60s and waits 5s for the device to respond. If the ping fails, Watchdog returns false and restarts (ACTION: 2 = SHORT OFF) device connected to first output. After restart, it waits 120 seconds and starts monitoring again. If the device does not respond, WatchDog remains in ERROR state until next successful ping.

WatchDog definition

WatchDog name: NR01_WDT

{
  "target": "192.168.101.180",
  "pingInterval": 60,
  "timeout": 5,
  "maxTimeouts": 0,
  "timeToReboot": 120,
  "maxRestarts": -1
}

Rule definition

Rule name: NR01_RULE

{
  "conditions": {
    "WDT/NR01_WDT/FAIL": true
  },
  "actions": {
    "OUTPUTS/1/ACTION": 2
  }
}

NR02 - Digital Inputs (Push button to Toggle Outputs 1 and 2)

Rule is used for managing outputs in response to change of Digital Inputs (DI) state. Rule monitors state of first DI. When DI switches from OFF (0) to ON (1), Rule switches (toggles) Outputs 1 & 2 to their opposite states (ACTION 4 = TOGGLE).

Rule definition

Rule name: NR02_RULE

{
  "conditions": {
    "INPUTS/1/STATE": "on"
  },
  "actions": {
    "OUTPUTS/1/ACTION": 4,
    "OUTPUTS/2/ACTION": 4
  }
}

NR03 - Load Watchdog (Restart device if it's more than 2 minutes in IDLE mode

Rule monitors load (Watts) on Output 1. If the load is between 1-20W for at least 2 minutes, it restarts (ACTION 2 = SHORT OFF) the output. Example uses PAB (Power Analysis Block) functionality to determine if measured value (load in our case) lies in given range for a period of time. When it does, defined Rule triggers device restart.

PAB definition

PAB name: NR03_PAB

{
  "type": "RANGE",
  "source": "OUTPUTS/1/LOAD",
  "lowerBound": 1,
  "upperBound": 20,
  "timeHysteresis": 120
}

Rule definition

Rule name: NR03_RULE

{
  "conditions": {
    "PAB/NR03_PAB/IN": true
  },
  "actions": {
    "OUTPUTS/1/ACTION": 2
  }
}

NR04 - Load Watchdog with alarm to Cloud

Rule monitors load (Watts) on Output 1. If the load is between 1-20W for at least 30 minutes, it restarts (ACTION 2 = SHORT OFF) the output. In addition, it triggers an alarm in NETIO Cloud, which sends a notification to specified email address. This example needs a NETIO Cloud account with Premium version active for first output. There also has to be email notification enabled for the output.

Example uses PAB (Power Analysis Block) functionality to determine if measured value (load in our case) lies in given range for a period of time. When it does, defined Rule triggers device restart and sends alarm to Cloud.

PAB definition

PAB name: NR04_PAB

{
  "type": "RANGE",
  "source": "OUTPUTS/1/LOAD",
  "lowerBound": 1,
  "upperBound": 20,
  "timeHysteresis": 1800
}


Rule definition

Rule name: NR04_RULE

{
  "conditions": {
    "PAB/NR04_PAB/IN": true
  }
  "actions": {
    "OUTPUTS/1/ACTION": 2,
    "CLOUD/OUTPUT/1/ALARM": "${COND_RESULT}"
  }
}

NR05 - Load Watchdog with zones (indicate OFF / IDLE / RUN mode by switched on output)

Rule monitors load (Watts) on Output 1. Measured load is then classified to several zones defined with thresholds (limit values). Depending on the zone in which the measured load is currently located, different actions can be triggered. Load value has to be between defined threshold for at least 10seconds in order to be placed to respective zone. Example is composed of one PAB that classifies the zones and three Rules for 3 separate actions. Actions do the following:

  • Output 1 load lower than 1W: Output 2 = ON
  • Output 1 load between 1-20W: Output 3 = ON
  • Output 1 load between 20-200W: Output 4 = ON

PAB definition

PAB name: NR05_PAB

{
  "type": "ZONES",
  "source": "OUTPUTS/2/CURRENT",
  "thresholds": [
    1,
    20,
    200
  ],
  "timeHysteresis": 10
}

Rules definitions

Rule 1 name: NR05_RULE_1

{
  "conditions": {
    "PAB/NR05_PAB/ZONE": 0
  },
  "actions": {
    "OUTPUTS/2/ACTION": 1,
    "OUTPUTS/3/ACTION": 0,
    "OUTPUTS/4/ACTION": 0
  }
}

Rule 2 name: NR05_RULE_2

{
  "conditions": {
    "PAB/NR05_PAB/ZONE": 1
  },
  "actions": {
    "OUTPUTS/2/ACTION": 0,
    "OUTPUTS/3/ACTION": 1,
    "OUTPUTS/4/ACTION": 0
  }
}

Rule 3 name: NR05_RULE_3

{
  "conditions": {
    "PAB/NR05_PAB/ZONE": 2
  },
  "actions": {
    "OUTPUTS/2/ACTION": 0,
    "OUTPUTS/3/ACTION": 0,
    "OUTPUTS/4/ACTION": 1
  }
}

NR06 - WatchDog for 2 IPs (Verify IP connectivity outage with 2 IPs)

The WatchDog functionality is used to monitor connectivity to specified IP address (or URL) by sending PING request to it.

In this example, we monitor two IPs and we want to restart device connected to Output 1 if none of the addresses reply. The ping for both IPs is sent every 30s and waits 5s for device to respond. There are 5 consecutive timeouts tolerated before the ping is considered as failed. When the ping fails, Watchdog returns false and remains in ERROR state.

In case both of the defined WatchDogs are in ERROR state, the Rule is triggered which then restarts Output 1.

WatchDogs definition

WatchDog name: NR06_WDT_1

{
  "target": "192.168.1.51",
  "pingInterval": 30,
  "timeout": 5,
  "maxTimeouts": 5,
  "timeToReboot": 120,
  "maxRestarts": -1
}

WatchDog name: NR06_WDT_2

{
  "target": "192.168.1.52",
  "pingInterval": 60,
  "timeout": 5,
  "maxTimeouts": 5,
  "timeToReboot": 120,
  "maxRestarts": -1
}

Rule definition

Rule name: NR06_RULE

{
  "conditions": {
    "operator": "AND",
    "WDT/NR06_WDT_1/FAIL": true,
    "WDT/NR06_WDT_2/FAIL": true
  },
  "actions": {
    "OUTPUTS/1/ACTION": 2
  }
}

NR07 - Synchronized outputs states during working hours

Rule keeps track of first output state and when it changes, it switches output 2 to the same state. However, we want this synchronization only to work during working hours. We define the time with Schedule functionality and use it as a filter (mask) in Rules. Schedule can be defined manually or imported as a configuration file.

Schedule definition

Schedule name: NR07_SCHEDULE

NR070 Schedule

Rule definition

Rule name: NR07_RULE

{
  "conditions": {
    "OUTPUTS/1/STATE": "on"
  },
  "filters": {
    "SCHEDULE/NR07_SCHEDULE/ACTIVE": true
  },
  "actions": {
    "OUTPUTS/2/ACTION": "${COND_RESULT}"
  }
}

NR08 - Load Watchdog -> Turn output ON after period of time

In this example we want to measure load on output 1 and indicate when the power is abnormally low for a period of time by switching device on Output 2 ON (could be control light, sound alarm etc.).

In PAB we define indication for low power usage (1-20W) that is measured for period of 30 minutes (1800 seconds). In Rule we define switching Output 2 = ON (ACTION 1 = TURN ON) based on fulfilled PAB condition. This set up counts with human interaction after the Rule action gets processed. (e.g. restarting/replacing device on Output 1 and turning Output 2 OFF). It is possible to alter this behavior in such a way that the control light (Output 2) turns automatically OFF when load on Output 1 returns to standard values, i.e. higher than 20W (device gets repaired/replaced) or drops to 0W (device was removed or Output 1 turned OFF). This setup is defined in Rule NR08_ALT

PAB definition

PAB name: NR08_PAB

{
  "type": "RANGE",
  "source": "OUTPUTS/1/LOAD",
  "lowerBound": 1,
  "upperBound": 20,
  "timeHysteresis": 1800
}

Rule definition

Rule name: NR08_RULE

{
  "conditions": {
    "PAB/NR08_PAB/IN": true
  },
  "actions": {
    "OUTPUTS/2/ACTION": 1
  }
}

Rule name: NR08_RULE_ALT

{
  "conditions": {
    "PAB/NR08_PAB/IN": true
  },
  "actions": {
    "OUTPUTS/2/ACTION": "${COND_RESULT}"
  }
}

NR09 - Digital Inputs with Schedule

Examples shows usage when we want to detect switching of Digital Input to ON state (1) but to (not) react only during specified hours (e.g. outside of working hours). Reaction hours are defined with Schedule functionality. Schedule can be defined manually or imported as a configuration file.

Schedule definition

Schedule name: NR09_SCHEDULE

Rule definition

Rule name: NR09_RULE

{
  "conditions": {
    "INPUTS/1/STATE": "on"
  },
  "filters": {
    "SCHEDULE/NR09_SCHEDULE/ACTIVE": false
  },
  "actions": {
    "OUTPUTS/1/ACTION": 2
  }
}

NRXX - Total load (8QS)

{
  "type": "RANGE",
  "source": "OUTPUTS/TOTAL/LOAD",
  "lowerBound": 30,
  "upperBound": 100,
  "timeHysteresis": 3
}


 
{
  "conditions": {
    "operator": "OR",
    "PAB/total_outputs/IN": true
  },
  "actions": {
    "OUTPUTS/1/ACTION": 4,
    "CLOUD/OUTPUT/1/ALARM": 1
  }
}

NRXXX - Negative load

{
  "type": "RANGE",
  "source": "OUTPUTS/1/LOAD",
  "lowerBound": -400,
  "upperBound": 0,
  "timeHysteresis": 2
}


 
{
  "conditions": {
    "PAB/negative/IN": true
  },
  "actions": {
    "OUTPUTS/3/ACTION": 4,
    "OUTPUTS/4/ACTION": 4
  }
}