Description
This function belongs to any device that has an ongoing duration for its operation which can be queried. This includes, but is not limited to, devices that operate cyclically, such as washing machines, dryers, and dishwashers.
Fields
Key | Type | Description |
---|---|---|
device
|
Device |
Required Variable is allowed. |
state
|
FieldPath |
The specific state data to check. Required Variable is NOT allowed |
is
|
Dynamic |
Checks if the state data is equal to a value. Optional To use this field, all the following fields CANNOT be used: isNot, greaterThanOrEqualTo, greaterThan, lessThanOrEqualTo, lessThan Variable is allowed. |
isNot
|
Dynamic |
Checks if the state data is not equal to a value. Optional To use this field, all the following fields CANNOT be used: is, greaterThanOrEqualTo, greaterThan, lessThanOrEqualTo, lessThan Variable is allowed. |
greaterThan
|
Dynamic |
Checks if the state data is greater than (>) a value. Optional To use this field, all the following fields CANNOT be used: isNot, is, greaterThanOrEqualTo Variable is allowed. |
greaterThanOrEqualTo
|
Dynamic |
Checks if the state data is greater than or equal to (>=) a value. Optional To use this field, all the following fields CANNOT be used: isNot, is, greaterThan Variable is allowed. |
lessThan
|
Dynamic |
Checks if the state data is less than (<) a value. Optional To use this field, all the following fields CANNOT be used: isNot, is, lessThanOrEqualTo Variable is allowed. |
lessThanOrEqualTo
|
Dynamic |
Checks if the state data is less than or equal to (<=) a value. Optional To use this field, all the following fields CANNOT be used: isNot, is, lessThan Variable is allowed. |
for
|
Duration |
Checks if the state has already remained for a certain duration. Only applicable for Starters, cannot be used with Conditions. Optional Variable is allowed. |
suppressFor
|
Duration |
Suppress the triggering of the starter for a certain time period. Optional Variable is allowed. |
RunCycle State Data
Key | Type | Description |
---|---|---|
currentTotalRemainingTime
|
Duration |
Optional |
currentCycleRemainingTime
|
Duration |
Optional |
Examples
starters:
- type: device.state.RunCycle
device: My Device - Room Name
state: currentRunCycle
is: Some Text
condition:
type: device.state.RunCycle
device: My Device - Room Name
state: currentRunCycle
is: Some Text