EnergyStorageState

Description

The state of an energy storage device such as a battery, including the amount of energy it is storing, whether or not it is charging, and whether or not it is plugged in.

Fields

Key Type Description
device Device

The device reporting the EnergyStorage state.

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

Optional

Variable is allowed.

EnergyStorage State Data

Key Type Description
isPluggedIn Bool

Optional
isCharging Bool

Optional
descriptiveCapacityRemaining String

Optional

Examples

starters:
- type: device.state.EnergyStorage
  device: My Device - Room Name
  state: isPluggedIn
  is: true

condition:
  type: device.state.EnergyStorage
  device: My Device - Room Name
  state: isCharging
  is: false