Difference between revisions of "Rule"

From Senfi Docs
Jump to: navigation, search
Line 15: Line 15:
  
 
   Output Changed --> Actions
 
   Output Changed --> Actions
 +
 +
== Example ==
 +
* Input: <tt>iot_weighingscale_v1.battery_level</tt>
 +
* Condition: < 20
 +
* Action: ''Email reminder to replace battery''
 +
* Rule execution option: Immediately (means evaluate this rule whenever there is any incoming measurement)
 +
 +
== Rule execution options ==
 +
;Evaluate Type
 +
: Immediate - Rule is executed immediately upon receipt of new values for any Input Measurements
 +
: Polling - Rule is executed periodically, regardless whether the value of Input Measurement have changed.
 +
  
 
Before adding a Rule, you should already have an event or situation that you wish to be notified about. The event or situation should be one that can be detected by monitoring data received by Senfi. If not you will first need to send the relevant data to Senfi before Senfi can monitor those data.
 
Before adding a Rule, you should already have an event or situation that you wish to be notified about. The event or situation should be one that can be detected by monitoring data received by Senfi. If not you will first need to send the relevant data to Senfi before Senfi can monitor those data.

Revision as of 15:37, 18 September 2019

As introduced in general concepts, a Rule is a tool that you can use to monitor your assets and be notified of abnormal situations or events.

A rule in Senfi comprises of:

  • Inputs
  • Conditions
  • Output
  • Actions
  • Rule execution options

Inputs are evaluated by Conditions to generate a single boolean Output. When value of Output changes, Actions, such as email and dashboard alerts, are executed. Rule execution options allows you to configure how the Rule should execute. e.g: how often the Rule is evaluated, when to execute Actions etc.

 Inputs --> Conditions --> Output
 Output Changed --> Actions

Example

  • Input: iot_weighingscale_v1.battery_level
  • Condition: < 20
  • Action: Email reminder to replace battery
  • Rule execution option: Immediately (means evaluate this rule whenever there is any incoming measurement)

Rule execution options

Evaluate Type
Immediate - Rule is executed immediately upon receipt of new values for any Input Measurements
Polling - Rule is executed periodically, regardless whether the value of Input Measurement have changed.


Before adding a Rule, you should already have an event or situation that you wish to be notified about. The event or situation should be one that can be detected by monitoring data received by Senfi. If not you will first need to send the relevant data to Senfi before Senfi can monitor those data.