LockUnlockState

Description

For devices that support locking and unlocking, and/or reporting a locked state.

Fields

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

LockUnlock State Data

Key	Type	Description
isLocked	Bool	Optional
isJammed	Bool	Optional

Examples

starters:
- type: device.state.LockUnlock
  device: My Device - Room Name
  state: isLocked
  is: true

condition:
  type: device.state.LockUnlock
  device: My Device - Room Name
  state: isLocked
  is: false