name:
description: Name of hygrostat.
required: true
default: Generic Hygrostat
type: string
unique_id:
description: An ID that uniquely identifies this humidifier. Set this to a unique value to allow customization through the UI.
required: false
type: string
humidifier:
description: "`entity_id` for humidifier or dehumidifier switch, must be a toggle device."
required: true
type: string
target_sensor:
description: "`entity_id` for a humidity sensor, target_sensor.state must be humidity."
required: true
type: string
min_humidity:
description: Set minimum set point available.
required: false
default: 0
type: float
max_humidity:
description: Set maximum set point available.
required: false
default: 100
type: float
target_humidity:
description: Set initial target humidity. This value will be used as a fallback when the previous setpoint is not available.
required: false
type: float
device_class:
description: Whether the switch specified in the *humidifier* option to be treated as a humidifier or a dehumidifier device. Must be either "humidifier" or "dehumidifier"
required: false
type: string
default: "humidifier"
min_cycle_duration:
description: Set a minimum amount of time that the switch specified in the *humidifier* option must be in its current state prior to being switched either off or on.
required: false
type: [time, integer]
dry_tolerance:
description: Set a minimum amount of difference between the humidity read by the sensor specified in the *target_sensor* option and the target humidity that must change prior to being switched on. For example, if the target humidity is 45 and the tolerance is 3 the humidifier will start when the sensor equals or goes below 42. It is advised to set this parameter equal or above your sensor precision. This parameter is only used on *target_sensor* changes and is ignored on initialization, on manual operation or `humidifier.turn_on` action.
required: false
default: 3
type: float
wet_tolerance:
description: Set a minimum amount of difference between the humidity read by the sensor specified in the *target_sensor* option and the target humidity that must change prior to being switched off. For example, if the target humidity is 45 and the tolerance is 3 the humidifier will stop when the sensor equals or goes above 48. It is advised to set this parameter equal or above your sensor precision. This parameter is only used on *target_sensor* changes and is ignored on initialization, on manual operation or `humidifier.turn_on` action.
required: false
default: 3
type: float
keep_alive:
description: Set a keep-alive interval. If set, the switch specified in the *humidifier* option will be triggered every time the interval elapses. Use with humidifiers and dehumidifiers that shut off if they don't receive a signal from their remote for a while. Use also with switches that might lose state. The keep-alive call is done with the current valid humidifier integration state (either on or off).
required: false
type: [time, integer]
initial_state:
description: Set the initial state. This value is used as a fallback when a previous state is not available.
required: false
type: boolean
default: false
away_humidity:
description: "Set the humidity used by `away` mode. If this is not specified, the mode feature will not be available."
required: false
type: integer
away_fixed:
description: "If this parameter is set to `True`, the target humidity for the `away` mode is fixed at `away_humidity` level and cannot be changed. An attempt to set the target humidity will effectively set the humidity for the `normal` mode. This can be used to independently control mode and target humidity."
required: false
type: boolean
default: false
sensor_stale_duration:
description: If the *target_sensor* does not update its value within this period, it is considered unavailable until the next update. When the sensor is unavailable, the *humidifier* is turned off for safety reasons.
required: false
type: [time, integer]
