HomePresenceState

Description

Fields

Key Type Description
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 specified time period.

Optional

Variable is allowed.

HomePresence State Data

Key Type Description
homePresenceMode String

Optional

Examples

starters:
- type: home.state.HomePresence
  state: homePresenceMode
  is: HOME

condition:
  type: home.state.HomePresence
  state: homePresenceMode
  is: AWAY