jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-18 23:06:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Align documented humidifier attributes with implementation (#1921)

Browse Source
This commit is contained in:
Erik Montnemery 2023-09-15 14:54:44 +02:00 committed by GitHub
parent 29acff9b82
commit 41846a472f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
docs/core/entity/humidifier.md
View File

@ -11,18 +11,25 @@ A humidifier entity is a device whose main purpose is to control humidity, i.e.
Properties should always only return information from memory and not do I/O (like network requests). Implement `update()` or `async_update()` to fetch data. Properties should always only return information from memory and not do I/O (like network requests). Implement `update()` or `async_update()` to fetch data.
::: :::
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ----------------------- | ------ | ------------------------------------------------- | ----------------------------------------------------------------------------------------- | | ----------------------- | ---------------------------------------------- | ------------------------------------- | -------------------------------------------------- |
| target_humidity | int | `None` | The target humidity the device is trying to reach. | | action | <code>HumidifierAction &#124; None</code> | `None` | Returns the current status of the device. |
| current_humidity | int | `None` | The current humidity measured by the device. | | available_modes | <code>list[str] &#124; None</code> | **Required by MODES** | The available modes. Requires `SUPPORT_MODES`. |
| max_humidity | int | `DEFAULT_MAX_HUMIDITY` (value == 100) | Returns the maximum humidity. | | current_humidity | <code>int &#124; None</code> | `None` | The current humidity measured by the device. |
| min_humidity | int | `DEFAULT_MIN_HUMIDITY` (value == 0) | Returns the minimum humidity. | | device_class | <code>HumidifierDeviceClass &#124; None</code> | `None` | Type of hygrostat |
| mode | string | `NotImplementedError()` | The current active preset. Requires `SUPPORT_MODES`. | | is_on | <code>bool &#124; None</code> | `None` | Whether the device is on or off. |
| available_modes | list | `NotImplementedError()` | The available modes. Requires `SUPPORT_MODES`. | | max_humidity | `int` | `DEFAULT_MAX_HUMIDITY` (value == 100) | The maximum humidity. |
| supported_features | int | (abstract method) | Bitmap of supported features. See below. | | min_humidity | `int` | `DEFAULT_MIN_HUMIDITY` (value == 0) | The minimum humidity. |
| is_on | bool | `None` | Whether the device is on or off. | | mode | <code>str &#124; None</code> | **Required** | The current active mode. Requires `SUPPORT_MODES`. |
| device_class | string | `None` | Either `HumidifierDeviceClass.HUMIDIFIER` or `HumidiferDeviceClass.DEHUMIDIFIER` | | target_humidity | <code>int &#124; None</code> | `None` | The target humidity the device is trying to reach. |
| action | HumidifierAction | `None` | Returns the current status of the device. |
### Available device classes
| Constant | Description
| ----------------------------------- | ------------------------------------------
| `HumidiferDeviceClass.DEHUMIDIFIER` | A dehumidifier
| `HumidifierDeviceClass.HUMIDIFIER` | A humidifier
### Modes ### Modes