Merge remote-tracking branch 'origin/dev' into zwave-alarm

.coveragerc

@@ -36,6 +36,9 @@ omit =
     homeassistant/components/rfxtrx.py
     homeassistant/components/*/rfxtrx.py
 
+    homeassistant/components/mysensors.py
+    homeassistant/components/*/mysensors.py
+
     homeassistant/components/binary_sensor/arest.py
     homeassistant/components/binary_sensor/rest.py
     homeassistant/components/browser.py
@@ -92,7 +95,6 @@ omit =
     homeassistant/components/sensor/eliqonline.py
     homeassistant/components/sensor/forecast.py
     homeassistant/components/sensor/glances.py
-    homeassistant/components/sensor/mysensors.py
     homeassistant/components/sensor/openweathermap.py
     homeassistant/components/sensor/rest.py
     homeassistant/components/sensor/rpi_gpio.py

homeassistant/components/mysensors.py

@@ -0,0 +1,230 @@
+"""
+homeassistant.components.mysensors
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+MySensors component that connects to a MySensors gateway via pymysensors
+API.
+
+For more details about this platform, please refer to the documentation at
+https://home-assistant.io/components/sensor.mysensors.html
+
+
+New features:
+
+New MySensors component.
+Updated MySensors Sensor platform.
+New MySensors Switch platform. Currently only in optimistic mode (compare
+with MQTT).
+Multiple gateways are now supported.
+
+Configuration.yaml:
+
+mysensors:
+  gateways:
+    - port: '/dev/ttyUSB0'
+      persistence_file: 'path/mysensors.json'
+    - port: '/dev/ttyACM1'
+      persistence_file: 'path/mysensors2.json'
+  debug: true
+  persistence: true
+  version: '1.5'
+"""
+import logging
+
+from homeassistant.helpers import validate_config
+import homeassistant.bootstrap as bootstrap
+
+from homeassistant.const import (
+    EVENT_HOMEASSISTANT_START,
+    EVENT_HOMEASSISTANT_STOP,
+    EVENT_PLATFORM_DISCOVERED, ATTR_SERVICE, ATTR_DISCOVERED,
+    TEMP_CELCIUS,)
+
+CONF_GATEWAYS = 'gateways'
+CONF_PORT = 'port'
+CONF_DEBUG = 'debug'
+CONF_PERSISTENCE = 'persistence'
+CONF_PERSISTENCE_FILE = 'persistence_file'
+CONF_VERSION = 'version'
+DEFAULT_VERSION = '1.4'
+
+DOMAIN = 'mysensors'
+DEPENDENCIES = []
+REQUIREMENTS = [
+    'https://github.com/theolind/pymysensors/archive/'
+    '005bff4c5ca7a56acd30e816bc3bcdb5cb2d46fd.zip#pymysensors==0.4']
+_LOGGER = logging.getLogger(__name__)
+ATTR_NODE_ID = 'node_id'
+ATTR_CHILD_ID = 'child_id'
+ATTR_PORT = 'port'
+
+GATEWAYS = None
+SCAN_INTERVAL = 30
+
+DISCOVER_SENSORS = "mysensors.sensors"
+DISCOVER_SWITCHES = "mysensors.switches"
+
+# Maps discovered services to their platforms
+DISCOVERY_COMPONENTS = [
+    ('sensor', DISCOVER_SENSORS),
+    ('switch', DISCOVER_SWITCHES),
+]
+
+
+def setup(hass, config):
+    """Setup the MySensors component."""
+    # pylint: disable=too-many-locals
+
+    if not validate_config(config,
+                           {DOMAIN: [CONF_GATEWAYS]},
+                           _LOGGER):
+        return False
+
+    import mysensors.mysensors as mysensors
+
+    version = str(config[DOMAIN].get(CONF_VERSION, DEFAULT_VERSION))
+    is_metric = (hass.config.temperature_unit == TEMP_CELCIUS)
+
+    def setup_gateway(port, persistence, persistence_file, version):
+        """Return gateway after setup of the gateway."""
+        gateway = mysensors.SerialGateway(port, event_callback=None,
+                                          persistence=persistence,
+                                          persistence_file=persistence_file,
+                                          protocol_version=version)
+        gateway.metric = is_metric
+        gateway.debug = config[DOMAIN].get(CONF_DEBUG, False)
+        gateway = GatewayWrapper(gateway, version)
+        # pylint: disable=attribute-defined-outside-init
+        gateway.event_callback = gateway.callback_factory()
+
+        def gw_start(event):
+            """Callback to trigger start of gateway and any persistence."""
+            gateway.start()
+            hass.bus.listen_once(EVENT_HOMEASSISTANT_STOP,
+                                 lambda event: gateway.stop())
+            if persistence:
+                for node_id in gateway.sensors:
+                    gateway.event_callback('persistence', node_id)
+
+        hass.bus.listen_once(EVENT_HOMEASSISTANT_START, gw_start)
+
+        return gateway
+
+    # Setup all ports from config
+    global GATEWAYS
+    GATEWAYS = {}
+    conf_gateways = config[DOMAIN][CONF_GATEWAYS]
+    if isinstance(conf_gateways, dict):
+        conf_gateways = [conf_gateways]
+    persistence = config[DOMAIN].get(CONF_PERSISTENCE, True)
+
+    for index, gway in enumerate(conf_gateways):
+        port = gway[CONF_PORT]
+        persistence_file = gway.get(
+            CONF_PERSISTENCE_FILE,
+            hass.config.path('mysensors{}.pickle'.format(index + 1)))
+        GATEWAYS[port] = setup_gateway(
+            port, persistence, persistence_file, version)
+
+    for (component, discovery_service) in DISCOVERY_COMPONENTS:
+        # Ensure component is loaded
+        if not bootstrap.setup_component(hass, component, config):
+            return False
+        # Fire discovery event
+        hass.bus.fire(EVENT_PLATFORM_DISCOVERED, {
+            ATTR_SERVICE: discovery_service,
+            ATTR_DISCOVERED: {}})
+
+    return True
+
+
+def pf_callback_factory(
+        s_types, v_types, devices, add_devices, entity_class):
+    """Return a new callback for the platform."""
+    def mysensors_callback(gateway, node_id):
+        """Callback for mysensors platform."""
+        if gateway.sensors[node_id].sketch_name is None:
+            _LOGGER.info('No sketch_name: node %s', node_id)
+            return
+        # previously discovered, just update state with latest info
+        if node_id in devices:
+            for entity in devices[node_id]:
+                entity.update_ha_state(True)
+            return
+
+        # First time we see this node, detect sensors
+        for child in gateway.sensors[node_id].children.values():
+            name = '{} {}.{}'.format(
+                gateway.sensors[node_id].sketch_name, node_id, child.id)
+
+            for value_type in child.values.keys():
+                if child.type not in s_types or value_type not in v_types:
+                    continue
+
+                devices[node_id].append(
+                    entity_class(gateway, node_id, child.id, name, value_type))
+        if devices[node_id]:
+            _LOGGER.info('adding new devices: %s', devices[node_id])
+            add_devices(devices[node_id])
+        for entity in devices[node_id]:
+            entity.update_ha_state(True)
+    return mysensors_callback
+
+
+class GatewayWrapper(object):
+    """Gateway wrapper class, by subclassing serial gateway."""
+
+    def __init__(self, gateway, version):
+        """Setup class attributes on instantiation.
+
+        Args:
+        gateway (mysensors.SerialGateway): Gateway to wrap.
+        version (str): Version of mysensors API.
+
+        Attributes:
+        _wrapped_gateway (mysensors.SerialGateway): Wrapped gateway.
+        version (str): Version of mysensors API.
+        platform_callbacks (list): Callback functions, one per platform.
+        const (module): Mysensors API constants.
+        __initialised (bool): True if GatewayWrapper is initialised.
+        """
+        self._wrapped_gateway = gateway
+        self.version = version
+        self.platform_callbacks = []
+        self.const = self.get_const()
+        self.__initialised = True
+
+    def __getattr__(self, name):
+        """See if this object has attribute name."""
+        # Do not use hasattr, it goes into infinite recurrsion
+        if name in self.__dict__:
+            # this object has it
+            return getattr(self, name)
+        # proxy to the wrapped object
+        return getattr(self._wrapped_gateway, name)
+
+    def __setattr__(self, name, value):
+        """See if this object has attribute name then set to value."""
+        if '_GatewayWrapper__initialised' not in self.__dict__:
+            return object.__setattr__(self, name, value)
+        elif name in self.__dict__:
+            object.__setattr__(self, name, value)
+        else:
+            object.__setattr__(self._wrapped_gateway, name, value)
+
+    def get_const(self):
+        """Get mysensors API constants."""
+        if self.version == '1.5':
+            import mysensors.const_15 as const
+        else:
+            import mysensors.const_14 as const
+        return const
+
+    def callback_factory(self):
+        """Return a new callback function."""
+        def node_update(update_type, node_id):
+            """Callback for node updates from the MySensors gateway."""
+            _LOGGER.info('update %s: node %s', update_type, node_id)
+            for callback in self.platform_callbacks:
+                callback(self, node_id)
+
+        return node_update

homeassistant/components/sensor/__init__.py

@@ -9,8 +9,8 @@
 import logging
 
 from homeassistant.helpers.entity_component import EntityComponent
-from homeassistant.components import (wink, zwave, isy994,
-                                      verisure, ecobee, tellduslive)
+from homeassistant.components import (
+    wink, zwave, isy994, verisure, ecobee, tellduslive, mysensors)
 
 DOMAIN = 'sensor'
 SCAN_INTERVAL = 30
@@ -25,6 +25,7 @@
     verisure.DISCOVER_SENSORS: 'verisure',
     ecobee.DISCOVER_SENSORS: 'ecobee',
     tellduslive.DISCOVER_SENSORS: 'tellduslive',
+    mysensors.DISCOVER_SENSORS: 'mysensors',
 }