StartStopState

Description

For devices that support starting and stopping operations.

Starting and stopping a device serves a similar function to turning it on and off. It indicates that devices function differently when turned on and when started. Certain washing machines, for instance, are able to be turned on and have their settings modified before actually starting operation.

Fields

Key	Type	Description
device	Device	The device reporting the StartStop state. 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

StartStop State Data

Key	Type	Description
isPaused	Bool	Optional
isRunning	Bool	Optional

Examples

starters:
 - type: device.state.StartStop
   device: My Device - Room Name
   state: isRunning
   is: true

condition:
   type: device.state.StartStop
   device: My Device - Room Name
   state: isRunning
   is: false