Description
For devices that have an ongoing duration for their operation which can be queried.
Devices like these will report their total number of cycles at the start of operation, and each cycle the device is currently in while running.
Fields
Key | Type | Description |
---|---|---|
device
|
Device |
The device reporting the Required |
state
|
FieldPath |
The specific state data to check. Required |
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 |
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 |
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 |
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 |
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 |
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 |
for
|
Duration |
Checks if the state has already remained for a certain duration. Only applicable for Starters, cannot be used with Conditions. Optional |
suppressFor
|
Duration |
Suppress the triggering of the starter for a specified time period. Optional |
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