158 lines
5.2 KiB
Python
158 lines
5.2 KiB
Python
"""
|
|
Support for the Broadlink RM2 Pro (only temperature) and A1 devices.
|
|
|
|
For more details about this platform, please refer to the documentation at
|
|
https://home-assistant.io/components/sensor.broadlink/
|
|
"""
|
|
from datetime import timedelta
|
|
import binascii
|
|
import logging
|
|
import socket
|
|
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.sensor import PLATFORM_SCHEMA
|
|
from homeassistant.const import (
|
|
CONF_HOST, CONF_MAC, CONF_MONITORED_CONDITIONS, CONF_NAME, TEMP_CELSIUS,
|
|
CONF_TIMEOUT, CONF_UPDATE_INTERVAL, CONF_SCAN_INTERVAL,
|
|
CONF_UPDATE_INTERVAL_INVALIDATION_VERSION)
|
|
from homeassistant.helpers.entity import Entity
|
|
from homeassistant.util import Throttle
|
|
import homeassistant.helpers.config_validation as cv
|
|
|
|
REQUIREMENTS = ['broadlink==0.9.0']
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
DEVICE_DEFAULT_NAME = 'Broadlink sensor'
|
|
DEFAULT_TIMEOUT = 10
|
|
SCAN_INTERVAL = timedelta(seconds=300)
|
|
|
|
SENSOR_TYPES = {
|
|
'temperature': ['Temperature', TEMP_CELSIUS],
|
|
'air_quality': ['Air Quality', ' '],
|
|
'humidity': ['Humidity', '%'],
|
|
'light': ['Light', ' '],
|
|
'noise': ['Noise', ' '],
|
|
}
|
|
|
|
PLATFORM_SCHEMA = vol.All(
|
|
PLATFORM_SCHEMA.extend({
|
|
vol.Optional(CONF_NAME, default=DEVICE_DEFAULT_NAME): vol.Coerce(str),
|
|
vol.Optional(CONF_MONITORED_CONDITIONS, default=[]):
|
|
vol.All(cv.ensure_list, [vol.In(SENSOR_TYPES)]),
|
|
vol.Optional(CONF_UPDATE_INTERVAL):
|
|
vol.All(cv.time_period, cv.positive_timedelta),
|
|
vol.Required(CONF_HOST): cv.string,
|
|
vol.Required(CONF_MAC): cv.string,
|
|
vol.Optional(CONF_TIMEOUT, default=DEFAULT_TIMEOUT): cv.positive_int
|
|
}),
|
|
cv.deprecated(
|
|
CONF_UPDATE_INTERVAL,
|
|
replacement_key=CONF_SCAN_INTERVAL,
|
|
invalidation_version=CONF_UPDATE_INTERVAL_INVALIDATION_VERSION,
|
|
default=SCAN_INTERVAL
|
|
)
|
|
)
|
|
|
|
|
|
def setup_platform(hass, config, add_entities, discovery_info=None):
|
|
"""Set up the Broadlink device sensors."""
|
|
host = config.get(CONF_HOST)
|
|
mac = config.get(CONF_MAC).encode().replace(b':', b'')
|
|
mac_addr = binascii.unhexlify(mac)
|
|
name = config.get(CONF_NAME)
|
|
timeout = config.get(CONF_TIMEOUT)
|
|
update_interval = config.get(CONF_SCAN_INTERVAL, SCAN_INTERVAL)
|
|
broadlink_data = BroadlinkData(update_interval, host, mac_addr, timeout)
|
|
dev = []
|
|
for variable in config[CONF_MONITORED_CONDITIONS]:
|
|
dev.append(BroadlinkSensor(name, broadlink_data, variable))
|
|
add_entities(dev, True)
|
|
|
|
|
|
class BroadlinkSensor(Entity):
|
|
"""Representation of a Broadlink device sensor."""
|
|
|
|
def __init__(self, name, broadlink_data, sensor_type):
|
|
"""Initialize the sensor."""
|
|
self._name = '{} {}'.format(name, SENSOR_TYPES[sensor_type][0])
|
|
self._state = None
|
|
self._type = sensor_type
|
|
self._broadlink_data = broadlink_data
|
|
self._unit_of_measurement = SENSOR_TYPES[sensor_type][1]
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the sensor."""
|
|
return self._name
|
|
|
|
@property
|
|
def state(self):
|
|
"""Return the state of the sensor."""
|
|
return self._state
|
|
|
|
@property
|
|
def unit_of_measurement(self):
|
|
"""Return the unit this state is expressed in."""
|
|
return self._unit_of_measurement
|
|
|
|
def update(self):
|
|
"""Get the latest data from the sensor."""
|
|
self._broadlink_data.update()
|
|
if self._broadlink_data.data is None:
|
|
return
|
|
self._state = self._broadlink_data.data[self._type]
|
|
|
|
|
|
class BroadlinkData:
|
|
"""Representation of a Broadlink data object."""
|
|
|
|
def __init__(self, interval, ip_addr, mac_addr, timeout):
|
|
"""Initialize the data object."""
|
|
self.data = None
|
|
self.ip_addr = ip_addr
|
|
self.mac_addr = mac_addr
|
|
self.timeout = timeout
|
|
self._connect()
|
|
self._schema = vol.Schema({
|
|
vol.Optional('temperature'): vol.Range(min=-50, max=150),
|
|
vol.Optional('humidity'): vol.Range(min=0, max=100),
|
|
vol.Optional('light'): vol.Any(0, 1, 2, 3),
|
|
vol.Optional('air_quality'): vol.Any(0, 1, 2, 3),
|
|
vol.Optional('noise'): vol.Any(0, 1, 2),
|
|
})
|
|
self.update = Throttle(interval)(self._update)
|
|
if not self._auth():
|
|
_LOGGER.warning("Failed to connect to device")
|
|
|
|
def _connect(self):
|
|
import broadlink
|
|
self._device = broadlink.a1((self.ip_addr, 80), self.mac_addr, None)
|
|
self._device.timeout = self.timeout
|
|
|
|
def _update(self, retry=3):
|
|
try:
|
|
data = self._device.check_sensors_raw()
|
|
if data is not None:
|
|
self.data = self._schema(data)
|
|
return
|
|
except socket.timeout as error:
|
|
if retry < 1:
|
|
_LOGGER.error(error)
|
|
return
|
|
except (vol.Invalid, vol.MultipleInvalid):
|
|
pass # Continue quietly if device returned malformed data
|
|
if retry > 0 and self._auth():
|
|
self._update(retry-1)
|
|
|
|
def _auth(self, retry=3):
|
|
try:
|
|
auth = self._device.auth()
|
|
except socket.timeout:
|
|
auth = False
|
|
if not auth and retry > 0:
|
|
self._connect()
|
|
return self._auth(retry-1)
|
|
return auth
|