Skip to content

Commit d5c8fd8

Browse files
authored
README: Improve rule builder trigger builder docs (#411)
Closes #400. Signed-off-by: Florian Hotze <[email protected]>
1 parent 29c6231 commit d5c8fd8

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

README.md

+22-22
Original file line numberDiff line numberDiff line change
@@ -1319,27 +1319,27 @@ See [Examples](#rule-builder-examples) for further patterns.
13191319
- `.cron(cronExpression)`: Specifies a cron schedule for the rule to fire.
13201320
- `.timeOfDay(time)`: Specifies a time of day in `HH:mm` for the rule to fire.
13211321
- `.item(itemName)`: Specifies an Item as the source of changes to trigger a rule.
1322-
- `.for(duration)`
1323-
- `.from(state)`
1324-
- `.fromOn()`
1325-
- `.fromOff()`
1326-
- `.to(state)`
1327-
- `.toOn()`
1328-
- `.toOff()`
1329-
- `.receivedCommand()`
1330-
- `.receivedUpdate()`
1331-
- `.changed()`
1322+
- `.receivedCommand()`, `.receivedUpdate()`, `.changed()` allows to define the received command/update, respective new state:
1323+
- `.of(command)`
1324+
- `.to(state)`
1325+
- `.toOn()`
1326+
- `.toOff()`
1327+
- `.changed()` allows to define the previous state and a duration for which the Item must have changed:
1328+
- `.from(state)`
1329+
- `.fromOn()`
1330+
- `.fromOff()`
1331+
- `.for(duration)` where duration is in milliseconds
13321332
- `.memberOf(groupName)`: Specifies a group Item as the source of changes to trigger the rule.
1333-
- `.for(duration)`
1334-
- `.from(state)`
1335-
- `.fromOn()`
1336-
- `.fromOff()`
1337-
- `.to(state)`
1338-
- `.toOn()`
1339-
- `.toOff()`
1340-
- `.receivedCommand()`
1341-
- `.receivedUpdate()`
1342-
- `.changed()`
1333+
- `.receivedCommand()`, `.receivedUpdate()`, `.changed()` allows to define the received command/update, respective new state:
1334+
- `.of(command)`
1335+
- `.to(state)`
1336+
- `.toOn()`
1337+
- `.toOff()`
1338+
- `.changed()` allows to define the previous state and a duration for which the Item must have changed:
1339+
- `.from(state)`
1340+
- `.fromOn()`
1341+
- `.fromOff()`
1342+
- `.for(duration)` where duration is in milliseconds
13431343
- `.system()`: Specifies a system event as a source for the rule to fire.
13441344
- `.ruleEngineStarted()`
13451345
- `.rulesLoaded()`
@@ -1349,9 +1349,9 @@ See [Examples](#rule-builder-examples) for further patterns.
13491349
- `.startLevel(level)`
13501350
- `.thing(thingName)`: Specifies a Thing event as a source for the rule to fire.
13511351
- `changed()`
1352+
- `from(state)`
1353+
- `to(state)`
13521354
- `updated()`
1353-
- `from(state)`
1354-
- `to(state)`
13551355
- `.dateTime(itemName)`: Specifies a DateTime Item whose (optional) date and time schedule the rule to fire.
13561356
- `.timeOnly()`: Only the time of the Item should be compared, the date should be ignored.
13571357
- `.withOffset(offset)`: The offset in seconds to add to the time of the DateTime Item.

0 commit comments

Comments
 (0)