279 lines
10 KiB
Python
279 lines
10 KiB
Python
"""Support for Xiaomi Gateways."""
|
|
import logging
|
|
import voluptuous as vol
|
|
import homeassistant.helpers.config_validation as cv
|
|
from homeassistant.helpers import discovery
|
|
from homeassistant.helpers.entity import Entity
|
|
from homeassistant.components.discovery import SERVICE_XIAOMI_GW
|
|
from homeassistant.const import (ATTR_BATTERY_LEVEL, EVENT_HOMEASSISTANT_STOP,
|
|
CONF_MAC, CONF_HOST, CONF_PORT)
|
|
|
|
REQUIREMENTS = ['PyXiaomiGateway==0.6.0']
|
|
|
|
ATTR_GW_MAC = 'gw_mac'
|
|
ATTR_RINGTONE_ID = 'ringtone_id'
|
|
ATTR_RINGTONE_VOL = 'ringtone_vol'
|
|
ATTR_DEVICE_ID = 'device_id'
|
|
CONF_DISCOVERY_RETRY = 'discovery_retry'
|
|
CONF_GATEWAYS = 'gateways'
|
|
CONF_INTERFACE = 'interface'
|
|
DOMAIN = 'xiaomi_aqara'
|
|
PY_XIAOMI_GATEWAY = "xiaomi_gw"
|
|
|
|
SERVICE_PLAY_RINGTONE = 'play_ringtone'
|
|
SERVICE_STOP_RINGTONE = 'stop_ringtone'
|
|
SERVICE_ADD_DEVICE = 'add_device'
|
|
SERVICE_REMOVE_DEVICE = 'remove_device'
|
|
|
|
XIAOMI_AQARA_SERVICE_SCHEMA = vol.Schema({
|
|
vol.Required(ATTR_GW_MAC): vol.All(cv.string,
|
|
vol.Any(vol.Length(min=12, max=12),
|
|
vol.Length(min=17, max=17)))
|
|
})
|
|
|
|
SERVICE_SCHEMA_PLAY_RINGTONE = XIAOMI_AQARA_SERVICE_SCHEMA.extend({
|
|
vol.Required(ATTR_RINGTONE_ID): vol.Coerce(int),
|
|
vol.Optional(ATTR_RINGTONE_VOL): vol.All(vol.Coerce(int),
|
|
vol.Clamp(min=0, max=100))
|
|
})
|
|
|
|
SERVICE_SCHEMA_REMOVE_DEVICE = XIAOMI_AQARA_SERVICE_SCHEMA.extend({
|
|
vol.Required(ATTR_DEVICE_ID): vol.All(cv.string,
|
|
vol.Length(min=14, max=14))
|
|
})
|
|
|
|
SERVICE_TO_METHOD = {
|
|
SERVICE_PLAY_RINGTONE: {'method': 'play_ringtone_service',
|
|
'schema': SERVICE_SCHEMA_PLAY_RINGTONE},
|
|
SERVICE_STOP_RINGTONE: {'method': 'stop_ringtone_service'},
|
|
SERVICE_ADD_DEVICE: {'method': 'add_device_service'},
|
|
SERVICE_REMOVE_DEVICE: {'method': 'remove_device_service',
|
|
'schema': SERVICE_SCHEMA_REMOVE_DEVICE},
|
|
}
|
|
|
|
|
|
def _validate_conf(config):
|
|
"""Validate a list of devices definitions."""
|
|
res_config = []
|
|
for gw_conf in config:
|
|
for _conf in gw_conf.keys():
|
|
if _conf not in [CONF_MAC, CONF_HOST, CONF_PORT, 'key']:
|
|
raise vol.Invalid('{} is not a valid config parameter'.
|
|
format(_conf))
|
|
|
|
res_gw_conf = {'sid': gw_conf.get(CONF_MAC)}
|
|
if res_gw_conf['sid'] is not None:
|
|
res_gw_conf['sid'] = res_gw_conf['sid'].replace(":", "").lower()
|
|
if len(res_gw_conf['sid']) != 12:
|
|
raise vol.Invalid('Invalid mac address', gw_conf.get(CONF_MAC))
|
|
key = gw_conf.get('key')
|
|
|
|
if key is None:
|
|
_LOGGER.warning(
|
|
'Gateway Key is not provided.'
|
|
' Controlling gateway device will not be possible.')
|
|
elif len(key) != 16:
|
|
raise vol.Invalid('Invalid key {}.'
|
|
' Key must be 16 characters'.format(key))
|
|
res_gw_conf['key'] = key
|
|
|
|
host = gw_conf.get(CONF_HOST)
|
|
if host is not None:
|
|
res_gw_conf[CONF_HOST] = host
|
|
res_gw_conf['port'] = gw_conf.get(CONF_PORT, 9898)
|
|
|
|
_LOGGER.warning(
|
|
'Static address (%s:%s) of the gateway provided. '
|
|
'Discovery of this host will be skipped.',
|
|
res_gw_conf[CONF_HOST], res_gw_conf[CONF_PORT])
|
|
|
|
res_config.append(res_gw_conf)
|
|
return res_config
|
|
|
|
|
|
CONFIG_SCHEMA = vol.Schema({
|
|
DOMAIN: vol.Schema({
|
|
vol.Optional(CONF_GATEWAYS, default=[{CONF_MAC: None, "key": None}]):
|
|
vol.All(cv.ensure_list, _validate_conf),
|
|
vol.Optional(CONF_INTERFACE, default='any'): cv.string,
|
|
vol.Optional(CONF_DISCOVERY_RETRY, default=3): cv.positive_int
|
|
})
|
|
}, extra=vol.ALLOW_EXTRA)
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
|
|
def setup(hass, config):
|
|
"""Set up the Xiaomi component."""
|
|
gateways = []
|
|
interface = 'any'
|
|
discovery_retry = 3
|
|
if DOMAIN in config:
|
|
gateways = config[DOMAIN][CONF_GATEWAYS]
|
|
interface = config[DOMAIN][CONF_INTERFACE]
|
|
discovery_retry = config[DOMAIN][CONF_DISCOVERY_RETRY]
|
|
|
|
def xiaomi_gw_discovered(service, discovery_info):
|
|
"""Called when Xiaomi Gateway device(s) has been found."""
|
|
# We don't need to do anything here, the purpose of HA's
|
|
# discovery service is to just trigger loading of this
|
|
# component, and then its own discovery process kicks in.
|
|
_LOGGER.info("Discovered: %s", discovery_info)
|
|
|
|
discovery.listen(hass, SERVICE_XIAOMI_GW, xiaomi_gw_discovered)
|
|
|
|
from PyXiaomiGateway import PyXiaomiGateway
|
|
hass.data[PY_XIAOMI_GATEWAY] = PyXiaomiGateway(hass.add_job, gateways,
|
|
interface)
|
|
|
|
_LOGGER.debug("Expecting %s gateways", len(gateways))
|
|
for k in range(discovery_retry):
|
|
_LOGGER.info('Discovering Xiaomi Gateways (Try %s)', k + 1)
|
|
hass.data[PY_XIAOMI_GATEWAY].discover_gateways()
|
|
if len(hass.data[PY_XIAOMI_GATEWAY].gateways) >= len(gateways):
|
|
break
|
|
|
|
if not hass.data[PY_XIAOMI_GATEWAY].gateways:
|
|
_LOGGER.error("No gateway discovered")
|
|
return False
|
|
hass.data[PY_XIAOMI_GATEWAY].listen()
|
|
_LOGGER.debug("Gateways discovered. Listening for broadcasts")
|
|
|
|
for component in ['binary_sensor', 'sensor', 'switch', 'light', 'cover']:
|
|
discovery.load_platform(hass, component, DOMAIN, {}, config)
|
|
|
|
def stop_xiaomi(event):
|
|
"""Stop Xiaomi Socket."""
|
|
_LOGGER.info("Shutting down Xiaomi Hub.")
|
|
hass.data[PY_XIAOMI_GATEWAY].stop_listen()
|
|
hass.bus.listen_once(EVENT_HOMEASSISTANT_STOP, stop_xiaomi)
|
|
|
|
# pylint: disable=unused-variable
|
|
def play_ringtone_service(call):
|
|
"""Service to play ringtone through Gateway."""
|
|
ring_id = int(call.data.get(ATTR_RINGTONE_ID))
|
|
gw_sid = call.data.get(ATTR_GW_MAC).replace(":", "").lower()
|
|
|
|
if ring_id in [9, 14-19]:
|
|
_LOGGER.error('Specified mid: %s is not defined in gateway.',
|
|
ring_id)
|
|
return
|
|
|
|
ring_vol = call.data.get(ATTR_RINGTONE_VOL)
|
|
if ring_vol is None:
|
|
ringtone = {'mid': ring_id}
|
|
else:
|
|
ringtone = {'mid': ring_id, 'vol': int(ring_vol)}
|
|
|
|
for (_, gateway) in hass.data[PY_XIAOMI_GATEWAY].gateways.items():
|
|
if gateway.sid == gw_sid:
|
|
gateway.write_to_hub(gateway.sid, **ringtone)
|
|
break
|
|
else:
|
|
_LOGGER.error('Unknown gateway sid: %s was specified.', gw_sid)
|
|
|
|
# pylint: disable=unused-variable
|
|
def stop_ringtone_service(call):
|
|
"""Service to stop playing ringtone on Gateway."""
|
|
gw_sid = call.data.get(ATTR_GW_MAC).replace(":", "").lower()
|
|
for (_, gateway) in hass.data[PY_XIAOMI_GATEWAY].gateways.items():
|
|
if gateway.sid == gw_sid:
|
|
ringtone = {'mid': 10000}
|
|
gateway.write_to_hub(gateway.sid, **ringtone)
|
|
break
|
|
else:
|
|
_LOGGER.error('Unknown gateway sid: %s was specified.', gw_sid)
|
|
|
|
# pylint: disable=unused-variable
|
|
def add_device_service(call):
|
|
"""Service to add a new sub-device within the next 30 seconds."""
|
|
gw_sid = call.data.get(ATTR_GW_MAC).replace(":", "").lower()
|
|
for (_, gateway) in hass.data[PY_XIAOMI_GATEWAY].gateways.items():
|
|
if gateway.sid == gw_sid:
|
|
join_permission = {'join_permission': 'yes'}
|
|
gateway.write_to_hub(gateway.sid, **join_permission)
|
|
hass.components.persistent_notification.async_create(
|
|
'Join permission enabled for 30 seconds! '
|
|
'Please press the pairing button of the new device once.',
|
|
title='Xiaomi Aqara Gateway')
|
|
break
|
|
else:
|
|
_LOGGER.error('Unknown gateway sid: %s was specified.', gw_sid)
|
|
|
|
# pylint: disable=unused-variable
|
|
def remove_device_service(call):
|
|
"""Service to remove a sub-device from the gateway."""
|
|
device_id = call.data.get(ATTR_DEVICE_ID)
|
|
gw_sid = call.data.get(ATTR_GW_MAC).replace(":", "").lower()
|
|
remove_device = {'remove_device': device_id}
|
|
for (_, gateway) in hass.data[PY_XIAOMI_GATEWAY].gateways.items():
|
|
if gateway.sid == gw_sid:
|
|
gateway.write_to_hub(gateway.sid, **remove_device)
|
|
break
|
|
else:
|
|
_LOGGER.error('Unknown gateway sid: %s was specified.', gw_sid)
|
|
|
|
for xiaomi_aqara_service in SERVICE_TO_METHOD:
|
|
schema = SERVICE_TO_METHOD[xiaomi_aqara_service].get(
|
|
'schema', XIAOMI_AQARA_SERVICE_SCHEMA)
|
|
service_handler = SERVICE_TO_METHOD[xiaomi_aqara_service].get('method')
|
|
hass.services.async_register(
|
|
DOMAIN, xiaomi_aqara_service, service_handler,
|
|
description=None, schema=schema)
|
|
|
|
return True
|
|
|
|
|
|
class XiaomiDevice(Entity):
|
|
"""Representation a base Xiaomi device."""
|
|
|
|
def __init__(self, device, name, xiaomi_hub):
|
|
"""Initialize the xiaomi device."""
|
|
self._state = None
|
|
self._sid = device['sid']
|
|
self._name = '{}_{}'.format(name, self._sid)
|
|
self._write_to_hub = xiaomi_hub.write_to_hub
|
|
self._get_from_hub = xiaomi_hub.get_from_hub
|
|
self._device_state_attributes = {}
|
|
xiaomi_hub.callbacks[self._sid].append(self.push_data)
|
|
self.parse_data(device['data'])
|
|
self.parse_voltage(device['data'])
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the device."""
|
|
return self._name
|
|
|
|
@property
|
|
def should_poll(self):
|
|
"""No polling needed."""
|
|
return False
|
|
|
|
@property
|
|
def device_state_attributes(self):
|
|
"""Return the state attributes."""
|
|
return self._device_state_attributes
|
|
|
|
def push_data(self, data):
|
|
"""Push from Hub."""
|
|
_LOGGER.debug("PUSH >> %s: %s", self, data)
|
|
if self.parse_data(data) or self.parse_voltage(data):
|
|
self.schedule_update_ha_state()
|
|
|
|
def parse_voltage(self, data):
|
|
"""Parse battery level data sent by gateway."""
|
|
if 'voltage' not in data:
|
|
return False
|
|
max_volt = 3300
|
|
min_volt = 2800
|
|
voltage = data['voltage']
|
|
voltage = min(voltage, max_volt)
|
|
voltage = max(voltage, min_volt)
|
|
percent = ((voltage - min_volt) / (max_volt - min_volt)) * 100
|
|
self._device_state_attributes[ATTR_BATTERY_LEVEL] = round(percent, 1)
|
|
return True
|
|
|
|
def parse_data(self, data):
|
|
"""Parse data sent by gateway."""
|
|
raise NotImplementedError()
|