Adjust documentation for generic hygrostat config flow (#33117)

This commit is contained in:
Joakim Plate 2024-06-23 13:27:04 +02:00 committed by GitHub
parent 075824c91a
commit 89131a804f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -11,10 +11,11 @@ ha_codeowners:
ha_iot_class: Local Polling
ha_platforms:
- humidifier
ha_integration_type: integration
ha_integration_type: helper
related:
- docs: /docs/configuration/
title: Configuration file
ha_config_flow: true
---
The `generic_hygrostat` humidifier {% term integration %} is a virtual hygrostat implemented in Home Assistant. It uses a sensor and a switch connected to a humidifier or dehumidifier under the hood. When in humidifier mode, if the measured humidity is less than the target humidity, the humidifier will be turned on and turned off when the required humidity is reached. When in dehumidifier mode, if the measured humidity is greater than the target humidity, the dehumidifier will be turned on and turned off when required humidity is reached. One Generic Hygrostat entity can only control one switch. If you need to activate two switches, one for a humidifier and one for a dehumidifier, you will need two Generic Hygrostat entities.
@ -22,6 +23,14 @@ The `generic_hygrostat` humidifier {% term integration %} is a virtual hygrostat
To enable the {% term integration %}, you need to add it to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
{% include integrations/config_flow.md %}
## YAML configuration
Alternatively, this integration can be configured and set up manually via YAML
as well. To enable the generic hygrostat in your installation, add the
following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
generic_hygrostat:
@ -107,7 +116,7 @@ sensor_stale_duration:
Time for `min_cycle_duration` and `keep_alive` must be set as "hh:mm:ss" or it must contain at least one of the following entries: `days:`, `hours:`, `minutes:`, `seconds:` or `milliseconds:`. Alternatively, it can be an integer that represents time in seconds.
## Full configuration example
## Full YAML configuration example
```yaml
generic_hygrostat: