add filter option, to set threholfs for minimal and maximal values of states

Author: lukas-hetzenecker

README.md

@@ -76,7 +76,15 @@ remote_homeassistant:
     exclude:
       entities:
       - group.all_switches
-
+    filter:
+    - entity_id: sensor.faulty_pc_energy
+      above: 100
+    - unit_of_measurement: W
+      above: 0
+      below: 1000
+    - entity_id: sensor.faulty_*_power
+      unit_of_measurement: W
+      below: 500
     subscribe_events:
     - zwave.network_ready
     - zwave.node_event
@@ -134,6 +142,26 @@ exclude:
     domains:
       description: The list of domains to be excluded from the remote instance
       type: list
+filter:
+  description: Filters out states above or below a certain threshold, e.g. outliers reported by faulty sensors
+  required: false
+  type: list of
+    entity_id:
+      description: which entities the filter should match, supports wildcards
+      required: false
+      type: string
+    unit_of_measurement
+      description: which units of measurement the filter should match
+      required: false
+      type: string
+    above:
+      description: states above this threshold will be ignored
+      required: false
+      type: float
+    below:
+      description: states below this threshold will be ignored
+      required: false
+      type: float
 subscribe_events:
   description: Further list of events, which should be forwarded from the remote instance. If you override this, you probably will want to add state_changed!!
   required: false

custom_components/remote_homeassistant/__init__.py

@@ -4,11 +4,12 @@
 For more details about this component, please refer to the documentation at
 https://home-assistant.io/components/remote_homeassistant/
 """
-
+import fnmatch
 import logging
 import copy
 import asyncio
 import aiohttp
+import re
 
 import voluptuous as vol
 
@@ -18,8 +19,9 @@
 from homeassistant.helpers.typing import HomeAssistantType, ConfigType
 from homeassistant.const import (CONF_HOST, CONF_PORT, EVENT_CALL_SERVICE,
                                  EVENT_HOMEASSISTANT_STOP,
-                                 EVENT_STATE_CHANGED, EVENT_SERVICE_REGISTERED, CONF_EXCLUDE, CONF_ENTITIES,
-                                 CONF_DOMAINS, CONF_INCLUDE)
+                                 EVENT_STATE_CHANGED, EVENT_SERVICE_REGISTERED,
+                                 CONF_EXCLUDE, CONF_ENTITIES, CONF_ENTITY_ID,
+                                 CONF_DOMAINS, CONF_INCLUDE, CONF_UNIT_OF_MEASUREMENT, CONF_ABOVE, CONF_BELOW)
 from homeassistant.config import DATA_CUSTOMIZE
 from homeassistant.helpers.aiohttp_client import async_get_clientsession
 import homeassistant.helpers.config_validation as cv
@@ -33,6 +35,7 @@
 CONF_API_PASSWORD = 'api_password'
 CONF_SUBSCRIBE_EVENTS = 'subscribe_events'
 CONF_ENTITY_PREFIX = 'entity_prefix'
+CONF_FILTER = 'filter'
 
 DOMAIN = 'remote_homeassistant'
 
@@ -63,6 +66,19 @@
             ),
         }
     ),
+    vol.Optional(CONF_FILTER, default=[]): vol.All(
+        cv.ensure_list,
+        [
+            vol.Schema(
+                {
+                    vol.Optional(CONF_ENTITY_ID): cv.string,
+                    vol.Optional(CONF_UNIT_OF_MEASUREMENT): cv.string,
+                    vol.Optional(CONF_ABOVE): vol.Coerce(float),
+                    vol.Optional(CONF_BELOW): vol.Coerce(float),
+                }
+            )
+        ]
+    ),
     vol.Optional(CONF_SUBSCRIBE_EVENTS,
                  default=DEFAULT_SUBSCRIBED_EVENTS): cv.ensure_list,
     vol.Optional(CONF_ENTITY_PREFIX, default=DEFAULT_ENTITY_PREFIX): cv.string,
@@ -109,6 +125,16 @@ def __init__(self, hass, conf):
         self._blacklist_e = set(exclude.get(CONF_ENTITIES, []))
         self._blacklist_d = set(exclude.get(CONF_DOMAINS, []))
 
+        self._filter = [
+            {
+                CONF_ENTITY_ID: re.compile(fnmatch.translate(f.get(CONF_ENTITY_ID))) if f.get(CONF_ENTITY_ID) else None,
+                CONF_UNIT_OF_MEASUREMENT: f.get(CONF_UNIT_OF_MEASUREMENT),
+                CONF_ABOVE: f.get(CONF_ABOVE),
+                CONF_BELOW: f.get(CONF_BELOW)
+            }
+            for f in conf.get(CONF_FILTER, [])
+        ]
+
         self._subscribe_events = conf.get(CONF_SUBSCRIBE_EVENTS)
         self._entity_prefix = conf.get(CONF_ENTITY_PREFIX)
 
@@ -311,6 +337,26 @@ def state_changed(entity_id, state, attr):
             ):
                 return
 
+            for f in self._filter:
+                if f[CONF_ENTITY_ID] and not f[CONF_ENTITY_ID].match(entity_id):
+                    continue
+                if f[CONF_UNIT_OF_MEASUREMENT]:
+                    if CONF_UNIT_OF_MEASUREMENT not in attr:
+                        continue
+                    if f[CONF_UNIT_OF_MEASUREMENT] != attr[CONF_UNIT_OF_MEASUREMENT]:
+                        continue
+                try:
+                    if f[CONF_BELOW] and float(state) < f[CONF_BELOW]:
+                        _LOGGER.info("%s: ignoring state '%s', because "
+                                     "below '%s'", entity_id, state, f[CONF_BELOW])
+                        return
+                    if f[CONF_ABOVE] and float(state) > f[CONF_ABOVE]:
+                        _LOGGER.info("%s: ignoring state '%s', because "
+                                     "above '%s'", entity_id, state, f[CONF_ABOVE])
+                        return
+                except ValueError:
+                    pass
+
             if self._entity_prefix:
                 object_id = self._entity_prefix + object_id
                 entity_id = domain + '.' + object_id