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-23 17:26:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add action attribute to Humidifier (#1817)

Browse Source 
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
Denis Shulyaka 2023-06-28 14:26:54 +03:00 committed by GitHub
parent 8ad3698a0a
commit dd312fcb06
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -21,7 +21,8 @@ Properties should always only return information from memory and not do I/O (lik
| available_modes | list | `NotImplementedError()` | The available modes. Requires `SUPPORT_MODES`. |
| supported_features | int | (abstract method) | Bitmap of supported features. See below. |
| is_on | bool | `None` | Whether the device is on or off. |
| device_class | string | `None` | Either `HumidifierDeviceClass.HUMIDIFIER` or `HumidiferDeviceClass,DEHUMIDIFIER` |
| device_class | string | `None` | Either `HumidifierDeviceClass.HUMIDIFIER` or `HumidiferDeviceClass.DEHUMIDIFIER` |
| action | HumidifierAction | `None` | Returns the current status of the device. |
### Modes
@ -48,6 +49,19 @@ and are combined using the bitwise or (`|`) operator.
| ------- | ------------------------------------ |
| `MODES` | The device supports different modes. |
## Action
The `action` property may return the current operating state of the device, whether it is humidifying or idle. This is an informational property. Please note that when the device is off, the `action` attribute, if present, will automatically be replaced with "off". Also, please note that setting `action` to `off` does not replace the `is_on` property.
Current values for `HumidifierAction`:
| Name | Description |
| ------------- | ------------------------------------------ |
| `HUMIDIFYING` | The device is currently humidifying. |
| `DRYING` | The device is currently dehumidifying. |
| `IDLE` | The device is on but not active right now. |
| `OFF` | The device is switched off. |
## Methods
### Set mode