Skip to content

Commit

Permalink
Small improvements on rules/scenes documentation (openhab#2206)
Browse files Browse the repository at this point in the history 
Signed-off-by: Kai Kreuzer <[email protected]>
  • Loading branch information
@kaikreuzer
kaikreuzer authored Jan 13, 2024
1 parent 88a862f commit bbf10ef
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions tutorials/getting_started/rules_introduction.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Rules can do that too.

A rule consists of three parts.

| Name | MainUI Section | Purpose |
| Name | Main UI Section | Purpose |
|-------------|----------------|-------------------------------------------------------------------------------------|
| `Trigger` | When | List of the events that cause the rule to run. |
| `Condition` | But Only If | Conditions which must be true before the rule is allowed to run even when triggered |
Expand Down Expand Up @@ -118,8 +118,8 @@ All are rules.
| Type | What's Unique | Purpose |
|--------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ![Rule](images/wand_stars.png) Rule | | This is any unit of automation which can contain zero or more of triggers, actions and, conditions |
| ![Script](images/doc_plaintext.png) Script | Rule consisting of a single Script Action and has the tag "Script", there are no triggers so they must be run manually or called from another rule | A great place to store examples when you figure something out and want to remember how you did it later. Can include reusable code called from other rules (though there are often better choices). Very useful for adhoc and pseudo-unit testing of your rules. Despite being a rule, Scripts do not appear in the Rules page of MainUI. |
| ![Scenes](images/scenes.png) Scene | A special type of rule that allows to send multiple item actions at the same time | This page is a good place to see when your rules are scheduled to run. However, note that it only shows statically timed rules. |
| ![Script](images/doc_plaintext.png) Script | Rule consisting of a single Script Action and has the tag "Script". There are no triggers so they must be run manually or called from another rule. | A great place to store examples when you figure something out and want to remember how you did it later. Can include reusable code called from other rules (though there are often better choices). Very useful for adhoc and pseudo-unit testing of your rules. Despite being a rule, Scripts do not appear in the Rules page of Main UI. |
| ![Scenes](images/scenes.png) Scene | A special type of rule that allows to send multiple item actions at the same time. | Scenes are commonly used to restore certain complex setups, like the lighting for dinner or TV sessions. They can be easily reused from other rules. |
| ![Schedule](images/calendar.png) Schedule | any rule with a time based trigger and the tag "Schedule" | This page is a good place to see when your rules are scheduled to run. However, note that it only shows statically timed rules. |

Important note on the term "Script".
Expand Down

0 comments on commit bbf10ef

Please sign in to comment.