VolumeState

Description

For devices which are able to change volume (for example, setting the volume to a certain level, mute, or unmute).

Fields

Key Type Description
device Device

Device which reports the Volume 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.

Volume State Data

Key Type Description
currentVolume Number

Optional
isMuted Bool

Optional

Examples

starters:
- type: device.state.Volume
  device: My Device - Room Name
  state: currentVolume
  is: 0

starters:
  type: device.state.Volume
  device: My Device - Room Name
  state: isMuted
  is: true