|
|
| Line 1: |
Line 1: |
| − | {{Top}}
| |
| | | | |
| − | <big>The Basic Rules app delivers easy to use home automation to anyone just getting started, while at the same time offering features experienced users will find handy.</big> | + | <big>'''We're moving!''' Please visit http://docs2.hubitat.com for the latest documentation.</big> |
| | | | |
| − | ===<big>How it works</big>===
| + | <big> |
| − | <big>Each Basic Rule you create follows the simple approach:</big>
| + | This document is available at: http://docs2.hubitat.com/en/apps/basic-rules |
| − | | + | </big> |
| − | <big>When '''THIS''' ''trigger'' event happens, do '''THAT''' ''action''.</big>
| |
| − | | |
| − | *<big>'''NOTE:''' To keep things easy to use, Basic Rule will only offer choices for triggers events and actions for the actual devices you have installed in your Hubitat Elevation system.</big>
| |
| − | | |
| − | ====<big>Events that can ''<u>trigger</u>'' a Basic Rule:</big>====
| |
| − | | |
| − | *<big>Time of day, with Sunrise and Sunset options</big>
| |
| − | *<big>Motion, Contact, Presence, Acceleration or Vibration sensors</big>
| |
| − | *<big>Water - Leak, Smoke or Carbon Monoxide detectors</big>
| |
| − | *<big>Temperature, Humidity or Illuminance sensors</big>
| |
| − | *<big>A switch turning ON or OFF, a button being pressed, or Modes changing.</big>
| |
| − | | |
| − | ====<big>''<u>Actions</u>'' Basic Rule can perform in response to a trigger:</big>====
| |
| − | | |
| − | *<big>Turn switches ON/OFF or Toggle, Set a dimmer level, Adjust color, or color temperature of lights.</big>
| |
| − | *<big>Lock/Unlock locks, Open/Close valves, or push a button.</big>
| |
| − | *<big>Send notifications, speak messages, or set the Mode.</big>
| |
| − | | |
| − | ''<big>Example of a Basic Rule when a contact sensor opens</big>''
| |
| − | [[File:Basic Rule example 1.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/b/b4/Basic_Rule_example_1.png
| |
| − | ]]
| |
| − | | |
| − | ===<big>Easy Automations</big>===
| |
| − | <big>Sometimes just having a device trigger a single action as shown above isn't all that you might want. For example, you might also want a message to notify you not only when the door has opened, but has also been left open. This is very easy with Basic Rule, but the best way to learn what you can do is to play around to discover what you can create!</big>
| |
| − | | |
| − | ''<big>Example of a Basic Rule notifying you when a contact sensor opens, and stays opened for more than two minutes</big>''
| |
| − | [[File:Basic Rule example 2.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/3/36/Basic_Rule_example_2.png
| |
| − | ]]
| |
| − | | |
| − | ===<big>Multiple Trigger Devices</big>===
| |
| − | <big>Basic Rule allows you to select multiple devices for '''When a ...''' ''Trigger'' event happens. Looking again at the example above, adding two or more contact sensors could notify you when any of multiple doors have been left open.</big>
| |
| − | | |
| − | '''<big>Multiple device options include:</big>'''
| |
| − | | |
| − | *<big>Any motion sensor active or inactive</big>
| |
| − | *<big>Any contact sensor opened or closed</big>
| |
| − | *<big>Any vibration sensor active or inactive</big>
| |
| − | *<big>Any presence sensor detects arrival or departure</big>
| |
| − | *<big>Any switch turns ON or OFF</big>
| |
| − | | |
| − | <big>Adding multiple temperature, humidity and illuminance sensors to a Basic Rule will generate a ''trigger'' event when '''any''' device detects a value '''greater than''', or '''less than''' a value you specify.</big>
| |
| − | | |
| − | <big>In this next example, multiple contact sensors can trigger a notification, but adding '''%device%''' instead of a specific device name will send a notification with only the contact sensor that triggered the Basic Rule included in the message.</big>
| |
| − | | |
| − | <big>You can also use '''%value%''' to fill in the last event value from a temperature sensor when it rises above or falls below a value you specify, and you can include the current date and time the event occurred by adding '''%date%''' and '''%time%'''.</big>
| |
| − | [[File:Basic Rule example 3.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/3/33/Basic_Rule_example_3.png
| |
| − | ]]
| |
| − | | |
| − | ===<big>More Actions</big>===
| |
| − | <big>Because you may want more than one thing to happen when a Basic Rule runs, you can easily add more actions. Actions can be changed or removed anytime.</big>
| |
| − | [[File:Basic Rule example 4.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/6/61/Basic_Rule_example_4.png
| |
| − | ]]
| |
| − | | |
| − | ===<big>Wait Until ...</big>===
| |
| − | <big>Next to the '''Add another action''' button is the '''Add Wait until ...''' button. This option opens up the possibility of your Basic Rule waiting for another event before proceeding to run additional actions. With this option your rule can both turn ON the lights in response to an event, and also turn them OFF later when another event occurs. '''Wait''' will be cancelled if the rule is triggered again before the time has elapsed, or the '''Wait''' ''event trigger'' has occurred.</big>
| |
| − | [[File:Basic Rule example 5.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/6/62/Basic_Rule_example_5.png
| |
| − | ]]
| |
| − | | |
| − | ===<big>Restrictions</big>===
| |
| − | <big>Suppose you want the "Any Door Left Open" rule above to run only at night. Simply adding a '''Restriction''' will limit your Basic Rule to only performing the actions when the specified conditions are true.</big>
| |
| − | [[File:Basic Rule restrictions.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/2/27/Basic_Rule_restrictions.png
| |
| − | ]]
| |
| − | '''<big>Available Restrictions include:</big>'''
| |
| − | | |
| − | *<big>Only between two times</big>
| |
| − | *<big>Only on certain days of the week</big>
| |
| − | *<big>Only when mode is one of a selected list of mode</big>
| |
| − | *<big>Only when illuminance is greater or less than a selected value</big>
| |
| − | *<big>Only when not disabled by a switch being either ON or OFF</big>
| |
| − | **<big>'''NOTE:''' When a Basic Rule is restricted, '''<span style="color: red;;">Restricted</span>''' will appear next to the rule name in both the app, and in the '''[[Apps]]''' list.</big>[[File:Basic Rule restrictions indication v2.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/e/ee/Basic_Rule_restrictions_indication_v2.png]]
| |
| − | | |
| − | ===<big>Additional options</big>===
| |
| − | | |
| − | *<big>'''Change the Basic Rule name''' will let you rename your rule if you don't like the automatically generated name.</big>
| |
| − | | |
| − | *<big>'''Enable logging''' will allow you to examine the [[Logs]] and see each step the rule takes when it runs.</big>
| |
