-
Notifications
You must be signed in to change notification settings - Fork 314
User Guide: Use When Then Rules
Note
This wiki page has been migrated to the following documentation page:
https://docs.openremote.io/docs/user-guide/rules-and-forecasting/when-then-rules
Please update your bookmarks.
When-Then rules are used in combination with the or-rules UI component. They are meant to be used to allow application users to define 'When this, then that' statements. For example "During weekdays, when it's cold, turn on the lights 5 minutes before sunset" or "send push notification to anybody who reaches the stadium".
Note that When-Then rules also support web hooks as the right hand side action. This allows you to connect to any other application based on an event. Options are endless, from connecting to your Maintenance or Messaging service to your ERP or CRM system.
To get familiar with the When-Then interface we will be creating a rule that turns on lights when the temperature drops below a certain threshold and just before sunset (makes sense right?). We only want this rule to be active on weekdays. This guide assumes you are using the Demo. Otherwise you need to create some assets first.
- Switch from the
master
realm to theSmart city
realm in the top. You will see the assets we use a demo setup. - Navigate to the
Rules
page, here you will find some demo rules that are running at the moment. We will add our own. - Add a new rule:
- Click the
+
. - Select 'When-Then'.
- Name it
Cold and sunset: lights on
.
- Click the
- Create the When side of the rule:
- Click the
+
, a list of asset types will appear. - Select
Weather Asset
, the next will appear showingAny of this type
. - Switch to the asset named
Weather
. - In the next field select the attribute of interest:
temperature
. - In the next field select the operator:
less than
. - Finally set a value of
10
. You have now finished the first condition. This can be combined throughAND
orOR
with other conditions.
- Click the
- Create a second condition to monitor the humidity:
- Click the
+
in the section below where it saysADD CONDITION
and selectTime
. - Select Trigger Type
Sunset
. - Set the value
-5
for theOffset in minutes
. - Select:
location
. You have finished theAND
condition. If both conditions are met, theThen
actions will trigger.
- Click the
- Create an action on the
Then
side of the rule:- Click the
+
on the right in theThen
section. - Select the
Light Asset
asset type. - Select the lights that you want to control. In this case we want to turn on all lights at once using the
Lighting Noordereiland
. - Select the attribute you want to control:
On Off
. - Toggle the switch on. The Actions are done.
- Click the
- Set the schedule for this rule:
- Open up the scheduler by clicking
Always active
next to the rules name. - Select
Plan a repeating occurrence
as we want the rule to work only on weekdays. - At
Repeat occurrence every
click the fiveweekdays
- Leave the
Repetition ends
atNever
- Click
Apply
and save the rule in the top right.
- Open up the scheduler by clicking
Your rule is finished! Every weekday the rule will check if both conditions are met and if so, turns on the lights of Noordereiland.
Source · Documentation · Forum · Issues · Docker Images · OpenRemote Inc.
- Overview
- Bluetooth Mesh
- HTTP
- KNX
- LoRa
- MQTT
- Simulator
- SNMP
- Serial
- TCP
- UDP
- Velbus
- Websocket
- Z-Wave
- Partner Integrations
- OpenRemote as Edge Gateway
- Auto provisioning devices and users
- Connect ESP32 or ESP8266 using MQTT
- Firmware updating with Hawkbit
- Partner Integrations
- Weather data using HTTP Agent
- Connect Your MQTT Client
- ChirpStack LoRaWAN Integration
- Celcius to Fahrenheit with Flow
- Configure mobile app behaviour
- Simulating data in attribute
- Preparing the environment
- Installing and using Docker
- Setting up an IDE
- Building and testing
- Working on UI and apps
- Working on maps
- Docker compose profiles
- Creating a custom project
- Maintaining an installation
- Adding Widgets on Insights
- Working on the mobile consoles
- Connecting Protocol adaptors with Agents
- Edge device firmware updating
- Licensing guidelines for contributors
- Useful commands and queries
- Data migration
- Gateway tunnelling setup