253 lines
7.6 KiB
Python
253 lines
7.6 KiB
Python
"""Support for Xiaomi Mi Air Quality Monitor (PM2.5)."""
|
|
from dataclasses import dataclass
|
|
import logging
|
|
|
|
from miio import AirQualityMonitor, DeviceException # pylint: disable=import-error
|
|
from miio.gateway import DeviceType
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.sensor import PLATFORM_SCHEMA
|
|
from homeassistant.const import (
|
|
CONF_HOST,
|
|
CONF_NAME,
|
|
CONF_TOKEN,
|
|
DEVICE_CLASS_HUMIDITY,
|
|
DEVICE_CLASS_PRESSURE,
|
|
DEVICE_CLASS_TEMPERATURE,
|
|
PRESSURE_HPA,
|
|
TEMP_CELSIUS,
|
|
UNIT_PERCENTAGE,
|
|
)
|
|
from homeassistant.exceptions import PlatformNotReady
|
|
import homeassistant.helpers.config_validation as cv
|
|
from homeassistant.helpers.entity import Entity
|
|
|
|
from .config_flow import CONF_FLOW_TYPE, CONF_GATEWAY
|
|
from .const import DOMAIN
|
|
from .gateway import XiaomiGatewayDevice
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
DEFAULT_NAME = "Xiaomi Miio Sensor"
|
|
DATA_KEY = "sensor.xiaomi_miio"
|
|
|
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
|
|
{
|
|
vol.Required(CONF_HOST): cv.string,
|
|
vol.Required(CONF_TOKEN): vol.All(cv.string, vol.Length(min=32, max=32)),
|
|
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
|
|
}
|
|
)
|
|
|
|
ATTR_POWER = "power"
|
|
ATTR_CHARGING = "charging"
|
|
ATTR_BATTERY_LEVEL = "battery_level"
|
|
ATTR_DISPLAY_CLOCK = "display_clock"
|
|
ATTR_NIGHT_MODE = "night_mode"
|
|
ATTR_NIGHT_TIME_BEGIN = "night_time_begin"
|
|
ATTR_NIGHT_TIME_END = "night_time_end"
|
|
ATTR_SENSOR_STATE = "sensor_state"
|
|
ATTR_MODEL = "model"
|
|
|
|
SUCCESS = ["ok"]
|
|
|
|
|
|
@dataclass
|
|
class SensorType:
|
|
"""Class that holds device specific info for a xiaomi aqara sensor."""
|
|
|
|
unit: str = None
|
|
icon: str = None
|
|
device_class: str = None
|
|
|
|
|
|
GATEWAY_SENSOR_TYPES = {
|
|
"temperature": SensorType(
|
|
unit=TEMP_CELSIUS, icon=None, device_class=DEVICE_CLASS_TEMPERATURE
|
|
),
|
|
"humidity": SensorType(
|
|
unit=UNIT_PERCENTAGE, icon=None, device_class=DEVICE_CLASS_HUMIDITY
|
|
),
|
|
"pressure": SensorType(
|
|
unit=PRESSURE_HPA, icon=None, device_class=DEVICE_CLASS_PRESSURE
|
|
),
|
|
}
|
|
|
|
|
|
async def async_setup_entry(hass, config_entry, async_add_entities):
|
|
"""Set up the Xiaomi sensor from a config entry."""
|
|
entities = []
|
|
|
|
# Gateway sub devices
|
|
if config_entry.data[CONF_FLOW_TYPE] == CONF_GATEWAY:
|
|
gateway = hass.data[DOMAIN][config_entry.entry_id]
|
|
sub_devices = gateway.devices
|
|
for sub_device in sub_devices.values():
|
|
sensor_variables = None
|
|
if sub_device.type == DeviceType.SensorHT:
|
|
sensor_variables = ["temperature", "humidity"]
|
|
if sub_device.type == DeviceType.AqaraHT:
|
|
sensor_variables = ["temperature", "humidity", "pressure"]
|
|
if sensor_variables is not None:
|
|
entities.extend(
|
|
[
|
|
XiaomiGatewaySensor(sub_device, config_entry, variable)
|
|
for variable in sensor_variables
|
|
]
|
|
)
|
|
|
|
async_add_entities(entities, update_before_add=True)
|
|
|
|
|
|
async def async_setup_platform(hass, config, async_add_entities, discovery_info=None):
|
|
"""Set up the sensor from config."""
|
|
if DATA_KEY not in hass.data:
|
|
hass.data[DATA_KEY] = {}
|
|
|
|
host = config[CONF_HOST]
|
|
token = config[CONF_TOKEN]
|
|
name = config[CONF_NAME]
|
|
|
|
_LOGGER.info("Initializing with host %s (token %s...)", host, token[:5])
|
|
|
|
try:
|
|
air_quality_monitor = AirQualityMonitor(host, token)
|
|
device_info = await hass.async_add_executor_job(air_quality_monitor.info)
|
|
model = device_info.model
|
|
unique_id = f"{model}-{device_info.mac_address}"
|
|
_LOGGER.info(
|
|
"%s %s %s detected",
|
|
model,
|
|
device_info.firmware_version,
|
|
device_info.hardware_version,
|
|
)
|
|
device = XiaomiAirQualityMonitor(name, air_quality_monitor, model, unique_id)
|
|
except DeviceException:
|
|
raise PlatformNotReady
|
|
|
|
hass.data[DATA_KEY][host] = device
|
|
async_add_entities([device], update_before_add=True)
|
|
|
|
|
|
class XiaomiAirQualityMonitor(Entity):
|
|
"""Representation of a Xiaomi Air Quality Monitor."""
|
|
|
|
def __init__(self, name, device, model, unique_id):
|
|
"""Initialize the entity."""
|
|
self._name = name
|
|
self._device = device
|
|
self._model = model
|
|
self._unique_id = unique_id
|
|
|
|
self._icon = "mdi:cloud"
|
|
self._unit_of_measurement = "AQI"
|
|
self._available = None
|
|
self._state = None
|
|
self._state_attrs = {
|
|
ATTR_POWER: None,
|
|
ATTR_BATTERY_LEVEL: None,
|
|
ATTR_CHARGING: None,
|
|
ATTR_DISPLAY_CLOCK: None,
|
|
ATTR_NIGHT_MODE: None,
|
|
ATTR_NIGHT_TIME_BEGIN: None,
|
|
ATTR_NIGHT_TIME_END: None,
|
|
ATTR_SENSOR_STATE: None,
|
|
ATTR_MODEL: self._model,
|
|
}
|
|
|
|
@property
|
|
def should_poll(self):
|
|
"""Poll the miio device."""
|
|
return True
|
|
|
|
@property
|
|
def unique_id(self):
|
|
"""Return an unique ID."""
|
|
return self._unique_id
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of this entity, if any."""
|
|
return self._name
|
|
|
|
@property
|
|
def unit_of_measurement(self):
|
|
"""Return the unit of measurement of this entity, if any."""
|
|
return self._unit_of_measurement
|
|
|
|
@property
|
|
def icon(self):
|
|
"""Return the icon to use for device if any."""
|
|
return self._icon
|
|
|
|
@property
|
|
def available(self):
|
|
"""Return true when state is known."""
|
|
return self._available
|
|
|
|
@property
|
|
def state(self):
|
|
"""Return the state of the device."""
|
|
return self._state
|
|
|
|
@property
|
|
def device_state_attributes(self):
|
|
"""Return the state attributes of the device."""
|
|
return self._state_attrs
|
|
|
|
async def async_update(self):
|
|
"""Fetch state from the miio device."""
|
|
try:
|
|
state = await self.hass.async_add_executor_job(self._device.status)
|
|
_LOGGER.debug("Got new state: %s", state)
|
|
|
|
self._available = True
|
|
self._state = state.aqi
|
|
self._state_attrs.update(
|
|
{
|
|
ATTR_POWER: state.power,
|
|
ATTR_CHARGING: state.usb_power,
|
|
ATTR_BATTERY_LEVEL: state.battery,
|
|
ATTR_DISPLAY_CLOCK: state.display_clock,
|
|
ATTR_NIGHT_MODE: state.night_mode,
|
|
ATTR_NIGHT_TIME_BEGIN: state.night_time_begin,
|
|
ATTR_NIGHT_TIME_END: state.night_time_end,
|
|
ATTR_SENSOR_STATE: state.sensor_state,
|
|
}
|
|
)
|
|
|
|
except DeviceException as ex:
|
|
self._available = False
|
|
_LOGGER.error("Got exception while fetching the state: %s", ex)
|
|
|
|
|
|
class XiaomiGatewaySensor(XiaomiGatewayDevice):
|
|
"""Representation of a XiaomiGatewaySensor."""
|
|
|
|
def __init__(self, sub_device, entry, data_key):
|
|
"""Initialize the XiaomiSensor."""
|
|
super().__init__(sub_device, entry)
|
|
self._data_key = data_key
|
|
self._unique_id = f"{sub_device.sid}-{data_key}"
|
|
self._name = f"{data_key} ({sub_device.sid})".capitalize()
|
|
|
|
@property
|
|
def icon(self):
|
|
"""Return the icon to use in the frontend."""
|
|
return GATEWAY_SENSOR_TYPES[self._data_key].icon
|
|
|
|
@property
|
|
def unit_of_measurement(self):
|
|
"""Return the unit of measurement of this entity, if any."""
|
|
return GATEWAY_SENSOR_TYPES[self._data_key].unit
|
|
|
|
@property
|
|
def device_class(self):
|
|
"""Return the device class of this entity."""
|
|
return GATEWAY_SENSOR_TYPES[self._data_key].device_class
|
|
|
|
@property
|
|
def state(self):
|
|
"""Return the state of the sensor."""
|
|
return self._sub_device.status[self._data_key]
|