DSMR sensor

homeassistant/components/sensor/dsmr.py

@@ -0,0 +1,153 @@
+"""
+Support for Dutch Smart Meter Requirements.
+
+Also known as: Smartmeter or P1 port.
+
+For more details about this platform, please refer to the documentation at
+https://home-assistant.io/components/sensor.dsmr/
+"""
+
+import asyncio
+import logging
+
+import voluptuous as vol
+import homeassistant.helpers.config_validation as cv
+from homeassistant.components.sensor import PLATFORM_SCHEMA
+from homeassistant.const import CONF_DEVICE
+from homeassistant.helpers.entity import Entity
+
+DOMAIN = 'dsmr'
+
+REQUIREMENTS = ['dsmr-parser==0.2']
+
+CONF_DSMR_VERSION = 'dsmr_version'
+DEFAULT_DEVICE = '/dev/ttyUSB0'
+DEFAULT_DSMR_VERSION = '4'
+
+PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
+    vol.Optional(CONF_DEVICE, default=DEFAULT_DEVICE): cv.string,
+    vol.Optional(CONF_DSMR_VERSION, default=DEFAULT_DSMR_VERSION): vol.All(
+        cv.string, vol.In(['4', '2.2'])),
+})
+
+_LOGGER = logging.getLogger(__name__)
+
+
+@asyncio.coroutine
+def async_setup_platform(hass, config, async_add_devices, discovery_info=None):
+    """Setup DSMR sensors."""
+    from dsmr_parser.obis_references import (
+        CURRENT_ELECTRICITY_USAGE,
+        CURRENT_ELECTRICITY_DELIVERY,
+        ELECTRICITY_ACTIVE_TARIFF
+    )
+
+    devices = []
+
+    dsmr = DSMR(hass, config, devices)
+
+    devices += [
+        DSMREntity('Power Usage', CURRENT_ELECTRICITY_USAGE, dsmr),
+        DSMREntity('Power Production', CURRENT_ELECTRICITY_DELIVERY, dsmr),
+        DSMRTariff('Power Tariff', ELECTRICITY_ACTIVE_TARIFF, dsmr),
+    ]
+    yield from async_add_devices(devices, True)
+    yield from dsmr.async_update()
+
+
+class DSMR:
+    """DSMR interface."""
+
+    def __init__(self, hass, config, devices):
+        """Setup DSMR serial interface and add device entities."""
+        from dsmr_parser.serial import (
+            SERIAL_SETTINGS_V4,
+            SERIAL_SETTINGS_V2_2,
+            SerialReader
+        )
+        from dsmr_parser import telegram_specifications
+
+        dsmr_versions = {
+            '4': (SERIAL_SETTINGS_V4, telegram_specifications.V4),
+            '2.2': (SERIAL_SETTINGS_V2_2, telegram_specifications.V2_2),
+        }
+
+        device = config[CONF_DEVICE]
+        dsmr_version = config[CONF_DSMR_VERSION]
+
+        self.dsmr_parser = SerialReader(
+            device=device,
+            serial_settings=dsmr_versions[dsmr_version][0],
+            telegram_specification=dsmr_versions[dsmr_version][1],
+        )
+
+        self.hass = hass
+        self.devices = devices
+        self._telegram = {}
+
+    @asyncio.coroutine
+    def async_update(self):
+        """Wait for DSMR telegram to be received and parsed."""
+        _LOGGER.info('retrieving new telegram')
+
+        self._telegram = self.read_telegram()
+
+        _LOGGER.info('got new telegram')
+
+        yield from asyncio.sleep(10, loop=self.hass.loop)
+        tasks = []
+        for device in self.devices:
+            tasks.append(device.async_update_ha_state())
+
+        yield from asyncio.gather(*tasks, loop=self.hass.loop)
+
+    def read_telegram(self):
+        """Read telegram."""
+        return next(self.dsmr_parser.read())
+
+    @property
+    def telegram(self):
+        """Return latest received telegram."""
+        return self._telegram
+
+
+class DSMREntity(Entity):
+    """Entity reading values from DSMR telegram."""
+
+    def __init__(self, name, obis, interface):
+        """"Initialize entity."""
+        self._name = name
+        self._obis = obis
+        self._interface = interface
+
+    @property
+    def name(self):
+        """Return the name of the sensor."""
+        return self._name
+
+    @property
+    def state(self):
+        """Return the state of the sensor."""
+        return getattr(self._interface.telegram.get(self._obis, {}),
+                       'value', None)
+
+    @property
+    def unit_of_measurement(self):
+        """Return the unit of measurement of this entity, if any."""
+        return getattr(self._interface.telegram.get(self._obis, {}),
+                       'unit', None)
+
+
+class DSMRTariff(DSMREntity):
+    """Convert integer tariff value to text."""
+
+    @property
+    def state(self):
+        """Convert 2/1 to high/low."""
+        tariff = super().state
+        if tariff == '0002':
+            return 'high'
+        elif tariff == '0001':
+            return 'low'
+        else:
+            return None

requirements_all.txt

@@ -81,6 +81,9 @@ dnspython3==1.15.0
 # homeassistant.components.sensor.dovado
 dovado==0.1.15
 
+# homeassistant.components.sensor.dsmr
+dsmr-parser==0.2
+
 # homeassistant.components.dweet
 # homeassistant.components.sensor.dweet
 dweepy==0.2.0

tests/components/sensor/test_dsmr.py

@@ -0,0 +1,43 @@
+"""Test for DSMR components."""
+
+import asyncio
+from decimal import Decimal
+from unittest.mock import patch
+
+from homeassistant.bootstrap import async_setup_component
+from tests.common import assert_setup_component
+
+
+@asyncio.coroutine
+def test_default_setup(hass):
+    """Test the default setup."""
+    from dsmr_parser.obis_references import (
+        CURRENT_ELECTRICITY_USAGE,
+        ELECTRICITY_ACTIVE_TARIFF,
+    )
+    from dsmr_parser.objects import CosemObject
+
+    config = {'platform': 'dsmr'}
+
+    telegram = {
+        CURRENT_ELECTRICITY_USAGE: CosemObject([
+            {'value': Decimal('0.1'), 'unit': 'kWh'}
+        ]),
+        ELECTRICITY_ACTIVE_TARIFF: CosemObject([
+            {'value': '0001', 'unit': ''}
+        ]),
+    }
+
+    with patch('homeassistant.components.sensor.dsmr.DSMR.read_telegram',
+               return_value=telegram), assert_setup_component(1):
+        yield from async_setup_component(hass, 'sensor', {'sensor': config})
+
+    state = hass.states.get('sensor.power_usage')
+
+    assert state.state == '0.1'
+    assert state.attributes.get('unit_of_measurement') is 'kWh'
+
+    state = hass.states.get('sensor.power_tariff')
+
+    assert state.state == 'low'
+    assert state.attributes.get('unit_of_measurement') is None