Added Sense energy monitor sensor (#11580)

* Added Sense energy monitor sensor

* Added missing =

* Style updates

* Added newline, but not blank line at end of file

* Updated sense API to 0.2.2

* Moved import in function

* Fixed tabs

* Updated requirements

* Removed bare except

* Longer update times and more stats

* sense api update

* Updated to use string formatting

* Setup to use monitored_conditions

* Fix syntax

* API update

* blank space fixes

* More blank fixes

* API version update

* Fixed comment format

* removed unneeded function call

.coveragerc

@@ -625,6 +625,7 @@ omit =
     homeassistant/components/sensor/ripple.py
     homeassistant/components/sensor/sabnzbd.py
     homeassistant/components/sensor/scrape.py
+    homeassistant/components/sensor/sense.py
     homeassistant/components/sensor/sensehat.py
     homeassistant/components/sensor/serial.py
     homeassistant/components/sensor/serial_pm.py

homeassistant/components/sensor/sense.py

@@ -0,0 +1,152 @@
+"""
+Support for monitoring a Sense energy sensor.
+
+For more details about this platform, please refer to the documentation at
+https://home-assistant.io/components/sensor.sense/
+"""
+import logging
+from datetime import timedelta
+
+import voluptuous as vol
+
+from homeassistant.components.sensor import PLATFORM_SCHEMA
+from homeassistant.const import (CONF_EMAIL, CONF_PASSWORD,
+                                 CONF_MONITORED_CONDITIONS)
+from homeassistant.helpers.entity import Entity
+from homeassistant.util import Throttle
+import homeassistant.helpers.config_validation as cv
+
+REQUIREMENTS = ['sense_energy==0.3.1']
+
+_LOGGER = logging.getLogger(__name__)
+
+ACTIVE_NAME = "Energy"
+PRODUCTION_NAME = "Production"
+CONSUMPTION_NAME = "Usage"
+
+ACTIVE_TYPE = 'active'
+
+
+class SensorConfig(object):
+    """Data structure holding sensor config."""
+
+    def __init__(self, name, sensor_type):
+        """Sensor name and type to pass to API."""
+        self.name = name
+        self.sensor_type = sensor_type
+
+
+# Sensor types/ranges
+SENSOR_TYPES = {'active': SensorConfig(ACTIVE_NAME, ACTIVE_TYPE),
+                'daily': SensorConfig('Daily', 'DAY'),
+                'weekly': SensorConfig('Weekly', 'WEEK'),
+                'monthly': SensorConfig('Monthly', 'MONTH'),
+                'yearly': SensorConfig('Yearly', 'YEAR')}
+
+# Production/consumption variants
+SENSOR_VARIANTS = [PRODUCTION_NAME.lower(), CONSUMPTION_NAME.lower()]
+
+# Valid sensors for configuration
+VALID_SENSORS = ['%s_%s' % (typ, var)
+                 for typ in SENSOR_TYPES
+                 for var in SENSOR_VARIANTS]
+
+ICON = 'mdi:flash'
+
+MIN_TIME_BETWEEN_DAILY_UPDATES = timedelta(seconds=300)
+MIN_TIME_BETWEEN_ACTIVE_UPDATES = timedelta(seconds=60)
+
+PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
+    vol.Required(CONF_EMAIL): cv.string,
+    vol.Required(CONF_PASSWORD): cv.string,
+    vol.Required(CONF_MONITORED_CONDITIONS):
+        vol.All(cv.ensure_list, vol.Length(min=1), [vol.In(VALID_SENSORS)]),
+})
+
+
+def setup_platform(hass, config, add_devices, discovery_info=None):
+    """Set up the Sense sensor."""
+    from sense_energy import Senseable
+
+    username = config.get(CONF_EMAIL)
+    password = config.get(CONF_PASSWORD)
+
+    data = Senseable(username, password)
+
+    @Throttle(MIN_TIME_BETWEEN_DAILY_UPDATES)
+    def update_trends():
+        """Update the daily power usage."""
+        data.update_trend_data()
+
+    @Throttle(MIN_TIME_BETWEEN_ACTIVE_UPDATES)
+    def update_active():
+        """Update the active power usage."""
+        data.get_realtime()
+
+    devices = []
+    for sensor in config.get(CONF_MONITORED_CONDITIONS):
+        config_name, prod = sensor.rsplit('_', 1)
+        name = SENSOR_TYPES[config_name].name
+        sensor_type = SENSOR_TYPES[config_name].sensor_type
+        is_production = prod == PRODUCTION_NAME.lower()
+        if sensor_type == ACTIVE_TYPE:
+            update_call = update_active
+        else:
+            update_call = update_trends
+        devices.append(Sense(data, name, sensor_type,
+                             is_production, update_call))
+
+    add_devices(devices)
+
+
+class Sense(Entity):
+    """Implementation of a Sense energy sensor."""
+
+    def __init__(self, data, name, sensor_type, is_production, update_call):
+        """Initialize the sensor."""
+        name_type = PRODUCTION_NAME if is_production else CONSUMPTION_NAME
+        self._name = "%s %s" % (name, name_type)
+        self._data = data
+        self._sensor_type = sensor_type
+        self.update_sensor = update_call
+        self._is_production = is_production
+        self._state = None
+
+        if sensor_type == ACTIVE_TYPE:
+            self._unit_of_measurement = 'W'
+        else:
+            self._unit_of_measurement = 'kWh'
+
+    @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 of measurement of this entity, if any."""
+        return self._unit_of_measurement
+
+    @property
+    def icon(self):
+        """Icon to use in the frontend, if any."""
+        return ICON
+
+    def update(self):
+        """Get the latest data, update state."""
+        self.update_sensor()
+
+        if self._sensor_type == ACTIVE_TYPE:
+            if self._is_production:
+                self._state = round(self._data.active_solar_power)
+            else:
+                self._state = round(self._data.active_power)
+        else:
+            state = self._data.get_trend(self._sensor_type,
+                                         self._is_production)
+            self._state = round(state, 1)

requirements_all.txt

@@ -1097,6 +1097,9 @@ sendgrid==5.3.0
 # homeassistant.components.sensor.sensehat
 sense-hat==2.2.0
 
+# homeassistant.components.sensor.sense
+sense_energy==0.3.1
+
 # homeassistant.components.media_player.aquostv
 sharp_aquos_rc==0.3.2