Vincent Le Bourlot 4f3c7fd36f
Add current_humidity attribute (#24)
* Add current_humidity attribute

* fix linter

* ignore brand in validate

* same

* improve extra attributes
2022-06-04 18:59:00 +02:00

155 lines
4.7 KiB
Python

"""Support for VeSync humidifiers."""
import logging
from homeassistant.components.humidifier import HumidifierEntity
from homeassistant.components.humidifier.const import (
MODE_AUTO,
MODE_NORMAL,
MODE_SLEEP,
SUPPORT_MODES,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers.dispatcher import async_dispatcher_connect
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from .common import VeSyncDevice, is_humidifier
from .const import DOMAIN, VS_DISCOVERY, VS_HUMIDIFIERS, VS_MODE_AUTO, VS_MODE_MANUAL
_LOGGER = logging.getLogger(__name__)
MAX_HUMIDITY = 80
MIN_HUMIDITY = 30
MODES = [MODE_AUTO, MODE_NORMAL, MODE_SLEEP]
VESYNC_TO_HA_ATTRIBUTES = {"humidity": "current_humidity"}
async def async_setup_entry(
hass: HomeAssistant,
config_entry: ConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up the VeSync humidifier platform."""
@callback
def discover(devices):
"""Add new devices to platform."""
_setup_entities(devices, async_add_entities)
config_entry.async_on_unload(
async_dispatcher_connect(hass, VS_DISCOVERY.format(VS_HUMIDIFIERS), discover)
)
_setup_entities(
hass.data[DOMAIN][config_entry.entry_id][VS_HUMIDIFIERS], async_add_entities
)
@callback
def _setup_entities(devices, async_add_entities):
"""Check if device is online and add entity."""
entities = []
for dev in devices:
if is_humidifier(dev.device_type):
entities.append(VeSyncHumidifierHA(dev))
else:
_LOGGER.warning(
"%s - Unknown device type - %s", dev.device_name, dev.device_type
)
continue
async_add_entities(entities, update_before_add=True)
class VeSyncHumidifierHA(VeSyncDevice, HumidifierEntity):
"""Representation of a VeSync humidifier."""
_attr_max_humidity = MAX_HUMIDITY
_attr_min_humidity = MIN_HUMIDITY
def __init__(self, humidifier):
"""Initialize the VeSync humidifier device."""
super().__init__(humidifier)
self.smarthumidifier = humidifier
@property
def available_modes(self):
"""Return the available mist modes."""
return MODES
@property
def supported_features(self):
"""Flag supported features."""
return SUPPORT_MODES
@property
def target_humidity(self):
"""Return the humidity we try to reach."""
return self.smarthumidifier.config["auto_target_humidity"]
@property
def mode(self):
"""Get the current preset mode."""
if self.smarthumidifier.details["mode"] == VS_MODE_AUTO:
return MODE_AUTO
if self.smarthumidifier.details["mode"] == VS_MODE_MANUAL:
return (
MODE_SLEEP
if self.smarthumidifier.details["mist_level"] == 1
else MODE_NORMAL
)
return None
@property
def is_on(self):
"""Return True if humidifier is on."""
return self.smarthumidifier.enabled # device_status is always on
@property
def unique_info(self):
"""Return the ID of this humidifier."""
return self.smarthumidifier.uuid
@property
def extra_state_attributes(self):
"""Return the state attributes of the humidifier."""
attr = {}
for k, v in self.smarthumidifier.details.items():
if k in VESYNC_TO_HA_ATTRIBUTES:
attr[VESYNC_TO_HA_ATTRIBUTES[k]] = v
elif k not in self.state_attributes:
attr[k] = v
return attr
def set_humidity(self, humidity):
"""Set the target humidity of the device."""
if humidity not in range(self.min_humidity, self.max_humidity + 1):
raise ValueError(
"{humidity} is not between {self.min_humidity} and {self.max_humidity} (inclusive)"
)
self.smarthumidifier.set_humidity(humidity)
self.schedule_update_ha_state()
def set_mode(self, mode):
"""Set the mode of the device."""
if mode not in self.available_modes:
raise ValueError(
"{mode} is not one of the valid available modes: {self.available_modes}"
)
if mode == MODE_AUTO:
self.smarthumidifier.set_humidity_mode(VS_MODE_AUTO)
else:
self.smarthumidifier.set_mist_level(
1 if mode == MODE_SLEEP else 2
) # this sets manual mode at the same time.
self.schedule_update_ha_state()
def turn_on(
self,
**kwargs,
) -> None:
"""Turn the device on."""
self.smarthumidifier.turn_on()