Rule Creation and Control


Guide for rule creation and management.

  1. About Rules
  2. Rule Management
  3. Rule Creation
  4. Rule Informaton
  5. Editing/Removing Rules
  6. Example Usage Tutorial

About Rules


What are Rules?

  • Rules are required for performing an action based on specific conditions. An example rule would be, simply: {In case of fire -> send message “we are on fire, uh oh”}.
  • Through rules, monitoring systems can perform various tasks and automate a wide variety of functions and actions.
  • Automation is one of the pillars of the IoT, and we have designed rules to make it as easy as possible for you to take advantage of this power.

What are Agents?

  • Agents are pre-defined Trigger Types that describe the type of input value (eg. temperature, moisture, etc..) that will be used for a trigger.

The Trigger-Condition-Action Structure

  • All rules are based on a similar structure.
  • Triggers: The first condition upon which the rule is executed. If the rule is never triggered, no action will be performed.
    • Ex. If temperature moves over 15 degree celcius, do something. In this case, the trigger is using the “temperature” agent.
    • There are many different agents, and thus, types of input, that can be used to trigger a rule.
  • Conditions: Additional conditions required for the trigger to fire.
    • Ex. Temperature moves past 15 celcius and humidity > 50%. When all conditions are met, the trigger will fire.
    • Types. Power consumption, battery gate, time condition and so on.
  • Actions: Upon the trigger executing, actions added here will be performed.
    • Ex. if temperature > 100 degrees celcius, send a message and initiate an alarm.
    • Action types are very diverse and malleable, they include: Web push, power regulation, turning a RGB LED on/off, taking a screenshot/image, e-mail, report, SMS and so on.

Parameters

  • Parameters can be used to modify triggers, conditions and actions.
  • Ex. Temperature sensor -> over or under range/ in range/ over a value / under a value.
  • Parameters allow for more precise rule creation using very specific conditions.

Rule Action Blockers

  • Specifically, actions can be blocked from firing too frequently.
    • Eg. A temperature sensor could be set to ignore additional rule triggers for a 5 minute period after having been first triggered.
  • Rules can also be selectively ignored for periods of time to help create rules related to irregular action such as fire alarms, specific doors being opened, etc...
    • Rule triggering that continues past the selective time period will then immediately fire.



Rule Management

Used to display and manage existing rules.

Rule Managment

  • ① Display the existing rule list.
  • ② Rule icon for triggers, conditions, and actions.
  • ③ Name and the description of a rule, ④ the most recent edit date.
  • ⑤ Switch to turn rules on and off.


The Rule Icon

Rule icons are visualized through the Trigger -> Condition -> Action structure. All rules have a three-division visual style that allows you to quickly see an idea of the rule’s components.

  • In this case, Trigger = Run, Condition = CO2 amount, and Action = alert.
  • These icons can be set on a per rule basis.


Creating a Rule

Rules can be set up manually on a customer by customer basis using specific sensors. Additionally, rule templates can be used that come with preset options.


Creating a Rule from Scratch

  1. Click the rule menu on the right part of the setting. Create a new rule from the button on top of the menu.
  2. For this example rule, we will be creating something that looks like: “If temperatures move over 30 degree celcius, send a message to mobile”.
  3. Select to begin Trigger creation.
  4. Select the trigger type for rule initiation. For example, in this case, we will use a temperature sensor .
  5. Next we will set up the range to be checked. Use the icon to select a range denoting all values above a certain value.
  6. Set the range by clicking next.
  7. Add a temperature of 30 degrees as the limit. Any value above this will trigger this rule.
  8. Select a gateway (tags can also be selected).
  9. Select a gateway that has a temperature sensor.
  10. Set the specific temperature sensor(s) to be used for the trigger.
  11. After the above is done, select an action. In the action screen, check your selected trigger. Use the to initialize.
  12. Select SMS on the selection screen.
  13. Select “SEND” as your option.
  14. Write in a default message (that will be sent upon this rule being triggered). Click to check your message or click to write HTML tags and content from scratch. You can also use the pre-filled default message to build upon. Finish rule creation by clicking .
  15. Set the severity level and click the finish button.


Rule Templates

  1. After clicking on from the menu to the right side, click rule management. Push the button at the top of the rule management page and click the template button.
  2. Select from the templates provided and click the Add button.
  3. Edit the rule if needed.
  4. Save it and the rule has been created.



Rule Details Panel

Here you can edit rules that have already been made. This can be accessed by both the rule management page as well as the timeline page.

  • ① Name of the rule
  • ② Agent used
  • ③ Trigger method
  • ④ Exact trigger limit
  • ⑤ Rule Settings
  • ⑥ Rule deletion
  • ⑦ Rule Activation/Deactivation


Editing and Removing Rules

  • Rule Editing
    • Rules can be edited at any time.
    • Click the button in the rule information page.
    • All rule values can be directly edited here.
  • Removing a rule
    • WARNING Rules cannot be recovered after being deleted. Please delete responsibily.
    • Click the button on the rule information page.
    • A pop up screen will ask you confirm if you would like to delete or not.



Rule Tutorial

(To be added)